support functions, procedures, types in the parser

Author: PhilippSalvisberg

sqldev/src/main/java/org/utplsql/sqldev/model/parser/PlsqlObject.xtend

@@ -23,6 +23,7 @@ import org.utplsql.sqldev.model.ut.Annotation
 @Accessors
 class PlsqlObject extends AbstractModel {
 	String name
+	String type
 	Integer position
 	List<Annotation> annotations
 }

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

@@ -93,10 +93,11 @@ class UtplsqlParser {
 	}
 
 	private def populateObjects() {
-		val p = Pattern.compile("(?i)(\\s*)(create(\\s+or\\s+replace)?\\s+(package)\\s+(body\\s+)?)([^\\s]+)(\\s+)")
+		val p = Pattern.compile("(?i)(\\s*)(create(\\s+or\\s+replace)?\\s+(package|type|function|procedure)\\s+(body\\s+)?)([^\\s]+)(\\s+)")
 		val m = p.matcher(plsqlReduced)
 		while (m.find) {
 			val o = new PlsqlObject
+			o.type = m.group(4).toUpperCase
 			o.name = m.group(6)
 			o.position = m.start
 			objects.add(o)
@@ -145,22 +146,44 @@ class UtplsqlParser {
 			}
 		}
 	}
-	
-	private def getObjectAt(int position) {
+
+	/**
+	 * gets the PL/SQL object based on the current editor position
+	 * 
+	 * @param position the absolute position as used in {@link JTextComponent#getCaretPosition()}
+	 * @return the PL/SQL object
+	 */
+	def getObjectAt(int position) {
 		var PlsqlObject obj
 		for (o : objects) {
 			if (o.position <= position) {
 				obj = o
 			}
 		}
 		return obj
-	}	
-	
-	private def getObjectNameAt(int position) {
-		val o = getObjectAt(position)
-		return if (o !== null) {o.name} else {""}
 	}
 
+	/**
+	 * converts a line and column to a postion as used in as used in {@link JTextComponent#getCaretPosition()}
+	 * used for testing purposes only
+	 *
+	 * @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 position
+	 */	
+	def toPosition(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 (i + column)
+				}
+			}
+		}
+		throw new RuntimeException('''Line «line» not found.''')
+	}	
+	
 	private def getUnitNameAt(int position) {
 		var name = ""
 		for (u : units) {
@@ -190,33 +213,13 @@ class UtplsqlParser {
 	 * @return the utPLSQL path
 	 */
 	def getPathAt(int position) {
-		var objectName = getObjectNameAt(position)
-		if (!objectName.empty) {
+		var object = getObjectAt(position)
+		if (object !== null && object.type == "PACKAGE") {
 			var unitName = getUnitNameAt(position)
-			val path = '''«IF owner !== null»«owner».«ENDIF»«objectName.fixName»«IF !unitName.empty».«unitName.fixName»«ENDIF»'''
+			val path = '''«IF owner !== null»«owner».«ENDIF»«object.name.fixName»«IF !unitName.empty».«unitName.fixName»«ENDIF»'''
 			return path
 		}
 		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/tests/UtplsqlParserTest.xtend

@@ -86,14 +86,14 @@ class UtplsqlParserTest extends AbstractJdbcTest {
 		Assert.assertEquals('''"P"'''.toString, units.get(1).name)
 		Assert.assertTrue(units.get(0).position < units.get(1).position)
 		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.p", 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.P", parser.getPathAt(22,10))
-		Assert.assertEquals("SCOTT.PKG.P", parser.getPathAt(29,1))
+		Assert.assertEquals("", parser.getPathAt(parser.toPosition(3,6)))
+		Assert.assertEquals("pkg", parser.getPathAt(parser.toPosition(4,1)))
+		Assert.assertEquals("pkg.p", parser.getPathAt(parser.toPosition(10,33)))
+		Assert.assertEquals("pkg.p", parser.getPathAt(parser.toPosition(13,1)))
+		Assert.assertEquals("SCOTT.PKG.P", parser.getPathAt(parser.toPosition(19,1)))
+		Assert.assertEquals("SCOTT.PKG.P", parser.getPathAt(parser.toPosition(22,9)))
+		Assert.assertEquals("SCOTT.PKG.P", parser.getPathAt(parser.toPosition(22,10)))
+		Assert.assertEquals("SCOTT.PKG.P", parser.getPathAt(parser.toPosition(29,1)))
 	}
 
 	@Test
@@ -124,8 +124,8 @@ class UtplsqlParserTest extends AbstractJdbcTest {
 		parser = new UtplsqlParser(sqlScript, dataSource.connection, null)
 		Assert.assertEquals(2, parser.getObjects.size)
 		Assert.assertEquals(2, parser.getUnits.size)
-		Assert.assertEquals("pkg.p", parser.getPathAt(13,1))
-		Assert.assertEquals("SCOTT.PKG.P", parser.getPathAt(19,1))
+		Assert.assertEquals("pkg.p", parser.getPathAt(parser.toPosition(13,1)))
+		Assert.assertEquals("SCOTT.PKG.P", parser.getPathAt(parser.toPosition(19,1)))
 		setupAndTeardown
 	}
 
@@ -178,12 +178,12 @@ class UtplsqlParserTest extends AbstractJdbcTest {
 			end;
 		'''
 		val parser = new UtplsqlParser(plsql)
-		Assert.assertEquals("test_expect_not_to_be_null.cleanup_expectations", parser.getPathAt(7,1))
-		Assert.assertEquals("test_expect_not_to_be_null.create_types", parser.getPathAt(13,1))
+		Assert.assertEquals("test_expect_not_to_be_null.cleanup_expectations", parser.getPathAt(parser.toPosition(7,1)))
+		Assert.assertEquals("test_expect_not_to_be_null.create_types", parser.getPathAt(parser.toPosition(13,1)))
 		// was: '||gc_varray_name||'.drop_types
-		Assert.assertEquals("test_expect_not_to_be_null.drop_types", parser.getPathAt(23,1))
+		Assert.assertEquals("test_expect_not_to_be_null.drop_types", parser.getPathAt(parser.toPosition(23,1)))
 		// was: '||gc_varray_name||'.blob_not_null
-		Assert.assertEquals("test_expect_not_to_be_null.blob_not_null", parser.getPathAt(33,1))
+		Assert.assertEquals("test_expect_not_to_be_null.blob_not_null", parser.getPathAt(parser.toPosition(33,1)))
 	}
 
 	@Test
@@ -215,7 +215,89 @@ class UtplsqlParserTest extends AbstractJdbcTest {
 		'''
 		val parser = new UtplsqlParser(plsql)
 		// was: test_expect_not_to_be_null.create_types
-		Assert.assertEquals("test_expect_not_to_be_null.blob_not_null", parser.getPathAt(13,26))
+		Assert.assertEquals("test_expect_not_to_be_null.blob_not_null", parser.getPathAt(parser.toPosition(13,26)))
 	}
 
+	@Test
+	def testProcedure() {
+		val plsql = '''
+			create or replace procedure z
+			is
+			    null;
+			end;
+			/
+		'''
+		val parser = new UtplsqlParser(plsql)
+		Assert.assertEquals("z", parser.getObjectAt(0).name)
+		Assert.assertEquals("PROCEDURE", parser.getObjectAt(0).type)
+	}
+
+	@Test
+	def testFunction() {
+		val plsql = '''
+			create or replace procedure z
+			is
+			    null;
+			end;
+			/
+			
+			create or replace function f return number is
+			begin
+			   null;
+			end;
+			/
+		'''
+		val parser = new UtplsqlParser(plsql)
+		Assert.assertEquals("f", parser.getObjectAt(parser.toPosition(8,1)).name)
+		Assert.assertEquals("FUNCTION", parser.getObjectAt(parser.toPosition(8,1)).type)
+	}
+
+	@Test
+	def testType() {
+		val plsql = '''
+			create or replace type t force is
+			    object (
+			      a number,
+			      b number,
+			      c varchar2(10),
+			      member procedure p(self in t)
+			    )
+			end;
+			/
+		'''
+		val parser = new UtplsqlParser(plsql)
+		Assert.assertEquals("t", parser.getObjectAt(0).name)
+		Assert.assertEquals("TYPE", parser.getObjectAt(0).type)
+	}
+
+	@Test
+	def testTypeBody() {
+		val plsql = '''
+			create or replace type body t force is
+			   member procedure p(self in t) is
+			   begin
+			      null;
+			   end;
+			end;
+			/
+		'''
+		val parser = new UtplsqlParser(plsql)
+		Assert.assertEquals("t", parser.getObjectAt(0).name)
+		Assert.assertEquals("TYPE", parser.getObjectAt(0).type)
+	}
+
+	@Test
+	def testUnknown() {
+		val plsql = '''
+			create or replace unknown u is
+			begin
+			   null;
+			end;
+			/
+		'''
+		val parser = new UtplsqlParser(plsql)
+		Assert.assertEquals(null, parser.getObjectAt(0))
+	}
+
+
 }