This project is read-only.

The Debugger Tutorial

In this tutorial you are going to learn how to debug code using the MXSPLI debugger.

Firstly you need to download any version MXSPLI higher or equal than v1.0.8A, for the best experience please use the web-installer who can be found here. The web installer will install the newest version of MXSPLI.

Starting the Debugger

If you are using ShareMX you will need to compile every batch file in a folder with exe extension using the Quick Batch File Compiler, and then you need to combine the folder /bin/ with /src/ and run MXSPLI.exe.

If you are using the official release of MXSPLI you will need to install it correctly and open the shortcut on your desktop.

Now you are going to be asked to type the project name, in this tutorial we are going to use the project name "DebuggerTutorial", but you can use whatever you want.

Now you need to modify the code the way you want, but we are going to left it untouched, then you need to save all the changes and select the file "DebuggerTutorial.mcode" if your project's name is "DebuggerTutorial", if it isn't you need to find "ProjectName.mcode" and open it in the editor.

After that you need to click the Run menu and click Debug, or press Shift+F6 to start the debugger.

Now you will see the Debugger Console Window with blue background and white text (depending on your version, it could be different).

Debugger Commands

The Debugging Console is controlled by the Debugging command that can be listed with the command:

dbg --help

In the version v1.0.8A this are the commands available:

file

With the file command you can select or change the selected debugging file.

dbg --file "FULL FILE LOCATION"

clean

With the clean command you can clean the logs created from the run or report command.

dbg --clean

run

With the run command you can run the file in the debugger and create the logs needed for the report.

dbg --run

report

With the report command you can view the debugging report created by the run command.

dbg --report

How to Debug?

Firstly to make sure that there are no old log files from the debug before this one you should execute:

dbg --clean

Now that you have clean logs you need to create new logs for the new source code:

dbg --run

Now you need to wait few seconds, if it takes longer you have very big source files or you made a loop, you should avoid logs when debugging, you should run the debugger on loops if the loops break and the code crashes, or if the loops can end. If you have used any function that pauses the code other than the functions in the Console library you should remove them because they pause the debugger.

If you see a message that says that the debugger is crashed there is a problem with the source or there is a bug in the MXSPLI code, or if you see a message that says that the debugger has ended the debugger haven't crashed so there are no heavy errors. To see the logs that were created by the debugger execute:

dbg --report

Now you will see a window on your screen with the debugger logs in it, if you don't see it and you don't see a message on the screen that says "Logs are reported", there was a problem when installing MXSPLI.

If the debugger crashed before it finished, and you think that there is a bug with the debugger, please copy the logs and post them to the discussions or issues.

Last edited May 2, 2016 at 4:19 PM by MixSoft, version 7