1 //
2 // Copyright (C) 2014 The Android Open Source Project
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 //      http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 //
16 
17 #ifndef UPDATE_ENGINE_UPDATE_MANAGER_POLICY_UTILS_H_
18 #define UPDATE_ENGINE_UPDATE_MANAGER_POLICY_UTILS_H_
19 
20 #include "update_engine/update_manager/policy.h"
21 
22 // Checks that the passed pointer value is not null, returning kFailed on the
23 // current context and setting the *error description when it is null. The
24 // intended use is to validate variable failures while using
25 // EvaluationContext::GetValue, for example:
26 //
27 //   const int* my_value = ec->GetValue(state->my_provider()->var_my_value());
28 //   POLICY_CHECK_VALUE_AND_FAIL(my_value, error);
29 //
30 #define POLICY_CHECK_VALUE_AND_FAIL(ptr, error) \
31     do { \
32       if ((ptr) == nullptr) { \
33         *(error) = #ptr " is required but is null."; \
34         return EvalStatus::kFailed; \
35       } \
36     } while (false)
37 
38 #endif  // UPDATE_ENGINE_UPDATE_MANAGER_POLICY_UTILS_H_
39