Frequently Asked Questions

General

What is ROUP?

ROUP is a Rust library that parses OpenMP and OpenACC directives and exposes the result to Rust, C, C++, and Fortran consumers. It focuses on analysing and transforming existing pragma-based code rather than compiling it.

Is ROUP production ready?

Not yet. The project is actively developed and APIs may change between releases. Treat the current builds as experimental and review the release notes for the latest status updates.

Which versions are supported?

OpenMP: Up to 6.0. Integration tests exercise the keyword registry, loop-transform directives, metadirectives, and device constructs.
OpenACC: 3.4 with full directive/clause coverage and aliases. Unsupported constructs fail with descriptive parse errors instead of being silently accepted.

Installation

How do I install ROUP for Rust?

Add the crate to your Cargo.toml:

[dependencies]
roup = "0.7"

How do I use ROUP from C or C++?

Build the library with cargo build --release and link against the generated artefact (libroup.so, libroup.dylib, or roup.dll). The generated constants header lives at src/roup_constants.h. See the C/C++ tutorials for function prototypes and RAII helpers.

What toolchains are required?

Rust 1.88 or newer (matches the MSRV in Cargo.toml).
A C/C++ compiler when using the FFI bindings.
Optional: Fortran compiler for the Fortran examples.

Usage

How do I parse a directive?

use roup::parser::openmp;

let parser = openmp::parser();
let (_, directive) = parser.parse("#pragma omp parallel for").expect("parse");
println!("kind: {}", directive.name);

How do I walk clauses from C?

OmpClauseIterator* it = roup_directive_clauses_iter(dir);
OmpClause* clause = NULL;
while (roup_clause_iterator_next(it, &clause)) {
    printf("clause kind: %d\n", roup_clause_kind(clause));
}
roup_clause_iterator_free(it);

ROUP Documentation