Class: TypeProf::Core::MethodCallBox

Inherits:
Box
  • Object
show all
Defined in:
lib/typeprof/core/graph/box.rb

Instance Attribute Summary collapse

Attributes inherited from Box

#changes, #destroyed, #node

Instance Method Summary collapse

Methods inherited from Box

#add_symbol_proc_call_box, #destroy, #destroy_symbol_proc_call_boxes, #on_type_added, #on_type_removed, #reuse, #run, #to_s

Constructor Details

#initialize(node, genv, recv, mid, a_args, subclasses, suppress_errors: false, unresolved_recv: nil) ⇒ MethodCallBox

unresolved_recv, when given, collects the receiver types for which no method entity was found. Without it those types only become "undefined method" diagnostics; with it the caller can handle them itself, as [*x] does to wrap a receiver that has no to_a.



938
939
940
941
942
943
944
945
946
947
948
949
950
951
# File 'lib/typeprof/core/graph/box.rb', line 938

def initialize(node, genv, recv, mid, a_args, subclasses, suppress_errors: false, unresolved_recv: nil)
  raise mid.to_s unless mid
  super(node)
  @recv = recv.new_vertex(genv, node)
  @recv.add_edge(genv, self)
  @mid = mid
  @a_args = a_args.new_vertexes(genv, node)
  @a_args.add_box_edges(genv, self)
  @ret = Vertex.new(node)
  @subclasses = subclasses
  @suppress_errors = suppress_errors
  @unresolved_recv = unresolved_recv
  @generics = {}
end

Instance Attribute Details

#mid ⇒ Object (readonly)

Returns the value of attribute mid.



953
954
955
# File 'lib/typeprof/core/graph/box.rb', line 953

def mid
  @mid
end

#recv ⇒ Object (readonly)

Returns the value of attribute recv.



953
954
955
# File 'lib/typeprof/core/graph/box.rb', line 953

def recv
  @recv
end

#ret ⇒ Object (readonly)

Returns the value of attribute ret.



953
954
955
# File 'lib/typeprof/core/graph/box.rb', line 953

def ret
  @ret
end

Instance Method Details

#resolve(genv, changes, &blk) ⇒ Object



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
# File 'lib/typeprof/core/graph/box.rb', line 1025

def resolve(genv, changes, &blk)
  @recv.each_type do |orig_ty|
    next if orig_ty == genv.bot_type
    if @mid == :"*super"
      mid = @node.lenv.cref.mid
      # Outside a method or in a define_method block, the method is unknown
      next unless mid
      skip = true
    else
      mid = @mid
      skip = false
    end

    ty = orig_ty.base_type(genv)

    base_ty_env = Type.default_param_map(genv, ty)

    alias_limit = 0
    while ty
      unless skip
        # First check prepended modules
        if !ty.is_a?(Type::Singleton)
          if resolve_prepended_modules(genv, changes, base_ty_env, ty, mid) do |me, ty, mid|
              yield me, ty, mid, orig_ty
            end
            break
          end
        end

        # Then check the class/module itself
        me = ty.mod.get_method(ty.is_a?(Type::Singleton), mid)
        changes.add_depended_method_entity(me) if changes
        if !me.aliases.empty?
          mid = me.aliases.values.first
          alias_limit += 1
          redo if alias_limit < 5
        end
        if me.exist?
          yield me, ty, mid, orig_ty
          break
        end
      end

      skip = false

      if ty.is_a?(Type::Singleton)
        # Check extended modules (their instance methods are singleton methods here)
        break if resolve_extended_modules(genv, changes, base_ty_env, ty, mid) do |me, ty, mid|
          yield me, ty, mid, orig_ty
        end
      else
        # Finally check included modules
        break if resolve_included_modules(genv, changes, base_ty_env, ty, mid) do |me, ty, mid|
          yield me, ty, mid, orig_ty
        end
      end

      ty = genv.get_superclass_type(ty, changes, base_ty_env)
    end

    yield nil, nil, mid, orig_ty unless ty
  end
end

#resolve_extended_modules(genv, changes, base_ty_env, ty, mid, &blk) ⇒ Object



