Merge pull request #163 from carlosperate/lang

Change how Ardublockly block strings are stored and build

Author: carlosperate

blockly/build.py

@@ -391,7 +391,7 @@ def _rebuild(self, srcs, dests):
       else:
         print("Error checking file creation times: " + e)
 
-  def run(self):
+  def generate_blockly(self):
     # The files msg/json/{en,qqq,synonyms}.json depend on msg/messages.js.
     if self._rebuild([os.path.join("msg", "messages.js")],
                      [os.path.join("msg", "json", f) for f in
@@ -424,7 +424,8 @@ def run(self):
           "--quiet"]
       json_files = glob.glob(os.path.join("msg", "json", "*.json"))
       json_files = [file for file in json_files if not
-                    (file.endswith(("keys.json", "synonyms.json", "qqq.json")))]
+                    (file.endswith(("keys.json", "synonyms.json", "qqq.json",
+                                    "_ardublockly.json")))]
       cmd.extend(json_files)
       subprocess.check_call(cmd)
     except (subprocess.CalledProcessError, OSError) as e:
@@ -440,6 +441,62 @@ def run(self):
       else:
         print("FAILED to create " + f)
 
+  def generate_ardublockly(self):
+    """
+    Recreates the msg/json/{en,qqq,synonyms}_ardublockly.json files if older
+    than msg/messages_ardublockly.js.
+    Then attaches the {lang}_ardublockly.json strings into the {lang}.js files.
+    """
+    # The files msg/json/{en,qqq,synonyms}.json depend on msg/messages.js.
+    if self._rebuild([os.path.join("msg", "messages_ardublockly.js")],
+                     [os.path.join("msg", "json", f) for f in
+                      ["en_ardublockly.json",
+                       "qqq_ardublockly.json",
+                       "synonyms_ardublockly.json"]]):
+      try:
+        subprocess.check_call([
+            "python",
+            os.path.join("i18n", "js_to_json.py"),
+            "--author", "carlosperate",
+            "--input_file", "msg/messages_ardublockly.js",
+            "--output_dir", "msg/json/",
+            "--ardublockly",
+            "--quiet"])
+      except (subprocess.CalledProcessError, OSError) as e:
+        print("Error running i18n/js_to_json.py for Ardublockly pass: ", e)
+        sys.exit(1)
+
+    try:
+      # Use create_messages.py to attach _ardublockly.json strings to .js files
+      cmd = [
+          "python",
+          os.path.join("i18n", "create_messages.py"),
+          "--source_lang_file", os.path.join("msg","json",
+                                             "en_ardublockly.json"),
+          "--source_synonym_file", os.path.join("msg", "json",
+                                                "synonyms_ardublockly.json"),
+          "--output_dir", os.path.join("msg", "js"),
+          "--ardublockly",
+          "--quiet"]
+      json_files = glob.glob(os.path.join("msg", "json", "*.json"))
+      json_files = [file for file in json_files if not
+                    (file.endswith(("keys.json", "synonyms.json", "qqq.json",
+                                    "_ardublockly.json")))]
+      cmd.extend(json_files)
+      subprocess.check_call(cmd)
+    except (subprocess.CalledProcessError, OSError) as e:
+      print("Error running i18n/create_messages.py for Ardublockly pass: ", e)
+      sys.exit(1)
+
+  def run(self):
+    """
+    Runs the thread to generate the Blockly JavaScript string files and append
+    the Ardublockly strings at the end as well.
+    """
+    self.generate_blockly()
+    # Ardublockly appends it's strings at the end of blockly output
+    self.generate_ardublockly()
+
 
 if __name__ == "__main__":
   try:

blockly/i18n/common.py

@@ -64,7 +64,7 @@ def read_json_file(filename):
     raise InputError(filename, str(e))
 
 
-def _create_qqq_file(output_dir):
+def _create_qqq_file(output_dir, ardublockly=False):
     """Creates a qqq.json file with message documentation for translatewiki.net.
 
     The file consists of key-value pairs, where the keys are message ids and
@@ -83,7 +83,8 @@ def _create_qqq_file(output_dir):
     Raises:
         IOError: An error occurred while opening or writing the file.
     """
