rouge 3.20.0 → 3.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0ad085dddf353cc95e795e5f556b4f2d9821068cceeeaab4cb34cb11f3ad776
-  data.tar.gz: f70271022198b1d7e95df35d856274234720d54d4ef3f1a42c782246e2cf4c47
+  metadata.gz: 35d2eb9627935d1f4e510d66263bddb55773667d8a441677019a377abaf3784e
+  data.tar.gz: 04370e4428e5f4c30a552d455bbf5655beeae8bf3ddc68db09ba0fbf76fee3e9
 SHA512:
-  metadata.gz: 473cfdc4ce0c458d0a7b0c3b1e6684723ceb7c15dea4d1080baf201786ecd149e9d21cd25f65735edbbf4b4f763a5d7d1854a4d909bef6902b7d609d30ebcc2b
-  data.tar.gz: 579d31241b2fe8d4f2b9471dd6bb97b5621051811260d02b21a012e9e35ccf34d83e0e998981e959aa0ce6a1b00932c06f7ed8b8b093fde95d53c7a8ebbb67ce
+  metadata.gz: fc847dd05c6d47cdbcc4296b60594faf8477b1c143e8f303c84a09bfbd88345baa5dbe19e4238ef6a37c79e59809616f649679070faf17f556838ce874cb95b9
+  data.tar.gz: 272f4948d1935e9e9c1eaae8e5230e5db42933dcf1e2130dad009d6d3e4c57fee656b4aead64d6933cadf836bd7d82287fbc8193032c1af7ebf21e53fc7fb403

data/lib/rouge.rb

@@ -83,6 +83,7 @@ Rouge.load_file 'formatters/html_table'
 Rouge.load_file 'formatters/html_pygments'
 Rouge.load_file 'formatters/html_legacy'
 Rouge.load_file 'formatters/html_linewise'
+Rouge.load_file 'formatters/html_line_highlighter'
 Rouge.load_file 'formatters/html_line_table'
 Rouge.load_file 'formatters/html_inline'
 Rouge.load_file 'formatters/terminal256'

data/lib/rouge/cli.rb

@@ -44,6 +44,7 @@ module Rouge
       yield %||
       yield %|where <command> is one of:|
       yield %|	highlight	#{Highlight.desc}|
+      yield %|	debug		#{Debug.desc}|
       yield %|	help		#{Help.desc}|
       yield %|	style		#{Style.desc}|
       yield %|	list		#{List.desc}|
@@ -104,6 +105,8 @@ module Rouge
         Help
       when 'highlight', 'hi'
         Highlight
+      when 'debug'
+        Debug
       when 'style'
         Style
       when 'list'
@@ -215,7 +218,7 @@ module Rouge
         end
       end
 
-      def self.parse(argv)
+      def self.parse_opts(argv)
         opts = {
           :formatter => supports_truecolor? ? 'terminal-truecolor' : 'terminal256',
           :theme => 'thankful_eyes',
@@ -256,7 +259,11 @@ module Rouge
           end
         end
 
-        new(opts)
+        opts
+      end
+
+      def self.parse(argv)
+        new(parse_opts(argv))
       end
 
       def input_stream
@@ -344,6 +351,29 @@ module Rouge
       end
     end
 
+    class Debug < Highlight
+      def self.desc
+      end
+
+      def self.doc
+        return enum_for(:doc) unless block_given?
+
+        yield %|usage: rougify debug [<options>]|
+        yield %||
+        yield %|Debug a lexer. Similar options to `rougify highlight`, but|
+        yield %|defaults to the `null` formatter, and ensures the `debug`|
+        yield %|option is enabled, to print debugging information to stdout.|
+      end
+
+      def self.parse_opts(argv)
+        out = super(argv)
+        out[:lexer_opts]['debug'] = '1'
+        out[:formatter] = 'null'
+
+        out
+      end
+    end
+
     class Style < CLI
       def self.desc
         "print CSS styles"

data/lib/rouge/demos/brightscript

@@ -0,0 +1,6 @@
+function main(args as dynamic) as void
+    screen = CreateObject("roSGScreen")
+    'Create a scene and load /components/helloworld.xml'
+    scene = screen.CreateScene("HelloWorld")
+    screen.show()
+end function

data/lib/rouge/demos/email

@@ -0,0 +1,11 @@
+From: Me <me@example.com>
+To: You <you@example.com>
+Date: Tue, 21 Jul 2020 15:14:03 +0000
+Subject: A very important message
+
+> Please investigate.  Thank you.
+
+I have investigated.
+
+-- 
+This message is highly confidential and will self-destruct.

data/lib/rouge/demos/j

@@ -0,0 +1,12 @@
+NB. Procedural programming
+fizzbuzz=: monad define
+  for_i. >:i.y do.
+    if.     0 = 15 | i do. echo'FizzBuzz'
+    elseif. 0 =  3 | i do. echo'Fizz'
+    elseif. 0 =  5 | i do. echo'Buzz'
+    else.                  echo i
+    end.
+  end.
+)
+NB. Loopless programming
+fizzbuzz=: echo@(, ::] ('Fizz' ; 'Buzz') ;@#~ 0 = 3 5&|)@>:@i.

