Code Generation by PatrickPenguinTurtle · Pull Request #597 · WPIRoboticsProjects/GRIP

PatrickPenguinTurtle · 2016-06-02T18:23:46Z

@osulacam and myself are working on an extension to GRIP that generates code. Eventually it will generate code for the users choice of Java, C++ and Python. For now it only generates Java code.

The idea behind this is so that users do not have to run a jvm containing GRIP to get pipelines to run. Instead they would include this file in their code and call the processImage function to run the pipeline once.

As mentioned this is in progress and at this time is not finished enough to be merged into GRIP.

Things to do:

Testing @PatrickPenguinTurtle
Better warning for unsupported ops @osulacam
Try with resources blocks @osulacam
Pull socket hint descriptions into comments

codecov-io · 2016-06-02T18:47:36Z

Current coverage is 55.09% (diff: 0.00%)

Merging #597 into master will decrease coverage by 3.37%

@@             master       #597   diff @@
==========================================
  Files           198        209    +11   
  Lines          6282       6663   +381   
  Methods           0          0          
  Messages          0          0          
  Branches        569        646    +77   
==========================================
- Hits           3673       3671     -2   
- Misses         2442       2824   +382   
- Partials        167        168     +1

Powered by Codecov. Last update 1c1a5f6...3b46891

SamCarlberg · 2016-06-02T18:50:15Z

I would put the Velocity templates into language-specific directories (e.g. /generation/templates/c++, /generation/templates/java, /generation/templates/python, etc.) and outside of the jar file to make it easy to add new languages or adjust/add to the stock templates that we bundle.

What's with all the T-prefixed classes? What does T stand for?

What's with the weird function names? (e.g. Find_Blobs -- follow the language conventions!)

MutableOf seems like a C-style way to return objects. If you're generating Java code, it should follow Java conventions. Use references for generated C/C++/C# code, not for Java.

Why did you remove two UI tests from version control?

And please, please, add some documentation.

I'll add more comments after I checkout this PR and play around with it.

SamCarlberg · 2016-06-02T18:59:49Z

ui/src/main/resources/edu/wpi/grip/ui/templates/operations/Switch.vm

