summaryrefslogtreecommitdiffstats
path: root/src/boost/libs/format/index.html
blob: 52cd354d1be730c2611daf45f708256a513cf441 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
  <meta http-equiv="Content-Language" content="en-us">
  <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">

  <title>The Boost Format library</title>
</head>

<body bgcolor="#FFFFFF" text="#000000">
  <table border="1" bgcolor="#007F7F" cellpadding="2" summary="">
    <tr>
      <td bgcolor="#FFFFFF"><img src="../../boost.png" alt=
      "boost.png (6897 bytes)" width="277" height="86"></td>

      <td><a href="../../index.htm"><font face="Arial" color=
      "#FFFFFF"><big>Home</big></font></a></td>

      <td><a href="../libraries.htm"><font face="Arial" color=
      "#FFFFFF"><big>Libraries</big></font></a></td>

      <td><a href="http://www.boost.org/people/people.htm"><font face="Arial" color=
      "#FFFFFF"><big>People</big></font></a></td>

      <td><a href="http://www.boost.org/more/faq.htm"><font face="Arial" color=
      "#FFFFFF"><big>FAQ</big></font></a></td>

      <td><a href="../../more/index.htm"><font face="Arial" color=
      "#FFFFFF"><big>More</big></font></a></td>
    </tr>
  </table>

  <h1>Boost Format library</h1>

  <p>The format library provides a class for formatting arguments according
  to a format-string, as does printf, but with two major differences
  :<br></p>

  <ul>
    <li>format sends the arguments to an internal stream, and so is entirely
    type-safe and naturally supports all user-defined types.</li>

    <li>The ellipsis (...) can not be used correctly in the strongly typed
    context of format, and thus the function call with arbitrary arguments is
    replaced by successive calls to an <i>argument feeding</i>
    <b>operator%</b></li>
  </ul>

  <p><br>
  You can find more Details in :</p>

  <ul>
    <li><a href="doc/format.html">Documentation</a> (HTML).</li>

    <li>Headers

      <ul>
        <li><a href="../../boost/format.hpp">format.hpp</a> : user
        frontend.</li>

        <li><a href="../../boost/format/format_fwd.hpp">format_fwd.hpp</a> :
        user forward declarations.</li>

        <li><a href=
        "../../boost/format/format_class.hpp">format_class.hpp</a> : the
        class interface</li>

        <li><a href=
        "../../boost/format/format_implementation.hpp">format_implementation.hpp</a>:
        implementation of the member functions</li>

        <li><a href="../../boost/format/feed_args.hpp">feed_args.hpp</a> :
        argument feeding helper functions</li>

        <li><a href="../../boost/format/free_funcs.hpp">free_funcs.hpp</a> :
        free functions definitions</li>

        <li><a href="../../boost/format/parsing.hpp">parsing.hpp</a> : code
        for parsing format-strings</li>

        <li><a href="../../boost/format/group.hpp">group.hpp</a> : auxiliary
        struct used to group arguments and manipulators</li>

        <li><a href="../../boost/format/exceptions.hpp">exceptions.hpp</a> :
        exceptions used by the library</li>

        <li><a href="../../boost/format/internals.hpp">internals.hpp</a> :
        auxiliary structs stream_format_state and format_item</li>
      </ul>
    </li>

    <li>Sample programs

      <ul>
        <li>The program <a href=
        "./example/sample_formats.cpp">sample_formats.cpp</a> demonstrates
        simple uses of <b>format</b>.</li>

        <li><a href=
        "./example/sample_new_features.cpp">sample_new_features.cpp</a>
        illustrates the few formatting features that were added to printf's
        syntax such as simple positional directives, centered alignment, and
        'tabulations'.</li>

        <li><a href="./example/sample_advanced.cpp">sample_advanced.cpp</a>
        demonstrates uses of advanced features, like reusing, and modifying,
        format objects, etc..</li>

        <li>And <a href=
        "./example/sample_userType.cpp">sample_userType.cpp</a> shows the
        behaviour of the <b>format</b> library on user-defined types.</li>
      </ul>
    </li>
  </ul>
  <hr>

  <p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
  "../../doc/images/valid-html401.png" alt="Valid HTML 4.01 Transitional"
  height="31" width="88"></a></p>

  <p>Revised 
  <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->02 December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38510" --></p>

  <p><i>Copyright &copy; 2003 Samuel Krempp</i></p>

  <p><i>Distributed under the Boost Software License, Version 1.0. (See
  accompanying file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
  copy at <a href=
  "http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body>
</html>