| 1 |
OVERVIEW: |
| 2 |
|
| 3 |
Camlidl is a stub code generator for Objective Caml. It generates |
| 4 |
stub code for interfacing Caml with C from an IDL description of the C |
| 5 |
functions. Thus, Camlidl automates the most tedious task in |
| 6 |
interfacing C libraries with Caml programs. It can also be used to |
| 7 |
interface Caml programs with other languages, as long as those |
| 8 |
languages have a well-defined C interface. |
| 9 |
|
| 10 |
In addition, Camlidl provides basic support for COM interfaces and |
| 11 |
components under MS Windows. It supports both using COM components |
| 12 |
(usually written in C++ or C) from Caml programs, and packaging Caml |
| 13 |
objects as COM components that can then be used from C++ or C. |
| 14 |
|
| 15 |
|
| 16 |
COPYRIGHT: |
| 17 |
|
| 18 |
All files marked "Copyright INRIA" in this distribution are copyright |
| 19 |
Institut National de Recherche en Informatique et en Automatique (INRIA) |
| 20 |
and distributed under the conditions stated in file LICENSE. |
| 21 |
For members of the Caml Consortium, the special Consortium license |
| 22 |
applies to this distribution. |
| 23 |
|
| 24 |
|
| 25 |
REQUIREMENTS: |
| 26 |
|
| 27 |
Camlidl requires Objective Caml 4.05 or later. |
| 28 |
|
| 29 |
Under MS Windows, you must use the MSVC port of Objective Caml. |
| 30 |
|
| 31 |
|
| 32 |
INSTALLATION: |
| 33 |
|
| 34 |
- Under Unix, copy config/Makefile.unix to config/Makefile. |
| 35 |
Under Windows, copy config/Makefile.win32 to config/Makefile. |
| 36 |
|
| 37 |
- Edit config/Makefile to set configuration options, following the |
| 38 |
comments in that file. You must set the BINDIR variable |
| 39 |
to say where to install the camlidl executable. Other variables |
| 40 |
have reasonable defaults. |
| 41 |
|
| 42 |
- Do "make all". |
| 43 |
|
| 44 |
- Become super-user if necessary and do "make install". |
| 45 |
|
| 46 |
|
| 47 |
DOCUMENTATION: |
| 48 |
|
| 49 |
- The user's manual can be found at https://xavierleroy.org/camlidl/ |
| 50 |
and in the docs/ subdirectory of the release. |
| 51 |
|
| 52 |
- Several examples are provided in the directories tests/ and tests/comp/. |
| 53 |
|
| 54 |
|
| 55 |
SUPPORT: |
| 56 |
|
| 57 |
- Please use the Github bug tracker and pull request manager at |
| 58 |
https://www.github.com/xavierleroy/camlidl |
| 59 |
|