# Changelog

This is the changelog for `hlbc`, other crates have their own changelog.
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased](https://github.com/Gui-Yom/hlbc/compare/v0.7.0...HEAD)

## [0.7.0](https://github.com/Gui-Yom/hlbc/compare/v0.6.1...v0.7.0) - 2023-11-16

### Added

- Use smart strings

### Changed

- Renamed `Resolve::resolve` to the shorter `Resolve::get`

### Fixed

- Correctly serialize function debug info
- Correctly serialize indexes (thanks @turuslan)

### Removed

- Remove `IsFromStd` trait

## [0.6.1](https://github.com/Gui-Yom/hlbc/compare/v0.6.0...v0.6.1) - 2023-05-13

### Changed

- Refactored read and write api

### Fixed

- No more stack overflow when formatting a virtual
- `EnumField` opcode formatting was incorrect and could cause a crash

## [0.6.0](https://github.com/Gui-Yom/hlbc/compare/v0.5.0...v0.6.0) - 2023-05-07

### Added

- Add support for hashlink `PACKED` type.
- Bytecode formatting trait `BytecodeFmt`, and its implementations : `DebugFmt`, `DisplayFmt`, `EnhancedFmt`.
- `Index` impl for `Bytecode` to resolve most types.
- `Resolve` trait to resolve `Ref*` elements.

### Changed

- Bytecode formatting requires the usage of the `BytecodeFmt` trait

### Removed

- Most types now don't have a `resolve` method, use index access (`[]`) instead

## [0.5.0](https://github.com/Gui-Yom/hlbc/compare/v0.4.0...v0.5.0) - 2021-09-15

### Added

- Helper methods to access entrypoint and main functions and get a function by its name
- Analysis helper functions are now methods
- IsStdFn trait implemented on functions and natives
- More methods for `FunPtr`
- Implement `Eq` on many types where `PartialEq` was already implemented
- Infallible methods to get a function name (defaults to `_`)
- Rename many `display` methods

### Changed

- Made `Callgraph` type public and reexport the `petgraph` crate

## [0.4.0](https://github.com/Gui-Yom/hlbc/compare/v0.3.0...v0.4.0) - 2021-08-03

### Changed

- The decompiler (`hlbc::decompiler`) has been moved to its own crate

## [0.3.0](https://github.com/Gui-Yom/hlbc/compare/v0.2.0...v0.3.0) - 2022-07-31

### Added

- Get an Opcode description (generated from its doc comment) and create an Opcode from its name.
- Derive Default on a lot of types
- Global initializer map (global -> constant)
- Correctly handle bytes pool
- Store a reference to the parent type in the function struct

#### Decompiler

- Handle expressions and statements
- Generate code with proper indentation
- Handle branches and while loops
- Handle early returns, constructors, closures and methods
- break and continue statements
- Partial result with \[missing expr]
- Initial support for primitive array accesses
- Decompile whole classes
- Anonymous structures
- Initial support for enums
- Initial support for switch

### Changed

- Callgraph generation is now a default feature
- Improve opcode display
- Make bytecode elements serialization and deserialization functions public
- Global function indexes are resolved through a vec instead of a map
- Return a custom error type instead of using anyhow