# KittenVM

**Repository Path**: Shirasawa-Topaz/kitten-vm

## Basic Information

- **Project Name**: KittenVM
- **Description**: 大抵是一个想象力丰富的LVM吧。
- **Primary Language**: Rust
- **License**: MulanPubL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2022-09-17
- **Last Updated**: 2024-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: vm

## README

# KittenVM
大抵是一个想象力丰富的LVM吧。

[English?](https://gitee.com/Shirasawa-CN/kitten-vm/blob/master/README_en.md)

## 使用

### Warning:关于稳定性！
目前(测试过程中)最推荐的版本是最新的alpha版本！如```1.0.0-1```  
稳定版本将不会带有横杠的版本，如```1.0.0```

### Rust
```
[dependencies]
KittenVM = "1.0.0"
```

```
use KittenVM::API;

let a = API::stream(new a);
//----------OR--------------
let result = API::file("file.kvm");
//----------OR--------------
//推荐这种方法！
let run = let mut run: KittenVM = vm::machine::KittenVM::default();
let a = run.dynamic_memory.new_mem(vm::value_type::Type::int(36));
```
### C/C++
确保KittenVM.lib要和libKittenVM.d在同一目录下；如果使用CMake之类的构建工具，确保正确引用！
[Staticlib下载](https://gitee.com/Shirasawa-CN/kitten-vm/releases)

## 特性
本玩具具有许多奇奇怪怪的脑洞特性，请移步到[README](./docs/README.md)

# 使用(指令)
## 创建空间
```
new name
```
创建一个名为name的内存空间

## 移动数据
```
mov name,4
```
将数字4移动到name空间

```
mov name1,name2
```
将name2的值移动到name1，此时name2变成None

## 内存回收
```
add_gc a
```
将a添加到回收列表中
```
free
```
清理回收列表中的内存

## 运算
add and div mul or sll sra sud xor 这些运算指令的格式均如下

```
expr rs1,rs2,target
```

# 使用(函数)
## 创建空间
```
let name = run.dynamic_memory.new_mem(vm::value_type::Type::int(36));
```
创建一个名为name的内存空间

## 移动数据
```
run.mov(4,name);
```
将数字4移动到name空间

```
run.mov(name1,name2);
```
将name2的值移动到name1，此时name2变成None

## 内存回收
```
run.add_gc(a);
```
将a添加到回收列表中
```
run.free();
```
清理回收列表中的内存

## 运算
add and div mul or sll sra sud xor 这些运算指令的格式均如下

```
expr(rs1,rs2,target);
```