-
Notifications
You must be signed in to change notification settings - Fork 435
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support for all BMFont output file types in FlxBitmapFont (#2949)
* Added support for all bmfont file types (xml, text, binary) * Update FlxAngelCodeXmlAsset to also accept Bytes * Cleanup of the `guessType` function and renamed FlxAngelCodeXmlAsset to FlxAngelCodeAsset * Codeclimate fixes * Unified the bmfont parsing functions into one function * fix codeclimate * Removed null types * crete abstracts over typedefs, move xml parsing * move text parsing to abstracts * rename package * rename data classes * move bytes parsing to abstracts * move to separate modules * separate fields for letter and id * add doc * remove redundnat local fields * change field order and add padding/spacing type * new regex for bmfont attribute matching. start of test cases * better key/value attribute parser * add spacing/padding fromBytes() * fix ci * remove unused function * add BMFont text format test * update BMFontTest to include binary file test * formatting --------- Co-authored-by: George FunBook <[email protected]> Co-authored-by: Logan <[email protected]>
- Loading branch information
3 people
authored
Dec 15, 2023
1 parent
211e212
commit f68d033
Showing
10 changed files
with
1,102 additions
and
83 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,232 @@ | ||
| package flixel.graphics.frames.bmfont; | ||
|
|
||
| import flixel.system.FlxAssets; | ||
| import haxe.io.Bytes; | ||
| import haxe.io.BytesInput; | ||
| import haxe.xml.Access; | ||
| import openfl.utils.Assets; | ||
|
|
||
| using StringTools; | ||
|
|
||
| /** | ||
| * Used internally via `FlxBitmapFont.fromAngelCode` to serialize text, xml or binary files | ||
| * exported from [BMFont](https://www.angelcode.com/products/bmfont/) | ||
| * | ||
| * @since 5.6.0 | ||
| * @see [flixel.graphics.frames.FlxBitmapFont.fromAngelCode](https://api.haxeflixel.com/flixel/graphics/frames/FlxBitmapFont.html#fromAngelCode) | ||
| */ | ||
| class BMFont | ||
| { | ||
| public var info:BMFontInfo; | ||
| public var common:BMFontCommon; | ||
| public var pages:Array<BMFontPage>; | ||
| public var chars:Array<BMFontChar>; | ||
| public var kerning:Null<Array<BMFontKerning>> = null; | ||
|
|
||
| function new(?info, ?common, ?pages, ?chars, ?kerning) | ||
| { | ||
| this.info = info; | ||
| this.common = common; | ||
| this.pages = pages; | ||
| this.chars = chars; | ||
| this.kerning = kerning; | ||
| } | ||
|
|
||
| public static function fromXml(xml:Xml) | ||
| { | ||
| final xmlAccess = new Access(xml); | ||
| final info = BMFontInfo.fromXml(xmlAccess.node.info); | ||
| final common = BMFontCommon.fromXml(xmlAccess.node.common); | ||
| final pages = BMFontPage.listFromXml(xmlAccess.node.pages); | ||
| final chars = BMFontChar.listFromXml(xmlAccess.node.chars); | ||
| var kerning:Array<BMFontKerning> = null; | ||
|
|
||
| if (xmlAccess.hasNode.kernings) | ||
| { | ||
| kerning = BMFontKerning.listFromXml(xmlAccess.node.kernings); | ||
| } | ||
|
|
||
| return new BMFont(info, common, pages, chars, kerning); | ||
| } | ||
|
|
||
| public static function fromText(text:String) | ||
| { | ||
| var info:BMFontInfo = null; | ||
| var common:BMFontCommon = null; | ||
| final pages = new Array<BMFontPage>(); | ||
| final chars = new Array<BMFontChar>(); | ||
| final kernings = new Array<BMFontKerning>(); | ||
| // we dont need these but they exists in the file | ||
| // var charCount = 0; | ||
| // var kerningCount = 0; | ||
|
|
||
| final lines = text.replace('\r\n', '\n').split('\n').filter((line) -> line.length > 0); | ||
| for (line in lines) | ||
| { | ||
| final blockType = line.substring(0, line.indexOf(' ')); | ||
| final blockAttrs = line.substring(line.indexOf(' ') + 1); | ||
| switch blockType | ||
| { | ||
| case 'info': info = BMFontInfo.fromText(blockAttrs); | ||
| case 'common': common = BMFontCommon.fromText(blockAttrs); | ||
| case 'page': pages.push(BMFontPage.fromText(blockAttrs)); | ||
| // case 'chars': charCount = Std.parseInt(blockAttrs.split("=").pop()); | ||
| case 'char': chars.push(BMFontChar.fromText(blockAttrs)); | ||
| // case 'kernings': kerningCount = Std.parseInt(blockAttrs.split("=").pop()); | ||
| case 'kerning': kernings.push(BMFontKerning.fromText(blockAttrs)); | ||
| } | ||
| } | ||
|
|
||
| return new BMFont(info, common, pages, chars, kernings.length > 0 ? kernings : null); | ||
| } | ||
|
|
||
| /** | ||
| * @see https://www.angelcode.com/products/bmfont/doc/file_format.html#bin | ||
| */ | ||
| public static function fromBytes(bytes:Bytes) | ||
| { | ||
| final bytes = new BytesInput(bytes); | ||
| final expectedBytes = [66, 77, 70]; // 'B', 'M', 'F' | ||
| for (b in expectedBytes) | ||
| { | ||
| var testByte = bytes.readByte(); | ||
| if (testByte != b) | ||
| throw 'Invalid binary .fnt file. Found $testByte, expected $b'; | ||
| } | ||
| var version = bytes.readByte(); | ||
| if (version < 3) | ||
| { | ||
| FlxG.log.warn('The BMFont parser is made to work on files with version 3. Using earlier versions can cause issues!'); | ||
| } | ||
|
|
||
| var info:BMFontInfo = null; | ||
| var common:BMFontCommon = null; | ||
| var pages:Array<BMFontPage> = null; | ||
| var chars:Array<BMFontChar> = null; | ||
| var kerning:Array<BMFontKerning> = null; | ||
|
|
||
| // parsing blocks | ||
| while (bytes.position < bytes.length) | ||
| { | ||
| final blockId:BMFontBlockId = bytes.readByte(); | ||
| switch blockId | ||
| { | ||
| case INFO: info = BMFontInfo.fromBytes(bytes); | ||
| case COMMON: common = BMFontCommon.fromBytes(bytes); | ||
| case PAGES: pages = BMFontPage.listFromBytes(bytes); | ||
| case CHARS: chars = BMFontChar.listFromBytes(bytes); | ||
| case KERNING: kerning = BMFontKerning.listFromBytes(bytes); | ||
| } | ||
| } | ||
| return new BMFont(info, common, pages, chars, kerning); | ||
| } | ||
|
|
||
| public static function parse(data:FlxAngelCodeAsset):BMFont | ||
| { | ||
| return switch guessType(data) | ||
| { | ||
| case TEXT(text): fromText(text); | ||
| case XML(xml): fromXml(xml); | ||
| case BINARY(bytes): fromBytes(bytes); | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * A helper function that helps determine the type of BMFont descriptor from either the path or content of the file | ||
| * @param data The file path or the file content | ||
| * @return BMFontFileType | ||
| */ | ||
| static function guessType(data:FlxAngelCodeAsset):BMFontFileType | ||
| { | ||
| if (data is Xml) | ||
| { | ||
| return XML(cast(data, Xml).firstElement()); | ||
| } | ||
|
|
||
| if (data is Bytes) | ||
| { | ||
| final bytes:Bytes = cast data; | ||
| if (isValidBytes(bytes)) | ||
| return BINARY(bytes); | ||
|
|
||
| return detectFromText(bytes.toString()); | ||
| } | ||
|
|
||
| if (data is String) | ||
| { | ||
| final dataStr:String = cast data; | ||
| if (Assets.exists(dataStr)) | ||
| { | ||
| // dataStr is a file path | ||
| final bytes = Assets.getBytes(dataStr); | ||
| if(bytes == null) | ||
| return detectFromText(Assets.getText(dataStr)); | ||
|
|
||
| if (isValidBytes(bytes)) | ||
| return BINARY(bytes); | ||
|
|
||
| return detectFromText(bytes.toString()); | ||
| } | ||
| else | ||
| { | ||
| // dataStr is the content of a file as a string (can be xml or just plain text) | ||
| return detectFromText(dataStr); | ||
| } | ||
| } | ||
|
|
||
| throw 'Invalid FlxAngelCodeAsset: $data'; | ||
| } | ||
|
|
||
| static function safeParseXML(str:String) | ||
| { | ||
| // for js, Xml.parse throws if str is not valid XML but on desktop it just returns null | ||
| // This function will always return null if xml is invalid | ||
| try | ||
| { | ||
| var xml = Xml.parse(str); | ||
| return xml; | ||
| } | ||
| catch (e:Dynamic) | ||
| { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| static function detectFromText(text:String):BMFontFileType | ||
| { | ||
| final xml = safeParseXML(text); | ||
| if (xml != null && xml.firstElement() != null) | ||
| { | ||
| return XML(xml.firstElement()); | ||
| } | ||
| return TEXT(text); | ||
| } | ||
|
|
||
| static function isValidBytes(bytes:Bytes) | ||
| { | ||
| final expected = [66, 77, 70]; // 'B', 'M', 'F' | ||
| for (i in 0...expected.length) | ||
| { | ||
| if (bytes.get(i) != expected[i]) | ||
| return false; | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
| } | ||
|
|
||
| private enum abstract BMFontBlockId(Int) from Int | ||
| { | ||
| var INFO = 1; | ||
| var COMMON = 2; | ||
| var PAGES = 3; | ||
| var CHARS = 4; | ||
| var KERNING = 5; | ||
| } | ||
|
|
||
| private enum BMFontFileType | ||
| { | ||
| TEXT(text:String); | ||
| XML(xml:Xml); | ||
| BINARY(bytes:Bytes); | ||
| } |
Oops, something went wrong.