blockly/generators/python/procedures.js

/**
 * @license
 * Copyright 2012 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

/**
 * @fileoverview Generating Python for procedure blocks.
 */

import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.Python.procedures');

import * as Variables from '../../core/variables.js';
import {NameType} from '../../core/names.js';
import {pythonGenerator, Order} from '../python.js';


pythonGenerator.forBlock['procedures_defreturn'] = function(block) {
  // Define a procedure with a return value.
  // First, add a 'global' statement for every variable that is not shadowed by
  // a local parameter.
  const globals = [];
  const workspace = block.workspace;
  const usedVariables = Variables.allUsedVarModels(workspace) || [];
  for (let i = 0, variable; (variable = usedVariables[i]); i++) {
    const varName = variable.name;
    if (block.getVars().indexOf(varName) === -1) {
      globals.push(pythonGenerator.nameDB_.getName(varName, NameType.VARIABLE));
    }
  }
  // Add developer variables.
  const devVarList = Variables.allDeveloperVariables(workspace);
  for (let i = 0; i < devVarList.length; i++) {
    globals.push(
        pythonGenerator.nameDB_.getName(
          devVarList[i], NameType.DEVELOPER_VARIABLE));
  }

  const globalString = globals.length ?
      pythonGenerator.INDENT + 'global ' + globals.join(', ') + '\n' :
      '';
  const funcName =
      pythonGenerator.nameDB_.getName(
        block.getFieldValue('NAME'), NameType.PROCEDURE);
  let xfix1 = '';
  if (pythonGenerator.STATEMENT_PREFIX) {
    xfix1 += pythonGenerator.injectId(pythonGenerator.STATEMENT_PREFIX, block);
  }
  if (pythonGenerator.STATEMENT_SUFFIX) {
    xfix1 += pythonGenerator.injectId(pythonGenerator.STATEMENT_SUFFIX, block);
  }
  if (xfix1) {
    xfix1 = pythonGenerator.prefixLines(xfix1, pythonGenerator.INDENT);
  }
  let loopTrap = '';
  if (pythonGenerator.INFINITE_LOOP_TRAP) {
    loopTrap = pythonGenerator.prefixLines(
        pythonGenerator.injectId(pythonGenerator.INFINITE_LOOP_TRAP, block),
        pythonGenerator.INDENT);
  }
  let branch = pythonGenerator.statementToCode(block, 'STACK');
  let returnValue =
      pythonGenerator.valueToCode(block, 'RETURN', Order.NONE) || '';
  let xfix2 = '';
  if (branch && returnValue) {
    // After executing the function body, revisit this block for the return.
    xfix2 = xfix1;
  }
  if (returnValue) {
    returnValue = pythonGenerator.INDENT + 'return ' + returnValue + '\n';
  } else if (!branch) {
    branch = pythonGenerator.PASS;
  }
  const args = [];
  const variables = block.getVars();
  for (let i = 0; i < variables.length; i++) {
    args[i] = pythonGenerator.nameDB_.getName(variables[i], NameType.VARIABLE);
  }
  let code = 'def ' + funcName + '(' + args.join(', ') + '):\n' + globalString +
      xfix1 + loopTrap + branch + xfix2 + returnValue;
  code = pythonGenerator.scrub_(block, code);
  // Add % so as not to collide with helper functions in definitions list.
  pythonGenerator.definitions_['%' + funcName] = code;
  return null;
};

// Defining a procedure without a return value uses the same generator as
// a procedure with a return value.
pythonGenerator.forBlock['procedures_defnoreturn'] =
    pythonGenerator.forBlock['procedures_defreturn'];

pythonGenerator.forBlock['procedures_callreturn'] = function(block) {
  // Call a procedure with a return value.
  const funcName =
      pythonGenerator.nameDB_.getName(
        block.getFieldValue('NAME'), NameType.PROCEDURE);
  const args = [];
  const variables = block.getVars();
  for (let i = 0; i < variables.length; i++) {
    args[i] =
        pythonGenerator.valueToCode(block, 'ARG' + i, Order.NONE) || 'None';
  }
  const code = funcName + '(' + args.join(', ') + ')';
  return [code, Order.FUNCTION_CALL];
};

pythonGenerator.forBlock['procedures_callnoreturn'] = function(block) {
  // Call a procedure with no return value.
  // Generated code is for a function call as a statement is the same as a
  // function call as a value, with the addition of line ending.
  const tuple = pythonGenerator.forBlock['procedures_callreturn'](block);
  return tuple[0] + '\n';
};

pythonGenerator.forBlock['procedures_ifreturn'] = function(block) {
  // Conditionally return value from a procedure.
  const condition =
      pythonGenerator.valueToCode(block, 'CONDITION', Order.NONE) || 'False';
  let code = 'if ' + condition + ':\n';
  if (pythonGenerator.STATEMENT_SUFFIX) {
    // Inject any statement suffix here since the regular one at the end
    // will not get executed if the return is triggered.
    code += pythonGenerator.prefixLines(
        pythonGenerator.injectId(
          pythonGenerator.STATEMENT_SUFFIX, block), pythonGenerator.INDENT);
  }
  if (block.hasReturnValue_) {
    const value =
        pythonGenerator.valueToCode(block, 'VALUE', Order.NONE) || 'None';
    code += pythonGenerator.INDENT + 'return ' + value + '\n';
  } else {
    code += pythonGenerator.INDENT + 'return\n';
  }
  return code;
};