• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3<html>
4<head>
5  <meta http-equiv="Content-Language" content="en-us">
6  <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
7
8  <title>The Boost Format library</title>
9</head>
10
11<body bgcolor="#FFFFFF" text="#000000">
12  <table border="1" bgcolor="#007F7F" cellpadding="2" summary="">
13    <tr>
14      <td bgcolor="#FFFFFF"><img src="../../boost.png" alt=
15      "boost.png (6897 bytes)" width="277" height="86"></td>
16
17      <td><a href="../../index.htm"><font face="Arial" color=
18      "#FFFFFF"><big>Home</big></font></a></td>
19
20      <td><a href="../libraries.htm"><font face="Arial" color=
21      "#FFFFFF"><big>Libraries</big></font></a></td>
22
23      <td><a href="http://www.boost.org/people/people.htm"><font face="Arial" color=
24      "#FFFFFF"><big>People</big></font></a></td>
25
26      <td><a href="http://www.boost.org/more/faq.htm"><font face="Arial" color=
27      "#FFFFFF"><big>FAQ</big></font></a></td>
28
29      <td><a href="../../more/index.htm"><font face="Arial" color=
30      "#FFFFFF"><big>More</big></font></a></td>
31    </tr>
32  </table>
33
34  <h1>Boost Format library</h1>
35
36  <p>The format library provides a class for formatting arguments according
37  to a format-string, as does printf, but with two major differences
38  :<br></p>
39
40  <ul>
41    <li>format sends the arguments to an internal stream, and so is entirely
42    type-safe and naturally supports all user-defined types.</li>
43
44    <li>The ellipsis (...) can not be used correctly in the strongly typed
45    context of format, and thus the function call with arbitrary arguments is
46    replaced by successive calls to an <i>argument feeding</i>
47    <b>operator%</b></li>
48  </ul>
49
50  <p><br>
51  You can find more Details in :</p>
52
53  <ul>
54    <li><a href="doc/format.html">Documentation</a> (HTML).</li>
55
56    <li>Headers
57
58      <ul>
59        <li><a href="../../boost/format.hpp">format.hpp</a> : user
60        frontend.</li>
61
62        <li><a href="../../boost/format/format_fwd.hpp">format_fwd.hpp</a> :
63        user forward declarations.</li>
64
65        <li><a href=
66        "../../boost/format/format_class.hpp">format_class.hpp</a> : the
67        class interface</li>
68
69        <li><a href=
70        "../../boost/format/format_implementation.hpp">format_implementation.hpp</a>:
71        implementation of the member functions</li>
72
73        <li><a href="../../boost/format/feed_args.hpp">feed_args.hpp</a> :
74        argument feeding helper functions</li>
75
76        <li><a href="../../boost/format/free_funcs.hpp">free_funcs.hpp</a> :
77        free functions definitions</li>
78
79        <li><a href="../../boost/format/parsing.hpp">parsing.hpp</a> : code
80        for parsing format-strings</li>
81
82        <li><a href="../../boost/format/group.hpp">group.hpp</a> : auxiliary
83        struct used to group arguments and manipulators</li>
84
85        <li><a href="../../boost/format/exceptions.hpp">exceptions.hpp</a> :
86        exceptions used by the library</li>
87
88        <li><a href="../../boost/format/internals.hpp">internals.hpp</a> :
89        auxiliary structs stream_format_state and format_item</li>
90      </ul>
91    </li>
92
93    <li>Sample programs
94
95      <ul>
96        <li>The program <a href=
97        "./example/sample_formats.cpp">sample_formats.cpp</a> demonstrates
98        simple uses of <b>format</b>.</li>
99
100        <li><a href=
101        "./example/sample_new_features.cpp">sample_new_features.cpp</a>
102        illustrates the few formatting features that were added to printf's
103        syntax such as simple positional directives, centered alignment, and
104        'tabulations'.</li>
105
106        <li><a href="./example/sample_advanced.cpp">sample_advanced.cpp</a>
107        demonstrates uses of advanced features, like reusing, and modifying,
108        format objects, etc..</li>
109
110        <li>And <a href=
111        "./example/sample_userType.cpp">sample_userType.cpp</a> shows the
112        behaviour of the <b>format</b> library on user-defined types.</li>
113      </ul>
114    </li>
115  </ul>
116  <hr>
117
118  <p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
119  "../../doc/images/valid-html401.png" alt="Valid HTML 4.01 Transitional"
120  height="31" width="88"></a></p>
121
122  <p>Revised
123  <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->02 December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38510" --></p>
124
125  <p><i>Copyright &copy; 2003 Samuel Krempp</i></p>
126
127  <p><i>Distributed under the Boost Software License, Version 1.0. (See
128  accompanying file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
129  copy at <a href=
130  "http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
131</body>
132</html>
133