Fix and document one-based argument indexing in StringFormat's getAnArgUsageOffset

smowton · smowton · commit 0f2139ff5d24 · 2021-06-17T11:41:06.000+01:00
diff --git a/java/ql/src/semmle/code/java/StringFormat.qll b/java/ql/src/semmle/code/java/StringFormat.qll
@@ -368,7 +368,7 @@ class FormatString extends string {
   /*abstract*/ int getASkippedFmtSpecIndex() { none() }
 
   /**
-   * Gets an offset in this format string where argument `argNo` will be interpolated, if any.
+   * Gets an offset (zero-based) in this format string where argument `argNo` (1-based) will be interpolated, if any.
    */
   int getAnArgUsageOffset(int argNo) { none() }
 }
@@ -451,7 +451,6 @@ private class PrintfFormatString extends FormatString {
   override int getAnArgUsageOffset(int argNo) {
     argNo = fmtSpecRefersToSpecificIndex(result)
     or
-    fmtSpecRefersToSequentialIndex(result) and
     result = rank[argNo](int i | fmtSpecRefersToSequentialIndex(i))
     or
     fmtSpecRefersToPrevious(result) and
@@ -485,8 +484,5 @@ private class LoggerFormatString extends FormatString {
 
   override int getMaxFmtSpecIndex() { result = count(int i | fmtPlaceholder(i)) }
 
-  override int getAnArgUsageOffset(int argNo) {
-    fmtPlaceholder(result) and
-    argNo = count(int i | fmtPlaceholder(i) and i < result)
-  }
+  override int getAnArgUsageOffset(int argNo) { result = rank[argNo](int i | fmtPlaceholder(i)) }
 }
