//
// Copyright (c) 2023 Alan de Freitas (alandefreitas@gmail.com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
//
// Official repository: https://github.com/boostorg/url
//

= Segments

Hierarchical schemes often interpret the path as a slash-delimited sequence of percent-encoded strings called segments.
In this library the segments may be accessed using these separate, bidirectional view types which reference the underlying URL:

[cols="1,1,3"]
|===
// Headers
|Type|Accessor|Description

// Row 1, Column 1
|cpp:segments_view[]
// Row 1, Column 2
|cpp:url_view_base::segments[segments]
// Row 1, Column 3
|A read-only range of decoded segments.

// Row 2, Column 1
|cpp:segments_ref[]
// Row 2, Column 2
|cpp:url_view_base::segments[segments]
// Row 2, Column 3
|A modifiable range of decoded segments.

// Row 3, Column 1
|cpp:segments_encoded_view[]
// Row 3, Column 2
|cpp:url_view_base::encoded_segments[encoded_segments]
// Row 3, Column 3
|A read-only range of segments.

// Row 4, Column 1
|cpp:segments_encoded_ref[]
// Row 4, Column 2
|cpp:url_view_base::encoded_segments[encoded_segments]
// Row 4, Column 3
|A modifiable range of segments.

|===

First we observe these invariants about paths and segments:

* All URLs have a path
* A path is absolute, relative, or empty
* Paths starting with "/" are absolute
* A relative path can never follow an authority
* Every path maps to a unique range of segments, plus a cpp:bool[] indicating if the path is absolute.
* Every range of segments, plus a cpp:bool[] indicating if the path is absolute, maps to a unique path.

The following URL contains a path with three segments: "path", "to", and "file.txt":

[source]
----
http://www.example.com/path/to/file.txt
----

To understand the relationship between the path and segments, we define this function `segs` which returns a list of strings corresponding to the elements in a container of segments:


[source,cpp]
----
include::example$unit/doc_3_urls.cpp[tag=code_container_4_1,indent=0]
----

In this table we show the result of invoking `segs` with different paths.
This demonstrates how the library achieves the invariants described above for various interesting cases:

[cols="3,3,1"]
|===
// Headers
|`s`|`segs( s )`|absolute

// Row 1, Column 1
|`""`
// Row 1, Column 2
|`{ }`
// Row 1, Column 3
|

// Row 2, Column 1
|`"/"`
// Row 2, Column 2
|`{ }`
// Row 2, Column 3
|yes

// Row 3, Column 1
|`"./"`
// Row 3, Column 2
|`{ "" }`
// Row 3, Column 3
|

// Row 4, Column 1
|`"usr"`
// Row 4, Column 2
|`{ "usr" }`
// Row 4, Column 3
|

// Row 5, Column 1
|`"./usr"`
// Row 5, Column 2
|`{ "usr" }`
// Row 5, Column 3
|

// Row 6, Column 1
|`"/index.htm"`
// Row 6, Column 2
|`{ "index.htm" }`
// Row 6, Column 3
|yes

// Row 7, Column 1
|`"/images/cat-pic.gif"`
// Row 7, Column 2
|`{ "images", "cat-pic.gif" }`
// Row 7, Column 3
|yes

// Row 8, Column 1
|`"images/cat-pic.gif"`
// Row 8, Column 2
|`{ "images", "cat-pic.gif" }`
// Row 8, Column 3
|

// Row 9, Column 1
|`"/fast//query"`
// Row 9, Column 2
|`{ "fast", "", "query" }`
// Row 9, Column 3
|yes

// Row 10, Column 1
|`"fast//"`
// Row 10, Column 2
|`{ "fast", "", "" }`
// Row 10, Column 3
|

// Row 11, Column 1
|`"/./"`
// Row 11, Column 2
|`{ "" }`
// Row 11, Column 3
|yes

// Row 12, Column 1
|`".//"`
// Row 12, Column 2
|`{ "", "" }`
// Row 12, Column 3
|

|===

This implies that two paths may map to the same sequence of segments. In the paths `usr` and `./usr`, the `./` is a prefix that might be necessary to maintain the invariant that instances of cpp:url_view_base[] always refer to valid URLs.
Thus, both paths map to `{ "usr" }`.
On the other hand, each sequence determines a unique path for a given URL.
For instance, setting the segments to `{"a"}` would always map to either `./a` or `a`, depending on whether the "." prefix is necessary to keep the URL valid.

Sequences don't iterate the leading "." when it's necessary to keep the URL valid.
Thus, when we assign `{ "x", "y", "z" }` to segments, the sequence always contains `{ "x", "y", "z" }` after that.
It never contains `{ ".", "x", "y", "z" }` because the `.` needed to be included.
In other words, the contents of the segment container are authoritative, and the path string is a function of them.
Not vice-versa.

