oppen 0.9.0 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a496d964de133aa177270080b9444d8e9ef865ce1b355bef4a6c4a43462d48c
-  data.tar.gz: d2955b0983ef133fd374c1c46fc3424d9cff05c4ec910a6ca5ad94ec3f2db78d
+  metadata.gz: fdf36c265fd8c6c3d7335fe79b016ac1e6d8014a23f1b027fc4d956d05b442ab
+  data.tar.gz: d75772336cb34c8af929e95d5c4520f0388718739f7d6df722496f6f2f96a82a
 SHA512:
-  metadata.gz: d4319e6b5be2d8fa394cf8d6cd593c4e8ab0b5c1c0a313cc42e287a93b46e23a95d844b8bddd01e5547ac67faa4b04395d5edb5ae911380572a0df1b7acf0c95
-  data.tar.gz: 680e57e6f38f4cda980b57d04e787b4b33becc7b45de4c73810b243e82169411d62cd0d34b56a67df3e96debcc6d8a2ad777046aedec342429792fc91f3b3346
+  metadata.gz: 1d745467bc343f1262dbf36f1206a1a37336840014b6785badab602712fe167457b45598b4d2f10e4d438cb49935472c8fe9aea1e21109f349c6f52524831e8e
+  data.tar.gz: ad6279e7c29f9b6764fd19ddcdfc8fe006272eb481632d0a3f4f7fa9aad7a5b873e624ea5e829b89ee97401c474779034cfa956ff202e438a27afa22e6bd9151

data/lib/oppen/mixins.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Oppen
+  # Mixins.
+  module Mixins
+    # Rotates circular array and triples its size.
+    # This method is not for public use.
+    #
+    # @param arr [Array]
+    # @param offset [Integer] Rotation amount
+    #
+    # @return [Array<Array, Integer, Integer>] upsized array, lhs, rhs
+    def upsize_circular_array(arr, offset)
+      size = arr.size
+      arr = arr.rotate(offset)
+      arr.fill(nil, size, 2 * size)
+      [arr, 0, size]
+    end
+
+    # Convert a list of tokens to its wadler representation.
+    #
+    # @param tokens [Array[Token]]
+    # @param base_indent [Integer]
+    #
+    # @return [String]
+    def tokens_to_wadler(tokens, base_indent = 4)
+      out = StringIO.new
+      write = ->(txt, nb_spaces) {
+        out.write("#{' ' * nb_spaces}#{txt}\n")
+      }
+      nb_spaces = base_indent
+      tokens.each do |token|
+        case token
+        in Token::String
+          write.call("out.text '#{token}'", nb_spaces)
+        in Token::LineBreak
+          write.call('out.break', nb_spaces)
+        in Token::Break
+          write.call('out.breakable', nb_spaces)
+        in Token::Begin
+          write.call('out.group {', nb_spaces)
+          nb_spaces += 2
+        in Token::End
+          nb_spaces -= 2
+          write.call('}', nb_spaces)
+        in Token::EOF
+          write.call('', nb_spaces) # new line
+        end
+      end
+      out.string
+    end
+  end
+end

data/lib/oppen/print_stack.rb

@@ -33,15 +33,15 @@ module Oppen
     # Delimiter between lines in output
     attr_reader :new_line
 
-    # Page margin (Called length in the original paper).
-    attr_reader :margin
+    # Maximum allowed width for printing (Called length in the original paper).
+    attr_reader :width
 
     # Current available space (Called index in the original paper).
     #
     # @return [Integer] Current available space (Called index in the original paper).
     attr_reader :space
 
-    def initialize(margin, new_line, config, space, out)
+    def initialize(width, new_line, config, space, out)
       @buffer = out
       @config = config
       @genspace =
@@ -55,8 +55,8 @@ module Oppen
         end
       @items = []
       @new_line = new_line
-      @margin = margin
-      @space = margin
+      @width = width
+      @space = width
     end
 
     # Returns the output of the print stack
@@ -71,32 +71,32 @@ module Oppen
     # @note Called Print in the original paper.
     #
     # @param token [Token]
