full support for MapMacros.asm

Author: kirjavascript

CHANGELOG

@@ -1,10 +1,11 @@
 # Changelog
 
 ## [unreleased]
-- Change DPLC limit to 255
+- Assembler now uses AS Macro Assembler for full macro support
+- MapMacros.asm definitions added
 - Make (de)compression threaded
+- Change DPLC limit to 255
 - Fix issue where image data would be cached incorrectly
-- Electron updated to v26
 
 ## [1.2.2]
 - Added sprite rotation algorithm: 3 shears

TODO

@@ -12,21 +12,22 @@
 
 
 macros for mappings
+    specify mapmacros in definition
     format hooks for defining asm output
     define macro files in script??
+    fix prelude
+    perf
 
-return rotsprite
+redo tile rendering
+remove rotsprite
 
 ROADMAP
-look at issues related to crashes
 drawing mode bugs
     disable mapping editing
 improve undo/redo when drawing pixels / moving things
 animation editor
     export to gif
 
-
-
 ==
 BUGS
 

app/components/file/file-object.js

@@ -1,13 +1,8 @@
 import React, { useState, useRef } from 'react';
 import { observer } from 'mobx-react';
 import { Item, Input, File as FileInput, Select, Checkbox, Button } from '#ui';
-import {
-    scripts,
-    runScript,
-    parseASM as parseASMInternal,
-    writeBIN,
-    writeASM,
-} from '#formats/scripts';
+import { scripts, runScript, writeBIN, writeASM, parseASMBasic } from '#formats/scripts';
+import { assemble } from '#formats/asm';
 
 import { decompress, compress, compressionFormats } from '#formats/compression';
 import { bufferToTiles, tilesToBuffer } from '#formats/art';
@@ -17,28 +12,26 @@ import { workspace } from '#store/workspace';
 import ErrorMsg from './error';
 import SaveLoad from './save-load';
 import { promises } from 'fs';
-import { extname } from 'path';
+import { extname, basename } from 'path';
 import { uuid } from '#util/uuid';
 
 const fs = promises;
 const compressionList = Object.keys(compressionFormats);
 
