mirror of
https://github.com/google/blockly.git
synced 2026-01-08 17:40:09 +01:00
b46a4fe286
* Google changed from an Inc to an LLC. This happened back in 2017 but we didn’t notice. Officially we should update files from Inc to LLC when they are changed as part of regular edits, but this is a nightmare to remember for the next decade. * Remove project description/titles from licenses This is no longer part of Google’s header requirements. Our existing descriptions were useless (“Visual Blocks Editor”) or grossly obselete (“Visual Blocks Language”). * License no longer requires URL. * Fix license regexps.
378 lines
14 KiB
JavaScript
378 lines
14 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
/**
|
|
* @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.BottomRow');
|
|
goog.require('Blockly.blockRendering.InputRow');
|
|
goog.require('Blockly.blockRendering.Measurable');
|
|
goog.require('Blockly.blockRendering.NextConnection');
|
|
goog.require('Blockly.blockRendering.OutputConnection');
|
|
goog.require('Blockly.blockRendering.PreviousConnection');
|
|
goog.require('Blockly.blockRendering.RenderInfo');
|
|
goog.require('Blockly.blockRendering.BottomRow');
|
|
goog.require('Blockly.blockRendering.InputRow');
|
|
goog.require('Blockly.blockRendering.Measurable');
|
|
goog.require('Blockly.blockRendering.NextConnection');
|
|
goog.require('Blockly.blockRendering.OutputConnection');
|
|
goog.require('Blockly.blockRendering.PreviousConnection');
|
|
goog.require('Blockly.blockRendering.Types');
|
|
goog.require('Blockly.blockRendering.ExternalValueInput');
|
|
goog.require('Blockly.geras.InlineInput');
|
|
goog.require('Blockly.geras.StatementInput');
|
|
goog.require('Blockly.utils.object');
|
|
|
|
|
|
/**
|
|
* 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.addInput_ = function(input, activeRow) {
|
|
// Non-dummy inputs have visual representations onscreen.
|
|
if (this.isInline && input.type == Blockly.INPUT_VALUE) {
|
|
activeRow.elements.push(
|
|
new Blockly.geras.InlineInput(this.constants_, input));
|
|
activeRow.hasInlineInput = true;
|
|
} else if (input.type == Blockly.NEXT_STATEMENT) {
|
|
activeRow.elements.push(
|
|
new Blockly.geras.StatementInput(this.constants_, input));
|
|
activeRow.hasStatement = true;
|
|
} else if (input.type == Blockly.INPUT_VALUE) {
|
|
activeRow.elements.push(
|
|
new Blockly.blockRendering.ExternalValueInput(this.constants_, input));
|
|
activeRow.hasExternalInput = true;
|
|
} else if (input.type == Blockly.DUMMY_INPUT) {
|
|
// Dummy inputs have no visual representation, but the information is still
|
|
// important.
|
|
activeRow.hasDummyInput = true;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @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) && 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.
|
|
if (!Blockly.blockRendering.Types.isInput(prev) && !next) {
|
|
// Between an editable field and the end of the row.
|
|
if (Blockly.blockRendering.Types.isField(prev) && 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 (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.isInput(next)) {
|
|
// Editable field after inline input.
|
|
if (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.isInput(prev) &&
|
|
next && !Blockly.blockRendering.Types.isInput(next) &&
|
|
(prev.isEditable == 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.addAlignmentPadding_ = function(row, missingSpace) {
|
|
var firstSpacer = row.getFirstSpacer();
|
|
var lastSpacer = row.getLastSpacer();
|
|
if (row.hasExternalInput || row.hasStatement) {
|
|
row.widthWithConnectedBlocks += missingSpace;
|
|
}
|
|
|
|
var input = row.getLastInput();
|
|
if (input) {
|
|
// Decide where the extra padding goes.
|
|
if (input.align == Blockly.ALIGN_LEFT) {
|
|
// Add padding to the end of the row.
|
|
lastSpacer.width += missingSpace;
|
|
} else if (input.align == Blockly.ALIGN_CENTRE) {
|
|
// Split the padding between the beginning and end of the row.
|
|
firstSpacer.width += missingSpace / 2;
|
|
lastSpacer.width += missingSpace / 2;
|
|
} else if (input.align == Blockly.ALIGN_RIGHT) {
|
|
// Add padding at the beginning of the row.
|
|
firstSpacer.width += missingSpace;
|
|
}
|
|
} else {
|
|
// Default to left-aligning if there's no input to say where to align.
|
|
lastSpacer.width += missingSpace;
|
|
}
|
|
row.width += missingSpace;
|
|
};
|
|
|
|
/**
|
|
* @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;
|
|
}
|
|
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 > row.height + this.constants_.TALL_INPUT_FIELD_OFFSET_Y) {
|
|
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.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);
|
|
}
|
|
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;
|
|
};
|