Blame - doc/html/index.html - RealtimeRoboticsGroup/test

<dt><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_allow_use_of_c__11_features_with_c__03_compilers">Macros

70

that allow use of C++11 features with C++03 compilers</a></dt>

71

<dt><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_c__14_features_not_supported">Macros

72

that describe C++14 features not supported</a></dt>

73

<dt><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_allow_use_of_c__14_features_with_c__11_or_earlier_compilers">Macros

74

that allow use of C++14 features with C++11 or earlier compilers</a></dt>

75

<dt><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_c__17_features_not_supported">Macros

76

that describe C++17 features not supported</a></dt>

77

<dt><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_that_describe_features_that_have_been_removed_from_the_standard_">Macros

78

that describe features that have been removed from the standard.</a></dt>

79

<dt><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.boost_helper_macros">Boost

80

Helper Macros</a></dt>

81

<dt><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.boost_informational_macros">Boost

82

Informational Macros</a></dt>

83

<dt><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.boost_deprecated_macros">Boost

84

Deprecated Macros</a></dt>

85

<dt><a href="boost_config/boost_macro_reference.html#boost_config.boost_macro_reference.macros_for_libraries_with_separate_source_code">Macros

86

for libraries with separate source code</a></dt>

87

</dl></dd>

88

<dt><a href="boost_config/build_config.html">Build Time Configuration</a></dt>

89

<dt><a href="boost_config/cstdint.html">Standard Integer Types</a></dt>

90

91

<dt><a href="boost_config/cstdint.html#boost_config.cstdint.overview">Overview</a></dt>

92

<dt><a href="boost_config/cstdint.html#boost_config.cstdint.rationale">Rationale</a></dt>

93

<dt><a href="boost_config/cstdint.html#boost_config.cstdint.ce">Caveat emptor</a></dt>

94

<dt><a href="boost_config/cstdint.html#boost_config.cstdint.exact_width_integer_types">Exact-width

95

integer types</a></dt>

96

<dt><a href="boost_config/cstdint.html#boost_config.cstdint.minimum_width_integer_types">Minimum-width

97

integer types</a></dt>

98

<dt><a href="boost_config/cstdint.html#boost_config.cstdint.fastest_minimum_width_integer_types">Fastest

99

minimum-width integer types</a></dt>

100

<dt><a href="boost_config/cstdint.html#boost_config.cstdint.greatest_width_integer_types">Greatest-width

101

integer types</a></dt>

102

<dt><a href="boost_config/cstdint.html#boost_config.cstdint.integer_constant_macros">Integer

103

Constant Macros</a></dt>

104

</dl></dd>

105

<dt><a href="boost_config/guidelines_for_boost_authors.html">Guidelines for

106

Boost Authors</a></dt>

107

108

<dt><a href="boost_config/guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.warnings">Disabling

109

Compiler Warnings</a></dt>

110

<dt><a href="boost_config/guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_defect_macros">Adding

111

New Defect Macros</a></dt>

112

<dt><a href="boost_config/guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_feature_test_macros">Adding

113

New Feature Test Macros</a></dt>

114

<dt><a href="boost_config/guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.modifying_the_boost_configuration_headers">Modifying

115

the Boost Configuration Headers</a></dt>

116

</dl></dd>

117

<dt><a href="boost_config/rationale.html">Rationale</a></dt>

118

119

<dt><a href="boost_config/rationale.html#boost_config.rationale.the_problem">The problem</a></dt>

120

<dt><a href="boost_config/rationale.html#boost_config.rationale.the_solution">The solution</a></dt>

121

</dl></dd>

122

<dt><a href="boost_config/acknowledgements.html">Acknowledgements</a></dt>

</dl>

</div>

<a name="boost_config.configuring_boost_for_your_platform"></a><a class="link" href="index.html#boost_config.configuring_boost_for_your_platform" title="Configuring Boost for Your Platform">Configuring

