Accessing the C++ Library Man Pages - Oracle® Solaris Studio 12.4: C++ User's Guide

Oracle^® Solaris Studio 12.4: C++ User's Guide

Document Information

Using This Documentation

Product Documentation Library

Access to Oracle Support

Feedback

Part I C++ Compiler

Chapter 1 The C++ Compiler

1.1 New Features and Functionality of the Oracle Solaris Studio 12.4 C++ 5.13 Compiler

1.1.1 C++11 Standard

1.1.2 Enforcement of C++ Rules

1.1.2.1 Template definition parsing

1.1.2.2 Dependent base lookup

1.1.2.3 Re-declaring template parameters

1.1.2.4 Old-style explicit instantiations

1.1.2.5 Stricter -template=extdef

1.1.2.6 Implicit int

1.1.2.7 Friend declarations

1.1.2.8 Static functions and name lookup in templates

1.2 Special x86 Notes

1.3 Compiling for 64–Bit Platforms

1.4 Binary Compatibility Verification

1.5 Standards Conformance

1.6 Release Information

1.7 Man Pages

1.8 Native-Language Support

Chapter 2 Using the C++ Compiler

2.1 Getting Started

2.2 Invoking the Compiler

2.2.1 Command Syntax

2.2.2 File Name Conventions

2.2.3 Using Multiple Source Files

2.3 Template Cache Considerations

2.4 Compiling and Linking

2.4.1 Compile-Link Sequence

2.4.2 Separate Compiling and Linking

2.4.3 Consistent Compiling and Linking

2.4.4 Compiling for 64–Bit Memory Model

2.4.5 Compiler Command-Line Diagnostics

2.4.6 Understanding the Compiler Organization

2.5 Preprocessing Directives and Names

2.5.1 Pragmas

2.5.2 Macros With a Variable Number of Arguments

2.5.3 Predefined Names

2.5.4 Warnings and Errors

2.6 Memory Requirements

2.6.1 Swap Space Size

2.6.2 Increasing Swap Space

2.6.3 Control of Virtual Memory

2.6.4 Memory Requirements

2.7 Using the strip Command with C++ Objects

2.8 Simplifying Commands

2.8.1 Using Aliases Within the C Shell

2.8.2 Using CCFLAGS to Specify Compile Options

2.8.3 Using make

2.8.3.1 Using CCFLAGS Within make

Chapter 3 Using the C++ Compiler Options

3.1 Syntax Overview

3.2 General Guidelines

3.3 Options Summarized by Function

3.3.1 Code Generation Options

3.3.2 Compile-Time Performance Options

3.3.3 Compile-Time and Link-Time Options

3.3.4 Debugging Options

3.3.5 Floating-Point Options

3.3.6 Language Options

3.3.7 Library Options

3.3.8 Obsolete Options

3.3.9 Output Options

3.3.10 Run-Time Performance Options

3.3.11 Preprocessor Options

3.3.12 Profiling Options

3.3.13 Reference Options

3.3.14 Source Options

3.3.15 Template Options

3.3.16 Thread Options

3.4 User-Supplied Default Options File

Part II Writing C++ Programs

Chapter 4 Language Extensions

4.1 Linker Scoping

4.1.1 Compatibility with Microsoft Windows

4.2 Thread-Local Storage

4.3 Overriding With Less Restrictive Virtual Functions

4.4 Making Forward Declarations of enum Types and Variables

4.5 Using Incomplete enum Types

4.6 Using an enum Name as a Scope Qualifier

4.7 Using Anonymous struct Declarations

4.8 Passing the Address of an Anonymous Class Instance

4.9 Declaring a Static Namespace-Scope Function as a Class Friend

4.10 Using the Predefined __func__ Symbol for Function Name

4.11 Supported Attributes

4.11.1 __has_attribute function-like macro

4.11.2 __packed__ Attribute Details

4.12 Compiler Support for Intel MMX and Extended x86 Platform Intrinsics

Chapter 5 Program Organization

5.1 Header Files

5.1.1 Language-Adaptable Header Files

5.1.2 Idempotent Header Files

5.2 Template Definitions

5.2.1 Template Definitions Included

5.2.2 Template Definitions Separate

