All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
utils.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 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 #ifndef JS_UTILS_H
25 #define JS_UTILS_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/base/js/api.h"
31 #include "pxr/base/js/value.h"
32 
33 #include <boost/none.hpp>
34 #include <boost/optional.hpp>
35 #include <string>
36 
37 PXR_NAMESPACE_OPEN_SCOPE
38 
39 typedef boost::optional<JsValue> JsOptionalValue;
40 
45 JS_API
46 JsOptionalValue JsFindValue(
47  const JsObject& object,
48  const std::string& key,
49  const JsOptionalValue& defaultValue = boost::none);
50 
51 PXR_NAMESPACE_CLOSE_SCOPE
52 
53 #endif // JS_UTILS_H
JS_API JsOptionalValue JsFindValue(const JsObject &object, const std::string &key, const JsOptionalValue &defaultValue=boost::none)
Returns the value associated with key in the given object.