R3EXS 1.0.5 → 1.1.1

data/lib/R3EXS/ast.rb

@@ -7,8 +7,21 @@ module R3EXS
     # 用来提取源码生成的 AST 中的字符串和符号
     class StringsExtractor < Prism::Visitor
 
+        # 提取后存储的字符串数组
+        #
+        # @return [Array<String>]
+        attr_reader :strings
+
+        # 是否包含脚本中的符号
+        #
+        # @return [Boolean]
+        attr_reader :with_symbol
+
+        # 初始化 StringsExtractor
+        #
         # @param strings [Array<String>] 存储提取出的字符串的数组
         # @param with_symbol [Boolean] 是否包含脚本中的符号
+        #
         # @return [StringsExtractor]
         def initialize(strings, with_symbol)
             @strings     = strings
@@ -18,6 +31,7 @@ module R3EXS
         # 处理类型为 StringNode 的节点
         #
         # @param node [Prism::StringNode] AST 节点
+        #
         # @return [void]
         def visit_string_node(node)
             @strings << node.content
@@ -27,22 +41,12 @@ module R3EXS
         # 处理类型为 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
 
     # 用来替换源码里面的字符串和符号
@@ -51,18 +55,6 @@ module R3EXS
         # 用来记录字符串的位置
         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]
@@ -78,9 +70,24 @@ module R3EXS
             # @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 hash [Hash<String, String>] 字符串翻译表
+        #
         # @return [StringsInjector]
         def initialize(hash)
             @strings_hash = hash
@@ -91,12 +98,13 @@ module R3EXS
         # 处理类型为 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)
-                @content_loc << Location.new(location.start_offset, location.length, @strings_hash[value])
+            if @strings_hash.has_key?(value) && @strings_hash[value].to_s != ''
+                @content_loc << Location.new(location.start_offset, location.length, value)
             end
             super
         end
@@ -104,30 +112,27 @@ module R3EXS
         # 处理类型为 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)
-                    @content_loc << Location.new(location.start_offset, location.length, @strings_hash[value])
+                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
 
-        # 将 file_path 对应位置的源码中的字符串替换成 '@strings_hash' 翻译后的字符串
+        # 将 script 源码中的字符串替换成 @strings_hash 翻译后的字符串
         #
-        # @param file_path [String] 源文件路径
+        # @param script [String] Ruby 源码，以二进制编码打开
         # @param ast_root [Prism::ProgramNode] AST 树根节点
+        #
         # @return [String]
-        def rewrite(file_path, ast_root)
-            # 读取文件内容
-            # 这里必须使用 rb 模式，因为 Prism 定位的位置是二进制下的位置
-            # 也就是说没有考虑换行符的问题，所以必须使用二进制模式读取文件
-            code = File.read(file_path, mode: 'rb')
-
+        def rewrite(script, ast_root)
             # 首先遍历一遍，找到所有需要替换的字符串的位置
             visit(ast_root)
 
@@ -138,17 +143,16 @@ module R3EXS
             #  然后将 code 切片，将字符串替换成新的字符串
             start_offset = 0
             @content_loc.each do |loc|
-                @code << code[start_offset...loc.start_offset]
-                @code << loc.content
+                @code << script[start_offset...loc.start_offset]
+                @code << @strings_hash[loc.content]
                 start_offset = loc.start_offset + loc.length
             end
-            @code << code[start_offset..-1]
+            @code << script[start_offset..-1]
 
-            # 将 @code 里面的字符串全部改为 UTF-8 编码
-            @code.map! { |str| str.force_encoding('UTF-8') }
+            # 将 @code 里面的字符串全部改为二进制编码
+            @code.map! { |str| str.force_encoding('ASCII-8BIT') unless str.nil? }
             @code.join
         end
-
     end
 
 end

data/lib/R3EXS/error.rb

@@ -5,222 +5,241 @@ module R3EXS
     # 用来处理 RPG 模块下的类型错误的异常
     class RPGTypeError < TypeError
 
