@blockdia/scratch-blocks 0.1.0

package/core/scratch_events.js

@@ -0,0 +1,131 @@
+/**
+ * @license
+ * Visual Blocks Editor
+ *
+ * Copyright 2018 Google Inc.
+ * https://developers.google.com/blockly/
+ *
+ * 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 Events fired as a result of UI actions in a Scratch-Blocks
+ * editor that are not fired in Blockly.
+ * @author fenichel@google.com (Rachel Fenichel)
+ */
+'use strict';
+
+goog.provide('Blockly.Events.DragBlockOutside');
+goog.provide('Blockly.Events.EndBlockDrag');
+
+goog.require('Blockly.Events');
+goog.require('Blockly.Events.BlockBase');
+
+goog.require('goog.array');
+goog.require('goog.math.Coordinate');
+
+/**
+ * Class for a block drag event. Fired when block dragged into or out of
+ * the blocks UI.
+ * @param {Blockly.Block} block The moved block.  Null for a blank event.
+ * @extends {Blockly.Events.BlockBase}
+ * @constructor
+ */
+Blockly.Events.DragBlockOutside = function(block) {
+  if (!block) {
+    return;  // Blank event to be populated by fromJson.
+  }
+  Blockly.Events.DragBlockOutside.superClass_.constructor.call(this, block);
+  this.recordUndo = false;
+};
+goog.inherits(Blockly.Events.DragBlockOutside, Blockly.Events.BlockBase);
+
+/**
+ * Type of this event.
+ * @type {string}
+ */
+Blockly.Events.DragBlockOutside.prototype.type = Blockly.Events.DRAG_OUTSIDE;
+
+/**
+ * Encode the event as JSON.
+ * @return {!Object} JSON representation.
+ */
+Blockly.Events.DragBlockOutside.prototype.toJson = function() {
+  var json = Blockly.Events.DragBlockOutside.superClass_.toJson.call(this);
+  if (this.isOutside) {
+    json['isOutside'] = this.isOutside;
+  }
+  return json;
+};
+
+/**
+ * Decode the JSON event.
+ * @param {!Object} json JSON representation.
+ */
+Blockly.Events.DragBlockOutside.prototype.fromJson = function(json) {
+  Blockly.Events.DragBlockOutside.superClass_.fromJson.call(this, json);
+  this.isOutside = json['isOutside'];
+};
+
+/**
+ * Class for a block end drag event.
+ * @param {Blockly.Block} block The moved block.  Null for a blank event.
+ * @param {boolean} isOutside True if the moved block is outside of the
+ *     blocks workspace.
+ * @extends {Blockly.Events.BlockBase}
+ * @constructor
+ */
+Blockly.Events.EndBlockDrag = function(block, isOutside) {
+  if (!block) {
+    return;  // Blank event to be populated by fromJson.
+  }
+  Blockly.Events.EndBlockDrag.superClass_.constructor.call(this, block);
+  this.isOutside = isOutside;
+  // If drag ends outside the blocks workspace, send the block XML
+  if (isOutside) {
+    this.xml = Blockly.Xml.blockToDom(block, true /* opt_noId */);
+  }
+  this.recordUndo = false;
+};
+goog.inherits(Blockly.Events.EndBlockDrag, Blockly.Events.BlockBase);
+
+/**
+ * Type of this event.
+ * @type {string}
+ */
+Blockly.Events.EndBlockDrag.prototype.type = Blockly.Events.END_DRAG;
+
+/**
+ * Encode the event as JSON.
+ * @return {!Object} JSON representation.
+ */
+Blockly.Events.EndBlockDrag.prototype.toJson = function() {
+  var json = Blockly.Events.EndBlockDrag.superClass_.toJson.call(this);
+  if (this.isOutside) {
+    json['isOutside'] = this.isOutside;
+  }
+  if (this.xml) {
+    json['xml'] = this.xml;
+  }
+  return json;
+};
+
+/**
+ * Decode the JSON event.
+ * @param {!Object} json JSON representation.
+ */
+Blockly.Events.EndBlockDrag.prototype.fromJson = function(json) {
+  Blockly.Events.EndBlockDrag.superClass_.fromJson.call(this, json);
+  this.isOutside = json['isOutside'];
+  this.xml = json['xml'];
+};

package/core/scratch_msgs.js

@@ -0,0 +1,85 @@
+/**
+ * @license
+ * Visual Blocks Editor
+ *
+ * Copyright 2018 Google Inc.
+ * https://developers.google.com/blockly/
+ *
+ * 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 Scratch Messages singleton, with function to override Blockly.Msg values.
+ * @author chrisg@media.mit.edu (Chris Garrity)
+ */
+'use strict';
+
+/**
+ * Name space for the ScratchMsgs singleton.
+ * Msg gets populated in the message files.
+ */
+goog.provide('Blockly.ScratchMsgs');
+
+goog.require('Blockly.Msg');
+
+
+/**
+ * The object containing messages for all locales - loaded from msg/scratch_msgs.
+ * @type {Object}
+ */
+Blockly.ScratchMsgs.locales = {};
+
+/**
+ * The current locale.
+ * @type {String}
+ * @private
+ */
+Blockly.ScratchMsgs.currentLocale_ = 'en';
+
+/**
+ * Change the Blockly.Msg strings to a new Locale
+ * Does not exist in Blockly, but needed in scratch-blocks
+ * @param {string} locale E.g., 'de', or 'zh-tw'
+ * @package
+ */
+Blockly.ScratchMsgs.setLocale = function(locale) {
+  if (Object.keys(Blockly.ScratchMsgs.locales).includes(locale)) {
+    Blockly.ScratchMsgs.currentLocale_ = locale;
+    Blockly.Msg = Object.assign({}, Blockly.Msg, Blockly.ScratchMsgs.locales[locale]);
+  } else {
+    // keep current locale
+    console.warn('Ignoring unrecognized locale: ' + locale);
+  }
+};
+
+/**
+ * Gets a localized message, for use in the Scratch VM with json init.
+ * Does not interpolate placeholders. Provided to allow default values in
+ * dynamic menus, for example, 'next backdrop', or 'random position'
+ * @param {string} msgId id for the message, key in Msg table.
+ * @param {string} defaultMsg string to use if the id isn't found.
+ * @param {string} useLocale optional locale to use in place of currentLocale_.
+ * @return {string} message with placeholders filled.
+ * @package
+ */
+Blockly.ScratchMsgs.translate = function(msgId, defaultMsg, useLocale) {
+  var locale = useLocale || Blockly.ScratchMsgs.currentLocale_;
+
+  if (Object.keys(Blockly.ScratchMsgs.locales).includes(locale)) {
+    var messages = Blockly.ScratchMsgs.locales[locale];
+    if (Object.keys(messages).includes(msgId)) {
+      return messages[msgId];
+    }
+  }
+  return defaultMsg;
+};