////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2016 by EMC Corporation, All Rights Reserved
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
///     http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is EMC Corporation
///
/// @author Andrey Abramov
/// @author Vasiliy Nabatchikov
////////////////////////////////////////////////////////////////////////////////

#pragma once

#include <functional>

#include "shared.hpp"
#include "store/directory_attributes.hpp"
#include "utils/string.hpp"

namespace irs {

struct directory;

//////////////////////////////////////////////////////////////////////////////
/// @class directory_cleaner
/// @brief represents a cleaner for directory files without any references
//////////////////////////////////////////////////////////////////////////////

class directory_cleaner {
 public:
  typedef std::function<bool(std::string_view)> removal_acceptor_t;

  // @param acceptor returns if removal candidates should actually be removed
  // @return count of files removed
  static size_t clean(
    directory& dir,
    const removal_acceptor_t& acceptor = [](std::string_view) -> bool {
      return true;
    });
};

}  // namespace irs
