text: #     Copyright 2020, Kay Hayen, mailto:kay.hayen@gmail.com
  #
  #     Part of "Nuitka", an optimizing Python compiler that is compatible and
  #     integrates with CPython, but also works on its own.
  #
  #     Licensed under the Apache License, Version 2.0 (the "License");
  #     you may not use this file except in compliance with the License.
  #     You may obtain a copy of the License at
  #
  #        http://www.apache.org/licenses/LICENSE-2.0
  #
  #     Unless required by applicable law or agreed to in writing, software
  #     distributed under the License is distributed on an "AS IS" BASIS,
  #     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  #     See the License for the specific language governing permissions and
  #     limitations under the License.
  #
  """ Code generation for calls.
  
  The different kinds of calls get dedicated code. Most notable, calls with
  only positional arguments, are attempted through helpers that might be
  able to execute them without creating the argument dictionary at all.
  
  """
  
  from .CodeHelpers import (
      generateChildExpressionCode,
      generateExpressionCode,
      withObjectCodeTemporaryAssignment,
  )
  from .ConstantCodes import getConstantAccess
  from .ErrorCodes import getErrorExitCode
  from .LineNumberCodes import emitLineNumberUpdateCode
  from .templates.CodeTemplatesCalls import (
      template_call_function_with_args_decl,
      template_call_function_with_args_impl,
      template_call_method_with_args_decl,
      template_call_method_with_args_impl,
  )
  from .templates.CodeTemplatesModules import (
      template_header_guard,
      template_helper_impl_decl,
  )
  
  
  def _generateCallCodePosOnly(
      to_name, expression, called_name, called_attribute_name, emit, context
  ):
      # We have many variants for this to deal with, pylint: disable=too-many-branches
  
      assert called_name is not None
      # TODO: Not yet specialized for method calls.
      # assert called_attribute_name is None
  
      call_args = expression.getCallArgs()
  
      if call_args is None or call_args.isExpressionConstantRef():
          context.setCurrentSourceCodeReference(expression.getCompatibleSourceReference())
  
          if call_args is not None:
              call_args_value = call_args.getConstant()
          else:
              call_args_value = ()
  
          assert type(call_args_value) is tuple
  
          if call_args is not None and call_args.isMutable():
              call_arg_names = []
  
              for call_arg_element in call_args_value:
                  call_arg_name = context.allocateTempName("call_arg_element")
  
                  getConstantAccess(
                      to_name=call_arg_name,
                      constant=call_arg_element,
                      emit=emit,
                      context=context,
                  )
  
                  call_arg_names.append(call_arg_name)
  
              if called_attribute_name is None:
                  getCallCodePosArgsQuick(
                      to_name=to_name,
                      called_name=called_name,
                      arg_names=call_arg_names,
                      needs_check=expression.mayRaiseException(BaseException),
                      emit=emit,
                      context=context,
                  )
              else:
                  _getInstanceCallCodePosArgsQuick(
                      to_name=to_name,
                      called_name=called_name,
                      called_attribute_name=called_attribute_name,
                      arg_names=call_arg_names,
                      needs_check=expression.mayRaiseException(BaseException),
                      emit=emit,
                      context=context,
                  )
          elif call_args_value:
              if called_attribute_name is None:
                  _getCallCodeFromTuple(
                      to_name=to_name,
                      called_name=called_name,
                      args_value=call_args_value,
                      needs_check=expression.mayRaiseException(BaseException),
                      emit=emit,
                      context=context,
                  )
              else:
                  _getInstanceCallCodeFromTuple(
                      to_name=to_name,
                      called_name=called_name,
                      called_attribute_name=called_attribute_name,
                      arg_tuple=context.getConstantCode(constant=call_args_value),
                      arg_size=len(call_args_value),
                      needs_check=expression.mayRaiseException(BaseException),
                      emit=emit,
                      context=context,
                  )
          else:
              if called_attribute_name is None:
                  getCallCodeNoArgs(
                      to_name=to_name,
                      called_name=called_name,
                      needs_check=expression.mayRaiseException(BaseException),
                      emit=emit,
                      context=context,
                  )
              else:
                  _getInstanceCallCodeNoArgs(
                      to_name=to_name,
                      called_name=called_name,
                      called_attribute_name=called_attribute_name,
                      needs_check=expression.mayRaiseException(BaseException),
                      emit=emit,
                      context=context,
                  )
      elif call_args.isExpressionMakeTuple():
          call_arg_names = []
  
          for call_arg_element in call_args.getElements():
              call_arg_name = generateChildExpressionCode(
                  child_name=call_args.getChildName() + "_element",
                  expression=call_arg_element,
                  emit=emit,
                  context=context,
              )
  
              call_arg_names.append(call_arg_name)
  
          context.setCurrentSourceCodeReference(expression.getCompatibleSourceReference())
  
          if called_attribute_name is None:
              getCallCodePosArgsQuick(
                  to_name=to_name,
                  called_name=called_name,
                  arg_names=call_arg_names,
                  needs_check=expression.mayRaiseException(BaseException),
                  emit=emit,
                  context=context,
              )
          else:
              _getInstanceCallCodePosArgsQuick(
                  to_name=to_name,
                  called_name=called_name,
                  called_attribute_name=called_attribute_name,
                  arg_names=call_arg_names,
                  needs_check=expression.mayRaiseException(BaseException),
                  emit=emit,
                  context=context,
              )
      else:
          args_name = generateChildExpressionCode(
              expression=call_args, emit=emit, context=context
          )
  
          context.setCurrentSourceCodeReference(expression.getCompatibleSourceReference())
  
          if called_attribute_name is None:
              _getCallCodePosArgs(
                  to_name=to_name,
                  called_name=called_name,
                  args_name=args_name,
                  needs_check=expression.mayRaiseException(BaseException),
                  emit=emit,
                  context=context,
              )
          else:
              _getInstanceCallCodePosArgs(
                  to_name=to_name,
                  called_name=called_name,
                  called_attribute_name=called_attribute_name,
                  args_name=args_name,
                  needs_check=expression.mayRaiseException(BaseException),
                  emit=emit,
                  context=context,
              )
  
  
  def _generateCallCodeKwOnly(
      to_name, expression, call_kw, called_name, called_attribute_name, emit, context
  ):
      # TODO: Not yet specialized for method calls.
      assert called_name is not None
      assert called_attribute_name is None
  
      call_kw_name = generateChildExpressionCode(
          expression=call_kw, emit=emit, context=context
      )
  
      context.setCurrentSourceCodeReference(expression.getCompatibleSourceReference())
  
      _getCallCodeKeywordArgs(
          to_name=to_name,
          called_name=called_name,
          call_kw_name=call_kw_name,
          emit=emit,
          context=context,
      )
  
  
  def generateCallCode(to_name, expression, emit, context):
      # There is a whole lot of different cases, for each of which, we create
      # optimized code, constant, with and without positional or keyword arguments
      # each, so there is lots of branches involved.
  
      called = expression.getCalled()
      call_kw = expression.getCallKw()
      call_args = expression.getCallArgs()
  
      # TODO: Make this work for all cases. Currently, the method calls that do
      # a combined lookup and call, do a re-ordering of things, and therefore it
      # must be disabled until this is solved.
      if (
          called.isExpressionAttributeLookup()
          and not called.isExpressionAttributeLookupSpecial()
          and called.getAttributeName() not in ("__class__", "__dict__")
          and (
              call_args is None
              or not call_args.mayHaveSideEffects()
              or not called.mayHaveSideEffects()
          )
          and call_kw is None
      ):
          called_name = context.allocateTempName("called_instance")
          generateExpressionCode(
              to_name=called_name,
              expression=called.subnode_expression,
              emit=emit,
              context=context,
          )
  
          called_attribute_name = context.getConstantCode(
              constant=called.getAttributeName()
          )
      else:
          called_attribute_name = None
  
          called_name = generateChildExpressionCode(
              expression=called, emit=emit, context=context
          )
  
      with withObjectCodeTemporaryAssignment(
          to_name, "call_result", expression, emit, context
      ) as result_name:
  
          if call_kw is None or (
              call_kw.isExpressionConstantRef() and call_kw.getConstant() == {}
          ):
              _generateCallCodePosOnly(
                  to_name=result_name,
                  called_name=called_name,
                  called_attribute_name=called_attribute_name,
                  expression=expression,
                  emit=emit,
                  context=context,
              )
          else:
              call_args = expression.getCallArgs()
  
              if call_args is None or (
                  call_args.isExpressionConstantRef() and call_args.getConstant() == ()
              ):
                  _generateCallCodeKwOnly(
                      to_name=result_name,
                      called_name=called_name,
                      called_attribute_name=called_attribute_name,
                      expression=expression,
                      call_kw=call_kw,
                      emit=emit,
                      context=context,
                  )
              else:
                  call_args_name = generateChildExpressionCode(
                      expression=call_args, emit=emit, context=context
                  )
  
                  call_kw_name = generateChildExpressionCode(
                      expression=call_kw, emit=emit, context=context
                  )
  
                  context.setCurrentSourceCodeReference(
                      expression.getCompatibleSourceReference()
                  )
  
                  _getCallCodePosKeywordArgs(
                      to_name=result_name,
                      called_name=called_name,
                      call_args_name=call_args_name,
                      call_kw_name=call_kw_name,
                      emit=emit,
                      context=context,
                  )
  
  
  def getCallCodeNoArgs(to_name, called_name, needs_check, emit, context):
      emitLineNumberUpdateCode(emit, context)
  
      emit("%s = CALL_FUNCTION_NO_ARGS(%s);" % (to_name, called_name))
  
      getErrorExitCode(
          check_name=to_name,
          release_name=called_name,
          emit=emit,
          needs_check=needs_check,
          context=context,
      )
  
      context.addCleanupTempName(to_name)
  
  
  def _getInstanceCallCodeNoArgs(
      to_name, called_name, called_attribute_name, needs_check, emit, context
  ):
      emitLineNumberUpdateCode(emit, context)
  
      emit(
          "%s = CALL_METHOD_NO_ARGS(%s, %s);"
          % (to_name, called_name, called_attribute_name)
      )
  
      getErrorExitCode(
          check_name=to_name,
          release_names=(called_name, called_attribute_name),
          emit=emit,
          needs_check=needs_check,
          context=context,
      )
  
      context.addCleanupTempName(to_name)
  
  
  # Outside helper code relies on some quick call to be present.
  quick_calls_used = set([2, 3, 4, 5])
  quick_instance_calls_used = set()
  
  
  def _getInstanceCallCodePosArgsQuick(
      to_name, called_name, called_attribute_name, arg_names, needs_check, emit, context
  ):
      arg_size = len(arg_names)
  
      # For 0 arguments, NOARGS is supposed to be used.
      assert arg_size > 0
  
      emitLineNumberUpdateCode(emit, context)
  
      # For one argument, we have a dedicated helper function that might
      # be more efficient.
      if arg_size == 1:
          emit(
              """%s = CALL_METHOD_WITH_SINGLE_ARG(%s, %s, %s);"""
              % (to_name, called_name, called_attribute_name, arg_names[0])
          )
      else:
          quick_instance_calls_used.add(arg_size)
  
          emit(
              """\
  {
      PyObject *call_args[] = {%s};
      %s = CALL_METHOD_WITH_ARGS%d(%s, %s, call_args);
  }
  """
              % (
                  ", ".join(str(arg_name) for arg_name in arg_names),
                  to_name,
                  arg_size,
                  called_name,
                  called_attribute_name,
              )
          )
  
      getErrorExitCode(
          check_name=to_name,
          release_names=[called_name] + arg_names,
          needs_check=needs_check,
          emit=emit,
          context=context,
      )
  
      context.addCleanupTempName(to_name)
  
  
  def getCallCodePosArgsQuick(
      to_name, called_name, arg_names, needs_check, emit, context
  ):
  
      arg_size = len(arg_names)
  
      # For 0 arguments, NOARGS is supposed to be used.
      assert arg_size > 0
  
      emitLineNumberUpdateCode(emit, context)
  
      # For one argument, we have a dedicated helper function that might
      # be more efficient.
      if arg_size == 1:
          emit(
              """%s = CALL_FUNCTION_WITH_SINGLE_ARG(%s, %s);"""
              % (to_name, called_name, arg_names[0])
          )
      else:
          quick_calls_used.add(arg_size)
  
          emit(
              """\
  {
      PyObject *call_args[] = {%s};
      %s = CALL_FUNCTION_WITH_ARGS%d(%s, call_args);
  }
  """
              % (
                  ", ".join(str(arg_name) for arg_name in arg_names),
                  to_name,
                  arg_size,
                  called_name,
              )
          )
  
      getErrorExitCode(
          check_name=to_name,
          release_names=[called_name] + arg_names,
          needs_check=needs_check,
          emit=emit,
          context=context,
      )
  
      context.addCleanupTempName(to_name)
  
  
  def _getInstanceCallCodeFromTuple(
      to_name,
      called_name,
      called_attribute_name,
      arg_tuple,
      arg_size,
      needs_check,
      emit,
      context,
  ):
      quick_instance_calls_used.add(arg_size)
  
      # For 0 arguments, NOARGS is supposed to be used.
      assert arg_size > 0
  
      emitLineNumberUpdateCode(emit, context)
  
      emit(
          """\
  %s = CALL_METHOD_WITH_ARGS%d(%s, %s, &PyTuple_GET_ITEM(%s, 0));
  """
          % (to_name, arg_size, called_name, called_attribute_name, arg_tuple)
      )
  
      getErrorExitCode(
          check_name=to_name,
          release_names=(called_name, called_attribute_name),
          needs_check=needs_check,
          emit=emit,
          context=context,
      )
  
      context.addCleanupTempName(to_name)
  
  
  def _getCallCodeFromTuple(to_name, called_name, args_value, needs_check, emit, context):
      arg_size = len(args_value)
  
      # For 0 arguments, NOARGS is supposed to be used.
      assert arg_size > 0
  
      emitLineNumberUpdateCode(emit, context)
  
      if arg_size == 1:
          arg_name = context.getConstantCode(args_value[0])
  
          emit(
              """%s = CALL_FUNCTION_WITH_SINGLE_ARG(%s, %s);"""
              % (to_name, called_name, arg_name)
          )
      else:
          # TODO: Having to use a full tuple is wasteful, a PyObject ** would do.
          arg_tuple_name = context.getConstantCode(constant=args_value)
  
          quick_calls_used.add(arg_size)
  
          emit(
              """\
  %s = CALL_FUNCTION_WITH_ARGS%d(%s, &PyTuple_GET_ITEM(%s, 0));
  """
              % (to_name, arg_size, called_name, arg_tuple_name)
          )
  
      getErrorExitCode(
          check_name=to_name,
          release_name=called_name,
          needs_check=needs_check,
          emit=emit,
          context=context,
      )
  
      context.addCleanupTempName(to_name)
  
  
  def _getInstanceCallCodePosArgs(
      to_name, called_name, called_attribute_name, args_name, needs_check, emit, context
  ):
      emitLineNumberUpdateCode(emit, context)
  
      emit(
          "%s = CALL_METHOD_WITH_POSARGS(%s, %s, %s);"
          % (to_name, called_name, called_attribute_name, args_name)
      )
  
      getErrorExitCode(
          check_name=to_name,
          release_names=(called_name, args_name),
          needs_check=needs_check,
          emit=emit,
          context=context,
      )
  
      context.addCleanupTempName(to_name)
  
  
  def _getCallCodePosArgs(to_name, called_name, args_name, needs_check, emit, context):
      emitLineNumberUpdateCode(emit, context)
  
      emit("%s = CALL_FUNCTION_WITH_POSARGS(%s, %s);" % (to_name, called_name, args_name))
  
      getErrorExitCode(
          check_name=to_name,
          release_names=(called_name, args_name),
          needs_check=needs_check,
          emit=emit,
          context=context,
      )
  
      context.addCleanupTempName(to_name)
  
  
  def _getCallCodeKeywordArgs(to_name, called_name, call_kw_name, emit, context):
      emitLineNumberUpdateCode(emit, context)
  
      emit(
          "%s = CALL_FUNCTION_WITH_KEYARGS(%s, %s);"
          % (to_name, called_name, call_kw_name)
      )
  
      getErrorExitCode(
          check_name=to_name,
          release_names=(called_name, call_kw_name),
          emit=emit,
          context=context,
      )
  
      context.addCleanupTempName(to_name)
  
  
  def _getCallCodePosKeywordArgs(
      to_name, called_name, call_args_name, call_kw_name, emit, context
  ):
      emitLineNumberUpdateCode(emit, context)
  
      emit(
          "%s = CALL_FUNCTION(%s, %s, %s);"
          % (to_name, called_name, call_args_name, call_kw_name)
      )
  
      getErrorExitCode(
          check_name=to_name,
          release_names=(called_name, call_args_name, call_kw_name),
          emit=emit,
          context=context,
      )
  
      context.addCleanupTempName(to_name)
  
  
  def getCallsDecls():
      result = []
  
      for quick_call_used in sorted(quick_calls_used.union(quick_instance_calls_used)):
          result.append(
              template_call_function_with_args_decl % {"args_count": quick_call_used}
          )
  
      for quick_call_used in sorted(quick_instance_calls_used):
          result.append(
              template_call_method_with_args_decl % {"args_count": quick_call_used}
          )
  
      return template_header_guard % {
          "header_guard_name": "__NUITKA_CALLS_H__",
          "header_body": "\n".join(result),
      }
  
  
  def getCallsCode():
      result = []
  
      result.append(template_helper_impl_decl % {})
  
      for quick_call_used in sorted(quick_calls_used.union(quick_instance_calls_used)):
          result.append(
              template_call_function_with_args_impl % {"args_count": quick_call_used}
          )
  
      for quick_call_used in sorted(quick_instance_calls_used):
          result.append(
              template_call_method_with_args_impl % {"args_count": quick_call_used}
          )
  
      return "\n".join(result)
  