Navegação do Sistema de Ficheiros

O cabeçalho C++17 <filesystem> fornece tipos e funções que permitem escrever código independente da plataforma para navegar no sistema de ficheiros. Por ser multiplataforma, contém APIs que não são relevantes para sistemas Windows. Por exemplo, is_fifo(const path&) devolve false sempre no Windows.

Overview

Use as <filesystem> APIs para as seguintes tarefas:

• iterar sobre ficheiros e diretórios sob um caminho especificado

• Obtenha informações sobre ficheiros, incluindo a hora de criação, tamanho, extensão e diretório raiz

• compor, decompor e comparar caminhos

• criar, copiar e eliminar diretórios

• copiar e eliminar ficheiros

Para mais informações sobre E/S de Ficheiros usando a Biblioteca Padrão, consulte Programação iostream.

Paths

Construção e composição de caminhos

Os caminhos no Windows (desde o XP) são armazenados nativamente no Unicode. A path turma faz automaticamente todas as conversões de cordas necessárias. Aceita argumentos tanto de matrizes de caracteres amplos como estreitos, e ambos std::string os tipos std::wstring e formatados como UTF8 ou UTF16. A path classe também normaliza automaticamente os separadores de caminho. Pode usar uma única barra direta como separador de diretórios nos argumentos dos construtores. Este separador permite-lhe usar as mesmas strings para armazenar caminhos tanto em ambientes Windows como UNIX:

path pathToDisplay(L"/FileSystemTest/SubDir3");     // OK!
path pathToDisplay2(L"\\FileSystemTest\\SubDir3");  // Still OK as always
path pathToDisplay3(LR"(\FileSystemTest\SubDir3)"); // Raw string literals are OK, too.

Para concatenar dois caminhos, pode-se usar os operadores e sobrecarregados/, que são análogos aos + operadores e += em std::string e std::wstring./= O path objeto fornecerá convenientemente os separadores se não o fizeres.

path myRoot("C:/FileSystemTest");  // no trailing separator, no problem!
myRoot /= path("SubDirRoot");      // C:/FileSystemTest/SubDirRoot

Examinar caminhos

A classe path tem vários métodos que retornam informação sobre várias partes do próprio caminho. Esta informação é distinta da informação sobre a entidade do sistema de ficheiros a que possa referir-se. Podes obter a raiz, o caminho relativo, o nome do ficheiro, a extensão do ficheiro e mais. Podes iterar sobre um objeto path para examinar todas as pastas na hierarquia. O exemplo seguinte mostra como iterar sobre um objeto de caminho. E como recuperar informações sobre as suas peças.

// filesystem_path_example.cpp
// compile by using: /EHsc /W4 /permissive- /std:c++17 (or later)
#include <string>
#include <iostream>
#include <sstream>
#include <filesystem>

using namespace std;
using namespace std::filesystem;

wstring DisplayPathInfo()
{
    // This path may or may not refer to an existing file. We are
    // examining this path string, not file system objects.
    path pathToDisplay(L"C:/FileSystemTest/SubDir3/SubDirLevel2/File2.txt ");

    wostringstream wos;
    int i = 0;
    wos << L"Displaying path info for: " << pathToDisplay << endl;
    for (path::iterator itr = pathToDisplay.begin(); itr != pathToDisplay.end(); ++itr)
    {
        wos << L"path part: " << i++ << L" = " << *itr << endl;
    }

    wos << L"root_name() = " << pathToDisplay.root_name() << endl
        << L"root_path() = " << pathToDisplay.root_path() << endl
        << L"relative_path() = " << pathToDisplay.relative_path() << endl
        << L"parent_path() = " << pathToDisplay.parent_path() << endl
        << L"filename() = " << pathToDisplay.filename() << endl
        << L"stem() = " << pathToDisplay.stem() << endl
        << L"extension() = " << pathToDisplay.extension() << endl;

    return wos.str();
}

int main()
{
    wcout << DisplayPathInfo() << endl;
    // wcout << ComparePaths() << endl; // see following example
    wcout << endl << L"Press Enter to exit" << endl;
    wstring input;
    getline(wcin, input);
}

O código produz esta saída:

