initial development (#1)

* initial development

* Create pyproject.toml

* Update lint.yml

* format clang

* Update lint.yml

Author: Owen

.clang-format

@@ -0,0 +1,14 @@
+---
+# We'll use defaults from the Google style.
+BasedOnStyle: Google
+---
+Language: Cpp
+# Force pointers to the type for C++.
+DerivePointerAlignment: false
+PointerAlignment: Left
+AlignAfterOpenBracket: AlwaysBreak
+---
+Language: Proto
+# Don't format .proto files.
+DisableFormat: true
+...

.clang-format-ignore

@@ -0,0 +1 @@
+third-party/sicgl

.github/workflows/ci.yml

@@ -0,0 +1,13 @@
+# continuous integration
+name: ci
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ "main" ]
+  pull_request:
+
+jobs:
+  lint:
+    name: 'linting'
+    uses: ./.github/workflows/lint.yml

.github/workflows/lint.yml

@@ -0,0 +1,48 @@
+# linting
+name: check-lint
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  clang-format-lint:
+    runs-on: ubuntu-latest
+    steps:
+      # check out the repo
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+
+      # install clang-format
+      - name: install clang-format
+        run: |
+          sudo apt update
+          sudo apt install clang-format
+          clang-format --version
+
+      # lint using clang-format
+      - name: clang-format lint
+        run: |
+          ./scripts/third-party/run-clang-format/run-clang-format.py -r src include
+
+  python-lint:
+    runs-on: ubuntu-latest
+    steps:
+      # check out the repo
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+
+      # setup ci tools
+      - name: set up ci tools
+        run: |
+          python3 -m venv venv
+          . ./venv/bin/activate
+          pip install -r requirements.dev.txt
+      
+      # lint using pylint
+      - name: run black
+        run: |
+          . ./venv/bin/activate
+          black . --check

.gitignore

@@ -1,3 +1,5 @@
+.vscode
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "third-party/sicgl"]
+	path = third-party/sicgl
+	url = https://github.com/oclyke/sicgl
+[submodule "scripts/third-party/run-clang-format"]
+	path = scripts/third-party/run-clang-format
+	url = https://github.com/Sarcasm/run-clang-format

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Owen
+Copyright (c) 2023 oclyke
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

examples/simple.py

@@ -0,0 +1,25 @@
+import pysicgl
+
+# create a screen definition with extent (WIDTH, HEIGHT)
+WIDTH = 256
+HEIGHT = 128
+display_screen = pysicgl.Screen((WIDTH, HEIGHT))
+
+# allocate memory for the interface using the number of
+# pixels in the display screen
+display_memory = pysicgl.allocate_pixel_memory(display_screen.pixels)
+
+# create an interface which controls access to this
+# memory. the screen definition is used to inform
+# geometrical constraints.
+display = pysicgl.Interface(display_screen, display_memory)
+
+# create a orange-red color using a 4-tuple of RGBA components
+color = pysicgl.Color.from_rgba((255, 128, 3, 0))
+
+# draw a pixel directly to the interface origin
+# the coordinates are given in the interface-relative system
+display.interface_pixel(color, (0, 0))
+
+# show the fist pixel as memory
+print(list(display.memory[0:4]))

include/pysicgl.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#include "pysicgl/color_sequence.h"
+#include "pysicgl/drawing/blit.h"
+#include "pysicgl/drawing/compose.h"
+#include "pysicgl/drawing/field.h"
+#include "pysicgl/drawing/global.h"
+#include "pysicgl/drawing/interface.h"
+#include "pysicgl/drawing/screen.h"
+#include "pysicgl/field.h"
+#include "pysicgl/interface.h"
+#include "pysicgl/screen.h"
+#include "pysicgl/utilities.h"

include/pysicgl/color.h

@@ -0,0 +1,14 @@
+#pragma once
+
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+// python includes must come first
+
+#include "sicgl/color.h"
+
+// declare the type
+extern PyTypeObject ColorType;
+
+typedef struct {
+  PyObject_HEAD
+} ColorObject;

include/pysicgl/color_sequence.h

@@ -0,0 +1,24 @@
+#pragma once
+
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+// python includes must come first
+
+#include "sicgl/color_sequence.h"
+
+// declare the type
+extern PyTypeObject ColorSequenceType;
+
+typedef struct {
+  PyObject_HEAD PyObject* _colors;
+  int _type;
+  sequence_map_fn _interpolation_map_fn;
+} ColorSequenceObject;
+
+int ColorSequence_post_ready_init();
+
+int ColorSequence_get(
+    ColorSequenceObject* self, size_t* len, color_t* colors_out,
+    size_t colors_out_len);
+int ColorSequence_get_interp_map_fn(
+    size_t interp_type, sequence_map_fn* fn_out);

include/pysicgl/drawing/blit.h