Library algorithms which modify individual segments of the path or set the entire path attempt to behave consistently with the behavior expected as if the operation was performed on the equivalent sequence.
If a path maps, say, to the three element sequence `{ "a", "b", "c" }` then erasing the middle segment should result in the sequence `{ "a", "c" }`.
The library always strives to do exactly what the caller requests; however, in some cases this would result in either an invalid URL, or a dramatic and unwanted change in the URL's semantics.

For example consider the following URL:

[source,cpp]
----
url u = url().set_path( "kyle:xy" );
----

The library produces the URL string `kyle%3Axy` and not `kyle:xy`, because the latter would have an unintended scheme.
The table below demonstrates the results achieved by performing various modifications to a URL containing a path:

//     Functions which may need
//     to alter the path prefix:
// 
//     * convert ':' to %3A
//         remove_scheme()
// 
//     * add "/."
//         remove_authority()
// 
//     * convert ':' to %3A or add "/."
//         remove_origin()
// 
//     * convert %3A to ':'
//         set_scheme_impl()
//             set_scheme()
//             set_scheme_id()
// 
//     * convert ':' to %3A
//     * convert %3A to ':'
//         set_path_absolute()
// 
//     * convert ':' to %3A or add "/."
//         set_path()
// 
//     * don't canonicalize %3A in segment-nc-nz
//         normalize()
// 
//     ????
//         set_encoded_path()
//         edit_segments()

[cols="1,1,1"]
|===
// Headers
|URL|Operation|Result

// Row 1, Column 1
|"info:kyle:xy"
// Row 1, Column 2
|cpp:boost::urls::url::remove_scheme[`remove_scheme()`]
// Row 1, Column 3
|"kyle%3Axy"

// Row 2, Column 1
|"kyle%3Axy"
// Row 2, Column 2
|cpp:boost::urls::url::set_scheme[`set_scheme( "gopher" )`]
// Row 2, Column 3
|"gopher:kyle:xy"

// Row 3, Column 1
|"http://www.example.com//kyle:xy"
// Row 3, Column 2
|cpp:boost::urls::url::remove_authority[`remove_authority()`]
// Row 3, Column 3
|"http:/.//kyle:xy"

// Row 4, Column 1
|"//www.example.com//kyle:xy"
// Row 4, Column 2
|cpp:boost::urls::url::remove_authority[`remove_authority()`]
// Row 4, Column 3
|"/.//kyle:xy"

// Row 5, Column 1
|"http://www.example.com//kyle:xy"
// Row 5, Column 2
|cpp:boost::urls::url::remove_origin[`remove_origin()`]
// Row 5, Column 3
|"/.//kyle:xy"

// Row 6, Column 1
|"info:kyle:xy"
// Row 6, Column 2
|cpp:boost::urls::url::remove_origin[`remove_origin()`]
// Row 6, Column 3
|"kyle%3Axy"

// Row 7, Column 1
|"/kyle:xy"
// Row 7, Column 2
|cpp:boost::urls::url::set_path_absolute[`set_path_absolute( false )`]
// Row 7, Column 3
|"kyle%3Axy"

// Row 8, Column 1
|"kyle%3Axy"
// Row 8, Column 2
|cpp:boost::urls::url::set_path_absolute[`set_path_absolute( true )`]
// Row 8, Column 3
|"/kyle:xy"

// Row 9, Column 1
|""
// Row 9, Column 2
|cpp:boost::urls::url::set_path[`set_path( "kyle:xy" )`]
// Row 9, Column 3
|"kyle%3Axy"

// Row 10, Column 1
|""
// Row 10, Column 2
|cpp:boost::urls::url::set_path[`set_path( "//foo/fighters.txt" )`]
// Row 10, Column 3
|"/.//foo/fighters.txt"

// Row 11, Column 1
|"my%3Asharona/billa%3Abong"
// Row 11, Column 2
|cpp:boost::urls::url::normalize[`normalize()`]
// Row 11, Column 3
|"my%3Asharona/billa:bong"

// Row 12, Column 1
|"./my:sharona"
// Row 12, Column 2
|cpp:boost::urls::url::normalize[`normalize()`]
// Row 12, Column 3
|"my%3Asharona"

|===

For the complete set of containers and functions for operating on paths and segments, please consult the reference.

[CAUTION]
====
The functions cpp:url_view_base::path[`path`] and cpp:url_base::set_path[`set_path`] for decoded paths as a whole cannot round-trip correctly when there's an encoded `%2F` in one of the segments because the corresponding decoded `/` character would be used as a separator between path segments.

If a segment itself contains an encoded `/`, it would be interpreted as a path separator when re-encoding, making it impossible to distinguish between actual separators and encoded `/` characters.

For lossless round-tripping, use the cpp:url_base::encoded_path[`encoded_path`], cpp:boost::urls::url_base::set_encoded_path[`set_encoded_path`],  cpp:boost::urls::url_base::segments[`segments`], or cpp:boost::urls::url_base::encoded_segments[`encoded_segments`] API.
====
