morty 0.6.0

A SystemVerilog source file pickler.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

![CI](https://github.com/zarubaf/morty/workflows/CI/badge.svg?branch=master)
[![Crate](https://img.shields.io/crates/v/morty.svg)](https://crates.io/crates/morty)
[![dependency status](https://deps.rs/repo/github/zarubaf/morty/status.svg)](https://deps.rs/repo/github/zarubaf/morty)
# Morty

_Come on, flip the pickle, Morty, you're not gonna regret it. The payoff is huge. I turned myself into a pickle, Morty!_

Morty reads SystemVerilog files and pickles them into a single file for easier handling. Optionally it allows to re-name modules with a common prefix or suffix. This allows for easier management of larger projects (they just become a single file). By making them unique they can also depend on different versions of the same dependency without namespace clashes.

## Install

We provide pre-builds for popular operating systems on our [releases page](https://github.com/zarubaf/morty/releases).

### From Source

Morty is written in Rust. Get the latest stable Rust version:
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
Then install `morty` using `cargo`:
```
cargo install --git https://github.com/zarubaf/morty.git
```

## Example Usage

To prefix all modules and packages in `test/package.sv` and `test/package_import_2.sv` and files with `my_little_prefix_` do:
```
morty test/package.sv test/package_import_2.sv -p my_little_prefix_
```

Alternatively, if you want to pass more files, `morty` will also parse manifest files (as generated by `bender sources -f`). See [Bender](https://github.com/fabianschuiki/bender). For example:

```
[
  {
    "include_dirs": [
      "/path/to/include/dir/common_cells/include/",
      "/path/to/include/dir/axi/include/"
    ],
    "defines": {
      "DEFINE_TO_BE_SET": "1"
    },
    "files": [
      "/path/to/file_0.sv",
      "/path/to/file_1.sv",
      "/path/to/file_2.sv"
    ]
  },
  {
    "include_dirs": [
      "/path/to/include/dir/deps/include/"
    ],
    "defines": {
      "ANOTHER_DEFINE_TO_BE_SET": "1"
    },
    "files": [
      "/path/to/file_3.sv",
      "/path/to/file_4.sv",
      "/path/to/file_5.sv"
    ]
  }
]
```

## Comments Stripping

Optionally, `morty` can strip comments (`--strip-comments`) of the pickled sources.