128

Boost for Your Platform</a>

129

</h2></div></div></div>

130

131

<dt><a href="index.html#boost_config.configuring_boost_for_your_platform.using_the_default_boost_configuration">Using

132

the default boost configuration</a></dt>

133

<dt><a href="index.html#boost_config.configuring_boost_for_your_platform.the__boost_config_hpp__header">The

134

<boost/config.hpp> header</a></dt>

135

<dt><a href="index.html#boost_config.configuring_boost_for_your_platform.using_the_configure_script">Using

136

the configure script</a></dt>

137

<dt><a href="index.html#boost_config.configuring_boost_for_your_platform.user_settable_options">User

138

settable options</a></dt>

139

<dt><a href="index.html#boost_config.configuring_boost_for_your_platform.advanced_configuration_usage">Advanced

140

configuration usage</a></dt>

141

<dt><a href="index.html#boost_config.configuring_boost_for_your_platform.testing_the_boost_configuration">Testing

142

the boost configuration</a></dt>

</dl></div>

<a name="boost_config.configuring_boost_for_your_platform.using_the_default_boost_configuration"></a><a class="link" href="index.html#boost_config.configuring_boost_for_your_platform.using_the_default_boost_configuration" title="Using the default boost configuration">Using

147

the default boost configuration</a>

148

</h3></div></div></div>

149

150

Boost comes already configured for most common compilers and platforms; you

151

should be able to use boost "as is". Since the compiler is configured

152

separately from the standard library, the default configuration should work

153

even if you replace the compiler's standard library with a third-party standard

154

library (like <a href="http://stlport.sourceforge.net" target="_top">STLport</a>).

155

156

157

Using boost "as is" without trying to reconfigure is the recommended

158

method for using boost. You can, however, run the configure script if you

159

want to, and there are regression tests provided that allow you to test the

160

current boost configuration with your particular compiler setup.

161

162

163

Boost library users can request support for additional compilers or platforms

164

by visiting our <a href="https://svn.boost.org/trac/boost/newticket" target="_top">Trac</a>

165

and submitting a support request.

</div>

<a name="boost_config.configuring_boost_for_your_platform.the__boost_config_hpp__header"></a><a class="link" href="index.html#boost_config.configuring_boost_for_your_platform.the__boost_config_hpp__header" title="The <boost/config.hpp> header">The

171

<boost/config.hpp> header</a>

172

</h3></div></div></div>

173

174

Boost library implementations access configuration macros via

175

176

<pre class="programlisting">#include <a href="../../../../boost/config.hpp" target="_top"><boost/config.hpp></a>

177

</pre>

178

179

While Boost library users are not required to include that file directly,

180

or use those configuration macros, such use is acceptable. The configuration

181

macros are documented as to their purpose, usage, and limitations which makes

182

them usable by both Boost library and user code.

183

184

185

Boost <a class="link" href="boost_config/boost_macro_reference.html#config_info_macros">informational</a> or <a class="link" href="boost_config/boost_macro_reference.html#config_helpers">helper</a>

186

macros are designed for use by Boost users as well as for our own internal

187

use. Note however, that the <a class="link" href="boost_config/boost_macro_reference.html#config_features">feature test</a>

188

and <a class="link" href="boost_config/boost_macro_reference.html#config_defects">defect test</a> macros were designed

189

for internal use by Boost libraries, not user code, so they can change at

190

any time (though no gratuitous changes are made to them). Boost library problems

191

resulting from changes to the configuration macros are caught by the Boost

192

regression tests, so the Boost libraries are updated to account for those

193

changes. By contrast, Boost library user code can be adversely affected by

194

changes to the macros without warning. The best way to keep abreast of changes

195

to the macros used in user code is to monitor the discussions on the Boost

developers list.

</div>

<a name="boost_config.configuring_boost_for_your_platform.using_the_configure_script"></a><a name="config_config_script"></a><a class="link" href="index.html#boost_config.configuring_boost_for_your_platform.using_the_configure_script" title="Using the configure script">Using

