Merge pull request #54 from NetLogo/model-reporting

Model reporting

This looks good. Excellent work @arthurhjorth!

Author: mrerrormessage

src/main/ChildModel.java

@@ -18,7 +18,6 @@
 import org.nlogo.prim.*;
 import org.nlogo.workspace.AbstractWorkspace;
 
-
 public abstract class ChildModel {
     private final World parentWorld;
     private JobOwner owner;
@@ -185,17 +184,19 @@ public LogoList listBreeds() {
 
     public LogoList listBreedsOwns() {
         LogoListBuilder llb = new LogoListBuilder();
+        // add turtle vars as a separate tuple
+        LogoListBuilder tuple  = new LogoListBuilder();
+        LogoListBuilder vars = new LogoListBuilder();
+        vars.addAll(workspace().world().program().turtlesOwn());
+        tuple.add("TURTLES");
+        tuple.add(vars.toLogoList());
+        llb.add(tuple.toLogoList());
+
         for (Map.Entry<String, List<String>> entry : workspace().world().program().breedsOwn().entrySet())
         {
-            LogoListBuilder tuple  = new LogoListBuilder();
-            LogoListBuilder vars = new LogoListBuilder();
-            for (String s : entry.getValue()){
-                vars.add(s);
-            }
-            // add turtles own to all of them too
-            for (String s: workspace().world().program().turtlesOwn()){
-                vars.add(s);
-            }
+            tuple = new LogoListBuilder();
+            vars  = new LogoListBuilder();
+            vars.addAll(entry.getValue());
             tuple.add(entry.getKey());
             tuple.add(vars.toLogoList());
             llb.add(tuple.toLogoList());
@@ -204,12 +205,18 @@ public LogoList listBreedsOwns() {
 
     }
 
+    public LogoList listObserverProcedures(){
+        return null;
+    }
+
+    public LogoList listTurtleProcedures(){
+        return null;
+    }
+
     public LogoList listGlobals() {
         LogoListBuilder llb = new LogoListBuilder();
 
         for (int i = 0; i < workspace().world().observer().getVariableCount(); i++){
-//				theList.add(myWS.world().observer().variableName(i));
-            // we add all of them. We can manually edit the json file later.
             llb.add(workspace().world().observer().variableName(i));
         }
         return llb.toLogoList();
@@ -359,4 +366,25 @@ private Procedure getCommandRunner(Reporter task, Object[] taskArgs) {
         commandRunner.code[0].args = makeArgumentArray(task, taskArgs);
         return commandRunner;
     }
+
+    public LogoList getProcedures() {
+        LogoListBuilder outerLLB = new LogoListBuilder();
+        for (String pName : workspace().getProcedures().keySet()){
+            LogoListBuilder pList = new LogoListBuilder();
+            Procedure p = workspace().getProcedures().get(pName);
+            pList.add(pName);
+            pList.add(p.tyype.toString());
+            pList.add(p.usableBy);
+            LogoListBuilder argLLB = new LogoListBuilder();
+            // args contains dummies (temp 'lets') so we don't include them.
+            // localsCount contains number of lets so we just subtract that
+            for (int i = 0; i < p.args.size() - p.localsCount;i++){
+                String theString = p.args.get(i);
+                argLLB.add(theString);
+            }
+            pList.add(argLLB.toLogoList());
+            outerLLB.add(pList.toLogoList());
+        }
+        return outerLLB.toLogoList();
+    }
 }

src/main/LevelsSpace.java

@@ -28,6 +28,7 @@
 import org.nlogo.api.Syntax;
 import org.nlogo.app.ToolsMenu;
 import org.nlogo.nvm.*;
+import org.nlogo.nvm.ReporterTask;
 import org.nlogo.window.SpeedSliderPanel;
 import org.nlogo.window.ViewUpdatePanel;
 
@@ -74,10 +75,12 @@ public void load(PrimitiveManager primitiveManager) throws ExtensionException {
         primitiveManager.addPrimitive("hide", new Hide());
         primitiveManager.addPrimitive("_list-breeds", new ListBreeds());
         primitiveManager.addPrimitive("_globals", new Globals());
-//        primitiveManager.addPrimitive("_breeds-own", new BreedsOwns());
         primitiveManager.addPrimitive("ask-descendant", new HierarchicalAsk());
         primitiveManager.addPrimitive("of-descendant", new HierarchicalOf());
         primitiveManager.addPrimitive("uses-level-space?", new UsesLevelSpace());
+        primitiveManager.addPrimitive("_model-procedures", new ModelProcedures());
+        primitiveManager.addPrimitive("to-OTPL", new ToOTPL());
+
 
         if (useGUI()) {
             // Adding event listener to Halt for halting child models
@@ -242,7 +245,7 @@ public void perform(Argument[] args, Context context) throws LogoException, Exte
             String command = args[1].getString();
             Object[] actuals = getActuals(args, 2);
             for (ChildModel model : toModelList(args[0])) {
-                model.ask(command, actuals);
+              model.ask(command, actuals);
             }
         }
     }
@@ -381,6 +384,26 @@ public Object report(Argument[] args, Context arg1)
 
     }
 
+    public static class ToOTPL extends DefaultReporter {
+            public Syntax getSyntax(){
+                return Syntax.reporterSyntax(new int[] {Syntax.CommandTaskType() | Syntax.ReporterTaskType() },
+                        Syntax.StringType());
+            }
+        @Override
+        public Object report(Argument[] args, Context arg1)
+                throws ExtensionException, LogoException {
+            Object task = args[0].get();
+            if (task instanceof ReporterTask) {
+                ReporterTask rTask = (ReporterTask) task;
+                return rTask.body().agentClassString;
+            } else {
+                org.nlogo.nvm.CommandTask cTask = (org.nlogo.nvm.CommandTask) task;
+                return cTask.procedure().syntax().agentClassString();
+            }
+        }
+
+    }
+
 
     public static class CloseModel extends DefaultCommand {
         public Syntax getSyntax() {
@@ -460,6 +483,18 @@ public Object report(Argument[] args, Context context) throws ExtensionException
         }
     }
 
+    // this returns the path of the model
+    public static class ModelProcedures extends DefaultReporter{
+        public Syntax getSyntax(){
+            return Syntax.reporterSyntax(new int[] {Syntax.NumberType()},
+                    Syntax.ListType());
+        }
+        public Object report(Argument[] args, Context context) throws ExtensionException, LogoException {
+            int modelNumber = args[0].getIntValue();
+            return getModel(modelNumber).getProcedures();
+        }
+    }
+
     public static class SetName extends DefaultCommand {
 
         @Override
@@ -506,34 +541,6 @@ public Object report(Argument args[], Context context)
         }
     }
 
-
-    public static class BreedsOwns extends DefaultReporter {
-        public Syntax getSyntax() {
-            return Syntax.reporterSyntax(
-                    // we take in int[] {modelNumber, varName}
-                    new int[] { Syntax.NumberType() },
-                    // and return a number
-                    Syntax.ListType());
-        }
-
-        public Object report(Argument args[], Context context)
-                throws ExtensionException, org.nlogo.api.LogoException {
-            // get model number from args
-            int modelNumber = (int) args[0].getDoubleValue();
-
-            // find the model. if it exists, get all breeds + owns
-            if(models.containsKey(modelNumber))
-            {
-                ChildModel theModel = models.get(modelNumber);
-                return theModel.listBreedsOwns();
-
-            }
-            else{
-                return false;
-            }
-
-        }
-    }
     public static class ListBreeds extends DefaultReporter {
         public Syntax getSyntax() {
             return Syntax.reporterSyntax(