Add contents for CppInterOp Documentation #105

Krishna-13-cyber · 2023-07-03T16:31:49Z

No description provided.

vgvassilev · 2023-07-12T08:38:18Z

docs/InstallationAndUsage.rst


   cd ../
   export LLVM_DIR=$PWD
   cd ../

-Clone the InterOp repo. Build it using cling and install. Note down the path to InterOp install directory. This will be referred to as INTEROP_DIR:
+   Clone the InterOp repo. Build it using cling and install. Note down the path to InterOp install directory. This will be referred to as INTEROP_DIR:


Can you break at 80 cols?

vgvassilev · 2023-07-12T08:38:45Z

docs/InstallationAndUsage.rst

@@ -51,11 +51,11 @@ Build Clang-Repl:
 .. code-block:: text


-   Get the llvm/release/16.x version:
+   // Get the llvm/release/16.x version:


That seems to be bash, shell where the token for comments is #.

vgvassilev · 2023-07-12T08:39:01Z

docs/UsingCppInterOp.rst

-If you are just getting started with CppInterop, then this is the best place to start.
-You may want to skim some sections on the first read. 
+This section briefly describes all the key functionalities offered by 
+CppInterop.If you are just getting started with CppInterop, then this is the


Suggested change

CppInterop.If you are just getting started with CppInterop, then this is the

CppInterOp. If you are just getting started with CppInterop, then this is the

vgvassilev · 2023-07-12T08:39:08Z

docs/UsingCppInterOp.rst

-You may want to skim some sections on the first read. 
+This section briefly describes all the key functionalities offered by 
+CppInterop.If you are just getting started with CppInterop, then this is the
+best place to start.You may want to skim some sections on the first read. 


Suggested change

best place to start.You may want to skim some sections on the first read.

best place to start. You may want to skim some sections on the first read.

vgvassilev · 2023-07-12T08:39:35Z

docs/UsingCppInterOp.rst


 C++ Language Interoperability Layer
 ===================================

+The CppInterop comes with using it is a dynamic shared library, 
+**libclangInterOp.so.13** which resides in the CppInterOp/build/lib/.


Suggested change

**libclangInterOp.so.13** which resides in the CppInterOp/build/lib/.

**libclangInterOp.so** which resides in the CppInterOp/build/lib/.

vgvassilev · 2023-07-12T08:39:57Z

docs/UsingCppInterOp.rst


+    libInterop = ctypes.CDLL("./libInterOp.so")


Is that the name of the library?

vgvassilev · 2023-07-12T08:40:08Z

docs/reference.rst

@@ -1,5 +1,39 @@
 Reference
---------
+----------


Why an extra dash here?

vgvassilev · 2023-07-12T08:40:32Z

docs/tutorials.rst


+**Note:: This example library shown below is portrayal of the concept on which 


Suggested change

**Note:: This example library shown below is portrayal of the concept on which

**Note:: This example library shown below is to illustrate the concept on which

vgvassilev · 2023-07-12T08:41:47Z

docs/tutorials.rst

@@ -1,5 +1,153 @@
 Tutorials


@wlav, could you take a look and give feedback on our documentation intent to capture the cppyy/python interop use case as motivation for CppInterOp?

? What specific piece of text needs commenting?

@wlav, basically this file: docs/tutorials.rst. I'd like to make sure we are not making some unreasonable claim.

vgvassilev · 2023-07-18T10:34:55Z

docs/tutorials.rst

+   _cpp_compile = libInterop.Clang_Parse
+   _cpp_compile.argtypes = [ctypes.c_char_p]
+
+We are using ctypes for inducting our library, *Clang_Parse* which is part


Where are Clang_Parse and such defined? Should we not show how the header file looks like at least?

vgvassilev · 2023-07-20T16:10:09Z

docs/tutorials.rst

+  # We are using ctypes for inducting our library, *Clang_Parse* which is part
+  # of the library is being used for parsing the C++ code.
+
+.. code-block:: bash


Suggested change

.. code-block:: bash

.. code-block:: cpp

Then replace # with //

vgvassilev · 2023-07-20T17:08:04Z

docs/tutorials.rst

+is parsed by the CppInterOp library in previous snippet and further compilation
+goes on.
+
+.. code-block:: cpp


No, that’s python.

vgvassilev · 2023-07-20T17:08:18Z

docs/tutorials.rst

+wrapped. In the similar manner we can use get_namespace.
+
+.. code-block::cpp


vgvassilev · 2023-07-29T03:19:28Z

docs/tutorials.rst

@@ -1,5 +1,185 @@
 Tutorials
 ----------
+This tutorial emphasizes on the abilities and usage of CppInterOp, Let's get


Suggested change

This tutorial emphasizes on the abilities and usage of CppInterOp, Let's get

This tutorial emphasizes on the abilities and usage of CppInterOp. Let's get

Can you please reread very carefully the entire set of documentation. I do not expect to continue fixing such details as it seems that we have not paid enough attention at that point. Please make sure it does not have any obvious issues before asking for a review.

vgvassilev · 2023-07-31T14:30:32Z

Can you squash all commits into one and mark this ready to review. I can improve a few things after we land it.

Krishna-13-cyber marked this pull request as draft July 3, 2023 16:32

vgvassilev reviewed Jul 12, 2023

View reviewed changes

vgvassilev reviewed Jul 18, 2023

View reviewed changes

vgvassilev reviewed Jul 20, 2023

View reviewed changes

docs/tutorials.rst Outdated

wrapped. In the similar manner we can use get_namespace.

.. code-block::cpp

Copy link

Contributor

vgvassilev Jul 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likewise.

Krishna-13-cyber marked this pull request as ready for review July 26, 2023 12:24

vgvassilev reviewed Jul 29, 2023

View reviewed changes

vgvassilev marked this pull request as draft July 29, 2023 03:25

Add tutorial and other contents for CppInterOp Documentation

d497777

Krishna-13-cyber force-pushed the Tutorials branch from f8381e0 to d497777 Compare July 31, 2023 19:43

Krishna-13-cyber mentioned this pull request Aug 1, 2023

[DOCS] Add C-C++ interoperability example #118

Closed

vgvassilev marked this pull request as ready for review August 1, 2023 22:19

vgvassilev added this pull request to the merge queue Aug 1, 2023

Merged via the queue into compiler-research:main with commit 0d4ab93 Aug 1, 2023

	CppInterop.If you are just getting started with CppInterop, then this is the
	CppInterOp. If you are just getting started with CppInterop, then this is the

	best place to start.You may want to skim some sections on the first read.
	best place to start. You may want to skim some sections on the first read.

	libclangInterOp.so.13 which resides in the CppInterOp/build/lib/.
	libclangInterOp.so which resides in the CppInterOp/build/lib/.


		**Note:: This example library shown below is portrayal of the concept on which

		wrapped. In the similar manner we can use get_namespace.

		.. code-block::cpp

	This tutorial emphasizes on the abilities and usage of CppInterOp, Let's get
	This tutorial emphasizes on the abilities and usage of CppInterOp. Let's get

Add contents for CppInterOp Documentation #105

Add contents for CppInterOp Documentation #105

Uh oh!

Conversation

Krishna-13-cyber commented Jul 3, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vgvassilev Jul 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vgvassilev commented Jul 31, 2023

Uh oh!

Uh oh!

vgvassilev Jul 12, 2023 •

edited

Loading