@@ -0,0 +1,8 @@
+    public static void Switch(boolean sw, Object onTrue,Object onFalse, Object output){


This method won't actually do anything. You're just reassigning a local reference.

Why not something like

public static <T> T Switch(boolean sw, T onTrue, T onFalse) { return sw ? onTrue : onFalse; }

I didn't write this one and we also know that Switch currently doesn't work.

PatrickPenguinTurtle · 2016-06-02T21:35:38Z

@SamCarlberg The reason behind MutableOf is it follows OpenCV's own convention. Further otherwise we would need to create several objects that did not exist before and fight with the TPipeline trying to make it recognize a new object.

Also made switch work.

…alve, and FindBlobs.

…ameraTest.java file.

Also made switch work.

SamCarlberg · 2016-06-03T14:51:10Z

ui/src/main/resources/edu/wpi/grip/ui/templates/Pipeline.vm

+*
+* <P>Make sure to set all sources using the setters before running processImage().
+*
+* <P>Tutorials and examples can be found online


Where online?

…into DataModel

…aModel

SamCarlberg · 2016-08-29T00:01:45Z

Edit: this has all been addressed in 11f967c

Breaks when using publishing operations. Publishing operations should be ignored from generation and the user should be alerted.

Edit: just saw you addressed this in the meeting.

Also, the generated method names could be a lot nicer.

setsourceX(...) should be setSourceX(...) in Java and C++ (python's okay)
Inconsistent naming scheme between languages (findBlobsOutput0() is a Java getter, getFind_Blobs0Output0() for C++, and python is find_blobs0output0).
- Seems like Java's working right and C++ and Python didn't get updated
Operations with only one output have redundant '0's at the end of getter methods

Getters for the outputs should be styled like get[op_name][op_number]Output[out_number], where op_number and out_number are optional if there's only one operation with that name or only one output for that operation, respectively.

Language	Operation	Instances of that operation	Number of outputs	Example of a generated getter
Java	Find blobs	1	1	`getFindBlobsOutput`
C++				`getFindBlobsOutput`
Python				`find_blobs_output`
Java	Split	2	3	`getSplit0Output2`
C++				`getSplit1Output0`
Python				`split_1_output_1`

If an operation has multiple outputs (eg Split could have Red plane, Green plane, and Blue plane), it would be good to name the pipeline outputs with those names (eg getSplitRedPlane, split_red_plane)

SamCarlberg · 2016-09-08T19:18:13Z

Generated code that uses Switch will fail if the inputs are not both Mats , or have different types (Java and C++). I don't think that's very likely to happen though, but I do think it would be worthwhile to inline the switch and valve operations

Variables and methods no longer have numbers if there's only one of that operation, or if an operation only has one output. Operations with multiple outputs have the outputs named the same as on the socket (instead of just 'output0', 'output1', ...) Rename `MutableOf` to `Ref` because it's really just holding a reference and it's used similarly to output parameters in C/C++

Don't try to generate code for network operations and improve generated variable and method names

…able operations

SamCarlberg · 2016-09-13T15:15:02Z

OpenCV artifacts are available here

Artifacts for an installer are also in that repository. The project is here

Add alert when trying to generate code for a pipeline with non-exportable operations

Fix code gen directory name not matching package name

SamCarlberg · 2016-09-22T22:04:49Z

ui/src/main/java/edu/wpi/grip/ui/codegeneration/CppTMethods.java

  }

+  @Override
+  public String getterName(String name) {


Should be "get" + WordUtils.capitalize(name(name)), otherwise you'll get stuff like "getblobsOutput" instead of "getBlobsOutput"

SamCarlberg · 2016-09-22T22:05:24Z

ui/src/main/java/edu/wpi/grip/ui/codegeneration/CppTMethods.java

+  }
+
+  @Override
+  public String setterName(String name) {


Should be "set" + WordUtils.capitalize(name(name)) (see comment for getterName)

SamCarlberg · 2016-09-22T22:06:02Z

ui/src/main/java/edu/wpi/grip/ui/codegeneration/JavaTMethods.java

  }

+  @Override
+  public String getterName(String name) {


See comment on CppTMethods

SamCarlberg · 2016-09-22T22:06:09Z

ui/src/main/java/edu/wpi/grip/ui/codegeneration/JavaTMethods.java

+  }
+
+  @Override
+  public String setterName(String name) {


See comment on CppTMethods

SamCarlberg · 2016-09-22T22:07:05Z

ui/src/main/java/edu/wpi/grip/ui/codegeneration/PythonTMethods.java

  }

+  @Override
+  public String getterName(String name) {


See comment on CppTMethods

SamCarlberg · 2016-09-22T22:07:50Z

ui/src/main/java/edu/wpi/grip/ui/codegeneration/PythonTMethods.java

+  }
+
+  @Override
+  public String setterName(String name) {


See comment on CppTMethods. Will this cause a naming conflict?

SamCarlberg · 2016-09-22T22:51:39Z

ui/src/test/java/edu/wpi/grip/ui/codegeneration/tools/CppPipelineInterfacer.java

  @Override
  public Object getOutput(String name, GenType type) {
-    String newName = name.toLowerCase().replaceAll("_", "");
+    String newName = tMeth.getterName(name);


I feel like it would make more sense to pass in the actual name instead of having to use the intermediate format that would then get transformed.

Calling

getOutput("convexHullsOutput", ...)

makes much more sense to me than

getOutput("Convex_Hulls_Output", ...)

…en tests on Travis' OSX platform

Merge master branch

Enable code generation tests without needing to build OpenCV

JLLeitschuh · 2016-10-03T15:42:37Z

LGTM!

![Approved with PullApprove](https://img.shields.io/badge/GRIP Merge Approvers-approved-brightgreen.svg)

Also added ui/CameraTest.java to git ignore

bec3923

SamCarlberg reviewed Jun 2, 2016
View reviewed changes

PatrickPenguinTurtle added 2 commits June 2, 2016 16:36

All OpenCV methods now work. Valve is currently in progress.

0c23488

Valve works now!

83ce42b

PatrickPenguinTurtle and others added 9 commits June 3, 2016 09:32

Cleaned up CV Step.vm by spliting into multiple files.

6fd9029

Also made switch work.

Merge github.com:WPIRoboticsProjects/GRIP

534cd7c

Added More CV methods. Only 5 more to go!

5c86cd5

All composite operations are finished and tested except for Switch, V…

5299d1c

…alve, and FindBlobs.

Finished all operations and have begun testing. Also removed the ui/C…

86d995e

…ameraTest.java file.

Also added ui/CameraTest.java to git ignore

c991438

All OpenCV methods now work. Valve is currently in progress.

c151948

Valve works now!

ffcfd7c

Cleaned up CV Step.vm by spliting into multiple files.

dc0a567

Also made switch work.

SamCarlberg reviewed Jun 3, 2016
View reviewed changes

osulacam added 4 commits August 27, 2016 12:18

Fixed mistakes from last commit.

0d9314e

Merge branch 'master' of https://github.com/WPIRoboticsProjects/GRIP …

23fe3af

…into DataModel

Fixed pmd bug.

d067404

Merge branch 'DataModel' of https://github.com/osulacam/GRIP into Dat…

8b6d212

…aModel

AustinShalit modified the milestones: v1.5.0, 1.6.0 Aug 27, 2016

SamCarlberg added the needs: fixup label Aug 29, 2016

Don't try generating code for publishing operations

a47afd8

SamCarlberg and others added 3 commits September 8, 2016 16:39

Merge pull request #1 from SamCarlberg/DataModel

5729c22

Don't try to generate code for network operations and improve generated variable and method names

Add alert when trying to generate code for a pipeline with non-export…

613d725

…able operations

osulacam and others added 4 commits September 14, 2016 12:53

Merge pull request #2 from SamCarlberg/DataModel

8b17b7f

Add alert when trying to generate code for a pipeline with non-exportable operations

Fix code gen directory name not matching package name

42c6827

Fixed Java and Python tests. C++ test are commented out.

2f8720f

Merge pull request #3 from SamCarlberg/DataModel

026e04c

Fix code gen directory name not matching package name

SamCarlberg requested changes Sep 22, 2016

View reviewed changes

SamCarlberg reviewed Sep 22, 2016

View reviewed changes

[email protected] and others added 5 commits September 22, 2016 18:58

Merge master

f03a581

Fix AbstractGenerationTestings

07c0853

Use OpenCV artifacts on FRC maven for code gen testing. Enable code g…

d9de34b

…en tests on Travis' OSX platform

Merge pull request #4 from SamCarlberg/DataModel

f570129

Merge master branch

Merge pull request #5 from SamCarlberg/codegen/use-opencv-maven

3b46891

Enable code generation tests without needing to build OpenCV

SamCarlberg approved these changes Sep 30, 2016

View reviewed changes

SamCarlberg merged commit 273959e into WPIRoboticsProjects:master Oct 3, 2016

		@@ -0,0 +1,8 @@
		public static void Switch(boolean sw, Object onTrue,Object onFalse, Object output){

Comments

Conversation

PatrickPenguinTurtle commented Jun 2, 2016 • edited by SamCarlberg Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-io commented Jun 2, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Current coverage is 55.09% (diff: 0.00%)

Uh oh!

SamCarlberg commented Jun 2, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PatrickPenguinTurtle commented Jun 2, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SamCarlberg commented Aug 29, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SamCarlberg commented Sep 8, 2016

Uh oh!

SamCarlberg commented Sep 13, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SamCarlberg Sep 22, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SamCarlberg Sep 22, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JLLeitschuh commented Oct 3, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

PatrickPenguinTurtle commented Jun 2, 2016 •

edited by SamCarlberg

Loading

codecov-io commented Jun 2, 2016 •

edited

Loading

SamCarlberg commented Jun 2, 2016 •

edited

Loading

SamCarlberg commented Aug 29, 2016 •

edited

Loading

SamCarlberg Sep 22, 2016 •

edited

Loading

SamCarlberg Sep 22, 2016 •

edited

Loading

JLLeitschuh commented Oct 3, 2016 •

edited

Loading