@@ -0,0 +1,7 @@
+#pragma once
+
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+// python includes must come first
+
+PyObject* blit(PyObject* self, PyObject* args);

include/pysicgl/drawing/compose.h

@@ -0,0 +1,7 @@
+#pragma once
+
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+// python includes must come first
+
+PyObject* compose(PyObject* self_in, PyObject* args);

include/pysicgl/drawing/field.h

@@ -0,0 +1,7 @@
+#pragma once
+
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+// python includes must come first
+
+PyObject* scalar_field(PyObject* self_in, PyObject* args);

include/pysicgl/drawing/global.h

@@ -0,0 +1,12 @@
+#pragma once
+
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+// python includes must come first
+
+PyObject* global_pixel(PyObject* self_in, PyObject* args);
+PyObject* global_line(PyObject* self_in, PyObject* args);
+PyObject* global_rectangle(PyObject* self_in, PyObject* args);
+PyObject* global_rectangle_filled(PyObject* self_in, PyObject* args);
+PyObject* global_circle(PyObject* self_in, PyObject* args);
+PyObject* global_ellipse(PyObject* self_in, PyObject* args);

include/pysicgl/drawing/interface.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+// python includes must come first
+
+PyObject* interface_fill(PyObject* self_in, PyObject* args);
+PyObject* interface_pixel(PyObject* self_in, PyObject* args);
+PyObject* interface_line(PyObject* self_in, PyObject* args);
+PyObject* interface_rectangle(PyObject* self_in, PyObject* args);
+PyObject* interface_rectangle_filled(PyObject* self_in, PyObject* args);
+PyObject* interface_circle(PyObject* self_in, PyObject* args);
+PyObject* interface_ellipse(PyObject* self_in, PyObject* args);

include/pysicgl/drawing/screen.h

@@ -0,0 +1,13 @@
+#pragma once
+
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+// python includes must come first
+
+PyObject* screen_fill(PyObject* self_in, PyObject* args);
+PyObject* screen_pixel(PyObject* self_in, PyObject* args);
+PyObject* screen_line(PyObject* self_in, PyObject* args);
+PyObject* screen_rectangle(PyObject* self_in, PyObject* args);
+PyObject* screen_rectangle_filled(PyObject* self_in, PyObject* args);
+PyObject* screen_circle(PyObject* self_in, PyObject* args);
+PyObject* screen_ellipse(PyObject* self_in, PyObject* args);

include/pysicgl/field.h

@@ -0,0 +1,17 @@
+#pragma once
+
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+// python includes must come first
+
+#include "sicgl/field.h"
+
+// declare the type
+extern PyTypeObject ScalarFieldType;
+
+typedef struct {
+  PyObject_HEAD Py_buffer _scalars_buffer;
+} ScalarFieldObject;
+
+int scalar_field_get_scalars(
+    ScalarFieldObject* self, size_t* len, double** scalars);

include/pysicgl/interface.h

@@ -0,0 +1,25 @@
+#pragma once
+
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+// python includes must come first
+
+#include "pysicgl/screen.h"
+#include "sicgl/interface.h"
+#include "sicgl/screen.h"
+
+// declare the type
+extern PyTypeObject InterfaceType;
+
+typedef struct {
+  PyObject_HEAD
+      // the underlying sicgl type
+      interface_t interface;
+
+  // a ScreenObject which is linked to
+  // the interface screen by reference
+  ScreenObject* _screen;
+
+  // a buffer backs up the interface memory
+  Py_buffer _memory_buffer;
+} InterfaceObject;

include/pysicgl/screen.h

@@ -0,0 +1,25 @@
+#pragma once
+
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+// python includes must come first
+
+#include <stdbool.h>
+
+#include "sicgl/screen.h"
+
+// declare the type
+extern PyTypeObject ScreenType;
+
+typedef struct {
+  PyObject_HEAD
+      /* Type-specific fields go here. */
+      screen_t* screen;
+  screen_t _screen;
+
+  // a flag to explicitly indicate whether this is an object or reference
+  bool _is_reference;
+} ScreenObject;
+
+// publicly accessible constructors
+ScreenObject* new_screen_object(screen_t* ref);

include/pysicgl/utilities.h

@@ -0,0 +1,9 @@
+#pragma once
+
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+// python includes must come first
+
+#include "sicgl/extent.h"
+
+// int unpack_ext_t_tuple2(PyObject* obj, ext_t* u, ext_t* v);

pyproject.toml

@@ -0,0 +1,10 @@
+[tool.black]
+include = '''
+src\/.*\.pyi?$|
+tests\/.*\.pyi?$|
+examples\/.*\.pyi?$
+'''
+exclude = '''
+third-party\/.*\.pyi?$|
+venv\/.*\.pyi?$
+'''

requirements.dev.txt

@@ -0,0 +1,2 @@
+black >= 22.12.0, < 23.0.0
+pytest >= 7.2.1, < 8.0.0