added providers to Parser // implemented provider for templates // adjusted tests

Author: benni-tec

packages/tiled/lib/src/layer.dart

@@ -112,7 +112,7 @@ abstract class Layer {
     this.properties = CustomProperties.empty,
   });
 
-  static Layer parse(Parser parser) {
+  static Layer parse(Parser parser, {List<ParserProvider>? templateProviders}) {
     final type = parser.formatSpecificParsing(
       (json) => json.getLayerType('type'),
       (xml) => LayerTypeExtension.parseFromTmx(xml.element.name.toString()),
@@ -272,7 +272,10 @@ abstract class Layer {
 
   static List<Layer> parseLayers(Parser parser) {
     return parser.formatSpecificParsing(
-      (json) => json.getChildrenAs('layers', Layer.parse),
+      (json) => json.getChildrenAs(
+        'layers',
+        Layer.parse,
+      ),
       (xml) {
         // It's very important not change the order of the layers
         // during parsing!

packages/tiled/lib/src/objects/tiled_object.dart

@@ -59,7 +59,9 @@ class TiledObject {
   bool point;
   bool rectangle;
 
+  String? templatePath;
   Template? template;
+
   Text? text;
   bool visible;
 
@@ -84,6 +86,7 @@ class TiledObject {
     this.ellipse = false,
     this.point = false,
     this.rectangle = false,
+    this.templatePath,
     this.template,
     this.text,
     this.visible = true,
@@ -93,12 +96,17 @@ class TiledObject {
   });
 
   bool get isPolyline => polyline.isNotEmpty;
+
   bool get isPolygon => polygon.isNotEmpty;
+
   bool get isPoint => point;
+
   bool get isEllipse => ellipse;
+
   bool get isRectangle => rectangle;
 
-  factory TiledObject.parse(Parser parser) {
+  factory TiledObject.parse(
+    Parser parser) {
     final x = parser.getDouble('x', defaults: 0);
     final y = parser.getDouble('y', defaults: 0);
     final height = parser.getDouble('height', defaults: 0);
@@ -126,7 +134,17 @@ class TiledObject {
       (xml) => xml.getChildren('point').isNotEmpty,
     );
     final text = parser.getSingleChildOrNullAs('text', Text.parse);
-    final template = parser.getSingleChildOrNullAs('template', Template.parse);
+    final templatePath = parser.getStringOrNull('template');
+    final templateProvider = templatePath == null
+        ? null
+        : parser.templateProviders?.firstWhere((e) => e.canProvide(templatePath));
+    final template = templateProvider == null
+        ? null
+        : Template.parse(
+            templateProvider.getCachedSource(templatePath!) ??
+                templateProvider.getSource(templatePath),
+          );
+
     final properties = parser.getProperties();
 
     final polygon = parsePointList(parser, 'polygon');
@@ -147,6 +165,7 @@ class TiledObject {
       ellipse: ellipse,
       point: point,
       rectangle: rectangle,
+      templatePath: templatePath,
       template: template,
       text: text,
       visible: visible,

packages/tiled/lib/src/parser.dart

@@ -11,10 +11,18 @@ class ParsingException implements Exception {
 class XmlParser extends Parser {
   final XmlElement element;
 
-  XmlParser(this.element);
-
-  factory XmlParser.fromString(String string) =>
-      XmlParser(XmlDocument.parse(string).rootElement);
+  XmlParser(this.element, {super.tsxProviders, super.templateProviders});
+
+  factory XmlParser.fromString(
+    String string, {
+    List<ParserProvider>? tsxProviders,
+    List<ParserProvider>? templateProviders,
+  }) =>
+      XmlParser(
+        XmlDocument.parse(string).rootElement,
+        tsxProviders: tsxProviders,
+        templateProviders: templateProviders,
+      );
 
   @override
   String? getInnerTextOrNull() =>
@@ -30,15 +38,23 @@ class XmlParser extends Parser {
     return element.children
         .whereType<XmlElement>()
         .where((e) => e.name.local == name)
-        .map(XmlParser.new)
+        .map((e) => XmlParser(
+              e,
+              templateProviders: templateProviders,
+              tsxProviders: tsxProviders,
+            ))
         .toList();
   }
 
   List<Parser> getChildrenWithNames(Set<String> names) {
     return element.children
         .whereType<XmlElement>()
         .where((e) => names.contains(e.name.local))
-        .map(XmlParser.new)
+        .map((e) => XmlParser(
+              e,
+              tsxProviders: tsxProviders,
+              templateProviders: templateProviders,
+            ))
         .toList();
   }
 
@@ -54,8 +70,18 @@ class XmlParser extends Parser {
 class JsonParser extends Parser {
   final Map<String, dynamic> json;
 
-  JsonParser(this.json);
-  factory JsonParser.fromString(String string) => JsonParser(jsonDecode(string) as Map<String, dynamic>);
+  JsonParser(this.json, {super.tsxProviders, super.templateProviders});
+
+  factory JsonParser.fromString(
+    String string, {
+    List<ParserProvider>? tsxProviders,
+    List<ParserProvider>? templateProviders,
+  }) =>
+      JsonParser(
+        jsonDecode(string) as Map<String, dynamic>,
+        tsxProviders: tsxProviders,
+        templateProviders: templateProviders,
+      );
 
   @override
   String? getInnerTextOrNull() => null;
@@ -71,7 +97,11 @@ class JsonParser extends Parser {
       return [];
     }
     return (json[name] as List<dynamic>)
-        .map((dynamic e) => JsonParser(e as Map<String, dynamic>))
+        .map((dynamic e) => JsonParser(
+              e as Map<String, dynamic>,
+              templateProviders: templateProviders,
+              tsxProviders: tsxProviders,
+            ))
         .toList();
   }
 
@@ -89,6 +119,11 @@ class JsonParser extends Parser {
 }
 
 abstract class Parser {
+  final List<ParserProvider>? templateProviders;
+  final List<ParserProvider>? tsxProviders;
+
+  Parser({this.tsxProviders, this.templateProviders});
+
   String? getInnerTextOrNull();
 
   String? getStringOrNull(String name, {String? defaults});

packages/tiled/lib/src/provider.dart

@@ -1,10 +1,10 @@
 part of tiled;
 
 abstract class Provider<T> {
-  bool canProvide(String filename);
+  bool canProvide(String path);
 
-  T getSource(String filename);
-  T? getCachedSource(String filename);
+  T getSource(String path);
+  T? getCachedSource(String path);
 }
 
 typedef ParserProvider = Provider<Parser>;

packages/tiled/lib/src/template.dart

@@ -34,3 +34,7 @@ class Template {
           object: parser.getSingleChildOrNullAs('object', TiledObject.parse),
         );
 }
+
+class TemplateReference {
+
+}

packages/tiled/lib/src/tiled_map.dart

@@ -314,40 +314,41 @@ class TiledMap {
     );
   }
 
-  static TiledMap parseJson(String json) {
-    final parser = JsonParser(jsonDecode(json) as Map<String, dynamic>);
+  static TiledMap parseJson(
+    String json, {
+    List<ParserProvider>? tsxProviders,
+    List<ParserProvider>? templateProviders,
+  }) {
+    final parser = JsonParser(
+      jsonDecode(json) as Map<String, dynamic>,
+      templateProviders: templateProviders,
+      tsxProviders: tsxProviders,
+    );
     return TiledMap.parse(parser);
   }
 
   /// Parses the provided map xml.
   ///
   /// Accepts an optional list of external TsxProviders for external tilesets
   /// referenced in the map file.
-  static TiledMap parseTmx(
+  factory TiledMap.parseTmx(
     String xml, {
     List<ParserProvider>? tsxProviders,
     List<ParserProvider>? templateProviders,
-    List<ImagePathProvider>? imageProviders,
   }) {
     final xmlElement = XmlDocument.parse(xml).rootElement;
     if (xmlElement.name.local != 'map') {
       throw 'XML is not in TMX format';
     }
-    final parser = XmlParser(xmlElement);
-    return TiledMap.parse(
-      parser,
+    final parser = XmlParser(
+      xmlElement,
       tsxProviders: tsxProviders,
       templateProviders: templateProviders,
-      imageProviders: imageProviders,
     );
+    return TiledMap.parse(parser);
   }
 
-  factory TiledMap.parse(
-    Parser parser, {
-    List<ParserProvider>? tsxProviders,
-    List<ParserProvider>? templateProviders,
-    List<ImagePathProvider>? imageProviders,
-  }) {
+  factory TiledMap.parse(Parser parser) {
     final backgroundColorHex = parser.getStringOrNull('backgroundcolor');
     final backgroundColor = parser.getColorOrNull('backgroundcolor');
     final compressionLevel = parser.getInt('compressionlevel', defaults: -1);
@@ -374,10 +375,11 @@ class TiledMap {
       'tileset',
       (tilesetData) {
         final tilesetSource = tilesetData.getStringOrNull('source');
-        if (tilesetSource == null || tsxProviders == null) {
+        if (tilesetSource == null || parser.tsxProviders == null) {
           return Tileset.parse(tilesetData);
         }
-        final matchingTsx = tsxProviders.where(
+
+        final matchingTsx = parser.tsxProviders!.where(
           (tsx) => tsx.canProvide(tilesetSource),
         );
 

packages/tiled/lib/src/tileset/tile.dart

@@ -50,7 +50,7 @@ class Tile {
   /// Will be same as [type].
   String? get class_ => type;
 
-  Tile.parse(Parser parser)
+  Tile.parse(Parser parser, {List<ParserProvider>? templateProviders})
       : this(
           localId: parser.getInt('id'),
 
@@ -72,8 +72,10 @@ class Tile {
             parser.getDoubleOrNull('width') ?? 0,
             parser.getDoubleOrNull('height') ?? 0,
           ),
-          objectGroup:
-              parser.getSingleChildOrNullAs('objectgroup', Layer.parse),
+          objectGroup: parser.getSingleChildOrNullAs(
+            'objectgroup',
+            (e) => Layer.parse(e, templateProviders: templateProviders),
+          ),
           animation: parser.formatSpecificParsing(
             (json) => json.getChildrenAs('animation', Frame.parse),
             (xml) =>

packages/tiled/test/parser_test.dart

@@ -255,7 +255,7 @@ void main() {
       return File('./test/fixtures/map_images.tmx').readAsString().then((xml) {
         map = TiledMap.parseTmx(
           xml,
-          tsxProviders: [FixtureTsxProvider.all('./test/fixtures')],
+          tsxProviders: [FixtureTsxProvider.all()],
         );
       });
     });
@@ -316,7 +316,7 @@ void main() {
           .then((xml) {
         final map = TiledMap.parseTmx(
           xml,
-          tsxProviders: [FixtureTsxProvider.all('./test/fixtures')],
+          tsxProviders: [FixtureTsxProvider.all()],
         );
         expect(map.tilesets[0].tileCount, 137);
         final tile = map.tileByGid(1)!;
@@ -331,7 +331,7 @@ void main() {
       return File('./test/fixtures/map_images.tmx').readAsString().then((xml) {
         map = TiledMap.parseTmx(
           xml,
-          tsxProviders: [FixtureTsxProvider.all('./test/fixtures')],
+          tsxProviders: [FixtureTsxProvider.all()],
         );
         expect(
           map.tilesetByName('external').image!.source,
@@ -346,7 +346,7 @@ void main() {
       return File('./test/fixtures/map_images.tmx').readAsString().then((xml) {
         map = TiledMap.parseTmx(
           xml,
-          tsxProviders: [FixtureTsxProvider.all('./test/fixtures')],
+          tsxProviders: [FixtureTsxProvider.all()],
         );
         expect(map.layers.length, equals(2));
       });
@@ -361,7 +361,7 @@ void main() {
           .then((xml) {
         map = TiledMap.parseTmx(
           xml,
-          tsxProviders: [FixtureTsxProvider.all('./test/fixtures')],
+          tsxProviders: [FixtureTsxProvider.all()],
         );
         return;
       });
@@ -434,7 +434,7 @@ class FixtureTsxProvider extends ParserProvider {
 
   FixtureTsxProvider(this.root, this.files);
 
-  factory FixtureTsxProvider.all(String directory) {
+  factory FixtureTsxProvider.all([String directory = './test/fixtures']) {
     final dir = Directory(directory);
     if (!dir.existsSync()) {
       throw '[FixtureTsxProvider] Supplied directory does not exist!';
@@ -447,27 +447,22 @@ class FixtureTsxProvider extends ParserProvider {
         .map((e) => paths.basename(e.path))
         .toList();
 
-    return FixtureTsxProvider(directory, names);
-  }
-
-  factory FixtureTsxProvider.file(String path) {
-    final file = File(path);
-    if (!file.existsSync()) {
-      throw '[FixtureTsxProvider] Supplied path does not match any file!';
-    }
-
-    return FixtureTsxProvider(paths.dirname(path), [paths.basename(path)]);
+    return FixtureTsxProvider(paths.absolute(directory), names);
   }
 
   final Map<String, String> cache = {};
 
   @override
-  bool canProvide(String filename) => true;
+  bool canProvide(String filename) {
+    return files.contains(filename);
+  }
 
   @override
-  Parser? getCachedSource(String filename) => cache.containsKey(filename)
-      ? XmlParser.fromString(cache[filename]!)
-      : null;
+  Parser? getCachedSource(String filename) {
+    return cache.containsKey(filename)
+        ? XmlParser.fromString(cache[filename]!)
+        : null;
+  }
 
   @override
   Parser getSource(String filename) {