Add Truecolor ANSI console constants
authorSergey Sharybin <sergey.vfx@gmail.com>
Fri, 16 Mar 2018 11:16:29 +0000 (12:16 +0100)
committerSergey Sharybin <sergey.vfx@gmail.com>
Fri, 16 Mar 2018 11:16:29 +0000 (12:16 +0100)
They are used to start and end colored output in console.
Use with care, it is up to you to check that console actually
supports Truecolor ANSII.

In thew future we can extend this to other consoles and platforms.

source/blender/blenlib/BLI_console.h [new file with mode: 0644]
source/blender/blenlib/CMakeLists.txt

diff --git a/source/blender/blenlib/BLI_console.h b/source/blender/blenlib/BLI_console.h
new file mode 100644 (file)
index 0000000..bf433f7
--- /dev/null
@@ -0,0 +1,42 @@
+/*
+ * ***** BEGIN GPL LICENSE BLOCK *****
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * The Original Code is Copyright (C) 2018 Blender Foundation.
+ * All rights reserved.
+ *
+ * Contributor(s): Srrgey Sharybin.
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+#ifndef __BLI_CONSOLE_H__
+#define __BLI_CONSOLE_H__
+
+/** \file BLI_console.h
+ *  \ingroup bli
+ *  \brief Set of utility functions and constants to work with consoles.
+ */
+
+/* Format string where one could BLI_snprintf() R, G and B values
+ * and get proper marker to start colored output in the console.
+ */
+#define TRUECOLOR_ANSI_COLOR_FORMAT "\x1b[38;2;%d;%d;%dm"
+
+/* Marker which indicates that colored output is finished. */
+#define TRUECOLOR_ANSI_COLOR_FINISH "\x1b[0m"
+
+#endif  /* __BLI_CONSOLE_H__ */
index d137de5..33a8379 100644 (file)
@@ -138,6 +138,7 @@ set(SRC
        BLI_compiler_attrs.h
        BLI_compiler_compat.h
        BLI_compiler_typecheck.h
+       BLI_console.h
        BLI_convexhull_2d.h
        BLI_dial_2d.h
        BLI_dlrbTree.h