doc/manual/reading-guide.tex

   1 \section*{Reading guide}
   2 This manual tries to be as comprehensive as possible; however, you don't
   3 necessarily have to read all of it before starting to do interesting stuff with
   4 metalua. Here's a brief summary of what the different parts of the manual
   5 address, and why you might want to read them immediately---or not.
   6
   7 \begin{itemize}
   8 \item{\bf Before reading this manual:} metalua is based on Lua, so
   9   you'll need a minimal level of Lua proficiency. You can probably get
  10   away without knowing much about metatables, environments or
  11   coroutines, but you need to be at ease with basic flow control,
  12   scoping rules, first-class functions, and the whole
  13   everything-is-a-table approach.
  14 \item{\bf Meta-programming in metalua:} this chapter exposes the generic principles
  15   of static meta-programming: meta-levels in sources, AST representation of
  16   code, meta-operators. You need to read this carefully if you plan to write any
  17   non-trivial meta-programming code and you've never used languages like, Common
  18   Lisp, camlp4 or Converge. If you're familiar with one of these, a cursory look
  19   over this chapter might be enough for you.
  20 \item{\bf Standard meta-programming libraries:} these are the tools that will allow
  21   you to manipulate code effectively; the more advanced an extension you want to
  22   write the more of these you'll want to know.
  23   \begin{itemize}
  24   \item{\bf mlp} is the dynamically extensible metalua parser. You need to know it
  25     if you want to change or extend the language's syntax
  26   \item{\bf gg} is the grammar generator, the library which lets you manipulate
  27     dynamic parsers. You need to know it in order to do anything useful with
  28     mlp.
  29   \item{\bf match} is an extension supporting structural pattern matching (which has
  30     almost nothing to do with regular expressions on strings). It's a construct
  31     taken from the ML language familly, which lets you manipulate advanced data
  32     structures in vrey powerful ways. It's extremely helpful, among others, when
  33     working with AST, i.e. for most interesting meta-programs.
  34   \item{\bf walk} is a code walker generator: smomething akin to a visitor pattern,
  35     which will help you to write code analysers or transformers. Whenever you
  36     want to find and transform all return statements in an AST, rename some
  37     conflicting local variables, check for the presence of nested for loops
  38     etc., you'll have to write a code walker, and walk will get you there much
  39     faster.
  40   \item{\bf hygiene} offers hygienic macros, i.e. protects you from accidental
  41     variable captures. As opposed to e.g. Scheme, macro writing is not limited
  42     to a term rewriting system in metalua, which lets more power to the
  43     programmer, but prevents from completely automating macro hygienization. If
  44     you wrote an extension and you want to raise it to production-quality,
  45     you'll need among others to protect its users from variable captures, and
  46     you'll need to hygienize it. If you don't feel like cluttering your code
  47     with dozens of {\tt gensym} calls, you'll want to use the macro hygienizer.
  48   \item{\bf dollar:} if you wrote a macro, but don't feel the need to give it a
  49     dedicated syntax extension, this library will let you call this macro as a
  50     regular function call, except that it will be prefixed with a ``{\tt\$}''.
  51   \end{itemize}
  52   \item{\bf General purpose libraries:} Lua strives at staying minimalist, and does
  53     not come with batteries included; you're expected to grab them separately,
  54     currently from luaforge, and eventually from a Lua Rocks repository. Metalua
  55     needs quite some support to run, and relies on a number of imported and
  56     custom-built libraries. Most of them can be reused for many other purposes
  57     including yours.\\
  58     A whole category of metalua users, who want to use third party libraries
  59     rather than reinventing their own wheels, will be primarily interested by
  60     these.
  61     \begin{itemize}
  62     \item{\bf metalua.runtime:} extensions to Lua core libraries: base, table,
  63       string.
  64     \item{\bf metalua.compiler:} mlc offers a consistent interface to metalua
  65       compilation and code representation transformers. 'package', 'loadstring',
  66       'dostring', 'loadfile' and 'dofile' are also updated to handle metalua
  67       source files.
  68     \item{\bf clopts} simplifies and unifies the handling of command line options
  69       for metalua programs.
  70     \item{\bf springs} brings together Lua Ring's handling of separate Lua universes
  71       with Pluto's communication capabilities.
  72     \item{\bf clist} offers an extended tables-as-list interface: lists by
  73       comprehension {\em \`a la} Haskell or Python, list chunks etc.
  74     \item{\bf xglobal} makes global variables declaration mandatory, for safer
  75       programming, with almost no runtime overhead, and a syntax consistant qith
  76       local variables declaration.
  77     \item{\bf anaphoric} introduces anaphoric control structures, akin to Common
  78       Lisp's {\tt aif}-familly macros.
  79     \item{\bf trycatch} provides a proper exception system, with reliable finally
  80       blocks and exception catching by structural pattern matching.
  81     \item{\bf log} eases the terminal logging of variables, mainly for those from
  82       the Printf-based School of Debugging.
  83     \item{\bf types} offers dynamic type checking to metalua programs. It supports
  84       variable typing as opposed to value typing, and advanced type system
  85       features (polymorphism, dependant types etc.).
  86     \end{itemize}
  87   \item{\bf Examples and tutorials}: this chapter lists a series of tiny
  88     meta-programs whose main purpose is didactic, and walks through the detailed
  89     implementation of a couple of non-trivial extensions.
  90 \end{itemize}