YABR

KO | EN

gitlite — search

#javascript #hacktoberfest #llm #machine-learning #deep-learning #linux #docker #java #windows #kubernetes #awesome-list #ios #mcp #open-source

(★ 22)

A unified, bidirectional framework for Java (de)compilation, analysis, and transformation.

YABR Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# YABR - Yet Another Bytecode Reader/Writer

YABR is a bidirectional Java (de)compiler, program-analysis, and transformation framework. It spans
bytecode, SSA, a structured IR, execution, and source, so a program can be lifted, analyzed,
transformed, executed, compiled, and decompiled across one ecosystem.

[![](https://www.jitpack.io/v/Tonic-Box/YABR.svg)](https://www.jitpack.io/#Tonic-Box/YABR)

- [JavaDocs](https://tonic-box.github.io/YABR/)

## Projects using YABR

- [JStudio](https://github.com/Tonic-Box/JStudio) - A Java reverse engineering and analysis IDE.
- [J2CS](https://github.com/Tonic-Box/J2CS) - A Java to C# transpiler.
- [Dukes-8-Bit-Challenge](https://github.com/Tonic-Box/Dukes-8-Bit-Challenge) - A game-jam submission using YABR in `buildSrc/` for compile-time transformations.

## Building
- Java 11+
```bash
./gradlew build
./gradlew :all:shadowJar
```

## Installation

The published artifact is the merged jar from the `all` module. Via JitPack:

```kotlin
repositories {
    mavenCentral()
    maven { url = uri("https://jitpack.io") }
}

dependencies {
    implementation("com.github.Tonic-Box.YABR:all:<version>")
}
```

## Quick Start

```java
// Load a class
ClassPool pool = ClassPool.getDefault();
ClassFile cf = pool.loadClass(inputStream);

// Create a new class with a default constructor
int access = new AccessBuilder().setPublic().build();
ClassFile newClass = ClassFactory.createClass(pool, "com/example/MyClass", access);

// Add a field with a getter and setter
FieldEntry field = newClass.createNewField(access, "value", "I", new ArrayList<>());
ClassFactory.generateGetter(newClass, field, false);
ClassFactory.generateSetter(newClass, field, false);

// Write the class
newClass.rebuild();
byte[] bytes = newClass.write();
```

## Examples

Runnable examples are in [`examples/src/main/java/com/tonic/demo/`](examples/src/main/java/com/tonic/demo/),
including class creation, SSA transformation, LLVM lowering, AST mutation, decompilation, call
graphs, dependency analysis, type inference, and pattern search.

## Documentation

The generated API reference lives at [tonic-box.github.io/YABR](https://tonic-box.github.io/YABR/);
regenerate it into `docs/` with `./gradlew docSite`. The guides below are in `md-docs/`.

### Getting Started
| Guide | Description |
|-------|-------------|
| [Quick Start](md-docs/quick-start.md) | Load, create, and modify classes in five minutes |
| [Architecture](md-docs/architecture.md) | Module structure and design |

### Class Files & Bytecode
| Guide | Description |
|-------|-------------|
| [Class Files](md-docs/class-files.md) | ClassPool, ClassFile, ConstPool |
| [Bytecode API](md-docs/bytecode-api.md) | Low-level bytecode editing |
| [Generation API](md-docs/generation-api.md) | Fluent class/method generation |
| [Visitors](md-docs/visitors.md) | Traversal and transformation patterns |
| [Frame Computation](md-docs/frame-computation.md) | StackMapTable generation |

### SSA & IR
| Guide | Description |
|-------|-------------|
| [SSA Guide](md-docs/ssa-guide.md) | SSA intermediate representation |
| [SSA Transforms](md-docs/ssa-transforms.md) | Optimization and analysis passes |
| [LLVM Lowering](md-docs/llvm-lowering.md) | Lower SSA IR to textual LLVM IR |
| [LLVM Lifting](md-docs/llvm-lifting.md) | Lift LLVM IR back to SSA |

### Source & Decompilation
| Guide | Description |
|-------|-------------|
| [AST Guide](md-docs/ast-guide.md) | AST recovery, mutation, and emission |
| [AST Editor](md-docs/ast-editor.md) | ExprEditor-style AST transformation |
| [Parser API](md-docs/parser-api.md) | Java source parser |
| [Decompiler API](md-docs/decompiler-api.md) | Class -> Java source decompilation |

### Analysis
| Guide | Description |
|-------|-------------|
| [Analysis APIs](md-docs/analysis-apis.md) | Overview of the analysis suite |
| [Call Graph API](md-docs/call-graph-api.md) | Call-graph construction |
| [Data Flow API](md-docs/dataflow-api.md) | Data-flow analysis |
| [Dependency API](md-docs/dependency-api.md) | Dependency analysis |
| [PDG API](md-docs/pdg-api.md) | Program Dependence Graph with slicing |
| [SDG API](md-docs/sdg-api.md) | Interprocedural System Dependence Graph |
| [CPG API](md-docs/cpg-api.md) | Code Property Graph with taint analysis |
| [Pattern Search API](md-docs/pattern-search-api.md) | Structural bytecode pattern search |
| [Similarity API](md-docs/similarity-api.md) | Method similarity and fingerprinting |
| [Type Inference API](md-docs/type-inference-api.md) | Type inference |
| [Xref API](md-docs/xref-api.md) | Cross-references |

### Execution & Runtime
| Guide | Description |
|-------|-------------|
| [Execution API](md-docs/execution-api.md) | Concrete bytecode execution |
| [Simulation API](md-docs/simulation-api.md) | Abstract simulation |
| [Abstract Execution API](md-docs/abstract-execution-api.md) | Operand-stack and local def-use |
| [Instrumentation API](md-docs/instrumentation-api.md) | Bytecode instrumentation and hooks |
| [Verifier API](md-docs/verifier-api.md) | Bytecode verification |

### Language & Query
| Guide | Description |
|-------|-------------|
| [Query API](md-docs/query-api.md) | Bytecode query language |
| [Renamer API](md-docs/renamer-api.md) | Class, method, and field renaming |

## Project Layout

YABR is a Gradle multi-project. Production code is split into layered modules (`core`, `bytecode`,
`renamer`, `ssa`, `source`, `analyses`, `execution`, `query`) whose dependencies are acyclic and
build-enforced; the `all` module merges them into a single jar. See
[Architecture](md-docs/architecture.md).

## Acknowledgements

Inspired by [classpooly](https://github.com/d-o-g/classpooly).

## License

MIT

YABR

YABR Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

YABR

YABR Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README