[ios, macos] Added $lineProgress expression variable

Author: 1ec5

platform/darwin/docs/guides/For Style Authors.md.ejs

@@ -402,6 +402,7 @@ In style specification | Method, function, or predicate type | Format string syn
 `tan`                  | `mgl_tan:` | `mgl_tan(0)`
 `zoom`                 | `NSExpression.zoomLevelVariableExpression` | `$zoomLevel`
 `heatmap-density`      | `NSExpression.heatmapDensityVariableExpression` | `$heatmapDensity`
+`line-progress`        | `NSExpression.lineProgressVariableExpression` | `$lineProgress`
 
 For operators that have no corresponding `NSExpression` symbol, use the
 `MGL_FUNCTION()` format string syntax.

platform/darwin/docs/guides/Predicates and Expressions.md

@@ -290,6 +290,17 @@ The following variables are defined by this SDK for use with style layers:
       <code>NSExpression.zoomLevelVariableExpression</code> property.
    </td>
 </tr>
+<tr>
+   <td><code>$lineProgress</code></td>
+   <td>Number</td>
+   <td>
+      A number that indicates the relative distance along a line at a given
+      point along the line. This variable evaluates to 0 at the beginning of the
+      line and 1 at the end of the line. It can only be used with the
+      `MGLLineStyleLayer.lineGradient` property. It corresponds to the
+      <code>NSExpression.lineProgressVariableExpression</code> property.
+   </td>
+</tr>
 </tbody>
 </table>
 

platform/darwin/src/NSExpression+MGLAdditions.h

@@ -61,6 +61,13 @@ FOUNDATION_EXTERN MGL_EXPORT const MGLExpressionInterpolationMode MGLExpressionI
  */
 @property (class, nonatomic, readonly) NSExpression *heatmapDensityVariableExpression;
 
