From deedd10a505f4ff5b9fa16a5d1826b31be382758 Mon Sep 17 00:00:00 2001 From: Jakob Bornecrantz Date: Wed, 8 Jul 2020 15:38:49 +0100 Subject: [PATCH] xrt: Tidy xrt_instance_create argument order and add doc-comment --- src/xrt/include/xrt/xrt_instance.h | 8 ++++++-- src/xrt/ipc/ipc_client_instance.c | 4 ++-- src/xrt/ipc/ipc_server_process.c | 2 +- src/xrt/state_trackers/gui/gui_prober.c | 2 +- src/xrt/state_trackers/oxr/oxr_instance.c | 2 +- src/xrt/targets/cli/cli_cmd_calibrate.c | 2 +- src/xrt/targets/cli/cli_cmd_probe.c | 2 +- src/xrt/targets/cli/cli_cmd_test.c | 2 +- src/xrt/targets/common/target_instance.c | 4 ++-- src/xrt/targets/common/target_instance_no_comp.c | 4 ++-- src/xrt/targets/openxr/target.c | 10 +++++----- 11 files changed, 23 insertions(+), 19 deletions(-) diff --git a/src/xrt/include/xrt/xrt_instance.h b/src/xrt/include/xrt/xrt_instance.h index 8164174b7..dbc08b801 100644 --- a/src/xrt/include/xrt/xrt_instance.h +++ b/src/xrt/include/xrt/xrt_instance.h @@ -226,6 +226,8 @@ xrt_instance_destroy(struct xrt_instance **xinst_ptr) * * Each target must implement this function. * + * @param[in] ii A pointer to a info struct containing information about the + * application. * @param[out] out_xinst A pointer to an xrt_instance pointer. Will be * populated. * @@ -234,8 +236,10 @@ xrt_instance_destroy(struct xrt_instance **xinst_ptr) * @relates xrt_instance */ int -xrt_instance_create(struct xrt_instance **out_xinst, - struct xrt_instance_info *ii); +xrt_instance_create(struct xrt_instance_info *ii, + struct xrt_instance **out_xinst + +); /*! * @} diff --git a/src/xrt/ipc/ipc_client_instance.c b/src/xrt/ipc/ipc_client_instance.c index 409290ef0..722074528 100644 --- a/src/xrt/ipc/ipc_client_instance.c +++ b/src/xrt/ipc/ipc_client_instance.c @@ -183,8 +183,8 @@ ipc_client_instance_destroy(struct xrt_instance *xinst) * @public @memberof ipc_instance */ int -ipc_instance_create(struct xrt_instance **out_xinst, - struct xrt_instance_info *i_info) +ipc_instance_create(struct xrt_instance_info *i_info, + struct xrt_instance **out_xinst) { struct ipc_client_instance *ii = U_TYPED_CALLOC(struct ipc_client_instance); diff --git a/src/xrt/ipc/ipc_server_process.c b/src/xrt/ipc/ipc_server_process.c index c3ca24423..da16fe6c0 100644 --- a/src/xrt/ipc/ipc_server_process.c +++ b/src/xrt/ipc/ipc_server_process.c @@ -384,7 +384,7 @@ init_all(struct ipc_server *s) s->running = true; s->exit_on_disconnect = debug_get_bool_option_exit_on_disconnect(); - int ret = xrt_instance_create(&s->xinst, NULL); + int ret = xrt_instance_create(NULL, &s->xinst); if (ret < 0) { teardown_all(s); return ret; diff --git a/src/xrt/state_trackers/gui/gui_prober.c b/src/xrt/state_trackers/gui/gui_prober.c index f7636b9d6..2c5c558b3 100644 --- a/src/xrt/state_trackers/gui/gui_prober.c +++ b/src/xrt/state_trackers/gui/gui_prober.c @@ -38,7 +38,7 @@ gui_prober_init(struct gui_program *p) int ret = 0; // Initialize the prober. - ret = xrt_instance_create(&p->instance, NULL); + ret = xrt_instance_create(NULL, &p->instance); if (ret != 0) { return do_exit(p, ret); } diff --git a/src/xrt/state_trackers/oxr/oxr_instance.c b/src/xrt/state_trackers/oxr/oxr_instance.c index 0ac792ba6..c59499214 100644 --- a/src/xrt/state_trackers/oxr/oxr_instance.c +++ b/src/xrt/state_trackers/oxr/oxr_instance.c @@ -177,7 +177,7 @@ oxr_instance_create(struct oxr_logger *log, sizeof(inst->xinst->instance_info.application_name), "%s", createInfo->applicationInfo.applicationName); - xinst_ret = xrt_instance_create(&inst->xinst, &i_info); + xinst_ret = xrt_instance_create(&i_info, &inst->xinst); if (xinst_ret != 0) { ret = oxr_error(log, XR_ERROR_RUNTIME_FAILURE, "Failed to create prober"); diff --git a/src/xrt/targets/cli/cli_cmd_calibrate.c b/src/xrt/targets/cli/cli_cmd_calibrate.c index 2f3e78829..e81d62fba 100644 --- a/src/xrt/targets/cli/cli_cmd_calibrate.c +++ b/src/xrt/targets/cli/cli_cmd_calibrate.c @@ -32,7 +32,7 @@ init(struct program *p) int ret; // Fist initialize the instance. - ret = xrt_instance_create(&p->xi, NULL); + ret = xrt_instance_create(NULL, &p->xi); if (ret != 0) { fprintf(stderr, "Failed to create instance\n"); return ret; diff --git a/src/xrt/targets/cli/cli_cmd_probe.c b/src/xrt/targets/cli/cli_cmd_probe.c index f59c69a3a..da5d154c5 100644 --- a/src/xrt/targets/cli/cli_cmd_probe.c +++ b/src/xrt/targets/cli/cli_cmd_probe.c @@ -36,7 +36,7 @@ cli_cmd_probe(int argc, const char **argv) // Initialize the prober. printf(" :: Creating instance!\n"); - ret = xrt_instance_create(&xi, NULL); + ret = xrt_instance_create(NULL, &xi); if (ret != 0) { return do_exit(&xi, 0); } diff --git a/src/xrt/targets/cli/cli_cmd_test.c b/src/xrt/targets/cli/cli_cmd_test.c index fc0b62fbb..b94c94040 100644 --- a/src/xrt/targets/cli/cli_cmd_test.c +++ b/src/xrt/targets/cli/cli_cmd_test.c @@ -36,7 +36,7 @@ cli_cmd_test(int argc, const char **argv) // Initialize the prober. printf(" :: Creating instance!\n"); - ret = xrt_instance_create(&xi, NULL); + ret = xrt_instance_create(NULL, &xi); if (ret != 0) { return do_exit(&xi, 0); } diff --git a/src/xrt/targets/common/target_instance.c b/src/xrt/targets/common/target_instance.c index fd6ce9165..05415957d 100644 --- a/src/xrt/targets/common/target_instance.c +++ b/src/xrt/targets/common/target_instance.c @@ -35,8 +35,8 @@ t_instance_create_fd_compositor(struct xrt_instance *xinst, */ int -xrt_instance_create(struct xrt_instance **out_xinst, - struct xrt_instance_info *i_info) +xrt_instance_create(struct xrt_instance_info *i_info, + struct xrt_instance **out_xinst) { struct xrt_prober *xp = NULL; diff --git a/src/xrt/targets/common/target_instance_no_comp.c b/src/xrt/targets/common/target_instance_no_comp.c index 927e8e269..956f913e8 100644 --- a/src/xrt/targets/common/target_instance_no_comp.c +++ b/src/xrt/targets/common/target_instance_no_comp.c @@ -29,8 +29,8 @@ t_instance_create_fd_compositor_stub(struct xrt_instance *xinst, */ int -xrt_instance_create(struct xrt_instance **out_xinst, - struct xrt_instance_info *i_info) +xrt_instance_create(struct xrt_instance_info *i_info, + struct xrt_instance **out_xinst) { struct xrt_prober *xp = NULL; diff --git a/src/xrt/targets/openxr/target.c b/src/xrt/targets/openxr/target.c index be2f8280f..1b94484e5 100644 --- a/src/xrt/targets/openxr/target.c +++ b/src/xrt/targets/openxr/target.c @@ -14,14 +14,14 @@ // Forward declaration int -ipc_instance_create(struct xrt_instance **out_xinst, - struct xrt_instance_info *i_info); +ipc_instance_create(struct xrt_instance_info *i_info, + struct xrt_instance **out_xinst); int -xrt_instance_create(struct xrt_instance **out_xinst, - struct xrt_instance_info *i_info) +xrt_instance_create(struct xrt_instance_info *i_info, + struct xrt_instance **out_xinst) { - return ipc_instance_create(out_xinst, i_info); + return ipc_instance_create(i_info, out_xinst); } #else