Include exit number in off-ramp instructions

Added TokenType.exitCode. Renamed TokenType.exit to exitIndex for clarity. Use the exit and exit_destination instructions if an exit code is present.

Author: 1ec5

OSRMTextInstructions/OSRMTextInstructions.swift

@@ -212,7 +212,11 @@ public class OSRMInstructionFormatter: Formatter {
         // Decide which instruction string to use
         // Destination takes precedence over name
         var instruction: String
-        if let _ = step.destinations, let obj = instructionObject["destination"] {
+        if let _ = step.destinations, let _ = step.exitCodes?.first, let obj = instructionObject["exit_destination"] {
+            instruction = obj
+        } else if let _ = step.destinations, let obj = instructionObject["destination"] {
+            instruction = obj
+        } else if let _ = step.exitCodes?.first, let obj = instructionObject["exit"] {
             instruction = obj
         } else if !wayName.isEmpty, let obj = instructionObject["name"] {
             instruction = obj
@@ -225,10 +229,11 @@ public class OSRMInstructionFormatter: Formatter {
         if let legIndex = legIndex, let numberOfLegs = numberOfLegs, legIndex != numberOfLegs - 1 {
             nthWaypoint = ordinalFormatter.string(from: (legIndex + 1) as NSNumber)
         }
+        let exitCode = step.exitCodes?.first ?? ""
         let destination = step.destinations?.first ?? ""
-        var exit: String = ""
+        var exitOrdinal: String = ""
         if let exitIndex = step.exitIndex, exitIndex <= 10 {
-            exit = ordinalFormatter.string(from: exitIndex as NSNumber)!
+            exitOrdinal = ordinalFormatter.string(from: exitIndex as NSNumber)!
         }
         let modifierConstants = constants["modifier"] as! [String: String]
         let modifierConstant = modifierConstants[modifier ?? "straight"]!
@@ -260,7 +265,8 @@ public class OSRMInstructionFormatter: Formatter {
                     switch tokenType {
                     case .wayName: replacement = wayName
                     case .destination: replacement = destination
-                    case .exit: replacement = exit
+                    case .exitCode: replacement = exitCode
+                    case .exitIndex: replacement = exitOrdinal
                     case .rotaryName: replacement = rotaryName
                     case .laneInstruction: replacement = laneInstruction ?? ""
                     case .modifier: replacement = modifierConstant

OSRMTextInstructions/TokenType.swift

@@ -6,7 +6,8 @@ public enum TokenType: Int, CustomStringConvertible {
     case wayName
     case destination
     case rotaryName
-    case exit
+    case exitCode
+    case exitIndex
     case laneInstruction
     case modifier
     case direction
@@ -21,8 +22,10 @@ public enum TokenType: Int, CustomStringConvertible {
             type = .destination
         case "rotary_name":
             type = .rotaryName
+        case "exit":
+            type = .exitCode
         case "exit_number":
-            type = .exit
+            type = .exitIndex
         case "lane_instruction":
             type = .laneInstruction
         case "modifier":
@@ -45,7 +48,9 @@ public enum TokenType: Int, CustomStringConvertible {
             return "destination"
         case .rotaryName:
             return "rotary_name"
-        case .exit:
+        case .exitCode:
+            return "exit"
+        case .exitIndex:
             return "exit_number"
         case .laneInstruction:
             return "lane_instruction"

OSRMTextInstructionsTests/OSRMTextInstructionsTests.swift

@@ -86,6 +86,9 @@ class OSRMTextInstructionsTests: XCTestCase {
         if let ref = jsonStep["ref"] {
             step["ref"] = ref
         }
+        if let exits = jsonStep["exits"] {
+            step["exits"] = exits
+        }
         if let destinations = jsonStep["destinations"] {
             step["destinations"] = destinations
         }