Cleaned up RETURN_IF_XR_FAILED to not require an existing local variable

The RETURN_IF_XR_FAILED macro previously required a local variable to
already exist for it to function correctly. This change removes that
requirement.

Change-Id: Ib0ebb5855abfe8788f906235d2bec95b13eb6655
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1934394
Commit-Queue: Alexander Cooper <alcooper@chromium.org>
Reviewed-by: Alexander Cooper <alcooper@chromium.org>
Cr-Commit-Position: refs/heads/master@{#721069}

device/vr/openxr/openxr_api_wrapper.cc

@@ -159,8 +159,6 @@ XrResult OpenXrApiWrapper::InitializeSystem() {
   DCHECK(HasInstance());
   DCHECK(!HasSystem());
 
-  XrResult xr_result;
-
   XrSystemId system;
   RETURN_IF_XR_FAILED(GetSystem(instance_, &system));
 
@@ -187,7 +185,7 @@ XrResult OpenXrApiWrapper::InitializeSystem() {
   system_ = system;
   view_configs_ = std::move(view_configs);
 
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 XrResult OpenXrApiWrapper::PickEnvironmentBlendMode(XrSystemId system) {
@@ -196,7 +194,6 @@ XrResult OpenXrApiWrapper::PickEnvironmentBlendMode(XrSystemId system) {
       XR_ENVIRONMENT_BLEND_MODE_OPAQUE,
   };
   DCHECK(HasInstance());
-  XrResult xr_result;
 
   uint32_t blend_mode_count;
   RETURN_IF_XR_FAILED(xrEnumerateEnvironmentBlendModes(
@@ -216,7 +213,7 @@ XrResult OpenXrApiWrapper::PickEnvironmentBlendMode(XrSystemId system) {
   }
 
   blend_mode_ = *blend_mode_it;
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 // Callers of this function must check the XrResult return value and destroy
@@ -228,8 +225,6 @@ XrResult OpenXrApiWrapper::InitSession(
   DCHECK(d3d_device.Get());
   DCHECK(IsInitialized());
 
-  XrResult xr_result;
-
   RETURN_IF_XR_FAILED(CreateSession(d3d_device));
   RETURN_IF_XR_FAILED(CreateSwapchain());
   RETURN_IF_XR_FAILED(
@@ -256,7 +251,7 @@ XrResult OpenXrApiWrapper::InitSession(
   DCHECK(HasSpace(XR_REFERENCE_SPACE_TYPE_VIEW));
   DCHECK(input_helper);
 
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 XrResult OpenXrApiWrapper::CreateSession(
@@ -281,8 +276,6 @@ XrResult OpenXrApiWrapper::CreateSwapchain() {
   DCHECK(HasSession());
   DCHECK(!HasColorSwapChain());
 
-  XrResult xr_result;
-
   gfx::Size view_size = GetViewSize();
 
   XrSwapchainCreateInfo swapchain_create_info = {XR_TYPE_SWAPCHAIN_CREATE_INFO};
@@ -318,7 +311,7 @@ XrResult OpenXrApiWrapper::CreateSwapchain() {
 
   color_swapchain_ = color_swapchain;
   color_swapchain_images_ = std::move(color_swapchain_images);
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 XrResult OpenXrApiWrapper::CreateSpace(XrReferenceSpaceType type,
@@ -357,8 +350,6 @@ XrResult OpenXrApiWrapper::BeginFrame(
   DCHECK(HasSession());
   DCHECK(HasColorSwapChain());
 
-  XrResult xr_result;
-
   RETURN_IF_XR_FAILED(ProcessEvents());
 
   XrFrameWaitInfo wait_frame_info = {XR_TYPE_FRAME_WAIT_INFO};
@@ -383,7 +374,7 @@ XrResult OpenXrApiWrapper::BeginFrame(
 
   *texture = color_swapchain_images_[color_swapchain_image_index].texture;
 
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 XrResult OpenXrApiWrapper::EndFrame() {
@@ -393,8 +384,6 @@ XrResult OpenXrApiWrapper::EndFrame() {
   DCHECK(HasSpace(XR_REFERENCE_SPACE_TYPE_LOCAL));
   DCHECK(HasFrameState());
 
-  XrResult xr_result;
-
   XrSwapchainImageReleaseInfo release_info = {
       XR_TYPE_SWAPCHAIN_IMAGE_RELEASE_INFO};
   RETURN_IF_XR_FAILED(xrReleaseSwapchainImage(color_swapchain_, &release_info));
@@ -417,12 +406,10 @@ XrResult OpenXrApiWrapper::EndFrame() {
 
   RETURN_IF_XR_FAILED(xrEndFrame(session_, &end_frame_info));
 
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 XrResult OpenXrApiWrapper::UpdateProjectionLayers() {
-  XrResult xr_result;
-
   RETURN_IF_XR_FAILED(
       LocateViews(XR_REFERENCE_SPACE_TYPE_LOCAL, &origin_from_eye_views_));
   RETURN_IF_XR_FAILED(
@@ -451,15 +438,13 @@ XrResult OpenXrApiWrapper::UpdateProjectionLayers() {
     layer_projection_view.subImage.imageRect.offset.y = 0;
   }
 
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 XrResult OpenXrApiWrapper::LocateViews(XrReferenceSpaceType type,
                                        std::vector<XrView>* views) const {
   DCHECK(HasSession());
 
-  XrResult xr_result;
-
   XrViewState view_state = {XR_TYPE_VIEW_STATE};
   XrViewLocateInfo view_locate_info = {XR_TYPE_VIEW_LOCATE_INFO};
   view_locate_info.viewConfigurationType = kSupportedViewConfiguration;
@@ -494,7 +479,7 @@ XrResult OpenXrApiWrapper::LocateViews(XrReferenceSpaceType type,
     *views = std::move(new_views);
   }
 
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 // Returns the next predicted display time in nanoseconds.
@@ -512,8 +497,6 @@ XrResult OpenXrApiWrapper::GetHeadPose(
   DCHECK(HasSpace(XR_REFERENCE_SPACE_TYPE_LOCAL));
   DCHECK(HasSpace(XR_REFERENCE_SPACE_TYPE_VIEW));
 
-  XrResult xr_result;
-
   XrSpaceLocation view_from_local = {XR_TYPE_SPACE_LOCATION};
   RETURN_IF_XR_FAILED(xrLocateSpace(view_space_, local_space_,
                                     frame_state_.predictedDisplayTime,
@@ -548,7 +531,7 @@ XrResult OpenXrApiWrapper::GetHeadPose(
     *emulated_position = false;
   }
 
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 void OpenXrApiWrapper::GetHeadFromEyes(XrView* left, XrView* right) const {
@@ -561,8 +544,6 @@ void OpenXrApiWrapper::GetHeadFromEyes(XrView* left, XrView* right) const {
 XrResult OpenXrApiWrapper::GetLuid(LUID* luid) const {
   DCHECK(IsInitialized());
 
-  XrResult xr_result;
-
   XrGraphicsRequirementsD3D11KHR graphics_requirements = {
       XR_TYPE_GRAPHICS_REQUIREMENTS_D3D11_KHR};
   RETURN_IF_XR_FAILED(xrGetD3D11GraphicsRequirementsKHR(
@@ -571,7 +552,7 @@ XrResult OpenXrApiWrapper::GetLuid(LUID* luid) const {
   luid->LowPart = graphics_requirements.adapterLuid.LowPart;
   luid->HighPart = graphics_requirements.adapterLuid.HighPart;
 
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 XrResult OpenXrApiWrapper::ProcessEvents() {
@@ -668,8 +649,7 @@ uint32_t OpenXrApiWrapper::GetRecommendedSwapchainSampleCount() const {
 // XrEventDataReferenceSpaceChangePending
 XrResult OpenXrApiWrapper::UpdateStageBounds() {
   DCHECK(HasSession());
-  XrResult xr_result;
-  xr_result = xrGetReferenceSpaceBoundsRect(
+  XrResult xr_result = xrGetReferenceSpaceBoundsRect(
       session_, XR_REFERENCE_SPACE_TYPE_STAGE, &stage_bounds_);
   if (XR_FAILED(xr_result)) {
     stage_bounds_.height = 0;

device/vr/openxr/openxr_controller.cc

@@ -85,8 +85,6 @@ XrResult OpenXrController::Initialize(
                    action_set_name.c_str());
   DCHECK(!error);
 
-  XrResult xr_result;
-
   RETURN_IF_XR_FAILED(
       xrCreateActionSet(instance_, &action_set_create_info, &action_set_));
 
@@ -95,14 +93,12 @@ XrResult OpenXrController::Initialize(
 
   RETURN_IF_XR_FAILED(InitializeMicrosoftMotionControllerSpaces());
 
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 XrResult OpenXrController::InitializeMicrosoftMotionControllerActions(
     const std::string& type_string,
     std::map<XrPath, std::vector<XrActionSuggestedBinding>>* bindings) {
-  XrResult xr_result;
-
   const std::string binding_prefix = top_level_user_path_string_ + "/input/";
   const std::string name_prefix = type_string + "_controller_";
 
@@ -170,18 +166,16 @@ XrResult OpenXrController::InitializeMicrosoftMotionControllerActions(
       binding_prefix + "aim", name_prefix + "aim_pose", &pointer_pose_action_,
       bindings));
 
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 XrResult OpenXrController::InitializeMicrosoftMotionControllerSpaces() {
-  XrResult xr_result;
-
   RETURN_IF_XR_FAILED(CreateActionSpace(grip_pose_action_, &grip_pose_space_));
 
   RETURN_IF_XR_FAILED(
       CreateActionSpace(pointer_pose_action_, &pointer_pose_space_));
 
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 uint32_t OpenXrController::GetId() const {
@@ -275,8 +269,6 @@ std::vector<double> OpenXrController::GetAxis(OpenXrAxisType type) const {
 }
 
 XrResult OpenXrController::UpdateInteractionProfile() {
-  XrResult xr_result;
-
   XrPath top_level_user_path;
   RETURN_IF_XR_FAILED(xrStringToPath(
       instance_, top_level_user_path_string_.c_str(), &top_level_user_path));
@@ -297,7 +289,7 @@ XrResult OpenXrController::UpdateInteractionProfile() {
                      output_size, &output_size, out_string));
 
   interaction_profile_ = out_string;
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 base::Optional<gfx::Transform> OpenXrController::GetMojoFromGripTransform(
@@ -371,8 +363,6 @@ XrResult OpenXrController::CreateAction(
     const std::string& action_name,
     XrAction* action,
     std::map<XrPath, std::vector<XrActionSuggestedBinding>>* bindings) {
-  XrResult xr_result;
-
   XrActionCreateInfo action_create_info = {XR_TYPE_ACTION_CREATE_INFO};
   action_create_info.actionType = type;
 
@@ -394,7 +384,7 @@ XrResult OpenXrController::CreateAction(
       xrStringToPath(instance_, binding_string.c_str(), &action_path));
   (*bindings)[profile_path].push_back({*action, action_path});
 
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 XrResult OpenXrController::CreateActionSpace(XrAction action, XrSpace* space) {

device/vr/openxr/openxr_input_helper.cc

@@ -43,8 +43,6 @@ XrResult OpenXRInputHelper::CreateOpenXRInputHelper(
     XrSession session,
     XrSpace local_space,
     std::unique_ptr<OpenXRInputHelper>* helper) {
-  XrResult xr_result;
-
   std::unique_ptr<OpenXRInputHelper> new_helper =
       std::make_unique<OpenXRInputHelper>(session, local_space);
 
@@ -83,7 +81,7 @@ XrResult OpenXRInputHelper::CreateOpenXRInputHelper(
   RETURN_IF_XR_FAILED(xrAttachSessionActionSets(session, &attach_info));
 
   *helper = std::move(new_helper);
-  return xr_result;
+  return XR_SUCCESS;
 }
 
 OpenXRInputHelper::OpenXRInputHelper(XrSession session, XrSpace local_space)

device/vr/openxr/openxr_util.h

@@ -13,13 +13,14 @@ namespace device {
 // all OpenXR helper macros here so they can be kept track of. This file
 // should not be included outside of device/vr/openxr.
 
-// The caller must have a variable of type XrResult named xr_result defined in
-// their scope. This macro sets xr_result to |xrcode|.
-#define RETURN_IF_XR_FAILED(xrcode) \
-  do {                              \
-    xr_result = (xrcode);           \
-    if (XR_FAILED(xr_result))       \
-      return xr_result;             \
+#define RETURN_IF_XR_FAILED(xrcode)                                     \
+  do {                                                                  \
+    XrResult return_if_xr_failed_xr_result = (xrcode);                  \
+    if (XR_FAILED(return_if_xr_failed_xr_result)) {                     \
+      DLOG(ERROR) << __func__                                           \
+                  << " Failed with: " << return_if_xr_failed_xr_result; \
+      return return_if_xr_failed_xr_result;                             \
+    }                                                                   \
   } while (false)
 
 #define RETURN_IF_FALSE(condition, error_code, msg) \

device/vr/openxr/test/openxr_test_helper.cc

@@ -187,7 +187,6 @@ XrInstance OpenXrTestHelper::CreateInstance() {
 
 XrResult OpenXrTestHelper::GetActionStateFloat(XrAction action,
                                                XrActionStateFloat* data) const {
-  XrResult xr_result;
 
   RETURN_IF_XR_FAILED(ValidateAction(action));
   const ActionProperties& cur_action_properties = actions_.at(action);
@@ -202,7 +201,6 @@ XrResult OpenXrTestHelper::GetActionStateFloat(XrAction action,
 XrResult OpenXrTestHelper::GetActionStateBoolean(
     XrAction action,
     XrActionStateBoolean* data) const {
-  XrResult xr_result;
 
   RETURN_IF_XR_FAILED(ValidateAction(action));
   const ActionProperties& cur_action_properties = actions_.at(action);
@@ -218,7 +216,6 @@ XrResult OpenXrTestHelper::GetActionStateBoolean(
 XrResult OpenXrTestHelper::GetActionStateVector2f(
     XrAction action,
     XrActionStateVector2f* data) const {
-  XrResult xr_result;
 
   RETURN_IF_XR_FAILED(ValidateAction(action));
   const ActionProperties& cur_action_properties = actions_.at(action);
@@ -233,7 +230,6 @@ XrResult OpenXrTestHelper::GetActionStateVector2f(
 
 XrResult OpenXrTestHelper::GetActionStatePose(XrAction action,
                                               XrActionStatePose* data) const {
-  XrResult xr_result;
 
   RETURN_IF_XR_FAILED(ValidateAction(action));
   const ActionProperties& cur_action_properties = actions_.at(action);
@@ -267,8 +263,6 @@ XrSpace OpenXrTestHelper::CreateReferenceSpace(XrReferenceSpaceType type) {
 XrResult OpenXrTestHelper::CreateAction(XrActionSet action_set,
                                         const XrActionCreateInfo& create_info,
                                         XrAction* action) {
-  XrResult xr_result;
-
   RETURN_IF_XR_FAILED(ValidateActionSet(action_set));
   RETURN_IF_XR_FAILED(ValidateActionSetNotAttached(action_set));
   RETURN_IF_XR_FAILED(ValidateActionCreateInfo(create_info));
@@ -324,7 +318,6 @@ XrActionSet OpenXrTestHelper::CreateActionSet(
 XrResult OpenXrTestHelper::CreateActionSpace(
     const XrActionSpaceCreateInfo& action_space_create_info,
     XrSpace* space) {
-  XrResult xr_result;
   RETURN_IF_XR_FAILED(ValidateActionSpaceCreateInfo(action_space_create_info));
   *space = TreatIntegerAsHandle<XrSpace>(++next_space_);
   action_spaces_[*space] = action_space_create_info.action;
@@ -428,8 +421,6 @@ void OpenXrTestHelper::SetD3DDevice(ID3D11Device* d3d_device) {
 
 XrResult OpenXrTestHelper::AttachActionSets(
     const XrSessionActionSetsAttachInfo& attach_info) {
-  XrResult xr_result;
-
   RETURN_IF(attach_info.type != XR_TYPE_SESSION_ACTION_SETS_ATTACH_INFO,
             XR_ERROR_VALIDATION_FAILURE,
             "XrSessionActionSetsAttachInfo type invalid");
@@ -453,7 +444,6 @@ uint32_t OpenXrTestHelper::AttachedActionSetsSize() const {
 }
 
 XrResult OpenXrTestHelper::SyncActionData(XrActionSet action_set) {
-  XrResult xr_result;
 
   RETURN_IF_XR_FAILED(ValidateActionSet(action_set));
   RETURN_IF(ValidateActionSetNotAttached(action_set) !=
@@ -468,7 +458,6 @@ XrResult OpenXrTestHelper::SyncActionData(XrActionSet action_set) {
 }
 
 XrResult OpenXrTestHelper::UpdateAction(XrAction action) {
-  XrResult xr_result;
   RETURN_IF_XR_FAILED(ValidateAction(action));
   const ActionProperties& cur_action_properties = actions_[action];
   std::string path_string = PathToString(cur_action_properties.binding);
@@ -814,7 +803,6 @@ XrResult OpenXrTestHelper::ValidateActionSetNotAttached(
 
 XrResult OpenXrTestHelper::ValidateActionSpaceCreateInfo(
     const XrActionSpaceCreateInfo& create_info) const {
-  XrResult xr_result;
   RETURN_IF(create_info.type != XR_TYPE_ACTION_SPACE_CREATE_INFO,
             XR_ERROR_VALIDATION_FAILURE,
             "ValidateActionSpaceCreateInfo type invalid");
@@ -895,8 +883,6 @@ XrResult OpenXrTestHelper::ValidatePredictedDisplayTime(XrTime time) const {
 
 XrResult OpenXrTestHelper::ValidateXrCompositionLayerProjection(
     const XrCompositionLayerProjection& projection_layer) const {
-  XrResult xr_result;
-
   RETURN_IF(projection_layer.type != XR_TYPE_COMPOSITION_LAYER_PROJECTION,
             XR_ERROR_LAYER_INVALID,
             "XrCompositionLayerProjection type invalid");