FileUtils.h

Go to the documentation of this file.

// This file is part of CoreLibrary containing useful reusable utility
// classes.
//
// Copyright (C) 2014 to present, Duncan Crutchley
// Contact <dac1976github@outlook.com>
//
// 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 General Public License and GNU Lesser General Public License
// for more details.
//
// You should have received a copy of the GNU General Public License
// and GNU Lesser General Public License along with this program. If
// not, see <http://www.gnu.org/licenses/>.

#ifndef FILEUTILS
#define FILEUTILS

#include <string>
#include <list>
#include "CoreLibraryDllGlobal.h"
#include "Platform/PlatformDefines.h"

namespace core_lib
{
namespace file_utils
{

bool CORE_LIBRARY_DLL_SHARED_API FindFileRecursively(const std::wstring& dirPath,
                                                     const std::wstring& fileName,
                                                     std::wstring&       pathFound,
                                                     bool                includeFileName = true);

std::wstring CORE_LIBRARY_DLL_SHARED_API FindCommonRootPath(const std::wstring& path1,
                                                            const std::wstring& path2);

enum class eCopyDirectoryOptions
{
    failIfTargetExists,
    continueIfTargetExists
};

void CORE_LIBRARY_DLL_SHARED_API CopyDirectoryRecursively(
    const std::wstring& source, const std::wstring& target,
    eCopyDirectoryOptions options = eCopyDirectoryOptions::continueIfTargetExists);

std::list<std::wstring> CORE_LIBRARY_DLL_SHARED_API
                        ListDirectoryContents(const std::wstring& path, const std::wstring& extMatch = L"");

std::list<std::wstring> CORE_LIBRARY_DLL_SHARED_API ListSubDirectories(const std::wstring& path);

} // namespace file_utils
} // namespace core_lib

#endif // FILEUTILS