Directory.h

/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "IDirectory.h"

#include <functional>
#include <memory>
#include <string>

class CFileItem;

namespace XFILE
{
class CDirectory
{
public:
  CDirectory(void);
  virtual ~CDirectory(void);

  class CHints
  {
  public:
    std::string mask;
    int flags = DIR_FLAG_DEFAULTS;
  };

  static bool GetDirectory(const CURL& url
                           , CFileItemList &items
                           , const std::string &strMask
                           , int flags);

  static bool GetDirectory(const CURL& url,
                           const std::shared_ptr<IDirectory>& pDirectory,
                           CFileItemList& items,
                           const CHints& hints);

  static bool GetDirectory(const CURL& url
                           , CFileItemList &items
                           , const CHints &hints);

  static bool Create(const CURL& url);
  static bool Exists(const CURL& url, bool bUseCache = true);
  static bool Remove(const CURL& url);
  static bool RemoveRecursive(const CURL& url);

  static bool GetDirectory(const std::string& strPath
                           , CFileItemList &items
                           , const std::string &strMask
                           , int flags);

  static bool GetDirectory(const std::string& strPath,
                           const std::shared_ptr<IDirectory>& pDirectory,
                           CFileItemList& items,
                           const std::string& strMask,
                           int flags);

  static bool GetDirectory(const std::string& strPath
                           , CFileItemList &items
                           , const CHints &hints);

  using DirectoryEnumerationCallback = std::function<void(const std::shared_ptr<CFileItem>& item)>;
  using DirectoryFilter = std::function<bool(const std::shared_ptr<CFileItem>& folder)>;

  static bool EnumerateDirectory(
      const std::string& path,
      const DirectoryEnumerationCallback& callback,
      const DirectoryFilter& filter = [](const std::shared_ptr<CFileItem>&) { return true; },
      bool fileOnly = false,
      const std::string& mask = "",
      int flags = DIR_FLAG_DEFAULTS);

  static bool Create(const std::string& strPath);
  static bool Exists(const std::string& strPath, bool bUseCache = true);
  static bool Remove(const std::string& strPath);
  static bool RemoveRecursive(const std::string& strPath);

  static void FilterFileDirectories(CFileItemList &items, const std::string &mask,
                                    bool expandImages=false);
};
}