Merge branch 'master' into ircv3

README.md

@@ -28,7 +28,7 @@ dub add birchwood
 
 ### Dependencies
 
-Birchwood dependends on the following D libraries:
+Birchwood depends on the following D libraries:
 
 * `libsnooze` (0.3.0)
 * `eventy` (0.4.0)
@@ -38,7 +38,7 @@ Birchwood dependends on the following D libraries:
 
 You can take a look at the `Client` API documentation on [DUB](https://birchwood.dpldocs.info/birchwood.client.Client.html).
 
-## Compatibiloty
+## Compatibility
 
 - [x] [rfc1459](https://www.rfc-editor.org/rfc/rfc1459)
    * Supports all the numeric codes

source/birchwood/protocol/formatting.d

@@ -1,2 +1,112 @@
 module birchwood.protocol.formatting;
 
+import std.string;
+
+// Reset character; resets all formatting
+enum reset_code = '\x0F';
+
+// Toggle characters
+enum bold_code = '\x02';
+enum italic_code = '\x1D';
+enum underline_code = '\x1F';
+enum strikethrough_code = '\x1E';
+enum monospace_code = '\x11';
+enum reverse_colors_code = '\x16'; // NOT UNIVERSALLY SUPPORTED
+
+// Color characters
+enum ascii_color_code = '\x03';
+enum hex_color_code = '\x04';
+
+// Simple color codes
+enum simpleColor: string {
+    WHITE = "00",
+    BLACK = "01",
+    BLUE = "02",
+    GREEN = "03",
+    RED = "04",
+    BROWN = "05",
+    MAGENTA = "06",
+    ORANGE = "07",
+    YELLOW = "08",
+    LIGHT_GREEN = "09",
+    CYAN = "10",
+    LIGHT_CYAN = "11",
+    LIGHT_BLUE = "12",
+    PINK = "13",
+    GREY = "14",
+    LIGHT_GREY = "15",
+    DEFAULT = "99" // NOT UNIVERSALLY SUPPORTED
+}
+
+// Return the hex control character if color is a hexadecimal color code, the ASCII control character if color is two ASCII digits, and throw an exception if it's neither
+// This function might be useless now that set_fg and set_fg_bg have been changed, but I'll keep it in case it's needed later.
+char generate_color_control_char(string color) {
+    if (color.length == 6) {
+        return hex_color_code;
+    } else if (color.length == 2) {
+        return ascii_color_code;
+    } else {
+        throw new StringException("Invalid color code (must be either two ASCII digits or a hexadecimal code of the form RRGGBB)");
+    }
+}
+
+// Generates a string that changes the foreground color
+string set_foreground(string color) {
+    char[1] control_char;
+    if (color.length == 6) {
+        control_char[0] = hex_color_code;
+    } else if (color.length == 2) {
+        control_char[0] = ascii_color_code;
+    } else {
+        throw new StringException("Invalid color code (must be either two ASCII digits or a hexadecimal code of the form RRGGBB)");
+    }
+    return control_char.idup ~ color;
+}
+
+// Generate a string that sets the foreground and background color
+string set_foreground_background(string fg, string bg) {
+    char[1] control_char;
+    if (fg.length != bg.length) {
+        throw new StringException("Invalid color code (cannot mix hex and ASCII)");
+    }
+    if (fg.length == 6) {
+        control_char[0] = hex_color_code;
+    } else if (fg.length == 2) {
+        control_char[0] = ascii_color_code;
+    } else {
+        throw new StringException("Invalid color code (must be either two ASCII digits or a hexadecimal code of the form RRGGBB)");
+    }
+    return control_char.idup ~ fg ~ "," ~ bg;
+}
+
+// Generates a string that changes the foreground color (except enum)
+pragma(inline)
+string set_foreground(simpleColor color) {
+    return ascii_color_code ~ color;
+}
+
+// Generate a string that sets the foreground and background color (except enum)
+pragma(inline)
+string set_foreground_background(simpleColor fg, simpleColor bg) {
+    return ascii_color_code ~ fg ~ "," ~ bg;
+}
+
+// Generate a string that resets the foreground and background colors
+pragma(inline)
+string reset_fg_bg() {return [ascii_color_code].idup;}
+
+// Format strings with functions
+pragma(inline)
+string bold(string text) {return bold_code~text~bold_code;}
+
+pragma(inline)
+string italics(string text) {return italic_code~text~italic_code;}
+
+pragma(inline)
+string underline(string text) {return underline_code~text~underline_code;}
+
+pragma(inline)
+string strikethrough(string text) {return strikethrough_code~text~strikethrough_code;}
+
+pragma(inline)
+string monospace(string text) {return monospace_code~text~monospace_code;}