Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tdegeus/cpppath
Simple file-path module for C++
https://github.com/tdegeus/cpppath
cpp path
Last synced: 25 days ago
JSON representation
Simple file-path module for C++
- Host: GitHub
- URL: https://github.com/tdegeus/cpppath
- Owner: tdegeus
- License: mit
- Created: 2018-04-25T06:53:10.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-06-24T15:26:08.000Z (over 2 years ago)
- Last Synced: 2024-09-30T00:03:00.941Z (about 1 month ago)
- Topics: cpp, path
- Language: C++
- Size: 44.9 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cpppath
[](https://github.com/tdegeus/cpppath/actions)
[](https://anaconda.org/conda-forge/cpppath)
Simple, header only, file-path module for C++ similar to `os` in Python. This module is nothing fancy, but it might be helpful to accomplish some simple tasks.
## Contents
- [Disclaimer](#disclaimer)
- [Getting cpppath](#getting-cpppath)
- [Using conda](#using-conda)
- [From source](#from-source)
- [Usage](#usage)
- [Compiling](#compiling)
- [Using CMake](#using-cmake)
- [Using pkg-config](#using-pkg-config)
- [By hand](#by-hand)
- [Overview](#overview)
- [cpppath::sep](#cpppathsep)
- [cpppath::dirname](#cpppathdirname)
- [cpppath::filename](#cpppathfilename)
- [cpppath::filebase](#cpppathfilebase)
- [cpppath::splitext](#cpppathsplitext)
- [cpppath::ext](#cpppathext)
- [cpppath::split](#cpppathsplit)
- [cpppath::join](#cpppathjoin)
- [cpppath::select](#cpppathselect)
- [cpppath::normpath](#cpppathnormpath)
- [cpppath::commonprefix](#cpppathcommonprefix)
- [cpppath::commondirname](#cpppathcommondirname)
- [cpppath::exists](#cpppathexists)
- [cpppath::curdir](#cpppathcurdir)
# Disclaimer
This library is free to use under the [MIT license](https://github.com/tdegeus/cpppath/blob/master/LICENSE). Any additions are very much appreciated, in terms of suggested functionality, code, documentation, testimonials, word-of-mouth advertisement, etc. Bug reports or feature requests can be filed on [GitHub](https://github.com/tdegeus/cpppath). As always, the code comes with no guarantee. None of the developers can be held responsible for possible mistakes.
Download: [.zip file](https://github.com/tdegeus/cpppath/zipball/master) | [.tar.gz file](https://github.com/tdegeus/cpppath/tarball/master).
(c - [MIT](https://github.com/tdegeus/cpppath/blob/master/LICENSE)) T.W.J. de Geus (Tom) | [email protected] | www.geus.me | [github.com/tdegeus/cpppath](https://github.com/tdegeus/cpppath)
# Getting cpppath
## Using conda
```bash
conda install -c conda-forge cpppath
```
## From source
```bash
# Download cpppath
git checkout https://github.com/tdegeus/cpppath.git
cd cpppath
# For CMake or pkg-config use
cmake .
make install
```
# Usage
This library is header only, so one just has to
```cpp
#include
```
and make sure that the header is in the include path of the compiler. See below.
Consider this micro-example:
```cpp
#include
int main()
{
std::cout << cpppath::join({"path", "to", "foo", "bar.txt"}) << std::endl;
return 0;
}
```
which will print
* Unix: `"path/to/foo/bar.txt"`
* Windows: `"path\to\foo\bar.txt"`
> All functions take the file-path separator as argument to allow customisation. To overwrite the library-wide default `/` on Unix and `\` use:
>
> ```cpp
> #define CPPPATH_SEP "/"
> ```
>
> **before** including *cpppath* for the first time.
# Compiling
## Using CMake
The `CMakeLists.txt` can be as follows
```cmake
cmake_minimum_required(VERSION 3.1)
project(example)
find_package(cpppath REQUIRED)
add_executable(example example.cpp)
target_link_libraries(example PRIVATE cpppath)
```
Compilation can then proceed using
* Unix:
```
cmake .
make
```
* Windows:
```none
cmake -G"NMake Makefiles" .
nmake
```
## Using pkg-config
Presuming that the compiler is `c++`, compile using (Unix):
```
c++ `pkg-config --cflags cpppath` ...
```
## By hand
Presuming that the compiler is `c++`, compile using (Unix):
```
c++ -I/path/to/cpppath/include ...
```
# Overview
## cpppath::sep
Get OS's separator.
* Unix: `"/"`
* Windows: `"\\"`
## cpppath::dirname
Get dirname part of a path.
Depending on the path, an empty string may be returned.
Example:
```cpp
std::cout << cpppath::dirname("/path/to/foo/bar.txt") << std::endl;
```
outputs:
```
"/path/to/foo"
```
## cpppath::filename
Get filename part of a path.
Depending on the path, an empty string may be returned.
Example:
```cpp
std::cout << cpppath::filename("/path/to/foo/bar.txt") << std::endl;
```
outputs:
```
"bar.txt"
```
## cpppath::filebase
Get filename part of a path, *without extension*.
Depending on the path, an empty string may be returned.
Example:
```cpp
std::cout << cpppath::filebase("/path/to/foo/bar.txt") << std::endl;
```
outputs:
```
"bar"
```
## cpppath::splitext
Split the pathname path into a pair `(root, ext)` such that `root + ext == path`,
and `ext` is empty or begins with a period and contains at most one period.
Leading periods on the basename are ignored; `cpppath::splitext(".cshrc")` returns `{".cshrc", ""}`.
## cpppath::ext
Get the extension of a path.
Depending on the path, an empty string may be returned.
Example:
```cpp
std::cout << cpppath::ext("/path/to/foo/bar.txt") << std::endl;
```
outputs:
```
"txt"
```
## cpppath::split
Split sub-paths using the separator. The output is a list of path components.
Optionally the list can be sliced as `cpppath::split(path, begin, end)` (Python equivalent: `os.split(path)[begin: end]`). Negative indices may be used to that count from the right (instead of from the left).
## cpppath::join
Join path components using separator.
Provides option to prepend the output string with the separator.
## cpppath::select
Selection of sub-paths (see `split`). Negative indices may be used to that count from the right (instead of from the left).
Example 1:
```cpp
std::cout << cpppath::select("/path/to/foo/bar.txt", 2) << std::endl;
```
outputs
```
"foo/bar.txt"
```
Example 2:
```cpp
std::cout << select("/path/to/foo/bar.txt", 2, 3) << std::endl;
```
outputs
```
"foo"
```
## cpppath::normpath
Normalize a path by collapsing redundant separators and up-level references so that `A//B`, `A/B/`, `A/./B` and `A/foo/../B` all become `A/B`. This string manipulation may change the meaning of a path that contains symbolic links.
## cpppath::commonprefix
Select the common part of a list of strings. For example:
```cpp
std::vector paths = {"/path/to/id=000/file.txt", "/path/to/id=001/file.txt"};
std::cout << cpppath::commonprefix(paths) << std::endl;
```
outputs
```
"/path/to/id=00"
```
## cpppath::commondirname
Select the common path of a list of paths. For example:
```cpp
std::vector paths = {"/path/to/id=000/file.txt", "/path/to/id=001/file.txt"};
std::cout << cpppath::commondirname(paths) << std::endl;
```
outputs
```
"/path/to"
```
This can also be used to select the part of the paths that in unique to each string. For example:
```cpp
std::vector paths = {"/path/to/id=000/file.txt", "/path/to/id=001/file.txt"};
std::cout << cpppath::split(paths[0], cpppath::commondirname(paths)+"/")[0] << std::endl;
```
outputs
```
"id=000/file.txt"
```
## cpppath::exists
Returns `true` is the `path` exists.
## cpppath::curdir
The current working directory.