Retro.Debug.Data.Provider 0.3.0-alpha

This is a prerelease version of Retro.Debug.Data.Provider.

dotnet add package Retro.Debug.Data.Provider --version 0.3.0-alpha

NuGet\Install-Package Retro.Debug.Data.Provider -Version 0.3.0-alpha

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Retro.Debug.Data.Provider" Version="0.3.0-alpha" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Retro.Debug.Data.Provider" Version="0.3.0-alpha" />
                    

                            Directory.Packages.props

<PackageReference Include="Retro.Debug.Data.Provider" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Retro.Debug.Data.Provider --version 0.3.0-alpha

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Retro.Debug.Data.Provider, 0.3.0-alpha"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#addin nuget:?package=Retro.Debug.Data.Provider&version=0.3.0-alpha&prerelease
                    

                            Install Retro.Debug.Data.Provider as a Cake Addin

#tool nuget:?package=Retro.Debug.Data.Provider&version=0.3.0-alpha&prerelease
                    

                            Install Retro.Debug.Data.Provider as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Retro Debug Data Provider

This project goal is to provide as much debugging support as possible for retro assemblers and possibly compilers starting with KickAssembler.

Current services

Debug file (.dbg) parsing provided by IKickAssemblerDbgParser.
Byte dump file (.dmp) parsing provided by IKickAssemblerByteDumpParser.
Compiler invocation (NOTE: Kick Assembler requires java installed on computer, OpenJDK is fine) provide by IKickAssemblerCompiler.
Converting Kick Assembler specific data into universal model provided by IKickAssemblerProgramInfoBuilder.
Universal model - for different assemblers and compilers (early version, might change in future) with top class AssemblerAppInfo.

I will add more services and more support types along the path.

This is a .NET 8+ cross-platform library.

Dependency injection support

All service classes have matching interface. Register them manually or run IoCRegistrar.AddDebugDataProvider extension method on IServiceCollection instance like:

public static IServiceCollection Configure(this IServiceCollection services)
{
    services.AddDebugDataProvider();
}

Debug file parser

Get debug data model by calling

var model = await IKickAssemblerDbgParser.LoadFileAsync("PATH_TO_DBG_FILE", ct)

Byte dump file parser

Get byte dumb model by calling

var model = await IKickAssemblerByteDumpParser.LoadFileAsync("PATH_TO_BYTE_DUMP_FILE", ct)

Compiler invocation

Unified model converter

Convert Kick Assembler specific debug model to universal one by calling

var universalModel = await IKickAssemblerProgramInfoBuilder.BuildAppInfoAsync("PROJECT_DIRECTORY", debugData, ct)

where debugData argument is output from Debug file parser.

Build from sources

Clone repository.

Since Kick Assembler binaries are not included in this repository, it's required to download them and manual install them: in src/Righthand.RetroDbgDataProvider/Righthand.RetroDbgDataProvider subdirectory create directory binaries/KickAss and place inside Kick Assembler files KickAss.cfg and KickAss.jar.

Product	Compatible and additional computed target framework versions.
.NET	net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net9.0
- Antlr4.Runtime.Standard (>= 4.13.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 9.0.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
0.3.0-alpha	41	3/15/2025
0.2.0-alpha	66	11/30/2024
0.1.5-alpha	72	9/30/2024
0.1.4-alpha	67	9/24/2024
0.1.3-alpha	69	9/1/2024
0.1.2-alpha	77	8/8/2024
0.1.1-alpha	56	8/7/2024
0.1.0-alpha	55	8/7/2024

# RetroDbgDataProvider changes

## [0.3.0-alpha](https://github.com/MihaMarkic/Retro-debug-data-provider/releases/tag/0.2.0-alpha) (9.3.2025)

* Implements completion options suggestions
* Adds more love towards Linux

## [0.2.0-alpha](https://github.com/MihaMarkic/Retro-debug-data-provider/releases/tag/0.2.0-alpha) (30.11.2024)

* Implements full project parsing for KickAssembler
* Many updates to lexer, parser and parsing in general