R3EXS 1.1.0 → 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,6 +98,7 @@ module R3EXS
         # 处理类型为 StringNode 的节点
         #
         # @param node [Prism::StringNode] AST 节点
+        #
         # @return [void]
         def visit_string_node(node)
             location = node.content_loc
@@ -104,6 +112,7 @@ module R3EXS
         # 处理类型为 SymbolNode 的节点
         #
         # @param node [Prism::SymbolNode] AST 节点
+        #
         # @return [void]
         def visit_symbol_node(node)
             location = node.value_loc
@@ -121,6 +130,7 @@ module R3EXS
         #
         # @param script [String] Ruby 源码，以二进制编码打开
         # @param ast_root [Prism::ProgramNode] AST 树根节点
+        #
         # @return [String]
         def rewrite(script, ast_root)
             # 首先遍历一遍，找到所有需要替换的字符串的位置
@@ -143,7 +153,6 @@ module R3EXS
             @code.map! { |str| str.force_encoding('ASCII-8BIT') unless str.nil? }
             @code.join
         end
-
     end
 
 end

data/lib/R3EXS/error.rb

@@ -5,205 +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 :json_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
 
+        # 引发异常的 *.json 文件目录
+        #
+        # @return [String]
+        attr_reader :json_dir
+
+        # 初始化 JsonDirError
+        #
         # @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
 
+        # 引发异常的 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

@@ -3,7 +3,6 @@
 require 'zlib'
 require_relative 'ast'
 require_relative 'utils'
-require_relative 'RGSS3_R3EXS'
 
 module R3EXS
 

data/lib/R3EXS/inject_strings.rb

@@ -3,7 +3,6 @@
 require 'zlib'
 require_relative 'ast'
 require_relative 'utils'
-require_relative 'RGSS3_R3EXS'
 
 module R3EXS
 

data/lib/R3EXS/json_rvdata2.rb

@@ -2,7 +2,6 @@
 
 require 'zlib'
 require_relative 'utils'
-require_relative 'RGSS3_R3EXS'
 
 module R3EXS
 

data/lib/R3EXS/rvdata2_json.rb

@@ -2,7 +2,6 @@
 
 require 'zlib'
 require_relative 'utils'
-require_relative 'RGSS3_R3EXS'
 
 module R3EXS
 
@@ -10,6 +9,7 @@ module R3EXS
     #
     # @param scripts [Array<Object>] 待转换的 Script 对象数组
     # @param output_dir [Pathname] 输出目录
+    #
     # @return [void]
     def R3EXS.scripts_rb(scripts, output_dir)
         output_dir.mkpath unless output_dir.exist?
@@ -38,6 +38,7 @@ module R3EXS
     # @param output_dir [Pathname] 输出目录
     # @param complete [Boolean] 是否序列化所有内容
     # @param with_notes [Boolean] 是否包含备注
+    #
     # @return [void]
     def R3EXS.commonevents_json(commonevents, output_dir, complete, with_notes)
         full_dir = output_dir.join('CommonEvents')

data/lib/R3EXS/utils.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'oj'
+require_relative 'RGSS3'
 require_relative 'RGSS3_R3EXS'
 
 module R3EXS
@@ -207,7 +208,7 @@ module R3EXS
                                                                                                           |--[int:3(Game Data)]--|
                                                                                                           |                      |--[int:5(Character)]---[int:{-1:Player, 0:This Event, 1:EV001, ...}]---[int:{0:Map X, 1:Map Y, 2:Direction, 3:Screen X ,4:Screen Y}]---END
                                                                                                           |                      |
-                                                                                                          |                      |--[int:6(Party)]---[int:{0~7}(Member ID)]---[int:0]---END('s Actor ID)
+                                                                                                          |                      |--[int:6(Party)]---[int:{0~7}(Member ID)]---[int:0]---END
                                                                                                           |                      |
                                                                                                           |                      |--[int:7(Other)]---[int:{0(Map ID), 1(Party Members), 2(Gold), 3(Steps), 4(Play Time), 5(Timer), 6(Save Count), 7(Battle Count)}]---[int:0]---END
                                                                                                           |
@@ -320,7 +321,7 @@ module R3EXS
                                                 |                                                                                                                       |
     [int:{0:This Event, 1:EV001, ...}]----------|--[int:1(Designation with Variables)]---[int(Map X Corresponded Variable ID)]---[int(Map Y Corresponded Variable ID)]--|--[int:{0:Retain, 2:Down, 4:Left, 6:Right, 8:Up}(Direction)]---END
                                                 |                                                                                                                       |
-                                                |--[int:2(Exchange with Another Event)]---[int(Exchanged Event ID)]---[int:0]----------------------------------------- |
+                                                |--[int:2(Exchange with Another Event)]---[int(Exchanged Event ID)]---[int:0]-------------------------------------------|
 =end
             203 => 'SetEventLocation',
 
@@ -1060,6 +1061,7 @@ module R3EXS
         #
         # @param object [Object] 待序列化的对象
         # @param output_file [Pathname] 输出文件路径
+        #
         # @return [void]
         def Utils.object_json(object, output_file)
             output_file.dirname.mkpath unless output_file.dirname.exist?
@@ -1070,6 +1072,7 @@ module R3EXS
         #
         # @param object [Object] 待序列化的对象
         # @param output_file [Pathname] 输出文件路径
+        #
         # @return [void]
         def Utils.object_rvdata2(object, output_file)
             output_file.dirname.mkpath unless output_file.dirname.exist?

data/lib/R3EXS/version.rb

@@ -3,5 +3,5 @@
 module R3EXS
 
     # 版本号
-    VERSION = '1.1.0'
+    VERSION = '1.1.1'
 end

data/lib/R3EXS.rb

@@ -8,5 +8,6 @@ module R3EXS
     require_relative 'R3EXS/json_rvdata2'
     require_relative 'R3EXS/extract_strings'
     require_relative 'R3EXS/inject_strings'
-    require_relative 'R3EXS/rgss3a_rvdata2.so'
+
+    require_relative 'R3EXS/R3EXS' # C extension
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: R3EXS
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - LuoTat
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.9
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.9
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -71,14 +71,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.16
+        version: 1.3.17
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.16
+        version: 1.3.17
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -111,18 +111,18 @@ email: LuoTat.s@gmail.com
 executables:
 - R3EXS
 extensions:
-- "./ext/rgss3a_rvdata2/extconf.rb"
+- "./ext/R3EXS/extconf.rb"
 extra_rdoc_files: []
 files:
-- "./ext/rgss3a_rvdata2/extconf.rb"
+- "./ext/R3EXS/extconf.rb"
 - ".yardopts"
 - CHANGELOG.md
 - LICENSE
 - README.md
 - README_EN.md
 - bin/R3EXS
-- ext/rgss3a_rvdata2/extconf.rb
-- ext/rgss3a_rvdata2/rgss3a_rvdata2.c
+- ext/R3EXS/R3EXS.c
+- ext/R3EXS/extconf.rb
 - lib/R3EXS.rb
 - lib/R3EXS/RGSS3.rb
 - lib/R3EXS/RGSS3_R3EXS.rb
@@ -145,7 +145,6 @@ metadata:
 rdoc_options: []
 require_paths:
 - lib
-- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -157,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.7.0
 specification_version: 4
 summary: A tool for extracting and translating strings from the RGSS3 game engine
 test_files: []

data/ext/rgss3a_rvdata2/extconf.rb

@@ -1,3 +0,0 @@
-require 'mkmf'
-
-create_makefile('R3EXS/rgss3a_rvdata2')