Move to kernel style SPDX license identifiers

[babeltrace.git] / src / common / common.h

diff --git a/src/common/common.h b/src/common/common.h
index 96c09b6c520413180809732c85d5ae146467ea98..a04f2be64cd4747939c9254b7c26c340b1dfdb4d 100644 (file)
--- a/src/common/common.h
+++ b/src/common/common.h
@@ -1,29 +1,13 @@
-#ifndef BABELTRACE_COMMON_INTERNAL_H
-#define BABELTRACE_COMMON_INTERNAL_H
-
 /*
+ * SPDX-License-Identifier: MIT
+ *
  * Copyright (c) 2018 EfficiOS Inc. and Linux Foundation
  * Copyright (c) 2018 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.
  */
 
+#ifndef BABELTRACE_COMMON_INTERNAL_H
+#define BABELTRACE_COMMON_INTERNAL_H
+
 #include <errno.h>
 #include <glib.h>
 #include <inttypes.h>
@@ -77,6 +61,40 @@
 #define BT_COMMON_COLOR_BG_CYAN                        "\033[46m"
 #define BT_COMMON_COLOR_BG_LIGHT_GRAY          "\033[47m"
 
+enum bt_common_color_when {
+       BT_COMMON_COLOR_WHEN_AUTO,
+       BT_COMMON_COLOR_WHEN_ALWAYS,
+       BT_COMMON_COLOR_WHEN_NEVER,
+};
+
+struct bt_common_color_codes {
+       const char *reset;
+       const char *bold;
+       const char *fg_default;
+       const char *fg_red;
+       const char *fg_green;
+       const char *fg_yellow;
+       const char *fg_blue;
+       const char *fg_magenta;
+       const char *fg_cyan;
+       const char *fg_light_gray;
+       const char *fg_bright_red;
+       const char *fg_bright_green;
+       const char *fg_bright_yellow;
+       const char *fg_bright_blue;
+       const char *fg_bright_magenta;
+       const char *fg_bright_cyan;
+       const char *fg_bright_light_gray;
+       const char *bg_default;
+       const char *bg_red;
+       const char *bg_green;
+       const char *bg_yellow;
+       const char *bg_blue;
+       const char *bg_magenta;
+       const char *bg_cyan;
+       const char *bg_light_gray;
+};
+
 struct bt_common_lttng_live_url_parts {
        GString *proto;
        GString *hostname;
@@ -199,6 +217,10 @@ const char *bt_common_color_bg_cyan(void);
 BT_HIDDEN
 const char *bt_common_color_bg_light_gray(void);
 
+BT_HIDDEN
+void bt_common_color_get_codes(struct bt_common_color_codes *codes,
+               enum bt_common_color_when use_colors);
+
 /*
  * Returns the substring from `input` to the first character found
  * in the list of characters `end_chars`, unescaping any character
@@ -671,6 +693,8 @@ const char *bt_common_func_status_string(int status)
                return "UNKNOWN_OBJECT";
        case __BT_FUNC_STATUS_MEMORY_ERROR:
                return "MEMORY_ERROR";
+       case __BT_FUNC_STATUS_USER_ERROR:
+               return "USER_ERROR";
        case __BT_FUNC_STATUS_ERROR:
                return "ERROR";
        case __BT_FUNC_STATUS_OK:
@@ -783,7 +807,7 @@ end:
  * bt_g_string_append_printf cannot be inlined because it expects a
  * variadic argument list.
  */
-BT_HIDDEN
+BT_HIDDEN __BT_ATTR_FORMAT_PRINTF(2, 3)
 int bt_common_g_string_append_printf(GString *str, const char *fmt, ...);
 
 static inline