puppet 3.1.1 → 3.2.0.rc1

data/lib/puppet/pops/model/ast_tree_dumper.rb

@@ -0,0 +1,378 @@
+require 'puppet/parser/ast'
+
+# Dumps a Pops::Model in reverse polish notation; i.e. LISP style
+# The intention is to use this for debugging output
+# TODO: BAD NAME - A DUMP is a Ruby Serialization
+#
+class Puppet::Pops::Model::AstTreeDumper < Puppet::Pops::Model::TreeDumper
+  AST = Puppet::Parser::AST
+  Model = Puppet::Pops::Model
+
+  def dump_LiteralNumber o
+    case o.radix
+    when 10
+      o.value.to_s
+    when 8
+      "0%o" % o.value
+    when 16
+      "0x%X" % o.value
+    else
+      "bad radix:" + o.value.to_s
+    end
+  end
+
+  def dump_Factory o
+    do_dump(o.current)
+  end
+
+  def dump_ArithmeticOperator o
+    [o.operator.to_s, do_dump(o.lval), do_dump(o.rval)]
+  end
+  def dump_Relationship o
+    [o.arrow.to_s, do_dump(o.left), do_dump(o.right)]
+  end
+
+  # Hostname is tricky, it is either a bare word, a string, or default, or regular expression
+  # Least evil, all strings except default are quoted
+  def dump_HostName o
+    result = do_dump o.value
+    unless o.value.is_a? AST::Regex
+      result = result == "default" ? ":default" : "'#{result}'"
+    end
+    result
+  end
+
+  # x[y] prints as (slice x y)
+  def dump_HashOrArrayAccess o
+    var = o.variable.is_a?(String) ? "$#{o.variable}" : do_dump(o.variable)
+    ["slice", var, do_dump(o.key)]
+  end
+
+  # The AST Collection knows about exported or virtual query, not the query.
+  def dump_Collection o
+    result = ["collect", do_dump(o.type), :indent, :break]
+    if o.form == :virtual
+      q = ["<| |>"]
+    else
+      q = ["<<| |>>"]
+    end
+    q << do_dump(o.query) unless is_nop?(o.query)
+    q <<  :indent
+    result << q
+    o.override do |ao|
+      result << :break << do_dump(ao)
+    end
+    result += [:dedent, :dedent ]
+    result
+  end
+
+  def dump_CollExpr o
+    operator = case o.oper
+    when 'and'
+      '&&'
+    when 'or'
+      '||'
+    else
+      o.oper
+    end
+    [operator, do_dump(o.test1), do_dump(o.test2)]
+  end
+
+  def dump_ComparisonOperator o
+    [o.operator.to_s, do_dump(o.lval), do_dump(o.rval)]
+  end
+
+  def dump_Boolean o
+    o.to_s
+  end
+
+  def dump_BooleanOperator o
+    operator = o.operator == 'and' ? '&&' : '||'
+    [operator, do_dump(o.lval), do_dump(o.rval)]
+  end
+
+  def dump_InOperator o
+    ["in", do_dump(o.lval), do_dump(o.rval)]
+  end
+
+  # $x = ...
+  # $x += ...
+  #
+  def dump_VarDef o
+    operator = o.append ? "+=" : "="
+    [operator, '$' + do_dump(o.name), do_dump(o.value)]
+  end
+
+  # Produces (name => expr) or (name +> expr)
+  def dump_ResourceParam o
+    operator = o.add ? "+>" : "=>"
+    [do_dump(o.param), operator, do_dump(o.value)]
+  end
+
+  def dump_Array o
+    o.collect {|e| do_dump(e) }
+  end
+
+  def dump_ASTArray o
+    ["[]"] + o.children.collect {|x| do_dump(x)}
+  end
+
+  def dump_ASTHash o
+    ["{}"] + o.value.sort_by{|k,v| k.to_s}.collect {|x| [do_dump(x[0]), do_dump(x[1])]}
+#    ["{}"] + o.value.collect {|x| [do_dump(x[0]), do_dump(x[1])]}
+  end
+
+  def dump_MatchOperator o
+    [o.operator.to_s, do_dump(o.lval), do_dump(o.rval)]
+  end
+
+  # Dump a Ruby String in single quotes unless it is a number.
+  def dump_String o
+
+    if o.is_a? String
+      o               # A Ruby String, not quoted
+    elsif n = Puppet::Pops::Utils.to_n(o.value)
+      o.value         # AST::String that is a number without quotes
+    else
+      "'#{o.value}'"  # AST::String that is not a number
+    end
+  end
+
+  def dump_Lambda o
+    result = ["lambda"]
+    result << ["parameters"] + o.parameters.collect {|p| _dump_ParameterArray(p) } if o.parameters.size() > 0
+    if o.children == []
+      result << [] # does not have a lambda body
+    else
+      result << do_dump(o.children)
+    end
+    result
+  end
+
+  def dump_Default o
+    ":default"
+  end
+
+  def dump_Undef o
+    ":undef"
+  end
+
+  # Note this is Regex (the AST kind), not Ruby Regexp
+  def dump_Regex o
+    "/#{o.value.source}/"
+  end
+
+  def dump_Nop o
+    ":nop"
+  end
+
+  def dump_NilClass o
+    "()"
+  end
+
+  def dump_Not o
+    ['!', dump(o.value)]
+  end
+
+  def dump_Variable o
+    "$#{dump(o.value)}"
+  end
+
+  def dump_Minus o
+    ['-', do_dump(o.value)]
+  end
+
+  def dump_BlockExpression o
+    ["block"] + o.children.collect {|x| do_dump(x) }
+  end
+
+  # Interpolated strings are shown as (cat seg0 seg1 ... segN)
+  def dump_Concat o
+    ["cat"] + o.value.collect {|x| x.is_a?(AST::String) ? " "+do_dump(x) : ["str", do_dump(x)]}
+  end
+
+  def dump_Hostclass o
+    # ok, this is kind of crazy stuff in the AST, information in a context instead of in AST, and
+    # parameters are in a Ruby Array with each parameter being an Array...
+    #
+    context = o.context
+    args = context[:arguments]
+    parent = context[:parent]
+    result = ["class", o.name]
+    result << ["inherits", parent] if parent
+    result << ["parameters"] + args.collect {|p| _dump_ParameterArray(p) } if args && args.size() > 0
+    if is_nop?(o.code)
+      result << []
+    else
+      result << do_dump(o.code)
+    end
+    result
+  end
+
+  def dump_Name o
+    o.value
+  end
+
+  def dump_Node o
+    context = o.context
+    parent = context[:parent]
+    code = context[:code]
+
+    result = ["node"]
+    result << ["matches"] + o.names.collect {|m| do_dump(m) }
+    result << ["parent", do_dump(parent)] if !is_nop?(parent)
+    if is_nop?(code)
+      result << []
+    else
+      result << do_dump(code)
+    end
+    result
+  end
+
+  def dump_Definition o
+    # ok, this is even crazier that Hostclass. The name of the define does not have an accessor
+    # and some things are in the context (but not the name). Parameters are called arguments and they
+    # are in a Ruby Array where each parameter is an array of 1 or 2 elements.
+    #
+    context = o.context
+    name = o.instance_variable_get("@name")
+    args = context[:arguments]
+    code = context[:code]
+    result = ["define", name]
+    result << ["parameters"] + args.collect {|p| _dump_ParameterArray(p) } if args && args.size() > 0
+    if is_nop?(code)
+      result << []
+    else
+      result << do_dump(code)
+    end
+    result
+  end
+
+  def dump_ResourceReference o
+    result = ["slice", do_dump(o.type)]
+    if o.title.children.size == 1
+      result << do_dump(o.title[0])
+    else
+      result << do_dump(o.title.children)
+    end
+    result
+  end
+
+  def dump_ResourceOverride o
+    result = ["override", do_dump(o.object), :indent]
+    o.parameters.each do |p|
+      result << :break << do_dump(p)
+    end
+    result << :dedent
+    result
+  end
+
+  # Puppet AST encodes a parameter as a one or two slot Array.
+  # This is not a polymorph dump method.
+  #
+  def _dump_ParameterArray o
+    if o.size == 2
+      ["=", o[0], do_dump(o[1])]
+    else
+      o[0]
+    end
+  end
+
+  def dump_IfStatement o
+    result = ["if", do_dump(o.test), :indent, :break,
+      ["then", :indent, do_dump(o.statements), :dedent]]
+    result +=
+    [:break,
+      ["else", :indent, do_dump(o.else), :dedent],
+      :dedent] unless is_nop? o.else
+    result
+  end
+
+  # Produces (invoke name args...) when not required to produce an rvalue, and
+  # (call name args ... ) otherwise.
+  #
+  def dump_Function o
+    # somewhat ugly as Function hides its "ftype" instance variable
+    result = [o.instance_variable_get("@ftype") == :rvalue ? "call" : "invoke", do_dump(o.name)]
+    o.arguments.collect {|a| result << do_dump(a) }
+    result << do_dump(o.pblock) if o.pblock
+    result
+  end
+
+  def dump_MethodCall o
+    # somewhat ugly as Method call (does the same as function) and hides its "ftype" instance variable
+    result = [o.instance_variable_get("@ftype") == :rvalue ? "call-method" : "invoke-method",
+      [".", do_dump(o.receiver), do_dump(o.name)]]
+    o.arguments.collect {|a| result << do_dump(a) }
+    result << do_dump(o.lambda) if o.lambda
+    result
+  end
+
+  def dump_CaseStatement o
+    result = ["case", do_dump(o.test), :indent]
+    o.options.each do |s|
+      result << :break << do_dump(s)
+    end
+    result << :dedent
+  end
+
+  def dump_CaseOpt o
+    result = ["when"]
+    result << o.value.collect {|x| do_dump(x) }
+    # A bit of trickery to get it into the same shape as Pops output
+    if is_nop?(o.statements)
+      result << ["then", []]  # Puppet AST has a nop if there is no body
+    else
+      result << ["then", do_dump(o.statements) ]
+    end
+    result
+  end
+
+  def dump_ResourceInstance o
+    result = [do_dump(o.title), :indent]
+    o.parameters.each do |p|
+      result << :break << do_dump(p)
+    end
+    result << :dedent
+    result
+  end
+
+  def dump_ResourceDefaults o
+    result = ["resource-defaults", do_dump(o.type), :indent]
+    o.parameters.each do |p|
+      result << :break << do_dump(p)
+    end
+    result << :dedent
+    result
+  end
+
+  def dump_Resource o
+    if o.exported
+      form = 'exported-'
+    elsif o.virtual
+      form = 'virtual-'
+    else
+      form = ''
+    end
+    result = [form+"resource", do_dump(o.type), :indent]
+    o.instances.each do |b|
+      result << :break << do_dump(b)
+    end
+    result << :dedent
+    result
+  end
+
+  def dump_Selector o
+    values = o.values
+    values = [values] unless values.instance_of? AST::ASTArray or values.instance_of? Array
+    ["?", do_dump(o.param)] + values.collect {|x| do_dump(x) }
+  end
+
+  def dump_Object o
+    ['dev-error-no-polymorph-dump-for:', o.class.to_s, o.to_s]
+  end
+
+  def is_nop? o
+    o.nil? || o.is_a?(Model::Nop) || o.is_a?(AST::Nop)
+  end
+end