+        # 引发异常的类
+        #
+        # @return [Object]
+        attr_reader :obj
+
+        # 初始化 RPGTypeError
+        #
         # @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
 
+        # 引发异常的类型
+        #
+        # @return [Object]
+        attr_reader :obj
+
+        # 初始化 R3EXSTypeError
+        #
         # @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
 
+        # 引发异常的 rgss3a 文件路径
+        #
+        # @return [String]
+        attr_reader :rgss3a_path
+
+        # 初始化 RGSS3AFileError
+        #
         # @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
 
+        # 引发异常的 rvdata2 文件路径
+        #
+        # @return [String]
+        attr_reader :rvdata2_path
+
+        # 初始化 Rvdata2FileError
+        #
         # @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
 
+        # 引发异常的 json 文件路径
+        #
+        # @return [String]
+        attr_reader :json_path
+
+        # 初始化 RPGJsonFileError
+        #
         # @param msg [String] 异常信息
         # @param json_path [String] 引发异常的 json 文件路径
+        #
         # @return [RPGJsonFileError]
         def initialize(msg = '', json_path)
             super(msg)
             @json_path = json_path
         end
+    end
+
+    # 用来处理 R3EXS 模块下 JSON 文件损坏的异常
+    class R3EXSJsonFileError < StandardError
 
         # 引发异常的 json 文件路径
         #
         # @return [String]
         attr_reader :json_path
-    end
-
-    # 用来处理 R3EXS 模块下 JSON 文件损坏的异常
-    class R3EXSJsonFileError < StandardError
 
+        # 初始化 R3EXSJsonFileError
+        #
         # @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 :rvdata2_path
     end
 
     # 用来处理模块名错误的异常
     class ModuleNameError < ArgumentError
 
+        # 引发异常的模块名
+        #
+        # @return [Symbol]
+        attr_reader :module_name
+
+        # 初始化 ModuleNameError
+        #
         # @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
 
+        # 引发异常的文件名
+        #
+        # @return [String]
+        attr_reader :filebasename
+
+        # 初始化 FileBaseNameError
+        #
         # @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
 
+        # 引发异常的 *.rvdata2 文件目录
+        #
+        # @return [String]
+        attr_reader :rvdata2_dir
+
+        # 初始化 Rvdata2DirError
+        #
         # @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
-
-    # 用来处理 *.rb 文件目录不存在的异常
-    class ScriptsDirError < IOError
 
+        # 初始化 JsonDirError
+        #
         # @param msg [String] 异常信息
-        # @param scripts_dir [String] 引发异常的 *.rb 文件目录
-        # @return [ScriptsDirError]
-        def initialize(msg = '', scripts_dir)
+        # @param json_dir [String] 引发异常的 *.json 文件目录
+        #
+        # @return [JsonDirError]
+        def initialize(msg = '', json_dir)
             super(msg)
-            @scripts_dir = scripts_dir
+            @json_dir = json_dir
         end
-
-        # 引发异常的 *.rb 文件目录
-        #
-        # @return [String]
-        attr_reader :scripts_dir
     end
 
     # 用来处理 Scripts_info.json 文件不存在的异常
     class ScriptsInfoPathError < IOError
 
+        # 引发异常的 Scripts_info.json 文件路径
+        #
+        # @return [String]
+        attr_reader :scripts_info_path
+
+        # 初始化 ScriptsInfoPathError
+        #
         # @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
 
+        # 引发异常的 ManualTransFile.json 文件路径
+        #
+        # @return [String]
+        attr_reader :manualtransfile_path
+
+        # 初始化 ManualTransFilePathError
+        #
         # @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

data/lib/R3EXS/extract_strings.rb

