Class: Puppet::Pops::Types::PAnyType

Inherits:
TypedModelObject show all
Defined in:
lib/puppet/pops/types/types.rb

Overview

Base type for all types

Constant Summary collapse

DEFAULT =

The default instance of this type. Each type in the type system has this constant declared.

PAnyType.new

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TypedModelObject

_ptype, create_ptype, register_ptypes

Methods included from PuppetObject

#_ptype

Class Method Details

.new_function(instance, loader) ⇒ Object

This default implementation of of a new_function raises an Argument Error. Types for which creating a new instance is supported, should create and return a Puppet Function class by using Puppet:Loaders.create_loaded_function(:new, loader) and return that result.

Raises:

  • (ArgumentError) 


306
307
308
 
# File 'lib/puppet/pops/types/types.rb', line 306

def self.new_function(instance, loader)
  raise ArgumentError.new("Creation of new instance of type '#{instance.to_s}' is not supported")
end

.register_ptype(loader, ir) ⇒ Object 



79
80
81
 
# File 'lib/puppet/pops/types/types.rb', line 79

def self.register_ptype(loader, ir)
  @type = Pcore::create_object_type(loader, ir, self, 'Pcore::AnyType', 'Any', EMPTY_HASH)
end

.simple_name ⇒ String

Strips the class name from all module prefixes, the leading ‘P’ and the ending ‘Type’. I.e. an instance of PVariantType will return ‘Variant’

Returns:

  • (String) —

    the simple name of this type



272
273
274
275
276
277
278
 
# File 'lib/puppet/pops/types/types.rb', line 272

def self.simple_name
  if @simple_name.nil?
    n = name
    @simple_name = n[n.rindex('::')+3..n.size-5]
  end
  @simple_name
end

Instance Method Details

#==(o) ⇒ Object 



261
262
263
 
# File 'lib/puppet/pops/types/types.rb', line 261

def ==(o)
  eql?(o)
end

#accept(visitor, guard) ⇒ Object

Accept a visitor that will be sent the message ‘visit`, once with `self` as the argument. The visitor will then visit all types that this type contains.



86
87
88
 
# File 'lib/puppet/pops/types/types.rb', line 86

def accept(visitor, guard)
  visitor.visit(self, guard)
end

#assignable?(o, guard = nil) ⇒ Boolean

Checks if o is a type that is assignable to this type. If o is a ‘Class` then it is first converted to a type. If o is a Variant, then it is considered assignable when all its types are assignable

The check for assignable must be guarded against self recursion since ‘self`, the given type o, or both, might be a `TypeAlias`. The initial caller of this method will typically never care about this and hence pass only the first argument, but as soon as a check of a contained type encounters a `TypeAlias`, then a `RecursionGuard` instance is created and passed on in all subsequent calls. The recursion is allowed to continue until self recursion has been detected in both `self` and in the given type. At that point the given type is considered to be assignable to `self` since all checks up to that point were positive.

Parameters:

  • o (Class, PAnyType) —

    the class or type to test

  • guard (RecursionGuard) (defaults to: nil) —

    guard against recursion. Only used by internal calls

Returns:

  • (Boolean) —

    ‘true` when o is assignable to this type



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/puppet/pops/types/types.rb', line 106

def assignable?(o, guard = nil)
  case o
  when Class
    # Safe to call _assignable directly since a Class never is a Unit or Variant
    _assignable?(TypeCalculator.singleton.type(o), guard)
  when PUnitType
    true
  when PTypeAliasType
    # An alias may contain self recursive constructs.
    if o.self_recursion?
      guard ||= RecursionGuard.new
      if guard.add_that(o) == RecursionGuard::SELF_RECURSION_IN_BOTH
        # Recursion detected both in self and other. This means that other is assignable
        # to self. This point would not have been reached otherwise
        true
      else
        assignable?(o.resolved_type, guard)
      end
    else
      assignable?(o.resolved_type, guard)
    end
  when PVariantType
    # Assignable if all contained types are assignable
    o.types.all? { |vt| assignable?(vt, guard) }
  when PNotUndefType
    if !(o.type.nil? || o.type.assignable?(PUndefType::DEFAULT))
      assignable?(o.type, guard)
    else
      _assignable?(o, guard)
    end
  else
    _assignable?(o, guard)
  end
end

#callable?(args, guard = nil) ⇒ Boolean

Returns ‘true` if this instance is a callable that accepts the given args

Parameters:

  • args (PAnyType) —

    the arguments to test

  • guard (RecursionGuard) (defaults to: nil) —

    guard against recursion. Only used by internal calls

Returns:

  • (Boolean) —

    ‘true` if this instance is a callable that accepts the given args



146
147
148
 
# File 'lib/puppet/pops/types/types.rb', line 146

def callable?(args, guard = nil)
  args.is_a?(PAnyType) && kind_of_callable? && args.callable_args?(self, guard)
end

#callable_args?(callable, guard) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns ‘true` if this instance is considered valid as arguments to the given `callable`

Parameters:

  • callable (PAnyType) —

    the callable

  • guard (RecursionGuard) —

    guard against recursion. Only used by internal calls

Returns:

  • (Boolean) —

    ‘true` if this instance is considered valid as arguments to the given `callable`



155
156
157
 
# File 'lib/puppet/pops/types/types.rb', line 155

def callable_args?(callable, guard)
  false
end

#check_self_recursion(originator) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Called from the ‘PTypeAliasType` when it detects self recursion. The default is to do nothing but some self recursive constructs are illegal such as when a `PObjectType` somehow inherits itself

