ceph/src/boost/libs/phoenix/doc/starter_kit.qbk

   1 [/==============================================================================
   2     Copyright (C) 2001-2010 Joel de Guzman
   3     Copyright (C) 2001-2005 Dan Marsden
   4     Copyright (C) 2001-2010 Thomas Heller
   5
   6     Distributed under the Boost Software License, Version 1.0. (See accompanying
   7     file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   8 ===============================================================================/]
   9
  10 [section Starter Kit]
  11
  12 Most "quick starts" only get you a few blocks from where you are. From there,
  13 you are on your own. Yet, typically, you'd want to get to the next city. This
  14 starter kit shall be as minimal as possible, yet packed as much power as
  15 possible.
  16
  17 So you are busy and always on the go. You do not wish to spend a lot of time
  18 studying the library. You wish to be spared the details for later when you need
  19 it. For now, all you need to do is to get up to speed as quickly as possible and
  20 start using the library. If this is the case, this is the right place to start.
  21
  22 This section is by no means a thorough discourse of the library. For more
  23 information on Phoenix, please take some time to read the rest of the
  24 Documentation. Yet, if you just want to use the library quickly, now, this
  25 chapter will probably suffice. Rather than taking you to the details of the
  26 library, we shall try to provide you with annotated examples instead.
  27 Hopefully, this will get you into high gear quickly.
  28
  29 [heading Functors everywhere]
  30
  31 Phoenix is built on function objects (functors). The functor is the main
  32 building block. We compose functors to build more complex functors... to build
  33 more complex functors... and so on. Almost everything is a functor.
  34
  35 [note Functors are so ubiquitous in Phoenix that, in the manual, the
  36 words /"functor"/ and /"function"/ are used interchangeably.]
  37
  38 [/section Primitives]
  39
  40 We start with some core functions that are called *primitives*. You can think of
  41 primitives (such as values, references and arguments) as atoms.
  42
  43 Things start to get interesting when we start /composing/ primitives to form
  44 *expressions*. The expressions can, in turn, be composed to form even more complex
  45 expressions.
  46
  47 [include starter_kit/values.qbk]
  48 [include starter_kit/references.qbk]
  49 [include starter_kit/arguments.qbk]
  50
  51 [/endsect]
  52
  53 [/section Composites]
  54
  55 [include starter_kit/operator.qbk]
  56 [include starter_kit/statement.qbk]
  57 [include starter_kit/object.qbk]
  58 [include starter_kit/function.qbk]
  59 [include starter_kit/more.qbk]
  60
  61 [/endsect]
  62
  63 [endsect]