Class: RBS::AST::TypeParam

Inherits:
Object
  • Object
show all
Defined in:
lib/rbs/ast/type_param.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, variance:, upper_bound:, location:, default_type: nil, unchecked: false) ⇒ TypeParam

Returns a new instance of TypeParam.



8
9
10
11
12
13
14
15
 
# File 'lib/rbs/ast/type_param.rb', line 8

def initialize(name:, variance:, upper_bound:, location:, default_type: nil, unchecked: false)
  @name = name
  @variance = variance
  @upper_bound_type = upper_bound
  @location = location
  @default_type = default_type
  @unchecked = unchecked
end

Instance Attribute Details

#default_type ⇒ Object (readonly)

Returns the value of attribute default_type.



6
7
8
 
# File 'lib/rbs/ast/type_param.rb', line 6

def default_type
  @default_type
end

#location ⇒ Object (readonly)

Returns the value of attribute location.



6
7
8
 
# File 'lib/rbs/ast/type_param.rb', line 6

def location
  @location
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



6
7
8
 
# File 'lib/rbs/ast/type_param.rb', line 6

def name
  @name
end

#upper_bound_type ⇒ Object (readonly)

Returns the value of attribute upper_bound_type.



6
7
8
 
# File 'lib/rbs/ast/type_param.rb', line 6

def upper_bound_type
  @upper_bound_type
end

#variance ⇒ Object (readonly)

Returns the value of attribute variance.



6
7
8
 
# File 'lib/rbs/ast/type_param.rb', line 6

def variance
  @variance
end

Class Method Details

.application(params, args) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/rbs/ast/type_param.rb', line 146

def self.application(params, args)
  if params.empty?
    return nil
  end

  optional_params, required_params = params.partition {|param| param.default_type }

  param_subst = Substitution.new()
  app_subst = Substitution.new()

  required_params.zip(args.take(required_params.size)).each do |param, arg|
    arg ||= Types::Bases::Any.new(location: nil)
    param_subst.add(from: param.name, to: arg)
    app_subst.add(from: param.name, to: arg)
  end

  optional_params.each do |param|
    param_subst.add(from: param.name, to: Types::Bases::Any.new(location: nil))
  end

  optional_params.zip(args.drop(required_params.size)).each do |param, arg|
    if arg
      app_subst.add(from: param.name, to: arg)
    else
      param.default_type or raise
      app_subst.add(from: param.name, to: param.default_type.sub(param_subst))
    end
  end

  app_subst
end

.normalize_args(params, args) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/rbs/ast/type_param.rb', line 178

def self.normalize_args(params, args)
  app = application(params, args) or return []

  min_count = params.count { _1.default_type.nil? }
  unless min_count <= args.size && args.size <= params.size
    return args
  end

  params.zip(args).filter_map do |param, arg|
    if arg
      arg
    else
      if param.default_type
        param.default_type.sub(app)
      else
        Types::Bases::Any.new(location: nil)
      end
    end
  end
end

.rename(params, new_names:) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/rbs/ast/type_param.rb', line 99

def self.rename(params, new_names:)
  raise unless params.size == new_names.size

  subst = Substitution.build(new_names, Types::Variable.build(new_names))

  params.map.with_index do |param, index|
    new_name = new_names[index]

    TypeParam.new(
      name: new_name,
      variance: param.variance,
      upper_bound: param.upper_bound_type&.map_type {|type| type.sub(subst) },
      location: param.location,
      default_type: param.default_type&.map_type {|type| type.sub(subst) }
    ).unchecked!(param.unchecked?)
  end
end

.resolve_variables(params) ⇒ Object 



77
78
79
80
81
82
83
84
85
 
# File 'lib/rbs/ast/type_param.rb', line 77

def self.resolve_variables(params)
  return if params.empty?

  vars = Set.new(params.map(&:name))

  params.map! do |param|
    param.map_type {|bound| _ = subst_var(vars, bound) }
  end
end

.subst_var(vars, type) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/rbs/ast/type_param.rb', line 87

def self.subst_var(vars, type)
  case type
  when Types::ClassInstance
    namespace = type.name.namespace
    if namespace.relative? && namespace.empty? && vars.member?(type.name.name)
      return Types::Variable.new(name: type.name.name, location: type.location)
    end
  end

  type.map_type {|t| subst_var(vars, t) }
end

.validate(type_params) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/rbs/ast/type_param.rb', line 199

def self.validate(type_params)
  optionals = type_params.filter {|param| param.default_type }

  optional_param_names = optionals.map(&:name).sort

  optionals.filter! do |param|
    default_type = param.default_type or raise
    optional_param_names.any? { default_type.free_variables.include?(_1) }
  end

  unless optionals.empty?
    optionals
  end
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql? 



33
34
35
36
37
38
39
40
 
# File 'lib/rbs/ast/type_param.rb', line 33

def ==(other)
  other.is_a?(TypeParam) &&
    other.name == name &&
    other.variance == variance &&
    other.upper_bound_type == upper_bound_type &&
    other.default_type == default_type &&
    other.unchecked? == unchecked?
end

#hash ⇒ Object 



44
45
46
 
# File 'lib/rbs/ast/type_param.rb', line 44

def hash
  self.class.hash ^ name.hash ^ variance.hash ^ upper_bound_type.hash ^ unchecked?.hash ^ default_type.hash
end

#map_type(&block) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/rbs/ast/type_param.rb', line 59

def map_type(&block)
  if b = upper_bound_type
    _upper_bound_type = yield(b)
  end

  if dt = default_type
    _default_type = yield(dt)
  end

  TypeParam.new(
    name: name,
    variance: variance,
    upper_bound: _upper_bound_type,
    location: location,
    default_type: _default_type
  ).unchecked!(unchecked?)
end

#to_json(state = JSON::State.new) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/rbs/ast/type_param.rb', line 48

def to_json(state = JSON::State.new)
  {
    name: name,
    variance: variance,
    unchecked: unchecked?,
    location: location,
    upper_bound: upper_bound_type,
    default_type: default_type
  }.to_json(state)
end

#to_s ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/rbs/ast/type_param.rb', line 117

def to_s
  s = +""

  if unchecked?
    s << "unchecked "
  end

  case variance
  when :invariant
    # nop
  when :covariant
    s << "out "
  when :contravariant
    s << "in "
  end

  s << name.to_s

  if type = upper_bound_type
    s << " < #{type}"
  end

  if dt = default_type
    s << " = #{dt}"
  end

  s
end

#unchecked!(value = true) ⇒ Object 



24
25
26
27
 
# File 'lib/rbs/ast/type_param.rb', line 24

def unchecked!(value = true)
  @unchecked = value ? true : false
  self
end

#unchecked? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/rbs/ast/type_param.rb', line 29

def unchecked?
  @unchecked
end

#upper_bound ⇒ Object 



17
18
19
20
21
22
 
# File 'lib/rbs/ast/type_param.rb', line 17

def upper_bound
  case upper_bound_type
  when Types::ClassInstance, Types::ClassSingleton, Types::Interface
    upper_bound_type
  end
end