-    qqq_file_name = os.path.join(os.curdir, output_dir, 'qqq.json')
+    qqq_file_name = 'qqq_ardublockly.json' if ardublockly else 'qqq.json'
+    qqq_file_name = os.path.join(os.curdir, output_dir, qqq_file_name)
     qqq_file = codecs.open(qqq_file_name, 'w', 'utf-8')
     print 'Created file: ' + qqq_file_name
     qqq_file.write('{\n')
@@ -105,7 +106,7 @@ def _close_qqq_file(qqq_file):
     qqq_file.close()
 
 
-def _create_lang_file(author, lang, output_dir):
+def _create_lang_file(author, lang, output_dir, ardublockly=False):
     """Creates a <lang>.json file for translatewiki.net.
 
     The file consists of metadata, followed by key-value pairs, where the keys
@@ -124,7 +125,8 @@ def _create_lang_file(author, lang, output_dir):
     Raises:
         IOError: An error occurred while opening or writing the file.
     """
-    lang_file_name = os.path.join(os.curdir, output_dir, lang + '.json')
+    lang_file_name = lang + ('_ardublockly.json' if ardublockly else '.json')
+    lang_file_name = os.path.join(os.curdir, output_dir, lang_file_name)
     lang_file = codecs.open(lang_file_name, 'w', 'utf-8')
     print 'Created file: ' + lang_file_name
     # string.format doesn't like printing braces, so break up our writes.
@@ -232,3 +234,27 @@ def write_files(author, lang, output_dir, units, write_key_file):
     if write_key_file:
       _close_key_file(key_file)
     _close_qqq_file(qqq_file)
+
+
+def write_files_ardublockly(author, lang, output_dir, units):
+    """
+    Same as write_files, but does not include the key_files and generates
+    lang_ardublockly.json and qqq_ardublockly.json instead.
+    """
+    lang_file = _create_lang_file(author, lang, output_dir, ardublockly=True)
+    qqq_file = _create_qqq_file(output_dir, ardublockly=True)
+    first_entry = True
+    for unit in units:
+        if not first_entry:
+            lang_file.write(',\n')
+            qqq_file.write(',\n')
+        lang_file.write(u'\t"{0}": "{1}"'.format(
+            unit['meaning'],
+            unit['source'].replace('"', "'")))
+        qqq_file.write(u'\t"{0}": "{1}"'.format(
+            unit['meaning'],
+            unit['description'].replace('"', "'").replace(
+                '{lb}', '{').replace('{rb}', '}')))
+        first_entry = False
+    _close_lang_file(lang_file)
+    _close_qqq_file(qqq_file)

blockly/i18n/create_messages.py

@@ -55,6 +55,8 @@ def main():
                       help='relative path to input keys file')
   parser.add_argument('--quiet', action='store_true', default=False,
                       help='do not write anything to standard output')
+  parser.add_argument('--ardublockly', action='store_true', default=False,
+                      help='Attach Ardublockly strings to lang js files')
   parser.add_argument('files', nargs='+', help='input files')
   args = parser.parse_args()
   if not args.output_dir.endswith(os.path.sep):
@@ -80,10 +82,18 @@ def main():
 
   # Create each output file.
   for arg_file in args.files:
-    (_, filename) = os.path.split(arg_file)
+    (dir_, filename) = os.path.split(arg_file)
     target_lang = filename[:filename.index('.')]
     if target_lang not in ('qqq', 'keys', 'synonyms'):
-      target_defs = read_json_file(os.path.join(os.curdir, arg_file))
+      if args.ardublockly:
+        # For Ardublockly pass search for {lang}_ardublockly.json target file
+        target_defs = {}
+        ardu_json = os.path.join(dir_, target_lang + '_ardublockly.json')
+        if os.path.isfile(ardu_json):
+          target_defs = read_json_file(os.path.join(os.curdir, ardu_json))
+          print(u'Processed Ardublockly translation: {0}'.format(ardu_json))
+      else:
+        target_defs = read_json_file(os.path.join(os.curdir, arg_file))
 
       # Verify that keys are 'ascii'
       bad_keys = [key for key in target_defs if not string_is_ascii(key)]
@@ -99,19 +109,23 @@ def main():
                 format(key, arg_file))
           target_defs[key] = _NEWLINE_PATTERN.sub(' ', value)
 
