The class fc::Local is used to encapsulate local directories or files.
More...
#include <FCPath.hpp>
The class fc::Local is used to encapsulate local directories or files.
◆ ~Local()
◆ Local()
| fc::Local::Local |
( |
const std::string & |
n | ) |
|
|
explicit |
◆ setDefaultDir()
| void fc::Local::setDefaultDir |
( |
const std::string & |
dir | ) |
const |
|
virtual |
Set the default directory.
Will ensure it is terminated by a slash or backslash.
- See also
- fc::Name::defaultDir()
- Warning
- This has been deprecated as of 2020-08. Setting a default directory was causing a problem when interpreting relative paths.
Implements fc::Name.
◆ defaultDir()
| const std::string & fc::Local::defaultDir |
( |
| ) |
const |
|
virtual |
Get the default directory.
This is guaranteed to be terminated by a slash or backslash.
- See also
- fc::Name::setDefaultDir()
- Warning
- This has been deprecated as of 2020-08. Setting a default directory was causing a problem when interpreting relative paths.
Implements fc::Name.
◆ separator()
| const std::string & fc::Local::separator |
( |
| ) |
const |
|
virtual |
◆ operator+()
| fc::Local fc::Local::operator+ |
( |
const std::string & |
name | ) |
const |
|
virtual |
◆ empty()
| virtual bool fc::Name::empty |
( |
| ) |
const |
|
inlinevirtualinherited |
◆ c_str()
| virtual const char* fc::Name::c_str |
( |
| ) |
const |
|
inlinevirtualinherited |
◆ operator const char *()
| virtual fc::Name::operator const char * |
( |
| ) |
const |
|
inlinevirtualinherited |
◆ operator const std::string &()
| virtual fc::Name::operator const std::string & |
( |
| ) |
const |
|
inlinevirtualinherited |
◆ str()
| virtual const std::string& fc::Name::str |
( |
| ) |
const |
|
inlinevirtualinherited |
◆ simplify() [1/2]
Attempt to simplify the path by removing double slashes and things like "../".
◆ simplify() [2/2]
| std::string fc::Name::simplify |
( |
std::string & |
path | ) |
|
|
staticinherited |
Attempt to simplify the path by removing double slashes and things like "../".
◆ operator+=()
| fc::Name & fc::Name::operator+= |
( |
const std::string & |
rhs | ) |
|
|
virtualinherited |
Append a filename to an existing Local or Remote object.
◆ isAbsolute()
| bool fc::Name::isAbsolute |
( |
| ) |
const |
|
virtualinherited |
◆ isRelative()
| bool fc::Name::isRelative |
( |
| ) |
const |
|
virtualinherited |
◆ name()
| const std::string & fc::Name::name |
( |
| ) |
const |
|
virtualinherited |
The original name specified when this object was first instantiated.
You probably want to use full() instead.
◆ create_temporary_filename()
| std::string fc::Name::create_temporary_filename |
( |
const fc::Options & |
options | ) |
const |
|
virtualinherited |
Create a temporary filename to use based on the prefix and suffix in the given options.
This is intended for internal use by FC++ to generate a usable temporary name, and likely doesn't need to be called directly.
- See also
- fc::Options::setTmpFilenames()
◆ parentDir()
| const std::string & fc::Name::parentDir |
( |
| ) |
const |
|
virtualinherited |
Get the parent directory if known, or a blank string if unknown.
The directory name (if not empty) will always be terminated with / or \. For example:
| Original Name | parentDir() |
| test.txt | |
| ../test.txt | ../ |
| /tmp/foo/bar/name.txt | /tmp/foo/bar/ |
| /testing/123/ | /testing/ |
| / | / |
◆ filename()
| const std::string & fc::Name::filename |
( |
| ) |
const |
|
virtualinherited |
Get the last component in full() which normally would be the filename.
◆ full()
| const std::string & fc::Name::full |
( |
| ) |
const |
|
virtualinherited |
Get the full name.
Most of the time, this is the method you'll want to call to generate a path or filename.
- Returns
- the full name, combined with the default directory when appropriate
◆ findSeparator()
| std::string fc::Name::findSeparator |
( |
| ) |
const |
|
protectedinherited |
Logic to extract the directory separator from the default directory or the explicit name.
◆ clearCache()
|
|
protectedvirtualinherited |
Clear the mutable cache items.
◆ defaultLocalDirectory
| std::string fc::Local::defaultLocalDirectory |
|
staticprotected |
◆ defaultLocalSeparator
| std::string fc::Local::defaultLocalSeparator |
|
staticprotected |
◆ explicitName
| std::string fc::Name::explicitName |
|
protectedinherited |
The name used when the object was instantiated.
◆ fileName
| std::string fc::Name::fileName |
|
mutableprotectedinherited |
the last component from full()
◆ parentDirectory
| std::string fc::Name::parentDirectory |
|
mutableprotectedinherited |
the parent directory including the terminating slash
◆ fullDirAndName
| std::string fc::Name::fullDirAndName |
|
mutableprotectedinherited |
the name combined with the default directory
The documentation for this class was generated from the following files:
1.8.17 
