1 | // ----------------------------------------------------------------------------
|
---|
2 | // format_class.hpp : class interface
|
---|
3 | // ----------------------------------------------------------------------------
|
---|
4 |
|
---|
5 | // Copyright Samuel Krempp 2003. Use, modification, and distribution are
|
---|
6 | // subject to the Boost Software License, Version 1.0. (See accompanying
|
---|
7 | // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
---|
8 |
|
---|
9 | // See http://www.boost.org/libs/format for library home page
|
---|
10 |
|
---|
11 | // ----------------------------------------------------------------------------
|
---|
12 |
|
---|
13 | #ifndef BOOST_FORMAT_CLASS_HPP
|
---|
14 | #define BOOST_FORMAT_CLASS_HPP
|
---|
15 |
|
---|
16 |
|
---|
17 | #include <vector>
|
---|
18 | #include <string>
|
---|
19 |
|
---|
20 | #include <boost/optional.hpp> // to store locale when needed
|
---|
21 |
|
---|
22 | #include <boost/format/format_fwd.hpp>
|
---|
23 | #include <boost/format/internals_fwd.hpp>
|
---|
24 | #include <boost/format/internals.hpp>
|
---|
25 | #include <boost/format/alt_sstream.hpp>
|
---|
26 |
|
---|
27 | namespace boost {
|
---|
28 |
|
---|
29 | template<class Ch, class Tr, class Alloc>
|
---|
30 | class basic_format
|
---|
31 | {
|
---|
32 | typedef typename io::CompatTraits<Tr>::compatible_type compat_traits;
|
---|
33 | public:
|
---|
34 | typedef Ch CharT; // borland fails in operator% if we use Ch and Tr directly
|
---|
35 | typedef std::basic_string<Ch, Tr, Alloc> string_type;
|
---|
36 | typedef typename string_type::size_type size_type;
|
---|
37 | typedef io::detail::format_item<Ch, Tr, Alloc> format_item_t;
|
---|
38 | typedef io::basic_altstringbuf<Ch, Tr, Alloc> internal_streambuf_t;
|
---|
39 |
|
---|
40 |
|
---|
41 | explicit basic_format(const Ch* str=NULL);
|
---|
42 | explicit basic_format(const string_type& s);
|
---|
43 | basic_format(const basic_format& x);
|
---|
44 | basic_format& operator= (const basic_format& x);
|
---|
45 | void swap(basic_format& x);
|
---|
46 |
|
---|
47 | #if !defined(BOOST_NO_STD_LOCALE)
|
---|
48 | explicit basic_format(const Ch* str, const std::locale & loc);
|
---|
49 | explicit basic_format(const string_type& s, const std::locale & loc);
|
---|
50 | #endif
|
---|
51 | io::detail::locale_t getloc() const;
|
---|
52 |
|
---|
53 | basic_format& clear(); // empty all converted string buffers (except bound items)
|
---|
54 | basic_format& clear_binds(); // unbind all bound items, and call clear()
|
---|
55 | basic_format& parse(const string_type&); // resets buffers and parse a new format string
|
---|
56 |
|
---|
57 | // ** formatted result ** //
|
---|
58 | size_type size() const; // sum of the current string pieces sizes
|
---|
59 | string_type str() const; // final string
|
---|
60 | // ===== John's Patch Feb 13 2012
|
---|
61 | operator string_type() const { return str(); }
|
---|
62 | // =====end
|
---|
63 |
|
---|
64 | // ** arguments passing ** //
|
---|
65 | template<class T>
|
---|
66 | basic_format& operator%(const T& x)
|
---|
67 | { return io::detail::feed<CharT, Tr, Alloc, const T&>(*this,x); }
|
---|
68 |
|
---|
69 | #ifndef BOOST_NO_OVERLOAD_FOR_NON_CONST
|
---|
70 | template<class T> basic_format& operator%(T& x)
|
---|
71 | { return io::detail::feed<CharT, Tr, Alloc, T&>(*this,x); }
|
---|
72 | #endif
|
---|
73 |
|
---|
74 | #if defined(__GNUC__)
|
---|
75 | // GCC can't handle anonymous enums without some help
|
---|
76 | // ** arguments passing ** //
|
---|
77 | basic_format& operator%(const int& x)
|
---|
78 | { return io::detail::feed<CharT, Tr, Alloc, const int&>(*this,x); }
|
---|
79 |
|
---|
80 | #ifndef BOOST_NO_OVERLOAD_FOR_NON_CONST
|
---|
81 | basic_format& operator%(int& x)
|
---|
82 | { return io::detail::feed<CharT, Tr, Alloc, int&>(*this,x); }
|
---|
83 | #endif
|
---|
84 | #endif
|
---|
85 |
|
---|
86 | // The total number of arguments expected to be passed to the format objectt
|
---|
87 | int expected_args() const
|
---|
88 | { return num_args_; }
|
---|
89 | // The number of arguments currently bound (see bind_arg(..) )
|
---|
90 | int bound_args() const;
|
---|
91 | // The number of arguments currently fed to the format object
|
---|
92 | int fed_args() const;
|
---|
93 | // The index (1-based) of the current argument (i.e. next to be formatted)
|
---|
94 | int cur_arg() const;
|
---|
95 | // The number of arguments still required to be fed
|
---|
96 | int remaining_args() const; // same as expected_args() - bound_args() - fed_args()
|
---|
97 |
|
---|
98 |
|
---|
99 | // ** object modifying **//
|
---|
100 | template<class T>
|
---|
101 | basic_format& bind_arg(int argN, const T& val)
|
---|
102 | { return io::detail::bind_arg_body(*this, argN, val); }
|
---|
103 | basic_format& clear_bind(int argN);
|
---|
104 | template<class T>
|
---|
105 | basic_format& modify_item(int itemN, T manipulator)
|
---|
106 | { return io::detail::modify_item_body<Ch,Tr, Alloc, T> (*this, itemN, manipulator);}
|
---|
107 |
|
---|
108 | // Choosing which errors will throw exceptions :
|
---|
109 | unsigned char exceptions() const;
|
---|
110 | unsigned char exceptions(unsigned char newexcept);
|
---|
111 |
|
---|
112 | #if !defined( BOOST_NO_MEMBER_TEMPLATE_FRIENDS ) \
|
---|
113 | && !BOOST_WORKAROUND(__BORLANDC__, <= 0x570) \
|
---|
114 | && !BOOST_WORKAROUND( _CRAYC, != 0) \
|
---|
115 | && !BOOST_WORKAROUND(__DECCXX_VER, BOOST_TESTED_AT(60590042))
|
---|
116 | // use friend templates and private members only if supported
|
---|
117 |
|
---|
118 | #ifndef BOOST_NO_TEMPLATE_STD_STREAM
|
---|
119 | template<class Ch2, class Tr2, class Alloc2>
|
---|
120 | friend std::basic_ostream<Ch2, Tr2> &
|
---|
121 | operator<<( std::basic_ostream<Ch2, Tr2> & ,
|
---|
122 | const basic_format<Ch2, Tr2, Alloc2>& );
|
---|
123 | #else
|
---|
124 | template<class Ch2, class Tr2, class Alloc2>
|
---|
125 | friend std::ostream &
|
---|
126 | operator<<( std::ostream & ,
|
---|
127 | const basic_format<Ch2, Tr2, Alloc2>& );
|
---|
128 | #endif
|
---|
129 |
|
---|
130 | template<class Ch2, class Tr2, class Alloc2, class T>
|
---|
131 | friend basic_format<Ch2, Tr2, Alloc2>&
|
---|
132 | io::detail::feed (basic_format<Ch2, Tr2, Alloc2>&, T);
|
---|
133 |
|
---|
134 | template<class Ch2, class Tr2, class Alloc2, class T> friend
|
---|
135 | void io::detail::distribute (basic_format<Ch2, Tr2, Alloc2>&, T);
|
---|
136 |
|
---|
137 | template<class Ch2, class Tr2, class Alloc2, class T> friend
|
---|
138 | basic_format<Ch2, Tr2, Alloc2>&
|
---|
139 | io::detail::modify_item_body (basic_format<Ch2, Tr2, Alloc2>&, int, T);
|
---|
140 |
|
---|
141 | template<class Ch2, class Tr2, class Alloc2, class T> friend
|
---|
142 | basic_format<Ch2, Tr2, Alloc2>&
|
---|
143 | io::detail::bind_arg_body (basic_format<Ch2, Tr2, Alloc2>&, int, const T&);
|
---|
144 |
|
---|
145 | private:
|
---|
146 | #endif
|
---|
147 | typedef io::detail::stream_format_state<Ch, Tr> stream_format_state;
|
---|
148 | // flag bits, used for style_
|
---|
149 | enum style_values { ordered = 1, // set only if all directives are positional
|
---|
150 | special_needs = 4 };
|
---|
151 |
|
---|
152 | void make_or_reuse_data(std::size_t nbitems);// used for (re-)initialisation
|
---|
153 |
|
---|
154 | // member data --------------------------------------------//
|
---|
155 | std::vector<format_item_t> items_; // each '%..' directive leads to a format_item
|
---|
156 | std::vector<bool> bound_; // stores which arguments were bound. size() == 0 || num_args
|
---|
157 |
|
---|
158 | int style_; // style of format-string : positional or not, etc
|
---|
159 | int cur_arg_; // keep track of wich argument is current
|
---|
160 | int num_args_; // number of expected arguments
|
---|
161 | mutable bool dumped_; // true only after call to str() or <<
|
---|
162 | string_type prefix_; // piece of string to insert before first item
|
---|
163 | unsigned char exceptions_;
|
---|
164 | internal_streambuf_t buf_; // the internal stream buffer.
|
---|
165 | boost::optional<io::detail::locale_t> loc_;
|
---|
166 | }; // class basic_format
|
---|
167 |
|
---|
168 | } // namespace boost
|
---|
169 |
|
---|
170 |
|
---|
171 | #endif // BOOST_FORMAT_CLASS_HPP
|
---|