+      # Prepare differences from parsing lang.json and lang_ardublockly.json
+      if args.ardublockly:
+        file_write_mode = 'a'
+        start_str = '\n\n// Ardublockly strings\n'
+      else:
+        file_write_mode = 'w'
+        start_str = ("// This file was automatically generated.  "
+                     "Do not modify.\n\n"
+                      "'use strict';\n\n"
+                      "goog.provide('Blockly.Msg.{0}');\n\n"
+                      "goog.require('Blockly.Msg');\n\n").format(
+                          target_lang.replace('-', '.'))
+
       # Output file.
       outname = os.path.join(os.curdir, args.output_dir, target_lang + '.js')
-      with codecs.open(outname, 'w', 'utf-8') as outfile:
-        outfile.write(
-            """// This file was automatically generated.  Do not modify.
-
-'use strict';
-
-goog.provide('Blockly.Msg.{0}');
-
-goog.require('Blockly.Msg');
-
-""".format(target_lang.replace('-', '.')))
+      with codecs.open(outname, file_write_mode, 'utf-8') as outfile:
+        outfile.write(start_str)
         # For each key in the source language file, output the target value
         # if present; otherwise, output the source language value with a
         # warning comment.

blockly/i18n/js_to_json.py

@@ -45,10 +45,11 @@
 import json
 import os
 import re
-from common import write_files
+from common import write_files, write_files_ardublockly
 
 
-_INPUT_DEF_PATTERN = re.compile("""Blockly.Msg.(\w*)\s*=\s*'([^']*)';?$""")
+#_INPUT_DEF_PATTERN = re.compile("""Blockly.Msg.(\w*)\s*=\s*'([^']*)';?$""")
+_INPUT_DEF_PATTERN = re.compile("""Blockly.Msg.(\w*)\s*=\s*'([^']*)';[\r\n]+$""")
 
 _INPUT_SYN_PATTERN = re.compile(
     """Blockly.Msg.(\w*)\s*=\s*Blockly.Msg.(\w*);""")
@@ -68,6 +69,8 @@ def main():
                       help='input file')
   parser.add_argument('--quiet', action='store_true', default=False,
                       help='only display warnings, not routine info')
+  parser.add_argument('--ardublockly', action='store_true', default=False,
+                      help='Create files for Ardublockly messages')
   args = parser.parse_args()
   if (not args.output_dir.endswith(os.path.sep)):
     args.output_dir += os.path.sep
@@ -105,7 +108,10 @@ def main():
   infile.close()
 
   # Create <lang_file>.json, keys.json, and qqq.json.
-  write_files(args.author, args.lang, args.output_dir, results, False)
+  if args.ardublockly:
+    write_files_ardublockly(args.author, args.lang, args.output_dir, results)
+  else:
+    write_files(args.author, args.lang, args.output_dir, results, False)
 
   # Create synonyms.json.
   synonym_file_name = os.path.join(os.curdir, args.output_dir, 'synonyms.json')

blockly/msg/json/en.json

@@ -370,123 +370,5 @@
 	"PROCEDURES_CREATE_DO": "Create '%1'",
 	"PROCEDURES_IFRETURN_TOOLTIP": "If a value is true, then return a second value.",
 	"PROCEDURES_IFRETURN_HELPURL": "http://c2.com/cgi/wiki?GuardClause",
