Class: RBS::Types::Function
- Inherits:
-
Object
- Object
- RBS::Types::Function
- Defined in:
- lib/rbs/types.rb
Defined Under Namespace
Classes: Param
Instance Attribute Summary collapse
-
#optional_keywords ⇒ Object
readonly
Returns the value of attribute optional_keywords.
-
#optional_positionals ⇒ Object
readonly
Returns the value of attribute optional_positionals.
-
#required_keywords ⇒ Object
readonly
Returns the value of attribute required_keywords.
-
#required_positionals ⇒ Object
readonly
Returns the value of attribute required_positionals.
-
#rest_keywords ⇒ Object
readonly
Returns the value of attribute rest_keywords.
-
#rest_positionals ⇒ Object
readonly
Returns the value of attribute rest_positionals.
-
#return_type ⇒ Object
readonly
Returns the value of attribute return_type.
-
#trailing_positionals ⇒ Object
readonly
Returns the value of attribute trailing_positionals.
Class Method Summary collapse
Instance Method Summary collapse
- #==(other) ⇒ Object (also: #eql?)
- #amap(array, &block) ⇒ Object
- #drop_head ⇒ Object
- #drop_tail ⇒ Object
- #each_param(&block) ⇒ Object
- #each_type ⇒ Object
- #empty? ⇒ Boolean
- #free_variables(set = Set.new) ⇒ Object
- #has_classish_type? ⇒ Boolean
- #has_keyword? ⇒ Boolean
- #has_self_type? ⇒ Boolean
- #hash ⇒ Object
- #hmapv(hash, &block) ⇒ Object
-
#initialize(required_positionals:, optional_positionals:, rest_positionals:, trailing_positionals:, required_keywords:, optional_keywords:, rest_keywords:, return_type:) ⇒ Function
constructor
A new instance of Function.
- #map_type(&block) ⇒ Object
- #map_type_name(&block) ⇒ Object
- #param_to_s ⇒ Object
- #return_to_s ⇒ Object
- #sub(s) ⇒ Object
- #to_json(state = _ = nil) ⇒ Object
- #update(required_positionals: self.required_positionals, optional_positionals: self.optional_positionals, rest_positionals: self.rest_positionals, trailing_positionals: self.trailing_positionals, required_keywords: self.required_keywords, optional_keywords: self.optional_keywords, rest_keywords: self.rest_keywords, return_type: self.return_type) ⇒ Object
- #with_nonreturn_void? ⇒ Boolean
- #with_return_type(type) ⇒ Object
Constructor Details
#initialize(required_positionals:, optional_positionals:, rest_positionals:, trailing_positionals:, required_keywords:, optional_keywords:, rest_keywords:, return_type:) ⇒ Function
Returns a new instance of Function.
906 907 908 909 910 911 912 913 914 915 |
# File 'lib/rbs/types.rb', line 906 def initialize(required_positionals:, optional_positionals:, rest_positionals:, trailing_positionals:, required_keywords:, optional_keywords:, rest_keywords:, return_type:) @return_type = return_type @required_positionals = required_positionals @optional_positionals = optional_positionals @rest_positionals = rest_positionals @trailing_positionals = trailing_positionals @required_keywords = required_keywords @optional_keywords = optional_keywords @rest_keywords = rest_keywords end |
Instance Attribute Details
#optional_keywords ⇒ Object (readonly)
Returns the value of attribute optional_keywords.
902 903 904 |
# File 'lib/rbs/types.rb', line 902 def optional_keywords @optional_keywords end |
#optional_positionals ⇒ Object (readonly)
Returns the value of attribute optional_positionals.
898 899 900 |
# File 'lib/rbs/types.rb', line 898 def optional_positionals @optional_positionals end |
#required_keywords ⇒ Object (readonly)
Returns the value of attribute required_keywords.
901 902 903 |
# File 'lib/rbs/types.rb', line 901 def required_keywords @required_keywords end |
#required_positionals ⇒ Object (readonly)
Returns the value of attribute required_positionals.
897 898 899 |
# File 'lib/rbs/types.rb', line 897 def required_positionals @required_positionals end |
#rest_keywords ⇒ Object (readonly)
Returns the value of attribute rest_keywords.
903 904 905 |
# File 'lib/rbs/types.rb', line 903 def rest_keywords @rest_keywords end |
#rest_positionals ⇒ Object (readonly)
Returns the value of attribute rest_positionals.
899 900 901 |
# File 'lib/rbs/types.rb', line 899 def rest_positionals @rest_positionals end |
#return_type ⇒ Object (readonly)
Returns the value of attribute return_type.
904 905 906 |
# File 'lib/rbs/types.rb', line 904 def return_type @return_type end |
#trailing_positionals ⇒ Object (readonly)
Returns the value of attribute trailing_positionals.
900 901 902 |
# File 'lib/rbs/types.rb', line 900 def trailing_positionals @trailing_positionals end |
Class Method Details
.empty(return_type) ⇒ Object
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 |
# File 'lib/rbs/types.rb', line 1056 def self.empty(return_type) Function.new( required_positionals: [], optional_positionals: [], rest_positionals: nil, trailing_positionals: [], required_keywords: {}, optional_keywords: {}, rest_keywords: nil, return_type: return_type ) end |
Instance Method Details
#==(other) ⇒ Object Also known as: eql?
917 918 919 920 921 922 923 924 925 926 927 |
# File 'lib/rbs/types.rb', line 917 def ==(other) other.is_a?(Function) && other.required_positionals == required_positionals && other.optional_positionals == optional_positionals && other.rest_positionals == rest_positionals && other.trailing_positionals == trailing_positionals && other.required_keywords == required_keywords && other.optional_keywords == optional_keywords && other.rest_keywords == rest_keywords && other.return_type == return_type end |
#amap(array, &block) ⇒ Object
988 989 990 991 992 993 994 |
# File 'lib/rbs/types.rb', line 988 def amap(array, &block) if array.empty? _ = array else array.map(&block) end end |
#drop_head ⇒ Object
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 |
# File 'lib/rbs/types.rb', line 1125 def drop_head case when !required_positionals.empty? [ required_positionals[0], update(required_positionals: required_positionals.drop(1)) ] when !optional_positionals.empty? [ optional_positionals[0], update(optional_positionals: optional_positionals.drop(1)) ] else raise "Cannot #drop_head" end end |
#drop_tail ⇒ Object
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 |
# File 'lib/rbs/types.rb', line 1142 def drop_tail case when !trailing_positionals.empty? last = trailing_positionals.last or raise [ last, update(trailing_positionals: trailing_positionals.take(trailing_positionals.size - 1)) ] else raise "Cannot #drop_tail" end end |
#each_param(&block) ⇒ Object
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 |
# File 'lib/rbs/types.rb', line 1025 def each_param(&block) if block required_positionals.each(&block) optional_positionals.each(&block) rest_positionals&.yield_self(&block) trailing_positionals.each(&block) required_keywords.each_value(&block) optional_keywords.each_value(&block) rest_keywords&.yield_self(&block) else enum_for :each_param end end |
#each_type ⇒ Object
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 |
# File 'lib/rbs/types.rb', line 1010 def each_type if block_given? required_positionals.each {|param| yield param.type } optional_positionals.each {|param| yield param.type } rest_positionals&.yield_self {|param| yield param.type } trailing_positionals.each {|param| yield param.type } required_keywords.each_value {|param| yield param.type } optional_keywords.each_value {|param| yield param.type } rest_keywords&.yield_self {|param| yield param.type } yield(return_type) else enum_for :each_type end end |
#empty? ⇒ Boolean
1096 1097 1098 1099 1100 1101 1102 1103 1104 |
# File 'lib/rbs/types.rb', line 1096 def empty? required_positionals.empty? && optional_positionals.empty? && !rest_positionals && trailing_positionals.empty? && required_keywords.empty? && optional_keywords.empty? && !rest_keywords end |
#free_variables(set = Set.new) ⇒ Object
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 |
# File 'lib/rbs/types.rb', line 943 def free_variables(set = Set.new) set.tap do required_positionals.each do |param| param.type.free_variables(set) end optional_positionals.each do |param| param.type.free_variables(set) end rest_positionals&.yield_self do |param| param.type.free_variables(set) end trailing_positionals.each do |param| param.type.free_variables(set) end required_keywords.each_value do |param| param.type.free_variables(set) end optional_keywords.each_value do |param| param.type.free_variables(set) end rest_keywords&.yield_self do |param| param.type.free_variables(set) end return_type.free_variables(set) end end |
#has_classish_type? ⇒ Boolean
1167 1168 1169 |
# File 'lib/rbs/types.rb', line 1167 def has_classish_type? each_type.any? {|type| type.has_classish_type? } end |
#has_keyword? ⇒ Boolean
1155 1156 1157 1158 1159 1160 1161 |
# File 'lib/rbs/types.rb', line 1155 def has_keyword? if !required_keywords.empty? || !optional_keywords.empty? || rest_keywords true else false end end |
#has_self_type? ⇒ Boolean
1163 1164 1165 |
# File 'lib/rbs/types.rb', line 1163 def has_self_type? each_type.any? {|type| type.has_self_type? } end |
#hash ⇒ Object
931 932 933 934 935 936 937 938 939 940 941 |
# File 'lib/rbs/types.rb', line 931 def hash self.class.hash ^ required_positionals.hash ^ optional_positionals.hash ^ rest_positionals.hash ^ trailing_positionals.hash ^ required_keywords.hash ^ optional_keywords.hash ^ rest_keywords.hash ^ return_type.hash end |
#hmapv(hash, &block) ⇒ Object
996 997 998 999 1000 1001 1002 |
# File 'lib/rbs/types.rb', line 996 def hmapv(hash, &block) if hash.empty? _ = hash else hash.transform_values(&block) end end |
#map_type(&block) ⇒ Object
971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 |
# File 'lib/rbs/types.rb', line 971 def map_type(&block) if block Function.new( required_positionals: amap(required_positionals) {|param| param.map_type(&block) }, optional_positionals: amap(optional_positionals) {|param| param.map_type(&block) }, rest_positionals: rest_positionals&.yield_self {|param| param.map_type(&block) }, trailing_positionals: amap(trailing_positionals) {|param| param.map_type(&block) }, required_keywords: hmapv(required_keywords) {|param| param.map_type(&block) }, optional_keywords: hmapv(optional_keywords) {|param| param.map_type(&block) }, rest_keywords: rest_keywords&.yield_self {|param| param.map_type(&block) }, return_type: yield(return_type) ) else enum_for :map_type end end |
#map_type_name(&block) ⇒ Object
1004 1005 1006 1007 1008 |
# File 'lib/rbs/types.rb', line 1004 def map_type_name(&block) map_type do |type| type.map_type_name(&block) end end |
#param_to_s ⇒ Object
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 |
# File 'lib/rbs/types.rb', line 1106 def param_to_s # @type var params: Array[String] params = [] params.push(*required_positionals.map(&:to_s)) params.push(*optional_positionals.map {|p| "?#{p}"}) params.push("*#{rest_positionals}") if rest_positionals params.push(*trailing_positionals.map(&:to_s)) params.push(*required_keywords.map {|name, param| "#{name}: #{param}" }) params.push(*optional_keywords.map {|name, param| "?#{name}: #{param}" }) params.push("**#{rest_keywords}") if rest_keywords params.join(", ") end |
#return_to_s ⇒ Object
1121 1122 1123 |
# File 'lib/rbs/types.rb', line 1121 def return_to_s return_type.to_s(1) end |
#sub(s) ⇒ Object
1052 1053 1054 |
# File 'lib/rbs/types.rb', line 1052 def sub(s) map_type {|ty| ty.sub(s) } end |
#to_json(state = _ = nil) ⇒ Object
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 |
# File 'lib/rbs/types.rb', line 1039 def to_json(state = _ = nil) { required_positionals: required_positionals, optional_positionals: optional_positionals, rest_positionals: rest_positionals, trailing_positionals: trailing_positionals, required_keywords: required_keywords, optional_keywords: optional_keywords, rest_keywords: rest_keywords, return_type: return_type }.to_json(state) end |
#update(required_positionals: self.required_positionals, optional_positionals: self.optional_positionals, rest_positionals: self.rest_positionals, trailing_positionals: self.trailing_positionals, required_keywords: self.required_keywords, optional_keywords: self.optional_keywords, rest_keywords: self.rest_keywords, return_type: self.return_type) ⇒ Object
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 |
# File 'lib/rbs/types.rb', line 1082 def update(required_positionals: self.required_positionals, optional_positionals: self.optional_positionals, rest_positionals: self.rest_positionals, trailing_positionals: self.trailing_positionals, required_keywords: self.required_keywords, optional_keywords: self.optional_keywords, rest_keywords: self.rest_keywords, return_type: self.return_type) Function.new( required_positionals: required_positionals, optional_positionals: optional_positionals, rest_positionals: rest_positionals, trailing_positionals: trailing_positionals, required_keywords: required_keywords, optional_keywords: optional_keywords, rest_keywords: rest_keywords, return_type: return_type ) end |
#with_nonreturn_void? ⇒ Boolean
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 |
# File 'lib/rbs/types.rb', line 1171 def with_nonreturn_void? if each_param.any? {|param| param.type.with_nonreturn_void? } true else if return_type.is_a?(Bases::Void) false else return_type.with_nonreturn_void? end end end |
#with_return_type(type) ⇒ Object
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 |
# File 'lib/rbs/types.rb', line 1069 def with_return_type(type) Function.new( required_positionals: required_positionals, optional_positionals: optional_positionals, rest_positionals: rest_positionals, trailing_positionals: trailing_positionals, required_keywords: required_keywords, optional_keywords: optional_keywords, rest_keywords: rest_keywords, return_type: type ) end |