xref: /netbsd-src/external/gpl3/gcc.old/dist/libstdc++-v3/doc/xml/faq.xml (revision 07ece4eabb6d327c320416d49d51617a7c0fb3be)
1<?xml version='1.0'?>
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
4[ ]>
5
6<book>
7
8<article id="faq" xreflabel="Frequently Asked Questions">
9<?dbhtml filename="faq.html"?>
10
11<articleinfo>
12  <title>Frequently Asked Questions</title>
13  <copyright>
14    <year>
15      2008
16    </year>
17    <holder>
18      <ulink url="http://www.fsf.org">FSF</ulink>
19    </holder>
20  </copyright>
21</articleinfo>
22
23<!-- FAQ starts here -->
24<qandaset>
25
26<!-- General Information -->
27<qandadiv id="faq.info" xreflabel="General Information">
28<title>General Information</title>
29
30<qandaentry id="faq.what">
31  <question id="faq.what.q">
32    <para>
33      What is libstdc++?
34    </para>
35  </question>
36  <answer id="faq.what.a">
37    <para>
38     The GNU Standard C++ Library v3 is an ongoing project to
39     implement the ISO 14882 Standard C++ library as described in
40     chapters 17 through 27 and annex D.  For those who want to see
41     exactly how far the project has come, or just want the latest
42     bleeding-edge code, the up-to-date source is available over
43     anonymous SVN, and can even be browsed over
44     the <ulink url="http://gcc.gnu.org/svn.html">web</ulink>.
45    </para>
46  </answer>
47</qandaentry>
48
49<qandaentry id="faq.why">
50  <question id="q-why">
51    <para>
52      Why should I use libstdc++?
53    </para>
54  </question>
55  <answer id="a-why">
56    <para>
57    The completion of the ISO C++ standardization gave the C++
58    community a powerful set of reuseable tools in the form of the C++
59    Standard Library.  However, all existing C++ implementations are
60    (as the Draft Standard used to say) <quote>incomplet and
61    incorrekt</quote>, and many suffer from limitations of the compilers
62    that use them.
63    </para>
64    <para>
65    The GNU compiler collection
66    (<command>gcc</command>, <command>g++</command>, etc) is widely
67    considered to be one of the leading compilers in the world.  Its
68    development is overseen by the
69    <ulink url="http://gcc.gnu.org/">GCC team</ulink>.  All of
70    the rapid development and near-legendary
71    <ulink url="http://gcc.gnu.org/buildstat.html">portability</ulink>
72    that are the hallmarks of an open-source project are being
73    applied to libstdc++.
74    </para>
75    <para>
76    That means that all of the Standard classes and functions will be
77    freely available and fully compliant. (Such as
78    <classname>string</classname>,
79    <classname>vector&lt;&gt;</classname>, iostreams, and algorithms.)
80    Programmers will no longer need to <quote>roll their own</quote>
81    nor be worried about platform-specific incompatibilities.
82    </para>
83  </answer>
84</qandaentry>
85
86<qandaentry id="faq.who">
87  <question id="q-who">
88    <para>
89      Who's in charge of it?
90    </para>
91  </question>
92  <answer id="a-who">
93    <para>
94     The libstdc++ project is contributed to by several developers
95     all over the world, in the same way as GCC or Linux.
96     Benjamin Kosnik, Gabriel Dos Reis, Phil Edwards, Ulrich Drepper,
97     Loren James Rittle, and Paolo Carlini are the lead maintainers of
98     the SVN archive.
99    </para>
100    <para>
101    Development and discussion is held on the libstdc++ mailing
102    list.  Subscribing to the list, or searching the list
103    archives, is open to everyone.  You can read instructions for
104    doing so on the <ulink url="http://gcc.gnu.org/libstdc++/">homepage</ulink>.
105    If you have questions, ideas, code, or are just curious, sign up!
106    </para>
107  </answer>
108</qandaentry>
109
110<qandaentry id="faq.when">
111  <question id="q-when">
112    <para>
113      When is libstdc++ going to be finished?
114    </para>
115  </question>
116  <answer id="a-when">
117    <para>
118    Nathan Myers gave the best of all possible answers, responding to
119    a Usenet article asking this question: <emphasis>Sooner, if you
120    help.</emphasis>
121    </para>
122  </answer>
123</qandaentry>
124
125<qandaentry id="faq.how">
126  <question id="q-how">
127    <para>
128      How do I contribute to the effort?
129    </para>
130  </question>
131  <answer id="a-how">
132    <para>
133    Here is <link linkend="appendix.contrib">a page devoted to
134    this topic</link>. Subscribing to the mailing list (see above, or
135    the homepage) is a very good idea if you have something to
136    contribute, or if you have spare time and want to
137    help. Contributions don't have to be in the form of source code;
138    anybody who is willing to help write documentation, for example,
139    or has found a bug in code that we all thought was working and is
140    willing to provide details, is more than welcome!
141    </para>
142  </answer>
143</qandaentry>
144
145<qandaentry id="faq.whereis_old">
146  <question id="q-whereis_old">
147    <para>
148      What happened to the older libg++? I need that!
149    </para>
150  </question>
151  <answer id="a-whereis_old">
152    <para>
153    The most recent libg++ README states that libg++ is no longer
154    being actively maintained.  It should not be used for new
155    projects, and is only being kicked along to support older code.
156    </para>
157    <para>
158    More information in the <link linkend="manual.appendix.porting.backwards">backwards compatibility documentation</link>
159    </para>
160  </answer>
161</qandaentry>
162
163<qandaentry id="faq.more_questions">
164  <question id="q-more_questions">
165    <para>
166      What if I have more questions?
167    </para>
168  </question>
169  <answer id="a-more_questions">
170    <para>
171    If you have read the README file, and your question remains
172    unanswered, then just ask the mailing list. At present, you do not
173    need to be subscribed to the list to send a message to it.  More
174    information is available on the homepage (including how to browse
175    the list archives); to send a message to the list,
176    use <email>libstdc++@gcc.gnu.org</email>.
177    </para>
178
179    <para>
180    If you have a question that you think should be included
181    here, or if you have a question <emphasis>about</emphasis> a question/answer
182    here, please send email to the libstdc++ mailing list, as above.
183    </para>
184  </answer>
185</qandaentry>
186
187</qandadiv>
188
189<!-- License -->
190<qandadiv id="faq.license" xreflabel="License QA">
191<title>License</title>
192
193<qandaentry id="faq.license.what">
194  <question id="q-license.what">
195    <para>
196      What are the license terms for libstdc++?
197    </para>
198  </question>
199  <answer id="a-license.what">
200    <para>
201    See <link linkend="manual.intro.status.license">our license description</link>
202    for these and related questions.
203    </para>
204  </answer>
205</qandaentry>
206
207<qandaentry id="faq.license.any_program">
208  <question id="q-license.any_program">
209    <para>
210      So any program which uses libstdc++ falls under the GPL?
211    </para>
212  </question>
213  <answer id="a-license.any_program">
214    <para>
215     No. The special exception permits use of the library in
216     proprietary applications.
217    </para>
218  </answer>
219</qandaentry>
220
221
222<qandaentry id="faq.license.lgpl">
223  <question id="q-license.lgpl">
224    <para>
225      How is that different from the GNU {Lesser,Library} GPL?
226    </para>
227  </question>
228  <answer id="a-license.lgpl">
229    <para>
230      The LGPL requires that users be able to replace the LGPL code with a
231     modified version; this is trivial if the library in question is a C
232     shared library.  But there's no way to make that work with C++, where
233     much of the library consists of inline functions and templates, which
234     are expanded inside the code that uses the library.  So to allow people
235     to replace the library code, someone using the library would have to
236     distribute their own source, rendering the LGPL equivalent to the GPL.
237    </para>
238  </answer>
239</qandaentry>
240
241<qandaentry id="faq.license.what_restrictions">
242  <question id="q-license.what_restrictions">
243    <para>
244      I see. So, what restrictions are there on programs that use the library?
245    </para>
246  </question>
247  <answer id="a-license.what_restrictions">
248    <para>
249      None.  We encourage such programs to be released as open source,
250     but we won't punish you or sue you if you choose otherwise.
251    </para>
252  </answer>
253</qandaentry>
254
255</qandadiv>
256
257<!-- Installation -->
258<qandadiv id="faq.installation" xreflabel="Installation">
259<title>Installation</title>
260
261<qandaentry id="faq.how_to_install">
262  <question id="q-how_to_install">
263    <para>How do I install libstdc++?
264    </para>
265  </question>
266  <answer id="a-how_to_install">
267    <para>
268    Often libstdc++ comes pre-installed as an integral part of many
269    existing Linux and Unix systems, as well as many embedded
270    development tools. It may be necessary to install extra
271    development packages to get the headers, or the documentation, or
272    the source: please consult your vendor for details.
273    </para>
274    <para>
275    To build and install from the GNU GCC sources, please consult the
276    <link linkend="manual.intro.setup">setup
277    documentation</link> for detailed
278    instructions. You may wish to browse those files ahead
279    of time to get a feel for what's required.
280    </para>
281  </answer>
282</qandaentry>
283
284<qandaentry id="faq.how_to_get_sources">
285  <question id="q-how_to_get_sources">
286    <para>How does one get current libstdc++ sources?
287    </para>
288  </question>
289  <answer id="a-how_to_get_sources">
290    <para>
291    Libstdc++ sources for all official releases can be obtained as
292    part of the GCC sources, available from various sites and
293    mirrors. A full <ulink url="http://gcc.gnu.org/mirrors.html">list of
294    download sites</ulink> is provided on the main GCC site.
295    </para>
296    <para>
297    Current libstdc++ sources can always be checked out of the main
298    GCC source repository using the appropriate version control
299    tool. At this time, that tool
300    is <application>Subversion</application>.
301    </para>
302    <para>
303    <application>Subversion</application>, or <acronym>SVN</acronym>, is
304    one of several revision control packages.  It was selected for GNU
305    projects because it's free (speech), free (beer), and very high
306    quality.  The <ulink url="http://subversion.tigris.org"> Subversion
307    home page</ulink> has a better description.
308    </para>
309    <para>
310    The <quote>anonymous client checkout</quote> feature of SVN is
311    similar to anonymous FTP in that it allows anyone to retrieve
312    the latest libstdc++ sources.
313    </para>
314    <para>
315    For more information
316    see <ulink url="http://gcc.gnu.org/svn.html"><acronym>SVN</acronym>
317    details</ulink>.
318    </para>
319  </answer>
320</qandaentry>
321
322<qandaentry id="faq.how_to_test">
323  <question id="q-how_to_test">
324    <para>How do I know if it works?
325    </para>
326  </question>
327  <answer id="a-how_to_test">
328    <para>
329    Libstdc++ comes with its own validation testsuite, which includes
330    conformance testing, regression testing, ABI testing, and
331    performance testing. Please consult the
332    <ulink url="http://gcc.gnu.org/install/test.html">testing
333    documentation</ulink> for more details.
334    </para>
335    <para>
336    If you find bugs in the testsuite programs themselves, or if you
337    think of a new test program that should be added to the suite,
338    <emphasis>please</emphasis> write up your idea and send it to the list!
339    </para>
340  </answer>
341</qandaentry>
342
343<qandaentry id="faq.how_to_set_paths">
344  <question id="q-how_to_set_paths">
345    <para>How do I insure that the dynamically linked library will be found?
346    </para>
347  </question>
348  <answer id="a-how_to_set_paths">
349    <para>
350    Depending on your platform and library version, the error message might
351    be similar to one of the following:
352    </para>
353
354    <screen>
355    ./a.out: error while loading shared libraries: libstdc++.so.6: cannot open shared object file: No such file or directory
356
357    /usr/libexec/ld-elf.so.1: Shared object "libstdc++.so.6" not found
358    </screen>
359
360    <para>
361    This doesn't mean that the shared library isn't installed, only
362    that the dynamic linker can't find it. When a dynamically-linked
363    executable is run the linker finds and loads the required shared
364    libraries by searching a pre-configured list of directories. If
365    the directory where you've installed libstdc++ is not in this list
366    then the libraries won't be found. The simplest way to fix this is
367    to use the <literal>LD_LIBRARY_PATH</literal> environment variable,
368    which is a colon-separated list of directories in which the linker
369    will search for shared libraries:
370    </para>
371
372    <screen>
373    LD_LIBRARY_PATH=${prefix}/lib:$LD_LIBRARY_PATH
374    export LD_LIBRARY_PATH
375    </screen>
376
377    <para>
378    The exact environment variable to use will depend on your
379    platform, e.g. DYLD_LIBRARY_PATH for Darwin,
380    LD_LIBRARY_PATH_32/LD_LIBRARY_PATH_64 for Solaris 32-/64-bit,
381    LD_LIBRARYN32_PATH/LD_LIBRARY64_PATH for Irix N32/64-bit ABIs and
382    SHLIB_PATH for HP-UX.
383    </para>
384    <para>
385    See the man pages for <command>ld</command>, <command>ldd</command>
386    and <command>ldconfig</command> for more information. The dynamic
387    linker has different names on different platforms but the man page
388    is usually called something such as <filename>ld.so/rtld/dld.so</filename>.
389    </para>
390  </answer>
391</qandaentry>
392
393<qandaentry id="faq.what_is_libsupcxx">
394  <question id="q-what_is_libsupcxx">
395    <para>
396      What's libsupc++?
397    </para>
398  </question>
399  <answer id="a-what_is_libsupcxx">
400    <para>
401      If the only functions from <filename>libstdc++.a</filename>
402      which you need are language support functions (those listed in
403      <link linkend="std.support">clause 18</link> of the
404      standard, e.g., <function>new</function> and
405      <function>delete</function>), then try linking against
406      <filename>libsupc++.a</filename>, which is a subset of
407      <filename>libstdc++.a</filename>.  (Using <command>gcc</command>
408      instead of <command>g++</command> and explicitly linking in
409      <filename>libsupc++.a</filename> via <literal>-lsupc++</literal>
410      for the final link step will do it).  This library contains only
411      those support routines, one per object file.  But if you are
412      using anything from the rest of the library, such as IOStreams
413      or vectors, then you'll still need pieces from
414      <filename>libstdc++.a</filename>.
415    </para>
416  </answer>
417</qandaentry>
418
419<qandaentry id="faq.size">
420  <question id="q-size">
421    <para>
422      This library is HUGE!
423    </para>
424  </question>
425  <answer id="a-size">
426    <para>
427    Usually the size of libraries on disk isn't noticeable.  When a
428    link editor (or simply <quote>linker</quote>) pulls things from a
429    static archive library, only the necessary object files are copied
430    into your executable, not the entire library.  Unfortunately, even
431    if you only need a single function or variable from an object file,
432    the entire object file is extracted.  (There's nothing unique to C++
433    or libstdc++ about this; it's just common behavior, given here
434    for background reasons.)
435    </para>
436    <para>
437    Some of the object files which make up libstdc++.a are rather large.
438    If you create a statically-linked executable with
439    <literal>-static</literal>, those large object files are suddenly part
440    of your executable.  Historically the best way around this was to
441    only place a very few functions (often only a single one) in each
442    source/object file; then extracting a single function is the same
443    as extracting a single .o file.  For libstdc++ this is only
444    possible to a certain extent; the object files in question contain
445    template classes and template functions, pre-instantiated, and
446    splitting those up causes severe maintenance headaches.
447    </para>
448    <para>
449    On supported platforms, libstdc++ takes advantage of garbage
450    collection in the GNU linker to get a result similar to separating
451    each symbol into a separate source and object files. On these platforms,
452    GNU ld can place each function and variable into its own
453    section in a .o file.  The GNU linker can then perform garbage
454    collection on unused sections; this reduces the situation to only
455    copying needed functions into the executable, as before, but all
456    happens automatically.
457    </para>
458  </answer>
459</qandaentry>
460
461</qandadiv>
462
463
464<!-- Platform-Specific Issues -->
465<qandadiv id="faq.platform-specific" xreflabel="Platform-Specific Issues">
466<title>Platform-Specific Issues</title>
467
468<qandaentry id="faq.other_compilers">
469  <question id="q-other_compilers">
470    <para>
471      Can libstdc++ be used with non-GNU compilers?
472    </para>
473  </question>
474  <answer id="a-other_compilers">
475    <para>
476    Perhaps.
477    </para>
478    <para>
479    Since the goal of ISO Standardization is for all C++
480    implementations to be able to share code, libstdc++ should be
481    usable under any ISO-compliant compiler, at least in theory.
482    </para>
483    <para>
484    However, the reality is that libstdc++ is targeted and optimized
485    for GCC/g++. This means that often libstdc++ uses specific,
486    non-standard features of g++ that are not present in older
487    versions of proprietary compilers. It may take as much as a year or two
488    after an official release of GCC that contains these features for
489    proprietary tools support these constructs.
490    </para>
491    <para>
492    In the near past, specific released versions of libstdc++ have
493    been known to work with versions of the EDG C++ compiler, and
494    vendor-specific proprietary C++ compilers such as the Intel ICC
495    C++ compiler.
496    </para>
497
498  </answer>
499</qandaentry>
500
501<qandaentry id="faq.solaris_long_long">
502  <question id="q-solaris_long_long">
503    <para>
504      No 'long long' type on Solaris?
505    </para>
506  </question>
507  <answer id="a-solaris_long_long">
508    <para>
509    By default we try to support the C99 <type>long long</type> type.
510    This requires that certain functions from your C library be present.
511    </para>
512    <para>
513    Up through release 3.0.2 the platform-specific tests performed by
514    libstdc++ were too general, resulting in a conservative approach
515    to enabling the <type>long long</type> code paths. The most
516    commonly reported platform affected was Solaris.
517    </para>
518    <para>
519    This has been fixed for libstdc++ releases greater than 3.0.3.
520    </para>
521  </answer>
522</qandaentry>
523
524<qandaentry id="faq.predefined">
525  <question id="q-predefined">
526    <para>
527      <constant>_XOPEN_SOURCE</constant> and <constant>_GNU_SOURCE</constant> are always defined?
528    </para>
529  </question>
530  <answer id="a-predefined">
531      <para>On Solaris, g++ (but not gcc) always defines the preprocessor
532         macro <constant>_XOPEN_SOURCE</constant>.  On GNU/Linux, the same happens
533         with <constant>_GNU_SOURCE</constant>.  (This is not an exhaustive list;
534         other macros and other platforms are also affected.)
535      </para>
536      <para>These macros are typically used in C library headers, guarding new
537         versions of functions from their older versions.  The C++ standard
538         library includes the C standard library, but it requires the C90
539         version, which for backwards-compatibility reasons is often not the
540         default for many vendors.
541      </para>
542      <para>More to the point, the C++ standard requires behavior which is only
543         available on certain platforms after certain symbols are defined.
544         Usually the issue involves I/O-related typedefs.  In order to
545         ensure correctness, the compiler simply predefines those symbols.
546      </para>
547      <para>Note that it's not enough to #define them only when the library is
548         being built (during installation).  Since we don't have an 'export'
549         keyword, much of the library exists as headers, which means that
550         the symbols must also be defined as your programs are parsed and
551         compiled.
552      </para>
553      <para>To see which symbols are defined, look for CPLUSPLUS_CPP_SPEC in
554         the gcc config headers for your target (and try changing them to
555         see what happens when building complicated code).  You can also run
556         <command>g++ -E -dM - &lt; /dev/null&quot;</command> to display
557         a list of predefined macros for any particular installation.
558      </para>
559      <para>This has been discussed on the mailing lists
560         <ulink url="http://gcc.gnu.org/cgi-bin/htsearch?method=and&amp;format=builtin-long&amp;sort=score&amp;words=_XOPEN_SOURCE+Solaris">quite a bit</ulink>.
561      </para>
562      <para>This method is something of a wart.  We'd like to find a cleaner
563         solution, but nobody yet has contributed the time.
564      </para>
565
566  </answer>
567</qandaentry>
568
569<qandaentry id="faq.darwin_ctype">
570  <question id="q-darwin_ctype">
571    <para>
572      Mac OS X <filename class="headerfile">ctype.h</filename> is broken! How can I fix it?
573    </para>
574  </question>
575  <answer id="a-darwin_ctype">
576      <para>This is a long-standing bug in the OS X support.  Fortunately,
577         the patch is quite simple, and well-known.
578         <ulink url="http://gcc.gnu.org/ml/gcc/2002-03/msg00817.html"> Here's a
579         link to the solution</ulink>.
580      </para>
581
582  </answer>
583</qandaentry>
584
585<qandaentry id="faq.threads_i386">
586  <question id="q-threads_i386">
587    <para>
588      Threading is broken on i386?
589    </para>
590  </question>
591  <answer id="a-threads_i386">
592    <para>
593    </para>
594      <para>Support for atomic integer operations is/was broken on i386
595         platforms.  The assembly code accidentally used opcodes that are
596         only available on the i486 and later.  So if you configured GCC
597         to target, for example, i386-linux, but actually used the programs
598         on an i686, then you would encounter no problems.  Only when
599         actually running the code on a i386 will the problem appear.
600      </para>
601      <para>This is fixed in 3.2.2.
602      </para>
603
604  </answer>
605</qandaentry>
606
607<qandaentry id="faq.atomic_mips">
608  <question id="q-atomic_mips">
609    <para>
610      MIPS atomic operations
611    </para>
612  </question>
613  <answer id="a-atomic_mips">
614    <para>
615    The atomic locking routines for MIPS targets requires MIPS II
616    and later.  A patch went in just after the 3.3 release to
617    make mips* use the generic implementation instead.  You can also
618    configure for mipsel-elf as a workaround.
619    </para>
620    <para>
621    The mips*-*-linux* port continues to use the MIPS II routines, and more
622    work in this area is expected.
623    </para>
624  </answer>
625</qandaentry>
626
627<qandaentry id="faq.linux_glibc">
628  <question id="q-linux_glibc">
629    <para>
630      Recent GNU/Linux glibc required?
631    </para>
632  </question>
633  <answer id="a-linux_glibc">
634      <para>When running on GNU/Linux, libstdc++ 3.2.1 (shared library version
635         5.0.1) and later uses localization and formatting code from the system
636         C library (glibc) version 2.2.5.  That version of glibc is over a
637         year old and contains necessary bugfixes.  Many GNU/Linux distros make
638         glibc version 2.3.x available now.
639      </para>
640      <para>The guideline is simple:  the more recent the C++ library, the
641         more recent the C library.  (This is also documented in the main
642         GCC installation instructions.)
643      </para>
644
645  </answer>
646</qandaentry>
647
648<qandaentry id="faq.freebsd_wchar">
649  <question id="q-freebsd_wchar">
650    <para>
651      Can't use wchar_t/wstring on FreeBSD
652    </para>
653  </question>
654  <answer id="a-freebsd_wchar">
655    <para>
656    Older versions of FreeBSD's C library do not have sufficient
657    support for wide character functions, and as a result the
658    libstdc++ configury decides that wchar_t support should be
659    disabled. In addition, the libstdc++ platform checks that
660    enabled <type>wchar_t</type> were quite strict, and not granular
661    enough to detect when the minimal support to
662    enable <type>wchar_t</type> and C++ library structures
663    like <classname>wstring</classname> were present. This impacted Solaris,
664    Darwin, and BSD variants, and is fixed in libstdc++ versions post 4.1.0.
665    </para>
666    <para>
667    </para>
668  </answer>
669</qandaentry>
670
671</qandadiv>
672
673
674<!-- Known Bugs -->
675<qandadiv id="faq.known_bugs" xreflabel="Known Bugs">
676<title>Known Bugs</title>
677
678<qandaentry id="faq.what_works">
679  <question id="q-what_works">
680    <para>
681      What works already?
682    </para>
683  </question>
684  <answer id="a-what_works">
685    <para>
686    Short answer: Pretty much everything <emphasis>works</emphasis>
687    except for some corner cases.  Support for localization
688    in <classname>locale</classname> may be incomplete on non-GNU
689    platforms. Also dependant on the underlying platform is support
690    for <type>wchar_t</type> and <type>long
691    long</type> specializations, and details of thread support.
692    </para>
693    <para>
694    Long answer: See the implementation status pages for
695    <link linkend="status.iso.1998">C++98</link>,
696    <link linkend="status.iso.tr1">TR1</link>, and
697    <link linkend="status.iso.200x">C++0x</link>.
698    </para>
699  </answer>
700</qandaentry>
701
702<qandaentry id="faq.standard_bugs">
703  <question id="q-standard_bugs">
704    <para>
705      Bugs in the ISO C++ language or library specification
706    </para>
707  </question>
708  <answer id="a-standard_bugs">
709    <para>
710    Unfortunately, there are some.
711    </para>
712    <para>
713    For those people who are not part of the ISO Library Group
714    (i.e., nearly all of us needing to read this page in the first
715    place), a public list of the library defects is occasionally
716    published <ulink url="http://anubis.dkuug.dk/jtc1/sc22/wg21/">here</ulink>.
717    Some of these issues have resulted in code changes in libstdc++.
718    </para>
719    <para>
720    If you think you've discovered a new bug that is not listed,
721    please post a message describing your problem
722    to <email>libstdc++@gcc.gnu.org</email> or the Usenet group
723    comp.lang.c++.moderated.
724    </para>
725  </answer>
726</qandaentry>
727
728<qandaentry id="faq.compiler_bugs">
729  <question id="q-compiler_bugs">
730    <para>
731      Bugs in the compiler (gcc/g++) and not libstdc++
732    </para>
733  </question>
734  <answer id="a-compiler_bugs">
735    <para>
736    On occasion, the compiler is wrong. Please be advised that this
737    happens much less often than one would think, and avoid jumping to
738    conclusions.
739    </para>
740    <para>
741    First, examine the ISO C++ standard. Second, try another compiler
742    or an older version of the GNU compilers. Third, you can find more
743    information on the libstdc++ and the GCC mailing lists: search
744    these lists with terms describing your issue.
745    </para>
746    <para>
747    Before reporting a bug, please examine the
748    <ulink url="http://gcc.gnu.org/bugs/">bugs database</ulink> with the
749    category set to <quote>g++</quote>.
750    </para>
751  </answer>
752</qandaentry>
753
754</qandadiv>
755
756<!-- Known Non-Bugs -->
757<qandadiv id="faq.known_non-bugs" xreflabel="Known Non-Bugs">
758<title>Known Non-Bugs</title>
759
760<qandaentry id="faq.stream_reopening_fails">
761  <question id="q-stream_reopening_fails">
762    <para>
763      Reopening a stream fails
764    </para>
765  </question>
766  <answer id="a-stream_reopening_fails">
767    <para>
768    One of the most-reported non-bug reports. Executing a sequence like:
769    </para>
770
771    <literallayout>
772    #include &lt;fstream&gt;
773    ...
774    std::fstream  fs(<quote>a_file</quote>);
775    // .
776    // . do things with fs...
777    // .
778    fs.close();
779    fs.open(<quote>a_new_file</quote>);
780    </literallayout>
781
782    <para>
783    All operations on the re-opened <varname>fs</varname> will fail, or at
784    least act very strangely.  Yes, they often will, especially if
785    <varname>fs</varname> reached the EOF state on the previous file.  The
786    reason is that the state flags are <emphasis>not</emphasis> cleared
787    on a successful call to open().  The standard unfortunately did
788    not specify behavior in this case, and to everybody's great sorrow,
789    the <link linkend="manual.intro.status.bugs">proposed LWG resolution in
790      DR #22</link> is to leave the flags unchanged.  You must insert a call
791    to <function>fs.clear()</function> between the calls to close() and open(),
792    and then everything will work like we all expect it to work.
793    <emphasis>Update:</emphasis> for GCC 4.0 we implemented the resolution
794    of <link linkend="manual.intro.status.bugs">DR #409</link> and open()
795    now calls <function>clear()</function> on success!
796    </para>
797  </answer>
798</qandaentry>
799
800<qandaentry id="faq.wefcxx_verbose">
801  <question id="q-wefcxx_verbose">
802    <para>
803      -Weffc++ complains too much
804    </para>
805  </question>
806  <answer id="a-wefcxx_verbose">
807    <para>
808    Many warnings are emitted when <literal>-Weffc++</literal> is used.  Making
809    libstdc++ <literal>-Weffc++</literal>-clean is not a goal of the project,
810    for a few reasons.  Mainly, that option tries to enforce
811    object-oriented programming, while the Standard Library isn't
812    necessarily trying to be OO.
813    </para>
814    <para>
815    We do, however, try to have libstdc++ sources as clean as possible. If
816    you see some simple changes that pacify <literal>-Weffc++</literal>
817    without other drawbacks, send us a patch.
818    </para>
819  </answer>
820</qandaentry>
821
822<qandaentry id="faq.ambiguous_overloads">
823  <question id="q-ambiguous_overloads">
824    <para>
825      Ambiguous overloads after including an old-style header
826    </para>
827  </question>
828  <answer id="a-ambiguous_overloads">
829    <para>
830    Another problem is the <literal>rel_ops</literal> namespace and the template
831    comparison operator functions contained therein.  If they become
832    visible in the same namespace as other comparison functions
833    (e.g., <quote>using</quote> them and the &lt;iterator&gt; header),
834    then you will suddenly be faced with huge numbers of ambiguity
835    errors.  This was discussed on the -v3 list; Nathan Myers
836    <ulink url="http://gcc.gnu.org/ml/libstdc++/2001-01/msg00247.html">sums
837      things up here</ulink>.  The collisions with vector/string iterator
838    types have been fixed for 3.1.
839    </para>
840  </answer>
841</qandaentry>
842
843<qandaentry id="faq.v2_headers">
844  <question id="q-v2_headers">
845    <para>
846      The g++-3 headers are <emphasis>not ours</emphasis>
847    </para>
848  </question>
849  <answer id="a-v2_headers">
850      <para>
851	If you are using headers in
852	<filename>${prefix}/include/g++-3</filename>, or if the installed
853	library's name looks like <filename>libstdc++-2.10.a</filename> or
854	<filename>libstdc++-libc6-2.10.so</filename>, then you are using the
855	old libstdc++-v2 library, which is nonstandard and
856	unmaintained.  Do not report problems with -v2 to the -v3
857	mailing list.
858      </para>
859      <para>
860	For GCC versions 3.0 and 3.1 the libstdc++ header files are
861	installed in <filename>${prefix}/include/g++-v3</filename> (see the
862	'v'?).  Starting with version 3.2 the headers are installed in
863	<filename>${prefix}/include/c++/${version}</filename> as this prevents
864	headers from previous versions being found by mistake.
865      </para>
866
867  </answer>
868</qandaentry>
869
870<qandaentry id="faq.boost_concept_checks">
871  <question id="q-boost_concept_checks">
872    <para>
873      Errors about <emphasis>*Concept</emphasis> and
874      <emphasis>constraints</emphasis> in the STL
875    </para>
876  </question>
877  <answer id="a-boost_concept_checks">
878    <para>
879    If you see compilation errors containing messages about
880    <errortext>foo Concept </errortext>and something to do with a
881    <errortext>constraints</errortext> member function, then most
882    likely you have violated one of the requirements for types used
883    during instantiation of template containers and functions.  For
884    example, EqualityComparableConcept appears if your types must be
885    comparable with == and you have not provided this capability (a
886    typo, or wrong visibility, or you just plain forgot, etc).
887    </para>
888    <para>
889    More information, including how to optionally enable/disable the
890    checks, is available
891    <link linkend="std.diagnostics.concept_checking">here</link>.
892    </para>
893  </answer>
894</qandaentry>
895
896<qandaentry id="faq.dlopen_crash">
897  <question id="q-dlopen_crash">
898    <para>
899      Program crashes when using library code in a
900      dynamically-loaded library
901    </para>
902  </question>
903  <answer id="a-dlopen_crash">
904    <para>
905    If you are using the C++ library across dynamically-loaded
906    objects, make certain that you are passing the correct options
907    when compiling and linking:
908    </para>
909
910    <literallayout>
911    // compile your library components
912    g++ -fPIC -c a.cc
913    g++ -fPIC -c b.cc
914    ...
915    g++ -fPIC -c z.cc
916
917    // create your library
918    g++ -fPIC -shared -rdynamic -o libfoo.so a.o b.o ... z.o
919
920    // link the executable
921    g++ -fPIC -rdynamic -o foo ... -L. -lfoo -ldl
922    </literallayout>
923  </answer>
924</qandaentry>
925
926<qandaentry id="faq.memory_leaks">
927  <question id="q-memory_leaks">
928    <para>
929      <quote>Memory leaks</quote> in containers
930    </para>
931  </question>
932  <answer id="a-memory_leaks">
933    <para>
934    A few people have reported that the standard containers appear
935    to leak memory when tested with memory checkers such as
936    <ulink url="http://valgrind.org/">valgrind</ulink>.
937    The library's default allocators keep free memory in a pool
938    for later reuse, rather than returning it to the OS.  Although
939    this memory is always reachable by the library and is never
940    lost, memory debugging tools can report it as a leak.  If you
941    want to test the library for memory leaks please read
942    <link linkend="debug.memory">Tips for memory leak hunting</link>
943    first.
944    </para>
945  </answer>
946</qandaentry>
947
948<qandaentry id="faq.list_size_on">
949  <question id="q-list_size_on">
950    <para>
951      list::size() is O(n)!
952    </para>
953  </question>
954  <answer id="a-list_size_on">
955    <para>
956    See
957    the <link linkend="std.containers">Containers</link>
958    chapter.
959    </para>
960  </answer>
961</qandaentry>
962
963<qandaentry id="faq.easy_to_fix">
964  <question id="q-easy_to_fix">
965    <para>
966      Aw, that's easy to fix!
967    </para>
968  </question>
969  <answer id="a-easy_to_fix">
970    <para>
971    If you have found a bug in the library and you think you have
972    a working fix, then send it in!  The main GCC site has a page
973    on <ulink url="http://gcc.gnu.org/contribute.html">submitting
974    patches</ulink> that covers the procedure, but for libstdc++ you
975    should also send the patch to our mailing list in addition to
976    the GCC patches mailing list.  The libstdc++
977    <link linkend="appendix.contrib">contributors' page</link>
978    also talks about how to submit patches.
979    </para>
980    <para>
981    In addition to the description, the patch, and the ChangeLog
982    entry, it is a Good Thing if you can additionally create a small
983    test program to test for the presence of the bug that your
984    patch fixes.  Bugs have a way of being reintroduced; if an old
985    bug creeps back in, it will be caught immediately by the
986    <ulink url="#2_4">testsuite</ulink> -- but only if such a test exists.
987    </para>
988  </answer>
989</qandaentry>
990
991</qandadiv>
992
993
994<!-- Miscellaneous -->
995<qandadiv id="faq.misc" xreflabel="Miscellaneous">
996<title>Miscellaneous</title>
997
998<qandaentry id="faq.iterator_as_pod">
999  <question id="faq.iterator_as_pod_q">
1000    <para>
1001      string::iterator is not char*; vector&lt;T&gt;::iterator is not T*
1002    </para>
1003  </question>
1004  <answer id="faq.iterator_as_pod_a">
1005    <para>
1006    If you have code that depends on container&lt;T&gt; iterators
1007    being implemented as pointer-to-T, your code is broken. It's
1008    considered a feature, not a bug, that libstdc++ points this out.
1009    </para>
1010    <para>
1011    While there are arguments for iterators to be implemented in
1012    that manner, A) they aren't very good ones in the long term,
1013    and B) they were never guaranteed by the Standard anyway.  The
1014    type-safety achieved by making iterators a real class rather
1015    than a typedef for <type>T*</type> outweighs nearly all opposing
1016    arguments.
1017    </para>
1018    <para>
1019    Code which does assume that a vector iterator <varname>i</varname>
1020    is a pointer can often be fixed by changing <varname>i</varname> in
1021    certain expressions to <varname>&amp;*i</varname>.  Future revisions
1022    of the Standard are expected to bless this usage for
1023    vector&lt;&gt; (but not for basic_string&lt;&gt;).
1024    </para>
1025  </answer>
1026</qandaentry>
1027
1028<qandaentry id="faq.what_is_next">
1029  <question id="q-what_is_next">
1030    <para>
1031      What's next after libstdc++?
1032    </para>
1033  </question>
1034  <answer id="a-what_is_next">
1035      <para>
1036	Hopefully, not much.  The goal of libstdc++ is to produce a
1037	fully-compliant, fully-portable Standard Library.  After that,
1038	we're mostly done: there won't <emphasis>be</emphasis> any
1039	more compliance work to do.
1040      </para>
1041      <para>
1042	There is an effort underway to add significant extensions to
1043	the standard library specification.  The latest version of
1044	this effort is described in
1045         <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1836.pdf">
1046         The C++ Library Technical Report 1</ulink>.
1047      </para>
1048  </answer>
1049</qandaentry>
1050
1051<qandaentry id="faq.sgi_stl">
1052  <question id="q-sgi_stl">
1053    <para>
1054      What about the STL from SGI?
1055    </para>
1056  </question>
1057  <answer id="a-sgi_stl">
1058    <para>
1059      The <ulink url="http://www.sgi.com/tech/stl/">STL from SGI</ulink>,
1060    version 3.3, was the final merge of the STL codebase.  The
1061    code in libstdc++ contains many fixes and changes, and
1062    the SGI code is no longer under active
1063    development.  We expect that no future merges will take place.
1064    </para>
1065    <para>
1066    In particular, <classname>string</classname> is not from SGI and makes no
1067    use of their &quot;rope&quot; class (which is included as an
1068    optional extension), nor is <classname>valarray</classname> and some others.
1069    Classes like <classname>vector&lt;&gt;</classname> are, but have been
1070    extensively modified.
1071    </para>
1072    <para>
1073    More information on the evolution of libstdc++ can be found at the
1074    <link linkend="appendix.porting.api">API
1075    evolution</link>
1076    and <link linkend="manual.appendix.porting.backwards">backwards
1077    compatibility</link> documentation.
1078    </para>
1079    <para>
1080    The FAQ for SGI's STL (one jump off of their main page) is
1081    still recommended reading.
1082    </para>
1083  </answer>
1084</qandaentry>
1085
1086<qandaentry id="faq.extensions_and_backwards_compat">
1087  <question id="q-extensions_and_backwards_compat">
1088    <para>
1089      Extensions and Backward Compatibility
1090    </para>
1091  </question>
1092  <answer id="a-extensions_and_backwards_compat">
1093    <para>
1094      See the <link linkend="manual.appendix.porting.backwards">link</link> on backwards compatibility and <link linkend="appendix.porting.api">link</link> on evolution.
1095    </para>
1096  </answer>
1097</qandaentry>
1098
1099<qandaentry id="faq.tr1_support">
1100  <question id="q-tr1_support">
1101    <para>
1102      Does libstdc++ support TR1?
1103    </para>
1104  </question>
1105  <answer id="a-tr1_support">
1106    <para>
1107    Yes.
1108    </para>
1109    <para>
1110    The C++ Standard Library Technical Report adds many new features to
1111    the library.  The latest version of this effort is described in
1112    <ulink url=
1113	 "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1836.pdf">
1114         Technical Report 1</ulink>.
1115    </para>
1116    <para>
1117    The implementation status of TR1 in libstdc++ can be tracked <link
1118    linkend="status.iso.tr1">on the TR1 status
1119    page</link>.
1120    </para>
1121  </answer>
1122</qandaentry>
1123
1124<qandaentry id="faq.get_iso_cxx">
1125  <question id="q-get_iso_cxx">
1126    <para>How do I get a copy of the ISO C++ Standard?
1127    </para>
1128  </question>
1129  <answer id="a-get_iso_cxx">
1130    <para>
1131    Copies of the full ISO 14882 standard are available on line via
1132    the ISO mirror site for committee members.  Non-members, or those
1133    who have not paid for the privilege of sitting on the committee
1134    and sustained their two-meeting commitment for voting rights, may
1135    get a copy of the standard from their respective national
1136    standards organization.  In the USA, this national standards
1137    organization is ANSI and their website is
1138    right <ulink url="http://www.ansi.org">here</ulink>.  (And if
1139    you've already registered with them, clicking this link will take
1140    you to directly to the place where you can
1141    <ulink url="http://webstore.ansi.org/RecordDetail.aspx?sku=ISO%2FIEC+14882:2003">buy the standard on-line</ulink>.
1142    </para>
1143    <para>
1144    Who is your country's member body?  Visit the
1145    <ulink url="http://www.iso.ch/">ISO homepage</ulink> and find out!
1146    </para>
1147    <para>
1148    The 2003 version of the standard (the 1998 version plus TC1) is
1149    available in print, ISBN 0-470-84674-7.
1150    </para>
1151  </answer>
1152</qandaentry>
1153
1154<qandaentry id="faq.what_is_abi">
1155  <question id="q-what_is_abi">
1156    <para>
1157      What's an ABI and why is it so messy?
1158    </para>
1159  </question>
1160  <answer id="a-what_is_abi">
1161    <para>
1162    <acronym>ABI</acronym> stands for <quote>Application Binary
1163     Interface</quote>.  Conventionally, it refers to a great
1164    mass of details about how arguments are arranged on the call
1165    stack and/or in registers, and how various types are arranged
1166    and padded in structs.  A single CPU design may suffer
1167    multiple ABIs designed by different development tool vendors
1168    who made different choices, or even by the same vendor for
1169    different target applications or compiler versions.  In ideal
1170    circumstances the CPU designer presents one ABI and all the
1171    OSes and compilers use it.  In practice every ABI omits
1172    details that compiler implementers (consciously or
1173    accidentally) must choose for themselves.
1174    </para>
1175    <para>
1176    That ABI definition suffices for compilers to generate code so a
1177    program can interact safely with an OS and its lowest-level libraries.
1178    Users usually want an ABI to encompass more detail, allowing libraries
1179    built with different compilers (or different releases of the same
1180    compiler!) to be linked together.  For C++, this includes many more
1181    details than for C, and CPU designers (for good reasons elaborated
1182    below) have not stepped up to publish C++ ABIs.  The details include
1183    virtual function implementation, struct inheritance layout, name
1184    mangling, and exception handling.  Such an ABI has been defined for
1185    GNU C++, and is immediately useful for embedded work relying only on
1186    a <quote>free-standing implementation</quote> that doesn't include (much
1187    of) the standard library.  It is a good basis for the work to come.
1188    </para>
1189    <para>
1190    A useful C++ ABI must also incorporate many details of the standard
1191    library implementation.  For a C ABI, the layouts of a few structs
1192    (such as FILE, stat, jmpbuf, and the like) and a few macros suffice.
1193    For C++, the details include the complete set of names of functions
1194    and types used, the offsets of class members and virtual functions,
1195    and the actual definitions of all inlines.  C++ exposes many more
1196    library details to the caller than C does.  It makes defining
1197    a complete ABI a much bigger undertaking, and requires not just
1198    documenting library implementation details, but carefully designing
1199    those details so that future bug fixes and optimizations don't
1200    force breaking the ABI.
1201    </para>
1202    <para>
1203    There are ways to help isolate library implementation details from the
1204    ABI, but they trade off against speed.  Library details used in
1205    inner loops (e.g., getchar) must be exposed and frozen for all
1206    time, but many others may reasonably be kept hidden from user code,
1207    so they may later be changed.  Deciding which, and implementing
1208    the decisions, must happen before you can reasonably document a
1209    candidate C++ ABI that encompasses the standard library.
1210    </para>
1211  </answer>
1212</qandaentry>
1213
1214<qandaentry id="faq.size_equals_capacity">
1215  <question id="q-size_equals_capacity">
1216    <para>
1217      How do I make std::vector&lt;T&gt;::capacity() == std::vector&lt;T&gt;::size?
1218    </para>
1219  </question>
1220  <answer id="a-size_equals_capacity">
1221    <para>
1222    The standard idiom for deallocating a <classname>vector&lt;T&gt;</classname>'s
1223    unused memory is to create a temporary copy of the vector and swap their
1224    contents, e.g. for <classname>vector&lt;T&gt; v</classname>
1225    </para>
1226    <literallayout>
1227     std::vector&lt;T&gt;(v).swap(v);
1228    </literallayout>
1229    <para>
1230    The copy will take O(n) time and the swap is constant time.
1231    </para>
1232    <para>
1233    See <link linkend="strings.string.shrink">Shrink-to-fit
1234    strings</link> for a similar solution for strings.
1235    </para>
1236  </answer>
1237</qandaentry>
1238
1239</qandadiv>
1240
1241
1242<!-- FAQ ends here -->
1243</qandaset>
1244
1245</article>
1246
1247</book>
1248