ops.cljc

(ns fif.stdlib.ops
  "Standard Library Word Definitions for common operators

  - Most of the functions listed were taken from the Forth standard library."
  (:require
   [clojure.string :as str]
   [clojure.pprint :as pprint]
   [fif.stack-machine :as stack]
   [fif.stack-machine.words :as words :refer [set-global-word-defn]]
   [fif.def :as def :refer [wrap-function-with-arity
                            wrap-procedure-with-arity]
    :include-macros true]))


(defn abs
  "(n -- n) Gets the absolute of the top value"
  [sm]
  (let [[i] (stack/get-stack sm)
        result (if (pos? i) i (clojure.core/- i))]
    (-> sm stack/pop-stack (stack/push-stack result) stack/dequeue-code)))


(defn dup [sm]
  (let [top (-> sm stack/get-stack peek)]
    (-> sm (stack/push-stack top) stack/dequeue-code)))


(defn dot [sm]
  (let [top (-> sm stack/get-stack peek)]
    (print top)
    (-> sm stack/pop-stack stack/dequeue-code)))


(defn carriage-return [sm]
  (print "\n")
  (-> sm stack/dequeue-code))


(defn dot-stack [sm]
  (let [stack (stack/get-stack sm)]
    (print (str "<" (count stack) "> "))
    (prn (reverse stack))
    (-> sm stack/dequeue-code)))


(defn push-return [sm]
  (let [[i] (stack/get-stack sm)]
    (-> sm stack/pop-stack (stack/push-ret i) stack/dequeue-code)))


(defn pop-return [sm]
  (let [[i] (stack/get-ret sm)]
    (-> sm stack/pop-ret (stack/push-stack i) stack/dequeue-code)))


(defn swap [sm]
  (let [[i j] (stack/get-stack sm)]
    (-> sm stack/pop-stack stack/pop-stack (stack/push-stack i) (stack/push-stack j) stack/dequeue-code)))


(defn rot [sm]
  (let [[k j i] (stack/get-stack sm)]
    (-> sm stack/pop-stack stack/pop-stack stack/pop-stack
        (stack/push-stack j) (stack/push-stack k) (stack/push-stack i) stack/dequeue-code)))


(defn op-drop [sm]
  (-> sm stack/pop-stack stack/dequeue-code))


(defn nip [sm]
  (let [[i j] (stack/get-stack sm)]
    (-> sm stack/pop-stack stack/pop-stack (stack/push-stack i) stack/dequeue-code)))


(defn tuck [sm]
  (let [[i j] (stack/get-stack sm)]
    (-> sm stack/pop-stack stack/pop-stack
        (stack/push-stack i) (stack/push-stack j) (stack/push-stack i) stack/dequeue-code)))


(defn over [sm]
  (let [[i j] (stack/get-stack sm)]
    (-> sm (stack/push-stack j) stack/dequeue-code)))


(defn roll
  "(v v --) *move* the item at that position to the top"
  [sm]
  (let [stack (stack/get-stack sm)
        pos (peek stack)
        item (nth stack pos)
        new-stack (nthrest stack 2)]))


