X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=src%2Fcommon%2Fargpar-utils%2Fargpar-utils.h;h=1bdff7e19822b065e056acfe348ab34c985de1f8;hb=ef9ff9cb5ff4dd763d4c9dbbcfcb5952adce167e;hp=b9ae510c9e138e4e9db9afa099399db99a966151;hpb=d50d200af8d01f4b58a14e384cabd46b1afb4817;p=lttng-tools.git

diff --git a/src/common/argpar-utils/argpar-utils.h b/src/common/argpar-utils/argpar-utils.h
index b9ae510c9..1bdff7e19 100644
--- a/src/common/argpar-utils/argpar-utils.h
+++ b/src/common/argpar-utils/argpar-utils.h
@@ -18,11 +18,14 @@ extern "C" {
 #include <common/argpar/argpar.h>
 #include <common/string-utils/format.h>
 
+#define WHILE_PARSING_ARG_N_ARG_FMT "While parsing argument #%d (`%s`): "
+
 enum parse_next_item_status
 {
 	PARSE_NEXT_ITEM_STATUS_OK = 0,
 	PARSE_NEXT_ITEM_STATUS_END = 1,
 	PARSE_NEXT_ITEM_STATUS_ERROR = -1,
+	PARSE_NEXT_ITEM_STATUS_ERROR_MEMORY = -2,
 };
 
 /*
@@ -39,14 +42,21 @@ enum parse_next_item_status
  * On error, print a descriptive error message and return
  * PARSE_NEXT_ITEM_STATUS_ERROR.  If `context_fmt` is non-NULL, it is formatted
  * using the following arguments and prepended to the error message.
+ * Add `argc_offset` to the argument index mentioned in the error message.
  *
  * If `unknown_opt_is_error` is true, an unknown option is considered an error.
  * Otherwise, it is considered as the end of the argument list.
+ *
+ * If `error_out` is given and PARSE_NEXT_ITEM_STATUS_ERROR is returned, set
+ * `*error_out` to the argpar_error object corresponding to the error.  The
+ * caller must free the object with `argpar_error_destroy`.
  */
-ATTR_FORMAT_PRINTF(5, 6)
+ATTR_FORMAT_PRINTF(7, 8)
 enum parse_next_item_status parse_next_item(struct argpar_iter *iter,
-		const struct argpar_item **item, const char **argv,
-		bool unknown_opt_is_error, const char *context_fmt, ...);
+		const struct argpar_item **item, int argc_offset,
+		const char **argv, bool unknown_opt_is_error,
+		const struct argpar_error **error_out,
+		const char *context_fmt, ...);
 
 #ifdef __cplusplus
 }