mirror of
https://github.com/mruby/mruby
synced 2026-06-08 16:11:16 +00:00
dearblue
f4f3a061be
- Added the index number corresponding to the instruction code.
- Omitted trailing `|` from table elements.
The table elements in GitHub Flavored Markdown can't wrap wherever wanted.
And trying to align the end of it tends to make the whole thing longer.
52 lines
1.6 KiB
Ruby
52 lines
1.6 KiB
Ruby
autoload :Pathname, 'pathname'
|
|
|
|
module MRuby
|
|
module Documentation
|
|
def Documentation.update_opcode_md
|
|
mrubydir = Pathname(MRUBY_ROOT)
|
|
path_ops_h = mrubydir + "include/mruby/ops.h"
|
|
path_opcode_md = mrubydir + "doc/internal/opcode.md"
|
|
|
|
opspecs = {
|
|
"Z" => { prefix: "", modified: "-" },
|
|
"B" => { prefix: "\'" },
|
|
"BB" => { prefix: "\"" },
|
|
"BBB" => { prefix: "\"" },
|
|
"BS" => { prefix: "\'" },
|
|
"BSS" => { prefix: "\'" },
|
|
"S" => { prefix: "" },
|
|
"W" => { prefix: "" },
|
|
}
|
|
|
|
diff = ""
|
|
|
|
spliter = <<~'SPLITER'
|
|
| No. | Instruction Name | Operand type | Semantics
|
|
| --: | ---------------- | ------------ | ---------------
|
|
SPLITER
|
|
|
|
diff = path_opcode_md.read.sub(/^#{Regexp.escape spliter}.*?(?=\z|^$\n)/m) do
|
|
repl = spliter
|
|
|
|
ops = path_ops_h.read
|
|
pat = /^\s*OPCODE\s*\(\s*(\w+)\s*,\s*(\w+)\s*\)\s*(?:\/\*\s*(.*?)\s*\*\/\s*)?/
|
|
ops.scan(pat).each_with_index do |(ins, opr, cmt), no|
|
|
if cmt
|
|
cmt.sub!(/\s*#.*/, "")
|
|
cmt.sub!(/\b(?=L_\w+\b)/, "OP_")
|
|
cmt.gsub!(/\b(Irep|Pool|R|Syms)\[([^\[\]]+)\]/, "\\1(\\2)")
|
|
cmt.gsub!(/[\\\|]/) { |m| "\\#{m}" } # Ruby-2.5 is not support "Numbered block parameter"
|
|
end
|
|
spec = opspecs[opr] or raise "unknown operand type: #{opr}"
|
|
item = format("| %3d | %-16s | %-12s | %s\n", no, "`OP_#{ins}`", "`#{spec[:modified] || opr}`", cmt && "`#{cmt}`")
|
|
repl << item
|
|
end
|
|
|
|
repl
|
|
end
|
|
|
|
path_opcode_md.binwrite diff
|
|
end
|
|
end
|
|
end
|