data/lib/puppet/pops/model/factory.rb

@@ -0,0 +1,804 @@
+# Factory is a helper class that makes construction of a Pops Model
+# much more convenient. It can be viewed as a small internal DSL for model
+# constructions.
+# For usage see tests using the factory.
+#
+# @todo All those uppercase methods ... they look bad in one way, but stand out nicely in the grammar...
+#   decide if they should change into lower case names (some of the are lower case)...
+#
+class Puppet::Pops::Model::Factory
+  Model = Puppet::Pops::Model
+
+  attr_accessor :current
+
+  # Shared build_visitor, since there are many instances of Factory being used
+  @@build_visitor = Puppet::Pops::Visitor.new(self, "build")
+  # Initialize a factory with a single object, or a class with arguments applied to build of
+  # created instance
+  #
+  def initialize popsobj, *args
+    @current = to_ops(popsobj, *args)
+  end
+
+  # Polymorphic build
+  def build(o, *args)
+    begin
+      @@build_visitor.visit_this(self, o, *args)
+    rescue =>e
+      # require 'debugger'; debugger # enable this when in trouble...
+      raise e
+    end
+  end
+
+  # Building of Model classes
+
+  def build_ArithmeticExpression(o, op, a, b)
+    o.operator = op
+    build_BinaryExpression(o, a, b)
+  end
+
+  def build_AssignmentExpression(o, op, a, b)
+    o.operator = op
+    build_BinaryExpression(o, a, b)
+  end
+
+  def build_AttributeOperation(o, name, op, value)
+    o.operator = op
+    o.attribute_name = name.to_s # BOOLEAN is allowed in the grammar
+    o.value_expr = build(value)
+    o
+  end
+
+  def build_AccessExpression(o, left, *keys)
+    o.left_expr = to_ops(left)
+    keys.each {|expr| o.addKeys(to_ops(expr)) }
+    o
+  end
+
+  def build_BinaryExpression(o, left, right)
+    o.left_expr = to_ops(left)
+    o.right_expr = to_ops(right)
+    o
+  end
+
+  def build_BlockExpression(o, *args)
+    args.each {|expr| o.addStatements(to_ops(expr)) }
+    o
+  end
+
+  def build_CollectExpression(o, type_expr, query_expr, attribute_operations)
+    o.type_expr = to_ops(type_expr)
+    o.query = build(query_expr)
+    attribute_operations.each {|op| o.addOperations(build(op)) }
+    o
+  end
+
+  def build_ComparisonExpression(o, op, a, b)
+    o.operator = op
+    build_BinaryExpression(o, a, b)
+  end
+
+  def build_ConcatenatedString(o, *args)
+    args.each {|expr| o.addSegments(build(expr)) }
+    o
+  end
+
+  def build_CreateTypeExpression(o, name, super_name = nil)
+    o.name = name
+    o.super_name = super_name
+    o
+  end
+
+  def build_CreateEnumExpression(o, *args)
+    o.name = args.slice(0) if args.size == 2
+    o.values = build(args.last)
+    o
+  end
+
+  def build_CreateAttributeExpression(o, name, datatype_expr)
+    o.name = name
+    o.type = to_ops(datatype_expr)
+    o
+  end
+
+  # @param name [String] a valid classname
+  # @param parameters [Array<Model::Parameter>] may be empty
+  # @param parent_class_name [String, nil] a valid classname referencing a parent class, optional.
+  # @param body [Array<Expression>, Expression, nil] expression that constitute the body
+  # @return [Model::HostClassDefinition] configured from the parameters
+  #
+  def build_HostClassDefinition(o, name, parameters, parent_class_name, body)
+    build_NamedDefinition(o, name, parameters, body)
+    o.parent_class = parent_class_name if parent_class_name
+    o
+  end
+
+  #  # @param name [String] a valid classname
+  #  # @param parameters [Array<Model::Parameter>] may be empty
+  #  # @param body [Array<Expression>, Expression, nil] expression that constitute the body
+  #  # @return [Model::HostClassDefinition] configured from the parameters
+  #  #
+  #  def build_ResourceTypeDefinition(o, name, parameters, body)
+  #    build_NamedDefinition(o, name, parameters, body)
+  #    o.name = name
+  #    parameters.each {|p| o.addParameters(build(p)) }
+  #    b = f_build_body(body)
+  #    o.body = b.current if b
+  #    o
+  #  end
+
+  def build_ResourceOverrideExpression(o, resources, attribute_operations)
+    o.resources = build(resources)
+    attribute_operations.each {|ao| o.addOperations(build(ao)) }
+    o
+  end
+
+  def build_KeyedEntry(o, k, v)
+    o.key = build(k)
+    o.value = build(v)
+    o
+  end
+
+  def build_LiteralHash(o, *keyed_entries)
+    keyed_entries.each {|entry| o.addEntries build(entry) }
+    o
+  end
+
+  def build_LiteralList(o, *values)
+    values.each {|v| o.addValues build(v) }
+    o
+  end
+
+  def build_LiteralNumber(o, val, radix)
+    o.value = val
+    o.radix = radix
+    o
+  end
+
+  def build_InstanceReferences(o, type_name, name_expressions)
+    o.type_name = build(type_name)
+    name_expressions.each {|n| o.addNames(build(n)) }
+    o
+  end
+
+  def build_ImportExpression(o, files)
+    # The argument files has already been built
+    files.each {|f| o.addFiles(to_ops(f)) }
+    o
+  end
+
+  def build_IfExpression(o, t, ift, els)
+    o.test = build(t)
+    o.then_expr = build(ift)
+    o.else_expr= build(els)
+    o
+  end
+
+  def build_MatchExpression(o, op, a, b)
+    o.operator = op
+    build_BinaryExpression(o, a, b)
+  end
+
+  # Builds body :) from different kinds of input
+  # @param body [nil] unchanged, produces nil
+  # @param body [Array<Expression>] turns into a BlockExpression
+  # @param body [Expression] produces the given expression
+  # @param body [Object] produces the result of calling #build with body as argument
+  def f_build_body(body)
+    case body
+    when NilClass
+      nil
+    when Array
+      Puppet::Pops::Model::Factory.new(Model::BlockExpression, *body)
+    else
+      build(body)
+    end
+  end
+
+  def build_Definition(o, parameters, body)
+    parameters.each {|p| o.addParameters(build(p)) }
+    b = f_build_body(body)
+    o.body = b.current if b
+    o
+  end
+
+  def build_NamedDefinition(o, name, parameters, body)
+    build_Definition(o, parameters, body)
+    o.name = name
+    o
+  end
+
+  # @param o [Model::NodeDefinition]
+  # @param hosts [Array<Expression>] host matches
+  # @param parent [Expression] parent node matcher
+  # @param body [Object] see {#f_build_body}
+  def build_NodeDefinition(o, hosts, parent, body)
+    hosts.each {|h| o.addHost_matches(build(h)) }
+    o.parent = build(parent) if parent # no nop here
+    b = f_build_body(body)
+    o.body = b.current if b
+    o
+  end
+
+  def build_Parameter(o, name, expr)
+    o.name = name
+    o.value = build(expr) if expr # don't build a nil/nop
+    o
+  end
+
+  def build_QualifiedReference(o, name)
+    o.value = name.to_s.downcase
+    o
+  end
+
+  def build_RelationshipExpression(o, op, a, b)
+    o.operator = op
+    build_BinaryExpression(o, a, b)
+  end
+
+  def build_ResourceExpression(o, type_name, bodies)
+    o.type_name = build(type_name)
+    bodies.each {|b| o.addBodies(build(b)) }
+    o
+  end
+
+  def build_ResourceBody(o, title_expression, attribute_operations)
+    o.title = build(title_expression)
+    attribute_operations.each {|ao| o.addOperations(build(ao)) }
+    o
+  end
+
+  def build_ResourceDefaultsExpression(o, type_ref, attribute_operations)
+    o.type_ref = build(type_ref)
+    attribute_operations.each {|ao| o.addOperations(build(ao)) }
+    o
+  end
+
+  def build_SelectorExpression(o, left, *selectors)
+    o.left_expr = to_ops(left)
+    selectors.each {|s| o.addSelectors(build(s)) }
+    o
+  end
+
+  def build_SelectorEntry(o, matching, value)
+    o.matching_expr = build(matching)
+    o.value_expr = build(value)
+    o
+  end
+
+  def build_QueryExpression(o, expr)
+    ops = to_ops(expr)
+    o.expr = ops unless Puppet::Pops::Model::Factory.nop? ops
+    o
+  end
+
+  def build_UnaryExpression(o, expr)
+    ops = to_ops(expr)
+    o.expr = ops unless Puppet::Pops::Model::Factory.nop? ops
+    o
+  end
+
+  def build_QualifiedName(o, name)
+    o.value = name.to_s
+    o
+  end
+
+  # Puppet::Pops::Model::Factory helpers
+  def f_build_unary(klazz, expr)
+    Puppet::Pops::Model::Factory.new(build(klazz.new, expr))
+  end
+
+  def f_build_binary_op(klazz, op, left, right)
+    Puppet::Pops::Model::Factory.new(build(klazz.new, op, left, right))
+  end
+
+  def f_build_binary(klazz, left, right)
+    Puppet::Pops::Model::Factory.new(build(klazz.new, left, right))
+  end
+
+  def f_build_vararg(klazz, left, *arg)
+    Puppet::Pops::Model::Factory.new(build(klazz.new, left, *arg))
+  end
+
+  def f_arithmetic(op, r)
+    f_build_binary_op(Model::ArithmeticExpression, op, current, r)
+  end
+
+  def f_comparison(op, r)
+    f_build_binary_op(Model::ComparisonExpression, op, current, r)
+  end
+
+  def f_match(op, r)
+    f_build_binary_op(Model::MatchExpression, op, current, r)
+  end
+
+  # Operator helpers
+  def in(r)     f_build_binary(Model::InExpression, current, r);          end
+
+  def or(r)     f_build_binary(Model::OrExpression, current, r);          end
+
+  def and(r)    f_build_binary(Model::AndExpression, current, r);         end
+
+  def not();    f_build_unary(Model::NotExpression, self);                end
+
+  def minus();  f_build_unary(Model::UnaryMinusExpression, self);         end
+
+  def text();   f_build_unary(Model::TextExpression, self);               end
+
+  def var();    f_build_unary(Model::VariableExpression, self);           end
+
+  def [](*r);   f_build_vararg(Model::AccessExpression, current, *r);     end
+
+  def dot r;    f_build_binary(Model::NamedAccessExpression, current, r); end
+
+  def + r;      f_arithmetic(:+, r);                                      end
+
+  def - r;      f_arithmetic(:-, r);                                      end
+
+  def / r;      f_arithmetic(:/, r);                                      end
+
+  def * r;      f_arithmetic(:*, r);                                      end
+
+  def % r;      f_arithmetic(:%, r);                                      end
+
+  def << r;     f_arithmetic(:<<, r);                                     end
+
+  def >> r;     f_arithmetic(:>>, r);                                     end
+
+  def < r;      f_comparison(:<, r);                                      end
+
+  def <= r;     f_comparison(:<=, r);                                     end
+
+  def > r;      f_comparison(:>, r);                                      end
+
+  def >= r;     f_comparison(:>=, r);                                     end
+
+  def == r;     f_comparison(:==, r);                                     end
+
+  def ne r;     f_comparison(:'!=', r);                                   end
+
+  def =~ r;     f_match(:'=~', r);                                        end
+
+  def mne r;    f_match(:'!~', r);                                        end
+
+  def paren();  f_build_unary(Model::ParenthesizedExpression, current);   end
+
+  def relop op, r
+    f_build_binary_op(Model::RelationshipExpression, op.to_sym, current, r)
+  end
+
+  def select *args
+    Puppet::Pops::Model::Factory.new(build(Model::SelectorExpression, current, *args))
+  end
+
+  # For CaseExpression, setting the default for an already build CaseExpression
+  def default r
+    current.addOptions(Puppet::Pops::Model::Factory.WHEN(:default, r).current)
+    self
+  end
+
+  def lambda=(lambda)
+    current.lambda = lambda.current
+    self
+  end
+
+  # Assignment =
+  def set(r)
+    f_build_binary_op(Model::AssignmentExpression, :'=', current, r)
+  end
+
+  # Assignment +=
+  def plus_set(r)
+    f_build_binary_op(Model::AssignmentExpression, :'+=', current, r)
+  end
+
+  def attributes(*args)
+    args.each {|a| current.addAttributes(build(a)) }
+    self
+  end
+
+  # Catch all delegation to current
+  def method_missing(meth, *args, &block)
+    if current.respond_to?(meth)
+      current.send(meth, *args, &block)
+    else
+      super
+    end
+  end
+
+  def respond_to?(meth)
+    current.respond_to?(meth) || super
+  end
+
+  # Records the position (start -> end) and computes the resulting length.
+  #
+  def record_position(start_pos, end_pos)
+    Puppet::Pops::Adapters::SourcePosAdapter.adapt(current) do |a|
+      a.line   = start_pos.line
+      a.offset = start_pos.offset
+      a.pos    = start_pos.pos
+      a.length = start_pos.length
+      if(end_pos.offset && end_pos.length)
+        a.length = end_pos.offset + end_pos.length - start_pos.offset
+      end
+    end
+    self
+  end
+
+  # Records the origin file of an element
+  # Does nothing if file is nil.
+  #
+  # @param file [String,nil] the file/path to the origin, may contain URI scheme of file: or some other URI scheme
+  # @returns [Factory] returns self
+  #
+  def record_origin(file)
+    return self unless file
+    Puppet::Pops::Adapters::OriginAdapter.adapt(current) do |a|
+       a.origin = file
+    end
+    self
+  end
+
+  # @return [Puppet::Pops::Adapters::SourcePosAdapter] with location information
+  def loc()
+    Puppet::Pops::Adapters::SourcePosAdapter.adapt(current)
+  end
+
+  # Returns documentation string, or nil if not available
+  # @return [String, nil] associated documentation if available
+  def doc()
+    a = Puppet::Pops::Adapters::SourcePosAdapter.adapt(current)
+    return a.documentation if a
+    nil
+  end
+
+  def doc=(doc_string)
+    a = Puppet::Pops::Adapters::SourcePosAdapter.adapt(current)
+    a.documentation = doc_string
+  end
+
+  # Returns symbolic information about a expected share of a resource expression given the LHS of a resource expr.
+  #
+  # * `name { }` => `:resource`,  create a resource of the given type
+  # * `Name { }` => ':defaults`, set defauls for the referenced type
+  # * `Name[] { }` => `:override`, ioverrides nstances referenced by LHS
+  # * _any other_ => ':error', all other are considered illegal
+  #
+  def self.resource_shape(expr)
+    expr = expr.current if expr.is_a?(Puppet::Pops::Model::Factory)
+    case expr
+    when Model::QualifiedName
+      :resource
+    when Model::QualifiedReference
+      :defaults
+    when Model::AccessExpression
+      :override
+    when 'class'
+      :class
+    else
+      :error
+    end
+  end
+  # Factory starting points
+
+  def self.literal(o);                   new(o);                                                 end
+
+  def self.minus(o);                     new(o).minus;                                           end
+
+  def self.var(o);                       new(o).var;                                             end
+
+  def self.block(*args);                 new(Model::BlockExpression, *args);                     end
+
+  def self.string(*args);                new(Model::ConcatenatedString, *args);                  end
+
+  def self.text(o);                      new(o).text;                                            end
+
+  def self.IF(test_e,then_e,else_e);     new(Model::IfExpression, test_e, then_e, else_e);       end
+
+  def self.UNLESS(test_e,then_e,else_e); new(Model::UnlessExpression, test_e, then_e, else_e);   end
+
+  def self.CASE(test_e,*options);        new(Model::CaseExpression, test_e, *options);           end
+
+  def self.WHEN(values_list, block);     new(Model::CaseOption, values_list, block);             end
+
+  def self.MAP(match, value);            new(Model::SelectorEntry, match, value);                end
+
+  def self.TYPE(name, super_name=nil);   new(Model::CreateTypeExpression, name, super_name);     end
+
+  def self.ATTR(name, type_expr=nil);    new(Model::CreateAttributeExpression, name, type_expr); end
+
+  def self.ENUM(*args);                  new(Model::CreateEnumExpression, *args);                end
+
+  def self.KEY_ENTRY(key, val);          new(Model::KeyedEntry, key, val);                       end
+
+  def self.HASH(entries);                new(Model::LiteralHash, *entries);                      end
+
+  def self.LIST(entries);                new(Model::LiteralList, *entries);                      end
+
+  def self.PARAM(name, expr=nil);        new(Model::Parameter, name, expr);                      end
+
+  def self.NODE(hosts, parent, body);    new(Model::NodeDefinition, hosts, parent, body);        end
+
+  # Creates a QualifiedName representation of o, unless o already represents a QualifiedName in which
+  # case it is returned.
+  #
+  def self.fqn(o)
+    o = o.current if o.is_a?(Puppet::Pops::Model::Factory)
+    o = new(Model::QualifiedName, o) unless o.is_a? Model::QualifiedName
+    o
+  end
+
+  # Creates a QualifiedName representation of o, unless o already represents a QualifiedName in which
+  # case it is returned.
+  #
+  def self.fqr(o)
+    o = o.current if o.is_a?(Puppet::Pops::Model::Factory)
+    o = new(Model::QualifiedReference, o) unless o.is_a? Model::QualifiedReference
+    o
+  end
+
+  def self.TEXT(expr)
+    new(Model::TextExpression, expr)
+  end
+
+  # TODO: This is the same a fqn factory method, don't know if callers to fqn and QNAME can live with the
+  # same result or not yet - refactor into one method when decided.
+  #
+  def self.QNAME(name)
+    new(Model::QualifiedName, name)
+  end
+
+  # Convert input string to either a qualified name, or a LiteralNumber with radix
+  #
+  def self.QNAME_OR_NUMBER(name)
+    if n_radix = Puppet::Pops::Utils.to_n_with_radix(name)
+      new(Model::LiteralNumber, *n_radix)
+    else
+      new(Model::QualifiedName, name)
+    end
+  end
+
+  def self.QREF(name)
+    new(Model::QualifiedReference, name)
+  end
+
+  def self.VIRTUAL_QUERY(query_expr)
+    new(Model::VirtualQuery, query_expr)
+  end
+
+  def self.EXPORTED_QUERY(query_expr)
+    new(Model::ExportedQuery, query_expr)
+  end
+
+  # Used by regular grammar, egrammar creates an AccessExpression instead, and evaluation determines
+  # if access is to instances or something else.
+  #
+  def self.INSTANCE(type_name, name_expressions)
+    new(Model::InstanceReferences, type_name, name_expressions)
+  end
+
+  def self.ATTRIBUTE_OP(name, op, expr)
+    new(Model::AttributeOperation, name, op, expr)
+  end
+
+  def self.CALL_NAMED(name, rval_required, argument_list)
+    unless name.kind_of?(Model::PopsObject)
+      name = Puppet::Pops::Model::Factory.fqn(name) unless name.is_a?(Puppet::Pops::Model::Factory)
+    end
+    new(Model::CallNamedFunctionExpression, name, rval_required, *argument_list)
+  end
+
+  def self.CALL_METHOD(functor, argument_list)
+    new(Model::CallMethodExpression, functor, true, nil, *argument_list)
+  end
+
+  def self.COLLECT(type_expr, query_expr, attribute_operations)
+    new(Model::CollectExpression, Puppet::Pops::Model::Factory.fqr(type_expr), query_expr, attribute_operations)
+  end
+
+  def self.IMPORT(files)
+    new(Model::ImportExpression, files)
+  end
+
+  def self.NAMED_ACCESS(type_name, bodies)
+    new(Model::NamedAccessExpression, type_name, bodies)
+  end
+
+  def self.RESOURCE(type_name, bodies)
+    new(Model::ResourceExpression, type_name, bodies)
+  end
+
+  def self.RESOURCE_DEFAULTS(type_name, attribute_operations)
+    new(Model::ResourceDefaultsExpression, type_name, attribute_operations)
+  end
+
+  def self.RESOURCE_OVERRIDE(resource_ref, attribute_operations)
+    new(Model::ResourceOverrideExpression, resource_ref, attribute_operations)
+  end
+
+  def self.RESOURCE_BODY(resource_title, attribute_operations)
+    new(Model::ResourceBody, resource_title, attribute_operations)
+  end
+
+  # Builds a BlockExpression if args size > 1, else the single expression/value in args
+  def self.block_or_expression(*args)
+    if args.size > 1
+      new(Model::BlockExpression, *args)
+    else
+      new(args[0])
+    end
+  end
+
+  def self.HOSTCLASS(name, parameters, parent, body)
+    new(Model::HostClassDefinition, name, parameters, parent, body)
+  end
+
+  def self.DEFINITION(name, parameters, body)
+    new(Model::ResourceTypeDefinition, name, parameters, body)
+  end
+
+  def self.LAMBDA(parameters, body)
+    new(Model::LambdaExpression, parameters, body)
+  end
+
+  def self.nop? o
+    o.nil? || o.is_a?(Puppet::Pops::Model::Nop)
+  end
+
+  # Transforms an array of expressions containing literal name expressions to calls if followed by an
+  # expression, or expression list. Also transforms a "call" to `import` into an ImportExpression.
+  #
+  def self.transform_calls(expressions)
+    expressions.reduce([]) do |memo, expr|
+      expr = expr.current if expr.is_a?(Puppet::Pops::Model::Factory)
+      name = memo[-1]
+      if name.is_a? Model::QualifiedName
+        if name.value() == 'import'
+          memo[-1] = Puppet::Pops::Model::Factory.IMPORT(expr.is_a?(Array) ? expr : [expr])
+        else
+          memo[-1] = Puppet::Pops::Model::Factory.CALL_NAMED(name, false, expr.is_a?(Array) ? expr : [expr])
+        end
+      else
+        memo << expr
+      end
+      if expr.is_a?(Model::CallNamedFunctionExpression)
+        # patch expression function call to statement style
+        # TODO: This is kind of meaningless, but to make it compatible...
+        expr.rval_required = false
+      end
+      memo
+    end
+
+  end
+
+  # Building model equivalences of Ruby objects
+  # Allows passing regular ruby objects to the factory to produce instructions
+  # that when evaluated produce the same thing.
+
+  def build_String(o)
+    x = Model::LiteralString.new
+    x.value = o;
+    x
+  end
+
+  def build_NilClass(o)
+    x = Model::Nop.new
+    x
+  end
+
+  def build_TrueClass(o)
+    x = Model::LiteralBoolean.new
+    x.value = o
+    x
+  end
+
+  def build_FalseClass(o)
+    x = Model::LiteralBoolean.new
+    x.value = o
+    x
+  end
+
+  def build_Fixnum(o)
+    x = Model::LiteralNumber.new
+    x.value = o;
+    x
+  end
+
+  def build_Float(o)
+    x = Model::LiteralNumber.new
+    x.value = o;
+    x
+  end
+
+  def build_Regexp(o)
+    x = Model::LiteralRegularExpression.new
+    x.value = o;
+    x
+  end
+
+  # If building a factory, simply unwrap the model oject contained in the factory.
+  def build_Factory(o)
+    o.current
+  end
+
+  # Creates a String literal, unless the symbol is one of the special :undef, or :default
+  # which instead creates a LiterlUndef, or a LiteralDefault.
+  def build_Symbol(o)
+    case o
+    when :undef
+      Model::LiteralUndef.new
+    when :default
+      Model::LiteralDefault.new
+    else
+      build_String(o.to_s)
+    end
+  end
+
+  # Creates a LiteralList instruction from an Array, where the entries are built.
+  def build_Array(o)
+    x = Model::LiteralList.new
+    o.each { |v| x.addValues(build(v)) }
+    x
+  end
+
+  # Create a LiteralHash instruction from a hash, where keys and values are built
+  # The hash entries are added in sorted order based on key.to_s
+  #
+  def build_Hash(o)
+    x = Model::LiteralHash.new
+    (o.sort_by {|k,v| k.to_s}).each {|k,v| x.addEntries(build(Model::KeyedEntry.new, k, v)) }
+    x
+  end
+
+  # @param rval_required [Boolean] if the call must produce a value
+  def build_CallExpression(o, functor, rval_required, *args)
+    o.functor_expr = to_ops(functor)
+    o.rval_required = rval_required
+    args.each {|x| o.addArguments(to_ops(x)) }
+    o
+  end
+
+  #  # @param rval_required [Boolean] if the call must produce a value
+  #  def build_CallNamedFunctionExpression(o, name, rval_required, *args)
+  #    build_CallExpression(o, name, rval_required, *args)
+  ##    o.functor_expr = build(name)
+  ##    o.rval_required = rval_required
+  ##    args.each {|x| o.addArguments(build(x)) }
+  #    o
+  #  end
+
+  def build_CallMethodExpression(o, functor, rval_required, lambda, *args)
+    build_CallExpression(o, functor, rval_required, *args)
+    o.lambda = lambda
+    o
+  end
+
+  def build_CaseExpression(o, test, *args)
+    o.test = build(test)
+    args.each {|opt| o.addOptions(build(opt)) }
+    o
+  end
+
+  def build_CaseOption(o, value_list, then_expr)
+    value_list = [value_list] unless value_list.is_a? Array
+    value_list.each { |v| o.addValues(build(v)) }
+    b = f_build_body(then_expr)
+    o.then_expr = to_ops(b) if b
+    o
+  end
+
+  # Build a Class by creating an instance of it, and then calling build on the created instance
+  # with the given arguments
+  def build_Class(o, *args)
+    build(o.new(), *args)
+  end
+
+  # Checks if the object is already a model object, or build it
+  def to_ops(o, *args)
+    if o.kind_of?(Model::PopsObject)
+      o
+    else
+      build(o, *args)
+    end
+  end
+end