Lua:registerAutoAssemblerCommand - Revision history

Leunsel: Syntax Highlighting.

2026-06-25T19:25:38Z

Syntax Highlighting.

Show changes

Leunsel: Major overhaul of the post.

2026-06-25T01:00:32Z

Major overhaul of the post.

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

@@ Line 1: / Line 1: @@
 [[Category:Lua]]
-'''function''' registerAutoAssemblerCommand(''Command'', ''Function'''(parameters, syntaxcheckonly)''' '')
+{{CodeBox|'''function''' registerAutoAssemblerCommand(''command'', ''function'') ''':''' void}}
-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.
+Registers a custom Auto Assembler command.
-If the function returns nil, and as secondary parameter a string, this will make the auto assembler fail with that error.
+When the Auto Assembler encounters the registered command, it calls the specified Lua function. The command line is then replaced by the string returned by that function.
-The Auto Assembler form syntax highlighter will highlight the registered command.
+The callback can be called twice: once during syntax check and symbol lookup, and once during actual assembly execution if the command has not been removed during the first phase.
+===Function Parameters===
-== Function Parameters ==
+{|width="85%" cellpadding="10%" cellspacing="0" border="0"
 !align="left"|Parameter
 !align="left"|Type
 !style="width: 80%;background-color:white;" align="left"|Description
 |-
-|Command
+|command
 |String
-|The command string it self
+|The Auto Assembler command name to register.
 |-
 |Function
-|Function
+|The Lua callback function that is called when the command is encountered.
 |}
-=== Callback Function Parameters ===
+===Callback Parameters===
-{|width="85%" cellpadding="10%" cellpadding="5%" cellspacing="0" border="0"
+{|width="85%" cellpadding="10%" cellspacing="0" border="0"
 !align="left"|Parameter
 !align="left"|Type
@@ Line 34: / Line 36: @@
 |parameters
 |String
-|This will be the string between parenthesis after the command string
+|The text passed to the custom Auto Assembler command.
 |-
 |syntaxcheckonly
 |Boolean
-|This will be ''true'' if the script is running though a syntax check
+|True when the callback is called during syntax check and symbol lookup. False when it is called during actual assembly execution.
 |}
-==== Callback Function Return(s) ====
+===Callback Returns===
-{|width="85%" cellpadding="10%" cellpadding="5%" cellspacing="0" border="0"
+{|width="85%" cellpadding="10%" cellspacing="0" border="0"
-!align="left"|Parameter
+!align="left"|Return Value
-!align="left"|Type
+!align="left"|Result
 !style="width: 80%;background-color:white;" align="left"|Description
 |-
-|ReplaceString
+|String
-|String or Nil
+|Replace command
-|This will replace the commands line in the Auto Assembler script, can be a multi-line string, if Nil the commands line is removed
+|Replaces the command line in the Auto Assembler script with the returned string.
 |-
-|ErrorMessage
+|nil, String
-|String or Nil (OPTIONAL)
+|Raise error
-|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
+|Fails the Auto Assembler script with the given error message.
 |}
-== Examples ==
+===Examples===
 <!-- <pre>
 local t = translate
@@ Line 143: / Line 150: @@
 </p>
 <!-- <pre>
 local t = translate
@@ Line 307: / Line 313: @@
 <span style="color: rgb(136, 136, 136);">----------------------------------------------------</span>
 </p>
 {{LuaSeeAlso}}
-== Related Functions ==
+{{Assembly}}

@@ 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]]

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

@@ 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>

@@ 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>