Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/neudinger/pdic

PDIC: (IDL) Transpiler Source-to-source compiler C/C++ to YAML Description based on clang
https://github.com/neudinger/pdic

clang compiler

Last synced: about 1 month ago
JSON representation

PDIC: (IDL) Transpiler Source-to-source compiler C/C++ to YAML Description based on clang

Host: GitHub
URL: https://github.com/neudinger/pdic
Owner: neudinger
License: eupl-1.2
Created: 2021-07-21T13:20:39.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2021-09-06T14:50:09.000Z (over 3 years ago)
Last Synced: 2024-08-08T22:19:05.009Z (5 months ago)
Topics: clang, compiler
Language: C++
Homepage:
Size: 1.79 MB
Stars: 3
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # PDIC [![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)

PDIC: [(IDL)](https://en.wikipedia.org/wiki/Interface_description_language) Transpiler Source-to-source compiler C/C++ to YAML Portable Data Interface Description

Project related to [PDI](https://gitlab.maisondelasimulation.fr/pdidev/pdi)

[![Linux](https://svgshare.com/i/Zhy.svg)](https://svgshare.com/i/Zhy.svg)

[![GitHub license](https://img.shields.io/badge/license-EUPL-blue.svg)](https://raw.githubusercontent.com/herotc/hero-rotation/master/LICENSE) [![Build Github Status](https://github.com/neudinger/PDIC/workflows/Build%20pdic/badge.svg)](https://github.com/neudinger/PDIC/actions)

[![PyPI version](https://badge.fury.io/py/pdic.svg)](https://badge.fury.io/py/pdic)

[![PyPI implementation](https://img.shields.io/pypi/implementation/pdic.svg)](https://pypi.python.org/pypi/pdic/)

[![Doc](https://readthedocs.org/projects/pip/badge/?version=latest)](https://neudinger.github.io/PDIC/)

[![made-with-Markdown](https://img.shields.io/badge/Made%20with-Markdown-1f425f.svg)](http://commonmark.org)

[![GitHub release](https://img.shields.io/github/release/neudinger/PDIC.svg)](https://GitHub.com/neudinger/PDIC/releases/) [![Docker](https://badgen.net/badge/icon/docker?icon=docker&label)](https://https://docker.com/)

From C/C++ to Yaml Description

|Simple binary|Python library|

|:-:|:-:|

|static binary|Python 3|

|`./pdic file.c`|`import pdic; result:str = pdic.files_to_pdi()`|

## Instalation

Binary

```sh

cmake -S . -DBINARY:BOOL=ON -B build && cmake --build build -- -j `nproc`

```

Google Test

```sh

cmake -S . -DTEST:BOOL=ON -B build && cmake --build build -- -j `nproc`

cd build && ctest

```

Python

```sh

python setup.py build -G "Unix Makefiles"

python3 setup.py bdist_wheel -G "Unix Makefiles" -j `nproc`

python setup.py build_ext  -G "Unix Makefiles" --inplace -j `nproc`

pytest

```

## Usage

```c++

#pragma pdi on

typedef struct Var8

{

#pragma pdi type : int64

    int my_int;

    char char_tab[20];

    char my_char;

} var;

#pragma pdi size:[42]

int **array_of_pointer_of_array[21];

var my_var;

#pragma pdi off

```

Will be see and describe as follow

```yml

structs:

 Var8:

  type: record

  name: Var8

  alias: [var]

  fieldsize: 3

  buffersize: 28

  packed: false

  members:

   char_tab: { type: array, subtype: char, size: 20 }

   my_char:

    offset: 24   

    type: char

   my_int:

    type: int64

data:

 array_of_pointer_of_array: { type: array, subtype:  { type: pointer, subtype:  { type: array, subtype: int, size: 42 } }, size: 21 }

 my_var:

  type: record

  name: Var8

  alias: [var]

  fieldsize: 3

  buffersize: 28

  packed: false

  members:

   char_tab: { type: array, subtype: char, size: 20 }

   my_char:

    offset: 24   

    type: char

   my_int:

    type: int64

```

Python Usage

```python

import os

import pathlib

import yaml

import pdic

here = pathlib.Path(__file__).parent.resolve()

# pip show -f pdic

if __name__ == "__main__":

    pdi_yml_description: str = pdic.files_to_pdi([os.path.join(here, "level_1.c"),

                                                  os.path.join(here, "level_2.c")])

    print(pdi_yml_description)

    print(yaml.dump(yaml.load(pdi_yml_description)))

```

## Index

1. [Abstract](/docs/1.0-Abstract.md)

2. [Usage](/docs/2.0-Requirement.md)

      1. [Binary](/docs/2.1-Binary.md)

      2. [Python](/docs/2.2-Python.md)

3. [Developpement](/docs/3.0-Developpement.md)

      - Code

      - Documentation

      - Test

      - Deploy

4. [Links](/docs/4.0-Links)

      - [Autre Documentation](/docs/5.1-Documentations.md)

      - Biblio

      - Code example

5. [Extra](/docs/5.0-Extra.md)

      - Clang LLVM

      - Mind Map

      - Graph

      - UML

6. Contact / Credits

Credits

Barre Kevin [neudinger](https://github.com/) (Software Scientist)

Julien Bigo [jbigot](https://gitlab.maisondelasimulation.fr/jbigot)

CEA PDI TEAM