1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
# File 'lib/typeprof/core/graph/box.rb', line 1174

def resolve_extended_modules(genv, changes, base_ty_env, ty, mid, &blk)
  found = false

  alias_limit = 0
  # An extended module's instance methods are resolved as the receiver's
  # singleton methods, so look them up with singleton = false.
  ty.mod.extended_modules.each do |ext_decl, ext_mod|
    if ext_decl.is_a?(AST::SigExtendNode) && ext_mod.type_params
      ext_ty = genv.get_instance_type(ext_mod, ext_decl.args, changes, base_ty_env, ty)
    else
      type_params = ext_mod.type_params.map { genv.untyped_arg } # TODO: better support
      ext_ty = Type::Instance.new(genv, ext_mod, type_params)
    end

    me = ext_ty.mod.get_method(false, mid)
    changes.add_depended_method_entity(me) if changes
    if !me.aliases.empty?
      mid = me.aliases.values.first
      alias_limit += 1
      redo if alias_limit < 5
    end
    if me.exist?
      found = true
      yield me, ext_ty, mid
    else
      # The extended module may itself include other modules.
      found ||= resolve_included_modules(genv, changes, base_ty_env, ext_ty, mid, &blk)
    end
  end
  found
end

#resolve_included_modules(genv, changes, base_ty_env, ty, mid, &blk) ⇒ Object



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
# File 'lib/typeprof/core/graph/box.rb', line 1121

def resolve_included_modules(genv, changes, base_ty_env, ty, mid, &blk)
  found = false

  alias_limit = 0
  ty.mod.self_types.each do |(mdecl, idx), self_ty_mod|
    raise unless mdecl.is_a?(AST::SigModuleNode)
    if self_ty_mod.type_params
      self_ty = genv.get_instance_type(self_ty_mod, mdecl.self_type_args[idx], changes, base_ty_env, ty)
    else
      self_ty = Type::Instance.new(genv, self_ty_mod, [])
    end

    me = self_ty.mod.get_method(false, mid)
    changes.add_depended_method_entity(me) if changes
    if !me.aliases.empty?
      mid = me.aliases.values.first
      alias_limit += 1
      redo if alias_limit < 5
    end
    if me.exist?
      found = true
      yield me, self_ty, mid
    else
      found ||= resolve_included_modules(genv, changes, base_ty_env, self_ty, mid, &blk)
    end
  end

  alias_limit = 0
  ty.mod.included_modules.each do |inc_decl, inc_mod|
    if inc_decl.is_a?(AST::SigIncludeNode) && inc_mod.type_params
      inc_ty = genv.get_instance_type(inc_mod, inc_decl.args, changes, base_ty_env, ty)
    else
      type_params = inc_mod.type_params.map { genv.untyped_arg } # TODO: better support
      inc_ty = Type::Instance.new(genv, inc_mod, type_params)
    end

    me = inc_ty.mod.get_method(false, mid)
    changes.add_depended_method_entity(me) if changes
    if !me.aliases.empty?
      mid = me.aliases.values.first
      alias_limit += 1
      redo if alias_limit < 5
    end
    if me.exist?
      found = true
      yield me, inc_ty, mid
    else
      found ||= resolve_included_modules(genv, changes, base_ty_env, inc_ty, mid, &blk)
    end
  end
  found
end

#resolve_prepended_modules(genv, changes, base_ty_env, ty, mid, &blk) ⇒ Object



1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
# File 'lib/typeprof/core/graph/box.rb', line 1089

def resolve_prepended_modules(genv, changes, base_ty_env, ty, mid, &blk)
  found = false

  alias_limit = 0
  # Process prepended modules in reverse order (last prepended = first in ancestor chain)
  ty.mod.prepended_modules.reverse_each do |prep_decl, prep_mod|
    if prep_decl.is_a?(AST::SigPrependNode) && prep_mod.type_params
      prep_ty = genv.get_instance_type(prep_mod, prep_decl.args, changes, base_ty_env, ty)
    else
      type_params = prep_mod.type_params.map { genv.untyped_arg } # TODO: better support
      prep_ty = Type::Instance.new(genv, prep_mod, type_params)
    end

    me = prep_ty.mod.get_method(false, mid)
    changes.add_depended_method_entity(me) if changes
    if !me.aliases.empty?
      mid = me.aliases.values.first
      alias_limit += 1
      redo if alias_limit < 5
    end
    if me.exist?
      found = true
      yield me, prep_ty, mid
    else
      found = resolve_prepended_modules(genv, changes, base_ty_env, prep_ty, mid, &blk)
    end
    break if found
  end

  found
