R3EXS 1.1.0 → 2.0.0

data/lib/R3EXS/ast.rb

@@ -1,149 +1,209 @@
-# frozen_string_literal: true
-
-require 'prism'
-
-module R3EXS
-
-    # 用来提取源码生成的 AST 中的字符串和符号
-    class StringsExtractor < Prism::Visitor
-
-        # @param strings [Array<String>] 存储提取出的字符串的数组
-        # @param with_symbol [Boolean] 是否包含脚本中的符号
-        # @return [StringsExtractor]
-        def initialize(strings, with_symbol)
-            @strings     = strings
-            @with_symbol = with_symbol
-        end
-
-        # 处理类型为 StringNode 的节点
-        #
-        # @param node [Prism::StringNode] AST 节点
-        # @return [void]
-        def visit_string_node(node)
-            @strings << node.content
-            super
-        end
-
-        # 处理类型为 SymbolNode 的节点
-        #
-        # @param node [Prism::SymbolNode] AST 节点
-        # @return [void]
-        def visit_symbol_node(node)
-            @strings << node.value if @with_symbol
-            super
-        end
-
-        # 提取后存储的字符串数组
-        #
-        # @return [Array<String>]
-        attr_accessor :strings
-
-        # 是否包含脚本中的符号
-        #
-        # @return [Boolean]
-        attr_accessor :with_symbol
-
-    end
-
-    # 用来替换源码里面的字符串和符号
-    class StringsInjector < Prism::Visitor
-
-        # 用来记录字符串的位置
-        class Location
-
-            # @note start_offset 是字符串在二进制下打开时的位置
-            #
-            # @param start_offset [Integer] 字符串在源文件中的起始位置
-            # @param length [Integer] 字符串的长度
-            # @param content [String] 字符串内容
-            # @return [Location]
-            def initialize(start_offset, length, content)
-                @start_offset = start_offset
-                @length       = length
-                @content      = content
-            end
-
-            # 字符串在二进制源文件中的起始位置
-            #
-            # @return [Integer]
-            attr_reader :start_offset
-
-            # 字符串的长度
-            #
-            # @return [Integer]
-            attr_reader :length
-
-            # 字符串内容
-            #
-            # @return [String]
-            attr_reader :content
-
-        end
-
-        # @param hash [Hash<String, String>] 字符串翻译表
-        # @return [StringsInjector]
-        def initialize(hash)
-            @strings_hash = hash
-            @content_loc  = []
-            @code         = []
-        end
-
-        # 处理类型为 StringNode 的节点
-        #
-        # @param node [Prism::StringNode] AST 节点
-        # @return [void]
-        def visit_string_node(node)
-            location = node.content_loc
-            value    = location.slice
-            if @strings_hash.has_key?(value) && @strings_hash[value].to_s != ''
-                @content_loc << Location.new(location.start_offset, location.length, value)
-            end
-            super
-        end
-
-        # 处理类型为 SymbolNode 的节点
-        #
-        # @param node [Prism::SymbolNode] AST 节点
-        # @return [void]
-        def visit_symbol_node(node)
-            location = node.value_loc
-            # 如果 location 不为 nil，说明这个符号是一个字符串
-            if location
-                value = location.slice
-                if @strings_hash.has_key?(value) && @strings_hash[value].to_s != ''
-                    @content_loc << Location.new(location.start_offset, location.length, value)
-                end
-            end
-            super
-        end
-
-        # 将 script 源码中的字符串替换成 @strings_hash 翻译后的字符串
-        #
-        # @param script [String] Ruby 源码，以二进制编码打开
-        # @param ast_root [Prism::ProgramNode] AST 树根节点
-        # @return [String]
-        def rewrite(script, ast_root)
-            # 首先遍历一遍，找到所有需要替换的字符串的位置
-            visit(ast_root)
-
-            # 然后开始替换 code 中的字符串
-            # 先将 @content_loc 按照 start_offset 从小到大排序
-            @content_loc.sort_by! { |loc| loc.start_offset }
-
-            #  然后将 code 切片，将字符串替换成新的字符串
-            start_offset = 0
-            @content_loc.each do |loc|
-                @code << script[start_offset...loc.start_offset]
-                @code << @strings_hash[loc.content]
-                start_offset = loc.start_offset + loc.length
-            end
-            @code << script[start_offset..-1]
-
-            # 将 @code 里面的字符串全部改为二进制编码
-            @code.map! { |str| str.force_encoding('ASCII-8BIT') unless str.nil? }
-            @code.join
-        end
-
-    end
-
-end
+# frozen_string_literal: true
+
+require 'prism'
+
+module R3EXS
+  # 用来提取源码生成的 AST 中的字符串和符号
+  class StringsExtractor < Prism::Visitor
+    # 提取后存储的字符串数组
+    #
+    # @return [Array<String>]
+    attr_reader :strings
+
+    # 是否包含脚本中的符号
+    #
+    # @return [Boolean]
+    attr_reader :with_symbol
+
+    # AST 根节点
+    #
+    # @return [Prism::Node]
+    attr_reader :root_node
+
+    # 初始化 StringsExtractor
+    #
+    # @param script [String] Ruby 源码
+    # @param with_symbol [Boolean] 是否包含脚本中的符号
+    #
+    # @return [StringsExtractor]
+    def initialize(script, with_symbol)
+      super()
+      @strings = []
+      @with_symbol = with_symbol
+      @root_node = Prism.parse(script).value
+    end
+
+    # 处理类型为 StringNode 的节点
+    #
+    # @param node [Prism::StringNode] AST 节点
+    #
+    # @return [void]
+    def visit_string_node(node)
+      @strings << node.content
+      super
+    end
+
+    # 处理类型为 SymbolNode 的节点
+    #
+    # @param node [Prism::SymbolNode] AST 节点
+    #
+    # @return [void]
+    def visit_symbol_node(node)
+      @strings << node.value if @with_symbol
+      super
+    end
+
+    # 提取 script 源码中的字符串
+    #
+    # @return [Array<String>]
+    def extract
+      visit(@root_node)
+      @strings
+    end
+
+    # 提取 script 源码中的字符串
+    # @param script [String] Ruby 源码
+    # @param with_symbol [Boolean] 是否包含脚本中的符号
+    #
+    # @return [Array<String>]
+    def self.extract(script, with_symbol)
+      extractor = new(script, with_symbol)
+      extractor.extract
+    end
+  end
+
+  # 用来替换源码里面的字符串和符号
+  class StringsInjector < Prism::Visitor
+    # 字符串在二进制源文件中的位置
+    #
+    # @return [Array<Location>]
+    attr_reader :content_loc
+
+    # Ruby 源码
+    #
+    # @return [String]
+    attr_reader :script
+
+    # 字符串翻译表
+    #
+    # @return [Hash{String => String}]
+    attr_reader :strings_hash
+
+    # AST 根节点
+    #
+    # @return [Prism::Node]
+    attr_reader :root_node
+
+    # 用来记录字符串的位置
+    class Location
+      # 字符串在二进制源文件中的起始位置
+      #
+      # @return [Integer]
+      attr_reader :start_offset
+
+      # 字符串的长度
+      #
+      # @return [Integer]
+      attr_reader :length
+
+      # 字符串内容
+      #
+      # @return [String]
+      attr_reader :content
+
+      # @note start_offset 是字符串在二进制下打开时的位置
+      #
+      # @param start_offset [Integer] 字符串在源文件中的起始位置
+      # @param length [Integer] 字符串的长度
+      # @param content [String] 字符串内容
+      #
+      # @return [Location]
+      def initialize(start_offset, length, content)
+        @start_offset = start_offset
+        @length = length
+        @content = content
+      end
+    end
+
+    # 初始化 StringsInjector
+    #
+    # @param script [String] Ruby 源码
+    # @param hash [Hash{String => String}] 字符串翻译表
+    #
+    # @return [StringsInjector]
+    def initialize(script, hash)
+      super()
+      @content_loc = []
+      @script = script
+      @strings_hash = hash
+      @root_node = Prism.parse(script).value
+    end
+
+    # 处理类型为 StringNode 的节点
+    #
+    # @param node [Prism::StringNode] AST 节点
+    #
+    # @return [void]
+    def visit_string_node(node)
+      location = node.content_loc
+      value = location.slice
+      if @strings_hash.key?(value) && @strings_hash[value].to_s != ''
+        @content_loc << Location.new(location.start_offset, location.length, value)
+      end
+      super
+    end
+
+    # 处理类型为 SymbolNode 的节点
+    #
+    # @param node [Prism::SymbolNode] AST 节点
+    #
+    # @return [void]
+    def visit_symbol_node(node)
+      location = node.value_loc
+      # 如果 location 不为 nil，说明这个符号是一个字符串
+      if location
+        value = location.slice
+        if @strings_hash.key?(value) && @strings_hash[value].to_s != ''
+          @content_loc << Location.new(location.start_offset, location.length, value)
+        end
+      end
+      super
+    end
+
+    # 将 script 源码中的字符串替换成 @strings_hash 翻译后的字符串
+    #
+    # @return [String]
+    def inject
+      code = []
+      # 首先遍历一遍，找到所有需要替换的字符串的位置
+      visit(@root_node)
+
+      # 然后开始替换 code 中的字符串
+      # 先将 @content_loc 按照 start_offset 从小到大排序
+      @content_loc.sort_by!(&:start_offset)
+
+      # 然后将 code 切片，将字符串替换成新的字符串
+      # 注意 Prism.parse 得到的位置是字节的偏移量，而 UTF-8 是变长编码，所以需要使用 byteslice 来切片
+      start_offset = 0
+      @content_loc.each do |loc|
+        code << @script.byteslice(start_offset...loc.start_offset)
+        code << @strings_hash[loc.content]
+        start_offset = loc.start_offset + loc.length
+      end
+      code << @script.byteslice(start_offset..)
+
+      code.join
+    end
+
+    # 将 script 源码中的字符串替换成 @strings_hash 翻译后的字符串
+    #
+    # @param script [String] Ruby 源码
+    # @param hash [Hash{String => String}] 字符串翻译表
+    #
+    # @return [String]
+    def self.inject(script, hash)
+      injector = new(script, hash)
+      injector.inject
+    end
+  end
+end