202

the configure script</a>

203

</h3></div></div></div>

<tr>

<th align="left">Important</th>

208

</tr>

209

210

This configure script only sets up the Boost headers for use with a particular

211

compiler. It has no effect on Boost.Build, or how the libraries are built.

</td></tr>

</table></div>

If you know that boost is incorrectly configured for your particular setup,

216

and you are on a UNIX like platform, then you may want to try and improve

217

things by running the boost configure script. From a shell command prompt

218

you will need to cd into <boost-root><code class="computeroutput">/libs/config/</code>

and type:

<code class="computeroutput">sh ./configure</code>

223

</blockquote></div>

224

225

you will see a list of the items being checked as the script works its way

226

through the regression tests. Note that the configure script only really

227

auto-detects your compiler if it's called g++, c++ or CC. If you are using

228

some other compiler you will need to set one or more of the following environment

variables:

<col>

<col>

</colgroup>

<th>

Variable

</th>

<th>

Description

</th>

</tr></thead>

<tbody>

<tr>

<td>

CXX

</td>

<td>

The name of the compiler, for example <code class="computeroutput">c++</code>.

</td>

</tr>

<tr>

<td>

CXXFLAGS

</td>

<td>

The compiler flags to use, for example <code class="computeroutput">-O2</code>.

</td>

</tr>

<tr>

<td>

LDFLAGS

</td>

<td>

The linker flags to use, for example <code class="computeroutput">-L/mypath</code>.

</td>

</tr>

<tr>

<td>

LIBS

</td>

<td>

Any libraries to link in, for example <code class="computeroutput">-lpthread</code>.

</td>

</tr>

</tbody>

</table></div>

For example to run the configure script with HP aCC, you might use something

301

like:

302

303

<pre class="programlisting">export CXX="aCC"

304

export CXXFLAGS="-Aa -DAportable -D__HPACC_THREAD_SAFE_RB_TREE \

305

-DRWSTD_MULTI_THREAD -DRW_MULTI_THREAD -D_REENTRANT -D_THREAD_SAFE"

306

export LDFLAGS="-DAportable"

307

export LIBS="-lpthread"

sh ./configure

</pre>

However you run the configure script, when it finishes you will find a new

312

header -<code class="computeroutput">user.hpp</code>- located in the <boost-root><code class="computeroutput">/libs/config/</code>

313

directory. Note that configure does not install this

314

header into your boost include path by default. This header contains

315

all the options generated by the configure script, plus a header-section

316

that contains the user settable options from the default version of <a href="../../../../boost/config/user.hpp" target="_top"><boost/config/user.hpp></a>

317

(located under <boost-root><code class="computeroutput">/boost/config/</code>).

318

There are two ways you can use this header:

Option 1: copy the header into <boost-root><code class="computeroutput">/boost/config/</code> so that it replaces the default user.hpp

323

provided by boost. This option allows only one configure-generated setup;

324

boost developers should avoid this option, as it incurs the danger of

325

accidentally committing a configure-modified <a href="../../../../boost/config/user.hpp" target="_top"><boost/config/user.hpp></a>

326

to the svn repository (something you will not be thanked for!).

327

</li>

328

329

Option 2: give the header a more memorable

330

name, and place it somewhere convenient; then, define the macro <code class="computeroutput">BOOST_USER_CONFIG</code> to point to it. For

331

example create a new sub-directory <boost-root><code class="computeroutput">/boost/config/</code> <code class="computeroutput">user/</code>, and copy the header there; for example

332

as <code class="computeroutput">multithread-gcc-config.hpp</code>. Then, when compiling add the command

333

line option: <code class="computeroutput">-DBOOST_USER_CONFIG="<boost/config/user/multithread-gcc-config.hpp>"</code>,

334

and boost will use the new configuration header. This option allows you

