mirror of
https://github.com/google/blockly.git
synced 2026-01-07 00:50:27 +01:00
b0a7c004a9
* fix(build): Restore erroneously-deleted filter function This was deleted in PR #7406 as it was mainly being used to filter core/ vs. test/mocha/ deps into separate deps files - but it turns out also to be used for filtering error messages too. Oops. * refactor(tests): Migrate advanced compilation test to ES Modules * refactor(build): Migrate main.js to TypeScript This turns out to be pretty straight forward, even if it would cause crashing if one actually tried to import this module instead of just feeding it to Closure Compiler. * chore(build): Remove goog.declareModuleId calls Replace goog.declareModuleId calls with a comment recording the former module ID for posterity (or at least until we decide how to reformat the renamings file. * chore(tests): Delete closure/goog/* For the moment we still need something to serve as base.js for the benefit of closure-make-deps, so we keep a vestigial base.js around, containing only the @provideGoog declaration. * refactor(build): Remove vestigial base.js By changing slightly the command line arguments to closure-make-deps and closure-calculate-chunks the need to have any base.js is eliminated. * chore: Typo fix for PR #7415
101 lines
3.1 KiB
TypeScript
101 lines
3.1 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2020 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import type {Connection} from '../connection.js';
|
|
import type {RenderedConnection} from '../rendered_connection.js';
|
|
// Former goog.module ID: Blockly.IConnectionChecker
|
|
|
|
/**
|
|
* Class for connection type checking logic.
|
|
*/
|
|
export interface IConnectionChecker {
|
|
/**
|
|
* Check whether the current connection can connect with the target
|
|
* connection.
|
|
*
|
|
* @param a Connection to check compatibility with.
|
|
* @param b Connection to check compatibility with.
|
|
* @param isDragging True if the connection is being made by dragging a block.
|
|
* @param opt_distance The max allowable distance between the connections for
|
|
* drag checks.
|
|
* @returns Whether the connection is legal.
|
|
*/
|
|
canConnect(
|
|
a: Connection | null,
|
|
b: Connection | null,
|
|
isDragging: boolean,
|
|
opt_distance?: number,
|
|
): boolean;
|
|
|
|
/**
|
|
* Checks whether the current connection can connect with the target
|
|
* connection, and return an error code if there are problems.
|
|
*
|
|
* @param a Connection to check compatibility with.
|
|
* @param b Connection to check compatibility with.
|
|
* @param isDragging True if the connection is being made by dragging a block.
|
|
* @param opt_distance The max allowable distance between the connections for
|
|
* drag checks.
|
|
* @returns Connection.CAN_CONNECT if the connection is legal, an error code
|
|
* otherwise.
|
|
*/
|
|
canConnectWithReason(
|
|
a: Connection | null,
|
|
b: Connection | null,
|
|
isDragging: boolean,
|
|
opt_distance?: number,
|
|
): number;
|
|
|
|
/**
|
|
* Helper method that translates a connection error code into a string.
|
|
*
|
|
* @param errorCode The error code.
|
|
* @param a One of the two connections being checked.
|
|
* @param b The second of the two connections being checked.
|
|
* @returns A developer-readable error string.
|
|
*/
|
|
getErrorMessage(
|
|
errorCode: number,
|
|
a: Connection | null,
|
|
b: Connection | null,
|
|
): string;
|
|
|
|
/**
|
|
* Check that connecting the given connections is safe, meaning that it would
|
|
* not break any of Blockly's basic assumptions (e.g. no self connections).
|
|
*
|
|
* @param a The first of the connections to check.
|
|
* @param b The second of the connections to check.
|
|
* @returns An enum with the reason this connection is safe or unsafe.
|
|
*/
|
|
doSafetyChecks(a: Connection | null, b: Connection | null): number;
|
|
|
|
/**
|
|
* Check whether this connection is compatible with another connection with
|
|
* respect to the value type system. E.g. square_root("Hello") is not
|
|
* compatible.
|
|
*
|
|
* @param a Connection to compare.
|
|
* @param b Connection to compare against.
|
|
* @returns True if the connections share a type.
|
|
*/
|
|
doTypeChecks(a: Connection, b: Connection): boolean;
|
|
|
|
/**
|
|
* Check whether this connection can be made by dragging.
|
|
*
|
|
* @param a Connection to compare.
|
|
* @param b Connection to compare against.
|
|
* @param distance The maximum allowable distance between connections.
|
|
* @returns True if the connection is allowed during a drag.
|
|
*/
|
|
doDragChecks(
|
|
a: RenderedConnection,
|
|
b: RenderedConnection,
|
|
distance: number,
|
|
): boolean;
|
|
}
|