/** * @license * Copyright 2012 Google LLC * SPDX-License-Identifier: Apache-2.0 */ /** * @fileoverview Generating Python for text blocks. */ import * as goog from '../../closure/goog/goog.js'; goog.declareModuleId('Blockly.Python.texts'); import * as stringUtils from '../../core/utils/string.js'; import {NameType} from '../../core/names.js'; import {pythonGenerator, Order} from '../python.js'; pythonGenerator.forBlock['text'] = function(block, generator) { // Text value. const code = generator.quote_(block.getFieldValue('TEXT')); return [code, Order.ATOMIC]; }; pythonGenerator.forBlock['text_multiline'] = function(block, generator) { // Text value. const code = generator.multiline_quote_(block.getFieldValue('TEXT')); const order = code.indexOf('+') !== -1 ? Order.ADDITIVE : Order.ATOMIC; return [code, order]; }; /** * Regular expression to detect a single-quoted string literal. */ const strRegExp = /^\s*'([^']|\\')*'\s*$/; /** * Enclose the provided value in 'str(...)' function. * Leave string literals alone. * @param {string} value Code evaluating to a value. * @return {Array} Array containing code evaluating to a string * and * the order of the returned code.[string, number] */ const forceString = function(value) { if (strRegExp.test(value)) { return [value, Order.ATOMIC]; } return ['str(' + value + ')', Order.FUNCTION_CALL]; }; pythonGenerator.forBlock['text_join'] = function(block, generator) { // Create a string made up of any number of elements of any type. // Should we allow joining by '-' or ',' or any other characters? switch (block.itemCount_) { case 0: return ["''", Order.ATOMIC]; case 1: { const element = generator.valueToCode(block, 'ADD0', Order.NONE) || "''"; const codeAndOrder = forceString(element); return codeAndOrder; } case 2: { const element0 = generator.valueToCode(block, 'ADD0', Order.NONE) || "''"; const element1 = generator.valueToCode(block, 'ADD1', Order.NONE) || "''"; const code = forceString(element0)[0] + ' + ' + forceString(element1)[0]; return [code, Order.ADDITIVE]; } default: { const elements = []; for (let i = 0; i < block.itemCount_; i++) { elements[i] = generator.valueToCode(block, 'ADD' + i, Order.NONE) || "''"; } const tempVar = generator.nameDB_.getDistinctName('x', NameType.VARIABLE); const code = '\'\'.join([str(' + tempVar + ') for ' + tempVar + ' in [' + elements.join(', ') + ']])'; return [code, Order.FUNCTION_CALL]; } } }; pythonGenerator.forBlock['text_append'] = function(block, generator) { // Append to a variable in place. const varName = generator.nameDB_.getName( block.getFieldValue('VAR'), NameType.VARIABLE); const value = generator.valueToCode(block, 'TEXT', Order.NONE) || "''"; return varName + ' = str(' + varName + ') + ' + forceString(value)[0] + '\n'; }; pythonGenerator.forBlock['text_length'] = function(block, generator) { // Is the string null or array empty? const text = generator.valueToCode(block, 'VALUE', Order.NONE) || "''"; return ['len(' + text + ')', Order.FUNCTION_CALL]; }; pythonGenerator.forBlock['text_isEmpty'] = function(block, generator) { // Is the string null or array empty? const text = generator.valueToCode(block, 'VALUE', Order.NONE) || "''"; const code = 'not len(' + text + ')'; return [code, Order.LOGICAL_NOT]; }; pythonGenerator.forBlock['text_indexOf'] = function(block, generator) { // Search the text for a substring. // Should we allow for non-case sensitive??? const operator = block.getFieldValue('END') === 'FIRST' ? 'find' : 'rfind'; const substring = generator.valueToCode(block, 'FIND', Order.NONE) || "''"; const text = generator.valueToCode(block, 'VALUE', Order.MEMBER) || "''"; const code = text + '.' + operator + '(' + substring + ')'; if (block.workspace.options.oneBasedIndex) { return [code + ' + 1', Order.ADDITIVE]; } return [code, Order.FUNCTION_CALL]; }; pythonGenerator.forBlock['text_charAt'] = function(block, generator) { // Get letter at index. // Note: Until January 2013 this block did not have the WHERE input. const where = block.getFieldValue('WHERE') || 'FROM_START'; const textOrder = (where === 'RANDOM') ? Order.NONE : Order.MEMBER; const text = generator.valueToCode(block, 'VALUE', textOrder) || "''"; switch (where) { case 'FIRST': { const code = text + '[0]'; return [code, Order.MEMBER]; } case 'LAST': { const code = text + '[-1]'; return [code, Order.MEMBER]; } case 'FROM_START': { const at = generator.getAdjustedInt(block, 'AT'); const code = text + '[' + at + ']'; return [code, Order.MEMBER]; } case 'FROM_END': { const at = generator.getAdjustedInt(block, 'AT', 1, true); const code = text + '[' + at + ']'; return [code, Order.MEMBER]; } case 'RANDOM': { generator.definitions_['import_random'] = 'import random'; const functionName = generator.provideFunction_('text_random_letter', ` def ${generator.FUNCTION_NAME_PLACEHOLDER_}(text): x = int(random.random() * len(text)) return text[x] `); const code = functionName + '(' + text + ')'; return [code, Order.FUNCTION_CALL]; } } throw Error('Unhandled option (text_charAt).'); }; pythonGenerator.forBlock['text_getSubstring'] = function(block, generator) { // Get substring. const where1 = block.getFieldValue('WHERE1'); const where2 = block.getFieldValue('WHERE2'); const text = generator.valueToCode(block, 'STRING', Order.MEMBER) || "''"; let at1; switch (where1) { case 'FROM_START': at1 = generator.getAdjustedInt(block, 'AT1'); if (at1 === 0) { at1 = ''; } break; case 'FROM_END': at1 = generator.getAdjustedInt(block, 'AT1', 1, true); break; case 'FIRST': at1 = ''; break; default: throw Error('Unhandled option (text_getSubstring)'); } let at2; switch (where2) { case 'FROM_START': at2 = generator.getAdjustedInt(block, 'AT2', 1); break; case 'FROM_END': at2 = generator.getAdjustedInt(block, 'AT2', 0, true); // Ensure that if the result calculated is 0 that sub-sequence will // include all elements as expected. if (!stringUtils.isNumber(String(at2))) { generator.definitions_['import_sys'] = 'import sys'; at2 += ' or sys.maxsize'; } else if (at2 === 0) { at2 = ''; } break; case 'LAST': at2 = ''; break; default: throw Error('Unhandled option (text_getSubstring)'); } const code = text + '[' + at1 + ' : ' + at2 + ']'; return [code, Order.MEMBER]; }; pythonGenerator.forBlock['text_changeCase'] = function(block, generator) { // Change capitalization. const OPERATORS = { 'UPPERCASE': '.upper()', 'LOWERCASE': '.lower()', 'TITLECASE': '.title()' }; const operator = OPERATORS[block.getFieldValue('CASE')]; const text = generator.valueToCode(block, 'TEXT', Order.MEMBER) || "''"; const code = text + operator; return [code, Order.FUNCTION_CALL]; }; pythonGenerator.forBlock['text_trim'] = function(block, generator) { // Trim spaces. const OPERATORS = { 'LEFT': '.lstrip()', 'RIGHT': '.rstrip()', 'BOTH': '.strip()' }; const operator = OPERATORS[block.getFieldValue('MODE')]; const text = generator.valueToCode(block, 'TEXT', Order.MEMBER) || "''"; const code = text + operator; return [code, Order.FUNCTION_CALL]; }; pythonGenerator.forBlock['text_print'] = function(block, generator) { // Print statement. const msg = generator.valueToCode(block, 'TEXT', Order.NONE) || "''"; return 'print(' + msg + ')\n'; }; pythonGenerator.forBlock['text_prompt_ext'] = function(block, generator) { // Prompt function. const functionName = generator.provideFunction_('text_prompt', ` def ${generator.FUNCTION_NAME_PLACEHOLDER_}(msg): try: return raw_input(msg) except NameError: return input(msg) `); let msg; if (block.getField('TEXT')) { // Internal message. msg = generator.quote_(block.getFieldValue('TEXT')); } else { // External message. msg = generator.valueToCode(block, 'TEXT', Order.NONE) || "''"; } let code = functionName + '(' + msg + ')'; const toNumber = block.getFieldValue('TYPE') === 'NUMBER'; if (toNumber) { code = 'float(' + code + ')'; } return [code, Order.FUNCTION_CALL]; }; pythonGenerator.forBlock['text_prompt'] = pythonGenerator.forBlock['text_prompt_ext']; pythonGenerator.forBlock['text_count'] = function(block, generator) { const text = generator.valueToCode(block, 'TEXT', Order.MEMBER) || "''"; const sub = generator.valueToCode(block, 'SUB', Order.NONE) || "''"; const code = text + '.count(' + sub + ')'; return [code, Order.FUNCTION_CALL]; }; pythonGenerator.forBlock['text_replace'] = function(block, generator) { const text = generator.valueToCode(block, 'TEXT', Order.MEMBER) || "''"; const from = generator.valueToCode(block, 'FROM', Order.NONE) || "''"; const to = generator.valueToCode(block, 'TO', Order.NONE) || "''"; const code = text + '.replace(' + from + ', ' + to + ')'; return [code, Order.MEMBER]; }; pythonGenerator.forBlock['text_reverse'] = function(block, generator) { const text = generator.valueToCode(block, 'TEXT', Order.MEMBER) || "''"; const code = text + '[::-1]'; return [code, Order.MEMBER]; };