data/lib/R3EXS/error.rb

@@ -1,209 +1,39 @@
-# frozen_string_literal: true
-
-module R3EXS
-
-    # 用来处理 RPG 模块下的类型错误的异常
-    class RPGTypeError < TypeError
-
-        # @param msg [String] 异常信息
-        # @param obj [Object] 引发异常的类
-        # @return [RPGTypeError]
-        def initialize(msg = '', obj)
-            super(msg)
-            @obj = obj
-        end
-
-        # 引发异常的类
-        #
-        # @return [Object]
-        attr_reader :obj
-    end
-
-    # 用来处理 R3EXS 模块下的类型错误的异常
-    class R3EXSTypeError < TypeError
-
-        # @param msg [String] 异常信息
-        # @param obj [Object] 引发异常的的类型
-        # @return [R3EXSTypeError]
-        def initialize(msg = '', obj)
-            super(msg)
-            @obj = obj
-        end
-
-        # 引发异常的类型
-        #
-        # @return [Object]
-        attr_reader :obj
-    end
-
-    # 用来处理 Game.rgss3a 文件加密格式不支持的异常
-    class RGSS3AFileError < StandardError
-
-        # @param msg [String] 异常信息
-        # @param rgss3a_path [String] 引发异常的 rgss3a 文件路径
-        # @return [Rvdata2DirError]
-        def initialize(msg = '', rgss3a_path)
-            super(msg)
-            @rgss3a_path = rgss3a_path
-        end
-
-        # 引发异常的 rgss3a 文件路径
-        #
-        # @return [String]
-        attr_reader :rgss3a_path
-    end
-
-    # 用来处理 rvdata2 文件损坏的异常
-    class Rvdata2FileError < StandardError
-
-        # @param msg [String] 异常信息
-        # @param rvdata2_path [String] 引发异常的 rvdata2 文件路径
-        # @return [Rvdata2DirError]
-        def initialize(msg = '', rvdata2_path)
-            super(msg)
-            @rvdata2_path = rvdata2_path
-        end
-
-        # 引发异常的 rvdata2 文件路径
-        #
-        # @return [String]
-        attr_reader :rvdata2_path
-    end
-
-    # 用来处理 RPG 模块下 JSON 文件损坏的异常
-    class RPGJsonFileError < StandardError
-
-        # @param msg [String] 异常信息
-        # @param json_path [String] 引发异常的 json 文件路径
-        # @return [RPGJsonFileError]
-        def initialize(msg = '', json_path)
-            super(msg)
-            @json_path = json_path
-        end
-
-        # 引发异常的 json 文件路径
-        #
-        # @return [String]
-        attr_reader :json_path
-    end
-
-    # 用来处理 R3EXS 模块下 JSON 文件损坏的异常
-    class R3EXSJsonFileError < StandardError
-
-        # @param msg [String] 异常信息
-        # @param json_path [String] 引发异常的 json 文件路径
-        # @return [R3EXSJsonFileError]
-        def initialize(msg = '', json_path)
-            super(msg)
-            @json_path = json_path
-        end
-
-        # 引发异常的 json 文件路径
-        #
-        # @return [String]
-        attr_reader :json_path
-    end
-
-    # 用来处理模块名错误的异常
-    class ModuleNameError < ArgumentError
-
-        # @param msg [String] 异常信息
-        # @param module_name [Symbol] 引发异常的模块名
-        # @return [ModuleNameError]
-        def initialize(msg = '', module_name)
-            super(msg)
-            @module_name = module_name
-        end
-
-        # 引发异常的模块名
-        #
-        # @return [Symbol]
-        attr_reader :module_name
-    end
-
-    # 用来处理文件名错误的异常
-    class FileBaseNameError < ArgumentError
-
-        # @param msg [String] 异常信息
-        # @param filebasename [String] 引发异常的文件名
-        # @return [FileBaseNameError]
-        def initialize(msg = '', filebasename)
-            super(msg)
-            @filebasename = filebasename
-        end
-
-        # 引发异常的文件名
-        #
-        # @return [String]
-        attr_reader :filebasename
-    end
-
-    # 用来处理 *.rvdata2 文件目录不存在的异常
-    class Rvdata2DirError < IOError
-
-        # @param msg [String] 异常信息
-        # @param rvdata2_dir [String] 引发异常的 *.rvdata2 文件目录
-        # @return [Rvdata2DirError]
-        def initialize(msg = '', rvdata2_dir)
-            super(msg)
-            @rvdata2_dir = rvdata2_dir
-        end
-
-        # 引发异常的 *.rvdata2 文件目录
-        #
-        # @return [String]
-        attr_reader :rvdata2_dir
-    end
-
-    # 用来处理 *.json 文件目录不存在的异常
-    class JsonDirError < IOError
-
-        # @param msg [String] 异常信息
-        # @param json_dir [String] 引发异常的 *.json 文件目录
-        # @return [JsonDirError]
-        def initialize(msg = '', json_dir)
-            super(msg)
-            @json_dir = json_dir
-        end
-
-        # 引发异常的 *.json 文件目录
-        #
-        # @return [String]
-        attr_reader :json_dir
-    end
-
-    # 用来处理 Scripts_info.json 文件不存在的异常
-    class ScriptsInfoPathError < IOError
-
-        # @param msg [String] 异常信息
-        # @param scripts_info_path [String] 引发异常的 Scripts_info.json 文件路径
-        # @return [ScriptsInfoPathError]
-        def initialize(msg = '', scripts_info_path)
-            super(msg)
-            @scripts_info_path = scripts_info_path
-        end
-
-        # 引发异常的 Scripts_info.json 文件路径
-        #
-        # @return [String]
-        attr_reader :scripts_info_path
-    end
-
-    # 用来处理 ManualTransFile.json 文件不存在的异常
-    class ManualTransFilePathError < IOError
-
-        # @param msg [String] 异常信息
-        # @param manualtransfile_path [String] 引发异常的 ManualTransFile.json 文件路径
-        # @return [ManualTransFilePathError]
-        def initialize(msg = '', manualtransfile_path)
-            super(msg)
-            @manualtransfile_path = manualtransfile_path
-        end
-
-        # 引发异常的 ManualTransFile.json 文件路径
-        #
-        # @return [String]
-        attr_reader :manualtransfile_path
-    end
-
-end
+# frozen_string_literal: true
+
+module R3EXS
+  # 用来处理 Game.rgss3a 文件加密格式不支持的异常
+  class RGSS3AFileError < StandardError
+  end
+
+  # 用来处理 RPG 模块下 JSON 文件损坏的异常
+  class RPGJsonFileError < StandardError
+  end
+
+  # 用来处理 R3EXS 模块下 JSON 文件损坏的异常
+  class R3EXSJsonFileError < StandardError
+  end
+
+  # 用来处理模块名错误的异常
+  class ModuleNameError < ArgumentError
+  end
+
+  # 用来处理 *.rvdata2 文件目录不存在的异常
+  class Rvdata2DirError < IOError
+  end
+
+  # 用来处理 *.json 文件目录不存在的异常
+  class JsonDirError < IOError
+  end
+
+  # 用来处理 Rvdata2 文件不存在的异常
+  class Rvdata2PathError < IOError
+  end
+
+  # 用来处理 Scripts_info.json 文件不存在的异常
+  class ScriptsInfoPathError < IOError
+  end
+
+  # 用来处理 ManualTransFile.json 文件不存在的异常
+  class ManualTransFilePathError < IOError
+  end
+end