end

#resolve_subclasses(genv, changes) ⇒ Object



1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
# File 'lib/typeprof/core/graph/box.rb', line 1206

def resolve_subclasses(genv, changes)
  # TODO: This does not follow new subclasses
  @recv.each_type do |ty|
    next if ty == genv.bot_type
    base_ty = ty.base_type(genv)
    singleton = base_ty.is_a?(Type::Singleton)
    mod = base_ty.mod
    # Every class descends from Object, so this would only find unrelated methods
    next if mod.cpath.empty?
    mod.each_descendant do |desc_mod|
      next if mod == desc_mod
      me = desc_mod.get_method(singleton, @mid)
      changes.add_depended_method_entity(me)
      if me && me.exist?
        yield ty, me
      end
    end
  end
end

#run0(genv, changes) ⇒ Object



955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
# File 'lib/typeprof/core/graph/box.rb', line 955

def run0(genv, changes)
  a_args = @a_args.normalize_for_method_call(genv)
  return unless a_args

  edges = Set.empty
  called_mdefs = Set.empty
  error_count = 0
  resolve(genv, changes) do |me, ty, mid, orig_ty|
    if @node.is_a?(AST::YieldNode) && mid == :call && orig_ty.is_a?(Type::Symbol)
      box = add_symbol_proc_call_box(changes, genv, orig_ty.sym, a_args.positionals, a_args.keywords)
      changes.add_edge(genv, box.ret, @ret) if box
    elsif !me
      if @unresolved_recv
        changes.add_edge(genv, Source.new(orig_ty), @unresolved_recv)
      end
      unless @suppress_errors
        if error_count < 3
          meth = @node.mid_code_range ? :mid_code_range : :code_range
          changes.add_diagnostic(meth, "undefined method: #{ orig_ty.show }##{ mid }")
        end
      end
      error_count += 1
    elsif me.builtin && me.builtin[changes, @node, orig_ty, a_args, @ret]
      # do nothing
    elsif !me.decls.empty?
      # TODO: support "| ..."
      me.decls.each do |mdecl|
        # TODO: union type is ok?
        # TODO: add_depended_method_entity for types used to resolve overloads
        ty_env = Type.default_param_map(genv, orig_ty)
        if ty.is_a?(Type::Instance)
          ty.mod.type_params.zip(ty.args) do |(param, default_ty), arg|
            ty_env[param] = arg || (default_ty ? default_ty.covariant_vertex(genv, changes, ty_env) : genv.untyped_arg)
          end
        end
        mdecl.resolve_overloads(changes, genv, @node, ty_env, a_args, @ret) do |method_type|
          @generics[method_type] ||= method_type.type_params.map { Vertex.new(@node) }
        end
      end
    elsif !me.defs.empty?
      me.defs.each do |mdef|
        next if called_mdefs.include?(mdef)
        called_mdefs << mdef
        mdef.call(changes, genv, a_args, @ret)
      end
    else
      pp me
      raise
    end
  end
  if @subclasses
    resolve_subclasses(genv, changes) do |recv_ty, me|
      if !me.defs.empty?
        me.defs.each do |mdef|
          next if called_mdefs.include?(mdef)
          called_mdefs << mdef
          mdef.call(changes, genv, a_args, @ret)
        end
      end
    end
  end
  edges.each do |src, dst|
    changes.add_edge(genv, src, dst)
  end
  if error_count > 3 && !@suppress_errors
    meth = @node.mid_code_range ? :mid_code_range : :code_range
    changes.add_diagnostic(meth, "... and other #{ error_count - 3 } errors")
  end
end