335

to generate more than one configuration header, and to keep them separate

336

from the boost source - so that updates to the source do not interfere

337

with your configuration.

</li>

</ul></div>

</div>

<a name="boost_config.configuring_boost_for_your_platform.user_settable_options"></a><a name="config_user_settable"></a><a class="link" href="index.html#boost_config.configuring_boost_for_your_platform.user_settable_options" title="User settable options">User

344

settable options</a>

345

</h3></div></div></div>

346

347

There are some configuration-options that represent user choices, rather

348

than compiler defects or platform specific options. These are listed in

349

350

and at the start of a configure-generated <code class="computeroutput">user.hpp</code> header.

351

You can define these on the command line, or by editing <code class="computeroutput"><boost/config/user.hpp></code>, they are listed in the following table:

<col>

<col>

</colgroup>

<th>

Macro

</th>

<th>

Description

</th>

</tr></thead>

<tbody>

<tr>

<td>

<code class="computeroutput">BOOST_USER_CONFIG</code>

</td>

<td>

When defined, it should point to the name of the user configuration

380

file to include prior to any boost configuration files. When not

381

defined, defaults to <a href="../../../../boost/config/user.hpp" target="_top"><code class="computeroutput"><boost/config/user.hpp></code></a>.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_COMPILER_CONFIG</code>

</td>

<td>

When defined, it should point to the name of the compiler configuration

394

file to use. Defining this cuts out the compiler selection logic,

395

and eliminates the dependency on the header containing that logic.

396

For example if you are using gcc, then you could define BOOST_COMPILER_CONFIG

397

to <a href="../../../../boost/config/compiler/gcc.hpp" target="_top"><code class="computeroutput"><boost/config/compiler/gcc.hpp></code></a>.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_STDLIB_CONFIG</code>

</td>

<td>

When defined, it should point to the name of the standard library

410

configuration file to use. Defining this cuts out the standard

411

library selection logic, and eliminates the dependency on the header

412

containing that logic. For example if you are using STLport, then

413

you could define <code class="computeroutput">BOOST_STDLIB_CONFIG</code>

414

to <a href="../../../../boost/config/stdlib/stlport.hpp" target="_top"><code class="computeroutput"><boost/config/stdlib/stlport.hpp></code></a>.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_PLATFORM_CONFIG</code>

</td>

<td>

When defined, it should point to the name of the platform configuration

427

file to use. Defining this cuts out the platform selection logic,

428

and eliminates the dependency on the header containing that logic.

429

For example if you are compiling on linux, then you could define

430

<code class="computeroutput">BOOST_PLATFORM_CONFIG</code>

431

to <a href="../../../../boost/config/platform/linux.hpp" target="_top"><code class="computeroutput"><boost/config/platform/linux.hpp></code></a>.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_NO_COMPILER_CONFIG</code>

</td>

<td>

When defined, no compiler configuration file is selected or included,

444

define when the compiler is fully conformant with the standard,

445

or where the user header (see <code class="computeroutput">BOOST_USER_CONFIG</code>),

446

has had any options necessary added to it, for example by an autoconf

447

generated configure script.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_NO_STDLIB_CONFIG</code>

</td>

<td>

When defined, no standard library configuration file is selected

460

or included, define when the standard library is fully conformant

461

with the standard, or where the user header (see <code class="computeroutput">BOOST_USER_CONFIG</code>), has had any

462

options necessary added to it, for example by an autoconf generated

configure script.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_NO_PLATFORM_CONFIG</code>

</td>

<td>

When defined, no platform configuration file is selected or included,

476

define when the platform is fully conformant with the standard

477

(and has no useful extra features), or where the user header (see

478

<code class="computeroutput">BOOST_USER_CONFIG</code>),

479

has had any options necessary added to it, for example by an autoconf

480

generated configure script.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_NO_CONFIG</code>

</td>

<td>

