From 33c9ed2d4212851f122620c5a1758c4d8737bbed Mon Sep 17 00:00:00 2001 From: jzmaddock Date: Mon, 25 Jan 2021 11:52:44 +0000 Subject: [PATCH] Document new build changes + standalone mode. --- doc/configuration.qbk | 50 ++++++----------- doc/html/boost_regex/configuration.html | 2 - .../boost_regex/configuration/locale.html | 6 +- .../boost_regex/configuration/tuning.html | 56 +++---------------- doc/html/boost_regex/install.html | 36 ++++++++++-- doc/html/index.html | 4 +- doc/install.qbk | 21 +++++-- 7 files changed, 75 insertions(+), 100 deletions(-) diff --git a/doc/configuration.qbk b/doc/configuration.qbk index 080adf1c..3439eb15 100644 --- a/doc/configuration.qbk +++ b/doc/configuration.qbk @@ -17,6 +17,22 @@ or platform) then [@../../../config/index.html Boost.Config] has a configure scr [endsect] +[section:standalone Use in Standalone Mode (without the rest of Boost)] + +This library may now be used in "standalone" mode without the rest of the Boost C++ libraries, +in order to do this you must either: + +* Have a C++17 compiler that supports `__has_include`, in this case if `` is *not* present +then the library will automoatically enter standalone mode. Or: +* Define BOOST_REGEX_STANDALONE when building. + +The main difference between the 2 modes, is that when Boost.Config is present the library will automatically +configure itself around various compiler defects. In particular in order to use the library with exception support +turned off, you will either need a copy of Boost.Config in your include path, or else manually define BOOST_NO_EXCEPTIONS +when building. + +[endsect] + [section:locale Locale and traits class selection] The following macros (see [@../../../../boost/regex/user.hpp user.hpp]) control how Boost.Regex interacts with @@ -31,43 +47,11 @@ the user's locale: [endsect] - -[section:linkage Linkage Options] - -[table -[[macro][description]] -[[BOOST_REGEX_DYN_LINK][For Microsoft and Borland C++ builds, this tells Boost.Regex that it should link to the dll build of the Boost.Regex. By default boost.regex will link to its static library build, even if the dynamic C runtime library is in use.]] -[[BOOST_REGEX_NO_LIB][For Microsoft and Borland C++ builds, this tells Boost.Regex that it should not automatically select the library to link to.]] -[[BOOST_REGEX_NO_FASTCALL][For Microsoft builds, this tells Boost.Regex to use the `__cdecl` calling convention rather than `__fastcall`. Useful if you want to use the same library from both managed and unmanaged code.]] -] - -[endsect] - -[section:algorithm Algorithm Selection] - -[table -[[macro][description]] -[[BOOST_REGEX_RECURSIVE][Tells Boost.Regex to use a stack-recursive matching algorithm. This is generally the fastest option (although there is very little in it), but can cause stack overflow in extreme cases, on Win32 this can be handled safely, but this is not the case on other platforms.]] -[[BOOST_REGEX_NON_RECURSIVE][Tells Boost.Regex to use a non-stack recursive matching algorithm, this can be slightly slower than the alternative, but is always safe no matter how pathological the regular expression. This is the default on non-Win32 platforms.]] -] - -[endsect] - [section:tuning Algorithm Tuning] -The following option applies only if BOOST_REGEX_RECURSIVE is set. - [table [[macro][description]] -[[BOOST_REGEX_HAS_MS_STACK_GUARD][Tells Boost.Regex that Microsoft style __try - __except blocks are supported, and can be used to safely trap stack overflow.]] -] - - -The following options apply only if BOOST_REGEX_NON_RECURSIVE is set. - -[table -[[macro][description]] -[[BOOST_REGEX_BLOCKSIZE][In non-recursive mode, Boost.Regex uses largish blocks of memory to act as a stack for the state machine, the larger the block size then the fewer allocations that will take place. This defaults to 4096 bytes, which is large enough to match the vast majority of regular expressions without further allocations, however, you can choose smaller or larger values depending upon your platforms characteristics.]] +[[BOOST_REGEX_BLOCKSIZE][Boost.Regex uses largish blocks of memory to act as a stack for the state machine, the larger the block size then the fewer allocations that will take place. This defaults to 4096 bytes, which is large enough to match the vast majority of regular expressions without further allocations, however, you can choose smaller or larger values depending upon your platforms characteristics.]] [[BOOST_REGEX_MAX_BLOCKS][Tells Boost.Regex how many blocks of size BOOST_REGEX_BLOCKSIZE it is permitted to use. If this value is exceeded then Boost.Regex will stop trying to find a match and throw a std::runtime_error. Defaults to 1024, don't forget to tweak this value if you alter BOOST_REGEX_BLOCKSIZE by much.]] [[BOOST_REGEX_MAX_CACHE_BLOCKS][Tells Boost.Regex how many memory blocks to store in it's internal cache - memory blocks are taken from this cache rather than by calling diff --git a/doc/html/boost_regex/configuration.html b/doc/html/boost_regex/configuration.html index 9e2bf10e..bfc70b20 100644 --- a/doc/html/boost_regex/configuration.html +++ b/doc/html/boost_regex/configuration.html @@ -30,8 +30,6 @@
Compiler Setup
Locale and traits class selection
-
Linkage Options
-
Algorithm Selection
Algorithm Tuning
diff --git a/doc/html/boost_regex/configuration/locale.html b/doc/html/boost_regex/configuration/locale.html index d1f74f6a..eb3ba937 100644 --- a/doc/html/boost_regex/configuration/locale.html +++ b/doc/html/boost_regex/configuration/locale.html @@ -7,7 +7,7 @@ - + @@ -20,7 +20,7 @@
-PrevUpHomeNext +PrevUpHomeNext

@@ -103,7 +103,7 @@
-PrevUpHomeNext +PrevUpHomeNext
diff --git a/doc/html/boost_regex/configuration/tuning.html b/doc/html/boost_regex/configuration/tuning.html index 45f13f45..30ddc99f 100644 --- a/doc/html/boost_regex/configuration/tuning.html +++ b/doc/html/boost_regex/configuration/tuning.html @@ -6,7 +6,7 @@ - + @@ -20,49 +20,12 @@
-PrevUpHomeNext +PrevUpHomeNext
-

- The following option applies only if BOOST_REGEX_RECURSIVE is set. -

-
---- - - - - - - - - -
-

- macro -

- 		-

- description -

-
-

- BOOST_REGEX_HAS_MS_STACK_GUARD -

- 		-

- Tells Boost.Regex that Microsoft style __try - __except blocks - are supported, and can be used to safely trap stack overflow. -

-
-

- The following options apply only if BOOST_REGEX_NON_RECURSIVE is set. -

@@ -89,13 +52,12 @@ @@ -150,7 +112,7 @@

- In non-recursive mode, Boost.Regex uses largish blocks of memory - to act as a stack for the state machine, the larger the block size - then the fewer allocations that will take place. This defaults - to 4096 bytes, which is large enough to match the vast majority - of regular expressions without further allocations, however, you - can choose smaller or larger values depending upon your platforms - characteristics. + Boost.Regex uses largish blocks of memory to act as a stack for + the state machine, the larger the block size then the fewer allocations + that will take place. This defaults to 4096 bytes, which is large + enough to match the vast majority of regular expressions without + further allocations, however, you can choose smaller or larger + values depending upon your platforms characteristics.

-PrevUpHomeNext +PrevUpHomeNext
diff --git a/doc/html/boost_regex/install.html b/doc/html/boost_regex/install.html index eacde153..7070210a 100644 --- a/doc/html/boost_regex/install.html +++ b/doc/html/boost_regex/install.html @@ -43,15 +43,39 @@ The library will encase all code inside namespace boost.

- Unlike some other template libraries, this library consists of a mixture of - template code (in the headers) and static code and data (in cpp files). Consequently - it is necessary to build the library's support code into a library or archive - file before you can use it, instructions for specific platforms are as follows: + This is a header only library provided your compiler supports C++11 or later. + Support for C++03 compilers is still present, but is now deprecated and may + be removed without further notice!

+

+ The only people that still need to build the external libboost_regex library + are those that are either: +

+
    +
  • + Using the library in C++03 mode, or, +
    • +
  • + Using the deprecated POSIX C API's +
    • +
+

+ Further, this library may now be used in "standalone" mode without + the rest of the Boost C++ libraries, in order to do this you must either: +

+
    +
  • + Have a C++17 compiler that supports __has_include, + in this case if <boost/config.hpp> is not present then the library will + automoatically enter standalone mode. Or: +
    • +
  • + Define BOOST_REGEX_STANDALONE when building. +
    • +
- Building - with bjam + C++03 users only (Deprecated) Building with bjam

This is now the preferred method for building and installing this library, diff --git a/doc/html/index.html b/doc/html/index.html index 74ba0669..49e7612f 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -44,8 +44,6 @@

Compiler Setup
Locale and traits class selection
-
Linkage Options
-
Algorithm Selection
Algorithm Tuning
Building and Installing the Library
@@ -215,7 +213,7 @@

- +

Last revised: November 23, 2020 at 17:52:46 GMT

Last revised: January 25, 2021 at 11:08:05 GMT
diff --git a/doc/install.qbk b/doc/install.qbk index 45fea722..041439ef 100644 --- a/doc/install.qbk +++ b/doc/install.qbk @@ -20,13 +20,22 @@ process is the same as for all of boost; see the The library will encase all code inside namespace boost. -Unlike some other template libraries, this library consists of a mixture of -template code (in the headers) and static code and data (in cpp files). -Consequently it is necessary to build the library's support code into a -library or archive file before you can use it, instructions for specific -platforms are as follows: +This is a header only library provided your compiler supports C++11 or later. Support for +C++03 compilers is still present, but is now deprecated and may be removed without further notice! -[h4 Building with bjam] +The only people that still need to build the external libboost_regex library are those that are either: + +* Using the library in C++03 mode, or, +* Using the deprecated POSIX C API's + +Further, this library may now be used in "standalone" mode without the rest of the Boost C++ libraries, +in order to do this you must either: + +* Have a C++17 compiler that supports `__has_include`, in this case if `` is not present +then the library will automoatically enter standalone mode. Or: +* Define BOOST_REGEX_STANDALONE when building. + +[h4 [*C++03 users only (Deprecated)] Building with bjam] This is now the preferred method for building and installing this library, please refer to the