cnescatlab#150 Localization of the SH.SYNC.Signals rule

Author: brigittehuynh

fr.cnes.analysis.tools.shell.rules/lex/SHSYNCSignals.lex

@@ -18,12 +18,15 @@ import java.io.FileNotFoundException;
 import java.io.FileReader;
 import java.io.File;
 import java.util.List;
+import java.util.EmptyStackException;
+import java.util.Stack;
 
 import org.eclipse.core.runtime.Path;
 
 import fr.cnes.analysis.tools.analyzer.datas.AbstractChecker;
 import fr.cnes.analysis.tools.analyzer.datas.CheckResult;
 import fr.cnes.analysis.tools.analyzer.exception.JFlexException;
+import fr.cnes.analysis.tools.shell.metrics.Function;
 
 %%
 
@@ -39,23 +42,38 @@ import fr.cnes.analysis.tools.analyzer.exception.JFlexException;
 %type List<CheckResult>
 
 
-%state COMMENT, NAMING, TRAP
+%state COMMENT, NAMING, TRAP, BEGINFUNC, STRING_SIMPLE, STRING_DOUBLE
 
 COMMENT_WORD = \#
 FUNCTION     = "function"
 FUNCT		 = {FNAME}{SPACE}*[\(]{SPACE}*[\)]
 FNAME		 = [a-zA-Z0-9\.\!\-\_\@\?\+]+
 SPACE		 = [\ \r\t\f]
 VAR		     = [a-zA-Z][a-zA-Z0-9\_]*
-STRING		 = \'[^\']*\' | \"[^\"]*\"
+
+STRING_D		= \"
+IGNORE_STRING_D = [\\][\"]
+STRING_S	 	= \'
+IGNORE_STRING_S = [\\][\']
 
 TRAP		 = "trap"
 
+FUNCSTART		= \{ | \( | \(\( | \[\[ | "if" | "case" | "select" | "for" | "while" | "until"
+FUNCEND			= \} | \) | \)\) | \]\] | "fi" | "esac" | "done"
 
 %{
-	String location = "MAIN PROGRAM";
+	/* MAINPROGRAM: constant for main program localisation */
+    private static final String MAINPROGRAM = "MAIN PROGRAM";
+	
+	String location = MAINPROGRAM;
+
     private String parsedFileName;
 
+	/* functionLine: the beginning line of the function */
+	int functionLine = 0;
+
+	private Stack<Function> functionStack = new Stack<>();
+	
     public SHSYNCSignals() {
 
     }
@@ -67,7 +85,25 @@ TRAP		 = "trap"
         this.parsedFileName = file.toString();
         this.zzReader = new FileReader(new Path(file.getAbsolutePath()).toOSString());
 	}
-			
+
+	private void endLocation() throws JFlexException {
+		try{
+		    Function functionFinished = functionStack.pop();
+			if (!functionStack.empty()) {
+				/* there is a current function: change location to this function */
+				location = functionStack.peek().getName();
+			} else {
+				/* we are in the main program: change location to main */
+				location = MAINPROGRAM;
+			}
+		}catch(EmptyStackException e){
+        		final String errorMessage = e.getMessage();
+            	throw new JFlexException(this.getClass().getName(), parsedFileName,
+        errorMessage, yytext(), yyline, yycolumn);
+		}
+	}	
+	
+	
 %}
 
 %eofval{
@@ -98,7 +134,7 @@ TRAP		 = "trap"
 /************************/
 <NAMING>   	
 		{
-				{FNAME}			{location = yytext(); yybegin(YYINITIAL);}
+				{FNAME}			{location = yytext(); functionLine = yyline+1; yybegin(BEGINFUNC);}
 				\n             	{yybegin(YYINITIAL);}  
 			   	.              	{}
 		}
@@ -110,8 +146,30 @@ TRAP		 = "trap"
 		{
 			  	{COMMENT_WORD} 	{yybegin(COMMENT);}
 				{FUNCTION}     	{yybegin(NAMING);}
-				{FUNCT}			{location = yytext().substring(0,yytext().length()-2).trim(); }
-			    {STRING}		{}
+				{FUNCT}			{functionLine = yyline+1; 
+								 location = yytext().substring(0,yytext().length()-2).trim(); 
+								 yybegin(BEGINFUNC);
+								}
+				{FUNCSTART}		{
+									if(!functionStack.empty()){
+										if(functionStack.peek().getFinisher().equals(Function.finisherOf(yytext()))){
+											functionStack.peek().addStarterRepetition();
+										}
+									} 
+		      					}
+	      		{FUNCEND}		{
+									if(!functionStack.empty()){
+		      							if(functionStack.peek().isFinisher(yytext())){
+		      								if(functionStack.peek().getStarterRepetition()>0) {
+	      									    functionStack.peek().removeStarterRepetition();
+		      								} else {
+		      									endLocation();
+		      								}
+										}
+									}
+		      					}
+				{STRING_D}		{yybegin(STRING_DOUBLE);}
+				{STRING_S}		{yybegin(STRING_SIMPLE);}
 			    {TRAP}			{yybegin(TRAP);}
 	      		[^]         	{}
 		}
@@ -127,7 +185,50 @@ TRAP		 = "trap"
 			   	.              	{}
 		}
 
+/************************/
+/* BEGINFUNC STATE	    */
+/************************/
+/*
+ * This state target is to retrieve the function starter. For more information on fonction starter, have a look on {@link Function} class.
+ * Pending this starter, the function ender can be defined.
+ *
+ */ 
+<BEGINFUNC>
+		{
+				\(\)			{}
+				{FUNCSTART}		{
+									Function function;
+									function = new Function(location, functionLine, yytext());
+									functionStack.push(function);
+								 	yybegin(YYINITIAL);
+							 	}
+			   	[^]|{SPACE}  {}
+		}
+
+/*
+ * The string states are designed to avoid problems due to patterns found in strings.
+ */ 
+/************************/
+/* STRING_SIMPLE STATE	    */
+/************************/
+<STRING_SIMPLE>   	
+		{
+				{IGNORE_STRING_S}	{}
+				{STRING_S}    		{yybegin(YYINITIAL);}  
+		  	 	[^]|{SPACE}  		{}
+		}
 
+/************************/
+/* STRING_DOUBLE STATE	    */
+/************************/
+<STRING_DOUBLE>   	
+		{
+				{IGNORE_STRING_D}	{}
+				{STRING_D}    		{yybegin(YYINITIAL);}  
+		  	 	[^]|{SPACE}  		{}
+		}		
+
+		
 /************************/
 /* ERROR STATE	        */
 /************************/

tests/fr.cnes.analysis.tools.shell.rules.test/src/fr/cnes/analysis/tools/shell/rules/SH/SYNC/Signals/TestSHSYNCSignals.java

@@ -36,7 +36,7 @@ public class TestSHSYNCSignals {
 	public final static String ERROR_FILE = "error.sh";
 	public final static String NO_ERROR_FILE = "noError.sh";
 	public final static int[] LINES = { 57 };
-	public final static String[] LOCATIONS = { "nettoie" };
+	public final static String[] LOCATIONS = { "MAIN PROGRAM" };
 	public final AbstractChecker rule = new SHSYNCSignals();
 
 	/**