Chapter 6 Creating and Using Templates

6.1 Function Templates

6.1.1 Function Template Declaration

6.1.2 Function Template Definition

6.1.3 Function Template Use

6.2 Class Templates

6.2.1 Class Template Declaration

6.2.2 Class Template Definition

6.2.3 Class Template Member Definitions

6.2.3.1 Function Member Definitions

6.2.3.2 Static Data Member Definitions

6.2.4 Class Template Use

6.3 Template Instantiation

6.3.1 Implicit Template Instantiation

6.3.2 Explicit Template Instantiation

6.3.2.1 Explicit Instantiation of Template Functions

6.3.2.2 Explicit Instantiation of Template Classes

6.3.2.3 Explicit Instantiation of Template Class Function Members

6.3.2.4 Explicit Instantiation of Template Class Static Data Members

6.4 Template Composition

6.5 Default Template Parameters

6.6 Template Specialization

6.6.1 Template Specialization Declaration

6.6.2 Template Specialization Definition

6.6.3 Template Specialization Use and Instantiation

6.6.4 Partial Specialization

6.7 Template Problem Areas

6.7.1 Nonlocal Name Resolution and Instantiation

6.7.2 Local Types as Template Arguments

6.7.3 Friend Declarations of Template Functions

6.7.4 Using Qualified Names Within Template Definitions

6.7.5 Nesting Template Names

6.7.6 Referencing Static Variables and Static Functions

6.7.7 Building Multiple Programs Using Templates in the Same Directory

Chapter 7 Compiling Templates

7.1 Verbose Compilation

7.2 Repository Administration

7.2.1 Generated Instances

7.2.2 Whole-Class Instantiation

7.2.3 Compile-Time Instantiation

7.2.4 Template Instance Placement and Linkage

7.3 External Instances

7.3.1 Possible Cache Conflicts

7.3.2 Static Instances

7.3.3 Global Instances

7.3.4 Explicit Instances

7.3.5 Semi-Explicit Instances

7.4 Template Repository

7.4.1 Repository Structure

7.4.2 Writing to the Template Repository

7.4.3 Reading From Multiple Template Repositories

7.4.4 Sharing Template Repositories

7.4.5 Template Instance Automatic Consistency With -instances=extern

7.5 Template Definition Searching

7.5.1 Source File Location Conventions

7.5.2 Definitions Search Path

7.5.3 Troubleshooting a Problematic Search

Chapter 8 Exception Handling

8.1 Synchronous and Asynchronous Exceptions

8.2 Specifying Runtime Errors

8.3 Disabling Exceptions

8.4 Using Runtime Functions and Predefined Exceptions

8.5 Mixing Exceptions With Signals and Setjmp/Longjmp

8.6 Building Shared Libraries That Have Exceptions

Chapter 9 Improving Program Performance

9.1 Avoiding Temporary Objects

9.2 Using Inline Functions

9.3 Using Default Operators

9.4 Using Value Classes

9.4.1 Choosing to Pass Classes Directly

9.4.2 Passing Classes Directly on Various Processors

9.5 Cache Member Variables

Chapter 10 Building Multithreaded Programs

10.1 Building Multithreaded Programs

10.1.1 Indicating Multithreaded Compilation

10.1.2 Using C++ Support Libraries With Threads and Signals

10.2 Using Exceptions in a Multithreaded Program

10.2.1 Thread Cancellation

10.3 Sharing C++ Standard Library Objects Between Threads

10.4 Memory Barrier Intrinsics

Part III Libraries

Chapter 11 Using Libraries

11.1 C Libraries

11.2 Libraries Provided With the C++ Compiler

11.2.1 C++ Library Descriptions

11.2.2 Accessing the C++ Library Man Pages

11.2.3 Default C++ Libraries

11.3 Related Library Options

11.4 Using Class Libraries

11.4.1 iostream Library

11.4.1.1 Note About Classic iostreams

11.4.2 Linking C++ Libraries

11.5 Statically Linking Standard Libraries

11.6 Using Shared Libraries

11.7 Replacing the C++ Standard Library

11.7.1 What Can Be Replaced

11.7.2 What Cannot Be Replaced