Displaying path info for: C:\FileSystemTest\SubDir3\SubDirLevel2\File2.txt
path part: 0 = C:
path part: 1 = \
path part: 2 = FileSystemTest
path part: 3 = SubDir3
path part: 4 = SubDirLevel2
path part: 5 = File2.txt
root_name() = C:
root_path() = C:\
relative_path() = FileSystemTest\SubDir3\SubDirLevel2\File2.txt
parent_path() = C:\FileSystemTest\SubDir3\SubDirLevel2
filename() = File2.txt
stem() = File2
extension() = .txt

Comparação de caminhos

A path classe sobrecarrega os mesmos operadores de comparação que std::string e std::wstring. Quando comparas dois caminhos, fazes uma comparação de cadeias depois de os separadores terem sido normalizados. Se falta uma barra final (ou barra invertida), não é adicionada, e isso afeta a comparação. O exemplo seguinte demonstra como os valores do caminho se comparam:

wstring ComparePaths()
{
    path p0(L"C:/Documents");                 // no trailing separator
    path p1(L"C:/Documents/");                // p0 < p1
    path p2(L"C:/Documents/2013/");           // p1 < p2
    path p3(L"C:/Documents/2013/Reports/");   // p2 < p3
    path p4(L"C:/Documents/2014/");           // p3 < p4
    path p5(L"D:/Documents/2013/Reports/");   // p4 < p5

    wostringstream wos;
    wos << boolalpha <<
        p0.wstring() << L" < " << p1.wstring() << L": " << (p0 < p1) << endl <<
        p1.wstring() << L" < " << p2.wstring() << L": " << (p1 < p2) << endl <<
        p2.wstring() << L" < " << p3.wstring() << L": " << (p2 < p3) << endl <<
        p3.wstring() << L" < " << p4.wstring() << L": " << (p3 < p4) << endl <<
        p4.wstring() << L" < " << p5.wstring() << L": " << (p4 < p5) << endl;
    return wos.str();
}

C:\Documents < C:\Documents\: true
C:\Documents\ < C:\Documents\2013\: true
C:\Documents\2013\ < C:\Documents\2013\Reports\: true
C:\Documents\2013\Reports\ < C:\Documents\2014\: true
C:\Documents\2014\ < D:\Documents\2013\Reports\: true

Para executar este código, cola-o no exemplo completo acima main antes e descomenta a linha que o chama no main.

Conversão entre tipos de caminho e de corda

Um path objeto é implicitamente convertível em std::wstring ou std::string. Significa que pode passar um caminho para funções como wofstream::open, como mostrado neste exemplo:

// filesystem_path_conversion.cpp
// compile by using: /EHsc /W4 /permissive- /std:c++17 (or later)
#include <string>
#include <iostream>
#include <fstream>
#include <filesystem>

using namespace std;
using namespace std::filesystem;

int main()
{
    const wchar_t* p{ L"C:/Users/Public/Documents" };
    path filePath(p);

    filePath /= L"NewFile.txt";

    // Open, write to, and close the file.
    wofstream writeFile(filePath, ios::out);  // implicit conversion
    writeFile << L"Lorem ipsum\nDolor sit amet";
    writeFile.close();

    // Open, read, and close the file.
    wifstream readFile;
    wstring line;
    readFile.open(filePath);  // implicit conversions
    wcout << L"File " << filePath << L" contains:" << endl;
    while (readFile.good())
    {
        getline(readFile, line);
        wcout << line << endl;
    }
    readFile.close();

    wcout << endl << L"Press Enter to exit" << endl;
    wstring input;
    getline(wcin, input);
}

File C:\Users\Public\Documents\NewFile.txt contains:
Lorem ipsum
Dolor sit amet

Press Enter to exit

Iteração de diretórios e ficheiros

O <filesystem> cabeçalho fornece o directory_iterator tipo para iterar sobre diretórios individuais, e a recursive_directory_iterator classe para iterar recursivamente sobre um diretório e os seus subdiretórios. Depois de construir um iterador passando-lhe um path objeto, o iterador aponta para a primeira directory_entry no caminho. Crie o iterador final chamando o construtor padrão.

Ao iterar num diretório, há vários tipos de itens que pode descobrir. Estes itens incluem diretórios, ficheiros, ligações simbólicas, ficheiros socket e outros. Devolve directory_iterator os seus itens como directory_entry objetos.