Equivalent to defining all of <code class="computeroutput">BOOST_NO_COMPILER_CONFIG</code>,

493

<code class="computeroutput">BOOST_NO_STDLIB_CONFIG</code>

494

and <code class="computeroutput">BOOST_NO_PLATFORM_CONFIG</code>.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_STRICT_CONFIG</code>

</td>

<td>

The normal behavior for compiler versions that are newer than the

507

last known version, is to assume that they have all the same defects

508

as the last known version. By setting this define, then compiler

509

versions that are newer than the last known version are assumed

510

to be fully conforming with the standard. This is probably most

511

useful for boost developers or testers, and for those who want

512

to use boost to test beta compiler versions.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_ASSERT_CONFIG</code>

</td>

<td>

When this flag is set, if the config finds anything unknown, then

525

it will stop with a #error rather than continue. Boost regression

526

testers should set this define, as should anyone who wants to quickly

527

check whether boost is supported on their platform.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_DISABLE_THREADS</code>

</td>

<td>

When defined, disables threading support, even if the compiler

540

in its current translation mode supports multiple threads.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_DISABLE_WIN32</code>

</td>

<td>

When defined, disables the use of Win32 specific API's, even when

553

these are available. Also has the effect of setting <code class="computeroutput">BOOST_DISABLE_THREADS</code> unless

554

<code class="computeroutput">BOOST_HAS_PTHREADS</code>

555

is set. This option may be set automatically by the config system

556

when it detects that the compiler is in "strict mode".

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_DISABLE_ABI_HEADERS</code>

</td>

<td>

Stops boost headers from including any prefix/suffix headers that

569

normally control things like struct packing and alignment.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_ABI_PREFIX</code>

</td>

<td>

A prefix header to include in place of whatever boost.config would

582

normally select, any replacement should set up struct packing and

583

alignment options as required.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_ABI_SUFFIX</code>

</td>

<td>

A suffix header to include in place of whatever boost.config would

596

normally select, any replacement should undo the effects of the

prefix header.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_ALL_DYN_LINK</code>

</td>

<td>

Forces all libraries that have separate source, to be linked as

610

dll's rather than static libraries on Microsoft Windows (this macro

611

is used to turn on <code class="computeroutput">__declspec(dllimport)</code> modifiers, so that the compiler

612

knows which symbols to look for in a dll rather than in a static

613

library). Note that there may be some libraries that can only be

614

statically linked (Boost.Test for example) and others which may

615

only be dynamically linked (Boost.Thread for example), in these

616

cases this macro has no effect.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_</code>WHATEVER<code class="computeroutput">_DYN_LINK</code>

</td>

<td>

Forces library "whatever" to be linked as a dll rather

629

than a static library on Microsoft Windows: replace the WHATEVER

630

part of the macro name with the name of the library that you want

631

to dynamically link to, for example use <code class="computeroutput">BOOST_DATE_TIME_DYN_LINK</code>

632

or <code class="computeroutput">BOOST_REGEX_DYN_LINK</code>

633

etc (this macro is used to turn on <code class="computeroutput">__declspec(dllimport)</code> modifiers, so that the compiler

634

knows which symbols to look for in a dll rather than in a static

635

library). Note that there may be some libraries that can only be

636

statically linked (Boost.Test for example) and others which may

637

only be dynamically linked (Boost.Thread for example), in these

638

cases this macro is unsupported.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_ALL_NO_LIB</code>

</td>

<td>

Tells the config system not to automatically select which libraries

651

to link against. Normally if a compiler supports #pragma lib, then

652

the correct library build variant will be automatically selected

653

and linked against, simply by the act of including one of that

654

library's headers. This macro turns that feature off.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_</code>WHATEVER<code class="computeroutput">_NO_LIB</code>

</td>

<td>

Tells the config system not to automatically select which library

667

to link against for library "whatever", replace WHATEVER

668

