mirror of
https://github.com/boostorg/static_string.git
synced 2025-07-29 20:17:35 +02:00
Renamed from fixed_string to static_string, added aliases
This commit is contained in:
16
doc/Jamfile
16
doc/Jamfile
@ -5,7 +5,7 @@
|
||||
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
#
|
||||
|
||||
project fixed_string/doc ;
|
||||
project static_string/doc ;
|
||||
|
||||
import os ;
|
||||
import path ;
|
||||
@ -23,7 +23,7 @@ import saxonhe ;
|
||||
# docs can be rebuild if any of the header files change.
|
||||
#
|
||||
|
||||
local sources = [ path.glob-tree ../include/boost/fixed_string : *.hpp *.ipp : detail impl ] ;
|
||||
local sources = [ path.glob-tree ../include/boost/static_string : *.hpp *.ipp : detail impl ] ;
|
||||
|
||||
# Get the configured paths to doxygen and xsltproc
|
||||
|
||||
@ -148,12 +148,12 @@ install qbk : reference.qbk ;
|
||||
install images
|
||||
:
|
||||
:
|
||||
<location>html/fixed_string/images
|
||||
<location>html/static_string/images
|
||||
;
|
||||
|
||||
explicit images ;
|
||||
|
||||
xml fixed_string_doc
|
||||
xml static_string_doc
|
||||
:
|
||||
qbk/main.qbk
|
||||
:
|
||||
@ -161,7 +161,7 @@ xml fixed_string_doc
|
||||
<dependency>qbk
|
||||
;
|
||||
|
||||
explicit fixed_string_doc ;
|
||||
explicit static_string_doc ;
|
||||
|
||||
#-------------------------------------------------------------------------------
|
||||
#
|
||||
@ -169,9 +169,9 @@ explicit fixed_string_doc ;
|
||||
#
|
||||
#-------------------------------------------------------------------------------
|
||||
|
||||
boostbook fixed_string
|
||||
boostbook static_string
|
||||
:
|
||||
fixed_string_doc
|
||||
static_string_doc
|
||||
:
|
||||
<xsl:param>boost.root=../../../..
|
||||
<xsl:param>chapter.autolabel=1
|
||||
@ -195,5 +195,5 @@ boostbook fixed_string
|
||||
alias boostdoc ;
|
||||
explicit boostdoc ;
|
||||
|
||||
alias boostrelease : fixed_string ;
|
||||
alias boostrelease : static_string ;
|
||||
explicit boostrelease ;
|
||||
|
@ -7,10 +7,10 @@
|
||||
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
||||
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
|
||||
Official repository: https://github.com/boostorg/fixed_string
|
||||
Official repository: https://github.com/boostorg/static_string
|
||||
-->
|
||||
|
||||
<section id="fixed_string.index">
|
||||
<section id="static_string.index">
|
||||
<title>Index</title>
|
||||
<index/>
|
||||
</section>
|
||||
|
@ -5,11 +5,11 @@
|
||||
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
||||
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
|
||||
Official repository: https://github.com/boostorg/fixed_string
|
||||
Official repository: https://github.com/boostorg/static_string
|
||||
]
|
||||
|
||||
[library Boost.FixedString
|
||||
[id fixed_string]
|
||||
[library Boost.StaticString
|
||||
[id static_string]
|
||||
[quickbook 1.6]
|
||||
[copyright 2016 - 2019 Vinnie Falco]
|
||||
[copyright 2019 Krystian Stasiowski]
|
||||
@ -30,7 +30,6 @@
|
||||
|
||||
[template path_link[path name] '''<ulink url="../../'''[path]'''">'''[name]'''</ulink>''']
|
||||
[template include_file[path][^<'''<ulink url="../../../../'''[path]'''">'''[path]'''</ulink>'''>]]
|
||||
[template issue[n] '''<ulink url="https://github.com/boostorg/beast/issues/'''[n]'''">#'''[n]'''</ulink>''']
|
||||
|
||||
[def __InputIterator__ [@https://en.cppreference.com/w/cpp/named_req/InputIterator ['InputIterator]]]
|
||||
|
||||
@ -73,16 +72,16 @@ The over-arching design goal is to resemble the interface and behavior of
|
||||
maximum allowed size of the string, `std::length_error` is thrown. All
|
||||
algorithms which throw exceptions provide the strong exception safety
|
||||
guarantee. This is intended to be a drop in replacement for `std::string`.
|
||||
All the operations for `fixed_string` work when the source is within the string itself.
|
||||
All the operations for `static_string` work when the source is within the string itself.
|
||||
|
||||
The API of `fixed_string` only diverges from `std::string` in few places,
|
||||
being `substr` for which this implementation returns a string view instead of `fixed_string`,
|
||||
The API of `static_string` only diverges from `std::string` in few places,
|
||||
being `substr` for which this implementation returns a string view instead of `static_string`,
|
||||
and certain functions that will never throw are marked as `noexcept`, which diverges from
|
||||
those of `std::string`. Every function that is in the C++20 specification of `std::string` is
|
||||
present in this implementation, with the only difference being the lack of `constexpr`
|
||||
for the time being. The avaliable overloads for `fixed_string` are identical to those
|
||||
for the time being. The avaliable overloads for `static_string` are identical to those
|
||||
of `std::string`, except for `operator+` which is explicitly deleted as no reasonable implementation
|
||||
would be possible, due to the difficulty in determining the size of the resulting `fixed_string`.
|
||||
would be possible, due to the difficulty in determining the size of the resulting `static_string`.
|
||||
|
||||
[endsect]
|
||||
|
||||
|
@ -7,7 +7,7 @@
|
||||
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
||||
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
||||
|
||||
Official repository: https://github.com/boostorg/fixed_string
|
||||
Official repository: https://github.com/boostorg/static_string
|
||||
-->
|
||||
|
||||
<informaltable frame="all">
|
||||
|
@ -3,7 +3,7 @@
|
||||
#---------------------------------------------------------------------------
|
||||
|
||||
INPUT = \
|
||||
$(LIB_DIR)/include/boost/fixed_string
|
||||
$(LIB_DIR)/include/boost/static_string
|
||||
|
||||
ALIASES += esafe="@par Exception Safety"
|
||||
|
||||
@ -43,7 +43,7 @@ SKIP_FUNCTION_MACROS = YES
|
||||
# Project related configuration options
|
||||
#---------------------------------------------------------------------------
|
||||
DOXYFILE_ENCODING = UTF-8
|
||||
PROJECT_NAME = "FixedString"
|
||||
PROJECT_NAME = "StaticString"
|
||||
PROJECT_NUMBER =
|
||||
PROJECT_BRIEF = String Library
|
||||
PROJECT_LOGO =
|
||||
|
@ -1,6 +1,6 @@
|
||||
<!-- Variables (Edit for your project) -->
|
||||
<xsl:variable name="doc-ref" select="'fixed_string.ref.'"/>
|
||||
<xsl:variable name="doc-ns" select="'boost::fixed_string'"/>
|
||||
<xsl:variable name="doc-ref" select="'static_string.ref.'"/>
|
||||
<xsl:variable name="doc-ns" select="'boost::static_string'"/>
|
||||
<xsl:variable name="debug" select="0"/>
|
||||
<xsl:variable name="private" select="0"/>
|
||||
<!-- End Variables -->
|
||||
|
Reference in New Issue
Block a user