mirror/Sprout
1
0
Fork 0
mirror of https://github.com/bolero-MURAKAMI/Sprout.git synced 2024-11-25 00:43:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add doc: basic_string aliases

Browse source
This commit is contained in:
Bolero-MURAKAMI 2013-09-08 13:44:32 +09:00
parent 7b0f0541e3
commit c6a9bf338a
16 changed files with 899 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
docs/_sources/libs/string/string.txt Normal file
View file

@ -0,0 +1,29 @@
.. _sprout-string-basic_string-string:
###############################################################################
string
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<std::size_t N>
using string = sprout::basic_string<char, N>;
Examples
========================================
.. sourcecode:: c++
#include <type_traits>
#include <sprout/string.hpp>
using namespace sprout;
using type = string<8>;
static_assert(std::is_same<type::value_type, char>::value, "element type of string is char.");
Header
========================================
| ``sprout/string/alias.hpp``
| Convenience header: ``sprout/string.hpp``

29
docs/_sources/libs/string/u16string.txt Normal file
View file

@ -0,0 +1,29 @@
.. _sprout-string-basic_string-u16string:
###############################################################################
u16string
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<std::size_t N>
using u16string = sprout::basic_string<char16_t, N>;
Examples
========================================
.. sourcecode:: c++
#include <type_traits>
#include <sprout/string.hpp>
using namespace sprout;
using type = u16string<8>;
static_assert(std::is_same<type::value_type, char16_t>::value, "element type of u16string is char16_t.");
Header
========================================
| ``sprout/string/alias.hpp``
| Convenience header: ``sprout/string.hpp``

29
docs/_sources/libs/string/u32string.txt Normal file
View file

@ -0,0 +1,29 @@
.. _sprout-string-basic_string-u32string:
###############################################################################
u32string
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<std::size_t N>
using u32string = sprout::basic_string<char32_t, N>;
Examples
========================================
.. sourcecode:: c++
#include <type_traits>
#include <sprout/string.hpp>
using namespace sprout;
using type = u32string<8>;
static_assert(std::is_same<type::value_type, char32_t>::value, "element type of u32string is char32_t.");
Header
========================================
| ``sprout/string/alias.hpp``
| Convenience header: ``sprout/string.hpp``

29
docs/_sources/libs/string/wstring.txt Normal file
View file

