OSDN Git Service

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