Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion libs/pxt-common/pxt-core.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ interface Array<T> {
//% help=arrays/push
//% shim=Array_::push weight=50
//% blockId="array_push" block="%list| add value %value| to end" blockNamespace="arrays"
//% list.fieldOptions.localizeVariable=true
//% list.label="list to change" item.label="value to add"
//% group="Modify"
push(item: T): void;
Expand Down Expand Up @@ -710,4 +711,4 @@ declare namespace control {

//% shim=_control::_onCodeStop
export function _onCodeStop(arg: any): void;
}
}
1 change: 1 addition & 0 deletions localtypings/pxtarget.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -925,6 +925,7 @@ declare namespace ts.pxtc {
blockCombineSetHelp?: string;
blockCombineChangeHelp?: string;
blockSetVariable?: string; // show block with variable assigment in toolbox. Set equal to a name to control the var name
blockSetVariableLocalizable?: boolean; // extract blockSetVariable as display-only localization; the stored variable name is unchanged
fixedInstances?: boolean;
fixedInstance?: boolean;
expose?: boolean; // expose to VM despite being in pxt:: namespace
Expand Down
14 changes: 11 additions & 3 deletions pxtblocks/fields/field_kind.ts
Original file line number Diff line number Diff line change
Expand Up @@ -128,11 +128,12 @@ function createMenuGenerator(opts: pxtc.KindInfo): Blockly.MenuGeneratorFunction
if (sourceBlock?.workspace && !sourceBlock.isInFlyout) {
const options = sourceBlock.workspace.getVariableMap().getVariablesOfType(kindType(opts.name));
options.forEach(model => {
res.push([model.getName(), model.getName()]);
const name = model.getName();
res.push([getInitialMemberDisplayName(opts, name), name]);
});
} else {
// Can't create variables from within the flyout, so we just have to fake it
opts.initialMembers.forEach((e) => res.push([e, e]) );
opts.initialMembers.forEach((e) => res.push([getInitialMemberDisplayName(opts, e), e]) );
}


Expand All @@ -145,6 +146,13 @@ function createMenuGenerator(opts: pxtc.KindInfo): Blockly.MenuGeneratorFunction
}
}

function getInitialMemberDisplayName(opts: pxtc.KindInfo, name: string) {
const displayNames = opts.initialMemberDisplayNames;
return displayNames && Object.prototype.hasOwnProperty.call(displayNames, name)
? displayNames[name]
: name;
}

type PromptFunction<U extends pxtc.KindInfo> = (ws: Blockly.Workspace, opts: U, message: string, cb: (newValue: string) => void) => void;

