first version that compiles but does not create the api yet and crashes at runtime

Author: aoloe

scripter-api/CMakeLists.txt

@@ -0,0 +1,23 @@
+cmake_minimum_required(VERSION 3.4)
+project(scripting VERSION 1.0 LANGUAGES CXX)
+set(CMAKE_CXX_VISIBILITY_PRESET hidden)
+
+set(PYBIND11_PYTHON_VERSION 3.4)
+
+find_package(pybind11 CONFIG)
+
+include_directories(src)
+
+add_executable(scripting
+    src/main.cpp
+    src/scripter.cpp
+)
+target_link_libraries(scripting
+    pybind11::embed
+)
+
+PYBIND11_ADD_MODULE(scripterapi
+      src/scripterAPI/scripterAPI.cpp
+#     src/scripterAPI/document.cpp
+#     src/scripterAPI/margin.cpp
+)

scripter-api/README.md

@@ -0,0 +1,15 @@
+# Providing an API for manipuling a document
+
+Demoing how to provide an API that let's a Python script manipulate a document strucuture in the c++ application.
+
+- The application is called "Sample".
+- Its API for Python is called "ScripterAPI"
+- The `Document` data structure (and its "sub" elements) contains the data of the c++ appplication.
+- From Python you import a module called "Sample" and access the document as `Sample.document`
+
+~~~.sh
+$ mkdir build
+$ cmake -Dpybind11_DIR=/home/ale/bin/pybind11/share/cmake/pybind11 ..
+$ make
+$ ./scripting
+~~~

scripter-api/python/set-bar.py

@@ -0,0 +1,7 @@
+import scripterapi
+
+# print(Sample.margin.top)
+# Sample.margin.top = 150
+# print(Sample.margin.top)
+print(Sample.document.a)
+print(Sample.a)

scripter-api/src/main.cpp

@@ -0,0 +1,22 @@
+#include <iostream>
+#include <pybind11/pybind11.h>
+#include <pybind11/embed.h>
+
+#include "sample/document.h"
+// #include "sample/margin.h"
+// 
+#include "scripter.h"
+
+namespace py = pybind11;
+
+int main()
+{
+    Sample::Document document;
+
+    Scripter scripter{document};
+    scripter.runFile("../python/set-bar.py");
+    // std::cout << "document a " << document.a << std::endl;
+    std::cout << "document top " << document.margin.top << std::endl;
+    // std::cout << "document page 1 top" document.page.at(0).margin.top << std::endl;
+}
+

scripter-api/src/sample/document.h

@@ -0,0 +1,17 @@
+#ifndef SAMPLEDOCUMENT_H
+#define SAMPLEDOCUMENT_H
+#include <vector>
+#include "margin.h"
+#include "page.h"
+namespace Sample
+{
+    class Document
+    {
+        public:
+            int a{0};
+            Margin margin;
+            std::vector<Page> page;
+    };
+
+}
+#endif

scripter-api/src/sample/margin.h

@@ -0,0 +1,21 @@
+#ifndef SAMPLEDMARGIN_H
+#define SAMPLEDMARGIN_H
+
+namespace Sample
+{
+    class Margin
+    {
+        public:
+            double top{0};
+            double bottom{0};
+            double left{0};
+            double right{0};
+            void set(double t, double r, double b, double l) {
+                top = t;
+                right = r;
+                bottom = b;
+                left = l;
+            }
+    };
+}
+#endif

scripter-api/src/sample/page.h

@@ -0,0 +1,14 @@
+#ifndef SAMPLEPAGE_H
+#define SAMPLEPAGE_H
+#include "margin.h"
+namespace Sample
+{
+    class Page
+    {
+        public:
+            Margin margin;
+    };
+
+}
+#endif
+

scripter-api/src/scripter.cpp

@@ -0,0 +1,27 @@
+#include <memory>
+#include "scripter.h"
+#include "scripterAPI/scripterAPI.h"
+#include "sample/document.h"
+
+using namespace pybind11::literals; // for the ""_a
+
+void Scripter::runFile(std::string fileName)
+{
+    // Sample::Document document;
+    //Sample::Margin saMargin;
+    auto document = std::make_unique<Sample::Document>();
+
+    ScripterAPI::ScripterAPI scripterAPI;
+    scripterAPI.setDocument(std::move(document));
+
+
+    auto module = py::module::import("scripterapi");
+
+    auto locals = py::dict("Sample"_a=py::cast(scripterAPI, py::return_value_policy::reference));
+
+    py::eval_file(fileName, py::globals(), locals);
+
+    document = scripterAPI.getDocument();
+
+    // assert(scripter.bar == 5);
+}

scripter-api/src/scripter.h

@@ -0,0 +1,23 @@
+#ifndef SCRIPTER_H
+#define SCRIPTER_H
+#include <string>
+
+#include <pybind11/pybind11.h>
+#include <pybind11/embed.h>
+
+#include "sample/document.h"
+
+namespace py = pybind11;
+
+class Scripter
+{
+    public:
+        Scripter(Sample::Document &document) :
+            document{document} {};
+        void runFile(std::string fileName);
+    private:
+        Sample::Document &document;
+
+        py::scoped_interpreter guard{};
+};
+#endif

scripter-api/src/scripterAPI/scripterAPI.cpp

@@ -0,0 +1,12 @@
+#include <pybind11/pybind11.h>
+
+#include "scripterAPI/scripterAPI.h"
+
+namespace py = pybind11;
+
+PYBIND11_MODULE(scripterapi, m) {
+    py::class_<ScripterAPI::ScripterAPI>(m, "Sample")
+        .def(py::init<>())
+        .def_readwrite("a", &ScripterAPI::ScripterAPI::a)
+        ;
+}