BigW Consortium Gitlab

ansi2html.rb 7.43 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
# ANSI color library
#
# Implementation per http://en.wikipedia.org/wiki/ANSI_escape_code
module Ci
  module Ansi2html
    # keys represent the trailing digit in color changing command (30-37, 40-47, 90-97. 100-107)
    COLOR = {
      0 => 'black', # not that this is gray in the intense color table
      1 => 'red',
      2 => 'green',
      3 => 'yellow',
      4 => 'blue',
      5 => 'magenta',
      6 => 'cyan',
      7 => 'white', # not that this is gray in the dark (aka default) color table
    }

    STYLE_SWITCHES = {
      bold:       0x01,
      italic:     0x02,
      underline:  0x04,
      conceal:    0x08,
      cross:      0x10,
    }

26 27
    def self.convert(ansi, state = nil)
      Converter.new.convert(ansi, state)
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
    end

    class Converter
      def on_0(s) reset()                            end
      def on_1(s) enable(STYLE_SWITCHES[:bold])      end
      def on_3(s) enable(STYLE_SWITCHES[:italic])    end
      def on_4(s) enable(STYLE_SWITCHES[:underline]) end
      def on_8(s) enable(STYLE_SWITCHES[:conceal])   end
      def on_9(s) enable(STYLE_SWITCHES[:cross])     end

      def on_21(s) disable(STYLE_SWITCHES[:bold])      end
      def on_22(s) disable(STYLE_SWITCHES[:bold])      end
      def on_23(s) disable(STYLE_SWITCHES[:italic])    end
      def on_24(s) disable(STYLE_SWITCHES[:underline]) end
      def on_28(s) disable(STYLE_SWITCHES[:conceal])   end
      def on_29(s) disable(STYLE_SWITCHES[:cross])     end

      def on_30(s) set_fg_color(0) end
      def on_31(s) set_fg_color(1) end
      def on_32(s) set_fg_color(2) end
      def on_33(s) set_fg_color(3) end
      def on_34(s) set_fg_color(4) end
      def on_35(s) set_fg_color(5) end
      def on_36(s) set_fg_color(6) end
      def on_37(s) set_fg_color(7) end
      def on_38(s) set_fg_color_256(s) end
      def on_39(s) set_fg_color(9) end

      def on_40(s) set_bg_color(0) end
      def on_41(s) set_bg_color(1) end
      def on_42(s) set_bg_color(2) end
      def on_43(s) set_bg_color(3) end
      def on_44(s) set_bg_color(4) end
      def on_45(s) set_bg_color(5) end
      def on_46(s) set_bg_color(6) end
      def on_47(s) set_bg_color(7) end
      def on_48(s) set_bg_color_256(s) end
      def on_49(s) set_bg_color(9) end

      def on_90(s) set_fg_color(0, 'l') end
      def on_91(s) set_fg_color(1, 'l') end
      def on_92(s) set_fg_color(2, 'l') end
      def on_93(s) set_fg_color(3, 'l') end
      def on_94(s) set_fg_color(4, 'l') end
      def on_95(s) set_fg_color(5, 'l') end
      def on_96(s) set_fg_color(6, 'l') end
      def on_97(s) set_fg_color(7, 'l') end
      def on_99(s) set_fg_color(9, 'l') end

      def on_100(s) set_bg_color(0, 'l') end
      def on_101(s) set_bg_color(1, 'l') end
      def on_102(s) set_bg_color(2, 'l') end
      def on_103(s) set_bg_color(3, 'l') end
      def on_104(s) set_bg_color(4, 'l') end
      def on_105(s) set_bg_color(5, 'l') end
      def on_106(s) set_bg_color(6, 'l') end
      def on_107(s) set_bg_color(7, 'l') end
      def on_109(s) set_bg_color(9, 'l') end

87 88 89 90 91 92 93 94 95 96 97 98
      attr_accessor :offset, :n_open_tags, :fg_color, :bg_color, :style_mask

      STATE_PARAMS = [:offset, :n_open_tags, :fg_color, :bg_color, :style_mask]

      def convert(raw, new_state)
        reset_state
        restore_state(new_state) if new_state && new_state[:offset].to_i < raw.length

        start = @offset
        ansi = raw[@offset..-1]

        open_new_tag