-    # @param token_length [Integer]
+    # @param token_width [Integer]
     #
     # @return [Nil]
-    def print(token, token_length)
+    def print(token, token_width)
       case token
       in Token::Begin
-        handle_begin token, token_length
+        handle_begin token, token_width
       in Token::End
         handle_end
       in Token::Break
-        handle_break token, token_length
+        handle_break token, token_width
       in Token::String
-        handle_string token, token_length
+        handle_string token, token_width
       end
     end
 
     # Handle Begin Token.
     #
     # @param token [Token]
-    # @param token_length [Integer]
+    # @param token_width [Integer]
     #
     # @return [Nil]
     #
     # @see Token::Begin
-    def handle_begin(token, token_length)
-      if token_length > space
+    def handle_begin(token, token_width)
+      if token_width > space
         type =
           if token.break_type == Token::BreakType::CONSISTENT
             Token::BreakType::CONSISTENT
@@ -129,16 +129,16 @@ module Oppen
     # Handle Break Token.
     #
     # @param token [Token]
-    # @param token_length [Integer]
+    # @param token_width [Integer]
     #
     # @return [Nil]
     #
     # @see Token::Break
-    def handle_break(token, token_length)
+    def handle_break(token, token_width)
       block = top
       case block.break_type
       in Token::BreakType::FITS
-        @space -= token.length
+        @space -= token.width
         write token
       in Token::BreakType::CONSISTENT
         @space = block.offset - token.offset
@@ -146,23 +146,23 @@ module Oppen
           if config&.indent_anchor == Config::IndentAnchor::ON_BEGIN
             token.offset
           else
-            margin - space
+            width - space
           end
         write token.line_continuation
         print_new_line indent
       in Token::BreakType::INCONSISTENT
-        if token_length > space
+        if token_width > space
           @space = block.offset - token.offset
           indent =
             if config&.indent_anchor == Config::IndentAnchor::ON_BEGIN
               token.offset
             else
-              margin - space
+              width - space
             end
           write token.line_continuation
           print_new_line indent
         else
-          @space -= token.length
+          @space -= token.width
           write token
         end
       end
@@ -171,13 +171,13 @@ module Oppen
     # Handle String Token.
     #
     # @param token [Token]
-    # @param token_length [Integer]
+    # @param token_width [Integer]
     #
     # @return [Nil]
     #
     # @see Token::String
-    def handle_string(token, token_length)
-      @space = [0, space - token_length].max
+    def handle_string(token, token_width)
+      @space = [0, space - token_width].max
       write token
     end
 
@@ -222,8 +222,8 @@ module Oppen
     def print_new_line(amount)
       write new_line
       if config&.indent_anchor == Config::IndentAnchor::ON_BEGIN
-        @space = margin - top.offset - amount
-        indent margin - space
+        @space = width - top.offset - amount
+        indent width - space
       else
         indent amount
       end

data/lib/oppen/printer.rb

@@ -4,11 +4,14 @@ require 'stringio'
 
 require_relative 'scan_stack'
 require_relative 'print_stack'
+require_relative 'mixins'
 
 # Oppen.
 module Oppen
   # Oppen pretty-printer.
   class Printer
+    extend Mixins
+
     attr_reader :config
     # Ring buffer left index.
     #
@@ -48,9 +51,18 @@ module Oppen
     # @note Called token in the original paper.
     attr_reader :tokens
 
-    # @note Called PrettyPrintInit in the original paper.
+    # Some description
+    #
+    # @example
+    #   "This is a string" # => and this is a comment
+    #   out = Oppen::Wadler.new (margin: 13) # Hawn
+    #   # Baliz
+    #
+    # @example
+    #   "This is a string" # => and this is a comment
+    #   # var = 12
     #
-    # @param margin   [Integer] maximum line width desired.
+    # @param width [Integer] maximum line width desired.
     # @param new_line [String]  the delimiter between lines.
     # @param config [Config]
     # @param space [String, Proc] could be a String or a callable.
@@ -60,18 +72,18 @@ module Oppen
     #   If it's a callable, it will receive `n` and it needs to return
     #   a string.
     # @param out [Object] should have a write and string method