in the macro name with the name of the library; for example <code class="computeroutput">BOOST_DATE_TIME_NO_LIB</code> or <code class="computeroutput">BOOST_REGEX_NO_LIB</code>. Normally

669

if a compiler supports <code class="computeroutput">#pragma

670

lib</code>, then the correct

671

library build variant will be automatically selected and linked

672

against, simply by the act of including one of that library's headers.

673

This macro turns that feature off.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_LIB_DIAGNOSTIC</code>

</td>

<td>

Causes the auto-linking code to output diagnostic messages indicating

686

the name of the library that is selected for linking.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_LIB_BUILDID</code>

</td>

<td>

If you built Boost using the <code class="computeroutput">--buildid</code> option then set this

699

macro to the same value as you passed to bjam. For example if you

700

built using <code class="computeroutput">bjam address-model=64 --buildid=amd64</code> then compile your code

701

with <code class="computeroutput">-DBOOST_LIB_BUILDID=amd64</code>

702

to ensure the correct libraries are selected at link time.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">BOOST_LIB_TOOLSET</code>

</td>

<td>

Overrides the name of the toolset part of the name of library being

715

linked to; note if defined this must be defined to a quoted string

716

literal, for example "abc".

</td>

</tr>

</tbody>

</table></div>

</div>

<a name="boost_config.configuring_boost_for_your_platform.advanced_configuration_usage"></a><a class="link" href="index.html#boost_config.configuring_boost_for_your_platform.advanced_configuration_usage" title="Advanced configuration usage">Advanced

726

configuration usage</a>

727

</h3></div></div></div>

728

729

<dt><a href="index.html#boost_config.configuring_boost_for_your_platform.advanced_configuration_usage.example_1__creating_our_own_frozen_configuration">Example

730

1: creating our own frozen configuration</a></dt>

731

<dt><a href="index.html#boost_config.configuring_boost_for_your_platform.advanced_configuration_usage.example_2__skipping_files_that_you_don_t_need">Example

732

2: skipping files that you don't need</a></dt>

733

<dt><a href="index.html#boost_config.configuring_boost_for_your_platform.advanced_configuration_usage.example_3__using_configure_script_to_freeze_the_boost_configuration">Example

734

3: using configure script to freeze the boost configuration</a></dt>

735

</dl></div>

736

737

By setting various macros on the compiler command line or by editing <a href="../../../../boost/config/user.hpp" target="_top"><boost/config/user.hpp></a>,

738

the boost configuration setup can be optimised in a variety of ways.

739

740

741

Boost's configuration is structured so that the user-configuration is included

742

first (defaulting to <a href="../../../../boost/config/user.hpp" target="_top"><boost/config/user.hpp></a>

743

if <code class="computeroutput">BOOST_USER_CONFIG</code> is not

744

defined). This sets up any user-defined policies, and gives the user-configuration

745

a chance to influence what happens next.

746

747

748

Next the compiler, standard library, and platform configuration files are

749

included. These are included via macros (<code class="computeroutput">BOOST_COMPILER_CONFIG</code>

750

etc, <a class="link" href="index.html#config_user_settable">see user settable macros</a>),

751

and if the corresponding macro is undefined then a separate header that detects

752

which compiler/standard library/platform is in use is included in order to

753

set these. The config can be told to ignore these headers altogether if the

754

corresponding <code class="computeroutput">BOOST_NO_XXX</code>

755

macro is set (for example <code class="computeroutput">BOOST_NO_COMPILER_CONFIG</code>

756

to disable including any compiler configuration file - <a class="link" href="index.html#config_user_settable">see

757

user settable macros</a>).

758

759

760

Finally the boost configuration header, includes <a href="../../../../boost/config/detail/suffix.hpp" target="_top"><boost/config/detail/suffix.hpp></a>;

761

this header contains any boiler plate configuration code - for example where

762

one boost macro being set implies that another must be set also.

763

764

765

The following usage examples represent just a few of the possibilities:

