Handle leading comments

Author: PhilippSalvisberg

sqldev/src/main/java/org/utplsql/sqldev/editor/menu/UtplsqlEditorController.xtend

@@ -45,7 +45,7 @@ class UtplsqlEditorController implements Controller {
 				val component = view.defaultFocusComponent
 				if (component instanceof JEditorPane) {
 					val parser = new UtplsqlParser(component.text)
-					if (!parser.getUtPlsqlCall(component.caretPosition).empty) {
+					if (!parser.getPathAt(component.caretPosition).empty) {
 						action.enabled = true
 					}
 				}
@@ -64,7 +64,7 @@ class UtplsqlEditorController implements Controller {
 				val parser = new UtplsqlParser(component.text)
 				val position = component.caretPosition
 				// TODO: open new worksheet and call utPLSQL
-				logger.fine('''Cursor is at «position». Calling «parser.getUtPlsqlCall(position)»''')
+				logger.fine('''Cursor is at «position». Calling «parser.getPathAt(position)»''')
 			}
 		}
 		logger.fine ("utPLSQL test started successfully.")

sqldev/src/main/java/org/utplsql/sqldev/parser/UtplsqlParser.xtend

@@ -16,34 +16,65 @@ package org.utplsql.sqldev.parser
 
 import java.util.ArrayList
 import java.util.regex.Pattern
-import org.utplsql.sqldev.model.parser.Unit
+import javax.swing.text.JTextComponent
 import org.utplsql.sqldev.model.parser.PlsqlObject
+import org.utplsql.sqldev.model.parser.Unit
 
 class UtplsqlParser {
 	private String plsql
+	private String plsqlWithoutComments
 	private ArrayList<PlsqlObject> objects = new ArrayList<PlsqlObject>
 	private ArrayList<Unit> units = new ArrayList<Unit>
 
 	new(String plsql) {
 		this.plsql = plsql
+		setPlsqlWithoutComments
 		populateObjects
 		populateUnits
 	}
 
-	private def populateObjects() {
-		val p = Pattern.compile("(?i)(\\s*)(create(\\s+or\\s+replace)?\\s+(package|type)\\s+(body\\s+)?)(.*?)(\\s+)", Pattern.DOTALL)
+	/**
+	 * replace multi-line and single-line PL/SQL comments with space
+	 * to simplify and improve performance of subsequent regex expressions 
+	 */
+	private def setPlsqlWithoutComments() {
+		val sb = new StringBuffer
+		val p = Pattern.compile("(/\\*(.|[\\r\\n])*?\\*/)|(--.*\\r?\\n)")
 		val m = p.matcher(plsql)
+		var pos = 0
+		while (m.find) {
+			if (pos < m.start) {
+				sb.append(plsql.substring(pos, m.start))
+			}
+			for (var i=m.start; i<m.end; i++) {
+				val c = plsql.substring(i, i+1)
+				if (c == "\n" || c == "\r") {
+					sb.append(c)
+				} else {
+					sb.append(" ")
+				}
+			}
+			pos = m.end
+		}
+		if (plsql.length > pos) {
+			sb.append(plsql.substring(pos, plsql.length))
+		}
+		plsqlWithoutComments=sb.toString
+	}
+	
+	private def populateObjects() {
+		val p = Pattern.compile("(?i)(\\s*)(create(\\s+or\\s+replace)?\\s+(package|type)\\s+(body\\s+)?)(.+?)(\\s+)")
+		val m = p.matcher(plsqlWithoutComments)
 		while (m.find) {
 			val o = new PlsqlObject
 			o.name = m.group(6)
 			o.position = m.start
 			objects.add(o)
 		}
 	}
-	
 	private def populateUnits() {
-		val p = Pattern.compile("(?i)(\\s*)(function|procedure)(\\s+)(.*?)(\\s+)", Pattern.DOTALL)
-		val m = p.matcher(plsql)
+		val p = Pattern.compile("(?i)(\\s*)(function|procedure)(\\s+)(.+?)(\\s+)")
+		val m = p.matcher(plsqlWithoutComments)
 		while (m.find) {
 			val u = new Unit
 			u.name = m.group(4)
@@ -55,7 +86,7 @@ class UtplsqlParser {
 	private def getObjectNameAt(int position) {
 		var name = ""
 		for (o : objects) {
-			if (o.position < position) {
+			if (o.position <= position) {
 				name = o.name
 			}
 		}
@@ -84,17 +115,43 @@ class UtplsqlParser {
 		return units
 	}
 
-	def getUtPlsqlCall(int position) {
+	/**
+	 * gets the utPLSQL path based on the current editor position
+	 * 
+	 * @param position the absolute position as used in {@link JTextComponent#getCaretPosition()}
+	 * @return the utPLSQL path
+	 */
+	def getPathAt(int position) {
 		var objectName = getObjectNameAt(position)
 		if (!objectName.empty) {
 			var unitName = getUnitNameAt(position)
 			if (unitName.empty) {
-				return '''ut.run('«objectName.removeQuotes»');'''
+				return objectName.removeQuotes
 			} else {
-				return '''ut.run('«objectName.removeQuotes».«unitName.removeQuotes»');'''
+				return '''«objectName.removeQuotes».«unitName.removeQuotes»'''
 			}
 		}
 		return ""
 	}
+	
+	/**
+	 * gets the utPLSQL path based on the current editor position
+	 *
+	 * @param line the line as used in SQL Developer, starting with 1
+	 * @param column the column as used in SQL Developer, starting with 1
+	 * @return the utPLSQL path
+	 */
+	def getPathAt(int line, int column) {
+		var lines=0
+		for (var i=0; i<plsql.length; i++) {
+			if (plsql.substring(i,i+1) == "\n") {
+				lines++
+				if (lines == line - 1) {
+					return getPathAt(i + column)
+				}
+			}
+		}
+		throw new RuntimeException('''Line «line» not found.''')
+	}
 
 }

sqldev/src/test/java/org/utplsql/sqldev/preferences/tests/UtplsqlParserTest.xtend

@@ -24,8 +24,17 @@ class UtplsqlParserTest {
 	@Test
 	def testPackage() {
 		val plsql = '''
-			--
+			PROMPT
+			PROMPT Install utPLSQL test package
+			PROMPT
+			
+			/*
+			 * some comment
+			 */
+			-- %suite
+			-- %rollback(manual)
 			CREATE OR REPLACE PACKAGE pkg IS
+			   -- %test
 			   PROCEDURE p (in_p1 INTEGER);
 			   FUNCTION f (in_p1 INTEGER) RETURN INTEGER;
 			END pkg;
@@ -37,6 +46,12 @@ class UtplsqlParserTest {
 			   BEGIN
 			      NULL;
 			   END p;
+			
+			   /* comment 1 */
+			   -- comment 2
+			   /* comment 3 */
+			   -- comment 4
+			
 			   FUNCTION "F" (in_p1 INTEGER) RETURN INTEGER IS
 			   BEGIN
 			      RETURN 1;
@@ -60,11 +75,14 @@ class UtplsqlParserTest {
 		Assert.assertTrue(units.get(0).position < units.get(1).position)
 		Assert.assertTrue(units.get(1).position < units.get(2).position)
 		Assert.assertTrue(units.get(2).position < units.get(3).position)
-		Assert.assertEquals("", parser.getUtPlsqlCall(0))
-		Assert.assertEquals("ut.run('pkg');", parser.getUtPlsqlCall(4))
-		Assert.assertEquals("ut.run('pkg.p');", parser.getUtPlsqlCall(66))
-		Assert.assertEquals("ut.run('pkg.f');", parser.getUtPlsqlCall(67))
-		Assert.assertEquals('''ut.run('SCOTT.PKG.P');'''.toString, parser.getUtPlsqlCall(185))
-		Assert.assertEquals('''ut.run('SCOTT.PKG.F');'''.toString, parser.getUtPlsqlCall(260))
+		Assert.assertEquals("", parser.getPathAt(0))
+		Assert.assertEquals("", parser.getPathAt(3,6))
+		Assert.assertEquals("pkg", parser.getPathAt(4,1))
+		Assert.assertEquals("pkg.p", parser.getPathAt(10,33))
+		Assert.assertEquals("pkg.f", parser.getPathAt(13,1))
+		Assert.assertEquals("SCOTT.PKG.P", parser.getPathAt(19,1))
+		Assert.assertEquals("SCOTT.PKG.P", parser.getPathAt(22,9))
+		Assert.assertEquals("SCOTT.PKG.F", parser.getPathAt(22,10))
+		Assert.assertEquals("SCOTT.PKG.F", parser.getPathAt(29,1))
 	}	
 }