[ceph.git] / ceph / src / boost / libs / spirit / doc / x3 / tutorial / tutorial_intro.qbk

[/==============================================================================
    Copyright (C) 2001-2015 Joel de Guzman
    Copyright (C) 2001-2011 Hartmut Kaiser

    Distributed under the Boost Software License, Version 1.0. (See accompanying
    file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
===============================================================================/]

[section Quick Start]

[heading Why would you want to use __x3__?]

__x3__ is designed to be a practical parsing tool. The ability to generate a
fully-working parser from a formal EBNF specification inlined in C++
significantly reduces development time. Programmers typically approach parsing
using ad hoc hacks with primitive tools such as scanf. Even regular-expression
libraries (such as boost regex) or scanners (such as Boost tokenizer) do not
scale well when we need to write more elaborate parsers. Attempting to write
even a moderately-complex parser using these tools leads to code that is hard to
understand and maintain.

One prime objective is to make the tool easy to use. When one thinks of a
parser generator, the usual reaction is "it must be big and complex with a
steep learning curve." Not so. Spirit is designed to be fully scalable. The
library is structured in layers. This permits learning on an as-needed basis,
after only learning the minimal core and basic concepts.

For development simplicity and ease in deployment, the entire library
consists of only header files, with no libraries to link against or build.
Just put the Spirit distribution in your include path, compile and run. Code
size? -very tight -essentially comparable to hand written recursive descent
code.

Our tutorials will walk you through the simplest Spirit examples, incrementally
building on top of the earlier examples as we expose more and more features and
techniques. We will try to be as gentle as possible with the learning curve.
We will present the tutorials in a cookbook style approach. This style of
presentation is based on our BoostCon '07 and BoostCon '08 slides.

Have fun!

[endsect] [/ Quickstart]
Commit	Line	Data
7c673cae FG	1	[/==============================================================================
	2	Copyright (C) 2001-2015 Joel de Guzman
	3	Copyright (C) 2001-2011 Hartmut Kaiser
	4
	5	Distributed under the Boost Software License, Version 1.0. (See accompanying
	6	file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
	7	===============================================================================/]
	8
	9	[section Quick Start]
	10
	11	[heading Why would you want to use __x3__?]
	12
	13	__x3__ is designed to be a practical parsing tool. The ability to generate a
	14	fully-working parser from a formal EBNF specification inlined in C++
	15	significantly reduces development time. Programmers typically approach parsing
	16	using ad hoc hacks with primitive tools such as scanf. Even regular-expression
	17	libraries (such as boost regex) or scanners (such as Boost tokenizer) do not
	18	scale well when we need to write more elaborate parsers. Attempting to write
	19	even a moderately-complex parser using these tools leads to code that is hard to
	20	understand and maintain.
	21
	22	One prime objective is to make the tool easy to use. When one thinks of a
	23	parser generator, the usual reaction is "it must be big and complex with a
	24	steep learning curve." Not so. Spirit is designed to be fully scalable. The
	25	library is structured in layers. This permits learning on an as-needed basis,
	26	after only learning the minimal core and basic concepts.
	27
	28	For development simplicity and ease in deployment, the entire library
	29	consists of only header files, with no libraries to link against or build.
	30	Just put the Spirit distribution in your include path, compile and run. Code
	31	size? -very tight -essentially comparable to hand written recursive descent
	32	code.
	33
	34	Our tutorials will walk you through the simplest Spirit examples, incrementally
	35	building on top of the earlier examples as we expose more and more features and
	36	techniques. We will try to be as gentle as possible with the learning curve.
	37	We will present the tutorials in a cookbook style approach. This style of
	38	presentation is based on our BoostCon '07 and BoostCon '08 slides.
	39
	40	Have fun!
	41
	42	[endsect] [/ Quickstart]