<a name="boost_config.configuring_boost_for_your_platform.advanced_configuration_usage.example_1__creating_our_own_frozen_configuration"></a><a class="link" href="index.html#boost_config.configuring_boost_for_your_platform.advanced_configuration_usage.example_1__creating_our_own_frozen_configuration" title="Example 1: creating our own frozen configuration">Example

770

1: creating our own frozen configuration</a>

771

</h4></div></div></div>

772

773

Lets suppose that we're building boost with Visual C++ 6, and STLport 4.0.

774

Lets suppose also that we don't intend to update our compiler or standard

775

library any time soon. In order to avoid breaking dependencies when we

776

update boost, we may want to "freeze" our configuration headers,

777

so that we only have to rebuild our project if the boost code itself has

778

changed, and not because the boost config has been updated for more recent

779

versions of Visual C++ or STLport. We'll start by realising that the configuration

780

files in use are: <a href="../../../../boost/config/compiler/visualc.hpp" target="_top"><code class="computeroutput"><boost/config/compiler/visualc.hpp></code></a> for the compiler, <a href="../../../../boost/config/stdlib/stlport.hpp" target="_top"><code class="computeroutput"><boost/config/stdlib/stlport.hpp></code></a> for the standard library, and

781

<a href="../../../../boost/config/platform/win32.hpp" target="_top"><code class="computeroutput"><boost/config/platform/win32.hpp></code></a> for the platform. Next we'll

782

create our own private configuration directory: <code class="computeroutput">boost/config/mysetup/</code>, and copy the configuration files into

783

there. Finally, open up <a href="../../../../boost/config/user.hpp" target="_top"><boost/config/user.hpp></a>

784

and edit the following defines:

785

786

<pre class="programlisting">#define BOOST_COMPILER_CONFIG "boost/config/mysetup/visualc.hpp"

787

#define BOOST_STDLIB_CONFIG "boost/config/mysetup/stlport.hpp"

788

#define BOOST_USER_CONFIG "boost/config/mysetup/win32.hpp"

789

</pre>

790

791

Now when you use boost, its configuration header will go straight to our

792

"frozen" versions, and ignore the default versions, you will

793

now be insulated from any configuration changes when you update boost.

794

This technique is also useful if you want to modify some of the boost configuration

795

files; for example if you are working with a beta compiler release not

796

yet supported by boost.

</div>

<a name="boost_config.configuring_boost_for_your_platform.advanced_configuration_usage.example_2__skipping_files_that_you_don_t_need"></a><a class="link" href="index.html#boost_config.configuring_boost_for_your_platform.advanced_configuration_usage.example_2__skipping_files_that_you_don_t_need" title="Example 2: skipping files that you don't need">Example

802

2: skipping files that you don't need</a>

803

</h4></div></div></div>

804

805

Lets suppose that you're using boost with a compiler that is fully conformant

806

with the standard; you're not interested in the fact that older versions

807

of your compiler may have had bugs, because you know that your current

808

version does not need any configuration macros setting. In a case like

809

this, you can define <code class="computeroutput">BOOST_NO_COMPILER_CONFIG</code>

810

either on the command line, or in <a href="../../../../boost/config/user.hpp" target="_top"><boost/config/user.hpp></a>,

811

and miss out the compiler configuration header altogether (actually you

812

miss out two headers, one which works out what the compiler is, and one

813

that configures boost for it). This has two consequences: the first is

814

that less code has to be compiled, and the second that you have removed

815

a dependency on two boost headers.

</div>

<a name="boost_config.configuring_boost_for_your_platform.advanced_configuration_usage.example_3__using_configure_script_to_freeze_the_boost_configuration"></a><a class="link" href="index.html#boost_config.configuring_boost_for_your_platform.advanced_configuration_usage.example_3__using_configure_script_to_freeze_the_boost_configuration" title="Example 3: using configure script to freeze the boost configuration">Example

821

