hcs-url

This C++17 header-only library which is capable of parsing and resolving URLs (URIs) quickly as defined in the RFC 3968.

Small. Fast. Header-only.

Example:

#include <iostream>
#include <headcode/url/url.hpp>

using namespace headcode::url;

int main(int argc, char ** argv) {

    URL url{"https://www.example.com/path/to/resource?foo&bar=1337"};
    std::cout
        << url.GetScheme()                  // Yields: "https"
        << url.GetHost()                    // Yields: "www.example.com"
        << url.GetPath()                    // Yields: "/path/to/resource"
        << url.GetPathPart(2)               // Yields: "/path/to"
        << url.GetQuery()                   // Yields: "foo&bar=1337"
        << url.GetQueryItems()[1]           // Yields: "bar=1337"
        << std::endl;
    
    return 0;
}

Philosophy

All headcode.space software follows these directives in that order:

Provide very high quality C++ software: the software does what it is meant to do and never ever crashes or reports false results. It has a minimum of 90% testing code coverage. That's the topmost goal.
Provide appealing C++ software, i.e. software which is easily read and understood. Second goal.
Provide software with super minimal public interfaces. I try to really provide the absolute minimum without any bloat. The users of the software should only include the main header file (e.g. #include <headcode/logger/logger.hpp>) and nothing else. These are self-contained and rely only on C++ standard headers. No additional 3rd party headers required. Third goal.
Provide libraries and binaries with little to no runtime dependencies. Yet, linkage might require additional libraries (sometimes from headcode.space sometimes else). Whenever possible I strive to go for the static libraries, because a) the resulting binaries when linked against these libraries have little to no runtime dependency and can be installed directly with a mere copy and b) they are smaller too, since the linkers tend to strip off stuff which is not needed.
In reverse, using and headcode.space library or software should not impose and intrusive dependencies on this particular software. It should be fairly easy to replace this software with something else.
Be performant. Yes, speed is impressive too.

I'm by no means perfect. There's always room for improvements and there are sure still bugs. If you have any suggestions please drop in an email at https://gitlab.com/headcode.space/url/-/issues.

SonarQube instance for hcs-benchmark: https://sonar.ddns.headcode.space/dashboard?id=hcs-url.

The API

There's not really much to say about the API. It's really small and centers around the URL class. The basic idea is, that you create an object of this class by providing a string as an url to parse. All is handled internally as std::string_view and indexes into the given string.

So, basically it is this:

    auto s = "https://some.web-site.com";
    headcode::url::URL url{s};
    ...

An error can be checked with this:

    auto s = "https://    some.web-site.com";
    headcode::url::URL url{s};
    if (url.GetError() != ParseError::kNoError) {
        std::cerr << "Meehhh... bad url." << std::endl;
    }
    ...

Oh, and there are some convenient methods too, like path segments and path parts as well as query parameter splitting.

General methods	Description
`std::string const & GetURL() const`	Gets the URL passed.
`ParseError GetError() const`	Returns the parsing error.
`bool IsValid() const`	Checks if the URL passed in is valid.

Accessor methods	Description
`std::string_view GetAuthority() const`	Returns the authority of the URL.
`std::string_view GetFragment() const`	Returns the fragment of the URL.
`std::string_view GetHost() const`	Returns the host of the URL.
`std::string_view GetPath() const`	Returns the full path of the URL.
`std::string_view GetPathPart(std::size_t n) const`	Returns the path up to the n-th segment of the URL.
`std::string_view GetPort() const`	Returns the port of the URL.
`std::string_view GetQuery() const`	Returns the full query of the URL.
`std::vector<std::string_view> GetQueryItems() const`	Returns the collection of parsed query items of the URL.
`std::string_view GetScheme() const`	Returns the scheme of the URL.
`std::vector<std::string_view> GetSegments() const`	Returns the collection of parsed path segments.
`std::string_view GetUserInfo() const`	Returns the user info within the authority.

Observer methods	Description
`bool IsFragmentPresent() const`	Checks if there is a fragment part.
`bool IsPathAbsolute() const`	Returns `true` if the path is absolute.
`bool IsQueryPresent() const`	Checks if there is a query part.

Operation	Description
`URL Normalize() const`	Normalizes the URL (expensive).

Project layout

.
├── cmake                       CMake additional files.
├── include                     Public header files. Add this folder to your C++ search path.
│   └── headcode                
│       └── url                 Here is the main include: <headcode/url/url.hpp>
├── src                         Main sources.
│   └── lib                     Static libhcs-url.a sources.
├── test                        Tests.
│   ├── benchmark               Benchmark tests.
│   ├── shared                  Shared test data files.
│   └── unit                    Unit tests.
├── tools                       Various tools for run-time or build-time.
│   ├── conan                   Conan package manager files.
│   ├── docker                  Dockerfiles for various platforms to build.
│   └── package                 Package related files.
├── Changes.md                  Changes file.
├── CMakeLists.txt              The overall CMakeLists.txt.
├── conanfile.txt               Conan package file.
├── Doxyfile                    Doxgen API documentation configuration.
├── LICENSE.txt                 The software license.
└── README.md                   This file.