(defn import-stdlib-ops [sm]
  (-> sm

      ;; Arithmetic

      (set-global-word-defn
       '* (wrap-function-with-arity 2 *)
       :stdlib? true
       :doc "( n n -- n ) Multiply the top two values on the stack."
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       '+ (wrap-function-with-arity 2 +)
       :stdlib? true
       :doc "( n n -- n ) Add the top two values on the stack."
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       '- (wrap-function-with-arity 2 -)
       :stdlib? true
       :doc "( n n -- n ) Subtract the top two values on the stack."
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       '/ (wrap-function-with-arity 2 /)
       :stdlib? true
       :doc "( n n -- n ) Divide the top two values on the stack"
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       'abs abs
       :stdlib? true
       :doc "( n -- n ) Absolute value of the top value on the stack."
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       'dec (wrap-function-with-arity 1 dec)
       :stdlib? true
       :doc "( n -- n ) Decrement of top value on the stack."
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       'inc (wrap-function-with-arity 1 inc)
       :stdlib? true
       :doc "( n -- n ) Increment of top value on the stack."
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       'max (wrap-function-with-arity 2 max)
       :stdlib? true
       :doc "( n n -- n ) Max value between the top two values on the stack."
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       'min (wrap-function-with-arity 2 min)
       :stdlib? true
       :doc "( n n -- n ) Min value between the top two values on the stack."
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       'mod (wrap-function-with-arity 2 mod)
       :stdlib? true
       :doc "( num div -- n ) Modulus of `num` and `div`"
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       'negate (wrap-function-with-arity 1 -)
       :stdlib? true
       :doc "( n -- n ) Negate the top value"
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       'quot (wrap-function-with-arity 2 quot)
       :stdlib? true
       :doc "( num div -- n ) Quotient of dividing `num` by `div`"
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       'rem (wrap-function-with-arity 2 rem)
       :stdlib? true
       :doc "( num div -- n ) Remainder of dividing `num` by `div`"
       :group :stdlib.math.arithmetic)

      ;; Bitwise

      (set-global-word-defn
       'bit-and (wrap-function-with-arity 2 bit-and)
       :stdlib? true
       :doc "( n n -- n ) Bitwise AND between top two values on the stack."
       :group :stdlib.bitwise)

      (set-global-word-defn
       'bit-and-not (wrap-function-with-arity 2 bit-and-not)
       :stdlib? true
       :doc "( n n -- n ) Bitwase AND with complement between top two values on the stack."
       :group :stdlib.bitwise)

      (set-global-word-defn
       'bit-clear (wrap-function-with-arity 2 bit-clear)
       :stdlib? true
       :doc "( num idx -- n ) Clear bit of `num` at `idx`."
       :group :stdlib.bitwise)

      (set-global-word-defn
       'bit-flip (wrap-function-with-arity 2 bit-flip)
       :stdlib? true
       :doc "( num idx -- n ) Flip bit of `num` at `idx`."
       :group :stdlib.bitwise)

      (set-global-word-defn
       'bit-not (wrap-function-with-arity 1 bit-not)
       :stdlib? true
       :doc "( n -- n ) Bitwise NOT of top value on the stack."
       :group :stdlib.bitwise)

      (set-global-word-defn
       'bit-or (wrap-function-with-arity 2 bit-or)
       :stdlib? true
       :doc "( n n -- n ) Bitwise OR of top two values on the stack."
       :group :stdlib.bitwise)

      (set-global-word-defn
       'bit-shift-left (wrap-function-with-arity 2 bit-shift-left)
       :stdlib? true
       :doc "( num shift -- n ) Bitwise shift left of `num` by `shift`."
       :group :stdlib.bitwise)

      (set-global-word-defn
       'bit-shift-right (wrap-function-with-arity 2 bit-shift-right)
       :stdlib? true
       :doc "( num shift -- n ) Bitwise shift right of `num` by `shift`."
       :group :stdlib.bitwise)

      (set-global-word-defn
       'bit-test (wrap-function-with-arity 2 bit-test)
       :stdlib? true
       :doc "( num idx -- b ) Test bit of `num` at `idx`."
       :group :stdlib.bitwise)

      (set-global-word-defn
       'bit-xor (wrap-function-with-arity 2 bit-xor)
       :stdlib? true
       :doc "( n n -- n ) Bitwise Exclusive-or between top two values on the stack."
       :group :stdlib.bitwise)

      (set-global-word-defn
       'byte (wrap-function-with-arity 1 byte)
       :stdlib? true
       :doc "( n -- n ) Coerce to byte."
       :group :stdlib.misc)

      (set-global-word-defn
       'unsigned-bit-shift-right (wrap-function-with-arity 2 unsigned-bit-shift-right)
       :stdlib? true
       :doc "(num shift -- n) Bitwise shift right, without sign-extension."
       :group :stdlib.bitwise)

      ;; Forth-based

      (set-global-word-defn
       '. dot
       :stdlib? true
       :doc "(n -- ) Send the top value to standard output."
       :group :stdlib.forth)

      (set-global-word-defn
       '.s dot-stack
       :stdlib? true
       :doc "( -- ) Prints the contents of the main stack onto standard output."
       :group :stdlib.forth)

      (set-global-word-defn
       '<> swap
       :stdlib? true
       :doc "( n1 n2 -- n2 n1 ) Swap the top two values on the stack."
       :group :stdlib.forth)

      (set-global-word-defn
       '>r push-return
       :stdlib? true
       :doc "( n -- ) Moves the top value on the main stack onto the return stack."
       :group :stdlib.forth)

      (set-global-word-defn
       'cr carriage-return
       :stdlib? true
       :doc "( -- ) Sends a newline to standard output."
       :group :stdlib.forth)

      (set-global-word-defn
       'drop op-drop
       :stdlib? true
       :doc "( n -- ) Drops the top value on the stack."
       :group :stdlib.forth)

      (set-global-word-defn
       'dup dup
       :stdlib? true
       :doc "( -- n ) Duplicates the top value on the stack."
       :group :stdlib.forth)

      (set-global-word-defn
       'nip nip
       :stdlib? true
       :doc "( n _ -- ) Drops the second value from the top of the stack."
       :group :stdlib.forth)

      (set-global-word-defn
       'over over
       :stdlib? true
       :doc "( -- n ) Duplicates the second value from the top of the stack."
       :group :stdlib.forth)

      (set-global-word-defn
       'r> pop-return
       :stdlib? true
       :doc "( -- n ) Moves the top value of the return stack onto the top of the main stack."
       :group :stdlib.forth)

      (set-global-word-defn
       'roll roll
       :stdlib? true
       :doc ""
       :group :stdlib.forth)

      (set-global-word-defn
       'rot rot
       :stdlib? true
       :doc "( n1 n2 n3 -- n2 n3 n1 ) Rotate the top three values."
       :group :stdlib.forth)

      (set-global-word-defn
       'swap swap
       :stdlib? true
       :doc "( n1 n2 -- n2 n1 ) Swap the top two values on the stack."
       :group :stdlib.forth)

      (set-global-word-defn
       'tuck tuck
       :stdlib? true
       :doc "( -- ) duplicate the top item below the second slot."
       :group :stdlib.forth)

      ;;
      ;; Comparison Operators
      ;;

      (set-global-word-defn
       '< (wrap-function-with-arity 2 <)
       :stdlib? true
       :doc "( x y -- bool ) Returns true if `x` < `y`, else false"
       :group :stdlib.comparison)

      (set-global-word-defn
       '<= (wrap-function-with-arity 2 <=)
       :stdlib? true
       :doc "( x y -- bool ) Returns true if `x` <= `y`, else false"
       :group :stdlib.comparison)

      (set-global-word-defn
       '= (wrap-function-with-arity 2 =)
       :stdlib? true
       :doc "( x y -- bool ) Returns true if `x` = `y`, else false"
       :group :stdlib.comparison)

      (set-global-word-defn
       '> (wrap-function-with-arity 2 >)
       :stdlib? true
       :doc "( x y -- bool ) Returns true if `x` > `y`, else false"
       :group :stdlib.comparison)

      (set-global-word-defn
       '>= (wrap-function-with-arity 2 >=)
       :stdlib? true
       :doc "( x y -- bool ) Returns true if `x` >= `y`, else false"
       :group :stdlib.comparison)

      (set-global-word-defn
       'and (wrap-function-with-arity 2 #(and %1 %2))
       :stdlib? true
       :doc "( x y -- bool ) Returns true if `x` and `y` are true, else false"
       :group :stdlib.comparison)

      (set-global-word-defn
       'compare (wrap-function-with-arity 2 compare)
       :stdlib? true
       :doc "( x y -- n ) Returns a negative number, zero, or a
positive number when x is logically 'less than', 'equal to', or
'greater than' y"
       :group :stdlib.comparison)

      (set-global-word-defn
       'not (wrap-function-with-arity 1 not)
       :stdlib? true
       :doc "( x -- b ) Returns true if x is logical false, false otherwise."
       :group :stdlib.comparison)

      (set-global-word-defn
       'not= (wrap-function-with-arity 2 not=)
       :stdlib? true
       :doc "( x y -- bool ) Returns true if `x` not equal to `y`, else false"
       :group :stdlib.comparison)

      (set-global-word-defn
       'or (wrap-function-with-arity 2 #(or %1 %2))
       :stdlib? true
       :doc "( x y -- bool ) Returns true if `x` and `y` are true, else false"
       :group :stdlib.comparison)

      ;; CLJ Type Checking
      #?(:clj
         (set-global-word-defn
          'bytes? (wrap-function-with-arity 1 bytes?)
          :stdlib? true
          :doc "( any -- bool ) Returns true if top value is a byte array."
          :group :stdlib.type-checking))

      #?(:clj
         (set-global-word-defn
          'ratio? (wrap-function-with-arity 1 ratio?)
          :stdlib? true
          :doc "( any -- bool ) Returns true if top value is a Ratio."
          :group :stdlib.type-checking))

      #?(:clj
         (set-global-word-defn
          'rational? (wrap-function-with-arity 1 rational?)
          :stdlib? true
          :doc "( any -- bool ) Returns true if the top value is a rational number."
          :group :stdlib.type-checking))

      #?(:clj
         (set-global-word-defn
          'decimal? (wrap-function-with-arity 1 decimal?)
          :stdlib? true
          :doc "( any -- bool ) Returns true if the top value is a BigDeciaml."
          :group :stdlib.type-checking))

      ;; Type Checking

      (set-global-word-defn
       'any? (wrap-function-with-arity 1 any?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is any value."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'associative? (wrap-function-with-arity 1 associative?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a collection that implements Associative (map set)."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'boolean? (wrap-function-with-arity 1 boolean?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a boolean value."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'coll? (wrap-function-with-arity 1 coll?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a collection (map set vec list seq)."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'double? (wrap-function-with-arity 1 double?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a Double."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'even? (wrap-function-with-arity 1 even?)
       :stdlib? true
       :doc "( n -- bool ) Returns true if the top value is even."
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       'false? (wrap-function-with-arity 1 false?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is the boolean value false."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'float? (wrap-function-with-arity 1 float?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a floating point number."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'indexed? (wrap-function-with-arity 1 indexed?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is indexed (vec)."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'inst? (wrap-function-with-arity 1 inst?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value satisifes Inst implementation."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'int? (wrap-function-with-arity 1 int?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a fixed precision integer."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'integer? (wrap-function-with-arity 1 integer?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is an integer."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'keyword? (wrap-function-with-arity 1 keyword?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a keyword."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'list? (wrap-function-with-arity 1 list?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a list."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'map? (wrap-function-with-arity 1 map?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a map."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'nat-int? (wrap-function-with-arity 1 nat-int?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a non-negative fixed precision integer."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'neg-int? (wrap-function-with-arity 1 neg-int?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a negative fixed precision integer."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'nil? (wrap-function-with-arity 1 nil?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is nil."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'number? (wrap-function-with-arity 1 number?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a number."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'odd? (wrap-function-with-arity 1 odd?)
       :stdlib? true
       :doc "( n -- bool ) Returns true if the top value is odd."
       :group :stdlib.math.arithmetic)

      (set-global-word-defn
       'pprint (wrap-procedure-with-arity 1 pprint/pprint)
       :stdlib? true
       :doc "( any -- ) Display clojure value pretty-printed to standard out."
       :group :stdlib.pprint)

      (set-global-word-defn
       'pos-int? (wrap-function-with-arity 1 pos-int?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a positive fixed precision integer."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'seq? (wrap-function-with-arity 1 seq?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value implements ISeq (list seq)"
       :group :stdlib.type-checking)

      (set-global-word-defn
       'seqable? (wrap-function-with-arity 1 seqable?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the seq function is supported by the top value."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'sequential? (wrap-function-with-arity 1 sequential?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value implements Sequential (list vec)"
       :group :stdlib.type-checking)

      (set-global-word-defn
       'set? (wrap-function-with-arity 1 set?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a set."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'some? (wrap-function-with-arity 1 some?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is not nil."
       :group :stdlib.comparison)

      (set-global-word-defn
       'string? (wrap-function-with-arity 1 string?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a string."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'symbol? (wrap-function-with-arity 1 symbol?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a symbol."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'symbol (wrap-function-with-arity 1 symbol)
       :stdlib? true
       :doc "( any -- bool ) Returns the top value as a symbol, otherwise nil."
       :group :stdlib.conversion)

      (set-global-word-defn
       'true? (wrap-function-with-arity 1 true?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is the boolean value true."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'uri? (wrap-function-with-arity 1 uri?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a java.net.URI."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'uuid? (wrap-function-with-arity 1 uuid?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is a java.util.UUID."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'vector? (wrap-function-with-arity 1 vector?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value implements IPersistentVector (vec)."
       :group :stdlib.type-checking)

      (set-global-word-defn
       'zero? (wrap-function-with-arity 1 zero?)
       :stdlib? true
       :doc "( any -- bool ) Returns true if the top value is the number zero."
       :group :stdlib.comparison)

      ;; Other Stuff

      (set-global-word-defn
       'count (wrap-function-with-arity 1 count)
       :stdlib? true
       :doc "( coll -- n ) Returns the length of the top value collection."
       :group :stdlib.collection)

      (set-global-word-defn
       'deref (wrap-function-with-arity 1 deref)
       :stdlib? true
       :doc "( derefable -- any ) Dereferences the top value."
       :group :stdlib.concurrent)

      (set-global-word-defn
       'newline (wrap-procedure-with-arity 0 newline)
       :stdlib? true
       :doc "( -- ) Sends a platform-specific newline to standard out."
       :group :stdlib.io)

      (set-global-word-defn
       'pr (wrap-procedure-with-arity 1 pr)
       :stdlib? true
       :doc "( any -- ) Sends the top value to standard output in reader notation."
       :group :stdlib.io)

      (set-global-word-defn
       'print (wrap-procedure-with-arity 1 print)
       :stdlib? true
       :doc "( any -- ) Sends the top value to standard output as a string"
       :group :stdlib.io)

      (set-global-word-defn
       'println (wrap-procedure-with-arity 1 println)
       :stdlib? true
       :doc "( any -- ) Sends the top value to standard output as a string with a newline."
       :group :stdlib.io)

      (set-global-word-defn
       'prn (wrap-procedure-with-arity 1 prn)
       :stdlib? true
       :doc "( any -- ) Sends the top value to standard output in reader notation with a newline."
       :group :stdlib.io)

      (set-global-word-defn
       'rand (wrap-function-with-arity 0 rand)
       :stdlib? true
       :doc "( -- n ) Returns a random floating point number between [0 1)."
       :group :stdlib.random)

      (set-global-word-defn
       'randn (wrap-function-with-arity 1 rand)
       :stdlib? true
       :doc "( n -- n ) Returns a random floating point number between  [0 n)."
       :group :stdlib.random)

      (set-global-word-defn
       'str (wrap-function-with-arity 2 str)
       :stdlib? true
       :doc "( any any -- n ) Returns the string concatenation of the top two values on the stack."
       :group :stdlib.string)

      (set-global-word-defn
       'str/blank? (wrap-function-with-arity 1 str/blank?)
       :stdlib? true
       :doc "( s -- b ) Returns true if `s` is nil, empty or contains only whitespace."
       :group :stdlib.string)

      (set-global-word-defn
       'str/capitalize (wrap-function-with-arity 1 str/capitalize)
       :stdlib? true
       :doc "( s -- s ) Returns the first character of the string uppercase, and all other characters in lowercase."
       :group :stdlib.string)

      (set-global-word-defn
       'str/ends-with? (wrap-function-with-arity 2 str/ends-with?)
       :stdlib? true
       :doc "( str substr -- bool ) Returns true if `str` ends with `substr`."
       :group :stdlib.string)

      (set-global-word-defn
       'str/escape (wrap-function-with-arity 2 str/escape)
       :stdlib? true
       :doc "( s cmap -- s ) Return a new string, using `cmap` to escape each character."
       :group :stdlib.string)

      (set-global-word-defn
       'str/includes? (wrap-function-with-arity 2 str/includes?)
       :stdlib? true
       :doc "( s substr -- bool ) Returns true if `s` includes `substr`."
       :group :stdlib.string)

      (set-global-word-defn
       'str/index-of (wrap-function-with-arity 2 str/index-of)
       :stdlib? true
       :doc "( s substr -- n ) Returns the index of the first occurence of `substr`, otherwise nil."
       :group :stdlib.string)

      (set-global-word-defn
       'str/index-after (wrap-function-with-arity 3 str/index-of)
       :stdlib? true
       :doc "( s substr from-index -- n ) Returns the index of the first occurence of `substr` after `from-index`, otherwise nil."
       :group :stdlib.string)

      (set-global-word-defn
       'str/join (wrap-function-with-arity 2 str/join)
       :stdlib? true
       :doc "( sep coll -- s ) Returns a string of collection `coll` elements separated by `sep`."
       :group :stdlib.string)

      (set-global-word-defn
       'str/last-index-of (wrap-function-with-arity 2 str/last-index-of)
       :stdlib? true
       :doc "( s substr -- n ) Returns the index of the last occurence of `substr`, otherwise nil."
       :group :stdlib.string)

      (set-global-word-defn
       'str/last-index-after (wrap-function-with-arity 3 str/last-index-of)
       :stdlib? true
       :doc "( s substr from-index -- n ) Returns the index of the last occurence of `substr` after `from-index`, otherwise nil."
       :group :stdlib.string)

      (set-global-word-defn
       'str/lower-case (wrap-function-with-arity 1 str/lower-case)
       :stdlib? true
       :doc "( s -- s ) Returns string with all characters in lowercase."
       :group :stdlib.string)

      (set-global-word-defn
       'str/replace (wrap-function-with-arity 3 str/replace)
       :stdlib? true
       :doc "( s re replacement -- s ) Replace all instances in `s` of regex `re` with `replacement`."
       :group :stdlib.string)

      (set-global-word-defn
       'str/replace-first (wrap-function-with-arity 3 str/replace-first)
       :stdlib? true
       :doc "( s re replacement -- s ) Same as str/replace, but replaces only the first occurrence."
       :group :stdlib.string)

      (set-global-word-defn
       'str/split (wrap-function-with-arity 2 str/split)
       :stdlib? true
       :doc "( s re -- vec ) Splits the string at matching regex `re` into a vector of strings `vec`."
       :group :stdlib.string)

      (set-global-word-defn
       'str/splitn (wrap-function-with-arity 3 str/split)
       :stdlib? true
       :doc "( s re n -- vec ) Splits the string at matching regex `re`, but only `n` times, into a vector of strings `vec`."
       :group :stdlib.string)

      (set-global-word-defn
       'str/split-lines (wrap-function-with-arity 1 str/split-lines)
       :stdlib? true
       :doc "( s -- vec ) Split string at \\n or \\r\\n into a vector of strings `vec`."
       :group :stdlib.string)

      (set-global-word-defn
       'str/starts-with? (wrap-function-with-arity 2 str/starts-with?)
       :stdlib? true
       :doc "( str substr -- bool ) Returns true if `str` starts with `substr`."
       :group :stdlib.string)

      (set-global-word-defn
       'str/trim (wrap-function-with-arity 1 str/trim)
       :stdlib? true
       :doc ""
       :group :stdlib.string)

      (set-global-word-defn
       'str/trim-newline (wrap-function-with-arity 1 str/trim-newline)
       :stdlib? true
       :doc "( s -- s ) Removes whitespace from both ends of a string."
       :group :stdlib.string)

      (set-global-word-defn
       'str/triml (wrap-function-with-arity 1 str/triml)
       :stdlib? true
       :doc "( s -- s ) Removes whitespace from the start of a string."
       :group :stdlib.string)

      (set-global-word-defn
       'str/trimr (wrap-function-with-arity 1 str/trimr)
       :stdlib? true
       :doc "( s -- s ) Removes whitespace from the end of a string."
       :group :stdlib.string)

      (set-global-word-defn
       'str/upper-case (wrap-function-with-arity 1 str/upper-case)
       :stdlib? true
       :doc "( s -- s ) Returns the string with all characters uppercase."
       :group :stdlib.string)

      (set-global-word-defn
       'subs (wrap-function-with-arity 3 subs)
       :stdlib? true
       :doc "( s start end -- s ) Returns the substring of `s` between indexes `start` and `end`."
       :group :stdlib.string)

      (set-global-word-defn
       'subvec (wrap-function-with-arity 3 subvec)
       :stdlib? true
       :doc "( v start end -- v ) Returns the subvector of `v` between indexes `start` and `end`."
       :group :stdlib.collection)

      ;; Regex
      (set-global-word-defn
       're-find (wrap-function-with-arity 2 re-find)
       :stdlib? true
       :doc "( re s -- g ) Returns the next regex match of `re` in `s` in the form of a regex group."
       :group :stdlib.regex)

      (set-global-word-defn
       're-find-match (wrap-function-with-arity 1 re-find)
       :stdlib? true
       :doc "( m -- g ) Returns the next regex match of Regex Matcher."
       :group :stdlib.regex)

      (set-global-word-defn
       're-seq (wrap-function-with-arity 2 re-seq)
       :stdlib? true
       :doc "( re s -- coll ) Returns a lazy seq of successive matches of regex `re` in `s`."
       :group :stdlib.regex)

      (set-global-word-defn
       're-matches (wrap-function-with-arity 2 re-matches)
       :stdlib? true
       :doc "( re s -- g ) Returns the match, if any, of string to regex pattern `re` as a re-group."
       :group :stdlib.regex)

      (set-global-word-defn
       're-pattern (wrap-function-with-arity 1 re-pattern)
       :stdlib? true
       :doc "( s -- re ) Creates a regex pattern object from a string."
       :group :stdlib.regex)

      (set-global-word-defn
       'regex (wrap-function-with-arity 1 re-pattern)
       :stdlib? true
       :doc "( s -- re ) Creates a regex pattern object from a string."
       :group :stdlib.regex)

      ;; CLJ Specific
      #?(:clj
         (set-global-word-defn
          'class (wrap-function-with-arity 1 class)
          :stdlib? true
          :doc "( x -- class ) Returns the class of `x`"
          :group :stdlib.repl))

      #?(:clj
         (set-global-word-defn
          're-matcher (wrap-function-with-arity 2 re-matcher)
          :stdlib? true
          :doc "( re s -- matcher ) Returns a java.util.regex.Matcher, for us in re-find-match."
          :group :stdlib.regex))

      #?(:clj
         (set-global-word-defn
          're-groups (wrap-function-with-arity 1 re-groups)
          :stdlib? true
          :doc "( matcher -- g ) Returns the most recent re-group from the most recent re-find-match."
          :group :stdlib.regex))

      ))