knowrob::URI Class Reference

#include <URI.h>

Public Member Functions
	URI (std::string_view path)
	URI (const boost::property_tree::ptree &property_tree)
	URI (std::string path, std::string protocol, std::string host, int port)
const auto &	operator() () const
const std::string &	path () const
	URI (std::string_view path)
	URI (const boost::property_tree::ptree &property_tree)
	URI (std::string path, std::string protocol, std::string host, int port)
const auto &	operator() () const
const std::string &	path () const

Static Public Member Functions
static std::string	resolve (const std::string_view &uriString)
static std::optional< std::string >	getHomePath (void)
static std::string	resolve (const std::string_view &uriString)
static std::optional< std::string >	getHomePath (void)

Protected Member Functions
void	updateURI ()
void	updateURI ()

Protected Attributes
std::string	uri_
std::string	path_
boost::optional< std::string >	protocol_
boost::optional< std::string >	host_
boost::optional< int >	port_

Detailed Description

A URI is a uniform resource identifier.

Definition at line 17 of file URI.h.

Constructor & Destructor Documentation

URI() [1/6]

URI::URI ( std::string_view  path )

explicit

Parameters

path	the path of the URI.

Definition at line 19 of file URI.cpp.

        : path_(path) {
    updateURI();
}

URI() [2/6]

URI::URI ( const boost::property_tree::ptree &  property_tree )

explicit

Parameters

property_tree

the property tree to construct the URI from.

Definition at line 32 of file URI.cpp.

                                                     {
    protocol_ = property_tree.get_optional<std::string>("protocol");
    path_ = property_tree.get("path", "/");
    host_ = property_tree.get_optional<std::string>("host");
    port_ = property_tree.get_optional<int>("port");
    updateURI();
}

URI() [3/6]

URI::URI	(	std::string	path,
		std::string	protocol,
		std::string	host,
		int	port
	)

Parameters

path	the path of the URI.
protocol	the protocol of the URI.
host	the host of the URI.
port	the port of the URI.

Definition at line 24 of file URI.cpp.

        : path_(std::move(path)),
          protocol_(std::move(protocol)),
          host_(std::move(host)),
          port_(port) {
    updateURI();
}

URI() [4/6]

knowrob::URI::URI ( std::string_view  path )

explicit

Parameters

path	the path of the URI.

URI() [5/6]

knowrob::URI::URI ( const boost::property_tree::ptree &  property_tree )

explicit

Parameters

property_tree

the property tree to construct the URI from.

URI() [6/6]

knowrob::URI::URI	(	std::string	path,
		std::string	protocol,
		std::string	host,
		int	port
	)

Parameters

path	the path of the URI.
protocol	the protocol of the URI.
host	the host of the URI.
port	the port of the URI.

Member Function Documentation

getHomePath() [1/2]

std::optional< std::string > URI::getHomePath ( void  )

static

Returns

the home path of the current user.

Definition at line 53 of file URI.cpp.

                                            {
#ifdef _WIN32
    auto env_drive = getenv("HOMEDRIVE");
    auto env_path = getenv("HOMEPATH");
    if (env_drive && env_path) {
            return std::string(env_drive) + std::string(env_path);
    } else {
        KB_WARN("Could not determine home directory");
        return std::nullopt;
    }
#else
    auto env_home = getenv("HOME");
    if (env_home) {
        return std::string(env_home);
    } else {
        struct passwd *pw = getpwuid(getuid());
        if (pw) {
            return std::string(pw->pw_dir);
        } else {
            KB_WARN("Could not determine home directory");
            return std::nullopt;
        }
    }
#endif
}

getHomePath() [2/2]

static std::optional<std::string> knowrob::URI::getHomePath ( void  )

static

Returns

the home path of the current user.

operator()() [1/2]

const auto& knowrob::URI::operator() ( ) const

inline

Returns

URI string of this data source.

Definition at line 52 of file URI.h.

{ return uri_; }

operator()() [2/2]

const auto& knowrob::URI::operator() ( ) const

inline

Returns

URI string of this data source.

Definition at line 52 of file URI.h.

{ return uri_; }

path() [1/2]

const std::string& knowrob::URI::path ( ) const

inline

Returns

string identifier of the data format.

Definition at line 57 of file URI.h.

{ return path_; }

path() [2/2]

const std::string& knowrob::URI::path ( ) const

inline

Returns

string identifier of the data format.

Definition at line 57 of file URI.h.

{ return path_; }

resolve() [1/2]

std::string URI::resolve ( const std::string_view &  uriString )

static

Resolves a URI string.

Parameters

uriString

the URI string to resolve.

Returns

the resolved URI string.

Definition at line 79 of file URI.cpp.

                                                      {
    static std::filesystem::path projectPath(KNOWROB_SOURCE_DIR);
    static std::filesystem::path installPath(KNOWROB_INSTALL_PREFIX);
    static std::optional<std::string> homePath(getHomePath());
 
    std::filesystem::path filePath(uriString);
    if (!exists(filePath)) {
        std::vector<std::filesystem::path> possiblePaths;
        // prefer loading from source directory
        possiblePaths.push_back(projectPath / filePath);
        possiblePaths.push_back(projectPath / "src" / filePath);
        // next try loading from home directory
        if (homePath) {
            possiblePaths.push_back(std::filesystem::path(homePath.value()) / ".knowrob" / filePath);
        }
        // lastly try loading from install directory
        possiblePaths.push_back(installPath / "share" / "knowrob" / filePath);
        possiblePaths.push_back(installPath / "lib" / "knowrob" / filePath);
 
        for (const auto &p: possiblePaths) {
            if (exists(p)) return p.u8string();
        }
    }
    return std::string(uriString);
}

resolve() [2/2]

static std::string knowrob::URI::resolve ( const std::string_view &  uriString )

static

Resolves a URI string.

Parameters

uriString

the URI string to resolve.

Returns

the resolved URI string.

updateURI() [1/2]

void URI::updateURI ( )

protected

Definition at line 40 of file URI.cpp.

                    {
    std::stringstream ss;
    if (protocol_ && protocol_.value() != "file") {
        ss << protocol_ << "://";
    }
    if (host_) {
        ss << host_.value();
        if (port_) ss << ':' << port_.value();
    }
    ss << path_;
    uri_ = ss.str();
}

updateURI() [2/2]

void knowrob::URI::updateURI ( )

protected

Member Data Documentation

host_

boost::optional< std::string > knowrob::URI::host_

protected

Definition at line 63 of file URI.h.

path_

std::string knowrob::URI::path_

protected

Definition at line 61 of file URI.h.

port_

boost::optional< int > knowrob::URI::port_

protected

Definition at line 64 of file URI.h.

protocol_

boost::optional< std::string > knowrob::URI::protocol_

protected

Definition at line 62 of file URI.h.

uri_

std::string knowrob::URI::uri_

protected

Definition at line 60 of file URI.h.

---

The documentation for this class was generated from the following files:

• build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/URI.h
• src/URI.cpp