.. module:: hyrule

====================================
The Hyrule manual
====================================

.. include:: ../README.rst

.. contents::
   :local:

Reference
=========

``anaphoric`` — Anaphoric macros
----------------------------------------------------------------------
.. hy:automodule:: hyrule.anaphoric

.. hy:autotag:: %
.. hy:automacro:: ap-if
.. hy:automacro:: ap-each
.. hy:automacro:: ap-each-while
.. hy:automacro:: ap-map
.. hy:automacro:: ap-map-when
.. hy:automacro:: ap-filter
.. hy:automacro:: ap-reject
.. hy:automacro:: ap-dotimes
.. hy:automacro:: ap-first
.. hy:automacro:: ap-last
.. hy:automacro:: ap-reduce
.. hy:automacro:: ap-when
.. hy:automacro:: ap-with

``argmove`` — Macros for calls with unusual argument placement 
----------------------------------------------------------------------
.. hy:automodule:: hyrule.argmove

.. hy:automacro:: ->
.. hy:automacro:: ->>
.. hy:automacro:: as->
.. hy:automacro:: doto

``collections`` — Tools for data structures
----------------------------------------------------------------------
.. hy:automodule:: hyrule.collections

.. hy:automacro:: assoc
.. hy:automacro:: ncut
.. hy:autofunction:: postwalk
.. hy:autofunction:: prewalk
.. hy:autotag:: s
.. hy:autofunction:: walk

``control`` — Control structures
----------------------------------------------------------------------
.. hy:automodule:: hyrule.control

.. hy:automacro:: block
.. hy:automacro:: branch
.. hy:automacro:: case
.. hy:automacro:: cfor
.. hy:automacro:: defmain
.. hy:automacro:: do-n
.. hy:automacro:: ebranch
.. hy:automacro:: ecase
.. hy:automacro:: ifp
.. hy:automacro:: lif
.. hy:automacro:: list-n
.. hy:automacro:: loop
.. hy:automacro:: unless

``destructure`` — Macros for destructuring collections
----------------------------------------------------------------------
.. hy:automodule:: hyrule.destructure

.. hy:automacro:: defn+
.. hy:automacro:: defn/a+
.. hy:automacro:: dict=:
.. hy:automacro:: fn+
.. hy:automacro:: fn/a+
.. hy:automacro:: let+
.. hy:automacro:: setv+

``iterables`` — Tools for iterable objects
----------------------------------------------------------------------
.. hy:automodule:: hyrule.iterables

.. hy:autofunction:: butlast
.. hy:autofunction:: coll?
.. hy:autofunction:: distinct
.. hy:autofunction:: drop-last
.. hy:autofunction:: flatten
.. hy:autofunction:: rest
.. hy:autofunction:: thru

``macrotools`` — Tools for writing and handling macros
----------------------------------------------------------------------
.. hy:automodule:: hyrule.macrotools

.. hy:autotag:: /
.. hy:automacro:: defmacro-kwargs
.. hy:automacro:: defmacro/g!
.. hy:automacro:: defmacro!
.. hy:autofunction:: macroexpand-all
.. hy:autofunction:: map-model
.. hy:autofunction:: match-fn-params
.. hy:automacro:: with-gensyms

``pprint`` — Pretty-printing data structures
----------------------------------------------------------------------
.. hy:automodule:: hyrule.hypprint

.. hy:autoclass:: PrettyPrinter
.. hy:autofunction:: pformat
.. hy:autofunction:: pp
.. hy:autofunction:: pprint
.. hy:autofunction:: readable?
.. hy:autofunction:: recursive?
.. hy:autofunction:: saferepr

``sequences`` — Lazy, indexable iterables
----------------------------------------------------------------------
.. hy:automodule:: hyrule.sequences

.. hy:automacro:: defseq
.. hy:autofunction:: end-sequence
.. hy:automacro:: seq

``misc`` — Everything else
----------------------------------------------------------------------
.. hy:automodule:: misc

.. hy:automacro:: comment
.. hy:autofunction:: constantly
.. hy:autofunction:: dec
.. hy:autofunction:: inc
.. hy:autofunction:: parse-args
.. hy:automacro:: profile/calls
.. hy:automacro:: profile/cpu
.. hy:autofunction:: sign
.. hy:automacro:: smacrolet
.. hy:autofunction:: xor

Contributing to Hyrule
======================

.. include:: ../CONTRIBUTING.rst