view OrthancServer/Resources/CodeModel/README.txt @ 6268:bb20617b77df

moving the code model generation from orthanc-java to orthanc
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 11 Aug 2025 13:39:40 +0200
parents
children 1990e87dd3e7
line wrap: on
line source


Introduction
============

The "./GenerateCodeModel.py" Python script analyzes the header of the
Orthanc Plugin SDK using clang, and saves this code model as a JSON
file.

The code model can then be used to generate wrappers. It is notably
used by the "orthanc-java" and "orthanc-python" plugins.

NB: This file was originally part of the "orthanc-java" project.


Usage on Ubuntu 22.04 LTS
=========================

Executing with default parameters:

$ sudo apt-get install python3-clang-14 python3-pystache
$ python3 ./GenerateCodeModel.py


Or, if you want to have more control:

$ python3 ./GenerateCodeModel.py \
          --libclang=libclang-14.so.1 \
          --source ../../Plugins/Include/orthanc/OrthancCPlugin.h \
          --target ../../Plugins/Include/orthanc/OrthancPluginCodeModel.json


Generation using Docker
=======================

$ ./docker-compile.sh