Skip to content

Update UsingCppInterOp.rst to not reference use of patches + small other updates #370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mcbarton merged 1 commit into from
Dec 5, 2024
Merged

Update UsingCppInterOp.rst to not reference use of patches + small other updates #370

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 5 additions & 19 deletions docs/UsingCppInterOp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ C++ Language Interoperability Layer
Loading Dynamic shared library
==============================

The CppInterop comes with using it is a dynamic shared library,
**libclangCppInterOp.so** which resides in the CppInterOp/build/lib/.
The CppInterop comes with using it is a dynamic shared library, which resides
in the build/lib/ after building CppInterOp following the instructions in
:doc:`Installation and usage <InstallationAndUsage>` .

.. code-block:: bash

libInterop = ctypes.CDLL("./libclangCppInterOp.so")

The above method of usage is for Python; for C, we can include the headers of
The above method of usage is for Python on Linux; for C, we can include the headers of
the library. Including this library in our program enables the user to use
the abilities of CppInterOp. CppInterOp helps programmers with multiple
verifications such as isClass, isBoolean, isStruct, and many more in different
Expand All @@ -33,21 +34,6 @@ and LLVM.
We can consider clang-repl as a state manager, where CppInterOp allows you to
query the state from the state manager. Thereafter, cppyy uses this to create
Python objects for C++.

.. code-block:: bash

# Apply the patches for development
compgen -G "../patches/llvm/clang16-*.patch" > /dev/null
&& find ../patches/llvm/clang16-*.patch -printf "%f\n"
&& git apply ../patches/llvm/clang16-*.patch

.. code-block:: bash

# Use the versions of llvm with above patches applied
-DClang_DIR=/usr/lib/llvm-16/build/lib/cmake/clang\
-DLLVM_DIR=/usr/lib/llvm-16/build/lib/cmake/llvm


This section briefly describes all the key **features** offered by
CppInterop. If you are just getting started with CppInterop, then this is the
best place to start.
Expand Down Expand Up @@ -318,4 +304,4 @@ with the Installation And Usage Guide.

.. _CPyCppyy: https://github.com/wlav/CPyCppyy

.. _cppyy-backend: https://github.com/wlav/cppyy-backend
.. _cppyy-backend: https://github.com/wlav/cppyy-backend