antares 0.1.0 → 0.2.0

data/lib/antares/tm_language_plist.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require "rexml/parsers/pullparser"
+require "rexml/text"
+
+module Antares
+  class TMLanguagePlist
+    ELEMENTS = %w[plist dict array key string integer real true false date data].freeze
+    PLIST_DOCTYPE = %r{<!DOCTYPE\s+plist\s+PUBLIC\s+
+      "-//Apple(?:\s+Computer)?//DTD\s+PLIST\s+1\.0//EN"\s+
+      "http://www\.apple\.com/DTDs/PropertyList-1\.0\.dtd"\s*>}ix
+    Frame = Struct.new(:name, :attributes, :text, :children, keyword_init: true)
+
+    def self.parse(source, max_depth:)
+      raise GrammarError, "tmLanguage XML entity declarations are unsupported" if source.match?(/<!ENTITY/i)
+      declaration = source.match(PLIST_DOCTYPE)
+      prefix = source[0...declaration.begin(0)] if declaration
+      if prefix&.match?(/\A\s*(?:<\?xml\b.*?\?>\s*)?\z/m)
+        source = prefix + source[declaration.end(0)..].to_s
+      end
+      raise GrammarError, "unsupported tmLanguage XML document type" if source.match?(/<!DOCTYPE/i)
+
+      new(source, max_depth).parse
+    rescue REXML::ParseException, ArgumentError, RangeError => error
+      raise GrammarError, "invalid tmLanguage plist: #{error.message.byteslice(0, 256)}"
+    end
+
+    def initialize(source, max_depth)
+      @parser = REXML::Parsers::PullParser.new(source)
+      @max_depth = max_depth
+      @frames = []
+      @roots = []
+    end
+
+    def parse
+      while @parser.has_next?
+        event = @parser.pull
+        case event.event_type
+        when :start_element then start(event[0], event[1])
+        when :end_element then finish(event[0])
+        when :text then text(event[0], entities: true)
+        when :cdata then text(event[0], entities: false)
+        end
+      end
+      raise GrammarError, "plist must contain one plist root" unless @frames.empty? && @roots.length == 1 && @roots.first.first == "plist"
+
+      @roots.first.last
+    end
+
+    private
+
+    def start(name, attributes)
+      raise GrammarError, "unsupported plist element #{name.inspect}" unless ELEMENTS.include?(name)
+      raise ResourceLimitError, "tmLanguage nesting exceeds #{@max_depth}" if @frames.length >= @max_depth
+      allowed_attributes = name == "plist" && (attributes.keys - ["version"]).empty?
+      raise GrammarError, "unsupported attributes on plist element #{name.inspect}" unless attributes.empty? || allowed_attributes
+
+      @frames << Frame.new(name: name, attributes: attributes, text: +"", children: [])
+    end
+
+    def text(value, entities:)
+      value = decode_entities(value) if entities
+      raise GrammarError, "text outside plist root" if @frames.empty? && !value.strip.empty?
+
+      @frames.last&.text&.concat(value)
+    end
+
+    def finish(name)
+      frame = @frames.pop
+      raise GrammarError, "mismatched plist element" unless frame&.name == name
+
+      value = decode(frame)
+      if @frames.empty?
+        @roots << [name, value]
+      else
+        @frames.last.children << [name, value]
+      end
+    end
+
+    def decode(frame)
+      scalar = !%w[plist dict array].include?(frame.name)
+      raise GrammarError, "plist container contains text" if !scalar && !frame.text.strip.empty?
+      raise GrammarError, "plist scalar contains child elements" if scalar && !frame.children.empty?
+
+      case frame.name
+      when "plist"
+        raise GrammarError, "plist root must contain one value" unless frame.children.length == 1
+
+        frame.children.first.last
+      when "dict" then decode_dict(frame.children)
+      when "array" then frame.children.map(&:last)
+      when "key", "string", "date", "data" then scalar_text(frame)
+      when "integer" then integer(scalar_text(frame))
+      when "real" then real(scalar_text(frame))
+      when "true" then boolean(frame, true)
+      when "false" then boolean(frame, false)
+      end
+    end
+
+    def scalar_text(frame)
+      frame.text
+    end
+
+    def decode_entities(value)
+      remainder = value.gsub(/&(?:amp|lt|gt|quot|apos|#\d+|#x[0-9a-f]+);/i, "")
+      raise GrammarError, "unsupported plist entity" if remainder.include?("&")
+
+      REXML::Text.unnormalize(value)
+    end
+
+    def decode_dict(children)
+      raise GrammarError, "plist dict must alternate keys and values" unless children.length.even?
+
+      result = {}
+      children.each_slice(2) do |key, entry|
+        raise GrammarError, "plist dict entry is missing a key" unless key.first == "key" && !key.last.empty?
+        raise GrammarError, "plist dict entry is missing a value" if entry.first == "key"
+        raise GrammarError, "duplicate plist key #{key.last.inspect}" if result.key?(key.last)
+
+        result[key.last] = entry.last
+      end
+      result
+    end
+
+    def integer(value)
+      raise GrammarError, "invalid plist integer" unless value.match?(/\A[+-]?\d{1,64}\z/)
+
+      Integer(value, 10)
+    end
+
+    def boolean(frame, value)
+      raise GrammarError, "plist boolean must be empty" unless frame.text.strip.empty?
+
+      value
+    end
+
+    def real(value)
+      number = Float(value)
+      raise GrammarError, "invalid plist real" unless number.finite?
+
+      number
+    rescue ArgumentError
+      raise GrammarError, "invalid plist real"
+    end
+  end
+end

data/lib/antares/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Antares
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/antares.rb

@@ -7,6 +7,7 @@ module Antares
   class Error < StandardError; end
   class UnsupportedLexerError < Error; end
   class ResourceLimitError < Error; end
+  class GrammarError < Error; end
 
   def self.compatible?(lexer)
     klass = lexer.is_a?(Class) ? lexer : lexer.class
@@ -19,3 +20,9 @@ require_relative "antares/compatibility"
 require_relative "antares/lexer_state_snapshot"
 require_relative "antares/lexer_driver"
 require_relative "antares/highlighter"
+require_relative "antares/structure"
+require_relative "antares/grammar"
+
+module Antares
+  private_constant :TMLanguageLexer, :TMLanguagePlist
+end

data/sig/antares.rbs

@@ -10,13 +10,39 @@ module Antares
   end
   class ResourceLimitError < Error
   end
+  class GrammarError < Error
+  end
 
   type strategy = :auto | :incremental | :window | :full
   type token = [Class, String]
   type row = Array[token]
+  type structure_kind = :block | :comment | :string | :region | :token | :line
+
+  interface _Structure
+    def fold_regions: (?Range[Integer]? range) -> Array[Region]
+    def brackets: (?Range[Integer]? range) -> Array[Bracket]
+    def bracket_at: (Integer line, Integer column) -> Bracket?
+    def context_at: (Integer line) -> Array[Region]
+    def selection_ranges: (Integer line, Integer column) -> Array[Region]
+    def edit: (from_line: Integer, removed: Integer, inserted: Integer) -> self
+  end
+
+  interface _StructureProvider
+    def new: (lines: ^(Integer) -> String, line_count: ^() -> Integer,
+      tokens_for: ^(Integer) -> row, tokens_in: ^(Range[Integer]) -> Array[row],
+      stabilize: ^(Integer) -> Integer) -> _Structure
+  end
 
   def self.compatible?: (untyped lexer) -> (:incremental | :window)
 
+  module Grammar
+    MAX_BYTES: Integer
+    MAX_DEPTH: Integer
+    MAX_RULES: Integer
+    MAX_REGEX_BYTES: Integer
+    def self.load_tmlanguage: (String path) -> untyped
+  end
+
   class LexerStateSnapshot
     attr_reader fingerprint: String
     attr_reader bytesize: Integer
@@ -43,5 +69,42 @@ module Antares
     def edit: (from_line: Integer, removed: Integer, inserted: Integer) -> self
     def advance: (until_line: Integer, ?from_line: Integer?) -> self
     def checkpoint_bytes: () -> Integer
+    def structure: () -> _Structure
+  end
+
+  class Bracket < Struct[untyped]
+    attr_accessor open_line: Integer
+    attr_accessor open_column: Integer
+    attr_accessor close_line: Integer
+    attr_accessor close_column: Integer
+    attr_accessor depth: Integer
+    attr_accessor kind: String
+    def self.new: (?open_line: Integer, ?open_column: Integer, ?close_line: Integer,
+      ?close_column: Integer, ?depth: Integer, ?kind: String) -> Bracket
+  end
+
+  class Region < Struct[untyped]
+    attr_accessor start_line: Integer
+    attr_accessor end_line: Integer
+    attr_accessor kind: structure_kind
+    attr_accessor label: String
+    attr_accessor start_column: Integer?
+    attr_accessor end_column: Integer?
+    def self.new: (?start_line: Integer, ?end_line: Integer, ?kind: structure_kind,
+      ?label: String, ?start_column: Integer?, ?end_column: Integer?) -> Region
+  end
+
+  class Structure
+    def self.register: (String | Symbol language, _StructureProvider provider) -> _StructureProvider
+    def self.unregister: (String | Symbol language) -> untyped
+    def initialize: (lines: ^(Integer) -> String, line_count: ^() -> Integer,
+      tokens_for: ^(Integer) -> row, tokens_in: ^(Range[Integer]) -> Array[row],
+      ?stabilize: ^(Integer) -> Integer) -> void
+    def fold_regions: (?Range[Integer]? range) -> Array[Region]
+    def brackets: (?Range[Integer]? range) -> Array[Bracket]
+    def bracket_at: (Integer line, Integer column) -> Bracket?
+    def context_at: (Integer line) -> Array[Region]
+    def selection_ranges: (Integer line, Integer column) -> Array[Region]
+    def edit: (from_line: Integer, removed: Integer, inserted: Integer) -> self
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: antares
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yudai Takada
@@ -23,6 +23,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 email:
 - t.yudai92@gmail.com
 executables: []
@@ -34,9 +54,13 @@ files:
 - README.md
 - lib/antares.rb
 - lib/antares/compatibility.rb
+- lib/antares/grammar.rb
 - lib/antares/highlighter.rb
 - lib/antares/lexer_driver.rb
 - lib/antares/lexer_state_snapshot.rb
+- lib/antares/structure.rb
+- lib/antares/tm_language_lexer.rb
+- lib/antares/tm_language_plist.rb
 - lib/antares/version.rb
 - sig/antares.rbs
 homepage: https://github.com/noxdea/antares
@@ -61,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.19
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Incremental highlighting for Rouge lexers
 test_files: []