generalized provider (ready for templates)

Author: benni-tec

packages/tiled/lib/src/parser.dart

@@ -4,13 +4,18 @@ class ParsingException implements Exception {
   final String name;
   final String? valueFound;
   final String reason;
+
   ParsingException(this.name, this.valueFound, this.reason);
 }
 
 class XmlParser extends Parser {
   final XmlElement element;
+
   XmlParser(this.element);
 
+  factory XmlParser.fromString(String string) =>
+      XmlParser(XmlDocument.parse(string).rootElement);
+
   @override
   String? getInnerTextOrNull() =>
       element.innerText.isEmpty ? null : element.innerText;
@@ -48,7 +53,9 @@ 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>);
 
   @override
   String? getInnerTextOrNull() => null;

packages/tiled/lib/src/provider.dart

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

packages/tiled/lib/src/tile_map_parser.dart

@@ -128,28 +128,31 @@ class TiledMap {
   /// the [TsxProvider]s returned from the [tsxProviderFunction].
   /// The [tsxProviderFunction] is most commonly your static [TsxProvider.parse]
   /// implementation.
-  static Future<TiledMap> fromString(
-    String contents,
-    Future<TsxProvider> Function(String key) tsxProviderFunction,
-  ) async {
-    final tsxSourcePaths = XmlDocument.parse(contents)
-        .rootElement
-        .children
-        .whereType<XmlElement>()
-        .where((element) => element.name.local == 'tileset')
-        .map((e) => e.getAttribute('source'));
-
-    final tsxProviders = await Future.wait(
-      tsxSourcePaths
-          .where((key) => key != null)
-          .map((key) async => tsxProviderFunction(key!)),
-    );
-
-    return TileMapParser.parseTmx(
-      contents,
-      tsxList: tsxProviders.isEmpty ? null : tsxProviders,
-    );
-  }
+  // TODO: why is this here? same as parseTmx???
+  // static Future<TiledMap> fromString(
+  //   String contents, {
+  //   List<ParserProvider>? tsxProviders,
+  //   List<ParserProvider>? templateProviders,
+  //   List<ImagePathProvider>? imageProviders,
+  // }) async {
+  //   final tsxSourcePaths = XmlDocument.parse(contents)
+  //       .rootElement
+  //       .children
+  //       .whereType<XmlElement>()
+  //       .where((element) => element.name.local == 'tileset')
+  //       .map((e) => e.getAttribute('source'));
+  //
+  //   final tsxProviders = await Future.wait(
+  //     tsxSourcePaths
+  //         .where((key) => key != null)
+  //         .map((key) async => tsxProviderFunction(key!)),
+  //   );
+  //
+  //   return TileMapParser.parseTmx(
+  //     contents,
+  //     tsxList: tsxProviders.isEmpty ? null : tsxProviders,
+  //   );
+  // }
 
   // Convenience Methods
   Tile? tileByGid(int tileGid) {
@@ -311,7 +314,40 @@ class TiledMap {
     );
   }
 
-  factory TiledMap.parse(Parser parser, {List<TsxProviderBase>? tsxList}) {
+  static TiledMap parseJson(String json) {
+    final parser = JsonParser(jsonDecode(json) as Map<String, dynamic>);
+    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(
+    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,
+      tsxProviders: tsxProviders,
+      templateProviders: templateProviders,
+      imageProviders: imageProviders,
+    );
+  }
+
+  factory TiledMap.parse(
+    Parser parser, {
+    List<ParserProvider>? tsxProviders,
+    List<ParserProvider>? templateProviders,
+    List<ImagePathProvider>? imageProviders,
+  }) {
     final backgroundColorHex = parser.getStringOrNull('backgroundcolor');
     final backgroundColor = parser.getColorOrNull('backgroundcolor');
     final compressionLevel = parser.getInt('compressionlevel', defaults: -1);
@@ -338,11 +374,11 @@ class TiledMap {
       'tileset',
       (tilesetData) {
         final tilesetSource = tilesetData.getStringOrNull('source');
-        if (tilesetSource == null || tsxList == null) {
+        if (tilesetSource == null || tsxProviders == null) {
           return Tileset.parse(tilesetData);
         }
-        final matchingTsx = tsxList.where(
-          (tsx) => tsx.checkProvidable(tilesetSource),
+        final matchingTsx = tsxProviders.where(
+          (tsx) => tsx.canProvide(tilesetSource),
         );
 
         return Tileset.parse(

packages/tiled/lib/src/tiled_map.dart

@@ -103,7 +103,7 @@ class Tileset {
     tileCount = this.tiles.length;
   }
 
-  factory Tileset.parse(Parser parser, {TsxProviderBase? tsx}) {
+  factory Tileset.parse(Parser parser, {ParserProvider? tsx}) {
     final backgroundColor = parser.getStringOrNull('backgroundcolor');
     final columns = parser.getIntOrNull('columns');
     final firstGid = parser.getIntOrNull('firstgid');
@@ -169,10 +169,10 @@ class Tileset {
     return result;
   }
 
-  void _checkIfExternalTsx(String? source, TsxProviderBase? tsx) {
+  void _checkIfExternalTsx(String? source, ParserProvider? tsx) {
     if (tsx != null && source != null) {
       final tileset = Tileset.parse(
-        tsx.getCachedSourceBase(source) ?? tsx.getSourceBase(source),
+        tsx.getCachedSource(source) ?? tsx.getSource(source),
       );
       // Copy attributes if not null
       backgroundColor = tileset.backgroundColor ?? backgroundColor;

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

@@ -26,8 +26,8 @@ part 'src/layer.dart';
 part 'src/objects/text.dart';
 part 'src/objects/tiled_object.dart';
 part 'src/parser.dart';
+part 'src/provider.dart';
 part 'src/template.dart';
-part 'src/tile_map_parser.dart';
 part 'src/tiled_map.dart';
 part 'src/tileset/grid.dart';
 part 'src/tileset/terrain.dart';
@@ -36,5 +36,4 @@ part 'src/tileset/tile_offset.dart';
 part 'src/tileset/tileset.dart';
 part 'src/tileset/wang/wang_color.dart';
 part 'src/tileset/wang/wang_set.dart';
-part 'src/tileset/wang/wang_tile.dart';
-part 'src/tsx_provider.dart';
+part 'src/tileset/wang/wang_tile.dart';

packages/tiled/lib/src/tsx_provider.dart

@@ -16,3 +16,4 @@ dev_dependencies:
   dartdoc: ^8.3.1
   flame_lint: ^1.1.2
   test: ^1.24.8
+  path: ^1.8.3

packages/tiled/lib/tiled.dart

@@ -10,7 +10,7 @@ void main() {
     return File('./test/fixtures/complexmap_infinite.tmx')
         .readAsString()
         .then((xml) {
-      complexMapInfinite = TileMapParser.parseTmx(xml);
+      complexMapInfinite = TiledMap.parseTmx(xml);
     });
   });
 

packages/tiled/pubspec.yaml

@@ -7,7 +7,7 @@ void main() {
   late TiledMap map;
   setUp(() {
     return File('./test/fixtures/imagelayer.tmx').readAsString().then((xml) {
-      map = TileMapParser.parseTmx(xml);
+      map = TiledMap.parseTmx(xml);
     });
   });
 

packages/tiled/test/complexmap_infinite_test.dart

@@ -11,14 +11,14 @@ void main() {
     return File('./test/fixtures/isometric_staggered_grass_and_water.json')
         .readAsString()
         .then((xml) {
-      mapIsoStaggeredJson = TileMapParser.parseJson(xml);
+      mapIsoStaggeredJson = TiledMap.parseJson(xml);
     });
   });
   setUp(() {
     return File('./test/fixtures/isometric_staggered_grass_and_water.tmx')
         .readAsString()
         .then((xml) {
-      mapIsoStaggeredTmx = TileMapParser.parseTmx(xml);
+      mapIsoStaggeredTmx = TiledMap.parseTmx(xml);
     });
   });
 

packages/tiled/test/image_layer_test.dart

@@ -10,7 +10,7 @@ void main() {
     return File('./test/fixtures/isometric_grass_and_water.tmx')
         .readAsString()
         .then((xml) {
-      mapIso = TileMapParser.parseTmx(xml);
+      mapIso = TiledMap.parseTmx(xml);
     });
   });
 

packages/tiled/test/isometric_staggered_test.dart

@@ -9,11 +9,11 @@ void main() {
 
   setUp(() {
     final f1 = File('./test/fixtures/test.tmx').readAsString().then((xml) {
-      mapTmx = TileMapParser.parseTmx(xml);
+      mapTmx = TiledMap.parseTmx(xml);
     });
     final f2 =
         File('./test/fixtures/test_base64_gzip.tmx').readAsString().then((xml) {
-      mapTmxBase64Gzip = TileMapParser.parseTmx(xml);
+      mapTmxBase64Gzip = TiledMap.parseTmx(xml);
     });
 
     return Future.wait([f1, f2]);

packages/tiled/test/isometric_test.dart

@@ -7,7 +7,7 @@ void main() {
   late TiledMap map;
   setUp(() {
     return File('./test/fixtures/objectgroup.tmx').readAsString().then((xml) {
-      map = TileMapParser.parseTmx(xml);
+      map = TiledMap.parseTmx(xml);
     });
   });
 

packages/tiled/test/layer_test.dart

@@ -11,11 +11,7 @@ void main() {
     setUp(() {
       return File('./test/fixtures/testoverflow_csv.tmx').readAsString().then(
         (mapString) {
-          return TiledMap.fromString(mapString, TsxProvider.parse).then(
-            (parsedMap) {
-              map = parsedMap;
-            },
-          );
+          map = TiledMap.parseTmx(mapString);
         },
       );
     });