Debian Codegraph @

LspCpp/third_party/uri/README.rst

raw
1 .. :Authors: Glyn Matthews <[email protected]>
2 .. :Date: Jan 01, 2013
3 .. :Description: Source code for the cpp-netlib URI class.
4
5 ###################
6 Deprecation warning
7 ###################
8
9 This library is still missing some features (including full Unicode
10 support), and does not work on some of the newest compiler versions.
11 Therefore, please prefer to use the
12 `WhatWG URL implementation`_ that
13 is intended to supersede this library.
14
15 .. _`WhatWG URL implementation`: https://github.com/cpp-netlib/url
16
17 ################
18 C++ Network URI
19 ################
20
21 .. image:: https://travis-ci.org/cpp-netlib/uri.png?branch=master
22 :target: https://travis-ci.org/cpp-netlib/uri
23
24 .. image:: https://ci.appveyor.com/api/projects/status/rjt0nbbtdhsjdjv4?svg=true
25 :target: https://ci.appveyor.com/project/glynos/uri-6fkuc
26
27 .. image:: https://img.shields.io/badge/license-boost-blue.svg
28 :target: https://github.com/cpp-netlib/uri/blob/master/LICENSE_1_0.txt
29
30 This project contains the source code that was originally meant to
31 track the proposal for a C++ URI at
32 http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n3975.html
33
34 This package provides:
35
36 * A ``network::uri`` class that implements a generic URI parser,
37 compatible with `RFC 3986`_ and `RFC 3987`_
38 * Accessors to the underlying URI parts
39 * A range-compatible interface
40 * Methods to normalize and compare URIs
41 * Percent encoding and decoding functions
42 * A URI builder to build consistent URIs from parts, including
43 case, percent encoding and path normalization
44
45 .. _`RFC 3986`: http://tools.ietf.org/html/rfc3986
46 .. _`RFC 3987`: http://tools.ietf.org/html/rfc3987
47
48 Building the project
49 ====================
50
51 Building with ``CMake``
52 -----------------------
53
54 ::
55
56 $ mkdir _build
57 $ cd _build
58 $ cmake ..
59 $ make -j4
60
61 Running the tests with ``CTest``
62 --------------------------------
63
64 ::
65
66 $ ctest
67
68 License
69 =======
70
71 This library is released under the Boost Software License (please see
72 http://boost.org/LICENSE_1_0.txt or the accompanying LICENSE_1_0.txt
73 file for the full text.
74
75 Contact
76 =======
77
78 Any questions about this library can be addressed to the cpp-netlib
79 `developers mailing list`_. Issues can be filed using Github at
80 http://github.com/cpp-netlib/uri/issues.
81
82 .. _`developers mailing list`: [email protected]