99

100
        s = StringScanner.new(ansi)
101 102 103
        while(!s.eos?)
          if s.scan(/\e([@-_])(.*?)([@-~])/)
            handle_sequence(s)
104 105 106 107
          elsif s.scan(/\e(([@-_])(.*?)?)?$/)
            break
          elsif s.scan(/</)
            @out << '&lt;'
108 109 110
          else
            @out << s.scan(/./m)
          end
111
          @offset += s.matched_size
112 113 114
        end

        close_open_tags()
115 116

        { state: state, html: @out, text: ansi[0, @offset - start], append: start > 0 }
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
      end

      def handle_sequence(s)
        indicator = s[1]
        commands = s[2].split ';'
        terminator = s[3]

        # We are only interested in color and text style changes - triggered by
        # sequences starting with '\e[' and ending with 'm'. Any other control
        # sequence gets stripped (including stuff like "delete last line")
        return unless indicator == '[' and terminator == 'm'

        close_open_tags()

        if commands.empty?()
          reset()
          return
        end

        evaluate_command_stack(commands)

138 139 140 141 142 143 144 145 146 147 148 149 150 151
        open_new_tag
      end

      def evaluate_command_stack(stack)
        return unless command = stack.shift()

        if self.respond_to?("on_#{command}", true)
          self.send("on_#{command}", stack)
        end

        evaluate_command_stack(stack)
      end

      def open_new_tag
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
        css_classes = []

        unless @fg_color.nil?
          fg_color = @fg_color
          # Most terminals show bold colored text in the light color variant
          # Let's mimic that here
          if @style_mask & STYLE_SWITCHES[:bold] != 0
            fg_color.sub!(/fg-(\w{2,}+)/, 'fg-l-\1')
          end
          css_classes << fg_color
        end
        css_classes << @bg_color unless @bg_color.nil?

        STYLE_SWITCHES.each do |css_class, flag|
          css_classes << "term-#{css_class}" if @style_mask & flag != 0
        end

169
        return if css_classes.empty?
170 171 172 173 174 175 176 177 178 179 180 181

        @out << %{<span class="#{css_classes.join(' ')}">}
        @n_open_tags += 1
      end

      def close_open_tags
        while @n_open_tags > 0
          @out << %{</span>}
          @n_open_tags -= 1
        end
      end

182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
      def reset_state
        @offset = 0
        @n_open_tags = 0
        @out = ''
        reset
      end

      def state
        STATE_PARAMS.inject({}) do |h, param|
          h[param] = send(param)
          h
        end
      end

      def restore_state(new_state)
        STATE_PARAMS.each do |param|
          send("#{param}=".to_sym, new_state[param])
        end
      end

202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
      def reset
        @fg_color = nil
        @bg_color = nil
        @style_mask = 0
      end

      def enable(flag)
        @style_mask |= flag
      end

      def disable(flag)
        @style_mask &= ~flag
      end

      def set_fg_color(color_index, prefix = nil)
        @fg_color = get_term_color_class(color_index, ["fg", prefix])
      end

      def set_bg_color(color_index, prefix = nil)
        @bg_color = get_term_color_class(color_index, ["bg", prefix])
      end

      def get_term_color_class(color_index, prefix)
        color_name = COLOR[color_index]
        return nil if color_name.nil?

        get_color_class(["term", prefix, color_name])
      end

      def set_fg_color_256(command_stack)
        css_class = get_xterm_color_class(command_stack, "fg")
        @fg_color = css_class unless css_class.nil?
      end

      def set_bg_color_256(command_stack)
        css_class = get_xterm_color_class(command_stack, "bg")
        @bg_color = css_class unless css_class.nil?
      end

      def get_xterm_color_class(command_stack, prefix)
        # the 38 and 48 commands have to be followed by "5" and the color index
        return unless command_stack.length >= 2
        return unless command_stack[0] == "5"

        command_stack.shift() # ignore the "5" command
        color_index = command_stack.shift().to_i

        return unless color_index >= 0
        return unless color_index <= 255

        get_color_class(["xterm", prefix, color_index])
      end

      def get_color_class(segments)
        [segments].flatten.compact.join('-')
      end
    end
  end
end