https://github.com/maswag/hyppau
Prototype tool for Hyper Pattern Matching with automata
https://github.com/maswag/hyppau
hyperproperty runtime-verification
Last synced: 10 months ago
JSON representation
Prototype tool for Hyper Pattern Matching with automata
- Host: GitHub
- URL: https://github.com/maswag/hyppau
- Owner: MasWag
- License: gpl-3.0
- Created: 2025-01-03T13:19:24.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-07-15T03:13:37.000Z (11 months ago)
- Last Synced: 2025-07-15T08:37:54.732Z (11 months ago)
- Topics: hyperproperty, runtime-verification
- Language: Rust
- Homepage:
- Size: 300 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
HypPAu — HYPer Pattern matching with AUtomata
==============================================
[](./LICENSE)
This is the source code repository for HypPAu (pronounced the same as "hippo")— a prototype tool for Hyper Pattern Matching.
Usage
-----
### Synopsis
```bash
cargo run -r -- [OPTIONS] -f FILE [FILE...]
./target/release/hyppau [OPTIONS] -f FILE [FILE...]
```
### Options
- **-h**, **--help**: Print a help message.
- **-q**, **--quiet**: Quiet mode. Causes any results to be suppressed.
- **-V**, **--version**: Print the version.
- **-i** *file*, **--input** *file*: Read the log from the *file*. The i-th input file is labeled with `i` in the output.
- **-f** *file*, **--automaton** *file*: Read an automaton written in JSON format from *file*.
- **-g**, **--graphviz**: Print the automaton in Graphviz DOT format.
- **-o** *file*, **--output** *file*: Write the output to *file* instead of stdout.
- **-m** *mode*, **--mode** *mode*: Choose the matching mode: naive, online, fjs, naive-filtered, online-filtered, or fjs-filtered. (default: naive).
- **-v**, **--verbose**: Increase verbosity. Use `-v` for debug-level messages and `-vv` for trace-level messages.
### Automaton JSON Format
The JSON format for the input automaton is as follows:
```json
{
"dimensions": 2,
"states": [
{ "id": 0, "is_initial": true, "is_final": false },
{ "id": 1, "is_initial": false, "is_final": true },
{ "id": 2, "is_initial": false, "is_final": false }
],
"transitions": [
{ "from": 0, "to": 1, "label": ["a", 0] },
{ "from": 0, "to": 2, "label": ["b", 1] },
{ "from": 1, "to": 2, "label": ["c", 0] },
{ "from": 2, "to": 0, "label": ["d", 1] }
]
}
```
- **dimensions**: The number of dimensions in the automaton.
- **states**: A list of states where each state has an `id`, a boolean indicating if it is initial (`is_initial`), and a boolean indicating if it is final (`is_final`).
- **transitions**: A list of transitions where each transition specifies the source state (`from`), target state (`to`), and the label associated with the transition.
Installation
------------
### Requirements
- **Rust & Cargo:** Ensure you have Rust (and its package manager, Cargo) installed.
- If not, install them via [rustup](https://rustup.rs).
### Installing from Source
1. **Clone the Repository:**
```bash
git clone https://github.com/MasWag/hyppau.git
cd hyppau
```
2. **Build the Project:**
Build the project in release mode for an optimized binary:
```bash
cargo build --release
```
3. **Run the Binary:**
The compiled executable will be located in `target/release/`. You can run it by `cargo run --release`, or directly:
```bash
./target/release/hyppau
```
4. (Optional) **Install the Binary:**
For easier access, you can install hyppau:
```bash
cargo install --release
```
Examples
--------
```bash
hyppau -f ./examples/small.json -i ./examples/small1.txt -i ./examples/small2.txt
```
## License
HypPAu is licensed under the [GNU General Public License v3.0](./LICENSE).
## Reference
- Hyper pattern matching. Masaki Waga, Étienne André