From 97222f2c5bb71cac1f167b3bf44f55562ad41596 Mon Sep 17 00:00:00 2001 From: YoshiRulz Date: Tue, 3 Aug 2021 01:46:17 +1000 Subject: [PATCH] Make the default index 1 for NLuaTableHelper.ListToTable --- .../lua/CommonLibs/ClientLuaLibrary.cs | 3 ++- .../lua/CommonLibs/CommLuaLibrary.cs | 4 +--- .../lua/CommonLibs/MemoryLuaLibrary.cs | 8 +++++--- .../lua/CommonLibs/MovieLuaLibrary.cs | 6 ++++-- src/BizHawk.Client.Common/lua/LuaHelper.cs | 3 ++- .../lua/LuaHelperLibs/EventsLuaLibrary.cs | 2 +- .../lua/LuaHelperLibs/MainMemoryLuaLibrary.cs | 5 +++-- .../lua/LuaHelperLibs/StringLuaLibrary.cs | 2 +- .../lua/NLuaTableHelper.cs | 2 +- .../tools/Lua/Libraries/TAStudioLuaLibrary.cs | 18 +++++++++++------- 10 files changed, 31 insertions(+), 22 deletions(-) diff --git a/src/BizHawk.Client.Common/lua/CommonLibs/ClientLuaLibrary.cs b/src/BizHawk.Client.Common/lua/CommonLibs/ClientLuaLibrary.cs index b0adbf2428..d2155f478a 100644 --- a/src/BizHawk.Client.Common/lua/CommonLibs/ClientLuaLibrary.cs +++ b/src/BizHawk.Client.Common/lua/CommonLibs/ClientLuaLibrary.cs @@ -272,7 +272,8 @@ namespace BizHawk.Client.Common [LuaMethodExample("local nlcliget = client.getavailabletools( );")] [LuaMethod("getavailabletools", "Returns a list of the tools currently open")] - public LuaTable GetAvailableTools() => _th.EnumerateToLuaTable(APIs.Tool.AvailableTools.Select(tool => tool.Name.ToLower())); + public LuaTable GetAvailableTools() + => _th.EnumerateToLuaTable(APIs.Tool.AvailableTools.Select(tool => tool.Name.ToLower()), indexFrom: 0); [LuaMethodExample("local nlcliget = client.gettool( \"Tool name\" );")] [LuaMethod("gettool", "Returns an object that represents a tool of the given name (not case sensitive). If the tool is not open, it will be loaded if available. Use gettools to get a list of names")] diff --git a/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs b/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs index 93bfd34e1c..1517bda741 100644 --- a/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs +++ b/src/BizHawk.Client.Common/lua/CommonLibs/CommLuaLibrary.cs @@ -175,9 +175,7 @@ namespace BizHawk.Client.Common } [LuaMethod("mmfReadBytes", "Reads bytes from a memory mapped file")] public LuaTable MmfReadBytes(string mmf_filename, int expectedSize) - { - return _th.ListToTable(APIs.Comm.MMF.ReadBytesFromFile(mmf_filename, expectedSize)); - } + => _th.ListToTable(APIs.Comm.MMF.ReadBytesFromFile(mmf_filename, expectedSize), indexFrom: 0); // All HTTP related methods [LuaMethod("httpTest", "tests HTTP connections")] diff --git a/src/BizHawk.Client.Common/lua/CommonLibs/MemoryLuaLibrary.cs b/src/BizHawk.Client.Common/lua/CommonLibs/MemoryLuaLibrary.cs index 73e42a788d..fda4ed3bd1 100644 --- a/src/BizHawk.Client.Common/lua/CommonLibs/MemoryLuaLibrary.cs +++ b/src/BizHawk.Client.Common/lua/CommonLibs/MemoryLuaLibrary.cs @@ -17,7 +17,8 @@ namespace BizHawk.Client.Common [LuaMethodExample("local nlmemget = memory.getmemorydomainlist();")] [LuaMethod("getmemorydomainlist", "Returns a string of the memory domains for the loaded platform core. List will be a single string delimited by line feeds")] - public LuaTable GetMemoryDomainList() => _th.ListToTable(APIs.Memory.GetMemoryDomainList()); + public LuaTable GetMemoryDomainList() + => _th.ListToTable(APIs.Memory.GetMemoryDomainList(), indexFrom: 0); [LuaMethodExample("local uimemget = memory.getmemorydomainsize( mainmemory.getname( ) );")] [LuaMethod("getmemorydomainsize", "Returns the number of bytes of the specified memory domain. If no domain is specified, or the specified domain doesn't exist, returns the current domain size")] @@ -49,12 +50,13 @@ namespace BizHawk.Client.Common [LuaDeprecatedMethod] [LuaMethod("readbyterange", "Reads the address range that starts from address, and is length long. Returns a zero-indexed table containing the read values (an array of bytes.)")] - public LuaTable ReadByteRange(long addr, int length, string domain = null) => _th.ListToTable(APIs.Memory.ReadByteRange(addr, length, domain)); + public LuaTable ReadByteRange(long addr, int length, string domain = null) + => _th.ListToTable(APIs.Memory.ReadByteRange(addr, length, domain), indexFrom: 0); [LuaMethodExample("local bytes = memory.read_bytes_as_array(0x100, 30, \"WRAM\");")] [LuaMethod("read_bytes_as_array", "Reads length bytes starting at addr into an array-like table (1-indexed).")] public LuaTable ReadBytesAsArray(long addr, int length, string domain = null) - => _th.ListToTable(APIs.Memory.ReadByteRange(addr, length, domain), indexFrom: 1); + => _th.ListToTable(APIs.Memory.ReadByteRange(addr, length, domain)); [LuaMethodExample("local bytes = memory.read_bytes_as_dict(0x100, 30, \"WRAM\");")] [LuaMethod("read_bytes_as_dict", "Reads length bytes starting at addr into a dict-like table (where the keys are the addresses, relative to the start of the domain).")] diff --git a/src/BizHawk.Client.Common/lua/CommonLibs/MovieLuaLibrary.cs b/src/BizHawk.Client.Common/lua/CommonLibs/MovieLuaLibrary.cs index 5dda21ba6c..fd39685478 100644 --- a/src/BizHawk.Client.Common/lua/CommonLibs/MovieLuaLibrary.cs +++ b/src/BizHawk.Client.Common/lua/CommonLibs/MovieLuaLibrary.cs @@ -86,10 +86,12 @@ namespace BizHawk.Client.Common [LuaMethodExample("local nlmovget = movie.getcomments( );")] [LuaMethod("getcomments", "If a movie is active, will return the movie comments as a lua table")] - public LuaTable GetComments() => _th.ListToTable(APIs.Movie.GetComments()); + public LuaTable GetComments() + => _th.ListToTable(APIs.Movie.GetComments(), indexFrom: 0); [LuaMethodExample("local nlmovget = movie.getsubtitles( );")] [LuaMethod("getsubtitles", "If a movie is active, will return the movie subtitles as a lua table")] - public LuaTable GetSubtitles() => _th.ListToTable(APIs.Movie.GetSubtitles()); + public LuaTable GetSubtitles() + => _th.ListToTable(APIs.Movie.GetSubtitles(), indexFrom: 0); } } diff --git a/src/BizHawk.Client.Common/lua/LuaHelper.cs b/src/BizHawk.Client.Common/lua/LuaHelper.cs index d6e554c395..f48feda4c0 100644 --- a/src/BizHawk.Client.Common/lua/LuaHelper.cs +++ b/src/BizHawk.Client.Common/lua/LuaHelper.cs @@ -19,6 +19,7 @@ namespace BizHawk.Client.Common /// ≥ 2^53 or ≤ -2^53 public static long AsInteger(this double d) => PrecisionLimits.Contains(d) ? (long) d : throw new ArithmeticException("integer value exceeds the precision of Lua's integer-as-double"); - public static LuaTable EnumerateToLuaTable(this NLuaTableHelper tableHelper, IEnumerable list) => tableHelper.ListToTable(list.ToList()); + public static LuaTable EnumerateToLuaTable(this NLuaTableHelper tableHelper, IEnumerable list, int indexFrom = 1) + => tableHelper.ListToTable(list.ToList(), indexFrom); } } diff --git a/src/BizHawk.Client.Common/lua/LuaHelperLibs/EventsLuaLibrary.cs b/src/BizHawk.Client.Common/lua/LuaHelperLibs/EventsLuaLibrary.cs index 6c4e5b6dcf..66fa90b2e2 100644 --- a/src/BizHawk.Client.Common/lua/LuaHelperLibs/EventsLuaLibrary.cs +++ b/src/BizHawk.Client.Common/lua/LuaHelperLibs/EventsLuaLibrary.cs @@ -251,7 +251,7 @@ namespace BizHawk.Client.Common public LuaTable AvailableScopes() { return DebuggableCore?.MemoryCallbacksAvailable() == true - ? _th.ListToTable(DebuggableCore.MemoryCallbacks.AvailableScopes) + ? _th.ListToTable(DebuggableCore.MemoryCallbacks.AvailableScopes, indexFrom: 0) : _th.CreateTable(); } diff --git a/src/BizHawk.Client.Common/lua/LuaHelperLibs/MainMemoryLuaLibrary.cs b/src/BizHawk.Client.Common/lua/LuaHelperLibs/MainMemoryLuaLibrary.cs index 6bd84727c1..aee0ed1340 100644 --- a/src/BizHawk.Client.Common/lua/LuaHelperLibs/MainMemoryLuaLibrary.cs +++ b/src/BizHawk.Client.Common/lua/LuaHelperLibs/MainMemoryLuaLibrary.cs @@ -46,12 +46,13 @@ namespace BizHawk.Client.Common [LuaDeprecatedMethod] [LuaMethod("readbyterange", "Reads the address range that starts from address, and is length long. Returns a zero-indexed table containing the read values (an array of bytes.)")] - public LuaTable ReadByteRange(long addr, int length) => _th.ListToTable(APIs.Memory.ReadByteRange(addr, length, MainMemName)); + public LuaTable ReadByteRange(long addr, int length) + => _th.ListToTable(APIs.Memory.ReadByteRange(addr, length, MainMemName), indexFrom: 0); [LuaMethodExample("local bytes = mainmemory.read_bytes_as_array(0x100, 30);")] [LuaMethod("read_bytes_as_array", "Reads length bytes starting at addr into an array-like table (1-indexed).")] public LuaTable ReadBytesAsArray(long addr, int length) - => _th.ListToTable(APIs.Memory.ReadByteRange(addr, length, MainMemName), indexFrom: 1); + => _th.ListToTable(APIs.Memory.ReadByteRange(addr, length, MainMemName)); [LuaMethodExample("local bytes = mainmemory.read_bytes_as_dict(0x100, 30);")] [LuaMethod("read_bytes_as_dict", "Reads length bytes starting at addr into a dict-like table (where the keys are the addresses, relative to the start of the main memory).")] diff --git a/src/BizHawk.Client.Common/lua/LuaHelperLibs/StringLuaLibrary.cs b/src/BizHawk.Client.Common/lua/LuaHelperLibs/StringLuaLibrary.cs index 6fc5040551..2af9611760 100644 --- a/src/BizHawk.Client.Common/lua/LuaHelperLibs/StringLuaLibrary.cs +++ b/src/BizHawk.Client.Common/lua/LuaHelperLibs/StringLuaLibrary.cs @@ -126,6 +126,6 @@ namespace BizHawk.Client.Common [LuaMethod("split", "Splits str into a Lua-style array using the given separator (consecutive separators in str will NOT create empty entries in the array). If the separator is not a string exactly one char long, ',' will be used.")] public LuaTable Split(string str, string separator) => string.IsNullOrEmpty(str) ? _th.CreateTable() - : _th.ListToTable(str.Split(new[] { separator?.Length == 1 ? separator[0] : ',' }, StringSplitOptions.RemoveEmptyEntries), indexFrom: 1); + : _th.ListToTable(str.Split(new[] { separator?.Length == 1 ? separator[0] : ',' }, StringSplitOptions.RemoveEmptyEntries)); } } diff --git a/src/BizHawk.Client.Common/lua/NLuaTableHelper.cs b/src/BizHawk.Client.Common/lua/NLuaTableHelper.cs index 0ad95fd7a4..da28d73cea 100644 --- a/src/BizHawk.Client.Common/lua/NLuaTableHelper.cs +++ b/src/BizHawk.Client.Common/lua/NLuaTableHelper.cs @@ -39,7 +39,7 @@ namespace BizHawk.Client.Common public IEnumerable EnumerateValues(LuaTable table) => table.Values.Cast(); - public LuaTable ListToTable(IList list, int indexFrom = 0) + public LuaTable ListToTable(IList list, int indexFrom = 1) { var table = _lua.NewTable(); for (int i = 0, l = list.Count; i != l; i++) table[indexFrom + i] = list[i]; diff --git a/src/BizHawk.Client.EmuHawk/tools/Lua/Libraries/TAStudioLuaLibrary.cs b/src/BizHawk.Client.EmuHawk/tools/Lua/Libraries/TAStudioLuaLibrary.cs index 699c1ccab9..f4918f266c 100644 --- a/src/BizHawk.Client.EmuHawk/tools/Lua/Libraries/TAStudioLuaLibrary.cs +++ b/src/BizHawk.Client.EmuHawk/tools/Lua/Libraries/TAStudioLuaLibrary.cs @@ -165,7 +165,9 @@ namespace BizHawk.Client.EmuHawk [LuaMethodExample("local nltasget = tastudio.getselection( );")] [LuaMethod("getselection", "gets the currently selected frames")] - public LuaTable GetSelection() => Engaged() ? _th.EnumerateToLuaTable(Tastudio.GetSelection()) : _th.CreateTable(); + public LuaTable GetSelection() => Engaged() + ? _th.EnumerateToLuaTable(Tastudio.GetSelection(), indexFrom: 0) + : _th.CreateTable(); [LuaMethodExample("")] [LuaMethod("submitinputchange", "")] @@ -376,12 +378,14 @@ namespace BizHawk.Client.EmuHawk public LuaTable GetBranches() { if (!Engaged()) return _th.CreateTable(); - return _th.EnumerateToLuaTable(Tastudio.CurrentTasMovie.Branches.Select(b => new - { - Id = b.Uuid.ToString(), - b.Frame, - Text = b.UserText - })); + return _th.EnumerateToLuaTable( + Tastudio.CurrentTasMovie.Branches.Select(b => new + { + Id = b.Uuid.ToString(), + b.Frame, + Text = b.UserText + }), + indexFrom: 0); } [LuaMethodExample("local nltasget = tastudio.getbranchinput( \"97021544-2454-4483-824f-47f75e7fcb6a\", 500 );")]