-    def initialize(margin, new_line, config = Config.oppen,
+    def initialize(width, new_line, config = Config.oppen,
                    space = ' ', out = StringIO.new)
       # Maximum size if the stacks
-      n = 3 * margin
+      n = 3 * width
 
       @config = config
       @left = 0
       @left_total = 1
-      @print_stack = PrintStack.new margin, new_line, config, space, out
+      @print_stack = PrintStack.new width, new_line, config, space, out
       @right = 0
       @right_total = 1
-      @scan_stack = ScanStack.new n
+      @scan_stack = ScanStack.new n, config
       @size = Array.new n
       @tokens = Array.new n
     end
@@ -148,7 +160,7 @@ module Oppen
         tokens[right] = token
         size[right] = -1
         scan_stack.push right
-        if config&.eager_print &&
+        if config&.eager_print? &&
            (!scan_stack.empty? && right_total - left_total < print_stack.space)
           check_stack 0
           advance_left tokens[left], size[left]
@@ -174,7 +186,7 @@ module Oppen
       scan_stack.push right
       tokens[right] = token
       size[right] = -right_total
-      @right_total += token.length
+      @right_total += token.width
     end
 
     # Handle String Token.
@@ -184,12 +196,12 @@ module Oppen
     # @see Token::String
     def handle_string(token)
       if scan_stack.empty?
-        print_stack.print token, token.length
+        print_stack.print token, token.width
       else
         advance_right
         tokens[right] = token
-        size[right] = token.length
-        @right_total += token.length
+        size[right] = token.width
+        @right_total += token.width
         check_stream
       end
     end
@@ -217,10 +229,15 @@ module Oppen
     #
     # @return [Nil]
     def advance_right
-      @right = (right + 1) % scan_stack.length
+      @right = (right + 1) % @size.length
+
       return if right != left
 
-      raise 'Token queue full'
+      raise 'Token queue full' if !config.upsize_stack?
+
+      @scan_stack.update_indexes(-@left)
+      @size, _left, _right = ScanStack.upsize_circular_array(@size, @left)
+      @tokens, @left, @right = ScanStack.upsize_circular_array(@tokens, @left)
     end
 
     # Advances the `left` pointer and lets the print stack
@@ -229,16 +246,16 @@ module Oppen
     # @note Called AdvanceLeft as well in the original paper.
     #
     # @return [Nil]
-    def advance_left(token, token_length)
-      return if token_length.negative?
+    def advance_left(token, token_width)
+      return if token_width.negative?
 
-      print_stack.print token, token_length
+      print_stack.print token, token_width
 
       case token
       when Token::Break
-        @left_total += token.length
+        @left_total += token.width
       when Token::String
-        @left_total += token_length
+        @left_total += token_width
       end
 
       return if left == right

data/lib/oppen/scan_stack.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
+require_relative 'mixins'
+
 # Oppen.
 module Oppen
   # A fixed-size stack that can be popped from top and bottom.
   class ScanStack
-    def initialize(size)
+    extend Mixins
+
+    def initialize(size, config)
       @bottom = 0
+      @config = config
       @empty = true
       @stack = Array.new(size)
       @top = 0
@@ -68,7 +73,9 @@ module Oppen
       else
         @top = increment(@top)
         if @top == @bottom
-          raise 'Stack full'
+          raise 'Stack full' if !@config.upsize_stack?
+
+          @stack, @bottom, @top = ScanStack.upsize_circular_array(@stack, @bottom)
         end
       end
       @stack[@top] = value
@@ -107,5 +114,16 @@ module Oppen
       end
       res
     end
+
+    # Offset the values of the stack.
+    #
+    # @param offset [Integer]
+    #
+    # @return [Array[Integer]]
+    def update_indexes(offset)
+      @stack = @stack.map { |val|
+        (val + offset) % length if val
+      }
+    end
   end
 end

data/lib/oppen/token.rb

@@ -18,60 +18,50 @@ module Oppen
       CONSISTENT = 2
     end
 
-    # Default token length
+    # Default token width
     # @return [Integer]
-    def length
-      0
-    end
+    def width = 0
 
     # String Token.
     class String < Token
       # @return [String] String value.
       attr_reader :value
+      # @return [Integer]
+      attr_reader :width
 
-      def initialize(value)
+      def initialize(value, width: value.length)
         @value = value
+        @width = width
         super()
       end
 
-      # @return [Integer]
-      def length
-        value.length
-      end
-
       # @return [String]
-      def to_s
-        value
-      end
+      def to_s = value
     end
 
     # Break Token.
     class Break < Token
-      # @return [String] Break strings.
-      attr_reader :str
       # @return [String] If a new line is needed display this string before the new line
       attr_reader :line_continuation
       # @return [Integer] Indentation.
       attr_reader :offset
+      # @return [String] Break strings.
+      attr_reader :str
+      # @return [Integer]
+      attr_reader :width
 
-      def initialize(str = ' ', line_continuation: '', offset: 0)
+      def initialize(str = ' ', width: str.length, line_continuation: '', offset: 0)
         raise ArgumentError, 'line_continuation cannot be nil' if line_continuation.nil?
 
         @line_continuation = line_continuation
         @offset = offset
         @str = str
+        @width = width
         super()
       end
 
-      # @return [Integer]
-      def length
-        str.length
-      end
-
       # @return [String]
-      def to_s
-        str
-      end
+      def to_s = str
     end
 
     # Distinguished instance of Break which forces a line break.
@@ -79,9 +69,7 @@ module Oppen
       # Mock string that represents an infinite string to force new line.
       class LineBreakString
         # @return [Integer]
-        def length
-          999_999
-        end
+        def length = 999_999
       end
 
       def initialize(line_continuation: '', offset: 0)

data/lib/oppen/version.rb

@@ -5,5 +5,5 @@ module Oppen
   # Oppen version
   #
   # @return [String] current version
-  VERSION = '0.9.0' # managed by release.sh
+  VERSION = '0.9.2' # managed by release.sh
 end

data/lib/oppen.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'oppen/mixins'
 require_relative 'oppen/printer'
 require_relative 'oppen/print_stack'
 require_relative 'oppen/scan_stack'
@@ -9,6 +10,8 @@ require_relative 'wadler/print'
 
 # Oppen.
 module Oppen
+  extend Mixins
+
   # Entry point of the pretty printer.
   #
   # @param config [Config]
@@ -18,15 +21,15 @@ module Oppen
   #   to indent.
   #   If it's a callable, it will receive `n` and it needs to return
   #   a string.
-  # @param margin [Integer] maximum line width desired
   # @param new_line [String] the delimiter between lines
   # @param out [Object] should have a write and string method
   # @param tokens [Array[Token]] the list of tokens to be printed
+  # @param width [Integer] maximum line width desired
   #
   # @return [String] output of the pretty printer
   def self.print(config: Config.oppen, space: ' ',
-                 margin: 80, new_line: "\n", out: StringIO.new, tokens: [])
-    printer = Printer.new margin, new_line, config, space, out
+                 new_line: "\n", out: StringIO.new, tokens: [], width: 80)
+    printer = Printer.new width, new_line, config, space, out
     tokens.each do |token|
       printer.print token
     end