Installation

I provide binary installation packages for some operating systems here.

Build

Dependencies

cmake
gcc (with g++) or clang (witch clang++)
git
make
doxygen (with graphviz)
conan (Conan package manger)
optional: ninja-build (as an alternative to make)

When cloning this project execute the following to clone submodules as well:

$ git submodule init
$ git submodule update

or simply clone with the --recurse-submodule option:

$ git clone --recurse-submodules

You may collect and install all dependencies on your own or use the conan system. For the latter setup conan (initial one-time; skip this if you have prepared conan locally already) to bind to libstdc++11 ABI and add the official GitLab.com as remote:

$ conan profile new default --detect
$ conan profile update settings.compiler.libcxx=libstdc++11 default
$ conan remote add gitlab https://gitlab.com/api/v4/packages/conan

Native build

hcs-url is a cmake project with out-of-source builds in a dedicated folder, usually labeled "build".

$ mkdir build && cd build
$ cmake ..
$ make

or with ninja installed:

$ mkdir build && cd build
$ cmake -GNinja ..
$ ninja

Docker build images

The tools/docker folder contains Dockerfiles along with necessary software to be installed into the docker containers to create docker builder containers. These docker containers should be capable to build the software.

The build target docker_images will build these images, provided the docker command is found on the system and the SHELL environment variable points to some POSIX like shell (bash, sh, zsh, ...). The variable DOCKER_TAG will be used as docker container tags.

Example:

$ cd build
$ cmake -GNinja -D DOCKER_TAG=foo
...
$ ninja docker_images
...
$ docker images | grep foo
REPOSITORY            TAG             IMAGE ID       CREATED         SIZE
foo                   debian-buster   5db480e2bcd8   2 minutes ago   810MB
foo                   fedora32        7f87de7b5e7b   2 minutes ago   1.48GB
foo                   ubuntu-focal    64b74231cd90   2 minutes ago   885MB

Then launch a docker builder like this:

$ docker run -it --rm --name foo-builder foo:debian-buster /bin/bash
root@d192869e6fe6:/build#

In second terminal copy all sources into the container and run a "native" build there:

$ cd PROJECT-SOURCES
$ docker cp . foo-builder:/build

Test

After compilation run ctest

$ cd build
$ ctest

$ cd build
$ make test

or with ninja installed:

$ cd build
$ ninja test

Note: Please check the test files for documentation. The tests are easy to read and tell you how the code is intended to be used.

Test Coverage

You may also run in-deep test coverage profiling. For this, you have to turn on profiling mode:

$ cd build
$ cmake -D PROFILING_MODE_ENABLED=on ..

Then compile as usual and run the tests. After the tests make the run-gcovr target:

$ make test
$ make run-gcovr

or with ninja installed:

$ ninja test
$ ninja run-gcovr

This will give you the test coverage on stdout as well as:

gcovr-coverage.info: this is the coverage info file created by gcovr
gcovr-report.xml: this is the gcovr report file in xml
coverge-html: this is the folder in which detailed html info of collected coverage resides (open up the file coverage-html/index.html in a browser of your choice)

in the build folder.

Installable system package creation

This project supports the creation of DEB and RPM files. This is done by specifying the CPACK_GENERATOR while configuring the project.

To create an installable DEB:

$ cd build
$ cmake -D CMAKE_BUILD_TYPE=Release -D CPACK_GENERATOR=DEB ..
...
$ make
...
$ make package

(or use ninja in place of make if you use the Ninja generator)

To create an installable RPM:

$ cd build
$ cmake -D CMAKE_BUILD_TYPE=Release -D CPACK_GENERATOR=RPM ..
...
$ make
...
$ make package

(or use ninja in place of make if you use the Ninja generator)

Conan packages

To create and install conan packages locally, call

$ cd build
$ make conan

You may want to tweak the package labeling by setting CONAN_USER and CONAN_CHANNEL arguments in cmake call prior like this:

$ cd build
$ cmake -D CONAN_USER=${USER} -D CONAN_CHANNEL="testing" ..
$ make conan

Notable guidelines

Coding Guidelines: https://google.github.io/styleguide/cppguide.html
How (not) to write git commit messages: https://www.codelord.net/2015/03/16/bad-commit-messages-hall-of-shame/
How to version your software: https://semver.org/
How to write a clever "Changes" file: https://keepachangelog.com/en/1.0.0/
Folder Convention: https://github.com/KriaSoft/Folder-Structure-Conventions

scherer-michael/hcs-url

hcs-url

Philosophy

The API

Project layout

Installation

Build

Dependencies

Native build

Docker build images

Test

Test Coverage

Installable system package creation

Conan packages

Notable guidelines