Signed-off-by: Will Hawkins <hawkinsw@obs.cr>
P4RSE: P4 Runtime In Swift Environment
P4RSE (yes, the acronym is a bit forced) is a P4 parser and runtime written in Swift. The project was started as a means to better learn Swift.
Status
Very, very alpha:
- Limited parts of the language can be parsed.
- Limited programs can be evaluated.
As an example of what can be parsed and evaluated, here is a fairly complex P4 program from our unit tests:
parser main_parser() {
state start {
bool where_to = true;
string where_from = "here";
string where_where = "here";
if (where_to) {
bool where_from = true;
if (where_from) {
where_to = false;
}
}
where_from = "there";
transition select (where_to) {
false: reject;
true: accept;
};
}
};
Please check back often!
Building
Requirements And Basic Build
This project uses code item macros (CodeItemMacros) which
are an experimental feature in Swift and not available in production.
Therefore, to compile this project, you must be using a non-production version of the compiler.
With that caveat noted, building can be done with swift build:
$ swift build
Testing
To run the P4RSE tests:
$ swift test
To run the parser tests, from the tree-sitter-p4 directory:
$ npx tree-sitter test
Generating Documentation
To build the documentation:
$ swift package generate-documentation
To preview the generated documentation:
$ swift package swift package --disable-sandbox preview-documentation --target <some target>
For more information, see the documentation for the Swift-DocC plugin.
Checking Format
To check the format:
$ swift-format --recursive -i Sources/