RAUL  0.5.1
Public Member Functions | Static Public Member Functions | List of all members
Raul::Symbol Class Reference

A restricted string (C identifier, which is a component of a path). More...

#include <Symbol.hpp>

Public Member Functions

 Symbol (const std::basic_string< char > &symbol)
 Construct a Symbol from an std::string. More...
 
 Symbol (const char *csymbol)
 Construct a Symbol from a C string. More...
 

Static Public Member Functions

static bool is_valid (const std::basic_string< char > &path)
 
static std::string symbolify (const std::basic_string< char > &str)
 

Detailed Description

A restricted string (C identifier, which is a component of a path).

A Symbol is an lv2-compliant symbol, which is also valid as a component of a URI, filesystem or OSC path, programming language identifier, etc.

Constructor & Destructor Documentation

Raul::Symbol::Symbol ( const std::basic_string< char > &  symbol)
inline

Construct a Symbol from an std::string.

It is a fatal error to construct a Symbol from an invalid string, use is_valid first to check.

Raul::Symbol::Symbol ( const char *  csymbol)
inline

Construct a Symbol from a C string.

It is a fatal error to construct a Symbol from an invalid string, use is_valid first to check.


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