+const isASM = (path) => ['.asm', '.s'].includes(extname(path));
+
 export const FileObject = observer(({ obj }) => {
     scripts.length; // react to script updates
     const script = obj.format && runScript(obj.format);
     const scriptSafe = script && !script.error;
 
     const { isAbsolute } = obj; // set in store/workspace
 
-    const mappingsASM = extname(obj.mappings.path) === '.asm';
-    const dplcsASM = extname(obj.dplcs.path) === '.asm';
+    const mappingsASM = isASM(obj.mappings.path);
+    const dplcsASM = isASM(obj.dplcs.path);
     const linesLeft = obj.palettes.reduce((a, c) => a - c.length, 4);
 
-    const scriptDPLCs = scriptSafe && script.DPLCs;
-    const scriptArt = scriptSafe && script.art;
-    const scriptPalettes = scriptSafe && script.palettes;
     const toggleDPLCs = () => (obj.dplcs.enabled = !obj.dplcs.enabled);
-    const parseASM = (scriptSafe && script.parseASM) || parseASMInternal;
 
     function ioWrap(filePath, setError, e, cb) {
         setError();
@@ -59,9 +52,28 @@ export const FileObject = observer(({ obj }) => {
         }
     }
 
+    async function getBuffer(path, isASM) {
+        if (isASM) {
+            const contents = await fs.readFile(path, 'utf8');
+
+            console.time(path);
+            if (script.asm.basic) return await parseASMBasic(contents);
+
+            const buffer = await assemble(script.asm.prelude + contents, {
+                filename: basename(path),
+            });
+            console.timeEnd(path);
+
+            return buffer;
+        }
+
+        return await fs.readFile(path);
+    }
+
     const loadRef = useRef();
 
     function loadObject() {
+        loadRef.current.childNodes.forEach(n => { n.textContent = ''; });
         loadArt({ target: loadRef.current.childNodes[0] });
         loadMappings({ target: loadRef.current.childNodes[1] });
         if (obj.dplcs.enabled) {
@@ -71,6 +83,7 @@ export const FileObject = observer(({ obj }) => {
     }
 
     function saveObject() {
+        loadRef.current.childNodes.forEach(n => { n.textContent = ''; });
         saveArt({ target: loadRef.current.childNodes[0] });
         saveMappings({ target: loadRef.current.childNodes[1] });
         if (obj.dplcs.enabled) {
@@ -85,7 +98,7 @@ export const FileObject = observer(({ obj }) => {
         ioWrap(obj.art.path, setArtError, e, async (path) => {
             const buffer = (await fs.readFile(path)).slice(obj.art.offset || 0);
 
-            if (scriptArt) {
+            if (script.art) {
                 environment.tiles.replace(script.readArt(buffer));
             } else {
                 const decompBuffer = await decompress(
@@ -102,12 +115,12 @@ export const FileObject = observer(({ obj }) => {
             if (obj.art.offset) {
                 throw new Error('Can only save art at offset 0');
             }
-            const tiles = scriptArt
+            const tiles = script.art
                 ? script.writeArt(tiles)
                 : tilesToBuffer(environment.tiles, obj.art.compression);
             await fs.writeFile(path, tiles);
 
-            if (scriptArt) {
+            if (script.art) {
                 await fs.writeFile(path, script.writeArt(tiles));
             } else {
                 const buffer = tilesToBuffer(environment.tiles);
@@ -124,10 +137,7 @@ export const FileObject = observer(({ obj }) => {
     function loadMappings(e) {
         ioWrap(obj.mappings.path, setMappingError, e, async (path) => {
             if (!obj.dplcs.enabled) environment.config.dplcsEnabled = false;
-
-            const buffer = mappingsASM
-                ? parseASM(await fs.readFile(path, 'utf8'))
-                : await fs.readFile(path);
+            const buffer = await getBuffer(path, mappingsASM);
 
             const mappings = script.readMappings(buffer);
             if (mappings.error) throw mappings.error;
@@ -168,9 +178,7 @@ export const FileObject = observer(({ obj }) => {
     function loadDPLCs(e) {
         ioWrap(obj.dplcs.path, setDPLCError, e, async (path) => {
             environment.config.dplcsEnabled = true;
-            const buffer = dplcsASM
-                ? parseASM(await fs.readFile(path, 'utf8'))
-                : await fs.readFile(path);
+            const buffer = await getBuffer(path, dplcsASM);
 
             const dplcs = script.readDPLCs(buffer);
             if (dplcs.error) throw dplcs.error;
@@ -206,7 +214,7 @@ export const FileObject = observer(({ obj }) => {
                     ? palPath
                     : workspace.absolutePath(palPath);
 
-                (scriptPalettes ? script.readPalettes : buffersToColors)({
+                (script.palettes ? script.readPalettes : buffersToColors)({
                     buffer: await fs.readFile(path),
                     length,
                 }).forEach((line) => {
@@ -233,7 +241,7 @@ export const FileObject = observer(({ obj }) => {
                     : workspace.absolutePath(palPath);
 
                 const chunk = (
-                    scriptPalettes ? script.writePalettes : colorsToBuffers
+                    script.palettes ? script.writePalettes : colorsToBuffers
                 )(environment.palettes, cursor, cursor + length);
                 await fs.writeFile(path, chunk);
                 cursor += length;
@@ -263,7 +271,7 @@ export const FileObject = observer(({ obj }) => {
                 <Item color="green">Art</Item>
                 <SaveLoad load={loadArt} save={saveArt} />
             </div>
-            {!scriptArt && (
+            {!script.art && (
                 <>
                     <div className="menu-item">
                         <Item>Compression</Item>
@@ -305,7 +313,7 @@ export const FileObject = observer(({ obj }) => {
                 </div>
             )}
 
-            {scriptDPLCs && (
+            {script.PLCs && (
                 <>
                     <div className="menu-item" onClick={toggleDPLCs}>
                         <Item>DPLCs Enabled</Item>

app/formats/asm/index.js

@@ -28,7 +28,7 @@ export async function assemble(
     const aslWorker = new Worker('bundles/asl-worker.js');
     const asl = Comlink.wrap(aslWorker);
 
-    const pFile = await asl.assemble(prelude + code, {
+    const pFile = await asl.assemble(code, {
         messages: asMessages,
         filename,
     });
@@ -43,98 +43,3 @@ export async function assemble(
 
     return bin;
 }
-
-const prelude = `SonicMappingsVer := 2
-SonicDplcVer = 2
-; macro to declare a mappings table (taken from Sonic 2 Hg disassembly)
-mappingsTable macro {INTLABEL}
-__LABEL__ label *
-.current_mappings_table := __LABEL__
-    endm
-
-; macro to declare an entry in a mappings table (taken from Sonic 2 Hg disassembly)
-mappingsTableEntry macro ptr
-	dc.ATTRIBUTE ptr-.current_mappings_table
-    endm
-
-spriteHeader macro {INTLABEL}
-__LABEL__ label *
-	if SonicMappingsVer=1
-	dc.b ((__LABEL___End - __LABEL___Begin) / 5)
-	elseif SonicMappingsVer=2
-	dc.w ((__LABEL___End - __LABEL___Begin) / 8)
-	else
-	dc.w ((__LABEL___End - __LABEL___Begin) / 6)
-	endif
-__LABEL___Begin label *
-    endm
-
-spritePiece macro xpos,ypos,width,height,tile,xflip,yflip,pal,pri
-	if SonicMappingsVer=1
-	dc.b	ypos
-	dc.b	(((width-1)&3)<<2)|((height-1)&3)
-	dc.b	((pri&1)<<7)|((pal&3)<<5)|((yflip&1)<<4)|((xflip&1)<<3)|((tile&$700)>>8)
-	dc.b	tile&$FF
-	dc.b	xpos
-	elseif SonicMappingsVer=2
-	dc.w	((ypos&$FF)<<8)|(((width-1)&3)<<2)|((height-1)&3)
-	dc.w	((pri&1)<<15)|((pal&3)<<13)|((yflip&1)<<12)|((xflip&1)<<11)|(tile&$7FF)
-	dc.w	((pri&1)<<15)|((pal&3)<<13)|((yflip&1)<<12)|((xflip&1)<<11)|((tile>>1)&$7FF)
-	dc.w	xpos
-	else
-	dc.w	((ypos&$FF)<<8)|(((width-1)&3)<<2)|((height-1)&3)
-	dc.w	((pri&1)<<15)|((pal&3)<<13)|((yflip&1)<<12)|((xflip&1)<<11)|(tile&$7FF)
-	dc.w	xpos
-	endif
-	endm
-
-spritePiece2P macro xpos,ypos,width,height,tile,xflip,yflip,pal,pri,tile2,xflip2,yflip2,pal2,pri2
-	if SonicMappingsVer=1
-	dc.b	ypos
-	dc.b	(((width-1)&3)<<2)|((height-1)&3)
-	dc.b	((pri&1)<<7)|((pal&3)<<5)|((yflip&1)<<4)|((xflip&1)<<3)|((tile&$700)>>8)
-	dc.b	tile&$FF
-	dc.b	xpos
-	elseif SonicMappingsVer=2
-	dc.w	((ypos&$FF)<<8)|(((width-1)&3)<<2)|((height-1)&3)
-	dc.w	((pri&1)<<15)|((pal&3)<<13)|((yflip&1)<<12)|((xflip&1)<<11)|(tile&$7FF)
-	dc.w	((pri2&1)<<15)|((pal2&3)<<13)|((yflip2&1)<<12)|((xflip2&1)<<11)|(tile2&$7FF)
-	dc.w	xpos
-	else
-	dc.w	((ypos&$FF)<<8)|(((width-1)&3)<<2)|((height-1)&3)
-	dc.w	((pri&1)<<15)|((pal&3)<<13)|((yflip&1)<<12)|((xflip&1)<<11)|(tile&$7FF)
-	dc.w	xpos
-	endif
-	endm
-
-dplcHeader macro {INTLABEL}
-__LABEL__ label *
-	if SonicDplcVer=1
-	dc.b ((__LABEL___End - __LABEL___Begin) / 2)
-	elseif SonicDplcVer=3
-	dc.w (((__LABEL___End - __LABEL___Begin) / 2)-1)
-	else
-	dc.w ((__LABEL___End - __LABEL___Begin) / 2)
-	endif
-__LABEL___Begin label *
-    endm
-
-dplcEntry macro tiles,offset
-	if SonicDplcVer=3
-	dc.w	((offset&$FFF)<<4)|((tiles-1)&$F)
-	elseif SonicDplcVer=4
-	dc.w	(((tiles-1)&$F)<<12)|((offset&$FFF)<<4)
-	else
-	dc.w	(((tiles-1)&$F)<<12)|(offset&$FFF)
-	endif
-	endm
-
-even macro
-    if (*)&1
-paddingSoFar		set paddingSoFar+1
-        dc.b 0 ;ds.b 1
-    endif
-    endm
-
-    cpu	68000
-    `;

app/formats/scripts/file.js

@@ -4,34 +4,40 @@ import { errorMsg } from '#util/dialog';
 import { uniq, debounce } from 'lodash';
 import { observable } from 'mobx';
 
-const scriptPaths = uniq([
-    dirname(process.execPath),
-    process.cwd(),
-]).map(path => join(path, 'scripts'));
+const scriptPaths = uniq([dirname(process.execPath), process.cwd()]).map(
+    (path) => join(path, 'scripts'),
+);
 
-const scriptDir = scriptPaths.find(path => (
-    fs.existsSync(path) && fs.lstatSync(path).isDirectory()
-));
+const scriptDir = scriptPaths.find(
+    (path) => fs.existsSync(path) && fs.lstatSync(path).isDirectory(),
+);
 
 const scripts = observable([]);
 
 const { readdir } = fs.promises;
 
 async function loadScripts() {
     try {
-        const list = await readdir(scriptDir);
-        scripts.replace(list.map(filename => ({
-            value: filename,
-            label: parse(filename).name,
-        })));
+        const list = (await readdir(scriptDir)).filter((filename) =>
+            filename.endsWith('.js'),
+        );
+        scripts.replace(
+            list.map((filename) => ({
+                value: filename,
+                label: parse(filename).name,
+            })),
+        );
     } catch (e) {
         console.error(e);
     }
 }
 
 if (!scriptDir) {
-    errorMsg(`Script Error`, `Could not find 'scripts' directory for mapping definition files
-Searched in;\n\t${scriptPaths.join('\n\t')}`);
+    errorMsg(
+        `Script Error`,
+        `Could not find 'scripts' directory for mapping definition files
+Searched in;\n\t${scriptPaths.join('\n\t')}`,
+    );
 } else {
     loadScripts();
     fs.watch(scriptDir, debounce(loadScripts, 100));
@@ -41,7 +47,4 @@ function loadScript(file) {
     return fs.readFileSync(join(scriptDir, file), 'utf8');
 }
 
-export {
-    scripts,
-    loadScript,
-};
+export { scripts, loadScript, scriptDir };

app/formats/scripts/index.js

@@ -1,5 +1,5 @@
 export { scripts } from './file';
-export { parseASM } from './parse-asm';
+export { parseASMBasic } from './parse-asm';
 export { writeBIN } from './write-bin';
 export { writeASM } from './write-asm';
 export { default as runScript } from './run-script';

app/formats/scripts/parse-asm.js

@@ -20,7 +20,8 @@ const sizes = {
     l: 4,
 };
 
-export function parseASM(text) {
+// use with asm(({ basic }) => basic())
+export function parseASMBasic(text) {
     const comment = regex(/^;.*$/m).map(() => [ignore]);
     const even = str('even').map(() => [ignore]);
     const label = regex(/^[A-Z0-9_@$.]+(\s+)?:/i).map(t => [lbl, t.replace(':', '')]);