11.7.3 Installing the Replacement Library

11.7.4 Using the Replacement Library

11.7.5 Standard Header Implementation

11.7.5.1 Replacing Standard C++ Headers

11.7.5.2 Replacing Standard C Headers

Caveats:

Chapter 12 Using the C++ Standard Library

12.1 STLport

12.1.1 Redistribution and Supported STLport Libraries

12.1.2 Redistribution and Supported g++ Libraries.

12.2 Apache stdcxx Standard Library

Chapter 13 Using the Classic iostream Library

13.1 Predefined iostreams

13.2 Basic Structure of iostream Interaction

13.3 Using the Classic iostream Library

13.3.1 Output Using iostream

13.3.1.1 Defining Your Own Insertion Operator

13.3.1.2 Handling Output Errors

13.3.1.3 Flushing

13.3.1.4 Binary Output

13.3.2 Input Using iostream

13.3.3 Defining Your Own Extraction Operators

13.3.4 Using the char* Extractor

13.3.5 Reading Any Single Character

13.3.6 Binary Input

13.3.7 Peeking at Input

13.3.8 Extracting Whitespace

13.3.9 Handling Input Errors

13.3.10 Using iostreams With stdio

13.4 Creating iostreams

13.4.1 Dealing With Files Using Class fstream

13.4.1.1 Open Mode

13.4.1.2 Declaring an fstream Without Specifying a File

13.4.1.3 Opening and Closing Files

13.4.1.4 Opening a File Using a File Descriptor

13.4.1.5 Repositioning Within a File

13.5 Assignment of iostreams

13.6 Format Control

13.7 Manipulators

13.7.1 Using Plain Manipulators

13.7.2 Parameterized Manipulators

13.8 strstream: iostreams for Arrays

13.9 stdiobuf: iostreams for stdio Files

13.10 Working Withstreambuf Streams

13.10.1 streambuf Pointer Types

13.10.2 Using streambuf Objects

13.11 iostream Man Pages

13.12 iostream Terminology

Chapter 14 Building Libraries

14.1 Understanding Libraries

14.2 Building Static (Archive) Libraries

14.3 Building Dynamic (Shared) Libraries

14.4 Building Shared Libraries That Contain Exceptions

14.5 Building Libraries for Private Use

14.6 Building Libraries for Public Use

14.7 Building a Library That Has a C API

14.8 Using dlopen to Access a C++ Library From a C Program

Part IV Appendixes

Appendix A C++ Compiler Options

A.1 How Option Information Is Organized

A.2.14.1 Values and Defaults

A.2.17 –features=a[,a...]

A.2.18 -filt[=filter[,filter...]]

A.2.20 -fma[={none|fused}]

A.2.21 –fnonstd

A.2.22 –fns[={yes|no}]

A.2.28 -ftrap=t[,t...]

A.2.29.1 Interactions

A.2.31.1 Interactions

A.2.35.1 Interactions

A.2.38 include filename

A.2.41 –instlib=filename

A.2.45.1 Interactions

Warnings

A.2.46 –llib

A.2.46.1 Interactions

A.2.49 -library=l[,l...]

A.2.49.1 Values

A.2.49.2 Defaults

A.2.49.3 Examples

A.2.49.4 Interactions

A.2.54 -mt[={yes|no}]

A.2.60.1 Interactions

A.2.61 –O

A.2.62 –Olevel

A.2.63 –o filename

A.2.63.1 Interactions

A.2.71 –preserve_argvalues[=simple|none]

A.2.72 –pta

A.2.73 –ptipath

A.2.73.1 Interactions

A.2.73.2 See Also

A.2.74 –pto

A.2.75 –ptv

A.2.76 –Qoption phase option[,option…]

A.2.76.1 Values

A.2.76.2 Examples

A.2.76.3 Warnings

A.2.77 –qoption phase option

A.2.78 –qp

A.2.79 –Qproduce sourcetype

A.2.80 –qproduce sourcetype

A.2.81 –Rpathname[:pathname…]

A.2.81.1 Defaults

A.2.81.2 Interactions

A.2.81.3 See Also

A.2.82 –S

A.2.83 –s

A.2.84 -staticlib=l[,l…]

