STCC-173 Add more logging to Scratch3 parser (#86)

Author: Philipp Fleischhacker

config/default.ini

@@ -6,6 +6,7 @@ version:       0.9.1
 build_name:    Aegean cat
 build_number:  937
 
+
 ;-------------------------------------------------------------------------------
 [CATROBAT]
 ; TODO: update this field manually every time the hierarchy changes

src/scratchtocatrobat/scratch/scratch3.py

@@ -1,3 +1,6 @@
+from scratchtocatrobat.tools import logger
+
+log = logger.log
 
 def get_block_attribute(block, key):
     if key in block.keys():
@@ -75,6 +78,8 @@ def parse_sprites(self):
 
     def parse_sprite(self, sprite):
         from scratch3visitor.visitorUtil import BlockContext, visitScriptBlock
+        log.info("-" * 80)
+        log.info("[Scratch3]  Converting Sprite: {}".format(sprite["name"]))
 
         script_blocks = []
         temp_block_dict = {}

src/scratchtocatrobat/scratch/scratch3visitor/data.py

@@ -1,4 +1,7 @@
 from visitorUtil import visitGeneric
+from scratchtocatrobat.tools import logger
+
+log = logger.log
 
 def visitSetvariableto(blockcontext):
     block = blockcontext.block
@@ -58,6 +61,7 @@ def visitItemnumoflist(blockcontext):
     block = blockcontext.block
     list = block.fields["LIST"][0]
     item = visitGeneric(blockcontext, "ITEM")
+    log.warn("[Scratch3] block {} ({}) possibly not available in Scratch2".format(block.opcode, block.name))
     return ["placeholder_itemnumoflist", list, item] #TODO: not in scratch2
 
 def visitLengthoflist(blockcontext):

src/scratchtocatrobat/scratch/scratch3visitor/looks.py

@@ -1,4 +1,7 @@
 from visitorUtil import visitGeneric
+from scratchtocatrobat.tools import logger
+
+log = logger.log
 
 def visitSayforsecs(blockcontext):
     message = visitGeneric(blockcontext, "MESSAGE")
@@ -30,6 +33,7 @@ def visitSwitchbackdropto(blockcontext):
     return ["startScene", backdrop]
 
 def visitNextbackdrop(blockcontext):
+    log.warn("[Scratch3] block {} ({}) possibly not available in Scratch2".format(blockcontext.block.opcode, blockcontext.block.name))
     return ["nextBackdropPlaceholder"] #TODO: not in scratch2
 
 def visitChangesizeby(blockcontext):
@@ -84,6 +88,7 @@ def visitCostumenumbername(blockcontext):
 def visitBackdropnumbername(blockcontext):
     block = blockcontext.block
     name_number = block.fields["NUMBER_NAME"][0]
+    log.warn("[Scratch3] block {} ({}) possibly not available in Scratch2".format(blockcontext.block.opcode, blockcontext.block.name))
     return ["sceneNamePlaceholder"] #TODO: implement properly
 
 def visitSize(blockcontext):

src/scratchtocatrobat/scratch/scratch3visitor/motion.py

@@ -1,4 +1,7 @@
 from visitorUtil import visitGeneric
+from scratchtocatrobat.tools import logger
+
+log = logger.log
 
 def visitMovesteps(blockcontext):
     steps = visitGeneric(blockcontext, "STEPS")
@@ -24,6 +27,7 @@ def visitGotoxy(blockcontext):
 def visitGlideto(blockcontext):
     secs = visitGeneric(blockcontext, "SECS")
     to = visitGeneric(blockcontext, "TO")
+    log.warn("[Scratch3] block {} ({}) possibly not available in Scratch2".format(blockcontext.block.opcode, blockcontext.block.name))
     return ["glideTo:", secs, to] #TODO: not in scratch2?
 
 def visitGlidesecstoxy(blockcontext):

src/scratchtocatrobat/scratch/scratch3visitor/operator.py

@@ -1,4 +1,8 @@
 from visitorUtil import visitGeneric
+from scratchtocatrobat.tools import logger
+
+log = logger.log
+
 
 def visitSubtract(blockcontext):
     operand1 = visitGeneric(blockcontext, "NUM1")
@@ -83,6 +87,8 @@ def visitDivide(blockcontext):
 def visitContains(blockcontext):
     operand1 = visitGeneric(blockcontext, "STRING1")
     operand2 = visitGeneric(blockcontext, "STRING2")
+
+    log.warn("[Scratch3] block {} ({}) possibly not available in Scratch2".format(blockcontext.block.opcode, blockcontext.block.name))
     return ["contains:", operand1, operand2]
     #TODO: not in scratch2?
 

src/scratchtocatrobat/scratch/scratch3visitor/pen.py

@@ -1,5 +1,7 @@
 from visitorUtil import visitGeneric
+from scratchtocatrobat.tools import logger
 
+log = logger.log
 
 def visitClear(blockcontext):
     return ["clearPenTrails"]
@@ -20,6 +22,7 @@ def visitSetPenColorToColor(blockcontext):
 def visitChangePenColorParamBy(blockcontext):
     colorparam = visitGeneric(blockcontext, "COLOR_PARAM")
     value = visitGeneric(blockcontext, "VALUE")
+    log.warn("[Scratch3] block {} ({}) possibly not available in Scratch2".format(blockcontext.block.opcode, blockcontext.block.name))
     return ["changePenHueBy:", colorparam, value] #TODO: not in scratch2? can choose parameter
 
 def visitPen_menu_colorParam(blockcontext):
@@ -28,6 +31,7 @@ def visitPen_menu_colorParam(blockcontext):
 def visitSetPenColorParamTo(blockcontext):
     colorparam = visitGeneric(blockcontext, "COLOR_PARAM")
     value = visitGeneric(blockcontext, "VALUE")
+    log.warn("[Scratch3] block {} ({}) possibly not available in Scratch2".format(blockcontext.block.opcode, blockcontext.block.name))
     return ["setPenHueTo:", colorparam, value] #TODO: not in scratch2? can choose parameter
 
 def visitChangePenSizeBy(blockcontext):
@@ -48,5 +52,6 @@ def visitChangePenShadeByNumber(blockcontext):
 
 def visitSetPenHueToNumber(blockcontext):
     size = visitGeneric(blockcontext, "HUE")
+    log.warn("[Scratch3] SetPenHue block possibly not available in Scratch2")
     return ["penHue:", size]
 

src/scratchtocatrobat/scratch/scratch3visitor/sensing.py

@@ -1,4 +1,7 @@
 from visitorUtil import visitGeneric
+from scratchtocatrobat.tools import logger
+
+log = logger.log
 
 def visitTouchingObject(blockcontext):
     touch = visitGeneric(blockcontext, "TOUCHINGOBJECTMENU")
@@ -20,6 +23,7 @@ def visitAskandwait(blockcontext):
 def visitSetdragmode(blockcontext):
     block = blockcontext.block
     dragmode = block.fields["DRAG_MODE"][0]
+    log.warn("[Scratch3] block {} ({}) possibly not available in Scratch2".format(blockcontext.block.opcode, blockcontext.block.name))
     return ["dragMode", dragmode] #TODO: not implemented in old converter?
 
 

src/scratchtocatrobat/scratch/scratch3visitor/sound.py

@@ -1,4 +1,7 @@
 from visitorUtil import visitGeneric
+from scratchtocatrobat.tools import logger
+
+log = logger.log
 
 def visitPlay(blockcontext):
     sound = visitGeneric(blockcontext, 'SOUND_MENU')
@@ -13,13 +16,16 @@ def visitStopallsounds(blockcontext):
 
 def visitChangeeffectby(blockcontext):
     block = blockcontext.block
+    log.warn("[Scratch3] block {} ({}) possibly not available in Scratch2".format(blockcontext.block.opcode, blockcontext.block.name))
     pass #TODO: doesnt exist in scratch2/catroid
 
 def visitSeteffectto(blockcontext):
     block = blockcontext.block
+    log.warn("[Scratch3] block {} ({}) possibly not available in Scratch2".format(blockcontext.block.opcode, blockcontext.block.name))
     pass #TODO: doesnt exist in scratch2/catroid
 
 def visitCleareffects(blockcontext):
+    log.warn("[Scratch3] block {} ({}) possibly not available in Scratch2".format(blockcontext.block.opcode, blockcontext.block.name))
     return ["clearSoundEffects"] #TODO: not in scratch2
 
 def visitChangevolumeby(blockcontext):

src/scratchtocatrobat/scratch/scratch3visitor/visitorUtil.py

@@ -24,6 +24,7 @@ def visitScriptBlock(blockcontext):
     if not isinstance(blockcontext, BlockContext):
         return blockcontext
 
+    log.info("[Scratch3]  Converting Script: {}".format(blockcontext.block.opcode))
     scriptblock_handler = blockcontext.getBlockHandler()
     scriptblock = scriptblock_handler(blockcontext)
     blockcontext.nextBlock()
@@ -67,6 +68,7 @@ def isShadowBlock(block, attributename):
 def visitGeneric(blockcontext, attributename):
     block = blockcontext.block
     if not attributename in block.inputs:
+        log.warn("[Scratch3] Failed to convert attribute: {} of block {} (type {}). Input is: {}".format(attributename, block.name, block.opcode, block.inputs.get(attributename)))
         return [False]
 
     block_id = blockcontext.getInput(attributename)[1]
@@ -88,10 +90,13 @@ def visitDefault(blockcontext):
 def visitCondition(blockcontext):
     block = blockcontext.block
     if not "CONDITION" in block.inputs:
+        log.warn("[Scratch3] Possibly empty condition in block {} ({})".format(blockcontext.block.name, blockcontext.block.opcode))
         return False
+
     block_id = blockcontext.getInput("CONDITION")[1]
     conditionblock = blockcontext.get_block(block_id)
     if not isinstance(conditionblock, Scratch3Block):
+        log.warn("[Scratch3] Possibly empty condition in block {} ({})".format(blockcontext.block.name, blockcontext.block.opcode))
         return False
     condition = visitGeneric(blockcontext, "CONDITION")
     return condition
@@ -111,6 +116,7 @@ def visitBlockList(blockcontext):
 
 def visitSubstack(blockcontext, substackkey):
     if not substackkey in blockcontext.block.inputs:
+        log.warn("[Scratch3] Possibly empty if or else clause in block {} ({})".format(blockcontext.block.name, blockcontext.block.opcode))
         return None
     block_id = blockcontext.getInput(substackkey)[1]
     substackstartblock = blockcontext.get_block(block_id)
@@ -120,6 +126,7 @@ def visitSubstack(blockcontext, substackkey):
     substack = visitBlockList(substack_context)
     return substack
 
+
 def visitMutation(blockcontext):
     return blockcontext.block.mutation["proccode"]