30 Input/output library [input.output]

30.10 File systems [filesystems]

30.10.27 Class path [fs.class.path]

30.10.27.4 path members [fs.path.member]

30.10.27.4.9 path decomposition [fs.path.decompose]

path root_name() const;

1
#

Returns: root-name, if the pathname in the generic format includes root-name, otherwise path().

path root_directory() const;

2
#

Returns: root-directory, if the pathname in the generic format includes root-directory, otherwise path().

path root_path() const;

3
#

Returns: root_­name() / root_­directory().

path relative_path() const;

4
#

Returns: A path composed from the pathname in the generic format, if !empty(), beginning with the first filename after root-path. Otherwise, path().

path parent_path() const;

5
#

Returns: *this if !has_­relative_­path(), otherwise a path whose generic format pathname is the longest prefix of the generic format pathname of *this that produces one fewer element in its iteration.

path filename() const;

6
#

Returns: relative_­path().empty() ? path() : *--end().

7
#

[ Example: 

path("/foo/bar.txt").filename();   // yields "bar.txt"
path("/foo/bar").filename();       // yields "bar"
path("/foo/bar/").filename();      // yields ""
path("/").filename();              // yields ""
path("//host").filename();         // yields ""
path(".").filename();              // yields "."
path("..").filename();             // yields ".."

 — end example ]

path stem() const;

8
#

Returns: Let f be the generic format pathname of filename(). Returns a path whose pathname in the generic format is

  • (8.1)

    f, if it contains no periods other than a leading period or consists solely of one or two periods;

  • (8.2)

    otherwise, the prefix of f ending before its last period.

9
#

[ Example: 

std::cout << path("/foo/bar.txt").stem(); // outputs "bar"
path p = "foo.bar.baz.tar";
for (; !p.extension().empty(); p = p.stem())
  std::cout << p.extension() << '\n';
  // outputs: .tar
  //          .baz
  //          .bar

 — end example ]

path extension() const;

10
#

Returns: a path whose pathname in the generic format is the suffix of filename() not included in stem().

11
#

[ Example: 

path("/foo/bar.txt").extension();  // yields ".txt" and stem() is "bar"
path("/foo/bar").extension();      // yields "" and stem() is "bar"
path("/foo/.profile").extension(); // yields "" and stem() is ".profile"
path(".bar").extension();          // yields "" and stem() is ".bar"
path("..bar").extension();         // yields ".bar" and stem() is "."

 — end example ]

12
#

[ Note: The period is included in the return value so that it is possible to distinguish between no extension and an empty extension.  — end note ]

13
#

[ Note: On non-POSIX operating systems, for a path p, it may not be the case that p.stem() + p.extension() == p.filename(), even though the generic format pathnames are the same.  — end note ]