did a wee bit of cleanup for dev release

Author: kazimuth

README.md

@@ -13,6 +13,9 @@ To install: unzip PythonMode.zip into "{your sketch folder}/modes/PythonMode" an
 
 Check build.xml for building instructions.
 
+Changes:
+- the Processing set() function is now called setPixel(), because python
+
 Done:
 - Basic functionality- running python code
 - Basic indentation & highlighting

release/PythonMode.zip

@@ -176,8 +176,14 @@ UP	LITERAL2	keyCode
 WAIT	LITERAL2	cursor_
 WHITESPACE	LITERAL2		
 
+# Python literals
+None	LITERAL2
+True	LITERAL2
+False	LITERAL2
+Ellipsis	LITERAL2
+NotImplemented LITERAL2
 
-# Java [python] keywords (void, import, , etc.)
+# Python keywords
 
 and	KEYWORD1	
 as	KEYWORD1
@@ -427,7 +433,7 @@ keyArray	FUNCTION2	FloatDict_keyArray_
 keys	FUNCTION2	FloatDict_keys_
 mult	FUNCTION2	FloatDict_mult_
 remove	FUNCTION2	FloatDict_remove_
-set	FUNCTION2	FloatDict_set_
+setPixel	FUNCTION2	FloatDict_set_
 size	FUNCTION2	FloatDict_size_
 sortKeys	FUNCTION2	FloatDict_sortKeys_
 sortKeysReverse	FUNCTION2	FloatDict_sortKeysReverse_

resources/keywords.txt

@@ -12,8 +12,8 @@
 
 /**
  * 
- * The glue between the PDE process and the sketch process Handles sending
- * messages to and recieving messages from
+ * A class that sends data to and gets data from the running sketch process.
+ * Sends start signals, stop signals, and sketches.
  * 
  */
 

resources/prepend-commented.py

@@ -24,8 +24,6 @@
  * interpreter, all this does is handle preprocessing and write to an output
  * file.
  * 