function promptForName<U extends pxtc.KindInfo>(ws: Blockly.Workspace, opts: U, message: string, cb: (newValue: string) => void, promptFn: PromptFunction<U>) {
Expand Down Expand Up @@ -231,4 +239,4 @@ function createVariableForKind(ws: Blockly.Workspace, opts: pxtc.KindInfo, newNa

function kindType(name: string) {
return "KIND_" + name;
}
}
66 changes: 65 additions & 1 deletion pxtblocks/loader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import { COLOR_PICKER_BLOCK_TYPE } from "./plugins/colorpicker";
import { setDraggableShadowBlocks, setDuplicateOnDrag, setDuplicateOnDragStrategy } from "./plugins/duplicateOnDrag";
import { initCopyPaste } from "./copyPaste";
export { initCopyPaste } from "./copyPaste";
import { FieldVariable } from "./plugins/newVariableField/fieldVariable";
import { FieldVariable, setVariableFieldLocalizeFunction } from "./plugins/newVariableField/fieldVariable";
import { ArgumentReporterBlock, FieldArgumentReporter, setArgumentReporterLocalizeFunction } from "./plugins/functions";
import { getArgumentReporterParent } from "./plugins/functions/utils";
import { isFunctionDefinition } from "./compiler/util";
Expand Down Expand Up @@ -111,6 +111,13 @@ export function blockSymbol(type: string): pxtc.SymbolInfo {
export function injectBlocks(blockInfo: pxtc.BlocksInfo): pxtc.SymbolInfo[] {
cachedBlockInfo = blockInfo;

setVariableFieldLocalizeFunction((field, variable) => {
const info = getVariableFieldLocalizationInfo(field, variable, blockInfo);
if (!info) return undefined;
const localized = pxtc.getBlockTranslationsCacheKey(info.localizationKey);
return localized ? localized + info.suffix : undefined;
});

setDraggableShadowBlocks([
COLOR_PICKER_BLOCK_TYPE,
...blockInfo.blocks.filter(fn => fn.attributes.duplicateShadowOnDrag).map(fn => fn.attributes.blockId)
Expand Down Expand Up @@ -138,6 +145,63 @@ export function injectBlocks(blockInfo: pxtc.BlocksInfo): pxtc.SymbolInfo[] {
});
}

export interface VariableFieldLocalizationInfo {
localizationKey: string;
suffix: string;
}

export function getVariableFieldLocalizationInfo(
field: FieldVariable,
variable: Blockly.IVariableModel<Blockly.IVariableState>,
blockInfo: pxtc.BlocksInfo
): VariableFieldLocalizationInfo {
const sourceBlock = field.getSourceBlock();
if (!sourceBlock || !blockInfo) return undefined;

const rawName = variable.getName();
let defaultName: string;
let allowNumericSuffix = false;

if (sourceBlock.type === "variables_set") {
const valueBlock = sourceBlock.getInputTargetBlock("VALUE");
const fn = valueBlock && blockInfo.blocksById[valueBlock.type];
if (fn?.attributes.blockSetVariableLocalizable) {
defaultName = pxt.blocks.blockSetVariableName(fn);
allowNumericSuffix = true;
}
}
else if (sourceBlock.type === "variables_get") {
const parent = sourceBlock.getParent();
const fn = parent && blockInfo.blocksById[parent.type];
if (fn) {
const input = parent.inputList.filter(i => i.connection?.targetBlock() === sourceBlock)[0];
if (input) {
const comp = pxt.blocks.compileInfo(fn);
const params = comp.thisParameter ? [comp.thisParameter, ...comp.parameters] : comp.parameters;
const param = params.filter(p => p.definitionName === input.name)[0];
if (param && pxt.blocks.isVariableNameLocalizable(param)) {
defaultName = pxt.blocks.variableDefaultName(param.defaultValue, param.shadowBlockId);
allowNumericSuffix = !!defaultName;
}
}
}
}

if (!defaultName) return undefined;
if (rawName === defaultName) {
return { localizationKey: pxt.blocks.variableNameLocalizationKey(defaultName), suffix: "" };
}

if (allowNumericSuffix && rawName.indexOf(defaultName) === 0) {
const suffix = rawName.slice(defaultName.length);
if (/^(?:[2-9]|[1-9][0-9]+)$/.test(suffix)) {
return { localizationKey: pxt.blocks.variableNameLocalizationKey(defaultName), suffix };
}
}

return undefined;
}

function injectBlockDefinition(info: pxtc.BlocksInfo, fn: pxtc.SymbolInfo, comp: pxt.blocks.BlockCompileInfo, blockXml: HTMLElement): boolean {
let id = fn.attributes.blockId;

Expand Down
53 changes: 53 additions & 0 deletions pxtblocks/plugins/newVariableField/fieldVariable.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import * as Blockly from "blockly";

let localizeFunction: ((field: FieldVariable, variable: Blockly.IVariableModel<Blockly.IVariableState>) => string) | undefined;

/**
* This is the same as the Blockly variable field but with the addition
* of a "New Variable" option in the dropdown
Expand All @@ -10,6 +12,15 @@ export class FieldVariable extends Blockly.FieldVariable {
static dropdownCreate(this: FieldVariable): Blockly.MenuOption[] {
const options = Blockly.FieldVariable.dropdownCreate.call(this) as Blockly.MenuOption[];

for (const option of options) {
if (option === Blockly.FieldDropdown.SEPARATOR) continue;
const variable = this.sourceBlock_?.workspace.getVariableMap().getVariableById(option[1]);
if (variable && localizeFunction) {
const localized = localizeFunction(this, variable);
if (localized) option[0] = localized;
}
}

const insertIndex = options.findIndex(e => e[1] === "RENAME_VARIABLE_ID");

options.splice(
Expand All @@ -34,6 +45,43 @@ export class FieldVariable extends Blockly.FieldVariable {
this.menuGenerator_ = FieldVariable.dropdownCreate;
}

override init(): void {
super.init();
this.sourceBlock_?.workspace.addChangeListener(this.onWorkspaceChange);
}

protected override getDisplayText_(): string {
const variable = this.getVariable();
if (variable && localizeFunction) {
const localized = localizeFunction(this, variable);
if (localized) return localized;
Comment thread
ChrisesDK marked this conversation as resolved.
Resolved
}

return super.getDisplayText_();
}

override getAriaValue(): string {
const variable = this.getVariable();
if (variable && localizeFunction) {
const localized = localizeFunction(this, variable);
if (localized) return localized;
}

return super.getAriaValue();
}

private onWorkspaceChange = (event: Blockly.Events.Abstract) => {
if (event.type !== Blockly.Events.BLOCK_MOVE) return;

const sourceBlock = this.getSourceBlock();
const moved = event as Blockly.Events.BlockMove;
if (sourceBlock && (moved.blockId === sourceBlock.id
|| moved.oldParentId === sourceBlock.id
|| moved.newParentId === sourceBlock.id)) {
this.forceRerender();
}
};

protected override onItemSelected_(menu: Blockly.Menu, menuItem: Blockly.MenuItem) {
if (this.sourceBlock_ && !this.sourceBlock_.isDeadOrDying()) {
const id = menuItem.getValue();
Expand Down Expand Up @@ -142,6 +190,7 @@ export class FieldVariable extends Blockly.FieldVariable {
}

override dispose() {
this.sourceBlock_?.workspace.removeChangeListener(this.onWorkspaceChange);
super.dispose();
if (this.svgRootBinding) {
Blockly.browserEvents.unbind(this.svgRootBinding);
Expand Down Expand Up @@ -190,3 +239,7 @@ export class FieldVariable extends Blockly.FieldVariable {
// Override the default variable field
Blockly.fieldRegistry.unregister("field_variable");
Blockly.fieldRegistry.register("field_variable", FieldVariable);

export function setVariableFieldLocalizeFunction(func: ((field: FieldVariable, variable: Blockly.IVariableModel<Blockly.IVariableState>) => string) | undefined) {
localizeFunction = func;
}
21 changes: 17 additions & 4 deletions pxtcompiler/emitter/service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -355,10 +355,18 @@ namespace ts.pxtc {
locStrings[param.labelLocalizationKey] = param.label;
}

const defaultString = pxt.blocks.parameterDefaultToLocalizationString(param.defaultValue, param.type);
const defaultLocalizationKey = pxt.blocks.parameterDefaultLocalizationKey(si.qName, param.actualName);
if (defaultLocalizationKey && defaultString !== undefined) {
locStrings[defaultLocalizationKey] = defaultString;
const variableName = pxt.blocks.variableDefaultName(param.defaultValue, param.shadowBlockId);
if (variableName) {
if (pxt.blocks.isVariableNameLocalizable(param)) {
locStrings[pxt.blocks.variableNameLocalizationKey(variableName)] = variableName;
}
}
else {
const defaultString = pxt.blocks.parameterDefaultToLocalizationString(param.defaultValue, param.type);
const defaultLocalizationKey = pxt.blocks.parameterDefaultLocalizationKey(si.qName, param.actualName);
if (defaultLocalizationKey && defaultString !== undefined) {
locStrings[defaultLocalizationKey] = defaultString;
}
}
}
if (comp.handlerArgs?.length) {
Expand All @@ -368,6 +376,11 @@ namespace ts.pxtc {
}
}

const blockSetVariableName = pxt.blocks.blockSetVariableName(si);
if (blockSetVariableName && si.attributes.blockSetVariableLocalizable) {
locStrings[pxt.blocks.variableNameLocalizationKey(blockSetVariableName)] = blockSetVariableName;
}

if (si.attributes.ariaLabel) {
locStrings[`${si.qName}|ariaLabel`] = si.attributes.ariaLabel;
}
Expand Down
49 changes: 49 additions & 0 deletions pxtlib/blocks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,55 @@ namespace pxt.blocks {
return qName ? `${qName}|param|${actualName}|defl` : undefined;
}

export function variableNameLocalizationKey(name: string) {
return name ? `{id:var}${name}` : undefined;
}

export function variableDefaultName(defaultValue: string, shadowBlockId: string) {
if (!defaultValue || shadowBlockId !== "variables_get") return undefined;

if (defaultValue.charAt(0) === "\"") {
try {
const parsed = JSON.parse(defaultValue);
return typeof parsed === "string" ? parsed : undefined;
}
catch (e) {
return undefined;
}
}

return defaultValue;
}

export function blockSetVariableName(fn: pxtc.SymbolInfo) {
if (fn.attributes.blockSetVariable === undefined || !fn.retType) return undefined;

const rawName = fn.attributes.blockSetVariable;
return !rawName || isReservedWord(rawName) ? fn.retType.toLowerCase() : rawName;
}

export function isVariableNameLocalizable(param: BlockParameter) {
const value = param.fieldOptions?.localizeVariable;
return value === "true";
}

export function defaultVariableNames(fn: pxtc.SymbolInfo) {
const result: string[] = [];
const blockSetName = blockSetVariableName(fn);
if (blockSetName && fn.attributes.blockSetVariableLocalizable) result.push(blockSetName);

if (fn.attributes.block) {
const comp = compileInfo(fn);
const params = comp.thisParameter ? [comp.thisParameter, ...comp.parameters] : comp.parameters;
for (const param of params) {
const name = variableDefaultName(param.defaultValue, param.shadowBlockId);
if (name && isVariableNameLocalizable(param) && result.indexOf(name) < 0) result.push(name);
}
}

return result;
}

export function parameterDefaultToLocalizationString(defaultValue: string, type?: string) {
if (!defaultValue) return undefined;
if (type === "string" && defaultValue.charAt(0) !== "\"") return defaultValue;
Expand Down
38 changes: 27 additions & 11 deletions pxtlib/service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ namespace ts.pxtc {
blockId: string;
promptHint: string;
initialMembers: string[];
initialMemberDisplayNames?: pxt.Map<string>;
}

export interface CompletionEntry {
Expand Down Expand Up @@ -536,10 +537,12 @@ namespace ts.pxtc {
}

const initialMembers: string[] = [];
const initialMemberDisplayNames: pxt.Map<string> = {};
if (info.byQName[kindNamespace]) {
for (const api of pxtc.Util.values(info.byQName)) {
if (api.namespace === kindNamespace && api.attributes.isKind) {
initialMembers.push(api.name);
initialMemberDisplayNames[api.name] = api.attributes.block || api.name;
}
}
}
Expand All @@ -550,6 +553,7 @@ namespace ts.pxtc {
name: kindNamespace,
memberName: s.attributes.kindMemberName || kindNamespace,
initialMembers: initialMembers,
initialMemberDisplayNames,
promptHint: s.attributes.enumPromptHint || Util.lf("Create a new kind..."),
createFunctionName: s.attributes.kindCreateFunction || "create"
};
Expand Down Expand Up @@ -700,6 +704,16 @@ namespace ts.pxtc {
Util.jsonMergeFrom(loc, apiLocalizationStrings);
packageLocalizationStrings = loc;

const variableNames: pxt.Map<boolean> = {};
Util.values(apis.byQName).forEach(fn => {
pxt.blocks.defaultVariableNames(fn).forEach(name => variableNames[name] = true);
});
Object.keys(variableNames).forEach(name => {
const key = pxt.blocks.variableNameLocalizationKey(name);
if (loc[key]) setBlockTranslationCacheKey(key, loc[key]);
else clearBlockTranslationCacheKey(key);
});

const toLocalize = Util.values(apis.byQName).filter(fn => fn.attributes._translatedLanguageCode !== lang);
await Util.promiseMapAll(toLocalize, async fn => {
const altLocSrc = fn.attributes.useLoc || fn.attributes.blockAliasFor;
Expand Down Expand Up @@ -764,18 +778,20 @@ namespace ts.pxtc {
}
}

const defaultString = pxt.blocks.parameterDefaultToLocalizationString(param.defaultValue, param.type);
const defaultLocalizationKey = pxt.blocks.parameterDefaultLocalizationKey(fn.qName, param.actualName);
if (defaultLocalizationKey && defaultString !== undefined) {
const locSuff = defaultLocalizationKey.slice(fn.qName.length);
const paramDefault = lookupLoc(locSuff, langLower + locSuff);
if (paramDefault !== undefined) {
if (!fn.attributes._untranslatedParamDefl) {
fn.attributes._untranslatedParamDefl = U.clone(fn.attributes.paramDefl || {});
if (!pxt.blocks.variableDefaultName(param.defaultValue, param.shadowBlockId)) {
const defaultString = pxt.blocks.parameterDefaultToLocalizationString(param.defaultValue, param.type);
const defaultLocalizationKey = pxt.blocks.parameterDefaultLocalizationKey(fn.qName, param.actualName);
if (defaultLocalizationKey && defaultString !== undefined) {
const locSuff = defaultLocalizationKey.slice(fn.qName.length);
const paramDefault = lookupLoc(locSuff, langLower + locSuff);
if (paramDefault !== undefined) {
if (!fn.attributes._untranslatedParamDefl) {
fn.attributes._untranslatedParamDefl = U.clone(fn.attributes.paramDefl || {});
}
if (!fn.attributes.paramDefl) fn.attributes.paramDefl = {};
fn.attributes.paramDefl[param.actualName] = pxt.blocks.localizationStringToParameterDefault(paramDefault);
syncParameterDefaults(fn);
}
if (!fn.attributes.paramDefl) fn.attributes.paramDefl = {};
fn.attributes.paramDefl[param.actualName] = pxt.blocks.localizationStringToParameterDefault(paramDefault);
syncParameterDefaults(fn);
}
}
}
Expand Down
Loading