A.2.84.1 Values

A.2.84.2 Defaults

A.2.84.3 Examples

A.2.84.4 Interactions

A.2.84.5 Warnings

A.2.84.6 See Also

A.2.85 -std=v

A.2.85.1 Interactions:

A.2.85.2 Notes:

A.2.86 -sync_stdio=[yes|no]

A.2.88 –template=opt[,opt…]

A.2.90 -traceback[={%none|common|signals_list}]

A.2.91 –Uname

A.2.91.1 Examples

A.2.91.2 Interactions

A.2.95 –verbose=v[,v…]

A.2.103 -xalias_level[=n]

A.2.103.1 -xalias_level=any

A.2.103.2 -xalias_level=simple

A.2.103.3 -xalias_level=compatible

A.2.103.4 Defaults

A.2.103.5 Interactions

A.2.103.6 Warning

A.2.104 -xanalyze={code|%none}

A.2.105 -xannotate[=yes|no]

A.2.107.1 -xarch Flags for SPARC and x86

A.2.107.2 -xarch Flags for SPARC

A.2.107.3 -xarch Flags for x86

A.2.107.4 Interactions

A.2.107.5 Warnings

A.2.108 -xautopar

A.2.108.1 See Also

A.2.109 -xbinopt={prepare|off}

A.2.109.1 Defaults

Interactions

A.2.110 -xbuiltin[={%all|%default|%none}]

A.2.113 -xcheck[=i[,i]]

A.2.116 -xdebugformat=[stabs|dwarf]

A.2.117 -xdebuginfo=a[,a...]

A.2.118 -xdepend=[yes|no]

A.2.118.1 See Also

A.2.119 -xdumpmacros[=value[,value...]]

A.2.121 xF[=v[,v...]]

A.2.122 -xglobalize[={yes|no}]

A.2.122.1 Interactions

A.2.125.2 Interactions

A.2.125.3 Warnings

A.2.125.4 See Also

A.2.126 -xinline[=func-spec[,func-spec...]]

A.2.126.1 Values

A.2.126.2 Defaults

A.2.126.3 Examples

A.2.126.4 Interactions

A.2.126.5 Warnings

A.2.126.6 See Also

A.2.127 xinline_param=a[,a[,a]...]

A.2.128 xinline_report[=n]

A.2.129 xinstrument=[no%]datarace

A.2.130 -xipo[={0|1|2}]

A.2.130.1 Values

A.2.130.2 Defaults

A.2.130.3 Examples

A.2.130.4 When Not To Use -xipo Interprocedural Analysis

A.2.130.5 Interactions

A.2.130.6 Warnings

A.2.130.7 See Also

A.2.131 -xipo_archive=[a]

A.2.132 -xipo_build=[yes|no]

A.2.132.1 -xipo_build Examples

A.2.133 -xivdep[=p]

A.2.134 -xjobs{=n|auto}

A.2.134.1 -xjobs Examples

A.2.135 -xkeep_unref[={[no%]funcs,[no%]vars}]

A.2.136 -xkeepframe[=[%all,%none,name,no%name]]

A.2.137 -xlang=language[,language]

A.2.137.1 Values

A.2.137.2 Interactions

A.2.137.3 Warnings

A.2.137.4 See Also

A.2.138 -xldscope={v}

A.2.140.1 Interactions

See Also

A.2.141 –xlibmopt

A.2.141.1 Interactions

A.2.141.2 See Also

A.2.142 –xlic_lib=sunperf

A.2.143 –xlicinfo

A.2.144 -xlinkopt[=level]

A.2.144.1 Values

A.2.144.2 Defaults

A.2.144.3 Interactions

A.2.146.2 Interactions

A.2.153 -xmemalign=ab

A.2.155.2 Interactions

A.2.159.2 Interactions

A.2.159.3 Defaults

A.2.159.4 Warnings

A.2.159.5 See Also

A.2.160 -xopenmp[={parallel|noopt|none}]

A.2.160.1 Values

A.2.160.2 Defaults

A.2.160.3 Interactions

A.2.162 -xpagesize_heap=n

A.2.162.1 Values

A.2.162.2 Defaults

