]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | <?xml version="1.0" encoding="utf-8"?> |
2 | <!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" | |
3 | "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd"> | |
4 | ||
5 | <!-- Copyright (c) 2002-2006 Pavol Droba. | |
6 | Subject to the Boost Software License, Version 1.0. | |
7 | (See accompanying file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt) | |
8 | --> | |
9 | ||
10 | <section id="string_algo.env" last-revision="$Date$"> | |
11 | <title>Environment</title> | |
12 | <section> | |
13 | <title>Build</title> | |
14 | <para> | |
15 | The whole library is provided in headers. Regex variants of some algorithms, | |
16 | however, are dependent on the <libraryname>Boost.Regex</libraryname> library. All such algorithms are | |
17 | separated in <headername>boost/algorithm/string_regex.hpp</headername>. | |
18 | If this header is used, the application must be linked with the <libraryname>Boost.Regex</libraryname> | |
19 | library. | |
20 | </para> | |
21 | </section> | |
22 | ||
23 | <section> | |
24 | <title>Examples</title> | |
25 | <para> | |
26 | Examples showing the basic usage of the library can be found in the libs/algorithm/string/example | |
27 | directory. There is a separate file for the each part of the library. Please follow the boost | |
28 | build guidelines to build examples using the bjam. To successfully build regex examples | |
29 | the <libraryname>Boost.Regex</libraryname> library is required. | |
30 | </para> | |
31 | </section> | |
32 | ||
33 | <section> | |
34 | <title>Tests</title> | |
35 | <para> | |
36 | A full set of test cases for the library is located in the libs/algorithm/string/test directory. | |
37 | The test cases can be executed using the boost build system. For the tests of regular | |
38 | expression variants of algorithms, the <libraryname>Boost.Regex</libraryname> library is required. | |
39 | </para> | |
40 | </section> | |
41 | ||
42 | <section> | |
43 | <title>Portability</title> | |
44 | <para> | |
45 | The library has been successfully compiled and tested with the following compilers: | |
46 | ||
47 | <itemizedlist> | |
48 | <listitem>Microsoft Visual C++ 7.0</listitem> | |
49 | <listitem>Microsoft Visual C++ 7.1</listitem> | |
50 | <listitem>GCC 3.2</listitem> | |
51 | <listitem>GCC 3.3.1</listitem> | |
52 | </itemizedlist> | |
53 | ||
54 | See <ulink url="http://boost.sourceforge.net/regression-logs/">Boost regression tables</ulink> | |
55 | for additional info for a particular compiler. | |
56 | </para> | |
57 | <para> | |
58 | There are known limitation on platforms not supporting partial template specialization. | |
59 | Library depends on correctly implemented <code>std::iterator_traits</code> class. | |
60 | If a standard library provided with compiler is broken, the String Algorithm Library | |
61 | cannot function properly. Usually it implies that primitive pointer iterators are not | |
62 | working with the library functions. | |
63 | </para> | |
64 | </section> | |
65 | </section> |