Skip to content

Commit

Permalink
begin VerveineC doc
Browse files Browse the repository at this point in the history
  • Loading branch information
badetitou committed Sep 21, 2023
1 parent 3fc2d43 commit 5bb6ec6
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 1 deletion.
60 changes: 60 additions & 0 deletions moose-wiki/Developers/Parsers/VerveineC-Cpp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
layout: page
background: '/img/bg-wiki.jpg'
---

# VerveineC-Cpp

VerveineC-Cpp (VerveineC in short) is a tool written in java that create a *json* or a *mse* file from C/C++ source code.

> VerveineC is not as stable as VerveineJ, do not hesitate to contact us in case of problem
## User Documentation

## Developer Documentation

### Installation

#### Download Eclipse

To install VerveineC, you need to clone it form [VerveineC github repositiory](https://github.com/moosetechnology/VerveineC-Cpp).
We advice you to contact us to know which branch is the best for now (probably `famix-7`).

```bash
# https
git clone https://github.com/moosetechnology/VerveineC-Cpp.git

# ssh
git clone [email protected]:moosetechnology/VerveineC-Cpp.git
```

VerveineC is *in reality* an eclipse plugin that will run in headless model.
Thus, you will have to download eclipse (eclipse Version: 2022-06 should work perfectly).

Then, you'll have to install the RCP Plug-In of eclipse and CDT.

#### Install RCP plug-in

To install the *RCP Plug-In*, in eclipse:

- *Help → Install New Software... → Choose The Eclipse Project Updates in field Work With → Filter for RCP Plug-In*.
- Select the *Eclipse Plug-in Development Environment*
- Perform the full install

### Potential issue

Your eclipse might not have the exact same plugin preinstalled.
In such a situation, you can search for equivalent plugin preinstalled, or install the plugin.

For instance, we had to change:

| source | target |
| ----------------------- | ------------------- |
| `org.junit.jupiter.api` | `junit-jupiter-api` |

### Export the plug-in

To export the plugin,

- `File` > `Export...` > `Plug-in Development` > `Deployable plug-ins and fragments` > Next
- Select the verveineC plugin and the root directory of your eclipse then *Finish*
3 changes: 2 additions & 1 deletion moose-wiki/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ There are different (so-called) parsers already created at various stages of pro
- [Petit Parser](https://github.com/moosetechnology/PetitParser) - Write "easily" a Parser with Moose
![External documentation](https://img.shields.io/badge/-External%20Documentation-blue){: .no-lightense}
- [VerveineJ](Developers/Parsers/VerveineJ) - Generate an mse from a Java project
- [VerveineJ](Developers/Parsers/VerveineJ) - Generate an mse/json from a Java project
- [VerveineC-Cpp](Developers/Parsers/VerveineC-Cpp) - Generate an mse/json from a C/C++ project
- [C#](https://github.com/feenkcom/roslyn2famix) - A parser for C# (using Roselyn) that should be able to export a Moose model
- [PowerBuilderParser](Developers/Parsers/PowerBuilderParser) - Generate an mse from a Powerbuilder project
![Unfinished](https://img.shields.io/badge/Progress-Unfinished-yellow){: .no-lightense}
Expand Down

0 comments on commit 5bb6ec6

Please sign in to comment.