HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
filesystemDiscoveryHelpers.h
Go to the documentation of this file.
1 //
2 // Copyright 2018 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 
25 #ifndef PXR_USD_NDR_FILESYSTEM_DISCOVERY_HELPERS_H
26 #define PXR_USD_NDR_FILESYSTEM_DISCOVERY_HELPERS_H
27 
28 /// \file ndr/filesystemDiscoveryHelpers.h
29 
30 #include "pxr/pxr.h"
31 #include "pxr/usd/ndr/api.h"
32 #include "pxr/usd/ndr/declare.h"
34 
36 
38 
39 /// \file filesystemDiscoveryHelpers.h
40 ///
41 /// Provides utilities that the default filesystem discovery plugin uses. If
42 /// a custom filesystem discovery plugin is needed, these can be used to fill
43 /// in a large chunk of the functionality.
44 ///
45 
46 /// Walks the specified search paths, optionally following symlinks. Paths
47 /// are walked recursively, and each directory has `FsHelpersExamineFiles()`
48 /// called on it. Only files that match one of the provided extensions (case
49 /// insensitive) are candidates for being turned into `NdrDiscoveryResult`s.
50 /// Returns a vector of discovery results that have been found while walking
51 /// the search paths. In each result the name and identifier will be the
52 /// same, the version will be invalid and default, and the family will
53 /// be empty. The caller is expected to adjust these as appropriate. A
54 /// naive client with no versions and no family will work correctly.
55 NDR_API
58  const NdrStringVec& searchPaths,
59  const NdrStringVec& allowedExtensions,
60  bool followSymlinks = true,
61  const NdrDiscoveryPluginContext* context = nullptr
62 );
63 
65 
66 #endif // PXR_USD_NDR_FILESYSTEM_DISCOVERY_HELPERS_H
std::vector< NdrNodeDiscoveryResult > NdrNodeDiscoveryResultVec
NDR_API NdrNodeDiscoveryResultVec NdrFsHelpersDiscoverNodes(const NdrStringVec &searchPaths, const NdrStringVec &allowedExtensions, bool followSymlinks=true, const NdrDiscoveryPluginContext *context=nullptr)
std::vector< std::string > NdrStringVec
Definition: declare.h:79
#define NDR_API
Definition: api.h:40
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91