iigs-sprite-compiler/SpriteCompiler/Problem/CodeSequence.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace SpriteCompiler.Problem
{
    /// <summary>
    /// A set of code sequences that can be used to generate sprites
    /// </summary>
    public abstract class CodeSequence
    {
        protected CodeSequence(int cycles)
        {
            CycleCount = cycles;
        }

        // Number of cycles that this code snippets takes to execute
        public int CycleCount { get; private set; }

        // Function to generate a new state based on the code's operation
        public abstract SpriteGeneratorState Apply(SpriteGeneratorState state);

        // Funtion to emit the source code
        public abstract string Emit();

        // Helper function for ToString implementations
        protected string FormatLine(string label, string opcode, string operand, string comment)
        {
            return String.Format("{0}\t{1}\t{2}\t; {3}", label, opcode, operand, comment);
        }
    }

    public sealed class MOVE_STACK : CodeSequence
    {
        private readonly int offset;

        public MOVE_STACK(int offset)
            : base(offset == 0 ? 2 : 5)
        {
            this.offset = offset;
        }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.A = _.A.Add(offset);
                _.S = _.A;
                _.AllowModeChange = true;
            });
        }

        public override string ToString()
        {
            return (offset == 0) ? "TCS" : ("ADC #" + offset.ToString() + " / TCS");
        }

        public override string Emit()
        {
            if (offset == 0)
            {
                return FormatLine("", "TCS", "", "2 cycles");
            }
            else
            {
                return String.Join("\n",
                    FormatLine("", "ADC", "#" + offset.ToString(), "3 cycles"),
                    FormatLine("", "TCS", "", "2 cycles")
                );
            }
        }
    }

    public sealed class TSC : CodeSequence
    {
        public TSC() : base(2) { }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.A = _.S;
            });
        }

        public override string ToString()
        {
            return "TSC";
        }

        public override string Emit()
        {
            return FormatLine("", "TSC", "", "2 cycles");
        }
    }


    public sealed class SHORT_M : CodeSequence
    {
        public SHORT_M() : base(3) { }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ => 
            {
                _.P &= 0xEF;
                _.AllowModeChange = false;
            });
        }

        public override string ToString()
        {
            return "SEP #$10";
        }

        public override string Emit()
        {
            return FormatLine("", "SEP", "#$10", "3 cycles");
        }
    }

    public sealed class LONG_M : CodeSequence
    {
        public LONG_M() : base(3) { }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ => 
            {
                _.P |= 0x10;
                _.AllowModeChange = false;
            });
        }

        public override string ToString()
        {
            return "REP #$10";
        }

        public override string Emit()
        {
            return FormatLine("", "REP", "#$10", "3 cycles");
        }
    }

    public sealed class STACK_REL_8_BIT_STORE : CodeSequence
    {
        private readonly byte offset;

        public STACK_REL_8_BIT_STORE(byte offset) : base(4) { this.offset = offset; }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.RemoveByte((ushort)(offset + _.S.Value));
            });
        }

        public override string ToString()
        {
            return "STA " + offset.ToString("X2") + ",s";
        }

        public override string Emit()
        {
            return FormatLine("", "STA", offset.ToString("X2") + ",s", "4 cycles");
        }
    }

    public sealed class STACK_REL_8_BIT_IMMEDIATE_STORE : CodeSequence
    {
        private readonly byte value;
        private readonly byte offset;

        public STACK_REL_8_BIT_IMMEDIATE_STORE(byte value, byte offset) : base(6) { this.value = value; this.offset = offset; }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.A = _.A.LoadConstant((_.A.Value & 0xFF00) | value);
                _.RemoveByte((ushort)(offset + _.S.Value));
            });
        }

        public override string ToString()
        {
            return "LDA #$" + value.ToString("X2") + " / STA " + offset.ToString("X2") + ",s";
        }

        public override string Emit()
        {
            return String.Join("\n",
                FormatLine("", "LDA", "#$" + value.ToString("X2"), "2 cycles"),
                FormatLine("", "STA", offset.ToString("X2") + ",s", "4 cycles")
            );
        }
    }

    public sealed class STACK_REL_8_BIT_READ_MODIFY_WRITE : CodeSequence
    {
        private readonly byte value;
        private readonly byte mask;
        private readonly byte offset;

        public STACK_REL_8_BIT_READ_MODIFY_WRITE(byte value, byte mask, byte offset) : base(12) { this.value = value; this.mask = mask; this.offset = offset; }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.A = Register.UNINITIALIZED;
                _.RemoveByte((ushort)(offset + _.S.Value));
            });
        }

        public override string ToString()
        {
            return "LDA " + offset.ToString("X2") + ",s / AND #$" + mask.ToString("X2") + " / ORA #$" + value.ToString("X2") + " / STA " + offset.ToString("X2") + ",s";
        }

        public override string Emit()
        {
            return String.Join("\n",
                FormatLine("", "LDA", offset.ToString("X2") + ",s", "4 cycles"),
                FormatLine("", "AND", "#$" + mask.ToString("X2"), "2 cycles"),
                FormatLine("", "ORA", "#$" + value.ToString("X2"), "2 cycles"),
                FormatLine("", "STA", offset.ToString("X2") + ",s", "4 cycles")
            );
        }
    }

    public sealed class STACK_REL_8_BIT_READ_MODIFY_PUSH : CodeSequence
    {
        private readonly byte value;
        private readonly byte mask;

        public STACK_REL_8_BIT_READ_MODIFY_PUSH(byte value, byte mask) : base(11) { this.value = value; this.mask = mask; }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.A = Register.UNINITIALIZED;
                _.RemoveByte((ushort)_.S.Value);
                _.S.Add(-1);
            });
        }

        public override string ToString()
        {
            return "LDA 0,s / AND #$" + mask.ToString("X2") + " / ORA #$" + value.ToString("X2") + " / PHA";
        }

        public override string Emit()
        {
            return String.Join("\n",
                FormatLine("", "LDA", "0,s", "4 cycles"),
                FormatLine("", "AND", "#$" + mask.ToString("X2"), "2 cycles"),
                FormatLine("", "ORA", "#$" + value.ToString("X2"), "2 cycles"),
                FormatLine("", "PHA", "", "3 cycles")
            );
        }
    }


    public sealed class STACK_REL_16_BIT_STORE : CodeSequence
    {
        private readonly byte offset;

        public STACK_REL_16_BIT_STORE(byte offset) : base(5) { this.offset = offset; }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.RemoveWord((ushort)(offset + _.S.Value));
            });
        }

        public override string ToString()
        {
            return "STA " + offset.ToString("X2") + ",s";
        }

        public override string Emit()
        {
            return FormatLine("", "STA", offset.ToString("X2") + ",s", "5 cycles");
        }
    }

    public sealed class STACK_REL_16_BIT_READ_MODIFY_WRITE : CodeSequence
    {
        private readonly ushort value;
        private readonly ushort mask;
        private readonly byte offset;

        public STACK_REL_16_BIT_READ_MODIFY_WRITE(ushort value, ushort mask, byte offset) : base(16) { this.value = value; this.mask = mask; this.offset = offset; }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.A = Register.UNINITIALIZED;
                _.RemoveWord((ushort)(offset + _.S.Value));
            });
        }

        public override string ToString()
        {
            return "LDA " + offset.ToString("X2") + ",s / AND #$" + mask.ToString("X4") + " / ORA #$" + value.ToString("X4") + " / STA " + offset.ToString("X2") + ",s";
        }

        public override string Emit()
        {
            return String.Join("\n",
                FormatLine("", "LDA", offset.ToString("X2") + ",s", "5 cycles"),
                FormatLine("", "AND", "#$" + mask.ToString("X4"), "3 cycles"),
                FormatLine("", "ORA", "#$" + value.ToString("X4"), "3 cycles"),
                FormatLine("", "STA", offset.ToString("X2") + ",s", "5 cycles")
            );
        }
    }

    public sealed class STACK_REL_16_BIT_IMMEDIATE_STORE : CodeSequence
    {
        private readonly ushort value;
        private readonly byte offset;

        public STACK_REL_16_BIT_IMMEDIATE_STORE(ushort value, byte offset) : base(8) { this.value = value; this.offset = offset; }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.A = _.A.LoadConstant(value);
                _.RemoveWord((ushort)(offset + _.S.Value));
            });
        }

        public override string ToString()
        {
            return "LDA #$" + value.ToString("X4") + " / STA " + offset.ToString("X2") + ",s";
        }

        public override string Emit()
        {
            return String.Join("\n",
                FormatLine("", "LDA", "#$" + value.ToString("X4"), "3 cycles"),
                FormatLine("", "STA", offset.ToString("X2") + ",s", "5 cycles")
            );
        }
    }

    public sealed class LOAD_16_BIT_IMMEDIATE_AND_PUSH : CodeSequence
    {
        private readonly ushort value;

        public LOAD_16_BIT_IMMEDIATE_AND_PUSH(ushort value) : base(7) { this.value = value; }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.A = _.A.LoadConstant(value);
                _.RemoveWord((ushort)(_.S.Value - 1));
                _.S = _.S.Add(-2);
            });
        }

        public override string ToString()
        {
            return "LDA #$" + value.ToString("X4") + " / PHA";
        }

        public override string Emit()
        {
            return String.Join("\n",
                FormatLine("", "LDA", "#$" + value.ToString("X4"), "3 cycles"),
                FormatLine("", "PHA", "", "4 cycles")
            );
        }
    }

    public sealed class LOAD_8_BIT_IMMEDIATE_AND_PUSH : CodeSequence
    {
        private readonly byte value;

        public LOAD_8_BIT_IMMEDIATE_AND_PUSH(byte value) : base(5) { this.value = value; }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.A = _.A.LoadConstant(value);      // Need to be able to track high / low bytes independently...
                _.RemoveByte((ushort)(_.S.Value));
                _.S = _.S.Add(-1);
            });
        }

        public override string ToString()
        {
            return "LDA #$" + value.ToString("X2") + " / PHA";
        }

        public override string Emit()
        {
            return String.Join("\n",
                FormatLine("", "LDA", "#$" + value.ToString("X2"), "2 cycles"),
                FormatLine("", "PHA", "", "3 cycles")
            );
        }
    }


    public sealed class PEA : CodeSequence
    {
        private readonly ushort value;

        public PEA(ushort value) : base(5) { this.value = value; }
    
        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.RemoveWord((ushort)(_.S.Value - 1));
                _.S = _.S.Add(-2);
            });
        }

        public override string ToString()
        {
            return "PEA $" + value.ToString("X4");
        }

        public override string Emit()
        {
            return FormatLine("", "PEA", "$" + value.ToString("X4"), "5 cycles");
        }
    }

    public sealed class PHA_16 : CodeSequence
    {
        public PHA_16() : base(4) { }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.RemoveWord((ushort)(_.S.Value - 1));
                _.S = _.S.Add(-2);
            });
        }

        public override string ToString()
        {
            return "PHA";
        }

        public override string Emit()
        {
            return FormatLine("", "PHA", "", "4 cycles");
        }
    }

    public sealed class PHA_8 : CodeSequence
    {
        public PHA_8() : base(3) { }

        public override SpriteGeneratorState Apply(SpriteGeneratorState state)
        {
            return state.Clone(_ =>
            {
                _.RemoveByte((ushort)(_.S.Value));
                _.S = _.S.Add(-1);
            });
        }

        public override string ToString()
        {
            return "PHA";
        }

        public override string Emit()
        {
            return FormatLine("", "PHA", "", "3 cycles");
        }
    }

}