Parameters:

Raises:

  • Puppet::Error if an illegal self recursion is detected



164
165
 
# File 'lib/puppet/pops/types/types.rb', line 164

def check_self_recursion(originator)
end

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean) 


257
258
259
 
# File 'lib/puppet/pops/types/types.rb', line 257

def eql?(o)
  self.class == o.class
end

#generalize ⇒ PAnyType

Generalizes value specific types. Types that are not value specific will return ‘self` otherwise the generalized type is returned.

Returns:



172
173
174
175
 
# File 'lib/puppet/pops/types/types.rb', line 172

def generalize
  # Applicable to all types that have no variables
  self
end

#hash ⇒ Object 



236
237
238
 
# File 'lib/puppet/pops/types/types.rb', line 236

def hash
  self.class.hash
end

#instance?(o, guard = nil) ⇒ Boolean

Returns true if the given argument o is an instance of this type

Parameters:

  • guard (RecursionGuard) (defaults to: nil) —

    guard against recursion. Only used by internal calls

Returns:

  • (Boolean) 


244
245
246
 
# File 'lib/puppet/pops/types/types.rb', line 244

def instance?(o, guard = nil)
  true
end

#iterable?(guard = nil) ⇒ Boolean

Returns ‘true` if an instance of this type is iterable, `false` otherwise The method #iterable_type must produce a `PIterableType` instance when this method returns `true`

Parameters:

  • guard (RecursionGuard) (defaults to: nil) —

    guard against recursion. Only used by internal calls

Returns:

  • (Boolean) —

    flag to indicate if instances of this type is iterable.



216
217
218
 
# File 'lib/puppet/pops/types/types.rb', line 216

def iterable?(guard = nil)
  false
end

#iterable_type(guard = nil) ⇒ PIterableType?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the ‘PIterableType` that this type should be assignable to, or `nil` if no such type exists. A type that returns a `PIterableType` must respond `true` to `#iterable?`.

Examples:

Any Collection[T] is assignable to an Iterable[T]
A String is assignable to an Iterable[String] iterating over the strings characters
An Integer is assignable to an Iterable[Integer] iterating over the 'times' enumerator
A Type[T] is assignable to an Iterable[Type[T]] if T is an Integer or Enum

Parameters:

  • guard (RecursionGuard) (defaults to: nil) —

    guard against recursion. Only used by internal calls

Returns:

  • (PIterableType, nil) —

    The iterable type that this type is assignable to or ‘nil`



232
233
234
 
# File 'lib/puppet/pops/types/types.rb', line 232

def iterable_type(guard = nil)
  nil
end

#kind_of_callable?(optional = true, guard = nil) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Responds ‘true` for all callables, variants of callables and unless optional is false, all optional callables.

Parameters:

  • optional (Boolean) (defaults to: true)
  • guard (RecursionGuard) (defaults to: nil) —

    guard against recursion. Only used by internal calls

Returns:

  • (Boolean) —

    ‘true`if this type is considered callable



206
207
208
 
# File 'lib/puppet/pops/types/types.rb', line 206

def kind_of_callable?(optional = true, guard = nil)
  false
end

#name ⇒ String

Returns the name of the type, without parameters

Returns:

  • (String) —

    the name of the type



291
292
293
 
# File 'lib/puppet/pops/types/types.rb', line 291

def name
  simple_name
end

#new_function(loader) ⇒ Object 



295
296
297
 
# File 'lib/puppet/pops/types/types.rb', line 295

def new_function(loader)
  self.class.new_function(self, loader)
end

#normalize(guard = nil) ⇒ PAnyType

Normalizes the type. This does not change the characteristics of the type but it will remove duplicates and constructs like NotUndef where T is not assignable from Undef and change Variant where all T are enums into an Enum.

Parameters:

  • guard (RecursionGuard) (defaults to: nil) —

    guard against recursion. Only used by internal calls

Returns:

  • (PAnyType) —

    The iterable type that this type is assignable to or ‘nil`



184
185
186
 
# File 'lib/puppet/pops/types/types.rb', line 184

def normalize(guard = nil)
  self
end

#really_instance?(o, guard = nil) ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

An object is considered to really be an instance of a type when something other than a TypeAlias or a Variant responds true to a call to #instance?.

Returns:

  • (Integer) —

    -1 = is not instance, 0 = recursion detected, 1 = is instance



253
254
255
 
# File 'lib/puppet/pops/types/types.rb', line 253

def really_instance?(o, guard = nil)
  instance?(o, guard) ? 1 : -1
end

#resolve(type_parser, loader) ⇒ PTypeAliasType

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Called from the TypeParser once it has found a type using the Loader to enable that this type can resolve internal type expressions using a loader. Presently, this method is a no-op for all types except the {PTypeAliasType}.

Parameters:

Returns:



196
197
198
 
# File 'lib/puppet/pops/types/types.rb', line 196

def resolve(type_parser, loader)
  self
end

#simple_name ⇒ Object 



265
266
267
 
# File 'lib/puppet/pops/types/types.rb', line 265

def simple_name
  self.class.simple_name
end

#to_alias_expanded_s ⇒ Object 



280
281
282
 
# File 'lib/puppet/pops/types/types.rb', line 280

def to_alias_expanded_s
  TypeFormatter.new.alias_expanded_string(self)
end

#to_s ⇒ Object 



284
285
286
 
# File 'lib/puppet/pops/types/types.rb', line 284

def to_s
  TypeFormatter.string(self)
end