@ -0,0 +1,29 @@
.. _sprout-string-basic_string-wstring:
###############################################################################
wstring
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<std::size_t N>
using wstring = sprout::basic_string<wchar_t, N>;
Examples
========================================
.. sourcecode:: c++
#include <type_traits>
#include <sprout/string.hpp>
using namespace sprout;
using type = wstring<8>;
static_assert(std::is_same<type::value_type, wchar_t>::value, "element type of wstring is charwchar_t
Header
========================================
| ``sprout/string/alias.hpp``
| Convenience header: ``sprout/string.hpp``

10
docs/libs/string/basic_string/data.html
View file

@ -38,7 +38,7 @@
<script type="text/javascript" src="../../../_static/doctools.js"></script> <script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="top" title="Sprout 1.0 documentation" href="../../../index.html" /> <link rel="top" title="Sprout 1.0 documentation" href="../../../index.html" />
<link rel="up" title="basic_string" href="index.html" /> <link rel="up" title="basic_string" href="index.html" />
<link rel="next" title="swap" href="swap-global.html" /> <link rel="next" title="string" href="../string.html" />
<link rel="prev" title="back" href="c_array.html" /> <link rel="prev" title="back" href="c_array.html" />
</head> </head>
<body> <body>
@ -49,7 +49,7 @@
<a href="../../../genindex.html" title="General Index" <a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li> accesskey="I">index</a></li>
<li class="right" > <li class="right" >
<a href="swap-global.html" title="swap" <a href="../string.html" title="string"
accesskey="N">next</a> |</li> accesskey="N">next</a> |</li>
<li class="right" > <li class="right" >
<a href="c_array.html" title="back" <a href="c_array.html" title="back"
@ -78,8 +78,8 @@
<p class="topless"><a href="c_array.html" <p class="topless"><a href="c_array.html"
title="previous chapter">back</a></p> title="previous chapter">back</a></p>
<h4>Next topic</h4> <h4>Next topic</h4>
<p class="topless"><a href="swap-global.html" <p class="topless"><a href="../string.html"
title="next chapter">swap</a></p> title="next chapter">string</a></p>
<h3>This Page</h3> <h3>This Page</h3>
<ul class="this-page-menu"> <ul class="this-page-menu">
<li><a href="../../../_sources/libs/string/basic_string/data.txt" <li><a href="../../../_sources/libs/string/basic_string/data.txt"
@ -160,7 +160,7 @@
<a href="../../../genindex.html" title="General Index" <a href="../../../genindex.html" title="General Index"
>index</a></li> >index</a></li>
<li class="right" > <li class="right" >
<a href="swap-global.html" title="swap" <a href="../string.html" title="string"
>next</a> |</li> >next</a> |</li>
<li class="right" > <li class="right" >
<a href="c_array.html" title="back" <a href="c_array.html" title="back"

10
docs/libs/string/basic_string/swap-global.html
View file

@ -39,7 +39,7 @@
<link rel="top" title="Sprout 1.0 documentation" href="../../../index.html" /> <link rel="top" title="Sprout 1.0 documentation" href="../../../index.html" />
<link rel="up" title="Sprout.String" href="../index.html" /> <link rel="up" title="Sprout.String" href="../index.html" />
<link rel="next" title="operator+" href="operator-plus.html" /> <link rel="next" title="operator+" href="operator-plus.html" />
<link rel="prev" title="back" href="data.html" /> <link rel="prev" title="u32string" href="../u32string.html" />
</head> </head>
<body> <body>
<div class="related"> <div class="related">
@ -52,7 +52,7 @@
<a href="operator-plus.html" title="operator+" <a href="operator-plus.html" title="operator+"
accesskey="N">next</a> |</li> accesskey="N">next</a> |</li>
<li class="right" > <li class="right" >
<a href="data.html" title="back" <a href="../u32string.html" title="u32string"
accesskey="P">previous</a> |</li> accesskey="P">previous</a> |</li>
<li><a href="../../../index.html">Sprout 1.0 documentation</a> &raquo;</li> <li><a href="../../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Libraries</a> &raquo;</li> <li><a href="../../index.html" >Libraries</a> &raquo;</li>
@ -75,8 +75,8 @@
</ul> </ul>
<h4>Previous topic</h4> <h4>Previous topic</h4>
<p class="topless"><a href="data.html" <p class="topless"><a href="../u32string.html"
title="previous chapter">back</a></p> title="previous chapter">u32string</a></p>
<h4>Next topic</h4> <h4>Next topic</h4>
<p class="topless"><a href="operator-plus.html" <p class="topless"><a href="operator-plus.html"
title="next chapter">operator+</a></p> title="next chapter">operator+</a></p>
@ -173,7 +173,7 @@
<a href="operator-plus.html" title="operator+" <a href="operator-plus.html" title="operator+"
>next</a> |</li> >next</a> |</li>
<li class="right" > <li class="right" >
<a href="data.html" title="back" <a href="../u32string.html" title="u32string"
>previous</a> |</li> >previous</a> |</li>
<li><a href="../../../index.html">Sprout 1.0 documentation</a> &raquo;</li> <li><a href="../../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../../index.html" >Libraries</a> &raquo;</li> <li><a href="../../index.html" >Libraries</a> &raquo;</li>

8
docs/libs/string/index.html
View file

@ -176,16 +176,16 @@
</tr> </tr>
</thead> </thead>
<tbody valign="top"> <tbody valign="top">
<tr class="row-even"><td><tt class="xref doc docutils literal"><span class="pre">string</span></tt></td> <tr class="row-even"><td><a class="reference internal" href="string.html"><em>string</em></a></td>
<td>&nbsp;</td> <td>&nbsp;</td>
</tr> </tr>
<tr class="row-odd"><td><tt class="xref doc docutils literal"><span class="pre">wstring</span></tt></td> <tr class="row-odd"><td><a class="reference internal" href="wstring.html"><em>wstring</em></a></td>
<td>&nbsp;</td> <td>&nbsp;</td>
</tr> </tr>
<tr class="row-even"><td><tt class="xref doc docutils literal"><span class="pre">u16string</span></tt></td> <tr class="row-even"><td><a class="reference internal" href="u16string.html"><em>u16string</em></a></td>
<td>&nbsp;</td> <td>&nbsp;</td>
</tr> </tr>
<tr class="row-odd"><td><tt class="xref doc docutils literal"><span class="pre">u32string</span></tt></td> <tr class="row-odd"><td><a class="reference internal" href="u32string.html"><em>u32string</em></a></td>
<td>&nbsp;</td> <td>&nbsp;</td>
</tr> </tr>
</tbody> </tbody>

163
docs/libs/string/string.html Normal file
View file

@ -0,0 +1,163 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-43764535-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<title>string &mdash; Sprout 1.0 documentation</title>
<link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="Sprout 1.0 documentation" href="../../index.html" />
<link rel="up" title="Sprout.String" href="index.html" />
<link rel="next" title="wstring" href="wstring.html" />
<link rel="prev" title="back" href="basic_string/data.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="wstring.html" title="wstring"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="basic_string/data.html" title="back"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../index.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Sprout.String</a> &raquo;</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">string</a><ul>
<li><a class="reference internal" href="#interface">Interface</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#header">Header</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="basic_string/data.html"
title="previous chapter">back</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="wstring.html"
title="next chapter">wstring</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/libs/string/string.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="string">
<h1>string<a class="headerlink" href="#string" title="Permalink to this headline"></a></h1>
<div class="section" id="interface">
<h2>Interface<a class="headerlink" href="#interface" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="k">template</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">N</span><span class="o">&gt;</span>
<span class="k">using</span> <span class="n">string</span> <span class="o">=</span> <span class="n">sprout</span><span class="o">::</span><span class="n">basic_string</span><span class="o">&lt;</span><span class="kt">char</span><span class="p">,</span> <span class="n">N</span><span class="o">&gt;</span><span class="p">;</span>
</pre></div>
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;type_traits&gt;</span>
<span class="cp">#include &lt;sprout/string.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="k">using</span> <span class="n">type</span> <span class="o">=</span> <span class="n">string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">;</span>
<span class="n">static_assert</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">is_same</span><span class="o">&lt;</span><span class="n">type</span><span class="o">::</span><span class="n">value_type</span><span class="p">,</span> <span class="kt">char</span><span class="o">&gt;::</span><span class="n">value</span><span class="p">,</span> <span class="s">&quot;element type of string is char.&quot;</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="header">
<h2>Header<a class="headerlink" href="#header" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">sprout/string/alias.hpp</span></tt></div>
<div class="line">Convenience header: <tt class="docutils literal"><span class="pre">sprout/string.hpp</span></tt></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="wstring.html" title="wstring"
>next</a> |</li>
<li class="right" >
<a href="basic_string/data.html" title="back"
>previous</a> |</li>
<li><a href="../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../index.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" >Sprout.String</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013, Bolero MURAKAMI.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>

163
docs/libs/string/u16string.html Normal file
View file

@ -0,0 +1,163 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-43764535-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<title>u16string &mdash; Sprout 1.0 documentation</title>
<link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="Sprout 1.0 documentation" href="../../index.html" />
<link rel="up" title="Sprout.String" href="index.html" />
<link rel="next" title="u32string" href="u32string.html" />
<link rel="prev" title="wstring" href="wstring.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="u32string.html" title="u32string"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="wstring.html" title="wstring"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../index.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Sprout.String</a> &raquo;</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">u16string</a><ul>
<li><a class="reference internal" href="#interface">Interface</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#header">Header</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="wstring.html"
title="previous chapter">wstring</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="u32string.html"
title="next chapter">u32string</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/libs/string/u16string.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="u16string">
<h1>u16string<a class="headerlink" href="#u16string" title="Permalink to this headline"></a></h1>
<div class="section" id="interface">
<h2>Interface<a class="headerlink" href="#interface" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="k">template</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">N</span><span class="o">&gt;</span>
<span class="k">using</span> <span class="n">u16string</span> <span class="o">=</span> <span class="n">sprout</span><span class="o">::</span><span class="n">basic_string</span><span class="o">&lt;</span><span class="n">char16_t</span><span class="p">,</span> <span class="n">N</span><span class="o">&gt;</span><span class="p">;</span>
</pre></div>
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;type_traits&gt;</span>
<span class="cp">#include &lt;sprout/string.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="k">using</span> <span class="n">type</span> <span class="o">=</span> <span class="n">u16string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">;</span>
<span class="n">static_assert</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">is_same</span><span class="o">&lt;</span><span class="n">type</span><span class="o">::</span><span class="n">value_type</span><span class="p">,</span> <span class="n">char16_t</span><span class="o">&gt;::</span><span class="n">value</span><span class="p">,</span> <span class="s">&quot;element type of u16string is char16_t.&quot;</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="header">
<h2>Header<a class="headerlink" href="#header" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">sprout/string/alias.hpp</span></tt></div>
<div class="line">Convenience header: <tt class="docutils literal"><span class="pre">sprout/string.hpp</span></tt></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="u32string.html" title="u32string"
>next</a> |</li>
<li class="right" >
<a href="wstring.html" title="wstring"
>previous</a> |</li>
<li><a href="../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../index.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" >Sprout.String</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013, Bolero MURAKAMI.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>

163
docs/libs/string/u32string.html Normal file
View file

@ -0,0 +1,163 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-43764535-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<title>u32string &mdash; Sprout 1.0 documentation</title>
<link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="Sprout 1.0 documentation" href="../../index.html" />
<link rel="up" title="Sprout.String" href="index.html" />
<link rel="next" title="swap" href="basic_string/swap-global.html" />
<link rel="prev" title="u16string" href="u16string.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="basic_string/swap-global.html" title="swap"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="u16string.html" title="u16string"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../index.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Sprout.String</a> &raquo;</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">u32string</a><ul>
<li><a class="reference internal" href="#interface">Interface</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#header">Header</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="u16string.html"
title="previous chapter">u16string</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="basic_string/swap-global.html"
title="next chapter">swap</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/libs/string/u32string.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="u32string">
<h1>u32string<a class="headerlink" href="#u32string" title="Permalink to this headline"></a></h1>
<div class="section" id="interface">
<h2>Interface<a class="headerlink" href="#interface" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="k">template</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">N</span><span class="o">&gt;</span>
<span class="k">using</span> <span class="n">u32string</span> <span class="o">=</span> <span class="n">sprout</span><span class="o">::</span><span class="n">basic_string</span><span class="o">&lt;</span><span class="n">char32_t</span><span class="p">,</span> <span class="n">N</span><span class="o">&gt;</span><span class="p">;</span>
</pre></div>
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;type_traits&gt;</span>
<span class="cp">#include &lt;sprout/string.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="k">using</span> <span class="n">type</span> <span class="o">=</span> <span class="n">u32string</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">;</span>
<span class="n">static_assert</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">is_same</span><span class="o">&lt;</span><span class="n">type</span><span class="o">::</span><span class="n">value_type</span><span class="p">,</span> <span class="n">char32_t</span><span class="o">&gt;::</span><span class="n">value</span><span class="p">,</span> <span class="s">&quot;element type of u32string is char32_t.&quot;</span><span class="p">);</span>
</pre></div>
</div>
</div>
<div class="section" id="header">
<h2>Header<a class="headerlink" href="#header" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">sprout/string/alias.hpp</span></tt></div>
<div class="line">Convenience header: <tt class="docutils literal"><span class="pre">sprout/string.hpp</span></tt></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="basic_string/swap-global.html" title="swap"
>next</a> |</li>
<li class="right" >
<a href="u16string.html" title="u16string"
>previous</a> |</li>
<li><a href="../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../index.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" >Sprout.String</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013, Bolero MURAKAMI.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>

163
docs/libs/string/wstring.html Normal file
View file

@ -0,0 +1,163 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-43764535-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<title>wstring &mdash; Sprout 1.0 documentation</title>
<link rel="stylesheet" href="../../_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="Sprout 1.0 documentation" href="../../index.html" />
<link rel="up" title="Sprout.String" href="index.html" />
<link rel="next" title="u16string" href="u16string.html" />
<link rel="prev" title="string" href="string.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="u16string.html" title="u16string"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="string.html" title="string"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../index.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Sprout.String</a> &raquo;</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">wstring</a><ul>
<li><a class="reference internal" href="#interface">Interface</a></li>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#header">Header</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="string.html"
title="previous chapter">string</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="u16string.html"
title="next chapter">u16string</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/libs/string/wstring.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="wstring">
<h1>wstring<a class="headerlink" href="#wstring" title="Permalink to this headline"></a></h1>
<div class="section" id="interface">
<h2>Interface<a class="headerlink" href="#interface" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="k">template</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">size_t</span> <span class="n">N</span><span class="o">&gt;</span>
<span class="k">using</span> <span class="n">wstring</span> <span class="o">=</span> <span class="n">sprout</span><span class="o">::</span><span class="n">basic_string</span><span class="o">&lt;</span><span class="kt">wchar_t</span><span class="p">,</span> <span class="n">N</span><span class="o">&gt;</span><span class="p">;</span>
</pre></div>
</div>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="highlight-c++"><div class="highlight"><pre><span class="cp">#include &lt;type_traits&gt;</span>
<span class="cp">#include &lt;sprout/string.hpp&gt;</span>
<span class="k">using</span> <span class="k">namespace</span> <span class="n">sprout</span><span class="p">;</span>
<span class="k">using</span> <span class="n">type</span> <span class="o">=</span> <span class="n">wstring</span><span class="o">&lt;</span><span class="mi">8</span><span class="o">&gt;</span><span class="p">;</span>
<span class="n">static_assert</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">is_same</span><span class="o">&lt;</span><span class="n">type</span><span class="o">::</span><span class="n">value_type</span><span class="p">,</span> <span class="kt">wchar_t</span><span class="o">&gt;::</span><span class="n">value</span><span class="p">,</span> <span class="s">&quot;element type of wstring is charwchar_t</span>
</pre></div>
</div>
</div>
<div class="section" id="header">
<h2>Header<a class="headerlink" href="#header" title="Permalink to this headline"></a></h2>
<div class="line-block">
<div class="line"><tt class="docutils literal"><span class="pre">sprout/string/alias.hpp</span></tt></div>
<div class="line">Convenience header: <tt class="docutils literal"><span class="pre">sprout/string.hpp</span></tt></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="u16string.html" title="u16string"
>next</a> |</li>
<li class="right" >
<a href="string.html" title="string"
>previous</a> |</li>
<li><a href="../../index.html">Sprout 1.0 documentation</a> &raquo;</li>
<li><a href="../index.html" >Libraries</a> &raquo;</li>
<li><a href="index.html" >Sprout.String</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2013, Bolero MURAKAMI.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>

2
docs/searchindex.js
View file

File diff suppressed because one or more lines are too long

29
source/libs/string/string.rst Normal file
View file

@ -0,0 +1,29 @@
.. _sprout-string-basic_string-string:
###############################################################################
string
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<std::size_t N>
using string = sprout::basic_string<char, N>;
Examples
========================================
.. sourcecode:: c++
#include <type_traits>
#include <sprout/string.hpp>
using namespace sprout;
using type = string<8>;
static_assert(std::is_same<type::value_type, char>::value, "element type of string is char.");
Header
========================================
| ``sprout/string/alias.hpp``
| Convenience header: ``sprout/string.hpp``

29
source/libs/string/u16string.rst Normal file
View file

@ -0,0 +1,29 @@
.. _sprout-string-basic_string-u16string:
###############################################################################
u16string
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<std::size_t N>
using u16string = sprout::basic_string<char16_t, N>;
Examples
========================================
.. sourcecode:: c++
#include <type_traits>
#include <sprout/string.hpp>
using namespace sprout;
using type = u16string<8>;
static_assert(std::is_same<type::value_type, char16_t>::value, "element type of u16string is char16_t.");
Header
========================================
| ``sprout/string/alias.hpp``
| Convenience header: ``sprout/string.hpp``

29
source/libs/string/u32string.rst Normal file
View file

@ -0,0 +1,29 @@
.. _sprout-string-basic_string-u32string:
###############################################################################
u32string
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<std::size_t N>
using u32string = sprout::basic_string<char32_t, N>;
Examples
========================================
.. sourcecode:: c++
#include <type_traits>
#include <sprout/string.hpp>
using namespace sprout;
using type = u32string<8>;
static_assert(std::is_same<type::value_type, char32_t>::value, "element type of u32string is char32_t.");
Header
========================================
| ``sprout/string/alias.hpp``
| Convenience header: ``sprout/string.hpp``

29
source/libs/string/wstring.rst Normal file
View file

@ -0,0 +1,29 @@
.. _sprout-string-basic_string-wstring:
###############################################################################
wstring
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<std::size_t N>
using wstring = sprout::basic_string<wchar_t, N>;
Examples
========================================
.. sourcecode:: c++
#include <type_traits>
#include <sprout/string.hpp>
using namespace sprout;
using type = wstring<8>;
static_assert(std::is_same<type::value_type, wchar_t>::value, "element type of wstring is charwchar_t
Header
========================================
| ``sprout/string/alias.hpp``
| Convenience header: ``sprout/string.hpp``