- * See BUILD.md for notes.
- * 
  */
 
 public class PythonBuild {
@@ -41,7 +39,7 @@ public class PythonBuild {
 
 	boolean usesOpenGL;
 
-	//build tracking
+	//build tracking, not that this actually does anything
 	private int buildnumber;
 	private static int buildstotal = 0;
 
@@ -57,9 +55,9 @@ public PythonBuild(Sketch sketch, PythonMode mode) {
 	 * Preprocess the sketch- turn the .pde files into valid python.
 	 */
 	public void build() throws Exception {
+		//to hold all the code
 		StringBuilder program = new StringBuilder();
-
-		SketchCode[] parts = sketch.getCode(); //fix'd
+		SketchCode[] parts = sketch.getCode();
 
 		//concatenate code strings
 		//TODO do this in some sort of vaguely intelligent way
@@ -68,11 +66,13 @@ public void build() throws Exception {
 			program.append(parts[i].getProgram());
 		}
 
+		//send to preprocessor
 		resultProgram = preprocess(program);
 
-		//write output file
+		//create output folder
 		binFolder = sketch.makeTempFolder();
 
+		//create & write to output file
 		outFile = new File(binFolder.getAbsolutePath() + File.separator + sketch.getName().toLowerCase() + ".py");
 		outFile.createNewFile();
 
@@ -81,17 +81,18 @@ public void build() throws Exception {
 		writer.close();
 	}
 
-	private static Pattern whitespace = Pattern.compile("\\s*");
-
 	/*
-	 * Turn .pde into valid python Now with antlr!
+	 * Turn .pde files into valid python and extract used libraries See
+	 * PyPdeConverter / generated antlr code for the actual preprocessing logic.
 	 */
 	private String preprocess(StringBuilder program) throws Exception {
-		if (whitespace.matcher(program).matches()) {
-			return "def setup():\n\tpass\n\n"; //empty sketch; TODO fix hack
+		if (Pattern.matches("\\s*", program)) {
+			return "def setup():\n\tpass\n\n";
 		}
 		try {
 			program.append("\n"); //to be safe
+
+			//now for the antlr
 			PyPdeLexer lexer = new PyPdeLexer(new ANTLRInputStream(program.toString()));
 			CommonTokenStream tokens = new CommonTokenStream(lexer);
 			PyPdeParser parser = new PyPdeParser(tokens);
@@ -118,7 +119,8 @@ private String preprocess(StringBuilder program) throws Exception {
 					String entry = (dot == -1) ? lib : lib.substring(0, dot);
 					Library library = mode.getLibrary(entry);
 					if (library == null) {
-						throw new Exception("Unknown library: " + lib);
+						System.err.println("I don't know about the library "+lib+" so it might not work. Sorry.");
+						continue;
 					}
 					javaLibs += library.getJarPath() + System.getProperty("path.separator");
 				}
@@ -139,6 +141,9 @@ private String preprocess(StringBuilder program) throws Exception {
 		}
 	}
 
+	/*
+	 * Access to extracted library information
+	 */
 	public String getJavaLibraries() {
 		return javaLibs;
 	}
@@ -156,7 +161,7 @@ public boolean hasPythonLibraries() {
 	}
 
 	/*
-	 * The output code string
+	 * The output code string, properly formatted and whatnot.
 	 */
 	public String getResultString() {
 		return resultProgram;
@@ -170,25 +175,29 @@ public String getResultFile() {
 	}
 
 	/*
-	 * 
+	 * This may eventually tie in to some global thing... or not
 	 */
 	public int getBuildNumber() {
 		return buildnumber;
 	}
 
 	/*
-	 * Classes used to run the build.
+	 * Java classes used to run the build.
 	 */
 	public String getClassPath() {
 		return classPath; //computed during preprocessing
 	}
 
+	/*
+	 * ...
+	 */
 	public String getName() {
 		return sketch.getName();
 	}
 
 	/*
-	 * TODO
+	 * I'm not sure what the java library path actually is, so, leaving this
+	 * blank.
 	 */
 	public String getJavaLibraryPath() {
 		return "";

src/info/sansgills/mode/python/Communicator.java

@@ -19,8 +19,10 @@
 
 /**
  * 
- * Main editor. Superclass handles most of the nitty-gritty; we just have to
- * manage python-specific things, like running and stopping.
+ * The main editor class. Unlike in Java Mode the editor also handles running and exporting code,
+ * because I'm lazy.
+ * 
+ * Does basically what you'd expect it to.
  * 
  */
 @SuppressWarnings("serial")

src/info/sansgills/mode/python/PythonBuild.java

@@ -5,6 +5,7 @@
 /**
  * 
  * Class used when the user selects the 'format' option from the menu.
+ * Currently does absolutely nothing.
  * 
  */
 

src/info/sansgills/mode/python/PythonEditor.java

@@ -37,9 +37,9 @@ public PythonKeyListener(Editor editor, JEditTextArea textarea) {
 
 	/*
 	 * Handles special stuff for Java brace indenting & outdenting, etc.
-	 * Overriding it 'cause we do things different here in python-land TODO use
-	 * actual parser; handle spaces
-	 * @return true if we've handled things correctly
+	 * Overriding it 'cause we do things different here in python-land 
+	 * TODO use actual parser; handle spaces
+	 * 
 	 */
 	@Override
 	public boolean keyPressed(KeyEvent event) {

src/info/sansgills/mode/python/PythonFormat.java

@@ -10,7 +10,8 @@
 
 /**
  * 
- * Python Mode. Yeah.
+ * The main mode class. I don't actually implement much functionality here; just
+ * what the Mode class is contractually obligated to provide.
  * 
  */
 public class PythonMode extends Mode {

src/info/sansgills/mode/python/PythonKeyListener.java

@@ -13,6 +13,8 @@
  * Class to handle the running of sketches. Starts a new ProcessingJythonWrapper
  * process and interfaces between it and the PDE.
  * 
+ * Synchronization is a horrible tangled mess and I don't remember how it works.
+ * 
  */
 
 public class PythonRunner {

src/info/sansgills/mode/python/PythonMode.java

@@ -17,7 +17,6 @@
  * 
  */
 
-//something up the chain is serializable, damned if I know why
 @SuppressWarnings("serial")
 public class PythonToolbar extends EditorToolbar {
 

src/info/sansgills/mode/python/PythonRunner.java

@@ -1,14 +1,15 @@
 /*
- * To change this template, choose Tools | Templates
- * and open the template in the editor.
+ * A fairly complete python2.7 parser, written with ANTLR4.
+ * Uses some ANTLR black magic to handle lexing indents & dedents, which parsers don't like.
  */
 
 grammar PyPde;
 
+//these are injected into the headers of the generated parser & lexer.
 @parser::header {
                  package info.sansgills.mode.python.preproc;
                  }
-
+                 
 @lexer::header {
                 package info.sansgills.mode.python.preproc;
                 
@@ -20,7 +21,7 @@ grammar PyPde;
                 import org.antlr.v4.runtime.misc.Interval;
                 }
 
-//some black magic
+//this is injected into the generated lexer. It overrides ANTLR's default 'go to next token' method in order to handle *dents.
 @lexer::members {
                  int bracket_nesting_level = 0;
                  int parenth_nesting_level = 0;
@@ -109,12 +110,15 @@ grammar PyPde;
                  }
                  }
 
+//and on the the actual parser.
+//essentially copied from http://docs.python.org/2/reference/, and probably quite inefficient.
+
 
 script: (NEWLINE | statement)*;
 
 
 //lexer!
-//strings first, so they'll gobble things up first
+//strings first, so they'll gobble things up
 
 STRING: STRINGPREFIX? (SHORTSTRING | LONGSTRING);
 fragment SHORTSTRING: '\'' (~('\\'|'\n'|'\'')|'\\'.)* '\'' 
@@ -203,7 +207,7 @@ WS: [ \t]+ -> channel(HIDDEN);
 
 
 // onto the parser
-// atomic values: identifiers and literals (including enclodure literals
+// atomic values: identifiers and literals (including enclosure literals)
 atom      :  identifier | literal | enclosure;
 
 literal:    STRING | INTEGER | IMAGINARY | FLOAT;