@@ -1,80 +1,76 @@
-# frozen_string_literal: true
-
-require 'zlib'
-require_relative 'ast'
-require_relative 'utils'
-require_relative 'RGSS3_R3EXS'
-
-module R3EXS
-
-    # 将 Ruby 源码中的字符串和符号提取出来
-    #
-    # @param target_dir [String] 目标目录
-    # @param with_symbol [Boolean] 是否包含脚本中的符号
-    #
-    # @raise [ScriptsDirError] Scripts 目录不存在
-    #
-    # @return [Array<String>]
-    def R3EXS.rb_ex_strings(target_dir, with_symbol)
-        full_dir = File.join(target_dir, 'Scripts')
-        Dir.exist?(full_dir) or raise ScriptsDirError.new(full_dir), "Scripts directory not found: #{full_dir}"
-
-        strings           = []
-        strings_extractor = StringsExtractor.new(strings, with_symbol)
-        Dir.glob(File.join(full_dir, '*.rb')).each do |script_file_path|
-            print "#{Utils::ESCAPE}#{Utils::MAGENTA_COLOR}Extracting from #{Utils::RESET_COLOR}#{script_file_path}...\r" if $global_options[:verbose]
-
-            strings_extractor.visit(Prism.parse_file(script_file_path).value)
-
-            print "#{Utils::ESCAPE}#{Utils::GREEN_COLOR}Extracted #{Utils::RESET_COLOR}#{script_file_path}\n" if $global_options[:verbose]
-        end
-        strings
-    end
-
-    # 将指定目录下的所有已经序列化为 R3EXS 后的 JOSN 文件中的字符串提取出来
-    #
-    # @param target_dir [String] 目标目录
-    # @param output_dir [String] 输出目录
-    # @param with_scripts [Boolean] 是否包含脚本
-    # @param with_symbol [Boolean] 是否包含脚本中的符号
-    # @param with_scripts_separate [Boolean] 是否将脚本提取的字符串单独存放
-    #
-    # @raise [R3EXSJsonFileError] json 文件不是 R3EXS 模块中的对象
-    # @raise [JsonDirError] target_dir 不存在
-    # @raise [ScriptsDirError] Scripts 目录不存在
-    #
-    # @return [void]
-    def R3EXS.ex_strings(target_dir, output_dir, with_scripts, with_symbol, with_scripts_separate)
-        FileUtils.mkdir(output_dir) unless Dir.exist?(output_dir)
-        all_ex_strings = []
-
-        Utils.all_json_files(target_dir, :R3EXS) do |object, file_basename|
-            file_path = File.join(target_dir, "#{file_basename}.json")
-            print "#{Utils::ESCAPE}#{Utils::MAGENTA_COLOR}Extracting from #{Utils::RESET_COLOR}#{file_path}...\r" if $global_options[:verbose]
-            if object.is_a?(Array)
-                object.each do |obj|
-                    all_ex_strings.concat(obj.ex_strings)
-                end
-            else
-                all_ex_strings.concat(object.ex_strings)
-            end
-            print "#{Utils::ESCAPE}#{Utils::GREEN_COLOR}Extracted #{Utils::RESET_COLOR}#{file_basename}\n" if $global_options[:verbose]
-        end
-
-        if with_scripts
-            scripts_strings = rb_ex_strings(target_dir, with_symbol)
-            if with_scripts_separate
-                # 去除 nil 元素
-                scripts_strings.compact!
-                Utils.object_json(scripts_strings.each_with_object({}) { |item, h| h[item] = item }, File.join(output_dir, 'ManualTransFile_scripts.json'))
-            else
-                all_ex_strings.concat(scripts_strings)
-            end
-        end
-
-        # 去除 nil 元素
-        all_ex_strings.compact!
-        Utils.object_json(all_ex_strings.each_with_object({}) { |item, h| h[item] = item }, File.join(output_dir, "ManualTransFile.json"))
-    end
-
+# frozen_string_literal: true
+
+require 'zlib'
+require_relative 'ast'
+require_relative 'utils'
+
+module R3EXS
+
+    # 将指定目录下的所有已经序列化为 R3EXS 后的 JOSN 文件中的字符串提取出来
+    #
+    # @param target_dir [Pathname] 目标目录
+    # @param output_dir [Pathname] 输出目录
+    # @param with_scripts [Boolean] 是否包含脚本
+    # @param with_symbol [Boolean] 是否包含脚本中的符号
+    # @param with_scripts_separate [Boolean] 是否将脚本提取的字符串单独存放
+    #
+    # @raise [R3EXSJsonFileError] json 文件不是 R3EXS 模块中的对象
+    # @raise [JsonDirError] target_dir 不存在
+    #
+    # @return [void]
+    def R3EXS.ex_strings(target_dir, output_dir, with_scripts, with_symbol, with_scripts_separate)
+        all_ex_strings = []
+
+        # 处理常规的 JSON 文件
+        Utils.all_json_files(target_dir, :R3EXS) do |object, file_basename, parent_relative_dir|
+            file_path = target_dir.join(parent_relative_dir, "#{file_basename}.json")
+            print "#{Utils::ESCAPE}#{Utils::MAGENTA_COLOR}Extracting from #{Utils::RESET_COLOR}#{file_path}...\r" if $global_options[:verbose]
+            if object.is_a?(Array)
+                object.each do |obj|
+                    all_ex_strings.concat(obj.ex_strings)
+                end
+            else
+                all_ex_strings.concat(object.ex_strings)
+            end
+            print "#{Utils::ESCAPE}#{Utils::GREEN_COLOR}Extracted #{Utils::RESET_COLOR}#{file_path}\n" if $global_options[:verbose]
+        end
+
+        # 处理 CommonEvent_\d{5}.json 文件
+        Utils.all_commonevent_json_files(target_dir, :R3EXS) do |commonevents, commonevents_basenames, parent_relative_dir|
+            commonevents.zip(commonevents_basenames).each do |commonevent, commonevent_basename|
+                file_path = target_dir.join(parent_relative_dir, "#{commonevent_basename}.json")
+                print "#{Utils::ESCAPE}#{Utils::MAGENTA_COLOR}Extracting from #{Utils::RESET_COLOR}#{file_path}...\r" if $global_options[:verbose]
+                all_ex_strings.concat(commonevent.ex_strings)
+                print "#{Utils::ESCAPE}#{Utils::GREEN_COLOR}Extracted #{Utils::RESET_COLOR}#{file_path}\n" if $global_options[:verbose]
+            end
+        end
+
+        # 处理 \d{5}.rb 文件
+        if with_scripts
+            all_rb_strings    = []
+            strings_extractor = StringsExtractor.new(all_rb_strings, with_symbol)
+
+            Utils.all_rb_files(target_dir) do |scripts, scripts_basenames, parent_relative_dir|
+                scripts.zip(scripts_basenames).each do |script, script_basename|
+                    file_path = target_dir.join(parent_relative_dir, "#{script_basename}.rb")
+                    print "#{Utils::ESCAPE}#{Utils::MAGENTA_COLOR}Extracting from #{Utils::RESET_COLOR}#{file_path}...\r" if $global_options[:verbose]
+                    strings_extractor.visit(Prism.parse(script).value)
+                    print "#{Utils::ESCAPE}#{Utils::GREEN_COLOR}Extracted #{Utils::RESET_COLOR}#{file_path}\n" if $global_options[:verbose]
+                end
+            end
+
+            if with_scripts_separate
+                # 去除 nil 元素
+                all_rb_strings.compact!
+                Utils.object_json(all_rb_strings.each_with_object({}) { |item, h| h[item] = item }, output_dir.join('ManualTransFile_scripts.json'))
+            else
+                all_ex_strings.concat(all_rb_strings)
+            end
+        end
+
+        # 去除 nil 元素
+        all_ex_strings.compact!
+        Utils.object_json(all_ex_strings.each_with_object({}) { |item, h| h[item] = item }, output_dir.join('ManualTransFile.json'))
+    end
+
 end