using HavenSoft.HexManiac.Core.Models.Runs; using HavenSoft.HexManiac.Core.ViewModels; using HavenSoft.HexManiac.Core.ViewModels.DataFormats; using System; using System.Collections.Generic; using System.Globalization; using System.Linq; using System.Text; namespace HavenSoft.HexManiac.Core.Models.Code { public class ScriptParser { private readonly IReadOnlyList engine; public event EventHandler CompileError; public ScriptParser(IReadOnlyList engine) => this.engine = engine; public int GetScriptSegmentLength(IDataModel model, int address) => engine.GetScriptSegmentLength(model, address); public string Parse(IDataModel data, int start, int length) { var builder = new StringBuilder(); foreach (var line in Decompile(data, start, length)) builder.AppendLine(line); return builder.ToString(); } public List CollectScripts(IDataModel model, int address) { if (address < 0 || address >= model.Count) return new List(); var scripts = new List { address }; for (int i = 0; i < scripts.Count; i++) { address = scripts[i]; int length = 0; while (true) { var line = engine.GetMatchingLine(model, address + length); if (line == null) break; length += line.LineCode.Count; foreach (var arg in line.Args) { if (arg.Type == ArgType.Pointer) { var destination = model.ReadPointer(address + length); if (destination >= 0 && destination < model.Count && line.PointsToNextScript && !scripts.Contains(destination) ) { scripts.Add(destination); } } length += arg.Length; } if (line.IsEndingCommand) break; } } return scripts; } public int FindLength(IDataModel model, int address) { int length = 0; while (true) { var line = engine.GetMatchingLine(model, address + length); if (line == null) break; length += line.CompiledByteLength; if (line.IsEndingCommand) break; } return length; } // TODO refactor to rely on CollectScripts rather than duplicate code public void FormatScript(ModelDelta token, IDataModel model, int address, IReadOnlyList sources = null) where TSERun : IScriptStartRun { Func, IScriptStartRun> constructor = (a, s) => new XSERun(a, s); if (typeof(TSERun) == typeof(BSERun)) constructor = (a, s) => new BSERun(a, s); var processed = new List(); var toProcess = new List { address }; while (toProcess.Count > 0) { address = toProcess.Last(); toProcess.RemoveAt(toProcess.Count - 1); if (processed.Contains(address)) continue; var existingRun = model.GetNextRun(address); if (!(existingRun is TSERun && existingRun.Start == address)) { if (sources == null && existingRun.Start != address) sources = model.SearchForPointersToAnchor(token, address); model.ObserveAnchorWritten(token, string.Empty, constructor(address, sources)); sources = null; } int length = 0; while (true) { var line = engine.GetMatchingLine(model, address + length); if (line == null) break; length += line.LineCode.Count; foreach (var arg in line.Args) { if (arg.Type != ArgType.Pointer) { length += arg.Length; continue; } var destination = model.ReadPointer(address + length); if (destination >= 0 && destination < model.Count) { model.ClearFormat(token, address + length, 4); model.ObserveRunWritten(token, new PointerRun(address + length)); if (line.PointsToNextScript) toProcess.Add(destination); if (line.PointsToText) { var destinationLength = PCSString.ReadString(model, destination, true); if (destinationLength > 0) model.ObserveRunWritten(token, new PCSRun(model, destination, destinationLength)); } else if (line.PointsToMovement) { WriteMovementStream(model, token, destination, address + length); } else if (line.PointsToMart) { WriteMartStream(model, token, destination, address + length); } } length += arg.Length; } if (line.IsEndingCommand) break; } processed.Add(address); } } private void WriteMovementStream(IDataModel model, ModelDelta token, int start, int source) { TableStreamRun.TryParseTableStream(model, start, new[] { source }, string.Empty, "[move.movementtypes]!FE", null, out var tsRun); if (tsRun != null) model.ObserveRunWritten(token, tsRun); } private void WriteMartStream(IDataModel model, ModelDelta token, int start, int source) { TableStreamRun.TryParseTableStream(model, start, new[] { source }, string.Empty, $"[move:{HardcodeTablesModel.ItemsTableName}]!0000", null, out var tsRun); if (tsRun != null) model.ObserveRunWritten(token, tsRun); } public byte[] Compile(ModelDelta token, IDataModel model, ref string script, out IReadOnlyList<(int originalLocation, int newLocation)> movedData) { movedData = new List<(int, int)>(); var lines = script.Split(new[] { Environment.NewLine }, StringSplitOptions.None) .Select(line => line.Split('#').First()) .Where(line => !string.IsNullOrWhiteSpace(line)) .ToArray(); var result = new List(); int streamLocation = -1, streamPointerLocation = -1; for (var i = 0; i < lines.Length; i++) { var line = lines[i].Trim(); if (line == "{") { var streamStart = i + 1; var indentCount = 1; i += 2; while (indentCount > 0) { line = lines[i].Trim(); if (line == "{") indentCount += 1; if (line == "}") indentCount -= 1; i += 1; if (i == lines.Length) break; } i -= 1; var streamEnd = i; var stream = lines.Skip(streamStart).Take(streamEnd - streamStart).Aggregate((a, b) => a + Environment.NewLine + b); // Let the stream run handle updating itself based on the stream content. if (streamLocation >= 0 && streamPointerLocation >= 0) { var streamRun = model.GetNextRun(streamLocation) as IStreamRun; if (streamRun != null && streamRun.Start == streamLocation) { streamRun = streamRun.DeserializeRun(stream, token); // alter script content and compiled byte location based on stream move if (streamRun.Start != streamLocation) { script = script.Replace(streamLocation.ToString("X6"), streamRun.Start.ToString("X6")); result[streamPointerLocation + 0] = (byte)(streamLocation >> 0); result[streamPointerLocation + 1] = (byte)(streamLocation >> 8); result[streamPointerLocation + 2] = (byte)(streamLocation >> 16); result[streamPointerLocation + 3] = (byte)((streamLocation >> 24) + 0x08); ((List<(int, int)>)movedData).Add((streamLocation, streamRun.Start)); } } } continue; } streamLocation = -1; streamPointerLocation = -1; foreach (var command in engine) { if (!(line + " ").StartsWith(command.LineCommand + " ")) continue; var currentSize = result.Count; if (line.Contains("")) { int newAddress = -1; if (command.PointsToMovement) { newAddress = model.FindFreeSpace(0, 0x10); token.ChangeData(model, newAddress, 0xFE); } else if (command.PointsToText) { newAddress = model.FindFreeSpace(0, 0x10); token.ChangeData(model, newAddress, 0xFF); } else if (command.PointsToMart) { newAddress = model.FindFreeSpace(0, 0x10); token.ChangeData(model, newAddress, 0x00); token.ChangeData(model, newAddress + 1, 0x00); } else if (command.PointsToNextScript) { newAddress = model.FindFreeSpace(0, 0x10); token.ChangeData(model, newAddress, 0x02); } if (newAddress != -1) { line = line.Replace("", $"<{newAddress:X6}>"); if (command.PointsToNextScript) { script = script.Replace("", $"<{newAddress:X6}>"); } else { script = script.Replace("", $"<{newAddress:X6}>{Environment.NewLine}{{{Environment.NewLine}}}"); } } } var error = command.Compile(model, line, out var code); if (error == null) { result.AddRange(code); } else { CompileError?.Invoke(this, i + ": " + error); return null; } if (command.PointsToMovement || command.PointsToText || command.PointsToMart) { var pointerOffset = command.Args.Until(arg => arg.Type == ArgType.Pointer).Sum(arg => arg.Length) + command.LineCode.Count; var destination = result.ReadMultiByteValue(currentSize + pointerOffset, 4) - 0x8000000; if (destination >= 0) { streamPointerLocation = currentSize + pointerOffset; streamLocation = destination; } } break; } } if (result.Count == 0) result.Add(0x02); // end return result.ToArray(); } public string GetHelp(string currentLine) { var candidates = engine.Where(line => line.LineCommand.Contains(currentLine.Split(' ')[0])).ToList(); if (candidates.Count > 10) return null; if (candidates.Count == 0) return null; if (candidates.Count == 1) return candidates[0].Usage + Environment.NewLine + string.Join(Environment.NewLine, candidates[0].Documentation); var perfectMatch = candidates.FirstOrDefault(candidate => (currentLine + " ").StartsWith(candidate.LineCommand + " ")); if (perfectMatch != null) return perfectMatch.Usage + Environment.NewLine + string.Join(Environment.NewLine, perfectMatch.Documentation); return string.Join(Environment.NewLine, candidates.Select(line => line.Usage)); } private string[] Decompile(IDataModel data, int index, int length) { var results = new List(); while (length > 0) { var line = engine.FirstOrDefault(option => Enumerable.Range(0, option.LineCode.Count).All(i => data[index + i] == option.LineCode[i])); if (line == null) { results.Add($".raw {data[index]:X2}"); index += 1; length -= 1; } else { results.Add(line.Decompile(data, index)); index += line.CompiledByteLength; length -= line.CompiledByteLength; if (line.IsEndingCommand) break; } } return results.ToArray(); } } public interface IScriptLine { IReadOnlyList Args { get; } IReadOnlyList LineCode { get; } string LineCommand { get; } int CompiledByteLength { get; } bool IsEndingCommand { get; } bool PointsToNextScript { get; } bool PointsToText { get; } bool PointsToMovement { get; } bool PointsToMart { get; } bool Matches(IReadOnlyList data, int index); string Compile(IDataModel model, string scriptLine, out byte[] result); string Decompile(IDataModel data, int start); } public abstract class ScriptLine : IScriptLine { private readonly List documentation = new List(); public const string Hex = "0123456789ABCDEF"; public IReadOnlyList Args { get; } public IReadOnlyList LineCode { get; } public string LineCommand { get; } public int CompiledByteLength { get; } public IReadOnlyList Documentation => documentation; public string Usage { get; } public virtual bool IsEndingCommand { get; } public virtual bool PointsToNextScript { get; } public virtual bool PointsToText { get; } public virtual bool PointsToMovement { get; } public virtual bool PointsToMart { get; } public ScriptLine(string engineLine) { var docSplit = engineLine.Split(new[] { '#' }, 2); if (docSplit.Length > 1) documentation.Add('#' + docSplit[1]); engineLine = docSplit[0].Trim(); Usage = engineLine.Split(new[] { ' ' }, 2).Last(); var tokens = engineLine.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries); var lineCode = new List(); var args = new List(); foreach (var token in tokens) { if (token.Length == 2 && token.All(ViewPort.AllHexCharacters.Contains)) { lineCode.Add(byte.Parse(token, NumberStyles.HexNumber)); continue; } if ("<> : .".Split(' ').Any(token.Contains)) { args.Add(new ScriptArg(token)); continue; } LineCommand = token; } LineCode = lineCode; Args = args; CompiledByteLength = LineCode.Count + Args.Sum(arg => arg.Length); } public void AddDocumentation(string doc) => documentation.Add(doc); public bool PartialMatchLine(string line) => LineCommand.MatchesPartial(line.Split(' ')[0]); public bool Matches(IReadOnlyList data, int index) { if (index + LineCode.Count >= data.Count) return false; return Enumerable.Range(0, LineCode.Count).All(i => data[index + i] == LineCode[i]); } public string Compile(IDataModel model, string scriptLine, out byte[] result) { result = null; var tokens = Tokenize(scriptLine); if (tokens[0] != LineCommand) throw new ArgumentException($"Command {LineCommand} was expected, but received {tokens[0]} instead."); if (Args.Count != tokens.Length - 1) { return $"Command {LineCommand} expects {Args.Count} arguments, but received {tokens.Length - 1} instead."; } var results = new List(LineCode); for (int i = 0; i < Args.Count; i++) { var token = tokens[i + 1]; if (Args[i].Type == ArgType.Byte) { results.Add((byte)Args[i].Convert(model, token)); } else if (Args[i].Type == ArgType.Short) { var value = Args[i].Convert(model, token); results.Add((byte)value); results.Add((byte)(value >> 8)); } else if (Args[i].Type == ArgType.Word) { var value = Args[i].Convert(model, token); results.Add((byte)value); results.Add((byte)(value >> 0x8)); results.Add((byte)(value >> 0x10)); results.Add((byte)(value >> 0x18)); } else if (Args[i].Type == ArgType.Pointer) { int value; if (token.StartsWith("<")) { if (!token.EndsWith(">")) { return "Unmatched <>"; } token = token.Substring(1, token.Length - 2); if (!int.TryParse(token, NumberStyles.HexNumber, CultureInfo.CurrentCulture, out value)) { return $"Unable to parse {token} as a hex number."; } value += 0x8000000; } else { value = int.Parse(token, NumberStyles.HexNumber); } results.Add((byte)value); results.Add((byte)(value >> 0x8)); results.Add((byte)(value >> 0x10)); results.Add((byte)(value >> 0x18)); } else { throw new NotImplementedException(); } } result = results.ToArray(); return null; } public string Decompile(IDataModel data, int start) { for (int i = 0; i < LineCode.Count; i++) { if (LineCode[i] != data[start + i]) throw new ArgumentException($"Data at {start:X6} does not match the {LineCommand} command."); } start += LineCode.Count; var builder = new StringBuilder(LineCommand); int lastAddress = -1; foreach (var arg in Args) { builder.Append(" "); if (arg.Type == ArgType.Byte) builder.Append($"{arg.Convert(data, data[start])}"); if (arg.Type == ArgType.Short) builder.Append($"{arg.Convert(data, data.ReadMultiByteValue(start, 2))}"); if (arg.Type == ArgType.Word) builder.Append($"{arg.Convert(data, data.ReadMultiByteValue(start, 4))}"); if (arg.Type == ArgType.Pointer) { var address = data.ReadMultiByteValue(start, 4); if (address < 0x8000000) { builder.Append(address.ToString("X6")); } else { address -= 0x8000000; builder.Append($"<{address:X6}>"); lastAddress = address; } } start += arg.Length; } if (PointsToText || PointsToMovement || PointsToMart) { var stream = data.GetNextRun(lastAddress) as IStreamRun; if (stream != null) { builder.AppendLine(); builder.AppendLine("{"); builder.AppendLine(stream.SerializeRun()); builder.Append("}"); } } return builder.ToString(); } public static string ReadString(IReadOnlyList data, int start) { var length = PCSString.ReadString(data, start, true); return PCSString.Convert(data, start, length); } private static string[] Tokenize(string scriptLine) { var result = new List(); var quoteCut = scriptLine.Split('"'); for (int i = 0; i < quoteCut.Length; i++) { if (i % 2 == 0 && quoteCut[i].Length == 0) continue; if (i % 2 == 1) result.Add($"\"{quoteCut[i]}\""); else result.AddRange(quoteCut[i].Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries)); } return result.ToArray(); } } public class XSEScriptLine : ScriptLine { public XSEScriptLine(string engineLine) : base(engineLine) { } public override bool IsEndingCommand => LineCode.Count == 1 && LineCode[0].IsAny(0x02, 0x03, 0x05, 0x08, 0x0A, 0x0C, 0x0D); public override bool PointsToNextScript => LineCode.Count == 1 && LineCode[0].IsAny(4, 5, 6, 7); public override bool PointsToText => LineCode.Count == 1 && LineCode[0].IsAny(0x0F, 0x67); public override bool PointsToMovement => LineCode.Count == 1 && LineCode[0].IsAny(0x4F, 0x50); public override bool PointsToMart => LineCode.Count == 1 && LineCode[0].IsAny(0x86, 0x87, 0x88); } public class BSEScriptLine : ScriptLine { public BSEScriptLine(string engineLine) : base(engineLine) { } public override bool IsEndingCommand => LineCode.Count == 1 && LineCode[0].IsAny(0x28, 0x3c, 0x3d, 0x3e, 0x3f); public override bool PointsToNextScript => LineCode.Count == 1 && LineCode[0].IsAny(0x01, 0x28, 0x97); public override bool PointsToText => false; public override bool PointsToMovement => false; public override bool PointsToMart => false; } public class ScriptArg { public ArgType Type { get; } public string Name { get; } public string EnumTableName { get; } public int Length { get; } public ScriptArg(string token) { if (token.Contains("<>")) { (Type, Length) = (ArgType.Pointer, 4); Name = token.Split(new[] { "<>" }, StringSplitOptions.None).First(); } else if (token.Contains(".")) { (Type, Length) = (ArgType.Byte, 1); Name = token.Split('.').First(); EnumTableName = token.Split('.').Last(); } else if (token.Contains("::")) { (Type, Length) = (ArgType.Word, 4); Name = token.Split(new[] { "::" }, StringSplitOptions.None).First(); EnumTableName = token.Split("::").Last(); } else if (token.Contains(":")) { (Type, Length) = (ArgType.Short, 2); Name = token.Split(':').First(); EnumTableName = token.Split(':').Last(); } else { // didn't find a token :( // I guess it's a byte? (Type, Length) = (ArgType.Byte, 1); Name = token; } } public string Convert(IDataModel model, int value) { var byteText = value.ToString($"X{Length * 2}"); if (string.IsNullOrEmpty(EnumTableName)) return byteText; var table = model.GetOptions(EnumTableName); if ((table?.Count ?? 0) <= value) return byteText; return table[value]; } public int Convert(IDataModel model, string value) { int result; if (string.IsNullOrEmpty(EnumTableName)) { if (int.TryParse(value, NumberStyles.HexNumber, CultureInfo.CurrentCulture, out result)) return result; return 0; } if (ArrayRunEnumSegment.TryParse(EnumTableName, model, value, out result)) return result; return 0; } } public enum ArgType { Byte, Short, Word, Pointer, } public static class ScriptExtensions { public static ScriptLine GetMatchingLine(this IReadOnlyList self, IReadOnlyList data, int start) => self.FirstOrDefault(option => option.Matches(data, start)); public static int GetScriptSegmentLength(this IReadOnlyList self, IDataModel model, int address) { int length = 0; while (true) { var line = self.GetMatchingLine(model, address + length); if (line == null) break; length += line.CompiledByteLength; if (line.IsEndingCommand) break; } return length; } } }