filesystemDiscoveryHelpers.h

Go to the documentation of this file.

//
// Copyright 2018 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
 
#ifndef PXR_USD_NDR_FILESYSTEM_DISCOVERY_HELPERS_H
#define PXR_USD_NDR_FILESYSTEM_DISCOVERY_HELPERS_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/tf/envSetting.h"
#include "pxr/usd/ndr/api.h"
#include "pxr/usd/ndr/declare.h"
#include "pxr/usd/ndr/nodeDiscoveryResult.h"
 
#include <functional>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class NdrDiscoveryPluginContext;
 
 
NDR_API
extern TfEnvSetting<std::string> PXR_NDR_FS_PLUGIN_SEARCH_PATHS;
 
NDR_API
extern TfEnvSetting<std::string> PXR_NDR_FS_PLUGIN_ALLOWED_EXTS;
 
NDR_API
extern TfEnvSetting<bool> PXR_NDR_FS_PLUGIN_FOLLOW_SYMLINKS;
 
using NdrParseIdentifierFn = std::function<
    bool (const TfToken &identifier, 
          TfToken *family,
          TfToken *name,
          NdrVersion *version)>;
 
NDR_API 
bool
NdrFsHelpersSplitShaderIdentifier(
    const TfToken &identifier, 
    TfToken *family,
    TfToken *name,
    NdrVersion *version);
 
NDR_API
NdrNodeDiscoveryResultVec
NdrFsHelpersDiscoverNodes(
    const NdrStringVec& searchPaths,
    const NdrStringVec& allowedExtensions,
    bool followSymlinks = true,
    const NdrDiscoveryPluginContext* context = nullptr,
    const NdrParseIdentifierFn &parseIdentifierFn = 
        NdrFsHelpersSplitShaderIdentifier
);
 
struct NdrDiscoveryUri 
{
    std::string uri;
    std::string resolvedUri;
};
 
using NdrDiscoveryUriVec = std::vector<NdrDiscoveryUri>;
 
NDR_API
NdrDiscoveryUriVec
NdrFsHelpersDiscoverFiles(
    const NdrStringVec& searchPaths,
    const NdrStringVec& allowedExtensions,
    bool followSymlinks = true
);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_NDR_FILESYSTEM_DISCOVERY_HELPERS_H