Skip to content

A peer-to-peer stack for code collaboration

docs: Remove Pandoc dependency (#214)

Alexander Simmerl98323e33b63f
diff --git a/docs/source/reference.rst b/docs/source/reference.rst
new file mode 100644
index 0000000..1e19ac6
--- /dev/null
+++ b/docs/source/reference.rst
@@ -0,0 +1,883 @@
+Radicle Reference
+=================
+
+These are the functions that are available in a new radicle chain after
+the prelude has been loaded.
+
+Basics
+------
+
+Basic function used for checking equality, determining the type of a
+value, etc.
+
+``eq?``
+~~~~~~~
+
+Checks if two values are equal.
+
+``not``
+~~~~~~~
+
+True if 'arg' is #f, false otherwise.
+
+``and``
+~~~~~~~
+
+Returns 'arg2' if 'arg1' is not #f, otherwise returns 'arg1'
+
+``or``
+~~~~~~
+
+Returns 'arg1' if 'arg1' is not #f, otherwise returns 'arg2'
+
+``all``
+~~~~~~~
+
+Checks that all the items of a list are truthy.
+
+``some``
+~~~~~~~~
+
+Checks that there is a least one truthy value in a list.
+
+``show``
+~~~~~~~~
+
+Returns a string representing the argument value.
+
+``string-append``
+~~~~~~~~~~~~~~~~~
+
+Concatenates a variable number of string arguments. If one of the
+arguments isn't a string then an exception is thrown.
+
+``string-length``
+~~~~~~~~~~~~~~~~~
+
+Returns the length of a string.
+
+``apply``
+~~~~~~~~~
+
+Calls the first argument (a function) using as arguments the elements of
+the the second argument (a list).
+
+``type``
+~~~~~~~~
+
+Returns a keyword representing the type of the argument; one of:
+``:atom``, ``:keyword``, ``:string``, ``:number``, ``:boolean``,
+``:list``, ``:vector``, ``:function``, ``:dict``, ``:ref``,
+``:function``.
+
+``atom?``
+~~~~~~~~~
+
+Checks if the argument is a atom.
+
+``boolean?``
+~~~~~~~~~~~~
+
+Checks if the argument is a boolean.
+
+``string?``
+~~~~~~~~~~~
+
+Checks if the argument is a string.
+
+``number?``
+~~~~~~~~~~~
+
+Checks if the argument is a number.
+
+``keyword?``
+~~~~~~~~~~~~
+
+Checks if the argument is a keyword.
+
+``list?``
+~~~~~~~~~
+
+Checks if the argument is a list.
+
+``dict?``
+~~~~~~~~~
+
+Checks if the argument is a dict.
+
+``read``
+~~~~~~~~
+
+Parses a string into a radicle value. Does not evaluate the value.
+
+``read-many``
+~~~~~~~~~~~~~
+
+Parses a string into a vector of radicle values. Does not evaluate the
+values.
+
+``throw``
+~~~~~~~~~
+
+Throws an exception. The first argument should be an atom used as a
+label for the exception, the second can be any value.
+
+``Y``
+~~~~~
+
+A combinator used to create recursive functions of one variable.
+
+``Y2``
+~~~~~~
+
+A combinator used to create recursive functions of two variables.
+
+``to-json``
+~~~~~~~~~~~
+
+Returns a JSON formatted string representing the input value.
+
+``uuid?``
+~~~~~~~~~
+
+Checks if a string has the format of a UUID.
+
+``make-counter``
+~~~~~~~~~~~~~~~~
+
+Creates a stateful counter. Returns a dict with two keys: the function
+at ``:next-will-be`` will return the next number (without incrementing
+it), while the function at ``:next`` increments the number and returns
+it.
+
+``public-key?``
+~~~~~~~~~~~~~~~
+
+Checks if a value represents a valid public key.
+
+Numerical functions
+-------------------
+
+Operations on numbers.
+
+``+``
+~~~~~
+
+Adds two numbers together.
+
+``*``
+~~~~~
+
+Multiplies two numbers together.
+
+``-``
+~~~~~
+
+Substracts one number from another.
+
+``<``
+~~~~~
+
+Checks if a number is strictly less than another.
+
+``>``
+~~~~~
+
+Checks if a number is strictly greater than another.
+
+``integral?``
+~~~~~~~~~~~~~
+
+Checks if a number is an integer.
+
+Lists
+-----
+
+Functions for manipulating lists.
+
+``list``
+~~~~~~~~
+
+Turns the arguments into a list.
+
+``nil``
+~~~~~~~
+
+The empty list.
+
+``head``
+~~~~~~~~
+
+Retrieves the first element of a sequence if it exists. Otherwise throws
+an exception.
+
+``tail``
+~~~~~~~~
+
+Given a non-empty sequence, returns the sequence of all the elements but
+the first. If the sequence is empty, throws an exception.
+
+``empty?``
+~~~~~~~~~~
+
+True if 'seq' is empty, false otherwise.
+
+``cons``
+~~~~~~~~
+
+Adds an element to the front of a list.
+
+``reverse``
+~~~~~~~~~~~
+
+Returns the reversed 'list'.
+
+``length``
+~~~~~~~~~~
+
+Returns the length of 'list'.
+
+``concat``
+~~~~~~~~~~
+
+Concatenates 'list1' and 'list2'.
+
+``filter``
+~~~~~~~~~~
+
+Returns 'list' with only the elements that satisfy 'filter-cond'.
+
+``range``
+~~~~~~~~~
+
+Returns a list with all integers from 'start' to 'end', inclusive.
+
+``list-with-head``
+~~~~~~~~~~~~~~~~~~
+
+Given a value ``x``, and two functions ``f`` and ``g``, checks if ``x``
+is a list with a head. If so applies ``f`` to the head, otherwise calls
+``g`` with no args.
+
+Vectors
+-------
+
+Functions for manipulating vectors.
+
+``<>``
+~~~~~~
+
+Concatenates two vectors.
+
+``add-left``
+~~~~~~~~~~~~
+
+Adds an element to the left side of a vector.
+
+``add-right``
+~~~~~~~~~~~~~
+
+Adds an element to the right side of a vector.
+
+Sequences
+---------
+
+Functions for manipulating boths lists and vectors.
+
+``nth``
+~~~~~~~
+
+Given an integral number ``n`` and ``xs``, returns the ``n``\ th element
+(zero indexed) of ``xs`` when ``xs`` is a list or a vector. If ``xs``
+does not have an ``n``-th element, or if it is not a list or vector,
+then an exception is thrown.
+
+``foldl``
+~~~~~~~~~
+
+Given a function ``f``, an initial value ``i`` and a sequence (list or
+vector) ``xs``, reduces ``xs`` to a single value by starting with ``i``
+and repetitively combining values with ``f``, using elements of ``xs``
+from left to right.
+
+``foldr``
+~~~~~~~~~
+
+Given a function ``f``, an initial value ``i`` and a sequence (list or
+vector) ``xs``, reduces ``xs`` to a single value by starting with ``i``
+and repetitively combining values with ``f``, using elements of ``xs``
+from right to left.
+
+``map``
+~~~~~~~
+
+Given a function ``f`` and a sequence (list or vector) ``xs``, returns a
+sequence of the same size and type as ``xs`` but with ``f`` applied to
+all the elements.
+
+``seq``
+~~~~~~~
+
+Given a structure ``s``, returns a sequence. Lists and vectors are
+returned without modification while for dicts a vector of
+key-value-pairs is returned: these are vectors of length 2 whose first
+item is a key and whose second item is the associated value.
+
+``take``
+~~~~~~~~
+
+Returns the first ``n`` items of a sequence, unless the sequence is too
+short, in which case an exception is thrown.
+
+``drop``
+~~~~~~~~
+
+Returns all but the first ``n`` items of a sequence, unless the sequence
+is empty, in which case an exception is thrown.
+
+Dicts
+-----
+
+Functions for manipulating dicts.
+
+``dict``
+~~~~~~~~
+
+Given an even number of arguments, creates a dict where the ``2i``-th
+argument is the key for the ``2i+1``\ th argument.
+
+``lookup``
+~~~~~~~~~~
+
+Given a value ``k`` (the 'key') and a dict ``d``, returns the value
+associated with ``k`` in ``d``. If the key does not exist in ``d`` then
+``()`` is returned instead. If ``d`` is not a dict then an exception is
+thrown.
+
+``insert``
+~~~~~~~~~~
+
+Given ``k``, ``v`` and a dict ``d``, returns a dict with the same
+associations as ``d`` but with ``k`` associated to ``d``. If ``d`` isn't
+a dict then an exception is thrown.
+
+``delete``
+~~~~~~~~~~
+
+Given ``k`` and a dict ``d``, returns a dict with the same associations
+as ``d`` but without the key ``k``. If ``d`` isn't a dict then an
+exception is thrown.
+
+``dict-from-list``
+~~~~~~~~~~~~~~~~~~
+
+Creates a dictionary from a list of key-value pairs.
+
+``keys``
+~~~~~~~~
+
+Given a ``dict``, returns a vector of its keys.
+
+``values``
+~~~~~~~~~~
+
+Given a ``dict``, returns a vector of its values.
+
+``rekey``
+~~~~~~~~~
+
+Change the key from 'old-key' to 'new-key' in 'dict'. If 'new-key'
+already exists, it is overwritten.
+
+``map-values``
+~~~~~~~~~~~~~~
+
+Given a function ``f`` and a dict ``d``, returns a dict with the same
+keys as ``d`` but ``f`` applied to all the associated values.
+
+``modify-map``
+~~~~~~~~~~~~~~
+
+Given a key, a function and a dict, applies the function to the value
+associated to that key.
+
+Structures
+----------
+
+Functions for manipulating lists, vectors and dicts.
+
+``member?``
+~~~~~~~~~~~
+
+Given ``v`` and structure ``s``, checks if ``x`` exists in ``s``. The
+structure ``s`` may be a list, vector or dict. If it is a list or a
+vector, it checks if ``v`` is one of the items. If ``s`` is a dict, it
+checks if ``v`` is one of the keys.
+
+Refs
+----
+
+Functions for creating, querying and modifying refs.
+
+``ref``
+~~~~~~~
+
+Creates a ref with the argument as the initial value.
+
+``read-ref``
+~~~~~~~~~~~~
+
+Returns the current value of a ref.
+
+``write-ref``
+~~~~~~~~~~~~~
+
+Given a reference ``r`` and a value ``v``, updates the value stored in
+``r`` to be ``v`` and returns ``v``.
+
+``modify-ref``
+~~~~~~~~~~~~~~
+
+Modify 'ref' by applying the provided function. Returns the new value.
+
+Evaluation functions
+--------------------
+
+Utilities for creating and extending evaluation functions.
+
+``base-eval``
+~~~~~~~~~~~~~
+
+The default evaluation function. Expects an expression and a radicle
+state. Return a list of length 2 consisting of the result of the
+evaluation and the new state.
+
+``eval``
+~~~~~~~~
+
+An eval in which one can use ``(:enter-chain url)`` to make the eval
+behave as that of a remote chain, and ``:send`` to send all enqueued
+expressions.
+
+``updatable-eval``
+~~~~~~~~~~~~~~~~~~
+
+Given an evaluation function ``f``, returns a new one which augments
+``f`` with a new command ``(update expr)`` which evaluates arbitrary
+expression using ``base-eval``.
+
+Documentation and testing
+-------------------------
+
+Functions for creating and querying documentation of variables in scope,
+and testing functions.
+
+``doc``
+~~~~~~~
+
+Returns the documentation string for a variable. To print it instead,
+use ``doc!``.
+
+``doc!``
+~~~~~~~~
+
+Prints the documentation attached to a value and returns ``()``. To
+retrieve the docstring as a value use ``doc`` instead.
+
+``apropos!``
+~~~~~~~~~~~~
+
+Prints documentation for all documented variables in scope.
+
+``document``
+~~~~~~~~~~~~
+
+Used to add documentation to variables.
+
+``is-test-env``
+~~~~~~~~~~~~~~~
+
+True iff file is being run as part of the Haskell suite
+
+Environment functions
+---------------------
+
+Utilities for modifying the current environment.
+
+``pure-env``
+~~~~~~~~~~~~
+
+Returns a pure initial radicle state. This is the state of a radicle
+chain before it has processed any inputs.
+
+``get-current-env``
+~~~~~~~~~~~~~~~~~~~
+
+Returns the current radicle state.
+
+``set-current-env``
+~~~~~~~~~~~~~~~~~~~
+
+Replaces the radicle state with the one provided.
+
+``set-env!``
+~~~~~~~~~~~~
+
+Given an atom ``x`` and a value ``v``, sets the value associated to
+``x`` in the current environemtn to be ``v``. Doesn't evaluate ``v``.
+
+Input/Output
+------------
+
+Effectful functions. These functions are not available in 'pure' chains,
+but are available in the local REPL.
+
+``print!``
+~~~~~~~~~~
+
+Pretty-prints a value.
+
+``get-line!``
+~~~~~~~~~~~~~
+
+Reads a single line of input and returns it as a string.
+
+``load!``
+~~~~~~~~~
+
+Evaluates the contents of a file. Each seperate radicle expression is
+``eval``\ uated according to the current definition of ``eval``.
+
+``read-file!``
+~~~~~~~~~~~~~~
+
+Reads the contents of a file and returns it as a string.
+
+``read-code!``
+~~~~~~~~~~~~~~
+
+Read code (as data) from a file. Returns a vector of expressions
+
+``send-code!``
+~~~~~~~~~~~~~~
+
+Send code from a file to a remote chain.
+
+``send-prelude!``
+~~~~~~~~~~~~~~~~~
+
+Send the pure prelude to a chain.
+
+``subscribe-to!``
+~~~~~~~~~~~~~~~~~
+
+Expects a dict ``s`` (representing a subscription) and a function ``f``.
+The dict ``s`` should have a function ``getter`` at the key ``:getter``.
+This function is called repeatedly (with no arguments), its result is
+then evaluated and passed to ``f``.
+
+``uuid!``
+~~~~~~~~~
+
+Generates a random UUID.
+
+``read-line!``
+~~~~~~~~~~~~~~
+
+Read a single line of input and interpret it as radicle data.
+
+``exit!``
+~~~~~~~~~
+
+Exit the interpreter immediately.
+
+Lenses
+------
+
+Functional references into radicle values.
+
+``@``
+~~~~~
+
+Returns a lens targetting keys of dicts.
+
+``@nth``
+~~~~~~~~
+
+Lenses into the nth element of a vector
+
+``make-lens``
+~~~~~~~~~~~~~
+
+Makes a lens out of a getter and a setter.
+
+``view``
+~~~~~~~~
+
+View a value through a lens.
+
+``view-ref``
+~~~~~~~~~~~~
+
+Like 'view', but for refs.
+
+``set``
+~~~~~~~
+
+Set a value though a lens.
+
+``set-ref``
+~~~~~~~~~~~
+
+Like 'set', but for refs.
+
+``over``
+~~~~~~~~
+
+Modify a value through a lens.
+
+``over-ref``
+~~~~~~~~~~~~
+
+Like 'over', but for refs.
+
+``id-lens``
+~~~~~~~~~~~
+
+The identity lens.
+
+``..``
+~~~~~~
+
+Compose two lenses.
+
+``...``
+~~~~~~~
+
+Compose multiple lenses.
+
+Validation
+----------
+
+Functions for creating or combining *validators*, which are functions
+which return the input unchanged or throw with an error message. These
+can be used for checking data before accepting it onto a chain.
+
+``validator/=``
+~~~~~~~~~~~~~~~
+
+Given ``x``, returns a validator that checks for equality with ``x``.
+
+``validator/member``
+~~~~~~~~~~~~~~~~~~~~
+
+Given a structure, returns a validator which checks for membership in
+the structure.
+
+``validator/type``
+~~~~~~~~~~~~~~~~~~
+
+Checks that a value has a type. Expects a keyword describing the type,
+as returned by the ``type`` function.
+
+``validator/pred``
+~~~~~~~~~~~~~~~~~~
+
+Given a description and a predicate, returns a validator that checks if
+the predicate is true.
+
+``validator/every``
+~~~~~~~~~~~~~~~~~~~
+
+Given a validator, creates a new validator which checks that all the
+items in a sequence conform to it.
+
+``validator/and``
+~~~~~~~~~~~~~~~~~
+
+Given a sequence of validators ``vs``, returns a new validator which,
+given a value, checks if it conforms to all the validators in ``vs``.
+
+``validator/or``
+~~~~~~~~~~~~~~~~
+
+Given a vector of validators ``vs``, returns a new validator which,
+given a value, checks if it conforms to at least one of the ``vs``.
+
+``validator/key``
+~~~~~~~~~~~~~~~~~
+
+Given a key and a validator, returns a validator which checks for the
+existence of that key and that the associated value conforms to the
+validator.
+
+``validator/keys``
+~~~~~~~~~~~~~~~~~~
+
+Given a dict associating keys to validators, returns a validator which
+checks a dict for the existence of those keys, and that they conform to
+the associated validators.
+
+Cryptography
+------------
+
+Tools for creating and verifying cryptographic signatures, and
+generating private/public key pairs.
+
+``verify-signature``
+~~~~~~~~~~~~~~~~~~~~
+
+Given a public key ``pk``, a signature ``s`` and a message (string)
+``m``, checks that ``s`` is a signature of ``m`` for the public key
+``pk``.
+
+``default-ecc-curve``
+~~~~~~~~~~~~~~~~~~~~~
+
+Returns the default elliptic-curve used for generating cryptographic
+keys.
+
+``gen-key-pair!``
+~~~~~~~~~~~~~~~~~
+
+Given an elliptic curve, generates a cryptographic key-pair. Use
+``default-ecc-curve`` for a default value for the elliptic curve.
+
+``gen-signature!``
+~~~~~~~~~~~~~~~~~~
+
+Given a private key and a message (a string), generates a cryptographic
+signature for the message.
+
+Chain tools
+-----------
+
+These functions can be used to simulate remote chains in the local REPL.
+This is useful for experimenting with inputs or even new evaluation
+functions before sending these to a remote chain.
+
+``new-chain``
+~~~~~~~~~~~~~
+
+Return an empty chain dictionary with the given url.
+
+``eval-in-chain``
+~~~~~~~~~~~~~~~~~
+
+Evaluates 'expr' in the 'chain' and returns a dict with the ':result'
+and the resulting ':chain'.
+
+``enter-remote-chain``
+~~~~~~~~~~~~~~~~~~~~~~
+
+Make the eval behave as that of a remote chain. The second param is the
+env to return to after :quit.
+
+``update-chain``
+~~~~~~~~~~~~~~~~
+
+Takes a chain, and returns a new chain updated with the new expressions
+from the remote chain
+
+``add-quit``
+~~~~~~~~~~~~
+
+Adds a ':quit' command to 'before-quit-eval', which switches to
+'after-quit-state' (and to the eval in that state)
+
+``add-send``
+~~~~~~~~~~~~
+
+Add a :send special form that sends the contents of *input to the
+chain*\ cur-chain
+
+``load-chain``
+~~~~~~~~~~~~~~
+
+Takes a ``url``, and fetches the inputs of a remote chain and return a
+chain dictionary with the chain state.
+
+``pure-prelude-files``
+~~~~~~~~~~~~~~~~~~~~~~
+
+List of files which together define the pure prelude.
+
+``pure-prelude-code``
+~~~~~~~~~~~~~~~~~~~~~
+
+The pure prelude.
+
+``store-exprs``
+~~~~~~~~~~~~~~~
+
+Store each new evaluated expression in '_inputs'
+
+``eval-fn-app``
+~~~~~~~~~~~~~~~
+
+Given a state, a function, an argument and a callback, returns the
+result of evaluating the function call on the arg in the given state,
+while also calling the callback on the result.
+
+``state-machine-eval``
+~~~~~~~~~~~~~~~~~~~~~~
+
+Returns an eval which operates a state machine whose transition function
+may be updated. To update the transition function all voters must agree
+on it.
+
+``state-machine-input``
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Handle an input in the morphing state-machine.
+
+``state-machine-new-trans``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Trigger a new vote.
+
+``state-machine-agree``
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Vote to agree on a new transition function.
+
+``state-machine-disagree``
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Vote to disagree on a new transition function.
+
+``simple-trans``
+~~~~~~~~~~~~~~~~
+
+Given a function ``f``, makes a transition function who's output is also
+the next state.
+
+``update-chain-ref``
+~~~~~~~~~~~~~~~~~~~~
+
+Update a ref containing a chain with the new expressions from the remote
+chain
+
+Issue chain
+-----------
+
+These functions allow creating and interacting with the default issues
+chain.
+
+``create-issues-chain!``
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Create a remote issue chain with the given url. Returns a ref with the
+chain.
+
+``list-issues``
+~~~~~~~~~~~~~~~
+
+Given an issues ref ``x``, returns its issues. Does not itself update
+the chain.
+
+``new-issue!``
+~~~~~~~~~~~~~~
+
+Create a new remote issue. Takes a chain ref, a keypair, an issue title
+and an issue body.
\ No newline at end of file
diff --git a/exe/RadicleExe.hs b/exe/RadicleExe.hs
index 9f064cb..5915259 100644
--- a/exe/RadicleExe.hs
+++ b/exe/RadicleExe.hs
@@ -1,5 +1,3 @@
-{-# LANGUAGE QuasiQuotes #-}
-
module RadicleExe (main) where
import API
@@ -17,7 +15,6 @@ import Servant.Client
import System.Console.Haskeline (InputT)
import System.Directory (doesFileExist)
-import Radicle.Internal.Doc (md)
import qualified Radicle.Internal.PrimFns as PrimFns
main :: IO ()
@@ -83,8 +80,8 @@ clientPrimFns mgr = fromList . PrimFns.allDocs $ [sendPrimop, receivePrimop]
where
sendPrimop =
( "send!"
- , [md|Given a URL (string) and a value, sends the value `v` to the remote
- chain located at the URL for evaluation.|]
+ , "Given a URL (string) and a value, sends the value `v` to the remote\
+ \ chain located at the URL for evaluation."
, \case
[String url, Vec v] -> do
res <- liftIO $ runClientM' url mgr (submit $ toList v)
@@ -98,8 +95,8 @@ clientPrimFns mgr = fromList . PrimFns.allDocs $ [sendPrimop, receivePrimop]
)
receivePrimop =
( "receive!"
- , [md|Given a URL (string) and a integral number `n`, queries the remote chain
- for the last `n` inputs that have been evaluated.|]
+ , "Given a URL (string) and a integral number `n`, queries the remote chain\
+ \ for the last `n` inputs that have been evaluated."
, \case
[String url, Number n] -> do
case floatingOrInteger n of
diff --git a/exe/ReferenceDoc.hs b/exe/ReferenceDoc.hs
index c75dbf5..5329b12 100644
--- a/exe/ReferenceDoc.hs
+++ b/exe/ReferenceDoc.hs
@@ -1,4 +1,3 @@
-{-# LANGUAGE QuasiQuotes #-}
-- | This executable generates the radicle reference docs. This is a markdown
-- document which contains documentation for all the primitive functions and all
-- the functions defined in the prelude.
@@ -12,7 +11,6 @@ import qualified Data.Map.Strict as Map
import qualified Data.Text as T
import qualified GHC.Exts as GhcExts
import Radicle
-import Radicle.Internal.Doc (md)
import System.Console.Haskeline (defaultSettings, runInputT)
import Text.Pandoc
@@ -62,23 +60,23 @@ main = do
, sec "Lenses" lens
"Functional references into radicle values."
, sec "Validation" validation
- [md|Functions for creating or combining *validators*, which are functions which return the
- input unchanged or throw with an error message. These can be used for checking data before
- accepting it onto a chain.|]
+ "Functions for creating or combining *validators*, which are functions which return the\
+ \ input unchanged or throw with an error message. These can be used for checking data before\
+ \ accepting it onto a chain."
, sec "Cryptography" crypto
"Tools for creating and verifying cryptographic signatures, and generating private/public key pairs."
, sec "Chain tools" chainTools
- [md|These functions can be used to simulate remote chains in the local REPL.
- This is useful for experimenting with inputs or even new evaluation functions
- before sending these to a remote chain.|]
+ "These functions can be used to simulate remote chains in the local REPL.\
+ \ This is useful for experimenting with inputs or even new evaluation functions\
+ \ before sending these to a remote chain."
, sec "Issue chain" issueChain
- [md|These functions allow creating and interacting with the default issues chain.|]
+ "These functions allow creating and interacting with the default issues chain."
]
basics =
[ "eq?", "not", "and", "or", "all", "some", "show", "string-append", "string-length"
, "apply", "type", "atom?", "boolean?", "string?", "number?", "keyword?", "list?"
- , "dict?", "read", "read-many", "throw", "Y", "Y2", "to-json", "uuid?", "make-counter", "markdown?"
+ , "dict?", "read", "read-many", "throw", "Y", "Y2", "to-json", "uuid?", "make-counter"
, "public-key?" ]
maths = ["+", "*", "-", "<", ">", "integral?"]
evalFns = ["base-eval", "eval", "updatable-eval"]
diff --git a/package.yaml b/package.yaml
index 78fe690..678b1e8 100644
--- a/package.yaml
+++ b/package.yaml
@@ -22,7 +22,6 @@ dependencies:
- haskeline
- megaparsec
- mtl
-- pandoc
- pointed
- prettyprinter
- prettyprinter-ansi-terminal
diff --git a/src/Radicle/Internal/Doc.hs b/src/Radicle/Internal/Doc.hs
index 6bbf206..0e8a4e7 100644
--- a/src/Radicle/Internal/Doc.hs
+++ b/src/Radicle/Internal/Doc.hs
@@ -1,5 +1,4 @@
{-# LANGUAGE DuplicateRecordFields #-}
-{-# LANGUAGE TemplateHaskell #-}
module Radicle.Internal.Doc where
@@ -7,9 +6,6 @@ import Protolude hiding (Any)
import Codec.Serialise (Serialise(..))
import Data.Copointed (Copointed(..))
-import qualified Data.Default as Default
-import Language.Haskell.TH.Quote
-import Text.Pandoc
data Docd a = Docd (Maybe Text) a
deriving (Show, Read, Functor, Foldable, Traversable, Generic)
@@ -31,21 +27,3 @@ instance Ord a => Ord (Docd a) where
noDocs :: [(a, c)] -> [(a, Maybe b, c)]
noDocs = fmap $ \(x,y) -> (x, Nothing, y)
--- | A quasiquoter that checks if a string is valid pandoc-markdown, then
--- returns the markdown with better formatting.
-md :: QuasiQuoter
-md = QuasiQuoter
- { quoteExp = \s -> [| case cleanupPandocMd s of
- Left e -> panic $ "Not valid pandoc-markdown: " <> show e
- Right s' -> s' |]
- , quoteType = err
- , quotePat = err
- , quoteDec = err
- }
- where
- err = panic "pan only works for expressions"
-
-cleanupPandocMd :: Text -> Either PandocError Text
-cleanupPandocMd s = runPure $ do
- p <- readMarkdown Default.def s
- writeMarkdown Default.def p
diff --git a/src/Radicle/Internal/Effects.hs b/src/Radicle/Internal/Effects.hs
index ea38202..3eda050 100644
--- a/src/Radicle/Internal/Effects.hs
+++ b/src/Radicle/Internal/Effects.hs
@@ -1,5 +1,4 @@
{-# OPTIONS_GHC -fno-warn-orphans #-}
-{-# LANGUAGE QuasiQuotes #-}
module Radicle.Internal.Effects where
@@ -23,7 +22,6 @@ import System.Console.Haskeline
import Radicle.Internal.Core
import Radicle.Internal.Crypto
-import Radicle.Internal.Doc (md)
import Radicle.Internal.Effects.Capabilities
import Radicle.Internal.Interpret
import Radicle.Internal.Pretty
@@ -79,7 +77,7 @@ replBindings = addPrimFns replPrimFns pureEnv
replPrimFns :: ReplM m => PrimFns m
replPrimFns = fromList $ allDocs $
[ ("print!"
- , [md|Pretty-prints a value.|]
+ , "Pretty-prints a value."
, \case
[x] -> do
putStrS (renderPrettyDef x)
@@ -87,8 +85,8 @@ replPrimFns = fromList $ allDocs $
xs -> throwErrorHere $ WrongNumberOfArgs "print!" 1 (length xs))
, ( "doc!"
- , [md|Prints the documentation attached to a value and returns `()`. To retreive
- the docstring as a value use `doc` instead.|]
+ , "Prints the documentation attached to a value and returns `()`. To retrieve\
+ \ the docstring as a value use `doc` instead."
, oneArg "doc!" $ \case
Atom i -> do
d <- lookupAtomDoc i
@@ -98,7 +96,7 @@ replPrimFns = fromList $ allDocs $
)
, ( "apropos!"
- , [md|Prints documentation for all documented variables in scope.|]
+ , "Prints documentation for all documented variables in scope."
, \case
[] -> do
env <- gets bindingsEnv
@@ -109,8 +107,8 @@ replPrimFns = fromList $ allDocs $
)
, ( "set-env!"
- , [md|Given an atom `x` and a value `v`, sets the value associated to `x` in
- the current environemtn to be `v`. Doesn't evaluate `v`.|]
+ , "Given an atom `x` and a value `v`, sets the value associated to `x` in\
+ \ the current environemtn to be `v`. Doesn't evaluate `v`."
, \case
[Atom x, v] -> do
defineAtom x Nothing v
@@ -119,16 +117,16 @@ replPrimFns = fromList $ allDocs $
xs -> throwErrorHere $ WrongNumberOfArgs "set-env!" 2 (length xs))
, ( "get-line!"
- , [md|Reads a single line of input and returns it as a string.|]
+ , "Reads a single line of input and returns it as a string."
, \case
[] -> maybe nil toRad <$> getLineS
xs -> throwErrorHere $ WrongNumberOfArgs "get-line!" 0 (length xs)
)
, ("subscribe-to!"
- , [md|Expects a dict `s` (representing a subscription) and a function `f`. The dict
- `s` should have a function `getter` at the key `:getter`. This function is called
- repeatedly (with no arguments), its result is then evaluated and passed to `f`.|]
+ , "Expects a dict `s` (representing a subscription) and a function `f`. The dict\
+ \ `s` should have a function `getter` at the key `:getter`. This function is called\
+ \ repeatedly (with no arguments), its result is then evaluated and passed to `f`."
, \case
[x, v] -> do
e <- gets bindingsEnv
@@ -163,7 +161,7 @@ replPrimFns = fromList $ allDocs $
_ -> throwErrorHere $ TypeError "subscribe-to!: Expected dict"
xs -> throwErrorHere $ WrongNumberOfArgs "subscribe-to!" 2 (length xs))
, ( "read-file!"
- , [md|Reads the contents of a file and returns it as a string.|]
+ , "Reads the contents of a file and returns it as a string."
, oneArg "read-file" $ \case
String filename -> readFileS filename >>= \case
Left err -> throwErrorHere . OtherError $ "Error reading file: " <> err
@@ -171,8 +169,8 @@ replPrimFns = fromList $ allDocs $
_ -> throwErrorHere $ TypeError "read-file: expects a string"
)
, ( "load!"
- , [md|Evaluates the contents of a file. Each seperate radicle expression is
- `eval`uated according to the current definition of `eval`.|]
+ , "Evaluates the contents of a file. Each seperate radicle expression is\
+ \ `eval`uated according to the current definition of `eval`."
, oneArg "load!" $ \case
String filename -> readFileS filename >>= \case
Left err -> throwErrorHere . OtherError $ "Error reading file: " <> err
@@ -180,8 +178,8 @@ replPrimFns = fromList $ allDocs $
_ -> throwErrorHere $ TypeError "load: expects a string"
)
, ( "gen-key-pair!"
- , [md|Given an elliptic curve, generates a cryptographic key-pair. Use
- `default-ecc-curve` for a default value for the elliptic curve.|]
+ , "Given an elliptic curve, generates a cryptographic key-pair. Use\
+ \ `default-ecc-curve` for a default value for the elliptic curve."
, oneArg "gen-key-pair!" $ \case
curvev -> do
curve <- hoistEither . first (toLangError . OtherError) $ fromRad curvev
@@ -194,8 +192,8 @@ replPrimFns = fromList $ allDocs $
]
)
, ( "gen-signature!"
- , [md|Given a private key and a message (a string), generates a cryptographic
- signature for the message.|]
+ , "Given a private key and a message (a string), generates a cryptographic\
+ \ signature for the message."
, \case
[skv, String msg] -> do
sk <- hoistEither . first (toLangError . OtherError) $ fromRad skv
@@ -203,13 +201,13 @@ replPrimFns = fromList $ allDocs $
_ -> throwErrorHere $ TypeError "gen-signature!: expects a string."
)
, ( "uuid!"
- , [md|Generates a random UUID.|]
+ , "Generates a random UUID."
, \case
[] -> String <$> UUID.uuid
xs -> throwErrorHere $ WrongNumberOfArgs "uuid!" 0 (length xs)
)
, ( "exit!"
- , [md|Exit the interpreter immediately.|]
+ , "Exit the interpreter immediately."
, \case
[] -> throwErrorHere Exit
xs -> throwErrorHere $ WrongNumberOfArgs "exit!" 0 (length xs)
diff --git a/src/Radicle/Internal/PrimFns.hs b/src/Radicle/Internal/PrimFns.hs
index 6bb2ecb..cabbd59 100644
--- a/src/Radicle/Internal/PrimFns.hs
+++ b/src/Radicle/Internal/PrimFns.hs
@@ -1,11 +1,8 @@
-{-# LANGUAGE QuasiQuotes #-}
-
module Radicle.Internal.PrimFns where
import Protolude hiding (TypeError)
import qualified Data.Aeson as Aeson
-import qualified Data.Default as Default
import qualified Data.IntMap as IntMap
import qualified Data.Map as Map
import Data.Scientific (Scientific, floatingOrInteger)
@@ -14,12 +11,10 @@ import qualified Data.Sequence as Seq
import qualified Data.Text as T
import GHC.Exts (IsList(..))
import Text.Megaparsec (parseErrorPretty)
-import qualified Text.Pandoc as Pandoc
import qualified Radicle.Internal.Annotation as Ann
import Radicle.Internal.Core
import Radicle.Internal.Crypto
-import Radicle.Internal.Doc (md)
import qualified Radicle.Internal.Doc as Doc
import Radicle.Internal.Parse
import Radicle.Internal.Pretty
@@ -32,8 +27,8 @@ pureEnv =
where
e = fromList . allDocs $
[ ( "eval"
- , [md|The evaluation function used to evaluate inputs. Intially
- this is set to `base-eval`.|]
+ , "The evaluation function used to evaluate inputs. Intially\
+ \this is set to `base-eval`."
, PrimFn $ unsafeToIdent "base-eval"
)
]
@@ -56,9 +51,9 @@ addPrimFns primFns bindings =
purePrimFns :: forall m. (Monad m) => PrimFns m
purePrimFns = fromList $ allDocs $
[ ( "base-eval"
- , [md|The default evaluation function. Expects an expression and a radicle
- state. Return a list of length 2 consisting of the result of the
- evaluation and the new state.|]
+ , "The default evaluation function. Expects an expression and a radicle\
+ \ state. Return a list of length 2 consisting of the result of the\
+ \ evaluation and the new state."
, \case
[expr, st] -> case (fromRad st :: Either Text (Bindings ())) of
Left e -> throwErrorHere $ OtherError e
@@ -71,38 +66,38 @@ purePrimFns = fromList $ allDocs $
xs -> throwErrorHere $ WrongNumberOfArgs "base-eval" 2 (length xs)
)
, ( "pure-env"
- , [md|Returns a pure initial radicle state. This is the state of a radicle
- chain before it has processed any inputs.|]
+ , "Returns a pure initial radicle state. This is the state of a radicle\
+ \ chain before it has processed any inputs."
, \case
[] -> pure $ toRad (pureEnv :: Bindings (PrimFns m))
xs -> throwErrorHere $ WrongNumberOfArgs "pure-env" 0 (length xs)
)
, ("apply"
- , [md|Calls the first argument (a function) using as arguments the
- elements of the the second argument (a list).|]
+ , "Calls the first argument (a function) using as arguments the\
+ \ elements of the the second argument (a list)."
, \case
[fn, List args] -> callFn fn args
[_, _] -> throwErrorHere $ TypeError "apply: expecting list as second arg"
xs -> throwErrorHere $ WrongNumberOfArgs "apply" 2 (length xs))
, ( "read"
- , [md|Parses a string into a radicle value. Does not evaluate the value.|]
+ , "Parses a string into a radicle value. Does not evaluate the value."
, oneArg "read" $ \case
String s -> readValue s
_ -> throwErrorHere $ TypeError "read: expects string"
)
, ( "read-many"
- , [md|Parses a string into a vector of radicle values. Does not evaluate the values.|]
+ , "Parses a string into a vector of radicle values. Does not evaluate the values."
, oneArg "read-many" $ \case
String s -> readValues s
_ -> throwErrorHere $ TypeError "read-many: expects string"
)
, ("get-current-env"
- , [md|Returns the current radicle state.|]
+ , "Returns the current radicle state."
, \case
[] -> toRad <$> get
xs -> throwErrorHere $ WrongNumberOfArgs "get-current-env" 0 (length xs))
, ( "set-current-env"
- , [md|Replaces the radicle state with the one provided.|]
+ , "Replaces the radicle state with the one provided."
, oneArg "set-current-env" $ \x -> do
e' :: Bindings () <- fromRadOtherErr x
e <- get
@@ -113,41 +108,41 @@ purePrimFns = fromList $ allDocs $
pure ok
)
, ("list"
- , [md|Turns the arguments into a list.|]
+ , "Turns the arguments into a list."
, pure . List)
, ("dict"
- , [md|Given an even number of arguments, creates a dict where the `2i`-th argument
- is the key for the `2i+1`th argument.|]
+ , "Given an even number of arguments, creates a dict where the `2i`-th argument\
+ \ is the key for the `2i+1`th argument."
, (Dict . foldr (uncurry Map.insert) mempty <$>)
. evenArgs "dict")
, ("throw"
- , [md|Throws an exception. The first argument should be an atom used as a label for
- the exception, the second can be any value.|]
+ , "Throws an exception. The first argument should be an atom used as a label for\
+ \ the exception, the second can be any value."
, \case
[Atom label, exc] -> throwErrorHere $ ThrownError label exc
[_, _] -> throwErrorHere $ TypeError "throw: first argument must be atom"
xs -> throwErrorHere $ WrongNumberOfArgs "throw" 2 (length xs))
, ( "eq?"
- , [md|Checks if two values are equal.|]
+ , "Checks if two values are equal."
, \case
[a, b] -> pure $ Boolean (a == b)
xs -> throwErrorHere $ WrongNumberOfArgs "eq?" 2 (length xs))
-- Vectors
, ( "<>"
- , [md|Concatenates two vectors.|]
+ , "Concatenates two vectors."
, twoArg "<>" $ \case
(Vec xs, Vec ys) -> pure $ Vec (xs Seq.>< ys)
_ -> throwErrorHere $ TypeError "<>: both arguments must be vectors"
)
, ( "add-left"
- , [md|Adds an element to the left side of a vector.|]
+ , "Adds an element to the left side of a vector."
, twoArg "add-left" $ \case
(x, Vec xs) -> pure $ Vec (x :<| xs)
_ -> throwErrorHere $ TypeError "add-left: second argument must be a vector"
)
, ( "add-right"
- , [md|Adds an element to the right side of a vector.|]
+ , "Adds an element to the right side of a vector."
, twoArg "add-right" $ \case
(x, Vec xs) -> pure $ Vec (xs :|> x)
_ -> throwErrorHere $ TypeError "add-right: second argument must be a vector"
@@ -155,14 +150,14 @@ purePrimFns = fromList $ allDocs $
-- Lists
, ("cons"
- , [md|Adds an element to the front of a list.|]
+ , "Adds an element to the front of a list."
, \case
[x, List xs] -> pure $ List (x:xs)
[_, _] -> throwErrorHere $ TypeError "cons: second argument must be list"
xs -> throwErrorHere $ WrongNumberOfArgs "cons" 2 (length xs))
, ("head"
- , [md|Retrieves the first element of a sequence if it exists. Otherwise throws an
- exception.|]
+ , "Retrieves the first element of a sequence if it exists. Otherwise throws an\
+ \ exception."
, oneArg "head" $ \case
List (x:_) -> pure x
List [] -> throwErrorHere $ OtherError "head: empty list"
@@ -170,8 +165,8 @@ purePrimFns = fromList $ allDocs $
Vec Seq.Empty -> throwErrorHere $ OtherError "head: empty vector"
_ -> throwErrorHere $ TypeError "head: expects sequence argument")
, ("tail"
- , [md|Given a non-empty sequence, returns the sequence of all the elements but the
- first. If the sequence is empty, throws an exception.|]
+ , "Given a non-empty sequence, returns the sequence of all the elements but the\
+ \ first. If the sequence is empty, throws an exception."
, oneArg "tail" $ \case
List (_:xs) -> pure $ List xs
List [] -> throwErrorHere $ OtherError "tail: empty list"
@@ -181,8 +176,8 @@ purePrimFns = fromList $ allDocs $
-- Lists and Vecs
, ( "drop"
- , [md|Returns all but the first `n` items of a sequence, unless the sequence is empty,
- in which case an exception is thrown.|]
+ , "Returns all but the first `n` items of a sequence, unless the sequence is empty,\
+ \ in which case an exception is thrown."
, twoArg "drop" $ \case
(Number n, vs) -> case floatingOrInteger n of
Left (_ :: Double) -> throwErrorHere $ OtherError "drop: first argument must be an integer"
@@ -193,8 +188,8 @@ purePrimFns = fromList $ allDocs $
_ -> throwErrorHere $ TypeError $ "drop: first argument must be a number"
)
, ( "take"
- , [md|Returns the first `n` items of a sequence, unless the sequence is too short,
- in which case an exception is thrown.|]
+ , "Returns the first `n` items of a sequence, unless the sequence is too short,\
+ \ in which case an exception is thrown."
, twoArg "take" $ \case
(Number n, vs) -> case floatingOrInteger n of
Left (_ :: Double) -> throwErrorHere $ OtherError "take: first argument must be an integer"
@@ -205,10 +200,10 @@ purePrimFns = fromList $ allDocs $
_ -> throwErrorHere $ TypeError $ "take: first argument must be a number"
)
, ( "nth"
- , [md|Given an integral number `n` and `xs`, returns the `n`th element
- (zero indexed) of `xs` when `xs` is a list or a vector. If `xs`
- does not have an `n`-th element, or if it is not a list or vector, then
- an exception is thrown.|]
+ , "Given an integral number `n` and `xs`, returns the `n`th element\
+ \ (zero indexed) of `xs` when `xs` is a list or a vector. If `xs`\
+ \ does not have an `n`-th element, or if it is not a list or vector, then\
+ \ an exception is thrown."
, \case
[Number n, vs] -> case floatingOrInteger n of
Left (_ :: Double) -> throwErrorHere $ OtherError "nth: first argument was not an integer"
@@ -222,9 +217,9 @@ purePrimFns = fromList $ allDocs $
)
, ("lookup"
- , [md|Given a value `k` (the 'key') and a dict `d`, returns the value associated
- with `k` in `d`. If the key does not exist in `d` then `()` is returned
- instead. If `d` is not a dict then an exception is thrown.|]
+ , "Given a value `k` (the 'key') and a dict `d`, returns the value associated\
+ \ with `k` in `d`. If the key does not exist in `d` then `()` is returned\
+ \ instead. If `d` is not a dict then an exception is thrown."
, \case
[a, Dict m] -> pure $ case Map.lookup a m of
Just v -> v
@@ -234,8 +229,8 @@ purePrimFns = fromList $ allDocs $
[_, _] -> throwErrorHere $ TypeError $ "lookup: second argument must be a dict"
xs -> throwErrorHere $ WrongNumberOfArgs "lookup" 2 (length xs))
, ( "map-values"
- , [md|Given a function `f` and a dict `d`, returns a dict with the same keys as `d`
- but `f` applied to all the associated values.|]
+ , "Given a function `f` and a dict `d`, returns a dict with the same keys as `d`\
+ \ but `f` applied to all the associated values."
, twoArg "map-values" $ \case
(f, Dict m) -> do
let kvs = Map.toList m
@@ -244,14 +239,14 @@ purePrimFns = fromList $ allDocs $
_ -> throwErrorHere $ TypeError $ "map-values: second argument must be a dict"
)
, ( "string-length"
- , [md|Returns the length of a string.|]
+ , "Returns the length of a string."
, oneArg "string-length" $ \case
String s -> pure . Number . fromIntegral . T.length $ s
_ -> throwErrorHere $ TypeError "string-length: expecting string"
)
, ( "string-append"
- , [md|Concatenates a variable number of string arguments. If one of the arguments
- isn't a string then an exception is thrown.|]
+ , "Concatenates a variable number of string arguments. If one of the arguments\
+ \ isn't a string then an exception is thrown."
, \args ->
let fromStr (String s) = Just s
fromStr _ = Nothing
@@ -260,17 +255,10 @@ purePrimFns = fromList $ allDocs $
then pure . String . mconcat $ catMaybes ss
else throwErrorHere $ TypeError "string-append: non-string argument"
)
- , ( "markdown?"
- , [md|Checks that the input string is valid Markdown according
- to the [CommonMark spec](commonmark.org).|]
- , oneArg "markdown?" $ \case
- String s -> pure . Boolean . isRight $ Pandoc.runPure (Pandoc.readCommonMark Default.def s)
- _ -> throwErrorHere $ TypeError "markdown?: expects string"
- )
, ( "insert"
- , [md|Given `k`, `v` and a dict `d`, returns a dict with the same associations
- as `d` but with `k` associated to `d`. If `d` isn't a dict then an exception
- is thrown.|]
+ , "Given `k`, `v` and a dict `d`, returns a dict with the same associations\
+ \ as `d` but with `k` associated to `d`. If `d` isn't a dict then an exception\
+ \ is thrown."
, \case
[k, v, Dict m] -> pure . Dict $ Map.insert k v m
[_, _, _] -> throwErrorHere
@@ -278,8 +266,8 @@ purePrimFns = fromList $ allDocs $
$ TypeError "insert: third argument must be a dict"
xs -> throwErrorHere $ WrongNumberOfArgs "insert" 3 (length xs))
, ( "delete"
- , [md|Given `k` and a dict `d`, returns a dict with the same associations as `d` but
- without the key `k`. If `d` isn't a dict then an exception is thrown.|]
+ , "Given `k` and a dict `d`, returns a dict with the same associations as `d` but\
+ \ without the key `k`. If `d` isn't a dict then an exception is thrown."
, twoArg "delete" $ \case
(k, Dict m) -> pure . Dict $ Map.delete k m
_ -> throwErrorHere $ TypeError "delete: second argument must be a dict"
@@ -292,23 +280,23 @@ purePrimFns = fromList $ allDocs $
--
-- In order to avoid this sort of thing, we don't allow +,*,- and / to be
-- applied to a single argument.
- , numBinop (+) "+" [md|Adds two numbers together.|]
- , numBinop (*) "*" [md|Multiplies two numbers together.|]
- , numBinop (-) "-" [md|Substracts one number from another.|]
+ , numBinop (+) "+" "Adds two numbers together."
+ , numBinop (*) "*" "Multiplies two numbers together."
+ , numBinop (-) "-" "Substracts one number from another."
, ( "<"
- , [md|Checks if a number is strictly less than another.|]
+ , "Checks if a number is strictly less than another."
, \case
[Number x, Number y] -> pure $ Boolean (x < y)
[_, _] -> throwErrorHere $ TypeError "<: expecting number"
xs -> throwErrorHere $ WrongNumberOfArgs "<" 2 (length xs))
, ( ">"
- , [md|Checks if a number is strictly greater than another.|]
+ , "Checks if a number is strictly greater than another."
, \case
[Number x, Number y] -> pure $ Boolean (x > y)
[_, _] -> throwErrorHere $ TypeError ">: expecting number"
xs -> throwErrorHere $ WrongNumberOfArgs ">" 2 (length xs))
, ( "integral?"
- , [md|Checks if a number is an integer.|]
+ , "Checks if a number is an integer."
, oneArg "integral?" $ \case
Number n -> case floatingOrInteger n of
Left (_ :: Double) -> pure $ Boolean False
@@ -316,26 +304,26 @@ purePrimFns = fromList $ allDocs $
_ -> throwErrorHere $ TypeError "integral?: expecting number"
)
, ( "foldl"
- , [md|Given a function `f`, an initial value `i` and a sequence (list or vector)
- `xs`, reduces `xs` to a single value by starting with `i` and repetitively
- combining values with `f`, using elements of `xs` from left to right.|]
+ , "Given a function `f`, an initial value `i` and a sequence (list or vector)\
+ \ `xs`, reduces `xs` to a single value by starting with `i` and repetitively\
+ \ combining values with `f`, using elements of `xs` from left to right."
, \case
[fn, init', v] -> do
ls :: [Value] <- fromRadOtherErr v
foldlM (\b a -> callFn fn [b, a]) init' ls
xs -> throwErrorHere $ WrongNumberOfArgs "foldl" 3 (length xs))
, ( "foldr"
- , [md|Given a function `f`, an initial value `i` and a sequence (list or vector)
- `xs`, reduces `xs` to a single value by starting with `i` and repetitively
- combining values with `f`, using elements of `xs` from right to left.|]
+ , "Given a function `f`, an initial value `i` and a sequence (list or vector)\
+ \ `xs`, reduces `xs` to a single value by starting with `i` and repetitively\
+ \ combining values with `f`, using elements of `xs` from right to left."
, \case
[fn, init', v] -> do
ls :: [Value] <- fromRadOtherErr v
foldrM (\b a -> callFn fn [b, a]) init' ls
xs -> throwErrorHere $ WrongNumberOfArgs "foldr" 3 (length xs))
, ( "map"
- , [md|Given a function `f` and a sequence (list or vector) `xs`, returns a sequence
- of the same size and type as `xs` but with `f` applied to all the elements.|]
+ , "Given a function `f` and a sequence (list or vector) `xs`, returns a sequence\
+ \ of the same size and type as `xs` but with `f` applied to all the elements."
, \case
[fn, List ls] -> List <$> traverse (callFn fn) (pure <$> ls)
[fn, Vec ls] -> Vec <$> traverse (callFn fn) (pure <$> ls)
@@ -362,9 +350,9 @@ purePrimFns = fromList $ allDocs $
Dict _ -> pure tt
_ -> pure ff)
, ( "type"
- , [md|Returns a keyword representing the type of the argument; one of:
- `:atom`, `:keyword`, `:string`, `:number`, `:boolean`, `:list`,
- `:vector`, `:function`, `:dict`, `:ref`, `:function`.|]
+ , "Returns a keyword representing the type of the argument; one of:\
+ \ `:atom`, `:keyword`, `:string`, `:number`, `:boolean`, `:list`,\
+ \ `:vector`, `:function`, `:dict`, `:ref`, `:function`."
, let kw' = pure . Keyword . Ident
in oneArg "type" $ \case
Atom _ -> kw' "atom"
@@ -395,9 +383,9 @@ purePrimFns = fromList $ allDocs $
Number _ -> pure tt
_ -> pure ff)
, ( "member?"
- , [md|Given `v` and structure `s`, checks if `x` exists in `s`. The structure `s`
- may be a list, vector or dict. If it is a list or a vector, it checks if `v`
- is one of the items. If `s` is a dict, it checks if `v` is one of the keys.|]
+ , "Given `v` and structure `s`, checks if `x` exists in `s`. The structure `s`\
+ \ may be a list, vector or dict. If it is a list or a vector, it checks if `v`\
+ \ is one of the items. If `s` is a dict, it checks if `v` is one of the keys."
, \case
[x, List xs] -> pure . Boolean $ elem x xs
[x, Vec xs] -> pure . Boolean . isJust $ Seq.elemIndexL x xs
@@ -406,16 +394,16 @@ purePrimFns = fromList $ allDocs $
$ TypeError "member?: second argument must be list"
xs -> throwErrorHere $ WrongNumberOfArgs "eq?" 2 (length xs))
, ( "ref"
- , [md|Creates a ref with the argument as the initial value.|]
+ , "Creates a ref with the argument as the initial value."
, oneArg "ref" newRef)
, ( "read-ref"
- , [md|Returns the current value of a ref.|]
+ , "Returns the current value of a ref."
, oneArg "read-ref" $ \case
Ref ref -> readRef ref
_ -> throwErrorHere $ TypeError "read-ref: argument must be a ref")
, ( "write-ref"
- , [md|Given a reference `r` and a value `v`, updates the value stored in `r` to be
- `v` and returns `v`.|]
+ , "Given a reference `r` and a value `v`, updates the value stored in `r` to be\
+ \ `v` and returns `v`."
, \case
[Ref (Reference x), v] -> do
st <- get
@@ -426,13 +414,13 @@ purePrimFns = fromList $ allDocs $
xs -> throwErrorHere
$ WrongNumberOfArgs "write-ref" 2 (length xs))
, ( "show"
- , [md|Returns a string representing the argument value.|]
+ , "Returns a string representing the argument value."
, oneArg "show" (pure . String . renderPrettyDef))
, ( "seq"
- , [md|Given a structure `s`, returns a sequence. Lists and vectors are returned
- without modification while for dicts a vector of key-value-pairs is returned:
- these are vectors of length 2 whose first item is a key and whose second item
- is the associated value.|]
+ , "Given a structure `s`, returns a sequence. Lists and vectors are returned\
+ \ without modification while for dicts a vector of key-value-pairs is returned:\
+ \ these are vectors of length 2 whose first item is a key and whose second item\
+ \ is the associated value."
, oneArg "seq" $
\case
x@(List _) -> pure x
@@ -441,20 +429,20 @@ purePrimFns = fromList $ allDocs $
_ -> throwErrorHere $ TypeError "seq: can only be used on a list, vector or dictionary"
)
, ( "to-json"
- , [md|Returns a JSON formatted string representing the input value.|]
+ , "Returns a JSON formatted string representing the input value."
, oneArg "to-json" $ \v -> String . toS . Aeson.encode <$>
maybeJson v ?? toLangError (OtherError "Could not serialise value to JSON")
)
, ( "default-ecc-curve"
- , [md|Returns the default elliptic-curve used for generating cryptographic keys.|]
+ , "Returns the default elliptic-curve used for generating cryptographic keys."
,
\case
[] -> pure $ toRad defaultCurve
xs -> throwErrorHere $ WrongNumberOfArgs "default-ecc-curve" 0 (length xs)
)
, ( "verify-signature"
- , [md|Given a public key `pk`, a signature `s` and a message (string) `m`, checks
- that `s` is a signature of `m` for the public key `pk`.|]
+ , "Given a public key `pk`, a signature `s` and a message (string) `m`, checks\
+ \ that `s` is a signature of `m` for the public key `pk`."
, \case
[keyv, sigv, String msg] -> do
key <- fromRadOtherErr keyv
@@ -464,20 +452,20 @@ purePrimFns = fromList $ allDocs $
xs -> throwErrorHere $ WrongNumberOfArgs "verify-signature" 3 (length xs)
)
, ( "public-key?"
- , [md|Checks if a value represents a valid public key.|]
+ , "Checks if a value represents a valid public key."
, oneArg "public-key?" $
\v -> case fromRad v of
Right (_ :: PublicKey) -> pure $ Boolean True
Left _ -> pure $ Boolean False
)
, ( "uuid?"
- , [md|Checks if a string has the format of a UUID.|]
+ , "Checks if a string has the format of a UUID."
, oneArg "uuid?" $ \case
String t -> pure . Boolean . UUID.isUUID $ t
_ -> throwErrorHere $ TypeError "uuid?: expects a string"
)
, ( "document"
- , [md|Used to add documentation to variables.|]
+ , "Used to add documentation to variables."
, \case
[Atom i, List _, String desc] -> do
v <- lookupAtom i
@@ -487,7 +475,7 @@ purePrimFns = fromList $ allDocs $
xs -> throwErrorHere $ WrongNumberOfArgs "document" 3 (length xs)
)
, ( "doc"
- , [md|Returns the documentation string for a variable. To print it instead, use `doc!`.|]
+ , "Returns the documentation string for a variable. To print it instead, use `doc!`."
, oneArg "doc" $ \case
Atom i -> do d <- lookupAtomDoc i
pure . String $