data/lib/rouge/demos/janet

@@ -0,0 +1,3 @@
+(defn a-fun
+  "A function"
+  (do-something))

data/lib/rouge/demos/postscript

@@ -0,0 +1,9 @@
+%!PS
+/Courier             % name the desired font
+20 selectfont        % choose the size in points and establish
+                     % the font as the current one
+72 500 moveto        % position the current point at
+                     % coordinates 72, 500 (the origin is at the
+                     % lower-left corner of the page)
+(Hello world!) show  % stroke the text in parentheses
+showpage             % print all on the page

data/lib/rouge/demos/ssh

@@ -0,0 +1,4 @@
+Host example
+    Hostname example.com
+    User user
+    Port 1234

data/lib/rouge/demos/systemd

@@ -0,0 +1,4 @@
+[Unit]
+Description=Snap Daemon
+Requires=snapd.socket
+OnFailure=snapd.failure.service

data/lib/rouge/formatters/html_line_highlighter.rb

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*- #
+# frozen_string_literal: true
+
+module Rouge
+  module Formatters
+    class HTMLLineHighlighter < Formatter
+      tag 'html_line_highlighter'
+
+      def initialize(delegate, opts = {})
+        @delegate = delegate
+        @highlight_line_class = opts.fetch(:highlight_line_class, 'hll')
+        @highlight_lines = opts[:highlight_lines] || []
+      end
+
+      def stream(tokens)
+        token_lines(tokens).with_index(1) do |line_tokens, lineno|
+          line = %(#{@delegate.format(line_tokens)}\n)
+          line = %(<span class="#{@highlight_line_class}">#{line}</span>) if @highlight_lines.include? lineno
+          yield line
+        end
+      end
+    end
+  end
+end

data/lib/rouge/formatters/html_line_table.rb

@@ -32,10 +32,8 @@ module Rouge
       end
 
       def stream(tokens, &b)
-        lineno = @start_line - 1
         buffer = [%(<table class="#@table_class"><tbody>)]
-        token_lines(tokens) do |line_tokens|
-          lineno += 1
+        token_lines(tokens).with_index(@start_line) do |line_tokens, lineno|
           buffer << %(<tr id="#{sprintf @line_id, lineno}" class="#@line_class">)
           buffer << %(<td class="#@gutter_class gl" )
           buffer << %(style="-moz-user-select: none;-ms-user-select: none;)

data/lib/rouge/formatters/html_linewise.rb

@@ -11,9 +11,8 @@ module Rouge
       end
 
       def stream(tokens, &b)
-        lineno = 0
-        token_lines(tokens) do |line_tokens|
-          yield %(<#{@tag_name} class="#{sprintf @class_format, lineno += 1}">)
+        token_lines(tokens).with_index(1) do |line_tokens, lineno|
+          yield %(<#{@tag_name} class="#{sprintf @class_format, lineno}">)
           @formatter.stream(line_tokens) {|formatted| yield formatted }
           yield %(\n</#{@tag_name}>)
         end

data/lib/rouge/lexer.rb

@@ -38,28 +38,15 @@ module Rouge
         registry[name.to_s]
       end
 
-      # Find a lexer, with fancy shiny features.
-      #
-      # * The string you pass can include CGI-style options
-      #
-      #     Lexer.find_fancy('erb?parent=tex')
-      #
-      # * You can pass the special name 'guess' so we guess for you,
-      #   and you can pass a second argument of the code to guess by
-      #
-      #     Lexer.find_fancy('guess', "#!/bin/bash\necho Hello, world")
+      # Same as ::find_fancy, except instead of returning an instantiated
+      # lexer, returns a pair of [lexer_class, options], so that you can
+      # modify or provide additional options to the lexer.
       #
-      #   If the code matches more than one lexer then Guesser::Ambiguous
-      #   is raised.
-      #
-      # This is used in the Redcarpet plugin as well as Rouge's own
-      # markdown lexer for highlighting internal code blocks.
-      #
-      def find_fancy(str, code=nil, additional_options={})
-
+      # Please note: the lexer class might be nil!
+      def lookup_fancy(str, code=nil, default_options={})
         if str && !str.include?('?') && str != 'guess'
           lexer_class = find(str)
-          return lexer_class && lexer_class.new(additional_options)
+          return [lexer_class, default_options]
         end
 
         name, opts = str ? str.split('?', 2) : [nil, '']
@@ -75,7 +62,7 @@ module Rouge
           [ k.to_s, val ]
         end
 
-        opts = additional_options.merge(Hash[opts])
+        opts = default_options.merge(Hash[opts])
 
         lexer_class = case name
         when 'guess', nil
@@ -84,6 +71,29 @@ module Rouge
           self.find(name)
         end
 
+        [lexer_class, opts]
+      end
+
+      # Find a lexer, with fancy shiny features.
+      #
+      # * The string you pass can include CGI-style options
+      #
+      #     Lexer.find_fancy('erb?parent=tex')
+      #
+      # * You can pass the special name 'guess' so we guess for you,
+      #   and you can pass a second argument of the code to guess by
+      #
+      #     Lexer.find_fancy('guess', "#!/bin/bash\necho Hello, world")
+      #
+      #   If the code matches more than one lexer then Guesser::Ambiguous
+      #   is raised.
+      #
+      # This is used in the Redcarpet plugin as well as Rouge's own
+      # markdown lexer for highlighting internal code blocks.
+      #
+      def find_fancy(str, code=nil, default_options={})
+        lexer_class, opts = lookup_fancy(str, code, default_options)
+
         lexer_class && lexer_class.new(opts)
       end
 
@@ -317,6 +327,14 @@ module Rouge
       @debug = Lexer.debug_enabled? && bool_option('debug')
     end
 
+    # Returns a new lexer with the given options set. Useful for e.g. setting
+    # debug flags post hoc, or providing global overrides for certain options
+    def with(opts={})
+      new_options = @options.dup
+      opts.each { |k, v| new_options[k.to_s] = v }
+      self.class.new(new_options)
+    end
+
     def as_bool(val)
       case val
       when nil, false, 0, '0', 'false', 'off'

data/lib/rouge/lexers/apex.rb

@@ -49,7 +49,7 @@ module Rouge
 
       state :root do
         rule %r/\s+/m, Text
-        
+
         rule %r(//.*?$), Comment::Single
         rule %r(/\*.*?\*/)m, Comment::Multiline
 
@@ -57,17 +57,19 @@ module Rouge
         rule %r/import\b/, Keyword::Namespace, :import
 
         rule %r/([@$.]?)(#{id})([:(]?)/io do |m|
-          if self.class.keywords.include? m[0].downcase
+          lowercased = m[0].downcase
+          uppercased = m[0].upcase
+          if self.class.keywords.include? lowercased
             token Keyword
-          elsif self.class.soql.include? m[0].upcase
+          elsif self.class.soql.include? uppercased
             token Keyword
-          elsif self.class.declarations.include? m[0].downcase
+          elsif self.class.declarations.include? lowercased
             token Keyword::Declaration
-          elsif self.class.types.include? m[0].downcase
+          elsif self.class.types.include? lowercased
             token Keyword::Type
-          elsif self.class.constants.include? m[0].downcase
+          elsif self.class.constants.include? lowercased
             token Keyword::Constant
-          elsif 'package'.casecmp m[0]
+          elsif lowercased == 'package'
             token Keyword::Namespace
           elsif m[1] == "@"
             token Name::Decorator

data/lib/rouge/lexers/batchfile.rb

@@ -78,7 +78,8 @@ module Rouge
 
       state :basic do
         # Comments
-        rule %r/\brem\b.*$/i, Comment
+        rule %r/@?\brem\b.*$/i, Comment
+
         # Empty Labels
         rule %r/^::.*$/, Comment
 
@@ -105,7 +106,7 @@ module Rouge
           end
         end
 
-        rule %r/([\/\-+][a-z]+)\s*/i, Name::Attribute
+        rule %r/((?:[\/\+]|--?)[a-z]+)\s*/i, Name::Attribute
 
         mixin :expansions
 

data/lib/rouge/lexers/brightscript.rb

@@ -0,0 +1,147 @@
+# -*- coding: utf-8 -*- #
+# frozen_string_literal: true
+
+module Rouge
+  module Lexers
+    class Brightscript < RegexLexer
+      title "BrightScript"
+      desc "BrightScript Programming Language (https://developer.roku.com/en-ca/docs/references/brightscript/language/brightscript-language-reference.md)"
+      tag 'brightscript'
+      aliases 'bs', 'brs'
+      filenames '*.brs'
+
+      # https://developer.roku.com/en-ca/docs/references/brightscript/language/global-utility-functions.md
+      # https://developer.roku.com/en-ca/docs/references/brightscript/language/global-string-functions.md
+      # https://developer.roku.com/en-ca/docs/references/brightscript/language/global-math-functions.md
+      def self.name_builtin
+        @name_builtin ||= Set.new %w(
+          ABS ASC ATN CDBL CHR CINT CONTROL COPYFILE COS CREATEDIRECTORY CSNG
+          DELETEDIRECTORY DELETEFILE EXP FINDMEMBERFUNCTION FINDNODE FIX
+          FORMATDRIVEFORMATJSON GETINTERFACE INSTR INT LCASE LEFT LEN LISTDIR
+          LOG MATCHFILES MID MOVEFILE OBSERVEFIELD PARSEJSON PARSEXML
+          READASCIIFILE REBOOTSYSTEM RIGHT RND RUNGARBAGECOLLECTOR SGN SIN
+          SLEEP SQR STR STRI STRING STRINGI STRTOI SUBSTITUTE TANTEXTTOP TEXT
+          TRUCASE UPTIME VALVISIBLE VISIBLE WAIT
+        )
+      end
+
+      # https://developer.roku.com/en-ca/docs/references/brightscript/language/reserved-words.md
+      def self.keyword_reserved
+        @keyword_reserved ||= Set.new %w(
+          BOX CREATEOBJECT DIM EACH ELSE ELSEIF END ENDFUNCTION ENDIF ENDSUB
+          ENDWHILE EVAL EXIT EXITWHILE FALSE FOR FUNCTION GETGLOBALAA
+          GETLASTRUNCOMPILEERROR GETLASTRUNRUNTIMEERROR GOTO IF IN INVALID LET
+          LINE_NUM M NEXT OBJFUN POS PRINT REM RETURN RUN STEP STOP SUB TAB TO
+          TRUE TYPE WHILE
+        )
+      end
+
+      # These keywords are present in BrightScript, but not supported in standard .brs files
+      def self.keyword_reserved_unsupported
+        @keyword_reserved_unsupported ||= Set.new %w(
+          CLASS CONST IMPORT LIBRARY NAMESPACE PRIVATE PROTECTED PUBLIC
+        )
+      end
+
+      # https://developer.roku.com/en-ca/docs/references/brightscript/language/expressions-variables-types.md
+      def self.keyword_type
+        @keyword_type ||= Set.new %w(
+          BOOLEAN DIM DOUBLE DYNAMIC FLOAT FUNCTION INTEGER INTERFACE INVALID
+          LONGINTEGER OBJECT STRING VOID
+        )
+      end
+
+      # https://developer.roku.com/en-ca/docs/references/brightscript/language/expressions-variables-types.md#operators
+      def self.operator_word
+        @operator_word ||= Set.new %w(
+          AND AS MOD NOT OR THEN
+        )
+      end
+
+      # Scene graph components configured as builtins. See BrightScript component documentation e.g.
+      # https://developer.roku.com/en-ca/docs/references/brightscript/components/roappinfo.md
+      def self.builtins
+        @builtins ||= Set.new %w(
+          roAppendFile roAppInfo roAppManager roArray roAssociativeArray
+          roAudioGuide roAudioMetadata roAudioPlayer roAudioPlayerEvent
+          roAudioResourceroBitmap roBoolean roBoolean roBrightPackage roBrSub
+          roButton roByteArray roCaptionRenderer roCaptionRendererEvent
+          roCecInterface roCECStatusEvent roChannelStore roChannelStoreEvent
+          roClockWidget roCodeRegistrationScreen
+          roCodeRegistrationScreenEventroCompositor roControlDown roControlPort
+          roControlPort roControlUp roCreateFile roDatagramReceiver
+          roDatagramSender roDataGramSocket roDateTime roDeviceInfo
+          roDeviceInfoEvent roDoubleroEVPCipher roEVPDigest roFileSystem
+          roFileSystemEvent roFloat roFont roFontMetrics roFontRegistry
+          roFunction roGlobal roGpio roGridScreen roGridScreenEvent
+          roHdmiHotPlugEventroHdmiStatus roHdmiStatusEvent roHMAC roHttpAgent
+          roImageCanvas roImageCanvasEvent roImageMetadata roImagePlayer
+          roImageWidgetroInput roInputEvent roInt roInt roInvalid roInvalid
+          roIRRemote roKeyboard roKeyboardPress roKeyboardScreen
+          roKeyboardScreenEventroList roListScreen roListScreenEvent
+          roLocalization roLongInteger roMessageDialog roMessageDialogEvent
+          roMessagePort roMicrophone roMicrophoneEvent roNetworkConfiguration
+          roOneLineDialog roOneLineDialogEventroParagraphScreen
+          roParagraphScreenEvent roPath roPinEntryDialog roPinEntryDialogEvent
+          roPinentryScreen roPosterScreen roPosterScreenEventroProgramGuide
+          roQuadravoxButton roReadFile roRectangleroRegexroRegion roRegistry
+          roRegistrySection roResourceManager roRSA roRssArticle roRssParser
+          roScreen roSearchHistory roSearchScreen roSearchScreenEvent
+          roSerialPort roSGNode roSGNodeEvent roSGScreenroSGScreenEvent
+          roSlideShowroSlideShowEvent roSNS5 roSocketAddress roSocketEvent
+          roSpringboardScreen roSpringboardScreenEventroSprite roStorageInfo
+          roStreamSocket roStringroSystemLogroSystemLogEvent roSystemTime
+          roTextFieldroTextScreen roTextScreenEvent roTextToSpeech
+          roTextToSpeechEvent roTextureManager roTextureRequest
+          roTextureRequestEventroTextWidget roTimer roTimespan roTouchScreen
+          roTunerroTunerEvent roUniversalControlEvent roUrlEvent roUrlTransfer
+          roVideoEvent roVideoInput roVideoMode roVideoPlayer roVideoPlayerEvent
+          roVideoScreen roVideoScreenEventroWriteFile roXMLElement roXMLList
+        )
+      end
+
+      id = /[$a-z_][a-z0-9_]*/io
+
+      state :root do
+        rule %r/\s+/m, Text::Whitespace
+
+        # https://developer.roku.com/en-ca/docs/references/brightscript/language/expressions-variables-types.md#comments
+        rule %r/\'.*/, Comment::Single
+        rule %r/REM.*/i, Comment::Single
+
+        # https://developer.roku.com/en-ca/docs/references/brightscript/language/expressions-variables-types.md#operators
+        rule %r([~!%^&*+=\|?:<>/-]), Operator
+
+        rule %r/\d*\.\d+(e-?\d+)?/i, Num::Float
+        rule %r/\d+[lu]*/i, Num::Integer
+
+        rule %r/".*?"/, Str::Double
+
+        rule %r/#{id}(?=\s*[(])/, Name::Function
+
+        rule %r/[()\[\],.;{}]/, Punctuation
+
+        rule id do |m|
+          caseSensitiveChunk = m[0]
+          caseInsensitiveChunk = m[0].upcase
+
+          if self.class.builtins.include?(caseSensitiveChunk)
+            token Keyword::Reserved
+          elsif self.class.keyword_reserved.include?(caseInsensitiveChunk)
+            token Keyword::Reserved
+          elsif self.class.keyword_reserved_unsupported.include?(caseInsensitiveChunk)
+            token Keyword::Reserved
+          elsif self.class.keyword_type.include?(caseInsensitiveChunk)
+            token Keyword::Type
+          elsif self.class.name_builtin.include?(caseInsensitiveChunk)
+            token Name::Builtin
+          elsif self.class.operator_word.include?(caseInsensitiveChunk)
+            token Operator::Word
+          else
+            token Name
+          end
+        end
+      end
+    end
+  end
+end