A.2.162.3 Warnings

A.2.163 -xpagesize_stack=n

A.2.163.1 Values

A.2.163.2 Defaults

A.2.163.3 Warnings

A.2.164 -xpatchpadding[={fix|patch|size}]

A.2.165 -xpch=v

A.2.165.1 Creating a Precompiled-Header File

Using a Precompiled-Header File

How to Modify Makefiles

A.2.165.2 See Also

A.2.166 -xpchstop=file

A.2.166.1 See Also

A.2.167 -xpec[={yes|no}]

A.2.168 –xpg

A.2.168.1 Warnings

A.2.168.2 See Also

A.2.169 -xport64[=(v)]

A.2.169.1 Values

A.2.169.2 Defaults

A.2.169.3 Examples

Checking for the Truncation of 64-bit Values

Checking for Sign Extension

Checking for Changes to the Packing of Bitfields

A.2.169.4 Warnings

A.2.169.5 See Also

A.2.170 -xprefetch[=a[,a...]]

A.2.170.1 Defaults

A.2.170.2 Interactions

A.2.170.3 Warnings

A.2.171 -xprefetch_auto_type=a

A.2.172 -xprefetch_level[=i]

A.2.172.1 Values

A.2.172.2 Defaults

A.2.172.3 Interactions

A.2.173 -xprevise={yes|no}

A.2.174 –xprofile=p

A.2.175 -xprofile_ircache[=path]

A.2.176 -xprofile_pathmap

A.2.177 -xreduction

A.2.178 –xregs=r[,r...]

A.2.179 -xrestrict[=f]

A.2.179.1 Restricted Pointers

A.2.180 –xs[={yes|no}]

A.2.181 –xsafe=mem

A.2.181.1 Interactions

A.2.181.2 Warnings

A.2.182 -xsegment_align=n

A.2.183 –xspace

A.2.184 –xtarget=t

A.2.184.1 -xtarget Values By Platform

-xtarget Values on SPARC Platforms

-xtarget Values on x86 Platforms

A.2.184.2 Defaults

A.2.184.3 Expansions

A.2.184.4 Examples

A.2.184.5 Interactions

A.2.184.6 Warnings

A.2.185 -xtemp=path

A.2.186 -xthreadvar[=o]

A.2.186.1 Values

A.2.186.2 Defaults

A.2.186.3 Interactions

A.2.186.4 Warnings

A.2.186.5 See Also

A.2.187 -xthroughput[={yes|no}]

A.2.188 –xtime

A.2.189 -xtrigraphs[={yes|no}]

A.2.190 -xunboundsym={yes|no}

A.2.191 –xunroll=n

A.2.191.1 Values

A.2.192 -xustr={ascii_utf16_ushort|no}

A.2.193.2 Interactions

A.2.194 -xvis[={yes|no}]

A.2.197.2 Interactions

B.1.1 Overloaded Functions as Pragma Arguments

B.2 Pragma Reference

B.2.1 #pragma align

B.2.2 #pragma does_not_read_global_data

B.2.3 #pragma does_not_return

B.2.4 #pragma does_not_write_global_data

B.2.5 #pragma dumpmacros

B.2.6 #pragma end_dumpmacros

B.2.7 #pragma error_messages

B.2.8 #pragma fini

B.2.9 #pragma hdrstop

B.2.10 #pragma ident

B.2.11 #pragma init

B.2.12 #pragma ivdep

B.2.13 #pragma must_have_frame

B.2.14 #pragma no_side_effect

B.2.15 #pragma opt

B.2.16 #pragma pack(n)

B.2.17 #pragma rarely_called

B.2.18 #pragma returns_new_memory

B.2.19 #pragma unknown_control_flow

B.2.20 #pragma weak

B.2.20.1 #pragma weak name

#pragma weak name1 = name2

Overloading Functions

Glossary

Index

Index Numbers and Symbols

Language:

11.2.2 Accessing the C++ Library Man Pages

The man pages associated with the libraries described in this section are located in sections 1, 3, and 3CC4.

To access man pages for the C++ libraries, type:

example% man library-name

To access man pages for version 4.2 of the C++ libraries, type:

example% man -s 3CC4 library-name