3: using configure script to freeze the boost configuration</a>

822

</h4></div></div></div>

823

824

If you are working on a unix-like platform then you can use the configure

825

script to generate a "frozen" configuration based on your current

826

compiler setup - <a class="link" href="index.html#config_config_script">see using the configure

827

script for more details</a>.

</div>

</div>

<a name="boost_config.configuring_boost_for_your_platform.testing_the_boost_configuration"></a><a class="link" href="index.html#boost_config.configuring_boost_for_your_platform.testing_the_boost_configuration" title="Testing the boost configuration">Testing

834

the boost configuration</a>

835

</h3></div></div></div>

836

837

The boost configuration library provides a full set of regression test programs

838

under the <boost-root><code class="computeroutput">/boost/config/</code>

sub-directory:

<col>

<col>

</colgroup>

<th>

File

</th>

<th>

Description

</th>

</tr></thead>

<tbody>

<tr>

<td>

<code class="computeroutput">config_info.cpp</code>

</td>

<td>

Prints out a detailed description of your compiler/standard library/platform

869

setup, plus your current boost configuration. The information provided

870

by this program is useful in setting up the boost configuration

871

files. If you report that boost is incorrectly configured for your

872

compiler/library/platform then please include the output from this

873

program when reporting the changes required.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">config_test.cpp</code>

</td>

<td>

A monolithic test program that includes most of the individual

886

test cases. This provides a quick check to see if boost is correctly

887

configured for your compiler/library/platform.

</td>

</tr>

<tr>

<td>

<code class="computeroutput">limits_test.cpp</code>

</td>

<td>

Tests your standard library's <code class="computeroutput">std::numeric_limits</code>

900

implementation (or its boost provided replacement if <code class="computeroutput">BOOST_NO_LIMITS</code> is defined).

901

This test file fails with most versions of numeric_limits, mainly

902

due to the way that some compilers treat NAN's and infinity.

</td>

</tr>

<tr>

<td>

</td>

<td>

Individual compiler defect test files. Each of these should compile,

915

if one does not then the corresponding <code class="computeroutput">BOOST_NO_XXX</code>

916

macro needs to be defined - see each test file for specific details.

</td>

</tr>

<tr>

<td>

</td>

<td>

Individual compiler defect test files. Each of these should not

929

compile, if one does then the corresponding <code class="computeroutput">BOOST_NO_XXX</code>

930

macro is defined when it need not be - see each test file for specific

details.

</td>

</tr>

<tr>

<td>

</td>

<td>

Individual feature test files. If one of these does not compile

944

then the corresponding <code class="computeroutput">BOOST_HAS_XXX</code>

945

macro is defined when it should not be - see each test file for

specific details.

</td>

</tr>

<tr>

<td>

</td>

<td>

Individual feature test files. If one of these does compile then

959

the corresponding <code class="computeroutput">BOOST_HAS_XXX</code>

960

macro can be safely defined - see each test file for specific details.

</td>

</tr>

</tbody>

</table></div>

Although you can run the configuration regression tests as individual test

968

files, there are rather a lot of them, so there are a couple of shortcuts

to help you out:

If you have built the <a href="../../../../tools/regression/doc/index.html" target="_top">boost

973

regression test driver</a>, then you can use this to produce a nice html

974

formatted report of the results using the supplied test file.

975

976

977

Alternatively you can run the configure script like this:

978

979

980

<code class="computeroutput">./configure

--enable-test</code>

</blockquote></div>

in which case the script will test the current configuration rather than

985

creating a new one from scratch.

986

987

988

If you are reporting the results of these tests for a new platform/library/compiler

989

then please include a log of the full compiler output, the output from <code class="computeroutput">config_info.cpp</code>, and the pass/fail test results.

</div>

</div>

</div>

<td align="left">Last revised: April 18, 2018 at 18:30:02 GMT</td>

</tr></table>

<hr>

</body>

</html>