Move to kernel style SPDX license identifiers

[babeltrace.git] / include / babeltrace2 / func-status.h

diff --git a/include/babeltrace2/func-status.h b/include/babeltrace2/func-status.h
index 60b68628f977b75e295e946912991b11d1584dd2..bba3882a609b34ab0cf5ea84117223ab344c5ed7 100644 (file)
--- a/include/babeltrace2/func-status.h
+++ b/include/babeltrace2/func-status.h
@@ -1,49 +1,16 @@
 /*
- * No include guards here: this header is included by a public header to
- * get the `__BT_FUNC_STATUS_*` definitions locally, and then
- * <babeltrace2/undef-func-status.h> is included at the end of the
- * header to undefine all those definitions.
+ * SPDX-License-Identifier: MIT
  *
- * If we forget to include <babeltrace2/undef-func-status.h> at the end
- * of a public header, we want to get the "redefined" compiler warning
- * to catch it.
+ * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
  */
 
 /*
- * Copyright (c) 2019 Philippe Proulx <pproulx@efficios.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * No include guards here: it is safe to include this file multiple
+ * times.
  */
 
-/*
- * This is just extra protection, in case the user tries to include
- * <babeltrace2/func-status.h> in user code: this is a redminder that
- * this header is reserved for internal use.
- *
- * The correct way for a public header to include this is:
- *
- *     #define __BT_FUNC_STATUS_ENABLE
- *     #include <babeltrace2/func-status.h>
- *     #undef __BT_FUNC_STATUS_ENABLE
- */
-#ifndef __BT_FUNC_STATUS_ENABLE
-# error Do NOT include <babeltrace2/func-status.h> in user code.
+#ifndef __BT_IN_BABELTRACE_H
+# error "Please include <babeltrace2/babeltrace.h> instead."
 #endif
 
 /*
@@ -54,37 +21,56 @@
  */
 
 /* Value is too large for the given data type */
-#define __BT_FUNC_STATUS_OVERFLOW              -75
-
-/* Invalid query parameters */
-#define __BT_FUNC_STATUS_INVALID_PARAMS                -24
-
-/* Invalid query object */
-#define __BT_FUNC_STATUS_INVALID_OBJECT                -23
+#ifndef __BT_FUNC_STATUS_OVERFLOW_ERROR
+# define __BT_FUNC_STATUS_OVERFLOW_ERROR       -75
+#endif
 
 /* Memory allocation error */
-#define __BT_FUNC_STATUS_MEMORY_ERROR          -12
+#ifndef __BT_FUNC_STATUS_MEMORY_ERROR
+# define __BT_FUNC_STATUS_MEMORY_ERROR         -12
+#endif
 
-/* Plugin loading error */
-#define __BT_FUNC_STATUS_LOADING_ERROR         -2
+/* User function error */
+#ifndef __BT_FUNC_STATUS_USER_ERROR
+# define __BT_FUNC_STATUS_USER_ERROR           -2
+#endif
 
 /* General error */
-#define __BT_FUNC_STATUS_ERROR                 -1
+#ifndef __BT_FUNC_STATUS_ERROR
+# define __BT_FUNC_STATUS_ERROR                        -1
+#endif
 
 /* Saul Goodman */
-#define __BT_FUNC_STATUS_OK                    0
+#ifndef __BT_FUNC_STATUS_OK
+# define __BT_FUNC_STATUS_OK                   0
+#endif
 
 /* End of iteration/consumption */
-#define __BT_FUNC_STATUS_END                   1
+#ifndef __BT_FUNC_STATUS_END
+# define __BT_FUNC_STATUS_END                  1
+#endif
 
 /* Something can't be found */
-#define __BT_FUNC_STATUS_NOT_FOUND             2
+#ifndef __BT_FUNC_STATUS_NOT_FOUND
+# define __BT_FUNC_STATUS_NOT_FOUND            2
+#endif
 
-/* Try operation again later */
-#define __BT_FUNC_STATUS_AGAIN                 11
+/* Object is interrupted */
+#ifndef __BT_FUNC_STATUS_INTERRUPTED
+# define __BT_FUNC_STATUS_INTERRUPTED          4
+#endif
 
-/* Unsupported operation */
-#define __BT_FUNC_STATUS_UNSUPPORTED           95
+/* No match found */
+#ifndef __BT_FUNC_STATUS_NO_MATCH
+# define __BT_FUNC_STATUS_NO_MATCH             6
+#endif
 
-/* Object is canceled */
-#define __BT_FUNC_STATUS_CANCELED              125
+/* Try operation again later */
+#ifndef __BT_FUNC_STATUS_AGAIN
+# define __BT_FUNC_STATUS_AGAIN                        11
+#endif
+
+/* Unknown query object */
+#ifndef __BT_FUNC_STATUS_UNKNOWN_OBJECT
+# define __BT_FUNC_STATUS_UNKNOWN_OBJECT       42
+#endif