Merge pull request #123 from EmperorYP7/python-bindings

feat: Initiated pybind11 Configuration

Author: hsluoyz

CMakeLists.txt

@@ -31,10 +31,11 @@ endif()
 # Project definition.
 
 project(Casbin-CPP 
-    VERSION 1.0.0
+    VERSION 1.27.0
     DESCRIPTION "An authorization library that supports access control models like ACL, RBAC, ABAC in C/C++"
     HOMEPAGE_URL https://github.com/casbin/casbin-cpp
-    LANGUAGES CXX C)
+    LANGUAGES CXX C
+)
 
 
 ###############################################################################
@@ -50,18 +51,23 @@ endif()
 
 option(CASBIN_BUILD_TEST "State whether to build test" ON)
 option(CASBIN_BUILD_BENCHMARK "State whether to build benchmarks" ON)
+option(CASBIN_BUILD_BINDINGS "State whether to build language bindings" ON)
+option(CASBIN_BUILD_PYTHON_BINDINGS "State whether to build python bindings" ON)
 
 # Do not output install messages.
 if(NOT DEFINED CMAKE_INSTALL_MESSAGE)
     set(CMAKE_INSTALL_MESSAGE "NEVER")
 endif()
 
+if(CASBIN_BUILD_BINDINGS)
+    add_subdirectory(bindings)
+endif()
+
 if(CASBIN_BUILD_TEST)
     enable_testing()
+    add_subdirectory(tests)
 endif()
 
-add_subdirectory(tests)
-
 # Change the path max size to avoid problem on Windows.
 if(NOT DEFINED CMAKE_OBJECT_PATH_MAX)
     set(CMAKE_OBJECT_PATH_MAX 300)

README.md

@@ -1,7 +1,6 @@
 Casbin-CPP
 ====
 
-[![Build Status](https://dev.azure.com/Casbin/casbin/_apis/build/status/casbin.casbin-cpp?branchName=master)](https://dev.azure.com/Casbin/casbin/_build?definitionId=2&branchName=master)
 [![CI](https://github.com/casbin/casbin-cpp/actions/workflows/ci.yml/badge.svg)](https://github.com/casbin/casbin-cpp/actions/workflows/ci.yml)
 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/casbin/casbin-cpp)](https://github.com/casbin/casbin-cpp/releases/latest)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

bindings/CMakeLists.txt

@@ -0,0 +1,17 @@
+#  Copyright 2021 The casbin Authors. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+if(CASBIN_BUILD_PYTHON_BINDINGS)
+    add_subdirectory(python)
+endif()

bindings/python/CMakeLists.txt

@@ -0,0 +1,57 @@
+#  Copyright 2021 The casbin Authors. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+set(SOURCES
+    main.cpp
+)
+
+add_library(pycasbin MODULE ${SOURCES})
+
+set_target_properties(pycasbin PROPERTIES
+    PREFIX ""
+)
+
+if(WIN32)
+    # Windows uses .pyd extension for python modules
+    set_target_properties(pycasbin PROPERTIES
+        SUFFIX ".pyd"
+    )
+endif()
+    
+
+# NOTE: Depending of the compiler version pybind11 2.4.3 does not compile with C++17 so revert to c++11
+
+if(UNIX)
+    # A 'module' is a dynamic library on Linux (i.e. '-fPIC' needed),
+    # but a static library on Windows.
+
+    # If supported for the target machine, emit position-independent code
+    # suitable for dynamic linking.
+    set_property(TARGET pycasbin PROPERTY POSITION_INDEPENDENT_CODE ON)
+endif()
+
+# macOS demands that the linker resolve all symbols at build time
+# Pass this flag to allow dynamic linking
+if(APPLE)
+    set_target_properties(pycasbin PROPERTIES
+        LINK_FLAGS "-undefined dynamic_lookup"
+    )
+endif()
+
+target_link_libraries(pycasbin
+    PRIVATE
+        # casbin
+        pybind11::module
+)
+

bindings/python/main.cpp

@@ -0,0 +1,57 @@
+/*
+* Copyright 2021 The casbin Authors. All Rights Reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+* This is the main file for python bindings workflow
+*/
+
+#include <pybind11/pybind11.h>
+
+#define STRINGIFY(x) #x
+#define MACRO_STRINGIFY(x) STRINGIFY(x)
+
+int add(int i, int j) {
+    return i + j;
+}
+
+namespace py = pybind11;
+
+PYBIND11_MODULE(pycasbin, m) {
+    m.doc() = R"pbdoc(
+        Pybind11 example plugin
+        -----------------------
+
+        .. currentmodule:: pycasbin
+
+        .. autosummary::
+           :toctree: _generate
+
+           add
+           subtract
+    )pbdoc";
+
+    m.def("add", &add, R"pbdoc(
+        Add two numbers
+
+        Some other explanation about the add function.
+    )pbdoc");
+
+    m.def("subtract", [](int i, int j) { return i - j; }, R"pbdoc(
+        Subtract two numbers
+
+        Some other explanation about the subtract function.
+    )pbdoc");
+
+    m.attr("__version__") = "dev";
+}

casbin/CMakeLists.txt

@@ -14,6 +14,9 @@
 
 FILE(GLOB_RECURSE SRC_FILES "*.cpp" "*.h")
 
+# Setting to C++ standard to C++17
+set(CMAKE_CXX_STANDARD 17)
+
 add_library(casbin ${SRC_FILES})
 include_directories(${CMAKE_SOURCE_DIR}/casbin)
 

casbin/pch.h

@@ -37,6 +37,7 @@
 #include <thread>
 #include <future>
 #include <condition_variable>
+#include <variant>
 
 #include "attribute_types.h"
 #include "data_types.h"

cmake/modules/FindExtPackages.cmake

@@ -24,12 +24,22 @@ set(CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY ON CACHE BOOL
 ###############################################################################
 ### Packages and versions ###
 
-# googletest
-# https://github.com/google/googletest
-find_package(googletest 1.11.0 REQUIRED)
+if(CASBIN_BUILD_TEST)
+    # googletest
+    # https://github.com/google/googletest
+    find_package(googletest 1.11.0 REQUIRED)
 
-if(CASBIN_BUILD_BENCHMARK)
-    # benchmark
-    # https://github.com/google/benchmark
-    find_package(benchmark 1.5.5 REQUIRED)
+    if(CASBIN_BUILD_BENCHMARK)
+        # benchmark
+        # https://github.com/google/benchmark
+        find_package(benchmark 1.5.5 REQUIRED)
+    endif()
+endif()
+
+if(CASBIN_BUILD_BINDINGS)
+    if(CASBIN_BUILD_PYTHON_BINDINGS)
+        # pybind11
+        # https://github.com/pybind/pybind11
+        find_package(pybind11 2.7.0 REQUIRED)
+    endif()
 endif()

cmake/modules/Findpybind11.cmake

@@ -0,0 +1,22 @@
+#  Copyright 2021 The casbin Authors. All Rights Reserved.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+include(FetchContent)
+
+FetchContent_Declare(
+  pybind11
+  URL https://github.com/pybind/pybind11/archive/refs/tags/v2.7.0.zip
+)
+
+FetchContent_MakeAvailable(pybind11)