-	"PROCEDURES_IFRETURN_WARNING": "Warning: This block may be used only within a function definition.",
-	"ARD_TYPE_CHAR": "Character",
-	"ARD_TYPE_TEXT": "Text",
-	"ARD_TYPE_BOOL": "Boolean",
-	"ARD_TYPE_SHORT": "Short Number",
-	"ARD_TYPE_NUMBER": "Number",
-	"ARD_TYPE_LONG": "Large Number",
-	"ARD_TYPE_DECIMAL": "Decimal",
-	"ARD_TYPE_ARRAY": "Array",
-	"ARD_TYPE_NULL": "Null",
-	"ARD_TYPE_UNDEF": "Undefined",
-	"ARD_TYPE_CHILDBLOCKMISSING": "ChildBlockMissing",
-	"ARD_HIGH": "HIGH",
-	"ARD_LOW": "LOW",
-	"ARD_ANALOGREAD": "read analog pin#",
-	"ARD_ANALOGREAD_TIP": "Return value between 0 and 1024",
-	"ARD_ANALOGWRITE": "set analog pin#",
-	"ARD_ANALOGWRITE_TIP": "Write analog value between 0 and 255 to a specific PWM Port",
-	"ARD_HIGHLOW_TIP": "Set a pin state logic High or Low.",
-	"ARD_DIGITALREAD": "read digital pin#",
-	"ARD_DIGITALREAD_TIP": "Read digital value on a pin: HIGH or LOW",
-	"ARD_DIGITALWRITE": "set digitial pin#",
-	"ARD_WRITE_TO": "to",
-	"ARD_DIGITALWRITE_TIP": "Write digital value HIGH or LOW to a specific Port",
-	"ARD_BUILTIN_LED": "set built-in LED",
-	"ARD_BUILTIN_LED_TIP": "Light on or off for the built-in LED of the Arduino",
-	"ARD_DEFINE": "Define",
-	"ARD_TONE_PIN": "Tone PIN#",
-	"ARD_TONE_FREQ": "frequency",
-	"ARD_TONE_PIN_TIP": "Generate audio tones on a pin",
-	"ARD_NOTONE_PIN": "No tone PIN#",
-	"ARD_NOTONE_PIN_TIP": "Stop generating a tone on a pin",
-	"ARD_MAP": "Map",
-	"ARD_MAP_VAL": "value to [0-",
-	"ARD_MAP_TIP": "Re-maps a number from [0-1024] to another.",
-	"ARD_FUN_RUN_SETUP": "Arduino run first:",
-	"ARD_FUN_RUN_LOOP": "Arduino loop forever:",
-	"ARD_FUN_RUN_TIP": "Defines the Arduino setup() and loop() functions.",
-	"ARD_PIN_WARN1": "Pin %1 is needed for %2 as pin %3. Already used as %4.",
-	"ARD_SERIAL_SETUP": "Setup",
-	"ARD_SERIAL_SPEED": ":  speed to",
-	"ARD_SERIAL_BPS": "bps",
-	"ARD_SERIAL_SETUP_TIP": "Selects the speed for a specific Serial peripheral",
-	"ARD_SERIAL_PRINT": "print",
-	"ARD_SERIAL_PRINT_NEWLINE": "add new line",
-	"ARD_SERIAL_PRINT_TIP": "Prints data to the console/serial port as human-readable ASCII text.",
-	"ARD_SERIAL_PRINT_WARN": "A setup block for %1 must be added to the workspace to use this block!",
-	"ARD_SERVO_WRITE": "set SERVO from Pin",
-	"ARD_SERVO_WRITE_TO": "to",
-	"ARD_SERVO_WRITE_DEG_180": "Degrees (0~180)",
-	"ARD_SERVO_WRITE_TIP": "Set a Servo to an specified angle",
-	"ARD_SERVO_READ": "read SERVO from PIN#",
-	"ARD_SERVO_READ_TIP": "Read a Servo angle",
-	"ARD_SPI_SETUP": "Setup",
-	"ARD_SPI_SETUP_CONF": "configuration:",
-	"ARD_SPI_SETUP_SHIFT": "data shift",
-	"ARD_SPI_SETUP_MSBFIRST": "MSBFIRST",
-	"ARD_SPI_SETUP_LSBFIRST": "LSBFIRST",
-	"ARD_SPI_SETUP_DIVIDE": "clock divide",
-	"ARD_SPI_SETUP_MODE": "SPI mode (idle - edge)",
-	"ARD_SPI_SETUP_MODE0": "0 (Low - Falling)",
-	"ARD_SPI_SETUP_MODE1": "1 (Low - Rising)",
-	"ARD_SPI_SETUP_MODE2": "2 (High - Falling)",
-	"ARD_SPI_SETUP_MODE3": "3 (High - Rising)",
-	"ARD_SPI_SETUP_TIP": "Configures the SPI peripheral.",
-	"ARD_SPI_TRANS_NONE": "none",
-	"ARD_SPI_TRANS_VAL": "transfer",
-	"ARD_SPI_TRANS_SLAVE": "to slave pin",
-	"ARD_SPI_TRANS_TIP": "Send a SPI message to an specified slave device.",
-	"ARD_SPI_TRANS_WARN1": "A setup block for %1 must be added to the workspace to use this block!",
-	"ARD_SPI_TRANS_WARN2": "Old pin value %1 is no longer available.",
-	"ARD_SPI_TRANSRETURN_TIP": "Send a SPI message to an specified slave device and get data back.",
-	"ARD_STEPPER_SETUP": "Setup stepper motor",
-	"ARD_STEPPER_MOTOR": "stepper motor:",
-	"ARD_STEPPER_DEFAULT_NAME": "MyStepper",
-	"ARD_STEPPER_NUMBER_OF_PINS": "Number of pins",
-	"ARD_STEPPER_TWO_PINS": "2",
-	"ARD_STEPPER_FOUR_PINS": "4",
-	"ARD_STEPPER_PIN1": "pin1#",
-	"ARD_STEPPER_PIN2": "pin2#",
-	"ARD_STEPPER_PIN3": "pin3#",
-	"ARD_STEPPER_PIN4": "pin4#",
-	"ARD_STEPPER_REVOLVS": "how many steps per revolution",
-	"ARD_STEPPER_SPEED": "set speed (rpm) to",
-	"ARD_STEPPER_SETUP_TIP": "Configures a stepper motor pinout and other settings.",
-	"ARD_STEPPER_STEP": "move stepper",
-	"ARD_STEPPER_STEPS": "steps",
-	"ARD_STEPPER_STEP_TIP": "Turns the stepper motor a specific number of steps.",
-	"ARD_STEPPER_COMPONENT": "stepper",
-	"ARD_COMPONENT_WARN1": "A %1 configuration block with the same %2 name must be added to use this block!",
-	"ARD_TIME_DELAY": "wait",
-	"ARD_TIME_MS": "milliseconds",
-	"ARD_TIME_DELAY_TIP": "Wait specific time in milliseconds",
-	"ARD_TIME_DELAY_MICROS": "microseconds",
-	"ARD_TIME_DELAY_MICRO_TIP": "Wait specific time in microseconds",
-	"ARD_TIME_MILLIS": "current elapsed Time (milliseconds)",
-	"ARD_TIME_MILLIS_TIP": "Returns the number of milliseconds since the Arduino board began running the current program. Has to be stored in a positive long integer",
-	"ARD_TIME_MICROS": "current elapsed Time (microseconds)",
-	"ARD_TIME_MICROS_TIP": "Returns the number of microseconds since the Arduino board began running the current program. Has to be stored in a positive long integer",
-	"ARD_TIME_INF": "wait forever (end program)",
-	"ARD_TIME_INF_TIP": "Wait indefinitely, stopping the program.",
-	"ARD_VAR_AS": "as",
-	"ARD_VAR_AS_TIP": "Sets a value to a specific type",
-	"ARD_PULSEREAD": "Read",
-	"ARD_PULSEON": "pulse on pin #",
-	"ARD_PULSETIMEOUT": "timeout after",
-	"ARD_PULSETIMEOUT_MS": "",
-	"ARD_PULSE_TIP": "Measures the duration of a pulse on the selected pin.",
-	"ARD_PULSETIMEOUT_TIP": "Measures the duration of a pulse on the selected pin, if it is within the timeout.",
-	"ARD_SETTONE": "Set tone on pin #",
-	"ARD_TONEFREQ": "at frequency",
-	"ARD_TONE_TIP": "Sets tone on pin to specified frequency within range 31 - 65535",
-	"ARD_TONE_WARNING": "Frequency must be in range 31 - 65535",
-	"ARD_NOTONE": "Turn off tone on pin #",
-	"ARD_NOTONE_TIP": "Turns the tone off on the selected pin",
-	"NEW_INSTANCE": "New instance...",
-	"RENAME_INSTANCE": "Rename instance...",
-	"NEW_INSTANCE_TITLE": "New instance name:",
-	"RENAME_INSTANCE_TITLE": "Rename all '%1' instances to:"
+	"PROCEDURES_IFRETURN_WARNING": "Warning: This block may be used only within a function definition."
 }