std::filesystem::canonical, std::filesystem::weakly_canonical

 

C++

Compiler-Unterstützung

Freestanding und gehostet

Sprache

Standardbibliothek

Header der Standardbibliothek

Benannte Anforderungen

Feature-Test-Makros (C++20)

Bibliothek für Sprachunterstützung

Konzepte-Bibliothek (C++20)

Diagnostik-Bibliothek

Speicherverwaltungsbibliothek

Metaprogrammierungsbibliothek (C++11)

Allgemeine Dienstprogramme-Bibliothek

Container-Bibliothek

Iterator-Bibliothek

Ranges-Bibliothek (C++20)

Algorithmen-Bibliothek

Bibliothek für Zeichenketten

Textverarbeitungsbibliothek

Numerik-Bibliothek

Datums- und Zeitbibliothek

Ein-/Ausgabe-Bibliothek

Dateisystembibliothek (C++17)

Unterstützung für nebenläufige Programmierung (C++11)

Ausführungssteuerungsbibliothek (C++26)

Technische Spezifikationen

Symbolverzeichnis

Externe Bibliotheken

 

Dateisystem-Bibliothek

Klassen
filesystem::path filesystem::filesystem_error filesystem::directory_entry filesystem::directory_iterator filesystem::recursive_directory_iterator    filesystem::file_status filesystem::space_info	filesystem::file_type filesystem::file_time_type filesystem::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options
Funktionen
filesystem::absolute filesystem::canonicalfilesystem::weakly_canonical filesystem::relativefilesystem::proximate filesystem::copy filesystem::copy_file filesystem::copy_symlink filesystem::create_directory filesystem::create_directories filesystem::create_hard_link filesystem::create_symlink filesystem::create_directory_symlink filesystem::current_path filesystem::temp_directory_path	filesystem::exists filesystem::equivalent filesystem::file_size filesystem::hard_link_count filesystem::last_write_time filesystem::permissions filesystem::read_symlink filesystem::remove filesystem::remove_all filesystem::rename filesystem::resize_file filesystem::space filesystem::status filesystem::symlink_status
Dateitypen
filesystem::is_block_file filesystem::is_character_file filesystem::is_directory filesystem::is_empty filesystem::status_known	filesystem::is_fifo filesystem::is_other filesystem::is_regular_file filesystem::is_socket filesystem::is_symlink

 

Definiert in Header <filesystem>
path canonical( const std::filesystem::path& p );	(1)	(seit C++17)
path canonical( const std::filesystem::path& p,                 std::error_code& ec );	(2)	(seit C++17)
path weakly_canonical( const std::filesystem::path& p );	(3)	(seit C++17)
path weakly_canonical( const std::filesystem::path& p,                        std::error_code& ec );	(4)	(seit C++17)

1,2) Konvertiert den Pfad p in einen kanonischen absoluten Pfad, d.h. einen absoluten Pfad, der keine Punkt-, Punkt-Punkt-Elemente oder symbolischen Links in seiner generischen Formatrepräsentation hat. Wenn p kein absoluter Pfad ist, verhält sich die Funktion so, als ob er zuerst durch std::filesystem::absolute(p) absolut gemacht wird. Der Pfad p muss existieren.

3,4) Gibt einen Pfad zurück, der durch operator/= aus dem Ergebnis des Aufrufs von canonical() mit einem Pfadargument zusammengesetzt wird, das aus den führenden Elementen von p besteht, die existieren (wie von status(p) oder status(p, ec) bestimmt), falls vorhanden, gefolgt von den Elementen von p, die nicht existieren. Der resultierende Pfad befindet sich in der Normalform.

Parameter

p	-	ein Pfad, der absolut oder relativ sein kann; für canonical muss es ein existierender Pfad sein
ec	-	Fehlercode, in dem der Fehlerstatus gespeichert wird

Rückgabewert

1,2) Ein absoluter Pfad, der auf dieselbe Datei wie std::filesystem::absolute(p) aufgelöst wird.

3,4) Ein normaler Pfad der Form canonical(x)/y, wobei x ein Pfad ist, der aus der längsten führenden Sequenz von Elementen in p besteht, die existieren, und y ein Pfad ist, der aus den verbleibenden nachfolgenden nicht existierenden Elementen von p besteht.

Ausnahmen

Jede Überladung, die nicht als noexcept markiert ist, kann std::bad_alloc auslösen, wenn die Speicherzuweisung fehlschlägt.

1,3) Wirft std::filesystem::filesystem_error bei zugrundeliegenden OS-API-Fehlern, konstruiert mit p als erstem Pfadargument und dem OS-Fehlercode als Fehlercodeargument.

2,4) Setzt einen std::error_code&-Parameter auf den OS-API-Fehlercode, wenn ein OS-API-Aufruf fehlschlägt, und führt ec.clear() aus, wenn keine Fehler auftreten.

Hinweise

Die Funktion canonical() ist nach dem POSIX- realpath modelliert.

Die Funktion weakly_canonical() wurde eingeführt, um die operativen Semantiken von relative() zu vereinfachen.

Beispiel

Führen Sie diesen Code aus

#include <filesystem>
#include <iostream>
 
int main()
{
    /* set up sandbox directories:
     a
     └── b
         ├── c1
         │   └── d <== current path
         └── c2
             └── e
    */
    auto old = std::filesystem::current_path();
    auto tmp = std::filesystem::temp_directory_path();
    std::filesystem::current_path(tmp);
    auto d1 = tmp / "a/b/c1/d";
    auto d2 = tmp / "a/b/c2/e";
    std::filesystem::create_directories(d1);
    std::filesystem::create_directories(d2);
    std::filesystem::current_path(d1);
 
    auto p1 = std::filesystem::path("../../c2/./e");
    auto p2 = std::filesystem::path("../no-such-file");
    std::cout << "Current path is "
              << std::filesystem::current_path() << '\n'
              << "Canonical path for " << p1 << " is "
              << std::filesystem::canonical(p1) << '\n'
              << "Weakly canonical path for " << p2 << " is "
              << std::filesystem::weakly_canonical(p2) << '\n';
    try
    {
        [[maybe_unused]] auto x_x = std::filesystem::canonical(p2);
        // NOT REACHED
    }
    catch (const std::exception& ex)
    {
        std::cout << "Canonical path for " << p2 << " threw exception:\n"
                  << ex.what() << '\n';
    }
 
    // cleanup
    std::filesystem::current_path(old);
    const auto count = std::filesystem::remove_all(tmp / "a");
    std::cout << "Deleted " << count << " files or directories.\n";
}

Mögliche Ausgabe

Current path is "/tmp/a/b/c1/d"
Canonical path for "../../c2/./e" is "/tmp/a/b/c2/e"
Weakly canonical path for "../no-such-file" is "/tmp/a/b/c1/no-such-file"
Canonical path for "../no-such-file" threw exception:
filesystem error: in canonical: No such file or directory [../no-such-file] [/tmp/a/b/c1/d]
Deleted 6 files or directories.

Fehlermeldungen

Die folgenden Verhaltensändernden Fehlerberichte wurden rückwirkend auf zuvor veröffentlichte C++-Standards angewendet.

DR	angewendet auf	Verhalten wie veröffentlicht	Korrigiertes Verhalten
LWG 2956	C++17	canonical hat einen überflüssigen base-Parameter	entfernt

Siehe auch

path (C++17)	repräsentiert einen Pfad (Klasse)
absolute (C++17)	komponiert einen absoluten Pfad (Funktion)
relativeproximate (C++17)	komponiert einen relativen Pfad (Funktion)