| 1 | <html> |
|---|
| 2 | |
|---|
| 3 | <head> |
|---|
| 4 | <TITLE>The Boost Format library</TITLE> |
|---|
| 5 | <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> |
|---|
| 6 | </head> |
|---|
| 7 | |
|---|
| 8 | <body bgcolor="#FFFFFF" text="#000000"> |
|---|
| 9 | |
|---|
| 10 | <table border="1" bgcolor="#007F7F" cellpadding="2"> |
|---|
| 11 | <tr> |
|---|
| 12 | <td bgcolor="#FFFFFF"><img src="../../boost.png" alt="boost.png (6897 bytes)" width="277" height="86"></td> |
|---|
| 13 | <td><a href="../../index.htm"><font face="Arial" color="#FFFFFF"><big>Home </big></font></a></td> |
|---|
| 14 | <td><a href="../libraries.htm"><font face="Arial" color="#FFFFFF"><big>Libraries </big></font></a></td> |
|---|
| 15 | <td><a href="../../people/people.htm"><font face="Arial" color="#FFFFFF"><big>People </big></font></a></td> |
|---|
| 16 | <td><a href="../../more/faq.htm"><font face="Arial" color="#FFFFFF"><big>FAQ </big></font></a></td> |
|---|
| 17 | <td><a href="../../more/index.htm"><font face="Arial" color="#FFFFFF"><big>More </big></font></a></td> |
|---|
| 18 | </tr> |
|---|
| 19 | </table> |
|---|
| 20 | |
|---|
| 21 | <h1>Boost Format library</h1> |
|---|
| 22 | |
|---|
| 23 | <p> |
|---|
| 24 | The format library provides a class for formatting arguments according to a format-string, |
|---|
| 25 | as does printf, but with two major differences : |
|---|
| 26 | <br> |
|---|
| 27 | <ul> |
|---|
| 28 | <li>format sends the arguments to an internal stream, and so is entirely type-safe and |
|---|
| 29 | naturally supports all user-defined types.</li> |
|---|
| 30 | <li>The ellipsis (...) can not be used correctly in the strongly typed context of format, |
|---|
| 31 | and thus the function call with arbitrary arguments is replaced by successive calls to an |
|---|
| 32 | <i>argument feeding</i> <b>operator%</b> |
|---|
| 33 | </li> |
|---|
| 34 | </ul> |
|---|
| 35 | |
|---|
| 36 | </p> |
|---|
| 37 | |
|---|
| 38 | <p> |
|---|
| 39 | <br> |
|---|
| 40 | You can find more Details in : |
|---|
| 41 | <ul> |
|---|
| 42 | <li><a href="doc/format.html">Documentation</a> (HTML).</li> |
|---|
| 43 | <li>Headers <ul> |
|---|
| 44 | <li><a href="../../boost/format.hpp">format.hpp</a> : user frontend.</li> |
|---|
| 45 | <li><a href="../../boost/format/format_fwd.hpp">format_fwd.hpp</a> |
|---|
| 46 | : user forward declarations.</li> |
|---|
| 47 | <li><a href="../../boost/format/format_class.hpp"> |
|---|
| 48 | format_class.hpp</a> : the class interface</li> |
|---|
| 49 | <li><a href="../../boost/format/format_implementation.hpp"> |
|---|
| 50 | format_implementation.hpp</a>: implementation of the member functions</li> |
|---|
| 51 | <li><a href="../../boost/format/feed_args.hpp">feed_args.hpp</a> |
|---|
| 52 | : argument feeding helper functions</li> |
|---|
| 53 | <li><a href="../../boost/format/free_funcs.hpp">free_funcs.hpp</a> |
|---|
| 54 | : free functions definitions</li> |
|---|
| 55 | <li><a href="../../boost/format/parsing.hpp">parsing.hpp</a> |
|---|
| 56 | : code for parsing format-strings</li> |
|---|
| 57 | <li><a href="../../boost/format/group.hpp">group.hpp</a> |
|---|
| 58 | : auxiliary struct used to group arguments and manipulators</li> |
|---|
| 59 | <li><a href="../../boost/format/exceptions.hpp">exceptions.hpp</a> |
|---|
| 60 | : exceptions used by the library</li> |
|---|
| 61 | <li><a href="../../boost/format/internals.hpp">internals.hpp</a> |
|---|
| 62 | : auxiliary structs stream_format_state and format_item</li> |
|---|
| 63 | </ul> |
|---|
| 64 | </li> |
|---|
| 65 | <li> Sample programs <ul> |
|---|
| 66 | <li>The program <A href="./example/sample_formats.cpp">sample_formats.cpp</A> |
|---|
| 67 | demonstrates simple uses of <B>format</B>. </li> |
|---|
| 68 | <li><A href="./example/sample_new_features.cpp">sample_new_features.cpp</A> |
|---|
| 69 | illustrates the few formatting features that were added to printf's syntax such |
|---|
| 70 | as simple positional directives, centered alignment, and 'tabulations'. </li> |
|---|
| 71 | <li><A href="./example/sample_advanced.cpp">sample_advanced.cpp</A> |
|---|
| 72 | demonstrates uses of advanced features, like reusing, and modifying, |
|---|
| 73 | format objects, etc.. </li> |
|---|
| 74 | <li>And <A href="./example/sample_userType.cpp">sample_userType.cpp</A> |
|---|
| 75 | shows the behaviour of the <b>format</b> library on user-defined types.</li> |
|---|
| 76 | </ul> |
|---|
| 77 | </li> |
|---|
| 78 | </ul> |
|---|
| 79 | Submitted by <a href="../../people/samuel_krempp.htm">Samuel Krempp</a>.</p> |
|---|
| 80 | </body> |
|---|
| 81 | |
|---|
| 82 | </html> |
|---|
