feat(model): Introduce a TextLocation.hasLineRange property

Note that although strictly speaking `!hasLineRange` equals

    startLine == UNKNOWN_LINE || endLine == UNKNOWN_LINE

instead of

    startLine == UNKNOWN_LINE && endLine == UNKNOWN_LINE

the `TextLocation` constructors ensures that not only either `startLine`
or `endLine` can be `UNKNOWN_LINE`, but always both of them.

Also, `isFullFileLocation()` was not completely removed (yet) to not
break existing templates.

Signed-off-by: Sebastian Schuberth <[email protected]>

Author: sschuberth

model/src/main/kotlin/TextLocation.kt

@@ -19,6 +19,8 @@
 
 package org.ossreviewtoolkit.model
 
+import com.fasterxml.jackson.annotation.JsonIgnore
+
 import java.io.File
 
 import kotlin.math.abs
@@ -65,6 +67,12 @@ data class TextLocation(
      */
     constructor(path: String, line: Int) : this(path, line, line)
 
+    /**
+     * Indicate whether this TextLocation has known start and end lines.
+     */
+    @JsonIgnore
+    val hasLineRange = startLine != UNKNOWN_LINE && endLine != UNKNOWN_LINE
+
     /**
      * Return a negative integer, zero, or a positive integer as this TextLocation comes before, is the same, or comes
      * after the [other] TextLocation.

plugins/reporters/freemarker/src/main/kotlin/FreemarkerTemplateProcessor.kt

@@ -343,8 +343,7 @@ class FreemarkerTemplateProcessor(
          * Return a flag if the given [sourceLocation] refers to the full source file.
          */
         @Suppress("unused") // This function is used in the templates.
-        fun isFullFileLocation(sourceLocation: TextLocation) =
-            sourceLocation.startLine == TextLocation.UNKNOWN_LINE && sourceLocation.endLine == TextLocation.UNKNOWN_LINE
+        fun isFullFileLocation(sourceLocation: TextLocation) = !sourceLocation.hasLineRange
 
         /**
          * Collect all the licenses present in a collection of [SnippetFinding]s.

plugins/scanners/fossid/src/main/kotlin/FossIdScanResults.kt

@@ -455,8 +455,8 @@ private fun urlToPackageType(url: String): PurlType =
     }
 
 internal fun TextLocation.prettyPrint(): String =
-    if (startLine == TextLocation.UNKNOWN_LINE && endLine == TextLocation.UNKNOWN_LINE) {
-        "$path#FULL"
-    } else {
+    if (hasLineRange) {
         "$path#$startLine-$endLine"
+    } else {
+        "$path#FULL"
     }