rexx-things/modules/api/c++/readme.txt
2025-03-12 20:50:48 +00:00

70 lines
4.1 KiB
Plaintext

/*----------------------------------------------------------------------------*/
/* */
/* Copyright (c) 2010-2021 Rexx Language Association. All rights reserved. */
/* */
/* This program and the accompanying materials are made available under */
/* the terms of the Common Public License v1.0 which accompanies this */
/* distribution. A copy is also available at the following address: */
/* https://www.oorexx.org/license.html */
/* */
/* Redistribution and use in source and binary forms, with or */
/* without modification, are permitted provided that the following */
/* conditions are met: */
/* */
/* Redistributions of source code must retain the above copyright */
/* notice, this list of conditions and the following disclaimer. */
/* Redistributions in binary form must reproduce the above copyright */
/* notice, this list of conditions and the following disclaimer in */
/* the documentation and/or other materials provided with the distribution. */
/* */
/* Neither the name of Rexx Language Association nor the names */
/* of its contributors may be used to endorse or promote products */
/* derived from this software without specific prior written permission. */
/* */
/* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS */
/* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT */
/* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS */
/* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT */
/* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, */
/* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED */
/* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, */
/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY */
/* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS */
/* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
/* */
/*----------------------------------------------------------------------------*/
ReadMe
======
ooRexx 4.0.0 introduced a new (at the time) C++ API for writing
extensions to the ooRexx interpreter. This API makes it possible for
the extension developer to make better, and more robust, use of the
interpreter. In particular the API makes it possible to use the
objects in ooRexx.
The subdirectories of this directory contain examples showing how to
use the C++ API.
Note that the extensions distributed with ooRexx make extensive use of
the C++ API and provide a lot of code showing usage of the API.
The subdirectories:
callsample
----------
This subdirectory has several examples of creating an interpreter
instance. One example uses the interpreter instance to call,
execute, and obtain the result from Rexx programs. The other
dynamically creates a Rexx routine and calls that routine.
external
--------
This subdirectory has three examples to create DLLs/shared libraries
with external routines and methods that can be directly used from
ooRexx programs. One example creates external routines only, the next
external methods only and one example creates external routines and
methods in the same DLL/shared library.