wiEnrich library

Warning

For technical reasons, [RED] is not a valid keyword, use [FRED]!

This is a C-library that allows you to write text like:

"This is [GREEN]text [ON BRIGHT-BLUE]on a bright-blue[/] background."

The single function char* enrich(char* message) will take the string, and substitute all the keywords in proper escape-characters.

This substitution will happen in-place, and it will happen in a single pass through the string.

Warning

This library WILL throw a runtime error when it detected a problem. Potential problems:

• No closing ] for a non-escaped opening [
• Invalid keyword between []
• Using [/] without having used another pattern first

To avoid that your program will crash, test it first ;-)

Caution

Because this library modifies the string in-place, you need to own the string in your program, otherwise a segmentation-fault will happen.

To pass a valid string to the wiEnrich() function, you should first assign it to a char[] (NOT a char*), or use strdup(), which will create a duplicate on the heap (and create a memory leak if you don't free it).

NO_COLOR

When the "$NO_COLOR" system variable is set, no colour will be substituted. Only bold, italic, ...

How to get the library

If you haven't cloned it already, clone with git clone --recurse-submodules git@github.com:/BWindey/WiEnrich.git. If you already cloned without the --recurse-submodules flag, use git submodule update --init --recursive.

With this repository cloned, you need 2 files from it: wiEnrich.h and the source code. The header file you can find in include/, the source code can be acquired in 2 ways:

• run make, this will produce lib/libwienrich.a, which you can then use for your own program (compiling would be then something like gcc main.c -L./ -lwienrich).
• use src/wiEnrich.c directly; you also need the file submodules/WiTesting/wiAssert.h in your project then, as it is needed by src/wiEnrich.c; I leave it to you to organise that.

Limitations

There are only a limited set of colours available to use. When you have some experience with these escape-characters, you will know why. This doesn't support extra colours, you'll need to find the escape-characters for those yourself.

The library also does not keep track of which effects have been applied when. Practically, this means that you cannot escape/stop one effect at a time. When inserting a [/], all text will be back to normal.

Example usage

#include <stdio.h>
#include "wiEnrich.h"

int main(void) {
	char msg[] = "[BOLD]This is bold.[/]\nAnd this is [BRIGHT-BLUE]blue[/]!";
	wiEnrich(msg);

	printf("%s\n", msg);

	char second[] = "I found [NUMBER]3.14[/] pies today!";
	printf("%s\n", wiEnrich(second));

	return 0;
}

List of recognised keywords

You'll notice that for every available colour, there is the colour itself as foreground and background, and both are also available in their bright versions.

• "[/]" <- Resets everything back

• "[NUMBER]" <- BOLD + CYAN

• "[BOLD]"

• "[DIM]"

• "[ITALIC]"

• "[UNDER]"

• "[STRIKE]"

• "[BLACK]"

• "[BRIGHT-BLACK]"

• "[ON BLACK]"

• "[ON BRIGHT-BLACK]"

• "[FRED]" <- WATCH OUT, has weird name

• "[BRIGHT-RED]"

• "[ON RED]"

• "[ON BRIGHT-RED]"

• "[GREEN]"

• "[BRIGHT-GREEN]"

• "[ON GREEN]"

• "[ON BRIGHT-GREEN]"

• "[YELLOW]"

• "[BRIGHT-YELLOW]"

• "[ON YELLOW]"

• "[ON BRIGHT-YELLOW]"

• "[BLUE]"

• "[BRIGHT-BLUE]"

• "[ON BLUE]"

• "[ON BRIGHT-BLUE]"

• "[MAGENTA]"

• "[BRIGHT-MAGENTA]"

• "[ON MAGENTA]"

• "[ON BRIGHT-MAGENTA]"

• "[CYAN]"

• "[BRIGHT-CYAN]"

• "[ON CYAN]"

• "[ON BRIGHT-CYAN]"

• "[WHITE]"

• "[BRIGHT-WHITE]"

• "[ON WHITE]"

• "[ON BRIGHT-WHITE]"