The GNU C++ Library Manual
Prev		Next

The GNU C++ Library Manual

+ License +

Table of Contents

I. + Introduction + +

1. Status

Implementation Status

C++ 1998/2003
C++ 200x
C++ TR1
C++ TR 24733

License

The Code: GPL
The Documentation: GPL, FDL

Bugs

Implementation Bugs
Standard Bugs

2. Setup

Prerequisites
Configure
Make

3. Using

Command Options

Headers

Header Files
Mixing Headers
The C Headers and namespace std
Precompiled Headers

Macros

Namespaces

Available Namespaces
namespace std
Using Namespace Composition

Linking

Almost Nothing
Finding Dynamic or Shared Libraries

Concurrency

Prerequisites
Thread Safety
Atomics
IO
Containers

Exceptions

Exception Safety
Exception Neutrality
Doing without
Compatibility

Debugging Support

Using g++
Debug Versions of Library Binary Files
Memory Leak Hunting
Data Race Hunting
Using gdb
Tracking uncaught exceptions
Debug Mode
Compile Time Checking
Profile-based Performance Analysis

II. + Standard Contents +

4. + Support + +

Types

Fundamental Types
Numeric Properties
NULL

Dynamic Memory

Termination

Termination Handlers
Verbose Terminate Handler

5. + Diagnostics + +

Exceptions

API Reference
Adding Data to exception

Concept Checking

6. + Utilities + +

Functors

Pairs

Memory

Allocators
auto_ptr
shared_ptr

Traits

7. + Strings + +

String Classes

Simple Transformations
Case Sensitivity
Arbitrary Character Types
Tokenizing
Shrink to Fit
CString (MFC)

8. + Localization + +

Locales

locale

Facets

ctype
codecvt
messages

9. + Containers + +

Sequences

list
vector

Associative

Insertion Hints
bitset

Interacting with C

Containers vs. Arrays

10. + Iterators + +

Predefined

Iterators vs. Pointers
One Past the End

11. + Algorithms + +

Mutating

swap

12. + Numerics + +

Complex

complex Processing

Generalized Operations

Interacting with C

Numerics vs. Arrays
C99

13. + Input and Output + +

Iostream Objects

Stream Buffers

Derived streambuf Classes
Buffering

Memory Based Streams

Compatibility With strstream

File Based Streams

Copying a File
Binary Input and Output

Interacting with C

Using FILE* and file descriptors
Performance

14. + Atomics + +

API Reference

15. + Concurrency + +

API Reference

III. + Extensions + +

16. Compile Time Checks

Using the Debug Mode
Using a Specific Debug Container

Design

Goals
Methods
Other Implementations

18. Parallel Mode

Intro

Semantics

Using

Prerequisite Compiler Flags
Using Parallel Mode
Using Specific Parallel Components

Design

Interface Basics
Configuration and Tuning
Implementation Namespaces

Using the Profile Mode
Tuning the Profile Mode

Design

Wrapper Model
Instrumentation
Run Time Behavior
Analysis and Diagnostics
Cost Model
Reports
Testing

Extensions for Custom Containers

Empirical Cost Model

Implementation Issues

Stack Traces
Symbolization of Instruction Addresses
Concurrency
Using the Standard Library in the Instrumentation Implementation
Malloc Hooks
Construction and Destruction of Global Objects

Developer Information

Big Picture
How To Add A Diagnostic

Diagnostics

Diagnostic Template
Containers
Algorithms
Data Locality
Multithreaded Data Access
Statistics

Bibliography

20. Allocators

mt_allocator

Intro
Design Issues
Implementation
Single Thread Example
Multiple Thread Example

bitmap_allocator

Design
Implementation

21. Containers

Policy Based Data Structures
HP/SGI
Deprecated HP/SGI

26. Input and Output

Derived filebufs

27. Demangling

28. Concurrency

Design

Interface to Locks and Mutexes
Interface to Atomic Functions

Implementation

Using Builtin Atomic Functions
Thread Abstraction

Use

IV. + Appendices +

A. + Contributing + +

Contributor Checklist

Reading
Assignment
Getting Sources
Submitting Patches

Directory Layout and Source Conventions

Coding Style

Bad Identifiers
By Example

Design Notes

B. + Porting and Maintenance + +

Configure and Build Hacking

Prerequisites
Overview: What Comes from Where
Storing Information in non-AC files (like configure.host)
Coding and Commenting Conventions
The acinclude.m4 layout
GLIBCXX_ENABLE, the --enable maker

Writing and Generating Documentation

Introduction
Generating Documentation
Doxygen
Docbook

Porting to New Hardware or Operating Systems

Operating System
CPU
Character Types
Thread Safety
Numeric Limits
Libtool

Test

Organization
Running the Testsuite
Writing a new test case
Test Harness and Utilities
Special Topics

ABI Policy and Guidelines

The C++ Interface
Versioning
Allowed Changes
Prohibited Changes
Implementation
Testing
Outstanding Issues

API Evolution and Deprecation History

3.0
3.1
3.2
3.3
3.4
4.0
4.1
4.2
4.3
4.4
4.5

Backwards Compatibility

First
Second
Third

C. + Free Software Needs Free Documentation + +

D. + GNU General Public License version 3 +

E. GNU Free Documentation License

List of Figures

B.1. Configure and Build File Dependencies

List of Tables

1.1. C++ 1998/2003 Implementation Status
1.2. C++ 200x Implementation Status
1.3. C++ TR1 Implementation Status
1.4. C++ TR 24733 Implementation Status
3.1. C++ Command Options
3.2. C++ 1998 Library Headers
3.3. C++ 1998 Library Headers for C Library Facilities
3.4. C++ 200x Library Headers
3.5. C++ 200x Library Headers for C Library Facilities
3.6. C++ TR 1 Library Headers
3.7. C++ TR 1 Library Headers for C Library Facilities
3.8. C++ TR 24733 Decimal Floating-Point Header
3.9. C++ ABI Headers
3.10. Extension Headers
3.11. Extension Debug Headers
3.12. Extension Profile Headers
3.13. Extension Parallel Headers
17.1. Debugging Containers
17.2. Debugging Containers C++0x
18.1. Parallel Algorithms
19.1. Profile Code Location
19.2. Profile Diagnostics
20.1. Bitmap Allocator Memory Map
B.1. Doxygen Prerequisites
B.2. HTML to Doxygen Markup Comparison
B.3. Docbook Prerequisites
B.4. HTML to Docbook XML Markup Comparison
B.5. Docbook XML Element Use
B.6. Extension Allocators
B.7. Extension Allocators Continued