Trunk: Merged the Devel-branch (branches/griatch) into /trunk. This constitutes a major refactoring of Evennia. Development will now continue in trunk. See the wiki and the past posts to the mailing list for info. /Griatch

src/utils/ansi.py

@@ -0,0 +1,155 @@
+"""
+ANSI - gives colour to text.
+"""
+import re
+
+class ANSITable(object):
+    """
+    A table of ANSI characters to use when replacing things.
+    """
+    ansi = {}
+    ansi["beep"] = "\07"
+    ansi["escape"] = "\033"
+    ansi["normal"] = "\033[0m"
+    
+    ansi["underline"] = "\033[4m"
+    ansi["hilite"] = "\033[1m"
+    ansi["blink"] = "\033[5m"
+    ansi["inverse"] = "\033[7m"
+    ansi["inv_hilite"] = "\033[1;7m"
+    ansi["inv_blink"] = "\033[7;5m"
+    ansi["blink_hilite"] = "\033[1;5m"
+    ansi["inv_blink_hilite"] = "\033[1;5;7m"
+    
+    # Foreground colors
+    ansi["black"] = "\033[30m"
+    ansi["red"] = "\033[31m"
+    ansi["green"] = "\033[32m"
+    ansi["yellow"] = "\033[33m"
+    ansi["blue"] = "\033[34m"
+    ansi["magenta"] = "\033[35m"
+    ansi["cyan"] = "\033[36m"
+    ansi["white"] = "\033[37m"
+    
+    # Background colors
+    ansi["back_black"] = "\033[40m"
+    ansi["back_red"] = "\033[41m"
+    ansi["back_green"] = "\033[42m"
+    ansi["back_yellow"] = "\033[43m"
+    ansi["back_blue"] = "\033[44m"
+    ansi["back_magenta"] = "\033[45m"
+    ansi["back_cyan"] = "\033[46m"
+    ansi["back_white"] = "\033[47m"
+    
+    # Formatting Characters
+    ansi["return"] = "\r\n"
+    ansi["tab"] = "\t"
+    ansi["space"] = " "
+    
+class BaseParser(object):
+    def parse_ansi(self, string, strip_ansi=False, strip_formatting=False):
+        """
+        Parses a string, subbing color codes as needed.
+        """
+        if string == None or string == '':
+            return ''
+        
+        # Convert to string to prevent problems with lists, ints, and other types.
+        string = str(string)
+        
+        # if strip_formatting:
+        #     char_return = ""
+        #     char_tab = ""
+        #     char_space = ""
+        # else:
+        #     char_return = ANSITable.ansi["return"]
+        #     char_tab = ANSITable.ansi["tab"]
+        #     char_space = ANSITable.ansi["space"]
+               
+        for sub in self.ansi_subs:
+            p = re.compile(sub[0], re.DOTALL)
+            if strip_ansi:
+                string = p.sub("", string)
+            else:
+                string = p.sub(sub[1], string)
+    
+        if strip_ansi:
+            return '%s' % (string)
+        else:
+            return '%s%s' % (string, ANSITable.ansi["normal"])
+
+class MuxANSIParser(BaseParser):
+    def __init__(self):
+        self.ansi_subs = [
+            (r'%r',  ANSITable.ansi["return"]),
+            (r'%t',  ANSITable.ansi["tab"]),
+            (r'%b',  ANSITable.ansi["space"]),
+            (r'%cf', ANSITable.ansi["blink"]),
+            (r'%ci', ANSITable.ansi["inverse"]),
+            (r'%ch', ANSITable.ansi["hilite"]),
+            (r'%cn', ANSITable.ansi["normal"]),
+            (r'%cx', ANSITable.ansi["black"]),
+            (r'%cX', ANSITable.ansi["back_black"]),
+            (r'%cr', ANSITable.ansi["red"]),
+            (r'%cR', ANSITable.ansi["back_red"]),
+            (r'%cg', ANSITable.ansi["green"]),
+            (r'%cG', ANSITable.ansi["back_green"]),
+            (r'%cy', ANSITable.ansi["yellow"]),
+            (r'%cY', ANSITable.ansi["back_yellow"]),
+            (r'%cb', ANSITable.ansi["blue"]),
+            (r'%cB', ANSITable.ansi["back_blue"]),
+            (r'%cm', ANSITable.ansi["magenta"]),
+            (r'%cM', ANSITable.ansi["back_magenta"]),
+            (r'%cc', ANSITable.ansi["cyan"]),
+            (r'%cC', ANSITable.ansi["back_cyan"]),
+            (r'%cw', ANSITable.ansi["white"]),
+            (r'%cW', ANSITable.ansi["back_white"]),
+        ]
+
+class ExtendedANSIParser(MuxANSIParser):
+    """
+    Extends the standard mux colour commands with {-style commands
+    (shortcuts for writing light/dark text without background)
+    """
+    def __init__(self):
+        super(ExtendedANSIParser, self).__init__()        
+        hilite = ANSITable.ansi['hilite']
+        normal = ANSITable.ansi['normal']
+        self.ansi_subs.extend( [
+        (r'{r', hilite + ANSITable.ansi['red']),    
+        (r'{R', normal + ANSITable.ansi['red']),    
+        (r'{g', hilite + ANSITable.ansi['green']),
+        (r'{G', normal + ANSITable.ansi['green']),
+        (r'{y', hilite + ANSITable.ansi['yellow']),
+        (r'{Y', normal + ANSITable.ansi['yellow']),
+        (r'{b', hilite + ANSITable.ansi['blue']),
+        (r'{B', normal + ANSITable.ansi['blue']),
+        (r'{m', hilite + ANSITable.ansi['magenta']),
+        (r'{M', normal + ANSITable.ansi['magenta']),
+        (r'{c', hilite + ANSITable.ansi['cyan']),
+        (r'{C', normal + ANSITable.ansi['cyan']),
+        (r'{w', hilite + ANSITable.ansi['white']), #white
+        (r'{W', normal + ANSITable.ansi['white']), #light grey
+        (r'{x', hilite + ANSITable.ansi['black']), #dark grey
+        (r'{X', normal + ANSITable.ansi['black']), #pure black
+        (r'{n', normal)                            #reset
+        ] )
+    
+#ANSI_PARSER = MuxANSIParser()
+ANSI_PARSER = ExtendedANSIParser()
+
+def parse_ansi(string, strip_ansi=False, strip_formatting=False, parser=ANSI_PARSER):
+    """
+    Parses a string, subbing color codes as needed.
+    """
+    return parser.parse_ansi(string, strip_ansi=strip_ansi, 
+                             strip_formatting=strip_formatting)
+def clean_ansi(string):
+    """
+    Cleans all ansi symbols from a string
+    """
+    # convert all to their ansi counterpart
+    string = parse_ansi(string)
+    # next, strip it all away
+    regex = re.compile("\033\[[0-9;]+m")
+    return regex.sub("", string) #replace all matches with empty strings