Initial import

Author: hinxx

.gitattributes

@@ -0,0 +1 @@
+*.png filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,124 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+*.dll
+
+# os-specific stuff
+.DS_Store
+
+# imgui runtime configuration
+imgui.ini
+
+# C extensions
+*.so
+
+# Cython related
+cython_debug/
+implot/*.cpp
+implot/*.h
+implot/*.c
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+completion.svg
+
+# Visual Studio stuff
+.vs/
+
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+doc/_build/
+doc/build
+
+# following is autogenerated
+doc/source/readme.rst
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+# Pycharm project settings
+.idea/
+
+# Visual Studio Code project settings
+.vscode/
+
+# Bootstrap marker
+.bootstrapped
+
+# Fonts
+*.ttf
+*.otf

.gitmodules

@@ -0,0 +1,7 @@
+[submodule "imgui-cpp"]
+	path = imgui-cpp
+	url = https://github.com/ocornut/imgui.git
+
+[submodule "implot-cpp"]
+	path = implot-cpp
+	url = https://github.com/epezent/implot.git

LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2016, Michał Jaworski
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of pyimgui nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

MANIFEST.in

@@ -0,0 +1,22 @@
+include README.md
+include LICENSE
+
+# Cython sources
+recursive-include implot *.pyx *.pxd
+
+# Cython-generated C++ sources
+recursive-include implot *.cpp *.h
+
+# Additional internal ImgGui configuration
+recursive-include config-cpp *.cpp *.h
+
+# ImGui sources
+recursive-include imgui-cpp *.cpp *.h
+prune imgui-cpp/examples
+prune imgui-cpp/extra_fonts
+
+# ImPlot sources
+recursive-include implot-cpp *.cpp *.h
+
+# ansifeed sources
+recursive-include ansifeed-cpp *.cpp *.h

Makefile

@@ -0,0 +1,61 @@
+.PHONY: help
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  clean       to clean local environment from stale build files"
+	@echo "  build       to build and install for development"
+	@echo "  rebuild     to rebuild from scratch"
+	@echo "  livedoc     to serve live documentation"
+	@echo "  bootstrap   to bootstrap whole development environment"
+	@echo "  completion  to get detailed overview on completion progress"
+	@echo "  coverage    to run tests with coverage"
+
+
+# note: empty recipe as alias for .bootstrapped target
+bootstrap: .bootstrapped ;
+
+.bootstrapped:
+	@echo "Bootstrapping project environment ..."
+	git submodule update --init
+	pip install -r doc/requirements-dev.txt
+	@touch .bootstrapped
+
+
+.PHONY: clean
+clean:
+	rm -rf implot/*.cpp implot/*.c implot/*.h implot/*.so build/*
+
+
+.PHONY: build
+build: bootstrap
+	_CYTHONIZE_WITH_COVERAGE=1 python -m pip install -e . -v
+	# python ci/completion.py -o README.md with-pxd implot/cimplot.pxd
+
+
+.PHONY: rebuild
+rebuild: clean build
+	@echo 'Done!'
+
+
+# .PHONY: livedoc
+# livedoc: build
+# 	sphinx-autobuild doc/source/ doc/build/html
+
+
+# .PHONY: coverage
+# coverage: build
+# 	coverage run --source imgui -m pytest
+# 	coverage report
+# 	coverage html
+
+
+# .PHONY: completion
+# completion:
+# 	_CYTHONIZE_WITH_COVERAGE=1 python -m pip install -e . -v
+# 	@python ci/completion.py missing `find build/ -name imgui.o -print -quit` `find build/ -name core.o -print -quit`
+# 	@python ci/completion.py with-nm `find build/ -name imgui.o -print -quit` `find build/ -name core.o -print -quit`
+
+# .PHONY: ditribute
+# distribute: clean
+# 	pip install -U Cython setuptools twine
+# 	python setup.py build
+# 	python setup.py sdist

PROGRESS.md

@@ -0,0 +1,18 @@
+# 2021-03-24
+
+Started isolating the ImPlot parts from the pyimgui.
+We still need the complete ImGui C++ source to create a functional pyimplot binding.
+Creating just `implot` module at the moment.
+Still using all the pyimgui *.pxd, except for core.pxd.
+
+## Results 1
+
+$ python3
+Python 3.9.2 (default, Mar 12 2021, 13:13:11)
+[GCC 7.5.0] on linux
+Type "help", "copyright", "credits" or "license" for more information.
+>>> import implot
+>>> dir(implot)
+['AXIS_FLAGS_AUTO_FIT', 'AXIS_FLAGS_INVERT', 'AXIS_FLAGS_LOCK', 'AXIS_FLAGS_LOCK_MAX', 'AXIS_FLAGS_LOCK_MIN', 'AXIS_FLAGS_LOD_SCALE', 'AXIS_FLAGS_NONE', 'AXIS_FLAGS_NO_DECORATIONS', 'AXIS_FLAGS_NO_GRID_LINES', 'AXIS_FLAGS_NO_LABEL', 'AXIS_FLAGS_NO_TICK_LABELS', 'AXIS_FLAGS_NO_TICK_MARKS', 'AXIS_FLAGS_TIME', 'COLOR_COUNT', 'IMPLOT_AUTO', 'IMPLOT_AUTO_COL', 'IMPLOT_VERSION', 'ImGuiError', 'PLOT_FLAGS_ANTI_ALIASED', 'PLOT_FLAGS_CANVAS_ONLY', 'PLOT_FLAGS_CROSSHAIRS', 'PLOT_FLAGS_EQUAL', 'PLOT_FLAGS_NONE', 'PLOT_FLAGS_NO_BOX_SELECT', 'PLOT_FLAGS_NO_CHILD', 'PLOT_FLAGS_NO_HIGHLIGHT', 'PLOT_FLAGS_NO_LEGEND', 'PLOT_FLAGS_NO_MENUS', 'PLOT_FLAGS_NO_MOUSE_POS', 'PLOT_FLAGS_NO_TITLE', 'PLOT_FLAGS_QUERY', 'PLOT_FLAGS_YAXIS2', 'PLOT_FLAGS_YAXIS3', 'PlotStyle', 'VERSION', 'Vec2', 'Vec4', '__builtins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__package__', '__path__', '__spec__', '__version__', 'add_colormap', 'annotate', 'annotate_clamped', 'annotate_clamped_color', 'annotate_color', 'begin_drag_drop_source', 'begin_drag_drop_source_item', 'begin_drag_drop_source_x', 'begin_drag_drop_source_y', 'begin_drag_drop_target', 'begin_drag_drop_target_legend', 'begin_drag_drop_target_x', 'begin_drag_drop_target_y', 'begin_legend_popup', 'begin_plot', 'bust_color_cache', 'colormap_button', 'colormap_icon', 'colormap_scale', 'colormap_slider', 'create_context', 'destroy_context', 'drag_line_x', 'drag_line_y', 'drag_point', 'end_drag_drop_source', 'end_drag_drop_target', 'end_legend_popup', 'end_plot', 'fit_next_plot_axes', 'get_colormap_color', 'get_colormap_count', 'get_colormap_index', 'get_colormap_name', 'get_colormap_size', 'get_current_context', 'get_last_item_color', 'get_marker_name', 'get_plot_limits', 'get_plot_mouse_pos', 'get_plot_pos', 'get_plot_query', 'get_plot_size', 'get_style', 'get_style_color_name', 'hide_next_item', 'is_legend_entry_hovered', 'is_plot_hovered', 'is_plot_queried', 'is_plot_x_axis_hovered', 'is_plot_y_axis_hovered', 'item_icon_idx', 'item_icon_rgba', 'namedtuple', 'next_colormap_color', 'pixels_to_plot', 'plot', 'plot_bars1', 'plot_bars2', 'plot_barsg', 'plot_barsh1', 'plot_barsh2', 'plot_barshg', 'plot_digital', 'plot_digitalg', 'plot_dummy', 'plot_error_bars1', 'plot_error_bars2', 'plot_error_barsh1', 'plot_error_barsh2', 'plot_heatmap', 'plot_histogram', 'plot_histogram_2d', 'plot_hlines1', 'plot_image', 'plot_line1', 'plot_line2', 'plot_lineg', 'plot_pie_chart', 'plot_scatter1', 'plot_scatter2', 'plot_scatterg', 'plot_shaded1', 'plot_shaded2', 'plot_shaded3', 'plot_shadedg', 'plot_stairs1', 'plot_stairs2', 'plot_stairsg', 'plot_stems1', 'plot_stems2', 'plot_text', 'plot_to_pixels', 'plot_vlines1', 'pop_colormap', 'pop_plot_clip_rect', 'pop_style_color', 'pop_style_var', 'push_colormap', 'push_colormap_name', 'push_plot_clip_rect', 'push_style_color', 'push_style_var', 'sample_colormap', 'set_current_context', 'set_imgui_context', 'set_legend_location', 'set_mouse_pos_location', 'set_next_error_bar_style', 'set_next_fill_style', 'set_next_line_style', 'set_next_marker_style', 'set_next_plot_limits', 'set_next_plot_limits_x', 'set_next_plot_limits_y', 'set_next_plot_ticks_x', 'set_next_plot_ticks_x_range', 'set_next_plot_ticks_y', 'set_next_plot_ticks_y_range', 'set_plot_y_axis', 'show_colormap_selector', 'show_demo_window', 'show_metrics_window', 'show_style_editor', 'show_style_selector', 'show_user_guide', 'style_colors_auto', 'style_colors_classic', 'style_colors_dark', 'style_colors_light', 'warnings']
+>>>
+

README.md

@@ -0,0 +1,67 @@
+# pyimplot
+
+Python bindings for the amazing
+[ImPlot](https://github.com/ocornut/imgui), GPU accelerated plotting library for
+[Dear ImGui](https://github.com/ocornut/imgui).
+
+        Warning: This is alpha quality code.
+
+Documentation: TODO
+
+# ImPlot
+
+NOTES from the time when this was introduced into the pyimgui codebase!
+
+It is not clear to me if this is the best place for ImPlot python binding. The
+question remains if it would be better to place this code into a separate project,
+or provide it as part of pyimgui. As of now the latter has been chosen due to my
+laziness, poor undestanding of cython and also due to some obstacles
+encountered during the process of creating this binding.
+
+Read on if you are interested in couple of details.
+
+As per ImGui and ImPlot documentation using them both as shared library is not recomended.
+In case of python binding this is exactly what is being done. The ImGui part ends up being
+a shared library and plot becomes a separate shared library. Creating a single shared library
+(with ImGui and ImPlot) does not sound like a good idea at all so lets not go there. Not going
+with shared library is also something that we can not do; AFAICT due to the way cypthon does
+its business (I might be wrong).
+
+At the level of C++ that cython wraps into python module and functions, ImPlot want access
+to `imgui.h` and `imgui_internal.h`. For example ImPlot uses `ImTextureID`, `ImGuiCond`,
+`ImGuiMouseButton`, `ImGuiKeyModFlags`, `ImGuiDragDropFlags`, `ImU32`, `ImDrawList`, `ImGuiContext`,
+`ImVec2`, `ImVec4` and alike. These need to be exposed a cython level, too. Currently,
+these come from `cimgui` and `internal` modules provided by pyimgui binding. Using them is
+as simple as adding a `cimport` line to a `cimplot.pxd`. pyimgui (c)imports were requiered for
+`plot.pyx` as well:
+
+        cimport cimplot
+        cimport cimgui
+        cimport core
+        cimport enums
+
+If the ImPlot is placed in a separate project/repo these would need to be redefined.
+
+
+When I tried to compile the ImPlot C++ code for cython binding (without adding ImGui sources)
+for that shared library, doing `import imgui` in a user script fails with `GImGui` being undefined.
+Have I missed something there during the library build?! I don't know.
+
+If the ImPlot binding is separate from ImGui binding (cleanest approach), I'm not sure how
+the user script would behave if pyimgui and pyimplot would be based of different ImGui C++ code.
+Might be a non-issue, but I just do not know.
+
+Have any ideas or suggestions on the above topics? Bring them up, please!
+
+
+# Development tips
+
+In order to build and install project locally ,ake sure you have created and
+activated virtual environment using `virtualenv` or `python -m venv` (for newer
+Python releases). Then you can just run:
+
+    make build
+
+This command will bootstrap whole environment (pull git submodules, install
+dev requirements etc.) and build the project. `make` will automatically install
+`implot` in the *development/editable* mode.

config-cpp/py_imconfig.cpp

@@ -0,0 +1,27 @@
+#include "py_imconfig.h"
+#include "plot.h"
+
+// note: error type can be controlled during compilation
+#ifndef PYIMGUI_CUSTOM_EXCEPTION
+#define PYIMGUI_EXC_TYPE PyExc_RuntimeError
+#else
+#define PYIMGUI_EXC_TYPE ImGuiError
+#endif
+
+
+// ImGui does not throw exceptions whenever error occurs. The only way to add
+// error handling is to provide custom IM_ASSERT definition. Here we can
+// set Python interpreter exception and also throw C++ exception to interrupt
+// any function call in order to avoid any memory corruption.
+void __py_assert(const char* msg) {
+    // At first, set the Python exception state so we don't need to provide
+    // custom exception translation function everywhere in Cython code
+    PyErr_SetString(PYIMGUI_EXC_TYPE, msg);
+
+    // Throw anything so on the Cython side we can can catch it with
+    // something like:
+    //
+    //     cdef extern from "imgui.h" namespace "ImGui":
+    //         void PopStyleVar(int) except +
+    throw msg;
+}