Sync usage with man page.
[netbsd-mini2440.git] / gnu / dist / gcc4 / libstdc++-v3 / include / ext / vstring_fwd.h
blob08ec94a00d5c28368160ff5a240f947a797570f3
1 // Versatile string forward -*- C++ -*-
3 // Copyright (C) 2005 Free Software Foundation, Inc.
4 //
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 2, or (at your option)
9 // any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // You should have received a copy of the GNU General Public License along
17 // with this library; see the file COPYING. If not, write to the Free
18 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19 // USA.
21 // As a special exception, you may use this file as part of a free software
22 // library without restriction. Specifically, if other files instantiate
23 // templates or use macros or inline functions from this file, or you compile
24 // this file and link it with other files to produce an executable, this
25 // file does not by itself cause the resulting executable to be covered by
26 // the GNU General Public License. This exception does not however
27 // invalidate any other reasons why the executable file might be covered by
28 // the GNU General Public License.
30 /** @file ext/vstring_fwd.h
31 * This file is a GNU extension to the Standard C++ Library.
32 * This is an internal header file, included by other library headers.
33 * You should not attempt to use it directly.
36 #ifndef _VSTRING_FWD_H
37 #define _VSTRING_FWD_H 1
39 #pragma GCC system_header
41 #include <bits/c++config.h>
42 #include <bits/char_traits.h>
43 #include <memory> // For allocator.
45 namespace __gnu_cxx
47 template<typename _CharT, typename _Traits, typename _Alloc>
48 class __sso_string_base;
50 template<typename _CharT, typename _Traits, typename _Alloc>
51 class __rc_string_base;
53 template<typename _CharT, typename _Traits = std::char_traits<_CharT>,
54 typename _Alloc = std::allocator<_CharT>,
55 template
56 <typename, typename, typename> class _Base = __sso_string_base>
57 class __versa_string;
59 typedef __versa_string<char> __vstring;
60 typedef __vstring __sso_string;
61 typedef
62 __versa_string<char, std::char_traits<char>,
63 std::allocator<char>, __rc_string_base> __rc_string;
65 #ifdef _GLIBCXX_USE_WCHAR_T
66 typedef __versa_string<wchar_t> __wvstring;
67 typedef __wvstring __wsso_string;
68 typedef
69 __versa_string<wchar_t, std::char_traits<wchar_t>,
70 std::allocator<wchar_t>, __rc_string_base> __wrc_string;
71 #endif
72 } // namespace __gnu_cxx
74 #endif /* _VSTRING_FWD_H */