mirror of
https://github.com/google/blockly.git
synced 2026-01-15 12:57:12 +01:00
1197afcee7
Some type annotations were missing curly brackets, which makes closure-make-deps emit uninteresting warnings. Now any output from the command will be informative and related to whatever one is presently working on.
480 lines
17 KiB
JavaScript
480 lines
17 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview Old (compatibility) renderer.
|
|
* Geras: spirit of old age.
|
|
* @author fenichel@google.com (Rachel Fenichel)
|
|
*/
|
|
'use strict';
|
|
|
|
goog.provide('Blockly.geras');
|
|
goog.provide('Blockly.geras.RenderInfo');
|
|
|
|
goog.require('Blockly.blockRendering.ExternalValueInput');
|
|
goog.require('Blockly.blockRendering.InputRow');
|
|
goog.require('Blockly.blockRendering.InRowSpacer');
|
|
goog.require('Blockly.blockRendering.RenderInfo');
|
|
goog.require('Blockly.blockRendering.Types');
|
|
/** @suppress {extraRequire} */
|
|
goog.require('Blockly.constants');
|
|
goog.require('Blockly.geras.InlineInput');
|
|
goog.require('Blockly.geras.StatementInput');
|
|
goog.require('Blockly.inputTypes');
|
|
goog.require('Blockly.utils.object');
|
|
|
|
goog.requireType('Blockly.blockRendering.Field');
|
|
goog.requireType('Blockly.BlockSvg');
|
|
goog.requireType('Blockly.geras.Renderer');
|
|
|
|
|
|
/**
|
|
* An object containing all sizing information needed to draw this block.
|
|
*
|
|
* This measure pass does not propagate changes to the block (although fields
|
|
* may choose to rerender when getSize() is called). However, calling it
|
|
* repeatedly may be expensive.
|
|
*
|
|
* @param {!Blockly.geras.Renderer} renderer The renderer in use.
|
|
* @param {!Blockly.BlockSvg} block The block to measure.
|
|
* @constructor
|
|
* @package
|
|
* @extends {Blockly.blockRendering.RenderInfo}
|
|
*/
|
|
Blockly.geras.RenderInfo = function(renderer, block) {
|
|
Blockly.geras.RenderInfo.superClass_.constructor.call(this, renderer, block);
|
|
};
|
|
Blockly.utils.object.inherits(Blockly.geras.RenderInfo,
|
|
Blockly.blockRendering.RenderInfo);
|
|
|
|
/**
|
|
* Get the block renderer in use.
|
|
* @return {!Blockly.geras.Renderer} The block renderer in use.
|
|
* @package
|
|
*/
|
|
Blockly.geras.RenderInfo.prototype.getRenderer = function() {
|
|
return /** @type {!Blockly.geras.Renderer} */ (this.renderer_);
|
|
};
|
|
|
|
/**
|
|
* @override
|
|
*/
|
|
Blockly.geras.RenderInfo.prototype.populateBottomRow_ = function() {
|
|
Blockly.geras.RenderInfo.superClass_.populateBottomRow_.call(this);
|
|
|
|
var followsStatement = this.block_.inputList.length &&
|
|
this.block_.inputList[this.block_.inputList.length - 1].type ==
|
|
Blockly.inputTypes.STATEMENT;
|
|
|
|
// The minimum height of the bottom row is smaller in Geras than in other
|
|
// renderers, because the dark path adds a pixel.
|
|
// If one of the row's elements has a greater height this will be overwritten
|
|
// in the compute pass.
|
|
if (!followsStatement) {
|
|
this.bottomRow.minHeight =
|
|
this.constants_.MEDIUM_PADDING - this.constants_.DARK_PATH_OFFSET;
|
|
}
|
|
|
|
};
|
|
|
|
/**
|
|
* @override
|
|
*/
|
|
Blockly.geras.RenderInfo.prototype.addInput_ = function(input, activeRow) {
|
|
// Non-dummy inputs have visual representations onscreen.
|
|
if (this.isInline && input.type == Blockly.inputTypes.VALUE) {
|
|
activeRow.elements.push(
|
|
new Blockly.geras.InlineInput(this.constants_, input));
|
|
activeRow.hasInlineInput = true;
|
|
} else if (input.type == Blockly.inputTypes.STATEMENT) {
|
|
activeRow.elements.push(
|
|
new Blockly.geras.StatementInput(this.constants_, input));
|
|
activeRow.hasStatement = true;
|
|
} else if (input.type == Blockly.inputTypes.VALUE) {
|
|
activeRow.elements.push(
|
|
new Blockly.blockRendering.ExternalValueInput(this.constants_, input));
|
|
activeRow.hasExternalInput = true;
|
|
} else if (input.type == Blockly.inputTypes.DUMMY) {
|
|
// Dummy inputs have no visual representation, but the information is still
|
|
// important.
|
|
activeRow.minHeight = Math.max(activeRow.minHeight,
|
|
this.constants_.DUMMY_INPUT_MIN_HEIGHT);
|
|
activeRow.hasDummyInput = true;
|
|
}
|
|
// Ignore row alignment if inline.
|
|
if (!this.isInline && activeRow.align == null) {
|
|
activeRow.align = input.align;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @override
|
|
*/
|
|
Blockly.geras.RenderInfo.prototype.addElemSpacing_ = function() {
|
|
var hasExternalInputs = false;
|
|
for (var i = 0, row; (row = this.rows[i]); i++) {
|
|
if (row.hasExternalInput) {
|
|
hasExternalInputs = true;
|
|
}
|
|
}
|
|
for (var i = 0, row; (row = this.rows[i]); i++) {
|
|
var oldElems = row.elements;
|
|
row.elements = [];
|
|
// No spacing needed before the corner on the top row or the bottom row.
|
|
if (row.startsWithElemSpacer()) {
|
|
// There's a spacer before the first element in the row.
|
|
row.elements.push(new Blockly.blockRendering.InRowSpacer(
|
|
this.constants_, this.getInRowSpacing_(null, oldElems[0])));
|
|
}
|
|
if (!oldElems.length) {
|
|
continue;
|
|
}
|
|
for (var e = 0; e < oldElems.length - 1; e++) {
|
|
row.elements.push(oldElems[e]);
|
|
var spacing = this.getInRowSpacing_(oldElems[e], oldElems[e + 1]);
|
|
row.elements.push(
|
|
new Blockly.blockRendering.InRowSpacer(this.constants_, spacing));
|
|
}
|
|
row.elements.push(oldElems[oldElems.length - 1]);
|
|
if (row.endsWithElemSpacer()) {
|
|
var spacing = this.getInRowSpacing_(oldElems[oldElems.length - 1], null);
|
|
if (hasExternalInputs && row.hasDummyInput) {
|
|
spacing += this.constants_.TAB_WIDTH;
|
|
}
|
|
// There's a spacer after the last element in the row.
|
|
row.elements.push(new Blockly.blockRendering.InRowSpacer(
|
|
this.constants_, spacing));
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @override
|
|
*/
|
|
Blockly.geras.RenderInfo.prototype.getInRowSpacing_ = function(prev, next) {
|
|
if (!prev) {
|
|
// Between an editable field and the beginning of the row.
|
|
if (next && Blockly.blockRendering.Types.isField(next) &&
|
|
(/** @type {Blockly.blockRendering.Field} */ (next)).isEditable) {
|
|
return this.constants_.MEDIUM_PADDING;
|
|
}
|
|
// Inline input at the beginning of the row.
|
|
if (next && Blockly.blockRendering.Types.isInlineInput(next)) {
|
|
return this.constants_.MEDIUM_LARGE_PADDING;
|
|
}
|
|
if (next && Blockly.blockRendering.Types.isStatementInput(next)) {
|
|
return this.constants_.STATEMENT_INPUT_PADDING_LEFT;
|
|
}
|
|
// Anything else at the beginning of the row.
|
|
return this.constants_.LARGE_PADDING;
|
|
}
|
|
|
|
// Spacing between a non-input and the end of the row or a statement input.
|
|
if (!Blockly.blockRendering.Types.isInput(prev) && (!next ||
|
|
Blockly.blockRendering.Types.isStatementInput(next))) {
|
|
// Between an editable field and the end of the row.
|
|
if (Blockly.blockRendering.Types.isField(prev) &&
|
|
(/** @type {Blockly.blockRendering.Field} */ (prev)).isEditable) {
|
|
return this.constants_.MEDIUM_PADDING;
|
|
}
|
|
// Padding at the end of an icon-only row to make the block shape clearer.
|
|
if (Blockly.blockRendering.Types.isIcon(prev)) {
|
|
return (this.constants_.LARGE_PADDING * 2) + 1;
|
|
}
|
|
if (Blockly.blockRendering.Types.isHat(prev)) {
|
|
return this.constants_.NO_PADDING;
|
|
}
|
|
// Establish a minimum width for a block with a previous or next connection.
|
|
if (Blockly.blockRendering.Types.isPreviousOrNextConnection(prev)) {
|
|
return this.constants_.LARGE_PADDING;
|
|
}
|
|
// Between rounded corner and the end of the row.
|
|
if (Blockly.blockRendering.Types.isLeftRoundedCorner(prev)) {
|
|
return this.constants_.MIN_BLOCK_WIDTH;
|
|
}
|
|
// Between a jagged edge and the end of the row.
|
|
if (Blockly.blockRendering.Types.isJaggedEdge(prev)) {
|
|
return this.constants_.NO_PADDING;
|
|
}
|
|
// Between noneditable fields and icons and the end of the row.
|
|
return this.constants_.LARGE_PADDING;
|
|
}
|
|
|
|
// Between inputs and the end of the row.
|
|
if (Blockly.blockRendering.Types.isInput(prev) && !next) {
|
|
if (Blockly.blockRendering.Types.isExternalInput(prev)) {
|
|
return this.constants_.NO_PADDING;
|
|
} else if (Blockly.blockRendering.Types.isInlineInput(prev)) {
|
|
return this.constants_.LARGE_PADDING;
|
|
} else if (Blockly.blockRendering.Types.isStatementInput(prev)) {
|
|
return this.constants_.NO_PADDING;
|
|
}
|
|
}
|
|
|
|
// Spacing between a non-input and an input.
|
|
if (!Blockly.blockRendering.Types.isInput(prev) &&
|
|
next && Blockly.blockRendering.Types.isInput(next)) {
|
|
// Between an editable field and an input.
|
|
if (Blockly.blockRendering.Types.isField(prev) &&
|
|
(/** @type {Blockly.blockRendering.Field} */ (prev)).isEditable) {
|
|
if (Blockly.blockRendering.Types.isInlineInput(next)) {
|
|
return this.constants_.SMALL_PADDING;
|
|
} else if (Blockly.blockRendering.Types.isExternalInput(next)) {
|
|
return this.constants_.SMALL_PADDING;
|
|
}
|
|
} else {
|
|
if (Blockly.blockRendering.Types.isInlineInput(next)) {
|
|
return this.constants_.MEDIUM_LARGE_PADDING;
|
|
} else if (Blockly.blockRendering.Types.isExternalInput(next)) {
|
|
return this.constants_.MEDIUM_LARGE_PADDING;
|
|
} else if (Blockly.blockRendering.Types.isStatementInput(next)) {
|
|
return this.constants_.LARGE_PADDING;
|
|
}
|
|
}
|
|
return this.constants_.LARGE_PADDING - 1;
|
|
}
|
|
|
|
// Spacing between an icon and an icon or field.
|
|
if (Blockly.blockRendering.Types.isIcon(prev) &&
|
|
next && !Blockly.blockRendering.Types.isInput(next)) {
|
|
return this.constants_.LARGE_PADDING;
|
|
}
|
|
|
|
// Spacing between an inline input and a field.
|
|
if (Blockly.blockRendering.Types.isInlineInput(prev) &&
|
|
next && Blockly.blockRendering.Types.isField(next)) {
|
|
// Editable field after inline input.
|
|
if ((/** @type {Blockly.blockRendering.Field} */ (next)).isEditable) {
|
|
return this.constants_.MEDIUM_PADDING;
|
|
} else {
|
|
// Noneditable field after inline input.
|
|
return this.constants_.LARGE_PADDING;
|
|
}
|
|
}
|
|
|
|
if (Blockly.blockRendering.Types.isLeftSquareCorner(prev) && next) {
|
|
// Spacing between a hat and a corner
|
|
if (Blockly.blockRendering.Types.isHat(next)) {
|
|
return this.constants_.NO_PADDING;
|
|
}
|
|
// Spacing between a square corner and a previous or next connection
|
|
if (Blockly.blockRendering.Types.isPreviousConnection(next)) {
|
|
return next.notchOffset;
|
|
} else if (Blockly.blockRendering.Types.isNextConnection(next)) {
|
|
// Next connections are shifted slightly to the left (in both LTR and RTL)
|
|
// to make the dark path under the previous connection show through.
|
|
var offset = (this.RTL ? 1 : -1) *
|
|
this.constants_.DARK_PATH_OFFSET / 2;
|
|
return next.notchOffset + offset;
|
|
}
|
|
}
|
|
|
|
// Spacing between a rounded corner and a previous or next connection.
|
|
if (Blockly.blockRendering.Types.isLeftRoundedCorner(prev) && next) {
|
|
if (Blockly.blockRendering.Types.isPreviousConnection(next)) {
|
|
return next.notchOffset - this.constants_.CORNER_RADIUS;
|
|
} else if (Blockly.blockRendering.Types.isNextConnection(next)) {
|
|
// Next connections are shifted slightly to the left (in both LTR and RTL)
|
|
// to make the dark path under the previous connection show through.
|
|
var offset = (this.RTL ? 1 : -1) *
|
|
this.constants_.DARK_PATH_OFFSET / 2;
|
|
return next.notchOffset - this.constants_.CORNER_RADIUS + offset;
|
|
}
|
|
}
|
|
|
|
// Spacing between two fields of the same editability.
|
|
if (Blockly.blockRendering.Types.isField(prev) &&
|
|
next && Blockly.blockRendering.Types.isField(next) &&
|
|
((/** @type {Blockly.blockRendering.Field} */ (prev)).isEditable ==
|
|
(/** @type {Blockly.blockRendering.Field} */ (next)).isEditable)) {
|
|
return this.constants_.LARGE_PADDING;
|
|
}
|
|
|
|
// Spacing between anything and a jagged edge.
|
|
if (next && Blockly.blockRendering.Types.isJaggedEdge(next)) {
|
|
return this.constants_.LARGE_PADDING;
|
|
}
|
|
|
|
return this.constants_.MEDIUM_PADDING;
|
|
};
|
|
|
|
/**
|
|
* @override
|
|
*/
|
|
Blockly.geras.RenderInfo.prototype.getSpacerRowHeight_ = function(prev, next) {
|
|
// If we have an empty block add a spacer to increase the height.
|
|
if (Blockly.blockRendering.Types.isTopRow(prev) &&
|
|
Blockly.blockRendering.Types.isBottomRow(next)) {
|
|
return this.constants_.EMPTY_BLOCK_SPACER_HEIGHT;
|
|
}
|
|
// Top and bottom rows act as a spacer so we don't need any extra padding.
|
|
if (Blockly.blockRendering.Types.isTopRow(prev) ||
|
|
Blockly.blockRendering.Types.isBottomRow(next)) {
|
|
return this.constants_.NO_PADDING;
|
|
}
|
|
if (prev.hasExternalInput && next.hasExternalInput) {
|
|
return this.constants_.LARGE_PADDING;
|
|
}
|
|
if (!prev.hasStatement && next.hasStatement) {
|
|
return this.constants_.BETWEEN_STATEMENT_PADDING_Y;
|
|
}
|
|
if (prev.hasStatement && next.hasStatement) {
|
|
return this.constants_.LARGE_PADDING;
|
|
}
|
|
if (!prev.hasStatement && next.hasDummyInput) {
|
|
return this.constants_.LARGE_PADDING;
|
|
}
|
|
if (prev.hasDummyInput) {
|
|
return this.constants_.LARGE_PADDING;
|
|
}
|
|
return this.constants_.MEDIUM_PADDING;
|
|
};
|
|
|
|
/**
|
|
* @override
|
|
*/
|
|
Blockly.geras.RenderInfo.prototype.getElemCenterline_ = function(row, elem) {
|
|
if (Blockly.blockRendering.Types.isSpacer(elem)) {
|
|
return row.yPos + elem.height / 2;
|
|
}
|
|
if (Blockly.blockRendering.Types.isBottomRow(row)) {
|
|
var baseline = row.yPos + row.height - row.descenderHeight;
|
|
if (Blockly.blockRendering.Types.isNextConnection(elem)) {
|
|
return baseline + elem.height / 2;
|
|
}
|
|
return baseline - elem.height / 2;
|
|
}
|
|
if (Blockly.blockRendering.Types.isTopRow(row)) {
|
|
if (Blockly.blockRendering.Types.isHat(elem)) {
|
|
return row.capline - elem.height / 2;
|
|
}
|
|
return row.capline + elem.height / 2;
|
|
}
|
|
|
|
var result = row.yPos;
|
|
if (Blockly.blockRendering.Types.isField(elem) ||
|
|
Blockly.blockRendering.Types.isIcon(elem)) {
|
|
result += (elem.height / 2);
|
|
if ((row.hasInlineInput || row.hasStatement) &&
|
|
elem.height + this.constants_.TALL_INPUT_FIELD_OFFSET_Y <= row.height) {
|
|
result += this.constants_.TALL_INPUT_FIELD_OFFSET_Y;
|
|
}
|
|
} else if (Blockly.blockRendering.Types.isInlineInput(elem)) {
|
|
result += elem.height / 2;
|
|
} else {
|
|
result += (row.height / 2);
|
|
}
|
|
return result;
|
|
};
|
|
|
|
/**
|
|
* @override
|
|
*/
|
|
Blockly.geras.RenderInfo.prototype.alignRowElements_ = function() {
|
|
if (!this.isInline) {
|
|
Blockly.geras.RenderInfo.superClass_.alignRowElements_.call(this);
|
|
return;
|
|
}
|
|
|
|
// Walk backgrounds through rows on the block, keeping track of the right
|
|
// input edge.
|
|
var nextRightEdge = 0;
|
|
var prevInput = null;
|
|
for (var i = this.rows.length - 1, row; (row = this.rows[i]); i--) {
|
|
row.nextRightEdge = nextRightEdge;
|
|
if (Blockly.blockRendering.Types.isInputRow(row)) {
|
|
if (row.hasStatement) {
|
|
this.alignStatementRow_(
|
|
/** @type {!Blockly.blockRendering.InputRow} */ (row));
|
|
}
|
|
if (prevInput && prevInput.hasStatement && row.width < prevInput.width) {
|
|
row.nextRightEdge = prevInput.width;
|
|
} else {
|
|
nextRightEdge = row.width;
|
|
}
|
|
prevInput = row;
|
|
}
|
|
}
|
|
// Walk down each row from the top, comparing the prev and next right input
|
|
// edges and setting the desired width to the max of the two.
|
|
var prevRightEdge = 0;
|
|
for (var i = 0, row; (row = this.rows[i]); i++) {
|
|
if (row.hasStatement) {
|
|
prevRightEdge = this.getDesiredRowWidth_(row);
|
|
} else if (Blockly.blockRendering.Types.isSpacer(row)) {
|
|
// Set the spacer row to the max of the prev or next input width.
|
|
row.width = Math.max(prevRightEdge, row.nextRightEdge);
|
|
} else {
|
|
var currentWidth = row.width;
|
|
var desiredWidth = Math.max(prevRightEdge, row.nextRightEdge);
|
|
var missingSpace = desiredWidth - currentWidth;
|
|
if (missingSpace > 0) {
|
|
this.addAlignmentPadding_(row, missingSpace);
|
|
}
|
|
prevRightEdge = row.width;
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @override
|
|
*/
|
|
Blockly.geras.RenderInfo.prototype.getDesiredRowWidth_ = function(
|
|
row) {
|
|
// Limit the width of a statement row when a block is inline.
|
|
if (this.isInline && row.hasStatement) {
|
|
return this.statementEdge + this.constants_.MAX_BOTTOM_WIDTH + this.startX;
|
|
}
|
|
return Blockly.geras.RenderInfo.superClass_.getDesiredRowWidth_.call(this,
|
|
row);
|
|
};
|
|
|
|
/**
|
|
* @override
|
|
*/
|
|
Blockly.geras.RenderInfo.prototype.finalize_ = function() {
|
|
// Performance note: this could be combined with the draw pass, if the time
|
|
// that this takes is excessive. But it shouldn't be, because it only
|
|
// accesses and sets properties that already exist on the objects.
|
|
var widestRowWithConnectedBlocks = 0;
|
|
var yCursor = 0;
|
|
for (var i = 0, row; (row = this.rows[i]); i++) {
|
|
row.yPos = yCursor;
|
|
row.xPos = this.startX;
|
|
yCursor += row.height;
|
|
|
|
widestRowWithConnectedBlocks =
|
|
Math.max(widestRowWithConnectedBlocks, row.widthWithConnectedBlocks);
|
|
// Add padding to the bottom row if block height is less than minimum
|
|
var heightWithoutHat = yCursor - this.topRow.ascenderHeight;
|
|
if (row == this.bottomRow &&
|
|
heightWithoutHat < this.constants_.MIN_BLOCK_HEIGHT) {
|
|
// But the hat height shouldn't be part of this.
|
|
var diff = this.constants_.MIN_BLOCK_HEIGHT - heightWithoutHat;
|
|
this.bottomRow.height += diff;
|
|
yCursor += diff;
|
|
}
|
|
this.recordElemPositions_(row);
|
|
}
|
|
if (this.outputConnection && this.block_.nextConnection &&
|
|
this.block_.nextConnection.isConnected()) {
|
|
// Include width of connected block in value to stack width measurement.
|
|
widestRowWithConnectedBlocks =
|
|
Math.max(widestRowWithConnectedBlocks,
|
|
this.block_.nextConnection.targetBlock().getHeightWidth().width -
|
|
this.constants_.DARK_PATH_OFFSET);
|
|
}
|
|
|
|
this.bottomRow.baseline = yCursor - this.bottomRow.descenderHeight;
|
|
|
|
// The dark (lowlight) adds to the size of the block in both x and y.
|
|
this.widthWithChildren = widestRowWithConnectedBlocks +
|
|
this.startX + this.constants_.DARK_PATH_OFFSET;
|
|
this.width += this.constants_.DARK_PATH_OFFSET;
|
|
this.height = yCursor + this.constants_.DARK_PATH_OFFSET;
|
|
this.startY = this.topRow.capline;
|
|
};
|