@@ -47,10 +50,17 @@ module Oppen
     end
 
     attr_accessor :indent_anchor
+
+    def initialize(indent_anchor: IndentAnchor::ON_BREAK, eager_print: false, upsize_stack: false)
+      @indent_anchor = indent_anchor
+      @eager_print = eager_print
+      @upsize_stack = upsize_stack
+    end
+
     # Print groups eagerly
     #
     # @example
-    #  out = Oppen::Wadler.new (margin: 13)
+    #  out = Oppen::Wadler.new (width: 13)
     #  out.group {
     #    out.group {
     #      out.text 'abc'
@@ -76,12 +86,9 @@ module Oppen
     #  # jkl
     #
     # @return [Boolean]
-    attr_accessor :eager_print
+    def eager_print? = @eager_print
 
-    def initialize(indent_anchor: IndentAnchor::ON_BREAK, eager_print: false)
-      @indent_anchor = indent_anchor
-      @eager_print = eager_print
-    end
+    def upsize_stack? = @upsize_stack
 
     # Default config for Oppen usage
     # @return [Config]
@@ -91,25 +98,27 @@ module Oppen
 
     # Default config for Wadler usage
     # @return [Config]
-    def self.wadler(eager_print: true)
-      new(indent_anchor: IndentAnchor::ON_BEGIN, eager_print:)
+    def self.wadler(eager_print: true, upsize_stack: true)
+      new(indent_anchor: IndentAnchor::ON_BEGIN, eager_print:, upsize_stack:)
     end
   end
 
   # @param value [String]
