Differences

This shows you the differences between two versions of the page.

--- libraries:machine_code [2023-12-17 02:15] – [Tools/libraries] Update library links geek
+++ libraries:machine_code [2024-03-07 13:46] (current) – Remove subheader to improve embedded page appearance geek
@@ Line 1: / Line 1: @@
 ====== Machine Code ======
-Machine Code (referred to as "mcode") is the process of embedding code written in a different language (usually C) into AHK code, and then calling it with the ''DllCall()'' function.
+Machine Code (referred to as "mcode") is the process of embedding code written in a different language (usually C) into AHK code, and then calling it with the ''DllCall()'' function. MCode is especially useful for performance critical operations like physics calculation or image processing, since compiled C code is much faster than the compiled C++ code which is used to interpret regular AHK code. However, due to the unique constraints of code being executed inside of AHK by ''DllCall()'', special tools are needed to compile any old C/C++ code into MCode. For guidance on how to use Machine Code tools, see the [[guides:machine_code|Machine Code guide page]].
-MCode is especially useful for performance critical operations like physics calculation or image processing, since compiled C code is much faster than the compiled C++ code which is used to interpret regular AHK code.
-However, due to the unique constraints of code being executed inside of AHK by ''DllCall()'', special tools are needed to compile any old C/C++ code into MCode. Such tools are what this article is dedicated to.
-===== Tools/libraries =====
   * [[https://www.autohotkey.com/boards/viewtopic.php?t=4642|MCode4GCC by joedf]], the classic machine code generator
   * [[libraries:machine_code:mcl]] - The next generation of machine code tooling for AutoHotkey - by [[user:CloakerSmoker]] and [[user:geek]]
-==== MCL ====
-<tabbox AutoHotkey v1>
-<runner ahk1>
-#Requires AutoHotkey v1.1
-#Include <MCL>
-c =
-(
-#define UNICODE
-#include <ahk.h>
-#include <mcl.h>
-// Export a global variable
-MCL_EXPORT_GLOBAL(someGlobal);
-int someGlobal = 42;
-// Export a function
-MCL_EXPORT(someFunction)
-int someFunction(AHK_OBJECT *obj) {
-    AHK_FIELD* field;
-    LPTSTR key = L"TEST";
-    if (!AhkObjGetStr(obj, key, &field))
-        return 0;
-    return AhkFieldAsInt(field) * someGlobal;
-}
-)
-lib := MCL.FromC(c)
-MsgBox % "someGlobal was " NumGet(lib.someGlobal, "Int")
-NumPut(2, lib.someGlobal, "Int")
-MsgBox % "someGlobal is " NumGet(lib.someGlobal, "Int")
-obj := {"TEST": "123 "}
-MsgBox % "obj is:"
-Print(obj)
-MsgBox % "someFunction returned " DllCall(lib.someFunction, "Ptr", &obj, "Int")
-; Compile the code into an includeable function
-; MsgBox % MCL.StandaloneAHKFromC(c)
-</runner>
-<tabbox AutoHotkey v2>
-<runner ahk2>
-#Requires AutoHotkey v2.0
-#Include <MCL>
-c := "
-(
-#include <mcl.h>
-// Export a global variable
-MCL_EXPORT_GLOBAL(someGlobal, Int);
-int someGlobal = 42;
-// Export a function
-MCL_EXPORT(someFunction, IntP, outputVarName, Int)
-int someFunction(int* outputVarName) {
-    // Multiply the inout parameter by the global
-    *outputVarName *= someGlobal;
-    return 1;
-}
-)"
-lib := MCL.FromC(c)
-MsgBox "someGlobal was " lib.someGlobal
-lib.someGlobal := 2
-MsgBox "someGlobal is " lib.someGlobal
-out := 123
-MsgBox "out was " out
-MsgBox "someFunction returned " lib.someFunction(&out)
-MsgBox "out is " out
-; Compile the code into an includeable class
-; MsgBox MCL.StandaloneAHKFromC(c)
-</runner>
-</tabbox>