filesystemDiscovery.h

//
// Copyright 2018 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//

#ifndef PXR_USD_NDR_FILESYSTEM_DISCOVERY_H
#define PXR_USD_NDR_FILESYSTEM_DISCOVERY_H


#include "pxr/pxr.h"
#include "pxr/usd/ndr/api.h"
#include "pxr/usd/ndr/discoveryPlugin.h"
#include <functional>

PXR_NAMESPACE_OPEN_SCOPE

TF_DECLARE_WEAK_AND_REF_PTRS(_NdrFilesystemDiscoveryPlugin);

class _NdrFilesystemDiscoveryPlugin final : public NdrDiscoveryPlugin
{
public:
    using Filter = std::function<bool(NdrNodeDiscoveryResult&)>;

    NDR_API
    _NdrFilesystemDiscoveryPlugin();

    NDR_API
    _NdrFilesystemDiscoveryPlugin(Filter filter);

    NDR_API
    ~_NdrFilesystemDiscoveryPlugin() {}

    NDR_API
    NdrNodeDiscoveryResultVec DiscoverNodes(const Context&) override;

    NDR_API
    const NdrStringVec& GetSearchURIs() const override { return _searchPaths; }

private:
    NdrStringVec _searchPaths;

    NdrStringVec _allowedExtensions;

    bool _followSymlinks;

    // The filter to run on the results.
    Filter _filter;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_USD_NDR_FILESYSTEM_DISCOVERY_H