+  # @param width [Integer] token width that defaults to value.length
   #
   # @return [Oppen::Token::String] a new String token
-  def self.string(value)
-    Token::String.new(value)
+  def self.string(value, width: value.length)
+    Token::String.new(value, width:)
   end
 
   # @param str [String]
   # @param line_continuation [String] If a new line is needed display this string before the new line
   # @param offset [Integer]
+  # @param width [Integer] token width that defaults to str.length
   #
   # @return [Oppen::Token::Break] a new Break token
-  def self.break(str = ' ', line_continuation: '', offset: 0)
-    Token::Break.new(str, line_continuation:, offset:)
+  def self.break(str = ' ', line_continuation: '', offset: 0, width: str.length)
+    Token::Break.new(str, width:, line_continuation:, offset:)
   end
 
   # @param line_continuation [String] If a new line is needed display this string before the new line

data/lib/wadler/print.rb

@@ -7,10 +7,10 @@ module Oppen
     attr_reader :config
     attr_reader :current_indent
     attr_reader :space
-    attr_reader :margin
     attr_reader :new_line
     attr_reader :out
     attr_reader :tokens
+    attr_reader :width
 
     # @param config [Oppen::Config]
     # @param space [String, Proc] could be a String or a callable.
@@ -19,15 +19,15 @@ module Oppen
     #   to indent.
     #   If it's a callable, it will receive `n` and it needs to return
     #   a string.
-    # @param margin [Integer]
     # @param new_line [String]
     # @param out [Object] should have a write and string method
+    # @param width [Integer]
     def initialize(config: Config.wadler, space: ' ',
-                   margin: 80, new_line: "\n", out: StringIO.new)
+                   new_line: "\n", out: StringIO.new, width: 80)
       @config = config
       @current_indent = 0
       @space = space
-      @margin = margin
+      @width = width
       @new_line = new_line
       @out = out
       @tokens = []
@@ -38,7 +38,7 @@ module Oppen
       if !tokens.last.is_a? Oppen::Token::EOF
         tokens << Oppen.eof
       end
-      Oppen.print(tokens:, margin:, new_line:, config:, space:, out:)
+      Oppen.print(tokens:, new_line:, config:, space:, out:, width:)
     end
 
     # @param indent [Integer] group indentation
@@ -110,16 +110,16 @@ module Oppen
     # @param value [String]
     #
     # @return [Nil]
-    def text(value)
-      tokens << Oppen.string(value)
+    def text(value, width: value.length)
+      tokens << Oppen.string(value, width:)
     end
 
     # @param str [String]
     # @param line_continuation [String] If a new line is needed display this string before the new line
     #
     # @return [Nil]
-    def breakable(str = ' ', line_continuation: '')
-      tokens << Oppen.break(str, line_continuation:, offset: current_indent)
+    def breakable(str = ' ', width: str.length, line_continuation: '')
+      tokens << Oppen.break(str, width:, line_continuation:, offset: current_indent)
     end
 
     # @param line_continuation [String] If a new line is needed display this string before the new line

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oppen
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.2
 platform: ruby
 authors:
 - Amine Mike El Maalouf <amine.el-maalouf@epita.fr>
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-27 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies: []
 description: Implementation of the Oppen's pretty printing algorithm
 email: 
@@ -20,6 +20,7 @@ files:
 - LICENSE
 - README.md
 - lib/oppen.rb
+- lib/oppen/mixins.rb
 - lib/oppen/print_stack.rb
 - lib/oppen/printer.rb
 - lib/oppen/scan_stack.rb