pathutil.hpp

Go to the documentation of this file.

/*
 * libxcks
 * Copyright (C) 2022 Julien Couot
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef INC_PATHUTIL_HPP_9D26D187_64D9_4224_8014_C7452B64B9EA
#define INC_PATHUTIL_HPP_9D26D187_64D9_4224_8014_C7452B64B9EA
 
//---------------------------------------------------------------------------
#include <filesystem>
//#include <vector>  // Included in "libxcks/types.hpp"
//#include <string>  // Included in "libxcks/types.hpp"
 
#include "libxcks/types.hpp"
//---------------------------------------------------------------------------
 
 
namespace libxcks
{
// Gets directories of a path.
std::vector<std::filesystem::path> getDirectories(const std::filesystem::path& p);
 
// Gets directories of a path.
ArrayString getDirectoriesAsArrayString(const std::filesystem::path& p);
//---------------------------------------------------------------------------
 
 
// Compares two file names.
int compareFileName(const std::string& fn1, const std::string& fn2);
 
// Compares file names of two paths.
int compareFileName(const std::filesystem::path& p1, const std::filesystem::path& p2);
//---------------------------------------------------------------------------
 
 
// Constructs a path from an array of directories and an optional filename.
std::filesystem::path constructPath(const ArrayString& dirs, const std::string& filename = std::string());
 
// Ensures the path ends with a path separator.
std::filesystem::path ensureEndsWithPathSeparator(const std::filesystem::path& p);
//---------------------------------------------------------------------------
 
 
// Checks if the name of the file is valid.
bool isFileNameValid(const std::string& filename);
//---------------------------------------------------------------------------
}  // namespace libxcks
//---------------------------------------------------------------------------
 
#endif  // INC_PATHUTIL_HPP_9D26D187_64D9_4224_8014_C7452B64B9EA