+/**
+ `NSExpression` variable that corresponds to the
+ <a href="https://www.mapbox.com/mapbox-gl-js/style-spec/#expressions-line-progress"><code>line-progress</code></a>
+ expression operator in the Mapbox Style Specification.
+ */
+@property (class, nonatomic, readonly) NSExpression *lineProgressVariableExpression;
+
 /**
  `NSExpression` variable that corresponds to the
  <a href="https://www.mapbox.com/mapbox-gl-js/style-spec/#eexpressions-geometry-type"><code>geometry-type</code></a>

platform/darwin/src/NSExpression+MGLAdditions.mm

@@ -542,6 +542,10 @@ + (NSExpression *)heatmapDensityVariableExpression {
     return [NSExpression expressionForVariable:@"heatmapDensity"];
 }
 
++ (NSExpression *)lineProgressVariableExpression {
+    return [NSExpression expressionForVariable:@"lineProgress"];
+}
+
 + (NSExpression *)geometryTypeVariableExpression {
     return [NSExpression expressionForVariable:@"geometryType"];
 }
@@ -814,6 +818,8 @@ + (instancetype)expressionWithMGLJSONObject:(id)object {
             return NSExpression.zoomLevelVariableExpression;
         } else if ([op isEqualToString:@"heatmap-density"]) {
             return NSExpression.heatmapDensityVariableExpression;
+        } else if ([op isEqualToString:@"line-progress"]) {
+            return NSExpression.lineProgressVariableExpression;
         } else if ([op isEqualToString:@"geometry-type"]) {
             return NSExpression.geometryTypeVariableExpression;
         } else if ([op isEqualToString:@"id"]) {
@@ -911,6 +917,9 @@ - (id)mgl_jsonExpressionObject {
             if ([self.variable isEqualToString:@"heatmapDensity"]) {
                 return @[@"heatmap-density"];
             }
+            if ([self.variable isEqualToString:@"lineProgress"]) {
+                return @[@"line-progress"];
+            }
             if ([self.variable isEqualToString:@"zoomLevel"]) {
                 return @[@"zoom"];
             }

platform/darwin/test/MGLExpressionTests.mm

@@ -170,6 +170,14 @@ - (void)testVariableExpressionObject {
         NSMutableDictionary *context = [@{@"heatmapDensity": @1} mutableCopy];
         XCTAssertEqualObjects([expression expressionValueWithObject:nil context:context], @1);
     }
+    {
+        NSExpression *expression = [NSExpression expressionForVariable:@"lineProgress"];
+        XCTAssertEqualObjects(expression.mgl_jsonExpressionObject, @[@"line-progress"]);
+        XCTAssertEqualObjects([NSExpression expressionWithFormat:@"$lineProgress"].mgl_jsonExpressionObject, @[@"line-progress"]);
+        XCTAssertEqualObjects([NSExpression expressionWithMGLJSONObject:@[@"line-progress"]], expression);
+        NSMutableDictionary *context = [@{@"lineProgress": @1} mutableCopy];
+        XCTAssertEqualObjects([expression expressionValueWithObject:nil context:context], @1);
+    }
     {
         NSExpression *expression = [NSExpression expressionForVariable:@"geometryType"];
         XCTAssertEqualObjects(expression.mgl_jsonExpressionObject, @[@"geometry-type"]);

platform/ios/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Mapbox welcomes participation and contributions from everyone. Please read [CONTRIBUTING.md](../../CONTRIBUTING.md) to get started.
 
+## master
+
+* Fixed a crash setting the `MGLLineStyleLayer.lineGradient` property to an expression containing the `$lineProgress` variable. Added an `NSExpression.lineProgressVariableExpression` class property that returns an expression for the `$lineProgress` variable. ([#13192](https://github.com/mapbox/mapbox-gl-native/pull/13192))
+
 ## 4.6.0
 
 ### Styles and rendering

platform/ios/docs/guides/For Style Authors.md

@@ -388,6 +388,7 @@ In style specification | Method, function, or predicate type | Format string syn
 `tan`                  | `mgl_tan:` | `mgl_tan(0)`
 `zoom`                 | `NSExpression.zoomLevelVariableExpression` | `$zoomLevel`
 `heatmap-density`      | `NSExpression.heatmapDensityVariableExpression` | `$heatmapDensity`
+`line-progress`        | `NSExpression.lineProgressVariableExpression` | `$lineProgress`
 
 For operators that have no corresponding `NSExpression` symbol, use the
 `MGL_FUNCTION()` format string syntax.

platform/macos/CHANGELOG.md

@@ -6,6 +6,7 @@
 
 * Added an `MGLSymbolStyleLayer.symbolZOrder` property for forcing point features in a symbol layer to be layered in the same order that they are specified in the layer’s associated source. ([#12783](https://github.com/mapbox/mapbox-gl-native/pull/12783))
 * Fixed a crash when a style layer `*-pattern` property evaluates to nil for a particular feature. ([#12896](https://github.com/mapbox/mapbox-gl-native/pull/12896))
+* Fixed a crash setting the `MGLLineStyleLayer.lineGradient` property to an expression containing the `$lineProgress` variable. Added an `NSExpression.lineProgressVariableExpression` class property that returns an expression for the `$lineProgress` variable. ([#13192](https://github.com/mapbox/mapbox-gl-native/pull/13192))
 * Fixed an issue where fill and line layers would occasionally flicker on zoom ([#12982](https://github.com/mapbox/mapbox-gl-native/pull/12982))
 
 ### Offline maps

platform/macos/docs/guides/For Style Authors.md

@@ -381,6 +381,7 @@ In style specification | Method, function, or predicate type | Format string syn
 `tan`                  | `mgl_tan:` | `mgl_tan(0)`
 `zoom`                 | `NSExpression.zoomLevelVariableExpression` | `$zoomLevel`
 `heatmap-density`      | `NSExpression.heatmapDensityVariableExpression` | `$heatmapDensity`
+`line-progress`        | `NSExpression.lineProgressVariableExpression` | `$lineProgress`
 
 For operators that have no corresponding `NSExpression` symbol, use the
 `MGL_FUNCTION()` format string syntax.