RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity
630b14b322
RIOT/makefiles/color.inc.mk

38 lines
1.1 KiB
Makefile
Raw Normal View History

make: Do not attempt to use color if the terminal cannot support it
2017-11-11 15:56:55 +01:00
# Set colored output control sequences if the terminal supports it and if
# not disabled by the user
make: refactor info- and buildtest targets
2017-09-09 00:06:29 +02:00
COLOR_GREEN :=
COLOR_RED :=
makefiles/color: preprocess color strings. The color strings COLOR_* are redefined so that they don't have to be processed by "echo -e". This is done by storing the already interpreted ANSI sequence in a shell variable. With this change, not only can color messages be printed using normal `echo` with no switches: colors also work with the `info` and `warning` builtins of make. The COLOR_ECHO variable is kept because it is also being used (confusingly) to intepret tabs an newlines. This will be fixed in another commit. This change should change absolutely anything and colors should still work as always.
2019-08-30 13:55:32 +02:00
COLOR_YELLOW :=
make: refactor info- and buildtest targets
2017-09-09 00:06:29 +02:00
COLOR_PURPLE :=
COLOR_RESET :=
makefiles/color: fix build on NixOS On NixOS, there is no `/bin/echo`, instead `which echo` will return /home/benpicco/.nix-profile/bin/echo so hard-coding the path will break here. Use `/usr/bin/env` to get the path of `echo`. This should be availiable on all systems at the same location.
2019-12-27 01:09:53 +01:00
COLOR_ECHO := /usr/bin/env echo
make: refactor info- and buildtest targets
2017-09-09 00:06:29 +02:00
makefiles/color.inc.mk: don't set CC_NOCOLOR If CC_NOCOLOR was not set by the user it was set according to the terminal support of colored output. But since CC_NOCOLOR is also used to set `-fdiagnostics-color` flags this means changing `CFLAGS` according to terminal support of colored output. This is not needed for `-fdiagnostics-color` since this option is by default `auto` if the compiler supports colored output, and `auto` means it will only use color when standard error is a terminal.
2020-01-10 08:40:00 +01:00
# Check if colored output is not disabled by user, i.e: CC_NOCOLOR unset
# or 0
ifneq ($(CC_NOCOLOR),1)
makefiles/color: detect if writing to terminal. The current code for detecting whether colors should be used by default was not working. Normally what programs such as git or grep do is check if they are writing to a pipe. To see the issue by yourself: $ BOARD=samr21-xpro make -C tests/periph_qdec > I_SHOULD_NOT_HAVE_COLORS 2>&1 This commit uses MAKE_TERMOUT, MAKE_TERMERR and if ANY of them is NOT a terminal, colors are disabled.
2019-08-30 16:30:41 +02:00
IS_TERMINAL = $(if $(MAKE_TERMOUT),$(MAKE_TERMERR),)
makefiles/color.inc.mk: don't set CC_NOCOLOR If CC_NOCOLOR was not set by the user it was set according to the terminal support of colored output. But since CC_NOCOLOR is also used to set `-fdiagnostics-color` flags this means changing `CFLAGS` according to terminal support of colored output. This is not needed for `-fdiagnostics-color` since this option is by default `auto` if the compiler supports colored output, and `auto` means it will only use color when standard error is a terminal.
2020-01-10 08:40:00 +01:00
# Check if terminal support colored output
ifneq ($(IS_TERMINAL),)
makefiles/utils/ansi: Refactor ansi codes into their own file. The escape codes and special chars now live in their own module. The color module is only concerned with detecting whether to use colors or not. Additional variables are defined with hard a coded ESC char, a tab and a newline. This removes the need for echo or printf.
2019-08-30 15:02:16 +02:00
COLOR_GREEN := $(ANSI_GREEN)
COLOR_RED := $(ANSI_RED)
COLOR_YELLOW := $(ANSI_YELLOW)
COLOR_PURPLE := $(ANSI_PURPLE)
COLOR_RESET := $(ANSI_RESET)
makefiles/color.inc.mk: don't set CC_NOCOLOR If CC_NOCOLOR was not set by the user it was set according to the terminal support of colored output. But since CC_NOCOLOR is also used to set `-fdiagnostics-color` flags this means changing `CFLAGS` according to terminal support of colored output. This is not needed for `-fdiagnostics-color` since this option is by default `auto` if the compiler supports colored output, and `auto` means it will only use color when standard error is a terminal.
2020-01-10 08:40:00 +01:00
ifeq ($(OS),Darwin)
COLOR_ECHO := echo -e
SHELL=bash
else
makefiles/color: fix build on NixOS On NixOS, there is no `/bin/echo`, instead `which echo` will return /home/benpicco/.nix-profile/bin/echo so hard-coding the path will break here. Use `/usr/bin/env` to get the path of `echo`. This should be availiable on all systems at the same location.
2019-12-27 01:09:53 +01:00
COLOR_ECHO := /usr/bin/env echo -e
makefiles/color.inc.mk: don't set CC_NOCOLOR If CC_NOCOLOR was not set by the user it was set according to the terminal support of colored output. But since CC_NOCOLOR is also used to set `-fdiagnostics-color` flags this means changing `CFLAGS` according to terminal support of colored output. This is not needed for `-fdiagnostics-color` since this option is by default `auto` if the compiler supports colored output, and `auto` means it will only use color when standard error is a terminal.
2020-01-10 08:40:00 +01:00
endif
make: refactor info- and buildtest targets
2017-09-09 00:06:29 +02:00
endif
endif
makefiles/color: Add color functions. c_xxxx functions can be used to wrap a piece of text in a $(COLOR_X)...$(COLOR_RESET) block, thereby avoiding the easy mistake of forgetting to place a COLOR_RESET.
2019-09-02 17:57:42 +02:00
# Colorizer functions:
# These functions wrap a block of text in $(COLOR_X)...$(COLOR_RESET).
# Do not nest calls to this functions or the colors will be wrong.
c_green = $(COLOR_GREEN)$(1)$(COLOR_RESET)
c_red = $(COLOR_RED)$(1)$(COLOR_RESET)
c_yellow = $(COLOR_YELLOW)$(1)$(COLOR_RESET)
c_purple = $(COLOR_PURPLE)$(1)$(COLOR_RESET)
Copy Permalink