added a PosHelper to help with correcting positions

e.g. only mark function signature instead of whole function incl. body

Author: AlexHaxe

src/checkstyle/checks/coding/ReturnCountCheck.hx

@@ -1,5 +1,7 @@
 package checkstyle.checks.coding;
 
+import checkstyle.utils.PosHelper;
+
 /**
 	Restricts the number of return statements in methods (2 by default). Ignores methods that matches "ignoreFormat" regex property.
 **/
@@ -36,10 +38,10 @@ class ReturnCountCheck extends Check {
 				default:
 			}
 			if (isPosSuppressed(fn.pos)) continue;
-			if (!fn.hasChildren()) throw "function has invalid structure!";
+			if (!fn.hasChildren()) continue;
 			var returns = fn.filterCallback(filterReturns);
 			if (returns.length > max) {
-				logPos('Return count is ${returns.length} (max allowed is ${max})', fn.pos);
+				logPos('Return count is ${returns.length} (max allowed is ${max})', PosHelper.getReportPos(fn));
 			}
 		}
 	}

src/checkstyle/checks/comments/FieldDocCommentCheck.hx

@@ -1,6 +1,7 @@
 package checkstyle.checks.comments;
 
 import checkstyle.checks.comments.TypeDocCommentCheck.TypeDocCommentToken;
+import checkstyle.utils.PosHelper;
 
 /**
 	Checks code documentation on type level
@@ -121,7 +122,7 @@ class FieldDocCommentCheck extends Check {
 		var prevToken:TokenTree = token.previousSibling;
 
 		if (prevToken == null || !prevToken.isComment()) {
-			logPos('Field "$name" should have documentation', getReportPos(token));
+			logPos('Field "$name" should have documentation', PosHelper.getReportPos(token));
 			return;
 		}
 		switch (prevToken.tok) {
@@ -131,29 +132,6 @@ class FieldDocCommentCheck extends Check {
 		}
 	}
 
-	/**
-		report function signature not body
-		@param token function or var token
-		@return Position token position without body
-	**/
-	public static function getReportPos(token:TokenTree):Position {
-		var pos:Position = token.getPos();
-		var body:Null<TokenTree> = token.access().firstChild().firstOf(POpen).token;
-		if (body == null) return pos;
-		body = body.nextSibling;
-		if (body == null) return pos;
-		switch (body.tok) {
-			case BrOpen:
-			case DblDot:
-				body = body.nextSibling;
-			default:
-				return pos;
-		}
-		if (body == null) return pos;
-		pos.max = body.pos.min;
-		return pos;
-	}
-
 	function checkIgnoreOverride(token:TokenTree):Bool {
 		if (!ignoreOverride) return false;
 		var ignoreTokens:Array<TokenTree> = token.filter([Kwd(KwdOverride)], FIRST);

src/checkstyle/checks/modifier/RedundantModifierCheck.hx

@@ -1,5 +1,7 @@
 package checkstyle.checks.modifier;
 
+import checkstyle.utils.PosHelper;
+
 /**
 	Checks for redundant modifiers.
 	Omitting the visibility modifier usually defaults the visibility to "private" in normal classes and "public" in interfaces and externs.
@@ -51,13 +53,13 @@ class RedundantModifierCheck extends Check {
 		var redundantCode:String = isDefaultPrivate ? REDUNDANT_PRIVATE : REDUNDANT_PUBLIC;
 		if (!f.access.contains(APublic) && !f.access.contains(APrivate)) {
 			if ((!isDefaultPrivate && forcePublic) || (isDefaultPrivate && forcePrivate)) {
-				logPos('Missing "$implicitAccess" keyword for "${f.name}"', f.pos, missingCode);
+				logPos('Missing "$implicitAccess" keyword for "${f.name}"', PosHelper.makeFieldSignaturePosition(f), missingCode);
 			}
 		}
 
 		if ((!forcePrivate && isDefaultPrivate && f.access.contains(APrivate))
 			|| (!forcePublic && !isDefaultPrivate && f.access.contains(APublic))) {
-			logPos('"$implicitAccess" keyword is redundant for "${f.name}"', f.pos, redundantCode);
+			logPos('"$implicitAccess" keyword is redundant for "${f.name}"', PosHelper.makeFieldSignaturePosition(f), redundantCode);
 		}
 	}
 

src/checkstyle/checks/size/MethodLengthCheck.hx

@@ -1,7 +1,7 @@
 package checkstyle.checks.size;
 
-import checkstyle.checks.comments.FieldDocCommentCheck;
 import checkstyle.checks.whitespace.ListOfEmptyLines;
+import checkstyle.utils.PosHelper;
 
 /**
 	Checks for long methods. If a method becomes very long it is hard to understand.
@@ -57,7 +57,7 @@ class MethodLengthCheck extends Check {
 				case _:
 			}
 		}
-		if (len > max) warnFunctionLength(len, name, FieldDocCommentCheck.getReportPos(token));
+		if (len > max) warnFunctionLength(len, name, PosHelper.getReportPos(token));
 	}
 
 	function getLineCount(lmin:Int, lmax:Int, emptyLines:ListOfEmptyLines):Int {

src/checkstyle/checks/size/ParameterNumberCheck.hx

@@ -1,5 +1,7 @@
 package checkstyle.checks.size;
 
+import checkstyle.utils.PosHelper;
+
 /**
 	Checks the number of parameters of a method.
 **/
@@ -35,7 +37,7 @@ class ParameterNumberCheck extends Check {
 		switch (f.kind) {
 			case FFun(fun):
 				if ((fun.args != null) && (fun.args.length > max)) {
-					warnMaxParameter(f.name, f.pos);
+					warnMaxParameter(f.name, PosHelper.makeFieldSignaturePosition(f));
 				}
 			default:
 		}

src/checkstyle/utils/PosHelper.hx

@@ -0,0 +1,44 @@
+package checkstyle.utils;
+
+class PosHelper {
+	/**
+		make a position for AST based checks that only holds function signature
+		@param field determine position for field
+		@return Position position that holds function signature
+	**/
+	public static function makeFieldSignaturePosition(field:Field):Position {
+		var pos:Position = {file: field.pos.file, min: field.pos.min, max: field.pos.max};
+		switch (field.kind) {
+			case FFun(fun):
+				if (fun.expr != null) {
+					pos.max = fun.expr.pos.min;
+				}
+			case FVar(_):
+			case FProp(_):
+		}
+		return pos;
+	}
+
+	/**
+		report function signature not body
+		@param token function or var token
+		@return Position token position without body
+	**/
+	public static function getReportPos(token:TokenTree):Position {
+		var pos:Position = token.getPos();
+		var body:Null<TokenTree> = token.access().firstChild().firstOf(POpen).token;
+		if (body == null) return pos;
+		body = body.nextSibling;
+		if (body == null) return pos;
+		switch (body.tok) {
+			case BrOpen:
+			case DblDot:
+				body = body.nextSibling;
+			default:
+				return pos;
+		}
+		if (body == null) return pos;
+		pos.max = body.pos.min;
+		return pos;
+	}
+}