Class: Yard2steep::Parser
- Inherits:
-
Object
- Object
- Yard2steep::Parser
- Defined in:
- lib/yard2steep/parser.rb
Constant Summary collapse
- ANY_TYPE =
'any'
- ANY_BLOCK_TYPE =
'{ (any) -> any }'
Instance Method Summary collapse
- #block_type_node(p) ⇒ AST::PTypeNode
- #debug_print!(message) ⇒ void
- #getter_method_node(ivarname) ⇒ AST::MethodNode
-
#initialize ⇒ Parser
constructor
A new instance of Parser.
- #parse(file, text, debug: false) ⇒ AST::ClassNode
- #parse_assign(r_ast) ⇒ void
- #parse_assign_constant(name:, v_ast:) ⇒ void
- #parse_attr_accessor(ivars) ⇒ void
- #parse_attr_reader(ivars) ⇒ void
- #parse_attr_writer(ivars) ⇒ void
- #parse_bodystmt(r_ast) ⇒ void
- #parse_class_or_module(r_ast) ⇒ void
- #parse_command(r_ast) ⇒ void
- #parse_command_args_add_block(r_ast) ⇒ Array<String>
- #parse_def(r_ast) ⇒ void
- #parse_defs(r_ast) ⇒ void
- #parse_method_add_arg(r_ast) ⇒ void
- #parse_method_impl(m_name, m_loc, params) ⇒ void
- #parse_no_paren_params(params) ⇒ Array<AST::PNode>
- #parse_params(r_ast) ⇒ Array<AST::PNode>
- #parse_paren_params(r_ast) ⇒ Array<AST::PNode>
- #parse_program(text) ⇒ void
- #parse_stmt(r_ast) ⇒ void
- #parse_stmts(r_ast) ⇒ void
- #setter_method_node(ivarname) ⇒ AST::MethodNode
- #type_node(p) ⇒ AST::PTypeNode
- #type_of(r_ast) ⇒ String
- #within_context(&block) ⇒ void
Constructor Details
#initialize ⇒ Parser
Returns a new instance of Parser.
12 13 14 15 16 17 18 |
# File 'lib/yard2steep/parser.rb', line 12 def initialize # Debug flag @debug = false # NOTE: set at parse @file = nil end |
Instance Method Details
#block_type_node(p) ⇒ AST::PTypeNode
716 717 718 719 720 721 722 723 724 725 726 727 728 |
# File 'lib/yard2steep/parser.rb', line 716 def block_type_node(p) if @p_types[p] type = @p_types[p] else type = ANY_BLOCK_TYPE end AST::PTypeNode.new( p_type: type, p_name: p, kind: AST::PTypeNode::KIND[:block], ) end |
#debug_print!(message) ⇒ void
This method returns an undefined value.
694 695 696 |
# File 'lib/yard2steep/parser.rb', line 694 def debug_print!() print "#{}\n" if @debug end |
#getter_method_node(ivarname) ⇒ AST::MethodNode
662 663 664 665 666 667 668 |
# File 'lib/yard2steep/parser.rb', line 662 def getter_method_node(ivarname) AST::MethodNode.new( p_list: [], r_type: ANY_TYPE, m_name: ivarname, ) end |
#parse(file, text, debug: false) ⇒ AST::ClassNode
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
# File 'lib/yard2steep/parser.rb', line 24 def parse(file, text, debug: false) @debug = debug @file = file debug_print!("Start parsing: #{file}") @comments = Comments.new(text) main = AST::ClassNode.create_main @ast = main # NOTE: reset class context @current_class = main parse_program(text) @ast end |
#parse_assign(r_ast) ⇒ void
This method returns an undefined value.
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 |
# File 'lib/yard2steep/parser.rb', line 412 def parse_assign(r_ast) # NOTE: r_ast is array such as # [:assign, # [:var_field, [:@const, "DNA", [1, 15]]], # [...]] Util.assert! { r_ast[0] == :assign && r_ast[1].is_a?(Array) && r_ast[1][0] == :var_field } var_type = r_ast[1][1][0] if var_type == :@const parse_assign_constant(name: r_ast[1][1][1], v_ast: r_ast[2]) end end |
#parse_assign_constant(name:, v_ast:) ⇒ void
This method returns an undefined value.
431 432 433 434 435 436 437 438 |
# File 'lib/yard2steep/parser.rb', line 431 def parse_assign_constant(name:, v_ast:) c = AST::ConstantNode.new( name: name, klass: @current_class, v_type: type_of(v_ast), ) @current_class.append_constant(c) end |
#parse_attr_accessor(ivars) ⇒ void
This method returns an undefined value.
646 647 648 649 650 651 652 653 654 655 656 657 658 |
# File 'lib/yard2steep/parser.rb', line 646 def parse_attr_accessor(ivars) ivars.each do |ivarname| @current_class.append_ivar( AST::IVarNode.new( name: ivarname ) ) # NOTE: attr_accessor should add getter and setter methods @current_class.append_m(getter_method_node(ivarname)) @current_class.append_m(setter_method_node(ivarname)) end end |
#parse_attr_reader(ivars) ⇒ void
This method returns an undefined value.
616 617 618 619 620 621 622 623 624 625 626 627 |
# File 'lib/yard2steep/parser.rb', line 616 def parse_attr_reader(ivars) ivars.each do |ivarname| @current_class.append_ivar( AST::IVarNode.new( name: ivarname ) ) # NOTE: attr_reader should add a getter method @current_class.append_m(getter_method_node(ivarname)) end end |
#parse_attr_writer(ivars) ⇒ void
This method returns an undefined value.
631 632 633 634 635 636 637 638 639 640 641 642 |
# File 'lib/yard2steep/parser.rb', line 631 def parse_attr_writer(ivars) ivars.each do |ivarname| @current_class.append_ivar( AST::IVarNode.new( name: ivarname ) ) # NOTE: attr_writer should add a setter method @current_class.append_m(setter_method_node(ivarname)) end end |
#parse_bodystmt(r_ast) ⇒ void
This method returns an undefined value.
399 400 401 402 403 404 405 406 407 408 |
# File 'lib/yard2steep/parser.rb', line 399 def parse_bodystmt(r_ast) # NOTE: # [:bodystmt, # [...]] Util.assert! { r_ast[0] == :bodystmt && r_ast[1].is_a?(Array) } parse_stmts(r_ast[1]) end |
#parse_class_or_module(r_ast) ⇒ void
This method returns an undefined value.
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 |
# File 'lib/yard2steep/parser.rb', line 342 def parse_class_or_module(r_ast) # NOTE: r_ast is array such as # [:class, # [:const_ref, [:@const, "OtherClass", [119, 6]]], # [:var_ref, [:@const, "MyClass", [119, 19]]], # [:bodystmt, [...]]] kind = r_ast[0].to_s case kind when "class" Util.assert! { r_ast.size == 4 } c_name_node = r_ast[1] super_c_node = r_ast[2] bodystmt_node = r_ast[3] when "module" Util.assert! { r_ast.size == 3 } c_name_node = r_ast[1] super_c_node = nil bodystmt_node = r_ast[2] else raise "invalid kind: #{kind}" end Util.assert! { c_name_node[0] == :const_ref && c_name_node[1].is_a?(Array) && c_name_node[1][0] == :@const && c_name_node[1][1].is_a?(String) } c_name = c_name_node[1][1] Util.assert! { !super_c_node || ( super_c_node[0] == :var_ref && super_c_node[1].is_a?(Array) && super_c_node[1][0] == :@const && super_c_node[1][1].is_a?(String) ) } super_c_name = super_c_node ? super_c_node[1][1] : nil c = AST::ClassNode.new( kind: kind, c_name: c_name, super_c: super_c_name, parent: @current_class, ) @current_class.append_child(c) @current_class = c parse_bodystmt(bodystmt_node) @current_class = @current_class.parent end |
#parse_command(r_ast) ⇒ void
This method returns an undefined value.
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 |
# File 'lib/yard2steep/parser.rb', line 497 def parse_command(r_ast) # NOTE: r_ast is array such as # [:command, # [:@ident, "attr_reader", [1, 15]], # [:args_add_block, # [ # [:symbol_literal, [:symbol, [:@ident, "ok", [1, 28]]]] # ], # false # ] # ] Util.assert! { r_ast[0] == :command && r_ast[1].is_a?(Array) } # NOTE: check attr_* if r_ast[1][0] == :@ident case r_ast[1][1] when "attr_reader" parse_attr_reader(parse_command_args_add_block(r_ast[2])) when "attr_writer" parse_attr_writer(parse_command_args_add_block(r_ast[2])) when "attr_accessor" parse_attr_accessor(parse_command_args_add_block(r_ast[2])) end # Do nothing for other case end end |
#parse_command_args_add_block(r_ast) ⇒ Array<String>
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 |
# File 'lib/yard2steep/parser.rb', line 530 def parse_command_args_add_block(r_ast) # NOTE: r_ast is array such as # # [:args_add_block, # [ # [:symbol_literal, [:symbol, [:@ident, "ok", [1, 28]]]], # [:symbol_literal, [:symbol, [:@ident, "no", [1, 33]]]], # [:string_literal, [:string_content, [:@tstring_content, "b", [1, 38]]]] # ], # false # ] Util.assert! { r_ast[0] == :args_add_block && r_ast[1].is_a?(Array) } r = [] r_ast[1].each do |ast| case ast[0] when :symbol_literal Util.assert! { ast[1].is_a?(Array) && ast[1][0] == :symbol && ast[1][1].is_a?(Array) && ast[1][1][0] == :@ident && ast[1][1][1].is_a?(String) } r.push(ast[1][1][1]) when :string_literal Util.assert! { ast[1].is_a?(Array) && ast[1][0] == :string_content && ast[1][1].is_a?(Array) && ast[1][1][0] == :@tstring_content && ast[1][1][1].is_a?(String) } r.push(ast[1][1][1]) end # Do nothing for other case end r end |
#parse_def(r_ast) ⇒ void
This method returns an undefined value.
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/yard2steep/parser.rb', line 119 def parse_def(r_ast) # NOTE: r_ast is array such as # [:def, # [:@ident, "first", [3, 4]], # [:paren, [:params, ...]], # [:bodystmt, [[:array, nil]], nil, nil, nil]]] Util.assert! { r_ast.size == 4 && r_ast[0] == :def && r_ast[1][0] == :@ident && r_ast[1][1].is_a?(String) && r_ast[1][2].is_a?(Array) } m_name = r_ast[1][1] m_loc = r_ast[1][2][0] params = r_ast[2] # NOTE: We also want to check bodystmt # bodystmt = r_ast[3] parse_method_impl(m_name, m_loc, params) end |
#parse_defs(r_ast) ⇒ void
This method returns an undefined value.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/yard2steep/parser.rb', line 87 def parse_defs(r_ast) # NOTE: r_ast is array such as # [:defs, # [:var_ref, [:@kw, "self", [1, 14]]], # [:@period, ".", [1, 18]], # [:@ident, "my_method", [1, 19]], # [:params, nil, nil, nil, nil, nil, nil, nil], # [:bodystmt, [[:void_stmt]], nil, nil, nil]] Util.assert! { r_ast.size == 6 && r_ast[0] == :defs && r_ast[1][0] == :var_ref && r_ast[1][1][0] == :@kw && r_ast[1][1][1].is_a?(String) && r_ast[1][1][2].is_a?(Array) && r_ast[2][0] == :@period && r_ast[3][0] == :@ident && r_ast[3][1].is_a?(String) } m_name = "#{r_ast[1][1][1]}.#{r_ast[3][1]}" m_loc = r_ast[1][1][2][0] params = r_ast[4] # NOTE: We also want to check bodystmt # bodystmt = r_ast[5] parse_method_impl(m_name, m_loc, params) end |
#parse_method_add_arg(r_ast) ⇒ void
This method returns an undefined value.
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 |
# File 'lib/yard2steep/parser.rb', line 574 def parse_method_add_arg(r_ast) # NOTE: r_ast is Array such as # [:method_add_arg, # [:fcall, [:@ident, "attr_reader", [1, 15]]], # [:arg_paren, # [ # :args_add_block, # [ # [:symbol_literal, [:symbol, [:@ident, "ok", [1, 28]]]] # ], # false # ] # ] # ] Util.assert! { r_ast[0] == :method_add_arg && r_ast[1].is_a?(Array) && r_ast[1][0] == :fcall && r_ast[1][1].is_a?(Array) && r_ast[2].is_a?(Array) && r_ast[2][0] == :arg_paren && r_ast[2][1].is_a?(Array) && r_ast[2][1][0] == :args_add_block && r_ast[2][1][1].is_a?(Array) } # NOTE: check attr_* if r_ast[1][1][0] == :@ident case r_ast[1][1][1] when "attr_reader" parse_attr_reader(parse_command_args_add_block(r_ast[2][1])) when "attr_writer" parse_attr_writer(parse_command_args_add_block(r_ast[2][1])) when "attr_accessor" parse_attr_accessor(parse_command_args_add_block(r_ast[2][1])) end # Do nothing for other case end end |
#parse_method_impl(m_name, m_loc, params) ⇒ void
This method returns an undefined value.
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/yard2steep/parser.rb', line 147 def parse_method_impl(m_name, m_loc, params) within_context do @p_types, @r_type = @comments.parse_from(m_loc) p_list = parse_params(params) # NOTE: We also want to check bodystmt # parse_mbody(bodystmt) m_node = AST::MethodNode.new( p_list: p_list, r_type: (@r_type || ANY_TYPE), m_name: m_name, ) @current_class.append_m(m_node) end end |
#parse_no_paren_params(params) ⇒ Array<AST::PNode>
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 |
# File 'lib/yard2steep/parser.rb', line 197 def parse_no_paren_params(params) # NOTE: params is array such as # [:params, # nil, # nil, # nil, # nil, # [ # [ # [:@label, "contents:", [3, 10]], # false # ] # ], # nil, # nil # ]], Util.assert! { params[0] == :params && params.size == 8 } r = [] n_params = (params[1] || []) # NOTE: n_params is array such as # [[:@ident, "a", [1, 7]], ...] n_params.each do |key| # TODO(south37) Optimize this check Util.assert! { key[0] == :@ident && key[1].is_a?(String) } name = key[1] r.push( AST::PNode.new( type_node: type_node(name), style: AST::PNode::STYLE[:normal], ) ) end v_params = (params[2] || []) # NOTE: v_params is array such as # [ # [ # [:@ident, "a", [1, 7]], # [:@int, "2", [1, 9]] # ], # ... # ] v_params.each do |v_param| key, default_v = v_param # TODO(south37) Optimize this check Util.assert! { key[0] == :@ident && key[1].is_a?(String) && default_v.is_a?(Array) } name = key[1] r.push( AST::PNode.new( type_node: type_node(name), style: AST::PNode::STYLE[:normal_with_default], ) ) end n_params2 = (params[4] || []) # NOTE: n_params2 is array such as # [[:@ident, "a", [1, 7]], ...] n_params2.each do |key| # TODO(south37) Optimize this check Util.assert! { key[0] == :@ident && key[1].is_a?(String) } name = key[1] r.push( AST::PNode.new( type_node: type_node(name), style: AST::PNode::STYLE[:normal], ) ) end k_params = (params[5] || []) # NOTE: k_params is array such as # [ # [ # [:@label, "contents:", [3, 10]], # false # ], # ... # ], k_params.each do |v_param| key, default_v = v_param # TODO(south37) Optimize this check Util.assert! { key[0] == :@label && key[1][-1] == ':' } name = key[1][0..-2] if default_v r.push( AST::PNode.new( type_node: type_node(name), style: AST::PNode::STYLE[:keyword_with_default], ) ) else r.push( AST::PNode.new( type_node: type_node(name), style: AST::PNode::STYLE[:keyword], ) ) end end b_param = params[7] # NOTE: b_params is array such as # [:blockarg, [:@ident, "block", [1, 8]]] if b_param Util.assert! { b_param[0] == :blockarg && b_param[1].is_a?(Array) && b_param[1][0] == :@ident && b_param[1][1].is_a?(String) } name = b_param[1][1] r.push( AST::PNode.new( type_node: block_type_node(name), style: AST::PNode::STYLE[:normal], ) ) end # NOTE: params[3] is `*a`, params[6] is `**a` r end |
#parse_params(r_ast) ⇒ Array<AST::PNode>
168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/yard2steep/parser.rb', line 168 def parse_params(r_ast) # NOTE: parrams is `paren_params` or `no_paren_params` # paren_params: [:paren, [:params, ...]] # no_paren_params: [:params, ...] case r_ast[0] when :paren parse_paren_params(r_ast) when :params parse_no_paren_params(r_ast) else raise "invalid node" end end |
#parse_paren_params(r_ast) ⇒ Array<AST::PNode>
184 185 186 187 188 189 190 191 192 193 |
# File 'lib/yard2steep/parser.rb', line 184 def parse_paren_params(r_ast) # NOTE: r_ast is array such as # [:paren, [:params, ...]] Util.assert! { r_ast[0] == :paren && r_ast[1].is_a?(Array) && r_ast[1][0] == :params } parse_no_paren_params(r_ast[1]) end |
#parse_program(text) ⇒ void
This method returns an undefined value.
45 46 47 48 49 50 51 52 |
# File 'lib/yard2steep/parser.rb', line 45 def parse_program(text) r_ast = Ripper.sexp(text) # NOTE: r_ast is array such as # [:program, # [...]] Util.assert! { r_ast[0] == :program && r_ast[1].is_a?(Array) } parse_stmts(r_ast[1]) end |
#parse_stmt(r_ast) ⇒ void
This method returns an undefined value.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/yard2steep/parser.rb', line 64 def parse_stmt(r_ast) n_type = r_ast[0] case n_type when :defs parse_defs(r_ast) when :def parse_def(r_ast) when :class, :module parse_class_or_module(r_ast) when :assign parse_assign(r_ast) when :command parse_command(r_ast) when :method_add_arg parse_method_add_arg(r_ast) end # Do nothing for other stmt end |
#parse_stmts(r_ast) ⇒ void
This method returns an undefined value.
56 57 58 59 60 |
# File 'lib/yard2steep/parser.rb', line 56 def parse_stmts(r_ast) r_ast.each do |node| parse_stmt(node) end end |
#setter_method_node(ivarname) ⇒ AST::MethodNode
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 |
# File 'lib/yard2steep/parser.rb', line 672 def setter_method_node(ivarname) AST::MethodNode.new( p_list: [ AST::PNode.new( type_node: AST::PTypeNode.new( p_type: ANY_TYPE, p_name: '', kind: AST::PTypeNode::KIND[:normal], ), style: AST::PNode::STYLE[:normal], ) ], r_type: ANY_TYPE, m_name: "#{ivarname}=", ) end |
#type_node(p) ⇒ AST::PTypeNode
700 701 702 703 704 705 706 707 708 709 710 711 712 |
# File 'lib/yard2steep/parser.rb', line 700 def type_node(p) if @p_types[p] type = @p_types[p] else type = ANY_TYPE end AST::PTypeNode.new( p_type: type, p_name: p, kind: AST::PTypeNode::KIND[:normal], ) end |
#type_of(r_ast) ⇒ String
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 |
# File 'lib/yard2steep/parser.rb', line 442 def type_of(r_ast) # NOTE: r_ast is array such as # # String example: # [:string_literal, # [:string_content, # [:@tstring_content, "String...", [34, 15]] # ] # ] # # Regexp example: # [:regexp_literal, # [ # [:@tstring_content, "this is re", [35, 15]] # ], # [:@regexp_end, "/", [35, 25]] # ] # # nil example: # [:var_ref, [:@kw, "nil", [40, 14]]] case r_ast[0] when :string_literal 'String' when :regexp_literal 'Regexp' when :symbol_literal 'Symbol' when :dot2 'Range<any>' when :@int 'Integer' when :@float 'Float' when :array 'Array<any>' # TODO(south37): check type of element when :hash 'Hash<any, any>' # TODO(south37): check type of element when :var_ref Util.assert! { r_ast[1].is_a?(Array) && r_ast[1][0] == :@kw } case r_ast[1][1] when 'true', 'false' 'bool' when 'nil' 'nil' else 'any' end else 'any' end end |
#within_context(&block) ⇒ void
This method returns an undefined value.
333 334 335 336 337 338 |
# File 'lib/yard2steep/parser.rb', line 333 def within_context(&block) # Current method context. @p_types = {} @r_type = nil block.call end |