Lua:registerAutoAssemblerCommand - Revision history

TheyCallMeTim13: /* Related Functions */

2018-01-25T01:20:19Z

‎Related Functions

TheyCallMeTim13: moved registerAutoAssemblerCommand to Lua:registerAutoAssemblerCommand

2018-01-25T00:15:48Z

moved registerAutoAssemblerCommand to Lua:registerAutoAssemblerCommand

TheyCallMeTim13 at 19:42, 13 January 2018

2018-01-13T19:42:29Z

Show changes

TheyCallMeTim13: /* Example 1 */

2018-01-13T19:40:49Z

‎Example 1

TheyCallMeTim13: /* Felated Functions */

2018-01-13T19:32:05Z

‎Felated Functions

TheyCallMeTim13 at 19:31, 13 January 2018

2018-01-13T19:31:42Z

TheyCallMeTim13 at 19:29, 13 January 2018

2018-01-13T19:29:26Z

TheyCallMeTim13 at 19:25, 13 January 2018

2018-01-13T19:25:29Z

TheyCallMeTim13: Created page with 'Category:Lua '''function''' registerAutoAssemblerCommand(''Command'', ''Function'''(parameters, syntaxcheckonly)''' '') Registers an auto assembler command to call the speci…'

2018-01-13T19:20:21Z

Created page with 'Category:Lua '''function''' registerAutoAssemblerCommand(''Command'', ''Function'''(parameters, syntaxcheckonly)''' '') Registers an auto assembler command to call the speci…'

New page

[[Category:Lua]]
'''function''' registerAutoAssemblerCommand(''Command'', ''Function'''(parameters, syntaxcheckonly)''' '')

Registers an auto assembler command to call the specified function. The command will be replaced by the string this function returns when executed. The function can be called twice. Once for syntax check and symbol lookup (1), and the second time for actual execution by the assembler (2) if it has not been removed in phase 1.

If the function returns nil, and as secondary parameter a string, this will make the auto assembler fail with that error.
:Note: You will only get a message pop-up if the Auto Assembler is preforming a syntax check.

The Auto Assembler form syntax highlighter will highlight the registered command.

== Function Parameters ==
{|width="85%" cellpadding="10%" cellpadding="5%" cellspacing="0" border="0"
!align="left"|Parameter
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|Command
|String
|The command string it self
|-
|Function
|Function
|The Lua function to be called when the command string is found in an Auto Assembler script
|}

=== Callback Function Parameters ===
{|width="85%" cellpadding="10%" cellpadding="5%" cellspacing="0" border="0"
!align="left"|Parameter
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|parameters
|String
|This will be the string between parenthesis after the command string
|-
|syntaxcheckonly
|Boolean
|This will be ''true'' if the script is running though a syntax check
|}

==== Callback Function Return(s) ====
{|width="85%" cellpadding="10%" cellpadding="5%" cellspacing="0" border="0"
!align="left"|Parameter
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|ReplaceString
|String or Nil
|This will replace the commands line in the Auto Assembler script, can be a multi-line string, if Nil the commands line is removed
|-
|ErrorMessage
|String or Nil (OPTIONAL)
|if the ''ReplaceString'' is nil and this is set to a string then, this will raise an error with the given error message for the command
|}

== Examples ==
=== Example 1 ===

local t = translate
local LineEnd = '\r\n'
local ExitOnSyntaxCheck = false

local function registerLabel(parameters, syntaxcheck)
---- registerLabel(name)
if ExitOnSyntaxCheck and syntaxcheck then return end
local le = LineEnd
local name = parameters
if name == nil then
return nil, t('Wrong number of parameters, no "name", for "registerLabel" custom AA command.')
end
local str = 'label(' .. name .. ')' .. le
str = str .. 'registerSymbol(' .. name .. ')'
return str
end

local function unregisterLabel(parameters, syntaxcheck)
---- unregisterLabel(name)
if ExitOnSyntaxCheck and syntaxcheck then return end
local name = parameters
if name == nil then
return nil, t('Wrong number of parameters, no "name", for "unregisterLabel" custom AA command.')
end
local str = 'unregisterSymbol(' .. name .. ')'
return str
end

registerAutoAssemblerCommand('registerLabel', registerLabel) ---- Register the command
registerAutoAssemblerCommand('unregisterLabel', unregisterLabel) ---- Register the command

---- Usage in an Auto Assembler script
----------------------------------------------------
-- alloc(memTestMemory, 0x400)
-- registerSymbol(memTestMemory)
-- registerLabel(memTestMemoryEND)
-- memTestMemory:
-- db 90 90 90 90
-- memTestMemoryEND:
----------------------------------------------------


=== Example 2 ===

local t = translate
local LineEnd = '\r\n'
local ExitOnSyntaxCheck = false

local function split(s, delimiter)
result = {}
for match in (s .. delimiter):gmatch('(.-)' .. delimiter) do
table.insert(result, match)
end
return result
end

function repeteBytes(parameters, syntaxcheck)
---- repeteBytes(numberOfByte, arrayOfBytes)
if ExitOnSyntaxCheck and syntaxcheck then return end
local le = LineEnd
local args = split(parameters, ',')
local numberOfBytes = args[1]
if numberOfBytes == nil then
return nil, t('Wrong number of parameters, no "numberOfBytes", for "repeteBytes" custom AA command.')
end
local arrayOfBytes = args[2]
if arrayOfBytes == nil then
return nil, t('Wrong number of parameters, no "arrayOfBytes", for "repeteBytes" custom AA command.')
end
arrayOfBytes = arrayOfBytes:upper()
if arrayOfBytes:find('#') or arrayOfBytes:find('(INT)')
or arrayOfBytes:find('(FLOAT)') or arrayOfBytes:find('(DOUBLE)') then
return nil, t('Wrong format of parameters, "arrayOfBytes" must be in hexadecimal format, for "repeteBytes" custom AA command.')
end
local bc = (#(arrayOfBytes:gsub('0X', ''):gsub('$', ''):gsub(' ', ''))) / 2
numberOfBytes = numberOfBytes:upper():gsub(' ', '')
if numberOfBytes:sub(1, 5) == '(INT)' then
numberOfBytes = tonumber(numberOfBytes:sub(6))
elseif numberOfBytes:sub(1, 1) == '#' then
numberOfBytes = tonumber(numberOfBytes:sub(2))
elseif numberOfBytes:sub(1, 1) == '$' then
numberOfBytes = tonumber(numberOfBytes:sub(2), 16)
elseif numberOfBytes:sub(1, 2) == '0X' then
numberOfBytes = tonumber(numberOfBytes:sub(3), 16)
else
numberOfBytes = tonumber(numberOfBytes, 16)
end
if type(numberOfBytes) ~= 'number' then
return nil, t('Could not parse "numberOfBytes" for "repeteBytes" custom AA command.')
end
local str = ''
for i = 1, numberOfBytes / bc do
str = str .. 'db ' .. arrayOfBytes .. le
end
return str
end

registerAutoAssemblerCommand('repeteBytes', repeteBytes) ---- Register the command

---- Usage in an Auto Assembler script
----------------------------------------------------
-- alloc(memTestMemory, 0x400)
-- registerSymbol(memTestMemory)
-- memTestMemory:
-- repeteBytes(0x64, 90 52)
----------------------------------------------------

---- Memory View Form copy of "memTestMemory"
----------------------------------------------------
-- 0032FFFE - - ?? 
-- 0032FFFF - - ?? 
-- memTestMemory- 90 - nop 
-- 00330001 - 52 - push edx
-- 00330002 - 90 - nop 
-- 00330003 - 52 - push edx
-- 00330004 - 90 - nop 
-- ...
-- 00330060 - 90 - nop 
-- 00330061 - 52 - push edx
-- 00330062 - 90 - nop 
-- 00330063 - 52 - push edx
-- 00330064 - 00 00 - add [eax],al
----------------------------------------------------


{{LuaSeeAlso}}

@@ Line 312: / Line 312: @@
 == Related Functions ==
-* [[unregisterAutoAssemblerCommand]]
+* [[Lua:unregisterAutoAssemblerCommand|unregisterAutoAssemblerCommand]]
-* [[registerAutoAssemblerPrologue]]
+* [[Lua:registerAutoAssemblerPrologue|registerAutoAssemblerPrologue]]
-* [[unregisterAutoAssemblerPrologue]]
+* [[Lua:unregisterAutoAssemblerPrologue|unregisterAutoAssemblerPrologue]]
-* [[registerAutoAssemblerTemplate]]
+* [[Lua:registerAutoAssemblerTemplate|registerAutoAssemblerTemplate]]
-* [[unregisterAutoAssemblerTemplate]]
+* [[Lua:unregisterAutoAssemblerTemplate|unregisterAutoAssemblerTemplate]]
-* [[generateCodeInjectionScript]]
+* [[Lua:generateCodeInjectionScript|generateCodeInjectionScript]]
-* [[generateAOBInjectionScript]]
+* [[Lua:generateAOBInjectionScript|generateAOBInjectionScript]]
-* [[generateFullInjectionScript]]
+* [[Lua:generateFullInjectionScript|generateFullInjectionScript]]

@@ Line 73: / Line 73: @@
 	end
 	local str = 'label(' .. name .. ')' .. le
-	str	= str .. 'registerSymbol(' .. name .. ')'
+	str = str .. 'registerSymbol(' .. name .. ')'
 	return str
 end
@@ Line 114: / Line 114: @@
 	<span style="font-weight: 700;">end</span>
 	<span style="font-weight: 700;">local</span> str = <span style="color: rgb(136, 0, 0);">'label('</span> .. name .. <span style="color: rgb(136, 0, 0);">')'</span> .. le
-	str	= str .. <span style="color: rgb(136, 0, 0);">'registerSymbol('</span> .. name .. <span style="color: rgb(136, 0, 0);">')'</span>
+	str = str .. <span style="color: rgb(136, 0, 0);">'registerSymbol('</span> .. name .. <span style="color: rgb(136, 0, 0);">')'</span>
 	<span style="font-weight: 700;">return</span> str
 <span style="font-weight: 700;">end</span>
@@ Line 142: / Line 142: @@
 <span style="color: rgb(136, 136, 136);">----------------------------------------------------</span>
 </p>
 === Example 2 ===

@@ Line 312: / Line 312: @@
 {{LuaSeeAlso}}
-== Felated Functions ==
+== Related Functions ==
 * [[unregisterAutoAssemblerCommand]]
 * [[registerAutoAssemblerPrologue]]

← Older revision		Revision as of 19:31, 13 January 2018
Line 311:		Line 311:

	{{LuaSeeAlso}}		{{LuaSeeAlso}}
		+
		+	== Felated Functions ==
		+	* [[unregisterAutoAssemblerCommand]]
		+	* [[registerAutoAssemblerPrologue]]
		+	* [[unregisterAutoAssemblerPrologue]]
		+	* [[registerAutoAssemblerTemplate]]
		+	* [[unregisterAutoAssemblerTemplate]]
		+	* [[generateCodeInjectionScript]]
		+	* [[generateAOBInjectionScript]]
		+	* [[generateFullInjectionScript]]

@@ Line 101: / Line 101: @@
 ----------------------------------------------------
 </pre> -->
-<p style="white-space: pre; display: block; overflow-x: auto; padding: 0.5em; background: rgb(240, 240, 240); color: rgb(68, 68, 68);"><span style="font-weight: 700;">local</span> t = translate
+<p style="line-height:1.15em;white-space:pre;font-family:'Lucida Console';display: block; overflow-x: auto; padding: 0.5em; background: rgb(240, 240, 240); color: rgb(68, 68, 68);"><span style="font-weight: 700;">local</span> t = translate
 <span style="font-weight: 700;">local</span> LineEnd = <span style="color: rgb(136, 0, 0);">'\r\n'</span>
 <span style="font-weight: 700;">local</span> ExitOnSyntaxCheck = <span style="font-weight: 700;">false</span>
@@ Line 227: / Line 227: @@
 ----------------------------------------------------
 </pre> -->
-<p style="white-space: pre; display: block; overflow-x: auto; padding: 0.5em; background: rgb(240, 240, 240); color: rgb(68, 68, 68);"><span style="font-weight: 700;">local</span> t = translate
+<p style="line-height:1.15em;white-space:pre;font-family:'Lucida Console';display: block; overflow-x: auto; padding: 0.5em; background: rgb(240, 240, 240); color: rgb(68, 68, 68);"><span style="font-weight: 700;">local</span> t = translate
 <span style="font-weight: 700;">local</span> LineEnd = <span style="color: rgb(136, 0, 0);">'\r\n'</span>
 <span style="font-weight: 700;">local</span> ExitOnSyntaxCheck = <span style="font-weight: 700;">false</span>

← Older revision	Revision as of 00:15, 25 January 2018
(No difference)

@@ Line 177: / Line 177: @@
 		return nil, t('Wrong format of parameters, "arrayOfBytes" must be in hexadecimal format, for "repeteBytes" custom AA command.')
 	end
-	local bc = (#(arrayOfBytes:gsub('0X', &#39;&#39;):gsub('$', &#39;&#39;):gsub('&nbsp;', &#39;&#39;))) / 2
+	local bc = (#arrayOfBytes) / 2
 	numberOfBytes = numberOfBytes:upper():gsub('&nbsp;', &#39;&#39;)
 	if numberOfBytes:sub(1, 5) == '(INT)' then
@@ Line 253: / Line 253: @@
 		<span style="font-weight: 700;">return</span> <span style="font-weight: 700;">nil</span>, t(<span style="color: rgb(136, 0, 0);">'Wrong number of parameters, no "arrayOfBytes", for "repeteBytes" custom AA command.'</span>)
 	<span style="font-weight: 700;">end</span>
-	arrayOfBytes = arrayOfBytes:upper()
+	arrayOfBytes = arrayOfBytes:upper():gsub(<span style="color: rgb(136, 0, 0);">'0X'</span>, <span style="color: rgb(136, 0, 0);">&#39;&#39;</span>):gsub(<span style="color: rgb(136, 0, 0);">'$'</span>, <span style="color: rgb(136, 0, 0);">&#39;&#39;</span>):gsub(<span style="color: rgb(136, 0, 0);">'&nbsp;'</span>, <span style="color: rgb(136, 0, 0);">&#39;&#39;</span>)
 	<span style="font-weight: 700;">if</span> arrayOfBytes:find(<span style="color: rgb(136, 0, 0);">'#'</span>) <span style="font-weight: 700;">or</span> arrayOfBytes:find(<span style="color: rgb(136, 0, 0);">'(INT)'</span>)
 	<span style="font-weight: 700;">or</span> arrayOfBytes:find(<span style="color: rgb(136, 0, 0);">'(FLOAT)'</span>) <span style="font-weight: 700;">or</span> arrayOfBytes:find(<span style="color: rgb(136, 0, 0);">'(DOUBLE)'</span>) <span style="font-weight: 700;">then</span>
 		<span style="font-weight: 700;">return</span> <span style="font-weight: 700;">nil</span>, t(<span style="color: rgb(136, 0, 0);">'Wrong format of parameters, "arrayOfBytes" must be in hexadecimal format, for "repeteBytes" custom AA command.'</span>)
 	<span style="font-weight: 700;">end</span>
-	<span style="font-weight: 700;">local</span> bc = (#(arrayOfBytes:gsub(<span style="color: rgb(136, 0, 0);">'0X'</span>, <span style="color: rgb(136, 0, 0);">&#39;&#39;</span>):gsub(<span style="color: rgb(136, 0, 0);">'$'</span>, <span style="color: rgb(136, 0, 0);">&#39;&#39;</span>):gsub(<span style="color: rgb(136, 0, 0);">'&nbsp;'</span>, <span style="color: rgb(136, 0, 0);">&#39;&#39;</span>))) / <span style="color: rgb(136, 0, 0);">2</span>
+	<span style="font-weight: 700;">local</span> bc = (#arrayOfBytes) / <span style="color: rgb(136, 0, 0);">2</span>
 	numberOfBytes = numberOfBytes:upper():gsub(<span style="color: rgb(136, 0, 0);">'&nbsp;'</span>, <span style="color: rgb(136, 0, 0);">&#39;&#39;</span>)
 	<span style="font-weight: 700;">if</span> numberOfBytes:sub(<span style="color: rgb(136, 0, 0);">1</span>, <span style="color: rgb(136, 0, 0);">5</span>) == <span style="color: rgb(136, 0, 0);">'(INT)'</span> <span style="font-weight: 700;">then</span>