diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..0dbc12d --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,142 @@ +cmake_minimum_required(VERSION 3.1.3) # Least supporting CMAKE_CXX_STANDARD +############################################################################### + +project(albert VERSION 0.16.1) + +############################################################################### + +include(GNUInstallDirs) + +############################################################################### + +add_definitions(-DALBERT_VERSION="${PROJECT_VERSION}") + +# Find includes in corresponding build directories +set(CMAKE_INCLUDE_CURRENT_DIR ON) + +# Instruct CMake to run moc automatically when needed. +set(CMAKE_AUTOMOC ON) +set(CMAKE_AUTOUIC ON) +set(CMAKE_AUTORCC ON) + +# Set standard +set(CMAKE_CXX_STANDARD 14) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +set(CMAKE_CXX_EXTENSIONS OFF) + +# Set additional compiler flags +set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic") #-Wconversion -Wunused +set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -DQT_QML_DEBUG") + +# Color make output +SET(CMAKE_COLOR_MAKEFILE ON) + +# Put the binaries in dedicated toplevel directories +set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib) +set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin) + +############################################################################### + +add_subdirectory(lib/globalshortcut) +add_subdirectory(lib/xdg) +add_subdirectory(plugins/) + +############################################################################### + +set(TARGET_NAME_LIB ${PROJECT_NAME}-lib) + +file(GLOB_RECURSE LIB_SRC include/* src/lib/*) + +add_library(${TARGET_NAME_LIB} SHARED ${LIB_SRC}) +add_library(albert::lib ALIAS ${TARGET_NAME_LIB}) + +set_target_properties(${TARGET_NAME_LIB} PROPERTIES + OUTPUT_NAME ${PROJECT_NAME} + INSTALL_RPATH "$ORIGIN" +) + +target_compile_definitions(${TARGET_NAME_LIB} PRIVATE -DCORE) #export branch + +target_include_directories(${TARGET_NAME_LIB} + PUBLIC + include + PRIVATE + include/albert + include/albert/util + src/lib +) + +find_package(Qt5 5.5.0 + COMPONENTS + Gui + Sql +) + +target_link_libraries(${TARGET_NAME_LIB} + PRIVATE + Qt5::Gui + Qt5::Sql +) + +############################################################################### + +option(BUILD_WITH_QTCHARTS "Use QtCharts to plot stats." ON) + +find_package(Qt5 5.5.0 + COMPONENTS + Concurrent + Network + Sql + Widgets + OPTIONAL_COMPONENTS + Charts +) + +set(TARGET_NAME_BIN ${PROJECT_NAME}-bin) + +file(GLOB_RECURSE BIN_SRC src/app/*) +if(NOT BUILD_WITH_QTCHARTS) # TODO: remove Apr 2020 + list(REMOVE_ITEM BIN_SRC "${CMAKE_CURRENT_SOURCE_DIR}/src/app/settingswidget/statswidget.h") + list(REMOVE_ITEM BIN_SRC "${CMAKE_CURRENT_SOURCE_DIR}/src/app/settingswidget/statswidget.cpp") +endif() + +add_executable(${TARGET_NAME_BIN} ${BIN_SRC} resources.qrc) + +set_target_properties(${TARGET_NAME_BIN} PROPERTIES + OUTPUT_NAME ${PROJECT_NAME} + INSTALL_RPATH "$ORIGIN/../${CMAKE_INSTALL_LIBDIR}/albert/" # Set the RPATH for the library lookup +) + +target_include_directories(${TARGET_NAME_BIN} PRIVATE src/app src/app/settingswidget) +if (DEFINED CMAKE_LIBRARY_ARCHITECTURE) + target_compile_definitions(${TARGET_NAME_BIN} PRIVATE -DMULTIARCH_TUPLE="${CMAKE_LIBRARY_ARCHITECTURE}") +endif() + +target_link_libraries(${TARGET_NAME_BIN} + PRIVATE + Qt5::Concurrent + Qt5::Network + Qt5::Sql + Qt5::Widgets + albert::lib + globalshortcut + xdg +) +if(BUILD_WITH_QTCHARTS) + target_link_libraries(${TARGET_NAME_BIN} PRIVATE Qt5::Charts) + target_compile_definitions(${TARGET_NAME_BIN} PRIVATE -DBUILD_WITH_QTCHARTS) #export branch +endif() + +############################################################################### + +install(TARGETS ${TARGET_NAME_LIB} ${TARGET_NAME_BIN} + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} +) + +# Do platform specific post target stuff +if(${CMAKE_SYSTEM_NAME} MATCHES "Linux") + # Install desktop entry and icon + install(FILES resources/albert.desktop DESTINATION ${CMAKE_INSTALL_DATADIR}/applications ) + install(FILES resources/icons/albert.svg DESTINATION ${CMAKE_INSTALL_DATADIR}/icons/hicolor/scalable/apps) +endif (${CMAKE_SYSTEM_NAME} MATCHES "Linux") diff --git a/Dockerfile.ubuntu1604 b/Dockerfile.ubuntu1604 new file mode 100644 index 0000000..f8a420f --- /dev/null +++ b/Dockerfile.ubuntu1604 @@ -0,0 +1,37 @@ +FROM ubuntu:16.04 + +# Prepare system +RUN export DEBIAN_FRONTEND=noninteractive \ + && apt-get -qq update \ + && apt-get install --no-install-recommends -y \ + cmake \ + g++ \ + libmuparser-dev \ + libqalculate-dev \ + libqt5svg5-dev \ + libqt5x11extras5-dev \ + python3-dev \ + qtbase5-dev \ + qtdeclarative5-dev \ + unzip \ + virtualbox \ + wget \ + && true + +# Install virtualbox headers +RUN true \ + && mkdir /tmp/vbox \ + && cd /tmp/vbox \ + && wget -q http://download.virtualbox.org/virtualbox/5.2.22/VirtualBoxSDK-5.2.22-126460.zip \ + && unzip VirtualBoxSDK-5.2.22-126460.zip \ + && mv sdk/bindings/xpcom/include /usr/lib/virtualbox/sdk/bindings/xpcom \ + && cd - \ + && rm -rf /tmp/vbox + +COPY . /srv/albert/src/ + +WORKDIR /srv/albert/build/ +RUN true \ + && cmake /srv/albert/src/ -DCMAKE_BUILD_TYPE=Debug -DBUILD_WITH_QTCHARTS=OFF \ + && make \ + && make install diff --git a/Dockerfile.ubuntu1804 b/Dockerfile.ubuntu1804 new file mode 100644 index 0000000..8f34cbd --- /dev/null +++ b/Dockerfile.ubuntu1804 @@ -0,0 +1,38 @@ +FROM ubuntu:18.04 + +# Prepare system +RUN export DEBIAN_FRONTEND=noninteractive \ + && apt-get -qq update \ + && apt-get install --no-install-recommends -y \ + cmake \ + g++ \ + libmuparser-dev \ + libqt5charts5-dev \ + libqalculate-dev \ + libqt5svg5-dev \ + libqt5x11extras5-dev \ + python3-dev \ + qtbase5-dev \ + qtdeclarative5-dev \ + unzip \ + virtualbox \ + wget \ + && true + +# Install virtualbox headers +RUN true \ + && mkdir /tmp/vbox \ + && cd /tmp/vbox \ + && wget -q http://download.virtualbox.org/virtualbox/5.2.22/VirtualBoxSDK-5.2.22-126460.zip \ + && unzip VirtualBoxSDK-5.2.22-126460.zip \ + && mv sdk/bindings/xpcom/include /usr/lib/virtualbox/sdk/bindings/xpcom \ + && cd - \ + && rm -rf /tmp/vbox + +COPY . /srv/albert/src/ + +WORKDIR /srv/albert/build/ +RUN true \ + && cmake /srv/albert/src/ -DCMAKE_BUILD_TYPE=Debug \ + && make \ + && make install diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..c16fc65 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,19 @@ + + +#### Source + + +#### Environment + + + +#### Steps to reproduce + +#### Expected behaviour + +#### Actual behaviour diff --git a/README.md b/README.md index 757634f..c814630 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ -# albert-hamonikr -launcher +# Albert launcher [![Build Status](https://api.travis-ci.org/albertlauncher/albert.svg?branch=dev)](https://travis-ci.org/albertlauncher/albert) + +[![Telegram news channel](https://img.shields.io/badge/news%20channel-telegram-0088cc.svg?style=flat)](https://telegram.me/albertlauncher) +[![Telegram community chat](https://img.shields.io/badge/chat-telegram-0088cc.svg?style=flat)](https://telegram.me/albert_launcher_community) +[![Discord](https://img.shields.io/badge/chat-discord-7289da.svg?style=flat)](https://discord.gg/enGMWUG) +[![IRC](https://img.shields.io/badge/chat-IRC-brightgreen.svg)](http://webchat.freenode.net/?channels=%23albertlauncher) + +## Albert in a nutshell + +Albert is a unified and efficient access to your machine. Technically it is a keyboard launcher written in C++/Qt. The plugin based architecture makes it extremely flexible and powerful. Plugins can be used to create modular frontends or native extensions. Extensions can also be implemented using embedded Python modules or via a CGI approach in any language you want. The frontends shipped heavily focus on customizability. + +## Getting started + +Check the section [*Installing Albert*](https://albertlauncher.github.io/docs/installing/) in the docs for setup instructions. When you are set up take a look at the section [*Using Albert*](https://albertlauncher.github.io/docs/using/). If you have problems check the [*Troubleshooting*](https://albertlauncher.github.io/docs/faq/) section. If it does not cover your problems seek for [*help*](https://albertlauncher.github.io/help/) in one of the chats. Developers may want to check the [*Extending Albert*](https://albertlauncher.github.io/docs/extending/) section. + +## Albert at a glance + +

+

+

+

+

+

+

+

+

+

+

+

+

+ +# Support + +If you like this software consider [donating](https://albertlauncher.github.io/docs/donation/) a :beer:. :+1: + +Have fun with albert, if you do not, [tell me why](https://telegram.me/albert_launcher_community). diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 0000000..8f7a86c --- /dev/null +++ b/debian/changelog @@ -0,0 +1,19 @@ +albert (0.16.1hamonikr1) stable; urgency=low + + * rebuild for hamonikr 4.0 + - added theme for hamonikr 4.0 jin + - add korean application name in desktop file + + -- HamoniKR Wed, 28 Oct 2020 16:38:31 +0900 + +albert (0.16.1) stable; urgency=low + + * version number update by debtransform + + -- debtransform Sat, 13 Jun 2020 13:10:17 +0000 + +albert (0.16.1-0) stable; urgency=low + + * Albert Upstream Release + + -- Manuel Schneider Sun, 29 Oct 2017 00:00:00 +0000 diff --git a/debian/compat b/debian/compat new file mode 100644 index 0000000..ec63514 --- /dev/null +++ b/debian/compat @@ -0,0 +1 @@ +9 diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..bf636fa --- /dev/null +++ b/debian/control @@ -0,0 +1,26 @@ +Source: albert +Section: utils +Priority: optional +Maintainer: Manuel Schneider +Standards-Version: 4.0.0 +Homepage: https://albertlauncher.github.io/ +Vcs-Git: ghttps://github.com/albertlauncher/albert.git +Build-Depends: + debhelper (>=9), + cmake (>=3.1.3), + qtbase5-dev (>=5.5), + libqt5x11extras5-dev (>=5.5), + libqt5svg5-dev (>=5.5), + qtdeclarative5-dev (>=5.5), + libmuparser-dev (>=2), + python3-dev (>=3.5), + lsb-release + + +Package: albert +Architecture: any +Depends: ${shlibs:Depends}, libqt5sql5-sqlite +Recommends: qml-module-qtgraphicaleffects, qml-module-qtquick-controls +Description: A sophisticated, plugin-based, standalone keyboard launcher written in C++/Qt + Albert is a unified and efficient access to your machine. Technically it is a keyboard launcher written in C++/Qt. The plugin based architecture makes it extremely flexible and powerful. Plugins can be used to create modular frontends or native extensions. Extensions can also be implemented using embedded Python modules or via a CGI approach in any language you want. The frontends shipped heavily focus on customizability. + diff --git a/debian/rules b/debian/rules new file mode 100755 index 0000000..7c7ef30 --- /dev/null +++ b/debian/rules @@ -0,0 +1,17 @@ +#!/usr/bin/make -f +CODENAME = $(shell lsb_release -cs) +export DH_VERBOSE = 1 +#export DEB_BUILD_MAINT_OPTIONS = hardening=+all +#export DEB_CFLAGS_MAINT_APPEND = -Wall -pedantic +#export DEB_LDFLAGS_MAINT_APPEND = -Wl,--as-needed + + +%: + dh $@ + +override_dh_auto_configure: +ifneq (, $(findstring ${CODENAME},"xenial" "yakkety" "zesty" "stretch")) + dh_auto_configure -- -DBUILD_WITH_QTCHARTS=OFF +else + dh_auto_configure -- +endif diff --git a/dist/albert.changes b/dist/albert.changes new file mode 100644 index 0000000..703939a --- /dev/null +++ b/dist/albert.changes @@ -0,0 +1,399 @@ +v0.16.1 (2018-12-31) + +* [albert] Fix default plugin lookup path +* [albert] Fix flicker when changing frontends +* [albert] Fix "Terminal option resets after a restart" +* [albert] Link libglobalshortcut statically +* [albert] Add a build flag for QtCharts +* [albert] Drop debug options if favor of QLoggingCategory env vars +* [plugins:ssh] Fix input regex. Sort by length then lexically. +* [plugins:ssh] Use backward compatible ssh url syntax +* [plugins:qml] Consistent form layout +* [modules:aur] Sort items by length first + +v0.16.0 (2018-12-28) + +* Add jekyll website as submodule +* New project structure (minimal shared lib) +* Let travis build against Ubuntu 18.04 and 16.04 +* Backward compatibility for Ubuntu 16.04 +* Let fuzzy require an additional character. Tolerance: floor((wordlen - 1)/3)) +* Print logging category to stdout QT_LOGGING_RULES="*debug=false;driver.usb.debug=true" +* [Term] Change terminal action order: Let "Run w/o term" be the last one +* [VBox] Set default build switch for VirtualBox to OFF +* [Files] Add fancy icons to mime dialog +* [Py] Use ast to read metadata without loading the modules +* [Py] Additional constraint: Metadata have to be string literals (for ast) +* [Py] Additional constraint: Name modules according PEP8 +* [Py/WinSwitch] Add close win action +* [Py/VBox] Add VirtualBox extension + +v0.15.0 (2018-12-16) + +* Usage graph in the settings (QtCharts (>=5.6)) +* [QML] Frontend plugin requires ()5.9 +* [QML] History search of the input now allows substring matching (Type and navigate) +* [QML] Store user input of every session +* New Python extension: Fortune +* New Python extension: Window switcher + +v0.14.22 (2018-09-21) + +* Telemetry is now opt-in. +* New Python extension: Pidgin +* New themes + +v0.14.21 (2018-06-08) + +* Bugfix release + +v0.14.20 (2018-06-04) + +* Bugfix release + +v0.14.19 (2018-05-15) + +* New Python extension: Datetime. (Time display and conversion. Supersedes the external extension) +* New Python extension: Bitfinex. (Quickly access Bitfinex markets) +* The file browse mode finally mimics bash completion behavior. + +v0.14.18 (2018-03-23) + +* Hotfix release + +v0.14.17 (2018-03-23) + +* New Python extension: Arch Wiki +* New option in applications extension: Use keywords for lookup +* New option in applications extension: Use generic name for lookup +* The _kvstore_ extension was renamed to _Snippets_ and got an improved config UI. + +v0.14.16 (2018-03-09) + +* New Python extension: Gnome dictionary (nikhilwanpal) +* New Python extension: Mathematica (Asger Hautop Drewsen) +* New Python extension: TeX to unicode (Asger Hautop Drewsen) +* New Python extension: IP address (Benedict Dudel) +* New Python extension: Multi Translate (David Britt) +* New Python extension: Emoji lookup (David Britt) +* New Python extension: Kaomoji lookup (David Britt) +* New Python extension: Timer +* New Python extension: Binance + +v0.14.15 (2018-01-26) + +* New Python extensions: CoinMarketCap, Trash, Pomodoro, Epoch, Packagist. +* New Python API PythonInterface/v0.2 (`configLocation()`, `dataLocation()`,`cacheLocation()`). + +v0.14.14 (2017-12-06) + +* New Python extension: npm (Benedict Dudel) + +v0.14.13 (2017-11-25) + +* Rich text support +* New AUR Python extension +* New `scrot` Python extension + +v0.14.12 (2017-11-23) + +* New CopyQ Python extension (Ported from external extension) + +v0.14.11 (2017-11-19) + +* New `locate` Python extension + +v0.14.10 (2017-11-16) + +* Bugfixes + +v0.14.9 (2017-11-16) + +* Better HiDPI support +* New commandline option for debug output (-d) + +v0.14.8 (2017-11-14) + +* New Gnote Python extension (Ported from external extension) +* New Tomboy Python extension (Ported from external extension) +* New Pacman Python extension +* New Pass Python extension +* New Kill Python extension + +v0.14.7 (2017-11-03) + +* Bugfixes + +v0.14.6 (2017-10-31) + +* New Wikipedia Python extension + +v0.14.5 (2017-10-30) + +* Bugfixes + +v0.14.4 (2017-10-25) + +* New base converter Python extension + +v0.14.3 (2017-10-21) + +* New Google Translate Python extension + +v0.14.2 (2017-10-20) + +* Bugfixes + +v0.14.1 (2017-10-19) + +* Bugfixes + +v0.14.0 (2017-10-18) + +* New Python Embedding extension +* New Python Eval Python extension +* New Debugging Python extension +* New Zeal Python extension +* New GoldenDict Python extension +* New Unit Converter Python extension (Gnu units) +* New Currency Converter Python extension (Google finance) + +v0.13.1 (2017-00-30) + +* Bugfixes + +v0.13.0 (2017-09-28) + +* Modular frontends +* QML frontend +* Tree structure in file index and "smart" indexing +* New KeyValue extension +* New Hash Generator extension +* Shell like completion for terminal extension + +v0.12.0 (2017-06-09) + +* Git-like ignore files +* Dedicated dialog for websearch editing. + +v0.11.3 (2017-05-28) + +* Bugfixes + +v0.11.2 (2017-05-13) + +* Home and End now work for the results list holding Ctrl. + +v0.11.1 (2017-04-16) + +* Bugfixes + +v0.11.0 (2017-04-16) + +* Fine-grained control of the MIME types to be indexed. +* Extensions can now have multiple triggers. +* The sorting algorithm is now stable. +* Browse mode now lists the results in lexicographical order with directories before the files. +* The use of fallbacks has been disabled for triggered queries. +* Further the websearch extension now contains an URL handler. +* The qss property `selection-color` works as expected now. + +v0.10.4 (2017-04-14) + +* Bugfixes + +v0.10.3 (2017-04-02) + +* Terminal extension does no more show suggestions. +* Any shell querying dropped. +* Bugfixes + +v0.10.2 (2017-03-24) + +* Bugfixes + +v0.10.1 (2017-03-20) + +* Bugfixes + +v0.10.0 (2017-03-19) + +* Tab completion. +* Hovering over the input box the mouse wheel can now be used to browse the history. +* Spotlight themes (Bright, Dark and Space). +* New native extension: MPRIS +* New native extension: Secure Shell +* The terminal extension now provides the shell aliases too. +* File browse mode. +* The application extension allows to ignore the `OnlyShowIn`/`NotShowIn` keys. +* The bash script to clone the template extension is now deprecated and replaced by a Python script. + +v0.9.5 (2017-03-13) + +* Bugfixes + +v0.9.4 (2017-03-01) + +* Bugfixes + +v0.9.3 (2017-02-05) + +* Bugfixes + +v0.9.2 (2017-01-30) + +* Bugfixes + +v0.9.1 (2017-01-23) + +* Chooseable terminal command of a list of installed terminals. +* The app icon now uses a theme icon +* _Open terminal here_ action. +* Mostly fixes + +v0.9.0 (2017-01-17) + +* New extension system architecture +* New native extension: External extensions +* New native extension: Firefox +* Improved VirtualBox extension + +v0.8.11 (2016-09-29) + +* Plugin abstraction architecture +* New plugin support: Native C++ QPlugins +* New plugin support: Executables +* Single click activation of items +* Action modifiers +* Multithreading +* Core is now responsible for usage counting (obsoletes most serialization) +* Asynchronous query "live" results +* Tray icon +* New option: Show tray icon +* New extension: Debug + +v0.8.10 (2016-06-23) + +* New extension: Virtual Box +* Basic IPC +* Graceful termination on SIGHUP + +v0.8.9 (2016-05-12) + +* New option: Hide on close +* New option: Display shadow +* Graceful termination on SIGINT + +v0.8.8 (2016-04-28) + +* Single instance + +v0.8.7.3 (2016-04-27), v0.8.7.2 (2016-04-03), v0.8.7.1 (2016-03-31) + +* Hotfixes + +v0.8.7 (2016-03-31) + +* New extension: Terminal +* Project structure: Use libraries + +v0.8.6 (2016-03-28) + +* Restructured settings widget + +v0.8.5 (2016-03-25) + +* Custom icon lookup +* Make main window movable +* Show alternative actions o Tab +* New option: Always on top +* New option: Hide on focus out +* New option: Display icons +* New option: Display scrollbar +* Dozens of new themes: Dark, Bright, SolarizedDark, SolarizedBright in several colors. + +v0.8.4 (2016-03-15) + +* Show message box after ungraceful termination + +v0.8.3 (2016-03-13) + +* Restructured settings widget + +v0.8.2 (2016-03-09) + +* New option: Group separators for calculator +* New themes: Arc +* New theme: Numix + +v0.8.1 (2016-03-04) + +* Minor tasks and improvements + +v0.8.0 (2015-10-27) + +* New extension: System control + +v0.7.7 (2015-10-16) + +* Bring settings window to front if it is already open. + +v0.7.6 (2015-10-15) + +* Reorderable websearches +* Allow exclusive queries by trigger + +v0.7.5 (2015-10-12) + +* Graceful termination on SIGINT + +v0.7.1 (2015-10-06), v0.7.2 (2015-10-07), v0.7.3 (2015-10-07), v0.7.4 (2015-10-08) + +* Tasks, Hotfixes, minor changes + +v0.7.0 (2015-10-05) + +* Implement plugin architecture +* Port the modules +* Ignore file (".albertignore") +* Actions +* Threaded background indexing +* New themes + +v0.6.0 (2014-11-12) + +* Make action modifications configurable +* Command history + +v0.5.0 (2014-11-06) + +* Add configuration widget to configure the modules +* Make user interface themable +* Provide proof-of-concept themes +* Make actions modifiable +* Show action modifications in the list +* Use CMake build system + +v0.4.0 (2014-10-16) + +* Add settings widget +* Implement indexing and search algorithms 'prefixmatch' and 'fuzzy' + +v0.3.0 (2014-09-12) + +* Implement serialization of indexes +* New module: Applications +* New module: Bookmarks +* New module: Calculator +* New module: Web search + +v0.2.0 (2014-09-08) + +* Abstract module architecture +* New module: Files + +v0.1.0 (2014-09-01) + +* Basic user interface +* Hotkeymanager + diff --git a/doc/.travis.yml b/doc/.travis.yml new file mode 100644 index 0000000..52864ce --- /dev/null +++ b/doc/.travis.yml @@ -0,0 +1,19 @@ +language: ruby + +install: gem install jekyll html-proofer + +addons: + apt: + packages: + - libcurl4-openssl-dev # Avoid ssl errors + +script: jekyll build -s src -d ./site && htmlproofer ./site + +deploy: + provider: script + skip_cleanup: true + on: + branch: master + script: ./deploy.sh + +sudo: false diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..2baf365 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,5 @@ +# Jekyll-powered Albert documentation website [![Build Status](https://travis-ci.org/albertlauncher/documentation.svg?branch=master)](https://travis-ci.org/albertlauncher/documentation) + +Automatically built and deployed by Travis CI. + +The output is goes [here](https://github.com/albertlauncher/albertlauncher.github.io) and is browsable [here](https://albertlauncher.github.io/). diff --git a/doc/deploy.sh b/doc/deploy.sh new file mode 100755 index 0000000..abefb1f --- /dev/null +++ b/doc/deploy.sh @@ -0,0 +1,9 @@ +set -o errexit +set -o xtrace +cd ./site +git init +git config user.name "Travis CI" +git config user.email "deploy@travis-ci.org" +git add . +git commit -m "Automated Travis CI deployment" +git push --force "https://${GITHUB_TOKEN}@github.com/albertlauncher/albertlauncher.github.io.git" master # &> /dev/null diff --git a/doc/src/README.md b/doc/src/README.md new file mode 100644 index 0000000..1af8087 --- /dev/null +++ b/doc/src/README.md @@ -0,0 +1,7 @@ +# Albert documentation website + +Automatically built and deployed by Travis CI. + +Source code: [albertlauncher/documentation](https://github.com/albertlauncher/documentation) + +Website: [albertlauncher.github.io](https://albertlauncher.github.io/) diff --git a/doc/src/_config.yml b/doc/src/_config.yml new file mode 100644 index 0000000..875b764 --- /dev/null +++ b/doc/src/_config.yml @@ -0,0 +1,23 @@ +# Site settings +# These are used to personalize your new site. If you look in the HTML files, +# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. +# You can create any custom variable you would like, and they will be accessible +# in the templates via {{ site.myvariable }}. +title: Albert +email: manuelschneid3r@gmail.com +description: > # this means to ignore newlines until "baseurl:" + Write an awesome description for your new site here. You can edit this + line in _config.yml. It will appear in your document head meta (for + Google search results) and in your feed.xml site description. +baseurl: "" # the subpath of your site, e.g. /blog +url: https://albertlauncher.github.io +github_username: manuelschneid3r +repository: https://github.com/albertlauncher/albert.git +exclude: [vendor] + +collections: + docs: + output: true + +#gems: +#- jemoji diff --git a/doc/src/_data/docs.yml b/doc/src/_data/docs.yml new file mode 100644 index 0000000..1a984c0 --- /dev/null +++ b/doc/src/_data/docs.yml @@ -0,0 +1,21 @@ +- title: User guide + docs: + - installing + - using + - extending + - extensions + - faq + +#- title: Dev guide +# docs: +# - extending/native +# - extending/external +# - extending/python +# - extending/javascript +# - extending/lua + +- title: Meta + docs: + - contributing + - donation + - changelog diff --git a/doc/src/_docs/changelog.md b/doc/src/_docs/changelog.md new file mode 100644 index 0000000..d5b1bec --- /dev/null +++ b/doc/src/_docs/changelog.md @@ -0,0 +1,319 @@ +--- +layout: docs +title: Changelog +permalink: /docs/changelog/ +--- +This is the feature centric changelog. It may be a bit behind, since I update it in batches. For a complete changelog refer to the news and git log. + +v0.14.14 (2017-12-06) + +- New npm Python extension + +v0.14.13 (2017-11-25) + +- Rich text support +- New AUR Python extension +- New `scrot` Python extension + + +v0.14.12 (2017-11-23) + +- New CopyQ Python extension (Ported from external extension) + +v0.14.11 (2017-11-19) + +- New `locate` Python extension + +v0.14.10 (2017-11-16) + +- Bugfixes + +v0.14.9 (2017-11-16) + +- Better HiDPI support +- New commandline option for debug output (-d) + +v0.14.8 (2017-11-14) + +- New Gnote Python extension (Ported from external extension) +- New Tomboy Python extension (Ported from external extension) +- New Pacman Python extension +- New Pass Python extension +- New Kill Python extension + +v0.14.7 (2017-11-03) + +- Bugfixes + +v0.14.6 (2017-10-31) + +- New Wikipedia Python extension + +v0.14.5 (2017-10-30) + +- Bugfixes + +v0.14.4 (2017-10-25) + +- New base converter Python extension + +v0.14.3 (2017-10-21) + +- New Google Translate Python extension + +v0.14.2 (2017-10-20) + +- Bugfixes + +v0.14.1 (2017-10-19) + +- Bugfixes + +v0.14.0 (2017-10-18) + +- New Python Embedding extension +- New Python Eval Python extension +- New Debugging Python extension +- New Zeal Python extension +- New GoldenDict Python extension +- New Unit Converter Python extension (Gnu units) +- New Currency Converter Python extension (Google finance) + +v0.13.1 (2017-00-30) + +- Bugfixes + +v0.13.0 (2017-09-28) + +- Modular frontends +- QML frontend +- Tree structure in file index and "smart" indexing +- New KeyValue extension +- New Hash Generator extension +- Shell like completion for terminal extension + +v0.12.0 (2017-06-09) + +- Git-like ignore files +- Dedicated dialog for websearch editing. + +v0.11.3 (2017-05-28) + +- Bugfixes + +v0.11.2 (2017-05-13) + +- Home and End now work for the results list holding Ctrl. + +v0.11.1 (2017-04-16) + +- Bugfixes + +v0.11.0 (2017-04-16) + +- Fine-grained control of the MIME types to be indexed. +- Extensions can now have multiple triggers. +- The sorting algorithm is now stable. +- Browse mode now lists the results in lexicographical order with directories before the files. +- The use of fallbacks has been disabled for triggered queries. +- Further the websearch extension now contains an URL handler. +- The qss property `selection-color` works as expected now. + +v0.10.4 (2017-04-14) + +- Bugfixes + +v0.10.3 (2017-04-02) + +- Terminal extension does no more show suggestions. +- Any shell querying dropped. +- Bugfixes + +v0.10.2 (2017-03-24) + +- Bugfixes + +v0.10.1 (2017-03-20) + +- Bugfixes + +v0.10.0 (2017-03-19) + +- Tab completion. +- Hovering over the input box the mouse wheel can now be used to browse the history. +- Spotlight themes (Bright, Dark and Space). +- [MPRIS](/docs/extensions/mpris/) extension +- [Secure Shell](/docs/extensions/ssh/) extension. +- The terminal extension now provides the shell aliases too. +- File browse mode. +- The application extension allows to ignore the `OnlyShowIn`/`NotShowIn` keys. +- The bash script to clone the template extension is now deprecated and replaced by a Python script. + +v0.9.5 (2017-03-13) + +- Bugfixes + +v0.9.4 (2017-03-01) + +- Bugfixes + +v0.9.3 (2017-02-05) + +- Bugfixes + +v0.9.2 (2017-01-30) + +- Bugfixes + +v0.9.1 (2017-01-23) + +- Chooseable terminal command of a list of installed terminals. +- The app icon now uses a theme icon +- _Open terminal here_ action. +- Mostly fixes + +v0.9.0 (2017-01-17) + +- New extension system architecture +- External extensions extension +- Firefox extension +- Improved VirtualBox extension + +v0.8.11 (2016-09-29) + +- Plugin abstraction architecture +- New plugin support: Native C++ QPlugins +- New plugin support: Executables +- Single click activation of items +- Action modifiers +- Multithreading +- Core is now responsible for usage counting (obsoletes most serialization) +- Asynchronous query "live" results +- Tray icon +- New option: Show tray icon +- New extension: Debug + +v0.8.10 (2016-06-23) + +- New extension: Virtual Box +- Basic IPC +- Graceful termination on SIGHUP + +v0.8.9 (2016-05-12) + +- New option: Hide on close +- New option: Display shadow +- Graceful termination on SIGINT + +v0.8.8 (2016-04-28) + +- Single instance + +v0.8.7.3 (2016-04-27), v0.8.7.2 (2016-04-03), v0.8.7.1 (2016-03-31) + +- Hotfixes + +v0.8.7 (2016-03-31) + +- New extension: Terminal +- Project structure: Use libraries + +v0.8.6 (2016-03-28) + +- Restructured settings widget + +v0.8.5 (2016-03-25) + +- Custom icon lookup +- Make main window movable +- Show alternative actions o Tab +- New option: Always on top +- New option: Hide on focus out +- New option: Display icons +- New option: Display scrollbar +- Dozens of new themes: Dark, Bright, SolarizedDark, SolarizedBright in several colors. + +v0.8.4 (2016-03-15) + +- Show message box after ungraceful termination + +v0.8.3 (2016-03-13) + +- Restructured settings widget + +v0.8.2 (2016-03-09) + +- New option: Group separators for calculator +- New themes: Arc +- New theme: Numix + +v0.8.1 (2016-03-04) + +- Minor tasks and improvements + +v0.8.0 (2015-10-27) + +- New extension: System control + +v0.7.7 (2015-10-16) + +- Bring settings window to front if it is already open. + +v0.7.6 (2015-10-15) + +- Reorderable websearches +- Allow exclusive queries by trigger + +v0.7.5 (2015-10-12) + +- Graceful termination on SIGINT + +v0.7.1 (2015-10-06), v0.7.2 (2015-10-07), v0.7.3 (2015-10-07), v0.7.4 (2015-10-08) + +- Tasks, Hotfixes, minor changes + +v0.7.0 (2015-10-05) + +- Implement plugin architecture +- Port the modules +- Ignore file (".albertignore") +- Actions +- Threaded background indexing +- New themes + +v0.6.0 (2014-11-12) + +- Make action modifications configurable +- Command history + +v0.5.0 (2014-11-06) + +- Add configuration widget to configure the modules +- Make user interface themable +- Provide proof-of-concept themes +- Make actions modifiable +- Show action modifications in the list +- Use CMake build system + +v0.4.0 (2014-10-16) + +- Add settings widget +- Implement indexing and search algorithms 'prefixmatch' and 'fuzzy' + +v0.3.0 (2014-09-12) + +- Implement serialization of indexes +- New module: Applications +- New module: Bookmarks +- New module: Calculator +- New module: Web search + +v0.2.0 (2014-09-08) + +- Abstract module architecture +- New module: Files + +v0.1.0 (2014-09-01) + +- Basic user interface +- Hotkeymanager diff --git a/doc/src/_docs/contributing.md b/doc/src/_docs/contributing.md new file mode 100644 index 0000000..adf6eb6 --- /dev/null +++ b/doc/src/_docs/contributing.md @@ -0,0 +1,35 @@ +--- +layout: docs +title: Contributing +permalink: /docs/contributing/ +--- + +I'd like like to invite anyone to be part of the project. Generally this is pretty straight forward: Fork the repository, push your changes to the fork and finally send a pull request. However due to problems in the past there are some rules on ***how*** you should contribute: + +1. _**Do absolutely not just implement things and send a PR!**_ +2. [Contact](/help/) us / Open an issue / Comment an issue. +3. Discuss if the idea is reasonable and find a well designed approach. +4. Work on the issue. Reflect your work. If you have doubts, communicate it. +5. Test it. Not real world testing, but use it a few days yourself. +6. Send a PR to the `dev` branch. + +This way nobody has to reject PR's, nobodies PR's will get rejected and there won't be multiple developers working on the same issue. + +By contributing your code, you agree to license your contribution under the GPL license. According to the goals, only code that is well designed, documented, clear and readable will be accepted. + +## Other contributions + +There is plenty of other things you can do aside from coding: + +- Star the [project. ![Issues](https://img.shields.io/github/stars/albertlauncher/albert.svg?style=social&label=Stars)](https://github.com/albertlauncher/albert) +- Spread the word. +- Join the community and help other users. +- Use the application and report issues. +- Check the [issues](https://github.com/albertlauncher/albert/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20sort%3Areactions-%2B1-desc) and try to help debugging. [![Issues](https://img.shields.io/github/issues/albertlauncher/albert.svg)](https://github.com/albertlauncher/albert/issues) +- Improve the documentation (Link on top of the pages). +- Support me as a creator by [donating some bucks](/docs/donation/). + + +## Supporters + +The list [moved](/docs/supporters). diff --git a/doc/src/_docs/donation.md b/doc/src/_docs/donation.md new file mode 100644 index 0000000..99e5acb --- /dev/null +++ b/doc/src/_docs/donation.md @@ -0,0 +1,26 @@ +--- +layout: docs +title: Donating +permalink: /docs/donation/ +--- + +If you found here, you are probably thinking about donating some bucks for the development of your favorite keyboard launcher ;D That's great. Thank you. It makes me happy to know that people are grateful for what I (love to) do, and I highly appreciate that you are thinking about a donation. + +These are the services you can use to donate. I want to make it simple, so if you think the list below is missing something let me know. + + +* PayPal: + + [![Donate via PayPal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W74BQPKPGNSNC) + +* Patreon: + + [![Donate via Patreon](/img/patreon.png)](https://www.patreon.com/bePatron?u=4631163) + +* Crypto ❤️: + + If you want to donate crypto, please [contact me](https://t.me/manuelschneider). + +* Wire transfer (€/SEPA): + + Please [contact me](https://t.me/manuelschneider). diff --git a/doc/src/_docs/extending.md b/doc/src/_docs/extending.md new file mode 100644 index 0000000..996c170 --- /dev/null +++ b/doc/src/_docs/extending.md @@ -0,0 +1,75 @@ +--- +layout: docs +title: Extending Albert +permalink: /docs/extending/ +--- + + +Albert has a flexible extension system, which provides users and developers with the ability to extend the functionality by creating *plugins*. These plugins can be used to provide several kinds of functionality by implementing particular interfaces. An instance of such an interface is called an *extension*. A plugin can provide several extensions. + +The native and primary way is to use C++/Qt to write a QPlugin. This gives you the performance of C++, the full set of interfaces to implement, access to several utility classes and direct access to the application and Qt framework including the event loop, which allows asynchronous operations. C++ knowledge is not that widespread therefore there are extensions that make albert scriptable. The primary way to script albert is the [python extension](/docs/extensions/python/). It supports a good fraction of the internal API, is in memory and pretty fast. A more flexible but less performant way to extend Albert are [external extensions](/docs/extensions/external/). Since they are basically CGI executables you can use *any* language that can be used to build executable files. + +This article is about the native extension of the albert launcher. + +### Overview + +A native albert extension is a [Qt Plugin](http://doc.qt.io/qt-5/plugins-howto.html#the-low-level-api-extending-qt-applications.) which is nothing else but a special shared library. A plugin has to have the correct interface id (IID) and of course to implement this interfaces to be loaded, e.g. `Core::Extension` or `Core::Frontend`. The best way to to get an overview is to read the [core library interface](https://github.com/albertlauncher/albert/tree/master/include/albert) classes. The headers comments and the other plugins especially the [template extension](https://github.com/albertlauncher/plugins/tree/master/templateExtension) should get you started. + +The internal API is still not final yet. If you want to write a plugin check the other extensions. There are some caveats and requirements you should know: + +- Qt Plugin needs a metadata file +- The metadata needs a unique id to be loaded +- The metadata file name must match the name in the `Q_PLUGIN_METADATA` macro +- The interface id defined in `Q_PLUGIN_METADATA` must match the current one defined in the interface headers for the plugin to be loaded. + +### Getting started + +The best way to get started is to copy the [template extension](https://github.com/albertlauncher/plugins/tree/master/templateExtension) and adjust the contents. + +To keep the code readable there are some conventions that are not strictly necessary, but the intention is to unify the filenames of the plugins.The main class of the extension is called `Extension` and if the extension returns a configuration widget the class shall be called `ConfigWidget`. The metadata file is called `metadata.json`. This would implicitly lead to naming conflicts, therefor all classes of an extensions live in a dedicated namespace having the name of the extension. In bullets: + +- Copy the template extension. +- Adjust the values contents in `metadata.json` and project name in `CmakeLists.txt`. +- Rename the namespace. Remember to define the namespace in the `*.ui` files, too. +- Make sure to have checked all core library headers . +- Implement your extension. + +Contact us if you need [help](/help/). + +### Extension plugins + +Implement the `Core::Extension` and `Core::QueryHandler` interface. Especially `Core::Extension` is not final yet. But this should not be a problem. Since changes would need you to just change a few lines of code. + +`Core::QueryHandler` has several functions that will be called on special events. Most important is the virtual function `handleQuery(Query)` this function will be called when the user types in his queries. + +The `Core::Query` object contains all necessary information and accepts objects of abstract type `Core::Item`. Subclass it or use `Core::StandardItem`. The items interface has a getter for actions of abstract type `Core::Action`. Again subclass it or use `Core::StandardAction`. Furter there is the `Core::IndexableItem` interface with its standard implementation `Core::StandardIndexItem`. These items are for the use with the utility class `Core::OfflineIndex` which does basic offline indexing and searching for you. + +To get a detailed description of the interfaces read the header files of the core library interface classes. + +### Frontend plugins + +Implement the `Core::Frontend` interface. Implementing a frontend is a cumbersome process with tons of caveats. I will rather not write a documentation on it. [Contact](/help/) us directly. + + +### The plugin metadata + +The plugin metadata is a mandatory file that is needed to compile the plugin. Its content is *JSON* formatted and its name has to be equal to the the one specified in the `Q_PLUGIN_METADATA` in the extensions main class. The convention is to call it `metadata.json`. Its fields give the application information about the plugin without having to load the plugin. + +Currently the plugin specification has the following keys: +- `id` is the unique identifier of the app. A plugin will not be loaded if its id has been registered already by an other plugin. +- `name` is the pretty printed name of the plugin. +- `version` is, well, the version of the plugin. +- `author` name of the developer of this plugin. +- `dependencies` is an array of dependencies of this plugin. These dependencies are mandatory for the plugin but optional for the application. The user is responsible to install them. + +A plugin specification could look like the following: + +```json +{ + "id" : "org.albert.extension.bookmarks", + "name" : "Bookmarks", + "version" : "1.1", + "author" : "Manuel Schneider", + "dependencies" : [] +} +``` diff --git a/doc/src/_docs/extensions.md b/doc/src/_docs/extensions.md new file mode 100644 index 0000000..22f640c --- /dev/null +++ b/doc/src/_docs/extensions.md @@ -0,0 +1,35 @@ +--- +layout: docs +title: Extensions +permalink: /docs/extensions/ +--- + +From the user perspective the application consists of the launcher, which is the main window, the settings window and the tray icon if you enabled it. However under the hood Albert has a plugin based architecture, which allows the user to modify or extend the functionality of the application. +There are several extensions that get shipped together with the main albert core. + +## The frontends + +- [Widgets Box Model](/docs/extensions/widgetboxmodel/) +- [QML Box Model](/docs/extensions/qmlboxmodel/) + +## The extensions + +- [Applications](/docs/extensions/applications/) +- [Calculator](/docs/extensions/calculator/) +- [Chromium](/docs/extensions/chromium/) +- [External extensions](/docs/extensions/external/) +- [Files](/docs/extensions/files/) +- Firefox +- Hash generator +- [MPRIS](/docs/extensions/mpris/) +- [Python](/docs/extensions/python/) +- [Secure Shell](/docs/extensions/ssh/) +- Snippets +- System +- Terminal +- [VirtualBox](/docs/extensions/virtualbox/) +- [Websearch](/docs/extensions/websearch/) + +## Python extensions + +The Python extension adds a lot of functionality via python modules. Most of the community effort goes into this part of the project. Check [the repo](https://github.com/albertlauncher/python) for an up to date list of extensions. diff --git a/doc/src/_docs/extensions/applications.md b/doc/src/_docs/extensions/applications.md new file mode 100644 index 0000000..7b94976 --- /dev/null +++ b/doc/src/_docs/extensions/applications.md @@ -0,0 +1,13 @@ +--- +layout: docs +title: Applications extension +permalink: /docs/extensions/applications/ +--- + +The applications extension makes desktop applications runnable by albert. The concept of desktop applications is described in the [freedesktop.org Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/). + +Desktop entries are looked up in the _applications_ directory in the paths set in `$XDG_DATA_HOME` and `$XDG_DATA_DIRS` environment variables. If they are not set, they default to `~/.local/share` and `/usr/local/share:/usr/share`. + +Every application is represented by a desktop file which has an ID. The desktop file ID is built using the path of the desktop file relative to the applications directory and turning '/' into '-'. If multiple files have the same desktop file ID, the first one in the precedence order given by the paths above is used. The standard action of an application item is to start the application, the alternative actions are defined by the desktop actions in the desktop entry. + +The fuzzy option in the settings dialog allows error tolerant matching of the items. diff --git a/doc/src/_docs/extensions/calculator.md b/doc/src/_docs/extensions/calculator.md new file mode 100644 index 0000000..bfeb169 --- /dev/null +++ b/doc/src/_docs/extensions/calculator.md @@ -0,0 +1,78 @@ +--- +layout: docs +title: Calculator extension +permalink: /docs/extensions/calculator/ +--- + +**Note**: This extension depends on [muparser](http://beltoforion.de/article.php?a=muparser). + +The calculator should be self-explanatory. The calculator item appears as soon as you type a valid math expression into the input box. Euler's number `_e` and π `_pi` are predefined. + +## Known limitations + +Muparser uses double precision floats which introduces the well known [precision problems](https://stackoverflow.com/questions/588004/is-floating-point-math-broken). + +## Built-in functions + +The following table gives an overview of the functions supported by the default implementation. It lists the function names, the number of arguments and a brief description. + +|Name|Argc.|Explanation| +|-|-|-| +|sin|1|sine function| +|cos|1|cosine function| +|tan|1|tangens function| +|asin|1|arcus sine function| +|acos|1|arcus cosine function| +|atan|1|arcus tangens function| +|sinh|1|hyperbolic sine function| +|cosh|1|hyperbolic cosine| +|tanh|1|hyperbolic tangens function| +|asinh|1|hyperbolic arcus sine function| +|acosh|1|hyperbolic arcus tangens function| +|atanh|1|hyperbolic arcur tangens function| +|log2|1|logarithm to the base 2| +|log10|1|logarithm to the base 10| +|log|1|logarithm to base e (2.71828...)| +|ln|1|logarithm to base e (2.71828...)| +|exp|1|e raised to the power of x| +|sqrt|1|square root of a value| +|sign|1|sign function -1 if x<0; 1 if x>0| +|rint|1|round to nearest integer| +|abs|1|absolute value| +|min|var.|min of all arguments| +|max|var.|max of all arguments| +|sum|var.|sum of all arguments| +|avg|var.|mean value of all arguments| + +## Built-in binary operators + +The following table lists the default binary operators supported by the parser. + +|Operator|Description|Priority| +|-|-|-| +|=|assignement|-1| +|&&|logical and|1| +|\|\||logical or|2| +|<=|less or equal|4| +|>=|greater or equal|4| +|!=|not equal|4| +|==|equal|4| +|>|greater than|4| +|<|less than|4| +|+|addition|5| +|-|subtraction|5| +|*|multiplication|6| +|/|division|6| +|^|raise x to the power of y|7| + +\*The assignment operator is special since it changes one of its arguments and can only by applied to variables. + +## Ternary Operators + +muParser has built in support for the if then else operator. It uses lazy evaluation in order to make sure only the necessary branch of the expression is evaluated. + +|Operator|Description|Remarks| +|-|-|-| +|?:|if then else operator|C++ style syntax| + +For more details check the [muparser documentation](http://beltoforion.de/article.php?a=muparser&hl=en&p=features&s=idDef1#idDef1). diff --git a/doc/src/_docs/extensions/chromium.md b/doc/src/_docs/extensions/chromium.md new file mode 100644 index 0000000..0b683db --- /dev/null +++ b/doc/src/_docs/extensions/chromium.md @@ -0,0 +1,9 @@ +--- +layout: docs +title: Chromium extension +permalink: /docs/extensions/chromium/ +--- + +The chromium/chrome extension makes your chromium/chrome bookmarks accessible via albert. + +In the settings dialog you can set the path to your bookmarks file, if the default path is not correct. This may happen if you have multiple profiles in use. The fuzzy option allows error tolerant matching of the items. diff --git a/doc/src/_docs/extensions/external.md b/doc/src/_docs/extensions/external.md new file mode 100644 index 0000000..3e6619d --- /dev/null +++ b/doc/src/_docs/extensions/external.md @@ -0,0 +1,26 @@ +--- +layout: docs +title: External extension +permalink: /docs/extensions/external/ +--- + +***Note: This scripting extension is deprecated as of v0.14.0. Use the python extension instead*** + + +Albert can be extended using regular executables. They are used like plugins, however the executables are separate processes which have separate address spaces. Therefore these executables are called _external plugins_. This documentation refers to the extension shipped with v0.13. + +An external plugin (hereafter plugin) is basically an executable which has a particular interface. Imagine the plugin as a set of functions that can be dynamically invoked. Which function is invoked, is defined by the environment variable `$ALBERT_OP`. The plugin should read this environment variable and react accordingly. Additionally to the mandatory environment variable `$ALBERT_OP` there may be some other variables defined. Imagine those as the parameters to the dynamic function. The return value of this function is returned to the application through the standard output stream (stdout). Depending on `$ALBERT_OP` the expected data may differ, but all responses have to be a JSON object containing properties. The set of possible `$ALBERT_OP`s and the expected properties and their structures are defined by the [*Communication protocol v3*](/docs/extensions/external/v3/) (Since v0.13, [*v2*](/docs/extensions/external/v2/) until 0.13). + +To save state between the executions the plugin can return a JSON object called "variables". The properties of the object "variables" will be set as environment variables in the next execution. Note that this properties have to be strings otherwise they will not be set in the environment. + +## Deployment + +> Note that the exteral extensions have to be executable to be used by albert + +The extension check its data directories for a directory called `extensions`. The name of a data directory is the id of the extension. I the case of the external extension this is `org.albert.extension.externalextensions`. The data directories reside in the data directories of the application defined by [Qt](http://doc.qt.io/qt-5/qstandardpaths.html#StandardLocation-enum). Hence the external extensions would be looked up in the following directories (in this order): + +* ~/.local/share/albert/org.albert.extension.externalextensions/extensions +* /usr/local/share/albert/org.albert.extension.externalextensions/extensions +* /usr/share/albert/org.albert.extension.externalextensions/extensions + +Ids are guaranteed to be unique. This means that if several of those path contain a plugins with identical ids, only the first found plugin will be used. diff --git a/doc/src/_docs/extensions/external.v2.md b/doc/src/_docs/extensions/external.v2.md new file mode 100644 index 0000000..a610504 --- /dev/null +++ b/doc/src/_docs/extensions/external.v2.md @@ -0,0 +1,75 @@ +--- +layout: docs +title: External extensions communication protocol (v2) +permalink: /docs/extensions/external/v2/ +--- + +#### `METADATA` +The application wants to get the metadata of the extension. It should have the +following keys: + +* `iid` (string, mandatory) +* `version` (string, defaults to 'N/A') +* `name` (string, defaults to $id) +* `trigger` (string, defaults to 'empty') +* `author` (string, defaults to 'N/A') +* `dependencies` (array of strings, defaults to 'empty') + +The interface id `iid` (currently `org.albert.extension.external/v2.0` tells the application the type and version of the communication protocol . If the `iid` is incompatible this plugin will not show up in the plugins list. The remaining keys should be self-explanatory. Errors in this step are fatal: loading will not be continued. + +#### `INITIALIZE` +The request to initialize the plugin. The plugin should load potential state from persistant storage, check if all requirements are met and set the exit code accordingly. (Everything but zero is an error). Errors in this step are fatal: loading will not be continued. + +#### `FINALIZE` +The request to finalize the plugin. The plugin should save the state to persistent storage. + +#### `SETUPSESSION` +The request to setup for a session, meaning prepare for user queries. This message is sent when the users starts a session, i.e. the main window opens. + +#### `TEARDOWNSESSION` +The request to teardown a session. This message is sent when the users ends a session, i.e. the main window closes. + +#### `QUERY` +The request to handle a query. The environment variable `ALBERT_QUERY` contains the _complete_ query as the user entered it into the input box, i.e. including potential triggers. + +**Note:** The process handling `QUERY` can be terminated at any time. Do _not_ change state in this code segment. + +Return the results by an array "items" containing JSON objects representing the results. A result object has to contain the following entries: `id`, `name`, `description`, `icon` and `actions`. + + - `id` is the plugin wide unique id of the result + - `name` is the name of the result + - `description` is the description of the result + - `completion` is the completions string of the result + - `icon` is the icon of the result (name or path) + - `actions` is a array of objects representing the actions for the item. + +The `id` of the item will be used to sort the items by usage. The `name`, `icon` and `description` will be displayed together as an item in the results list. `completion` is the string that will be used to replace the text in the input box when the user pressed Tab. If `icon` is an absolute path, the given file will be used. If the `icon` is not an absolute path, the algorithm described in the [Icon Theme Specification](https://freedesktop.org/wiki/Specifications/icon-theme-spec/) will be used to locate the icon. An object representing an action has to contain the following values: `name`, `command` and `arguments`. + +- `name` is the actions name +- `command` is the program to be execute +- `arguments` is an array of parameters for `command` + +An example: +```json +{ + "items": [{ + "id":"extension.wide.unique.id", + "name":"An Item", + "description":"Nice description.", + "icon":"/path/to/icon", + "actions":[{ + "name":"Action name 1", + "command":"program", + "arguments":["-a", "-b"] + },{ + "name":"Action name 2", + "command":"program2", + "arguments":["-C", "-D"] + }] + }], + "variables": { + "some_var":"variable", + "some_other_var":"cool state" + } +} +``` diff --git a/doc/src/_docs/extensions/external.v3.md b/doc/src/_docs/extensions/external.v3.md new file mode 100644 index 0000000..54d095c --- /dev/null +++ b/doc/src/_docs/extensions/external.v3.md @@ -0,0 +1,69 @@ +--- +layout: docs +title: External extensions communication protocol (v3) +permalink: /docs/extensions/external/v3/ +--- + +#### `METADATA` +The application wants to get the metadata of the extension. It should have the +following keys: + +* `iid` (string, mandatory) +* `version` (string, defaults to 'N/A') +* `name` (string, defaults to $id) +* `trigger` (string, defaults to 'empty') +* `author` (string, defaults to 'N/A') +* `dependencies` (array of strings, defaults to 'empty') + +The interface id `iid` (currently `org.albert.extension.external/v3.0` tells the application the type and version of the communication protocol . If the `iid` is incompatible this plugin will not show up in the plugins list. The remaining keys should be self-explanatory. Errors in this step are fatal: loading will not be continued. + +#### `INITIALIZE` +The request to initialize the plugin. The plugin should load potential state from persistant storage, check if all requirements are met and set the exit code accordingly. (Everything but zero is an error). Errors in this step are fatal: loading will not be continued. + +#### `FINALIZE` +The request to finalize the plugin. The plugin should save the state to persistent storage. + +#### `QUERY` +The request to handle a query. The environment variable `ALBERT_QUERY` contains the _complete_ query as the user entered it into the input box, i.e. including potential triggers. + +**Note:** The process handling `QUERY` can be terminated at any time. Do _not_ change state in this code segment. + +Return the results by an array "items" containing JSON objects representing the results. A result object has to contain the following entries: `id`, `name`, `description`, `icon` and `actions`. + + - `id` is the plugin wide unique id of the result + - `name` is the name of the result + - `description` is the description of the result + - `completion` is the completions string of the result + - `icon` is the icon of the result (name or path) + - `actions` is a array of objects representing the actions for the item. + +The `id` of the item will be used to sort the items by usage. The `name`, `icon` and `description` will be displayed together as an item in the results list. `completion` is the string that will be used to replace the text in the input box when the user pressed Tab. If `icon` is an absolute path, the given file will be used. If the `icon` is not an absolute path, the algorithm described in the [Icon Theme Specification](https://freedesktop.org/wiki/Specifications/icon-theme-spec/) will be used to locate the icon. An object representing an action has to contain the following values: `name`, `command` and `arguments`. + +- `name` is the actions name +- `command` is the program to be execute +- `arguments` is an array of parameters for `command` + +An example: +```json +{ + "items": [{ + "id":"extension.wide.unique.id", + "name":"An Item", + "description":"Nice description.", + "icon":"/path/to/icon", + "actions":[{ + "name":"Action name 1", + "command":"program", + "arguments":["-a", "-b"] + },{ + "name":"Action name 2", + "command":"program2", + "arguments":["-C", "-D"] + }] + }], + "variables": { + "some_var":"variable", + "some_other_var":"cool state" + } +} +``` diff --git a/doc/src/_docs/extensions/files.md b/doc/src/_docs/extensions/files.md new file mode 100644 index 0000000..d23662d --- /dev/null +++ b/doc/src/_docs/extensions/files.md @@ -0,0 +1,70 @@ +--- +layout: docs +title: Files extension +permalink: /docs/extensions/files/ +--- + +The files extension offers ways to access files through Albert. + +One way to access files is to use the offline index. The extension indexes files that can be accessed by their filename. In the settings you can set paths the extension recursively scans for files. + +Further the files extension provides a way to browse through the file system using paths. This is handy to access files that are _not_ indexed. Queries beginning with either `/` or `~` are interpreted as a path. In combination with the tab completion this is a nice way to browse the file system. + +The offline index can be configured in several ways. It is recommended that you configure the extension depending on your needs. Simply indexing all files on your system may be convenient, but on one hand the vast amounts of files you'll never use will clutter the output and on the other hand a large file index may introduce performance penalties, like long indexing and lookup times and high memory usage. + +Generally you have to define where the extension should look for files. But you may not want to index all of the files in the directory tree below the paths you specified. You have now two options to exclude files from indexing: File filters and MIME type filters. + +## File filters / Ignore files + +An ignore file is a simple text file with the name `.albertignore` which specifies which files should be ignored. Each line in an ignore file specifies a pattern which serves as an exclusive filter. Patterns read from an ignore file in the same directory as the path, or in any parent directory, with patterns in the higher level files (up to the toplevel path to be indexed) being overridden by those in lower level files down to the directory containing the file. These patterns match relative to the location of the ignore file. + +### Pattern format + +A blank line matches no files, so it can serve as a separator for readability. + +A line starting with `#` serves as a comment. + +The prefix `!` negates the pattern; any matching file excluded by a previous pattern will become included again. It is not possible to re-include a file if a parent directory of that file is excluded. Put a backslash (`\`) in front of the first `!` for patterns that begin with a literal `!`. + +A leading slash `/` marks a relative pattern. This pattern is anchored relative to the directory the ignore file resides in. Without the leading slash a pattern is an absolute pattern and is inherited to sub directories. For example the pattern `/bar` matches the file `bar` but not `foo/bar`, while the pattern `bar` does. + +An asterisk `*` in a pattern matches against all characters but the directory separator `/`. Two consecutive asterisks `**` in a pattern match against all characters. More consecutive asterisks collapse to `**`. + +#### Example + +``` +# Ignore eclipse dir +/workspace + +# Ignore git projects +/git/* + +# Include albert repos though +!/git/albert +!/git/aur-albert + +# However in the albert repo dont index source files +/git/albert/**.cpp + +# General ignores +node_modules +bower_components +``` + +## MIME filters + +You also have fine-grained control over the MIME types that should be indexed. The Advanced button in the settings opens a dialog that lets you set a list of patterns that are used to match against the MIME types of the indexed files. The check boxes besides the button are shortcuts that let you add or remove the most popular patterns. + +As against the file filters the MIME filters are inclusive, files are only indexed if their MIME type match against one of the patterns. Unlike the file filters which reside in a file the MIME filters have global scope. + +The patterns support common [wildcard matching](http://doc.qt.io/qt-5/qregexp.html#wildcard-matching). + +#### Example + +``` +application/* +inode/directory +audio/* +video/* +text/x-python +``` diff --git a/doc/src/_docs/extensions/mpris.md b/doc/src/_docs/extensions/mpris.md new file mode 100644 index 0000000..455688d --- /dev/null +++ b/doc/src/_docs/extensions/mpris.md @@ -0,0 +1,24 @@ +--- +layout: docs +title: MPRIS extension +permalink: /docs/extensions/mpris/ +--- + +**Note**: This extension depends on the [Qt D-Bus](http://doc.qt.io/qt-5/qtdbus-index.html) module. + +This extension is for linux only. It lets you control running MPRIS-capable media players like Rhythmbox or VLC. +MPRIS (Media Player Remote Interfacing Specification) is a protocol that enables media players to be controlled via DBus. +Currently this extension supports the following commands: +- Play +- Pause +- Next +- Previous +- Stop + +Just enter the action you want to perform (like "play" to start playback) and there will be an entry for every player that is running and the action is applicable. +I.e. when you have only one player running and it's already playing, the Play-entry will not occure. +Or; when you have two players running and one is playing, "next" will yield two entries. One for each player. + +If the media player supports the Raise method it can also be brought to front with albert. +This may or may not work as well depending on the implementation of the Raise method within the media player. +**But** there is no seperate entry to raise the player, this is an alternative action attached to all MPRIS-entries. diff --git a/doc/src/_docs/extensions/python.md b/doc/src/_docs/extensions/python.md new file mode 100644 index 0000000..0bd2729 --- /dev/null +++ b/doc/src/_docs/extensions/python.md @@ -0,0 +1,185 @@ +--- +layout: docs +title: Python extension +permalink: /docs/extensions/python/ +--- + +The Python extension makes the application extendable by embedding Python modules. Since the name of the native extension providing this functionality is "Python extension" and a Python module in this context is called "Python extension" too, this article refers to the Python extensions by using the term *Python modules*. + +A Python module must have a specific interface to be applicable as extension. The interface uses classes which are defined in the builtin `albertv0` module. Check the relevant sections below. + +The extension interface and the built-in albert module are _not_ final. They are prototypes and intended to be improved on user feedback. + +The extension interface is a versioned protocol that describes how the Python extension interacts with the Python modules. The current interface identifier is **PythonInterface/v0.2**. + + +## Extension interface (0.2) + +Additions to PythonInterface/0.1: + +##### `cacheLocation()` + +Returns the writable cache location of the app. (E.g. $HOME/.cache/albert/ on Linux) + +##### `configLocation()` + +Returns the writable config location of the app. (E.g. $HOME/.config/albert/ on Linux) + +##### `dataLocation()` + +Returns the writable data location of the app. (E.g. $HOME/.local/share/albert/ on Linux) + +## Extension interface (0.1) + +##### `handleQuery(Query)` +Mandatory function. This is the crucial part of a Python module. When the user types a query, this function is called with a query object representing the current query execution. + +This function should return a list of Item objects. See the Item class section below. + +##### `initialize()` +Optional function. This function is called when the extension is loaded. + +##### `finalize()` +Optional function. This function is called when the extension is unloaded. + +##### The docstring of the module (`__doc__`) +The docstring of the module is used as description of the extension. This string will be displayed to the user. + +##### `__iid__` +Mandatory variable (string). This variable has to hold the interface version the extension implements. + +##### `__prettyname__` +Optional variable (string). This variable should hold the pretty name of the extension. This string will be displayed to the user. + +##### `__version__` +Optional variable (string). This variable should hold the version of the extension. This string will be displayed to the user. The versioning scheme should follow the [semantic versioning](http://semver.org). + +##### `__trigger__` +Optional variable (string). If this extension should be run exclusively, this variable has to hold the trigger that causes the extension to be executed. + +##### `__author__` +Optional variable (string). This variable should hold the name of the author of the extension. + +##### `__dependencies__` +Optional variable (list of strings). This string should contain any dependencies the extension needs to be used. + + +## Api reference - The `albertv0` module + +The built-in albert module exposes several functions and classes for use with Albert. + +### The `Query` class + +The query class represents a query execution. It holds the necessary information to handle a Query. It is passed to the handleQuery function. It holds the following read-only properties. + +##### `string` +This is the actual query string without the trigger. If the query is not triggered this string equals rawstring. + +##### `rawString` +This is the full query string including the trigger. If the query is not triggered this string equals string. + +##### `trigger` +This is the trigger that has been used to start this extension. + +##### `isTriggered` +Indicates that this query has been triggered. + +##### `isValid` +This flag indicates if the query is valid. A query is valid as long as the core cancels it. You should regularly check this flag and abort the query handling if the flag is False to release threads in the threadpool for the next query. + +### Abstract classes + +##### The `ActionBase` class + +The base class for actions. This is a wrapper for the internal Action interface. You should not need it. If you think you do I‘d be interested why. Please contact me. + +##### The `ItemBase` class + +The base class for items. This is a wrapper for the internal Item interface. You should not need this unless you need the Urgency enum. + +###### The `Urgency` enum +The urgency of an item. Note that this enum is defined in the scope of the ItemBase class. + +### Standard action classes + +Standard actions are realizations of the Action interface from the core. They implement often used actions for Albert items. + +##### The `ClipAction` class +This class copies the given text to the clipboard on activation. + +##### `UrlAction` +This class opens the given URL with the systems default URL handler for the scheme of the URL on activation. + +##### `ProcAction` +This class executes the given commandline as a detached process on activation. Optionally the working directory of the process can be set. + +##### `TermAction` +This class executes the given commandline in the terminal set in the preferences. Optionally the working directory of the process can be set. + +##### The `FuncAction` class +This class is a general purpose action. On activation the callable is executed. + +### The `Item` class + +This class represents a result item. Objects of this class are intended to be returned by the handleQuery function. + +##### `Item(id="", icon=":python_module", text="", subtext="", completion="", urgency=Urgency::Normal, actions=[])` +This is the constructor of the item. + +Note that the default icon path is ":python_module" which is an embedded resource icon depicting a Python script and the urgency defaults to normal. + +##### `id` +The identifier string of the item. It is used for ranking algorithms and should not be empty. + +##### `icon` +The path of the icon displayed in the item. + +##### `text` +The primary text of the item. + +##### `subtext` +The secondary text of the item. This text should have informative character. + +##### `completion` +The completion string of the item. This string will be used to replace the input line when the user hits the Tab key on an item. + +Note that the semantics may vary depending in the context. Often evaluate semantics are more appropriate. + +##### `urgency` +The urgency of the item. Note that the Urgency enum is defined in the ItemBase class. See the Urgency enum. + +##### `addAction(Action)` +Add an action to the item. + +### Free functions + +##### `debug(text)` +Log a debug message. Note that this is effectively a NOP in release builds. + +##### `info(text)` +Log an info message. + +##### `warning(text)` +Log a warning message. + +##### `critical(text)` +Log a critical message. + +##### `iconLookup(iconName)` +Perform xdg icon lookup and return a path. Empty if nothing found. + +## Deployment + +The extension checks its data directories for a directory called `modules`. The name of a data directory is the id of the extension. I the case of the Python extension this is `org.albert.extension.python`. The data directories reside in the data directories of the application defined by [Qt](http://doc.qt.io/qt-5/qstandardpaths.html#StandardLocation-enum). Hence the external extensions would be looked up in the following directories (in this order): + +* ~/.local/share/albert/org.albert.extension.python/modules +* /usr/local/share/albert/org.albert.extension.python/modules +* /usr/share/albert/org.albert.extension.python/modules + +Ids are guaranteed to be unique. This means that if several of those paths contain a plugins with identical ids, the first plugin found will be used. + +# Known issues + +Python exceptions thrown at the core application are not handled well and may introduce a lot of weird errors. Ensure that you catch _all_ exceptions in the Python code. + +The Python interpreter shuts down when the Python extension is unloaded. After this, enabling the extension will restart the interpreter. Some modules cannot be re-initialized safely and may cause segfaults after the interpreter has been restarted (numpy!). The issue is that Python itself cannot completely unload extension modules and there are several caveats with regard to interpreter restarting. In short, not all memory may be freed, either due to Python reference cycles or user-created global data. All the details can be found in the CPython documentation. diff --git a/doc/src/_docs/extensions/qmlboxmodel.md b/doc/src/_docs/extensions/qmlboxmodel.md new file mode 100644 index 0000000..ae7e750 --- /dev/null +++ b/doc/src/_docs/extensions/qmlboxmodel.md @@ -0,0 +1,11 @@ +--- +layout: docs +title: QML Box Model +permalink: /docs/extensions/qmlboxmodel/ +--- + +QML is a user interface markup language. It is a JSON-like declarative language for designing user interface–centric applications. Inline JavaScript code handles imperative aspects. This allows extremely flexible, flashy and animated interfaces, without coding imperative lines for hours and hours. + +QML allows to write the entire user interface in QML and Javascript. There is actually no need for another QML UI plugin anymore since the C++ code below to run QML would not change. Hence the QML plugin itself is modular, designed to have several styles adhering to a determined QML-C++ interface. You can even write one on your own! + +A style in this context means a QML Frontend written in QML. v0.13 comes with a standard style: The Box Model style. The Box Model style has properties that can be set with predefined themes. You could even make your own theme with the easy to use property editor without touching a single line of code! Check out this how-to [video](https://www.youtube.com/watch?v=aCyB3ZngbLk&feature=youtu.be). diff --git a/doc/src/_docs/extensions/ssh.md b/doc/src/_docs/extensions/ssh.md new file mode 100644 index 0000000..d2a6201 --- /dev/null +++ b/doc/src/_docs/extensions/ssh.md @@ -0,0 +1,11 @@ +--- +layout: docs +title: Secure shell extension +permalink: /docs/extensions/ssh/ +--- + +This extension scans your `/etc/ssh/config` and `~/.ssh/config` and makes your ssh hosts accessible by Albert. + +Type the trigger `ssh` and albert will list all your ssh hosts. When you type another word this word is used to filter the hosts by prefix match. There is one additional item that uses the complete second word as host. This item is intended to quick connect to undefined hosts. + +Parameters are not allowed. To use parameters you may want to use the terminal extension or just start a terminal. diff --git a/doc/src/_docs/extensions/virtualbox.md b/doc/src/_docs/extensions/virtualbox.md new file mode 100644 index 0000000..f364952 --- /dev/null +++ b/doc/src/_docs/extensions/virtualbox.md @@ -0,0 +1,15 @@ +--- +layout: docs +title: VirtualBox extension +permalink: /docs/extensions/virtualbox/ +--- + +This extension lets you control your VirtualBox VMs. It supports various states in which the VM can be: +- starting/restoring/saving/stopping : All controls are disabled +- poweroff/aborted/saved : This VM can be **started** +- running : This VM can be **paused**, saved and stopped +- paused : This VM can be **resumed**, saved and reset + +The **bold** options are the main actions that will get executed if the entry is hit. The other ones are alternative actions. + +Type in the name of the VM you want to manipulate and an entry will appear. diff --git a/doc/src/_docs/extensions/websearch.md b/doc/src/_docs/extensions/websearch.md new file mode 100644 index 0000000..a26af68 --- /dev/null +++ b/doc/src/_docs/extensions/websearch.md @@ -0,0 +1,11 @@ +--- +layout: docs +title: Websearch extension +permalink: /docs/extensions/websearch/ +--- + +This extension lets you define web search engines that you can fire up in your browser with a query string. The web search item shows up when prefixing the query with the trigger string of the search engine, e.g. `gg foobar` shows an item that launches a google search for foobar in your browser. Special about the web search entries is that they can serve as fallback items when the current query did not yield any results too. + +The settings widget allows you to add, edit and remove search engines, change the order and restore the default search engines. The order of the engines in this list defines the order of the fallback items. The check mark indicates that the item will show up in the fallback items. + +When adding a new search you have to set a name, a trigger and the URL to the search engine containing the string `%s`. The `%s` will be replaced by the query string you entered. Optionally you can set an icon for the search engine. diff --git a/doc/src/_docs/extensions/widgetboxmodel/themecreator.html b/doc/src/_docs/extensions/widgetboxmodel/themecreator.html new file mode 100644 index 0000000..fa576a2 --- /dev/null +++ b/doc/src/_docs/extensions/widgetboxmodel/themecreator.html @@ -0,0 +1,287 @@ +--- +layout: page +title: Theme Creator +permalink: /docs/extensions/widgetboxmodel/themecreator/ +--- + + +
+

Welcome to the Albert theme creator! Here you can create your own theme customizing the options below.

+
+ +
+
+ +
+ + + + + +
+ +
+
    +
  • +
    +
    + google +
    +
    +

    Google

    +

    Start Google search in your browser

    +
    +
    +
    • + +
  • +
    +
    + youtube +
    +
    +

    Youtube

    +

    Start Youtube search in your browser

    +
    +
    +
    • + +
  • +
    +
    + amazon +
    +
    +

    Amazon

    +

    Start Amazon search in your browser

    +
    +
    +
    • +
  • +
    +
    + github +
    +
    +

    Github

    +

    Start Github search in your browser

    +
    +
    +
    • +
+
+
+
    +
  • Start Google search in your browser
    • +
+
+
+ +
+
+
General
+ + +
+ +
+
Frame
+ + +
+ +
+
Input
+ + + + + +
+ +
+
Settings
+ +
+ +
+
Proposal list
+ + + + +
+ +
+
Scrollbar
+ + +
+ +
+
Action list
+ + + +
+
+ +
+ 
+/*
+ * This theme was made using Albert theme creator ({{site.url}}/docs/theming/themecreator/).
+ *
+ * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics:
+ * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html)
+ * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html)
+ */
+* {
+  border: none;
+  color : #;
+  background-color: #;
+}
+
+#frame {
+  padding: 6px;
+  border-radius: 12px;
+  background-color: #;
+  border: px solid #;
+  min-width: 640px;
+  max-width: 640px;
+}
+
+#inputLine {
+  padding: 2px;
+  border-radius: 2px;
+  font-size: px;
+  selection-color: #;
+  selection-background-color: #;
+  background-color: #;
+  color: #
+}
+
+#settingsButton {
+  color: #;
+  background-color: #;
+  padding: 4px;
+  margin: 6px 6px 0px 0px;
+  border-top-right-radius: 6px;
+  border-bottom-left-radius: 10px;
+  min-width:13px;
+  min-height:13px;
+  max-width:13px;
+  max-height:13px;
+}
+
+/********** ListViews **********/
+QListView QScrollBar:vertical  {
+  width: px;
+  background: transparent;
+}
+
+QListView QScrollBar::handle:vertical  {
+  background: #;
+  min-height: 24px;
+}
+
+QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical,
+QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical,
+QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical {
+  border: 0px;
+  width: 0px;
+  height: 0px;
+  background: transparent;
+}
+
+/********** actionList **********/
+QListView#actionList {
+  font-size: px;
+}
+
+QListView#actionList::item{
+  height: px;
+}
+
+QListView#actionList::item::selected{
+  background: qlineargradient(x1:0, x2:1, stop:0.0 #40, stop:0.5 #20, stop:1.0 #40 );
+}
+
+/********** resultsList **********/
+QListView#resultsList {
+  icon-size: px;
+  font-size: px;
+  color: #;
+}
+
+QListView#resultsList::item{
+  height: px;
+}
+
+QListView#resultsList::item::selected{
+  background: qlineargradient(x1:0, x2:1, stop:0.0 #40, stop:0.5 #20, stop:1.0 #40 );
+}
+
+ +
+ +Made by @Fuhrmann + + + diff --git a/doc/src/_docs/extensions/widgetboxmodel/themes.json b/doc/src/_docs/extensions/widgetboxmodel/themes.json new file mode 100644 index 0000000..e4f208f --- /dev/null +++ b/doc/src/_docs/extensions/widgetboxmodel/themes.json @@ -0,0 +1,24 @@ +{ + "Bright": { + "foreground_color": "#808080", + "background_color": "#FFFFFF", + "frame_border_size": "6", + "frame_border_color": "#808080", + "input_line_background_color": "#D0D0D0", + "input_line_font_size": "36", + "input_color": "#808080", + "input_selection_background_color": "#808080", + "input_selection_font_color": "#FFFFFF", + "settings_button_color": "#808080", + "item_icon_size": "44", + "item_font_size": "26", + "item_color": "#808080", + "item_height": "48", + "item_selected_color": "#808080", + "scrollbar_width": "5", + "scrollbar_color": "#808080", + "action_list_height": "28", + "action_list_font_size": "20", + "action_list_selected_color": "#808080" + } +} \ No newline at end of file diff --git a/doc/src/_docs/extensions/widgetboxmodel/widgetboxmodel.md b/doc/src/_docs/extensions/widgetboxmodel/widgetboxmodel.md new file mode 100644 index 0000000..67e8e39 --- /dev/null +++ b/doc/src/_docs/extensions/widgetboxmodel/widgetboxmodel.md @@ -0,0 +1,40 @@ +--- +layout: docs +title: Widget Box Model +permalink: /docs/extensions/widgetboxmodel/ +--- + +The main user interface can be customized using [QStyleSheets](http://doc.qt.io/qt-5/stylesheet.html). Qt Style Sheets are a powerful mechanism that allows you to customize the appearance of widgets. The concepts, terminology, and syntax of Qt Style Sheets are heavily inspired by HTML Cascading Style Sheets (CSS) but adapted to the world of widgets. + +Before handcrafting your own style sheet you might want to consider the convenient [theme creator](/docs/extensions/widgetboxmodel/themecreator/) written by Ricardo Fuhrmann. If you're not satisfied with the output, you can still customize the style sheet. + +##### Writing style sheets + +The user interface consists of five widgets: The window itself, the input line, the settings button the two list views for the items and their actions. In Qt terms a [QFrame](http://doc.qt.io/qt-5/qframe.html), a [QLineEdit](http://doc.qt.io/qt-5/qlineedit.html), a [QPushButton](http://doc.qt.io/qt-5/qpushbutton.html) and a [QListView](http://doc.qt.io/qt-5/qlistview.html). All of them support the [box model](http://doc.qt.io/qt-5/stylesheet-customizing.html). + +To differentiate the views they have an ID Selector to refer to it, for the sake of completeness all other widgets too: `frame`, `inputLine`, `settingsButton`, `resultsList` (until v0.12 `proposalList`) and `actionList`. You can identify them like this : + +``` +QListView#actionList { + font-size: 20px; +} +``` + +There is an excellent documentation on QStyleSheets: + +- [Overview](http://doc.qt.io/qt-5/stylesheet.html) + - [The Style Sheet Syntax](http://doc.qt.io/qt-5/stylesheet-syntax.html) + - [Customizing Qt Widgets Using Style Sheets](http://doc.qt.io/qt-5/stylesheet-customizing.html) + - [Qt Style Sheets Reference](http://doc.qt.io/qt-5/stylesheet-reference.html ), especially the sections + - [Customizing QFrame](http://doc.qt.io/qt-5/stylesheet-examples.html#customizing-qframe) + - [Customizing QLineEdit](http://doc.qt.io/qt-5/stylesheet-examples.html#customizing-qlineedit) + - [Customizing QListView](http://doc.qt.io/qt-5/stylesheet-examples.html#customizing-qlistview) + - [Qt Style Sheets Examples](http://doc.qt.io/qt-5/stylesheet-examples.html) + +Further check the [existing themes](https://github.com/albertlauncher/plugins/tree/master/widgetboxmodel/share/themes). + +If your done place the file in "~/.local/share/albert/org.albert.frontend.boxmodel.widgets/themes/" and restart albert. The restart is necessary because file list is read once at start. If the file is listed you can apply changes by switching to other themes and and back again. + +##### Limitations + +The item is printed using a custom QStyleItemDelegate and the regular items do not intend to display a second text. So there is no (proper) possibilty to design the subtexts font size. diff --git a/doc/src/_docs/faq.md b/doc/src/_docs/faq.md new file mode 100644 index 0000000..a4d1d77 --- /dev/null +++ b/doc/src/_docs/faq.md @@ -0,0 +1,94 @@ +--- +layout: docs +title: Troubleshooting +permalink: /docs/faq/ +--- + +##### Why are items not sorted the way I prefer? + +Simply because Albert does not know your preferences. The results of the different plugins are not sorted in a special order. Fortunately Albert remembers your usage patterns. In detail Albert sorts by urgency, score and length of title, in this order. The score is determined by the score an extension gives the item and the usage score. The score of the extension is often the ratio of the match length to title length and the usage score is your usage history with a pinch of magic. If you use albert a while you will get a comfortable order of the items. Just "train" it. + +##### How can I autostart Albert? + +At the moment there is no autostart option, since this application is meant to be desktop agnostic and there is no standard way to achieve this. The most promising approach for the future is the XDG [Desktop Application Autostart Specification](http://standards.freedesktop.org/autostart-spec/autostart-spec-latest.html) but not all desktop environments do support it. Link the desktop file into your autostart directory: `ln -s /usr/share/applications/albert.desktop ~/.config/autostart/` + +##### Which application is used to open an item? + +Unless explicitly defined by the responsible extension, Albert uses the system defaults. They are managed by your desktop environment and defined as stated in the freedesktop.org [Association between MIME types and applications](http://standards.freedesktop.org/mime-apps-spec/mime-apps-spec-1.0.html) standard. See the [Arch Linux](https://wiki.archlinux.org/index.php/Default_applications#MIME_types_and_desktop_entries) or [Debian](https://wiki.debian.org/MIME) wiki for a human readable version of the standard. One generic way to change those associations is `xdg-mime`. Check the manual for more informations. + +##### "FATAL: Stylefile not found: xxx", where is it? + +Albert searches for theme files in the directory `albert/themes` in the [QStandardPaths::AppDataLocation](http://doc.qt.io/qt-5/qstandardpaths.html#StandardLocation-enum). Most probably you did not *install* Albert (The installation process places the stylefiles, icons and libraries in the correct places) or you did it in a place where the theme directories are not in an AppDataLocation. This can happen if you use an unusual `CMAKE_INSTALL_PREFIX`. + +##### Can I let Albert ignore certain files/folders? + +Create a file called `.albertignore` in the folder that contains the file you want to ignore. Fill it with the filenames you want to ignore. One per line. The ignores supports [wildcard matching](http://doc.qt.io/qt-5/qregexp.html#wildcard-matching). Global ignores like e.g. the `.gitignore` provides are currently not supported. + +###### Error. Key-XYZ could not be registered. + +This is what Albert tells you, if the window system refused to register the key combination¹. This may have many reasons, but the most prominent is that another application already grabbed the key combo. If you really want to get exactly that combo, your best bet is to find out which application grabbed the key and disable the grab. In virtually every case this will be your desktop environment, respectively its window manager, e.g. Compiz (Unity), KWin (KDE), Mutter (Gnome), or Muffin (Cinnamon). If it is possible remove the desired key combination from the system's keyboard settings and try again to set it Albert. If the grab is hardcoded you're out of luck. Use the workaround below or use another key. + +**¹** Actually a registration of one key combination is made up of 4 grabs. Since X11 considers numlock and capslock as modifiers, the actual grabs comprise every permutation of num- and capslock modifiers plus the actual key combo. If one grab fails the registration is considered as failed. + +###### Hotkey is set but does not work + +This is one of the weirdest and most annoying issue on linux. There may be several reasons. Known so far are: + +* Wayland does not allow to grab keys at all. Magically the hotkey works on X11 windows but not on wayland windows. +* Sometimes crappy window managers (e.g. Unity) intercept the keypress event. The event is simply not delivered. + +For these use the workaround described below. + +###### General workaround for hotkey problems + +The workaround for the problems above is to let the desktop environment handle the registration of hotkeys and run the command `albert show` or `albert toggle` on activation. This implies that a process has to be run and is somewhat heavy. Try to get native hotkeys first. + +##### Why are my icons are not displayed correctly? + +Make sure you have libqt5-svg (May be slightly different on some distributions) installed. Further make sure that Qt has the correct icon theme set. This is not a problem of Albert in particular, but of all Qt applications. This is a common problem and the internet provides solutions to the tons of possible reasons. Two mainstream options: Get Qt to [inherit the GTK icon theme](https://wiki.archlinux.org/index.php/Uniform_look_for_Qt_and_GTK_applications#Using_a_GTK.2B_icon_theme_in_Qt_apps) or use qt5ct to [configure Qt](https://wiki.archlinux.org/index.php/qt#Configuration_of_Qt5_apps_under_environments_other_than_KDE_Plasma) (not recommended, qt5ct messes up other things). + +##### Why are some applications not shown? + +The [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/) defines which applications shall be shown. If the desktop entry contains the key value pair `NoDisplay=true`, the application will not be shown. Further the keys `OnlyShowIn` and `NotShowIn` define which desktop environments should (not) show the desktop entry. The values are compared to the environment variable `$XDG_CURRENT_DESKTOP`. + +##### .\* Wayland .\* ? + +Sorry, I can't help you with this. Waylands integration into the major DEs is far from mature. Wayland support needs a lot of time and hopefully these infancy problems vanish with time. I'd like to invest the little time I have to do things [essential](https://en.wikipedia.org/wiki/No_Silver_Bullet) to the development of albert. If you google a bit, you will find out that a lot of applications have problems with Wayland. However if you are willing I'd appreciate to get help with that problem. + +If you came here because the hotkey does not work under Wayland see the section on hotkeys above. + +##### HiDPI? + +Unfortunately Qt does not support [HiDPI scaling](http://doc.qt.io/qt-5/highdpi.html) until 5.6. From there on you can use the environment variable `QT_SCALE_FACTOR=2` to run albert scaled. Further you can use `QT_AUTO_SCREEN_SCALE_FACTOR=1` to enable automatic scaling, based on the pixel density of the monitor. + +Note that v0.14.9 introduces automated scaling based on the dpi the screen reports. The scale factors are multiplicative. Setting QT_SCALE_FACTOR=2 on a 2x device gives an effective devicePixelRatio of 4. v0.14.13 changes this behavior when environment variables related to scaling are set, no automatic scaling is applied. + +The automatic scaling may not fit your needs, especially on small HiDPI screens people tend to rather want small scaling. If you are not satisfied with the automatic scaling Qt applies, just set one of the environment variables, e.g. `QT_SCALE_FACTOR=1`. + +##### fatal error: \*.h: No such file or directory. + +Check if you have installed the dependencies. A good way to check the current dependencies is to check `depends`, `makedepends` and `optdepends` sections in the official Arch Linux [PKGBUILD](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=albert). If you don't want to build a specific plugin you don't have to. Configure CMake accordingly by setting build switches, e.g. `-DBUILD_VIRTUALBOX=OFF`. See the possible build switches and their default values [here](https://github.com/albertlauncher/plugins/blob/master/CMakeLists.txt). + +In general you should avoid compiling albert on your own and use package managers. + +##### Seems like I dont use the official repos + +You have to be one of every second person that got albert from **unofficial** sources somewhere in the internet. This _sucks_ because 1st **you** are at risk to run malicious code on your machine and 2nd **I** am made responsible for whatever is not working. Please use the official repositories hosted at OpenSuse Build System to be safe and up to date. If something is not working, report the problem instead of using other sources. It's really as easy as that: + +* Trust the key on your machine. +* Add the repository to your package manager. +* Install albert and update your system every now and then. + +This process is also explained a bit more elaborate in the [docs](https://albertlauncher.github.io/docs/installing/#using-package-managers). + +##### I get a black border/background, i.e. no transparency + +Either you dont have hardware graphics acceleration or you are missing a [compositor](https://en.wikipedia.org/wiki/Compositing_window_manager). These problems are not related to albert, but are a general desktop misconfiguration. Google will help you to solve it. If there are other reasons for this symptom, please let me know. + +##### Launcher appears behind maximized windows + +Some window managers prioritize maximized windows over popups. The suggested way to fix this is to find an "Always on Top" option in your window manager. If such a thing doesn't exist however you can use [`wmctrl`](http://tripie.sweb.cz/utils/wmctrl/) to manually raise it by mapping a hotkey to the following command: + +``` +albert toggle && wmctrl -a "albert — Albert" +``` diff --git a/doc/src/_docs/index.md b/doc/src/_docs/index.md new file mode 100644 index 0000000..41dd9d5 --- /dev/null +++ b/doc/src/_docs/index.md @@ -0,0 +1,8 @@ +--- +layout: docs +title: Welcome +permalink: /docs/ +redirect_from: /docs/index.html +--- + +Welcome to the Albert launcher documentation. Here you should find anything you need to know about Albert. diff --git a/doc/src/_docs/installing.md b/doc/src/_docs/installing.md new file mode 100644 index 0000000..b592f00 --- /dev/null +++ b/doc/src/_docs/installing.md @@ -0,0 +1,68 @@ +--- +layout: docs +title: Installing Albert +permalink: /docs/installing/ +--- + +There are two ways to get Albert: Using a package manager or building Albert from the sources. Using a package manager is highly recommended, since it is less error prone and the necessary dependencies are pulled automatically. + +## Using package managers + +### Arch Linux (and derivatives) - [AUR](https://aur.archlinux.org/packages/albert/) +There's a PKGBUILD for Arch Linux in the AUR. Explaing how to build and install packages from AUR goes beyond scope here. Refer to the related Arch Wiki sections. Note that this is an automated way to build the package from sources. + +### Prebuilt binary packages - [OBS](https://build.opensuse.org/package/show/home:manuelschneid3r/albert) +These packages are built and hosted using the openSUSE Build Service. Using these is the most convenient way to get albert and stay up to date. You have to add the repo to your package manager and import the keyfile which is used to verify the packages signatures. This has to be done only once. From then on you can install and update albert like any other package on you system. + +#### Importing the keyfile + +For RPM based package managers: +```bash +sudo rpm --import \ + https://build.opensuse.org/projects/home:manuelschneid3r/public_key +``` + +For DEB based package managers: +```bash +curl https://build.opensuse.org/projects/home:manuelschneid3r/public_key | sudo apt-key add - +``` + +#### Adding the repo + +Adding the repo to the package managers of basic distributions (Arch, Debian, Ubuntu, Fedora and openSuse) is straight forward. Just visit [the OBS software repo](https://software.opensuse.org/download.html?project=home:manuelschneid3r&package=albert) and follow the instructions there. If you are using derivatives of these distributions you have to find out which repository they are based on and proceed using this repo. E.g. [Linux Mint 19 is based on Ubuntu 18.04 repositories](https://en.wikipedia.org/wiki/Linux_Mint_version_history#Release_history). + +## Building from sources + +Building from sources is the least convenient, but most flexible way. The build process is trivial, but you have to manage the dependencies on your own. Before you can start building Albert you need some libraries. + +### Prerequisites + +The goal is to be always compatible with the latest Ubuntu LTS release. To build Albert from sources you will need CMake, a C++ compiler supporting at least the C++14 standard, and the Qt toolkit. + +Further the plugins may introduce optional dependencies, e.g the calculator plugin needs the [muparser](http://beltoforion.de/article.php?a=muparser) library and the QMLBoxModel frontend needs the QtDeclarative library. Check the [docker file](https://raw.githubusercontent.com/albertlauncher/albert/dev/Dockerfile.ubuntu1804) for an up to date list of dependencies. + +Problems may arise with distributions that split submodules into optional dependencies. Ubuntu is known to split the SQL driver submodules into separate packages. Additionally, Elementary OS - which builds on Ubuntu - does not install optional dependencies. Users may therefore encounter linkage errors and have to explicitly install the missing dependencies. + +Another concern is the difference between compile time and runtime dependencies. Some distributions ship libraries as single packages while others ship a normal package and a *\*-dev* package. Dev packages usually contain the header files and static libraries in addition to the shared libraries. Normal packages are stripped down to the shared libraries. On distributions that do not differentiate between these kinds of packages, basically every package is a dev package. For the compilation on e.g. Ubuntu, dev packages are needed at compile time but at runtime normal packages are sufficient. If the optional dependency of a plugin is not available at runtime it will refuse to load; the core application will run fine though. + +### Compilation + +To configure, build and install run the following commands: +```bash +git clone --recursive https://github.com/albertlauncher/albert.git +mkdir albert-build +cd albert-build +cmake ../albert -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug +make +sudo make install +``` + +Lets go through them and clarify what they do. The first command clones the Albert git repository to the local file system. Since no destination directory is specified a directory with the name of the repository is created. The next step is to create the out-of-source-build directory. A self-explanatory name is always a good one. + +After changing the working directory to the just created build directory the `cmake` command configures the build environment and creates the makefiles. The first positional parameter is the path to the source directory which contains a file called `CMakeLists.txt`. The `-D` parameter sets CMake variables. + +The CMake variable `CMAKE_BUILD_TYPE` specifies the build type to use. If you want to report bugs it makes sense to build a `Debug` build, since the build then produces debugging information with which GDB can work. Core dumps of this build can be used to track down issues. Futher the make output is more verbose. If you dont want any of those that use the build type `Release`. + +`CMAKE_INSTALL_PREFIX` defines the prefix for the installation directory. This value usually defaults to `/usr/local`. Since albert looks up libraries, plugins and stylefiles etc only `/usr`, `/usr/local` are supported. If you still want to make it work somewhere else, you have to use environment variables to manipulate XDG base dir specs and the lookup paths of the dynamic linker. Do absolutely not do this unless you exactly know what you are doing. + +Finally `make` builds the application and `sudo make install` installs the application on your system. Albert is not a portable application so the install step is mandatory. diff --git a/doc/src/_docs/supporters.md b/doc/src/_docs/supporters.md new file mode 100644 index 0000000..995edd0 --- /dev/null +++ b/doc/src/_docs/supporters.md @@ -0,0 +1,52 @@ +--- +layout: docs +title: Supporters +permalink: /docs/supporters/ +--- + +I would like to express my sincere gratitude to my supporters, especially to the recurring ones and my active patrons. + +Adam Brunnmeier, +Adomas Venčkauskas, +Alexander Brem, +Alexander Browne, +Andreas Kollmann, +Andy Saini, +Brooke Dukes, +Christian Schubnell, +David Britt, +David R Jelinek, +Diego Pereyra, +Dmitry Sabani, +Emanuele Aliverti, +Georgios Tzanakis, +Harsh Poddar, +Holger Froehlich, +Jacob Lindgren, +James Turnbull, +Joel Baxter, +Johannes Wolf, +Konstantin Vankov, +Marcel Nageler, +Marcus Baw, +Mario Hros, +Mario Witte, +Mark Horsfield, +Matthew Johnson, +Max Lutterbeck, +Norbert Fuksz, +Philipp Staender, +Psymole, +Randy Syring, +Robert Orzanna, +Ronny Becker, +Simon Whyte, +Stefan Grosser, +Tamara Stefanovic, +Tony Wu, +Wei-Ting Lin, +Yan Doroshenko, +Yaozhong Yan, +Raja Senapati + +Thank you so much ❤️ diff --git a/doc/src/_docs/using.md b/doc/src/_docs/using.md new file mode 100644 index 0000000..9ba8046 --- /dev/null +++ b/doc/src/_docs/using.md @@ -0,0 +1,40 @@ +--- +layout: docs +title: Using Albert +permalink: /docs/using/ +--- + +To get up and running just run `albert` in terminal and press the hotkey (which is configured upon install) to start using it. When albert is running you can configure or quit the application via the tray icon. To make albert autostart checkout [Troubleshooting](/docs/faq). + +As you would expect from a launcher, the main use case is to type a query into an input box and finally to interact with some sort of results. Actually there is not much more Albert allows you to do - triggering things. No more, no less. + +By pressing the hotkey the launcher is shown and the focused input line awaits a query. If you press Esc or the hotkey again or if the window looses focus, the window hides. The query entered in the input box is delegated to a set of plugins, which in turn return items that are somehow related to the query. + +While typing a query Albert instantly shows the results in a vertical list below the input box. These results can be browsed like a regular list view. With the keys ⬆ and ⬇ the selection can be moved a single item, PgUp and PgDn moves the selection by the amount of visible items, Ctrl+Home and Ctrl+End moves the selection to the first and last item respectively. You have to hold Ctrl since the input line has precedence. If you found the item you are looking for, you can run its associated action by activating the item with ⏎, Enter or a mouse click. + +If a query yielded no results, several fallback items are provided. Fallback items are items that can handle every query, e.g. an item that opens an external search engine like google in your browser or your local dictionary application. + +Items can have multiple alternative actions. By holding Alt a list containing the alternative actions shows up. As long as this list is visible the arrow up and down keys move the cursor in this list. Release Alt to return to the result items - the action list disappears. + +Holding Meta can be used as a shortcut for the default fallback action. Holding Meta while activating an item runs the 1st fallback item with the entered query. + +Albert stores the input query when you activate an item. This query history entries are unique and sorted chronologically. If the inputline contains text, this text serves as search term for a substring based search on the history. Note that an empty string matches all history entries. You can navigate the history search results using Ctrl+⬆ and Ctrl+⬇. For convenience ⬆ behaves like Ctrl+⬆ when the first item in the results is selected. + +In the input box a little gear is spinning. If you left click on this gear, the settings dialog will appear. Alternatively you can simply hit Ctrl + , or Alt + , to open the settings dialog. A right click opens a context menu offering some actions including the +"Quit" action. Clicking this item will quit the application. Alternatively you +can quit the application by hitting Alt + F4. + +For reference the following table lists all keys you can use to control Albert: + +Key | Action +------------- | ------------- +Esc | Hide Albert +Alt | Hold to show alternative actions for the item +Ctrl | Hold to show item shortcuts +⏎,Enter | Activate the primary action of selected item +Meta/Win+⏎,
Meta/Win+Enter | Activate the 1st fallback item with the query +Ctrl+,
Alt+, | Show the settings dialog +⬆,⬇,
PgUp,PgDn,
Ctrl+Home,
Ctrl+End | Navigation in the results list. If the first item is selected, ⬆ behaves like Ctrl+⬆. +Ctrl+⬆
Ctrl+⬇ | Navigate the query history substring search results +Ctrl+1-9 | Shortcut for item activation +Alt+F4 | Quit Albert diff --git a/doc/src/_drafts/date-albert-version-released.md b/doc/src/_drafts/date-albert-version-released.md new file mode 100644 index 0000000..7e8b0d4 --- /dev/null +++ b/doc/src/_drafts/date-albert-version-released.md @@ -0,0 +1,6 @@ +--- +layout: page +title: "Albert __version__ released" +date: __YAML_DATE__ +--- +This is a patch release. Check the [git log](https://github.com/albertlauncher/albert/commits/__version__) for details. diff --git a/doc/src/_includes/anchor_links.html b/doc/src/_includes/anchor_links.html new file mode 100644 index 0000000..60e9cec --- /dev/null +++ b/doc/src/_includes/anchor_links.html @@ -0,0 +1,47 @@ + diff --git a/doc/src/_includes/docs_contents.html b/doc/src/_includes/docs_contents.html new file mode 100644 index 0000000..9affe70 --- /dev/null +++ b/doc/src/_includes/docs_contents.html @@ -0,0 +1,6 @@ + diff --git a/doc/src/_includes/docs_ul.html b/doc/src/_includes/docs_ul.html new file mode 100644 index 0000000..adb6600 --- /dev/null +++ b/doc/src/_includes/docs_ul.html @@ -0,0 +1,7 @@ +
    +{% for item in include.items %} + {% assign item_url = item | prepend:"/docs/" | append:"/" %} + {% assign p = site.docs | where:"url", item_url | first %} +
  • {{ p.title }}
    • +{% endfor %} +
diff --git a/doc/src/_includes/footer.html b/doc/src/_includes/footer.html new file mode 100644 index 0000000..e69de29 diff --git a/doc/src/_includes/head.html b/doc/src/_includes/head.html new file mode 100644 index 0000000..39b116c --- /dev/null +++ b/doc/src/_includes/head.html @@ -0,0 +1,8 @@ + + Albert - {{ page.title }} + + + + + + diff --git a/doc/src/_includes/header.html b/doc/src/_includes/header.html new file mode 100644 index 0000000..900f10c --- /dev/null +++ b/doc/src/_includes/header.html @@ -0,0 +1,11 @@ + diff --git a/doc/src/_includes/news_item.html b/doc/src/_includes/news_item.html new file mode 100644 index 0000000..d92457c --- /dev/null +++ b/doc/src/_includes/news_item.html @@ -0,0 +1,14 @@ +
+

+ {{ post.title }}
+ {{ post.date | date_to_string }} +

+

+ {% capture truncated_content %}{{ post.content | truncatewords: 50, '' }}{% endcapture %} + {% if post.content != truncated_content %} + {{ truncated_content }}… Read full post. + {% else %} + {{ post.content}} + {% endif %} +

+
diff --git a/doc/src/_includes/primary-nav-items.html b/doc/src/_includes/primary-nav-items.html new file mode 100644 index 0000000..6482f06 --- /dev/null +++ b/doc/src/_includes/primary-nav-items.html @@ -0,0 +1,17 @@ + diff --git a/doc/src/_layouts/default.html b/doc/src/_layouts/default.html new file mode 100644 index 0000000..200d81a --- /dev/null +++ b/doc/src/_layouts/default.html @@ -0,0 +1,12 @@ + + +{% include head.html %} + +
+ {% include header.html %} + {{ content }} + {% include footer.html %} + {% include anchor_links.html %} +
+ + diff --git a/doc/src/_layouts/docs.html b/doc/src/_layouts/docs.html new file mode 100644 index 0000000..9f1b57c --- /dev/null +++ b/doc/src/_layouts/docs.html @@ -0,0 +1,21 @@ +--- +layout: default +--- + +
+
+
+
+ {% include docs_contents.html %} +
+
+
+ Improve this page +
+

{{ page.title }}

+ {{ content }} +
+
+
+ +
diff --git a/doc/src/_layouts/page.html b/doc/src/_layouts/page.html new file mode 100644 index 0000000..3335e6b --- /dev/null +++ b/doc/src/_layouts/page.html @@ -0,0 +1,9 @@ +--- +layout: default +--- +
+
+

{{ page.title }}

+ {{ content }} +
+
diff --git a/doc/src/_posts/2017-01-09-albert-now-has-a-website.md b/doc/src/_posts/2017-01-09-albert-now-has-a-website.md new file mode 100644 index 0000000..34e4914 --- /dev/null +++ b/doc/src/_posts/2017-01-09-albert-now-has-a-website.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert finally has a website" +date: 2017-01-09 18:17 +0100 +--- + +Until recently the information relevant to the user was cluttered over several places. For a motivation there was a small landing page on github-pages, the github repository had a README.md, which basically served the same purpose, to get help the user had to go to the wiki and for news… well there was nothing. Finally there is now a place where everything gets merged to a single website: The project website *[albertlauncher.github.io](http://albertlauncher.github.io).* + +Using [Jekyll](https://jekyllrb.com/) and a handcrafted theme based on the [Milligram CSS framework](https://milligram.io/) the static website offers a nice reading experience and is still somewhat maintainable for a lazy c++ guy. The docs are dynamically generated from markdown sources and allow Github users to send pull request for modifications, e.g. typos. News post are dynamically generated too and even build a RSS news feed to allow interested users to subscribe and be up to date. diff --git a/doc/src/_posts/2017-01-11-repository-moved-to-organization.md b/doc/src/_posts/2017-01-11-repository-moved-to-organization.md new file mode 100644 index 0000000..e64d7f1 --- /dev/null +++ b/doc/src/_posts/2017-01-11-repository-moved-to-organization.md @@ -0,0 +1,11 @@ +--- +layout: page +title: "Repository moved to organization page" +date: 2017-01-11 20:09 +0100 +--- + +Finally albert moved from my [user page](https://github.com/manuelschneid3r) to the [albert organization page](https://github.com/albertlauncher). The repository url is now [https://github.com/albertlauncher/albert.git](https://github.com/albertlauncher/albert.git). This has some implications for developers who cloned the repository: The git remote urls are now invalid. Fix them by using the git commandline (or your git tool of choice): + +```bash +git remote set-url https://github.com/albertlauncher/albert +``` diff --git a/doc/src/_posts/2017-01-17-albert-v0.9.0-released.md b/doc/src/_posts/2017-01-17-albert-v0.9.0-released.md new file mode 100644 index 0000000..b36bee7 --- /dev/null +++ b/doc/src/_posts/2017-01-17-albert-v0.9.0-released.md @@ -0,0 +1,55 @@ +--- +layout: page +title: "Albert 0.9 released" +date: 2017-01-17 14:49 +0100 +--- +Almost four months have passed since the last alpha release. Dozens of hours of contemplation about a sophisticated design, dozens of hours of implementation and even a broken arm later I am happy to announce the release of Albert v0.9. + +This release comes with a new architecture that allows extensions to register extensions themselves. Based on this changes a new extension *"External extensions"* has been implemented, which can be used to let Albert run external programs and scripts as extensions. Here's an example of an external bash extension that lets you run the scan popup of goldendict as external search engine: + +``` +#!/bin/bash +case $ALBERT_OP in + "METADATA") + STDOUT='{ + "iid":"org.albert.extension.external/v2.0", + "name":"Goldendict", + "version":"1.0", + "author":"Manuel Schneider", + "dependencies":["goldendict"], + "trigger":"gd " + }' + echo -n "${STDOUT}" + exit 0 + ;; + "QUERY") + QUERYSTRING="${ALBERT_QUERY:3}" + echo -n '{ + "items":[{ + "id":"goldendict", + "name":"Use goldendict to lookup '"'${QUERYSTRING}'"'", + "description":"Opens the scan popup and searches for '"'${QUERYSTRING}'"'.", + "icon":"goldendict", + "actions":[{ + "name":"goldendict", + "command":"goldendict", + "arguments":["'${QUERYSTRING}'"] + }] + }] + }' + exit 0 + ;; +esac + +``` +Just a few words on this to get you started. The core application runs the extension with several environment variables set. The vars used in this script are `$ALBERT_OP` and `$ALBERT_QUERY`. `$ALBERT_OP` tells the extension what to do. When the user enters a query the extension is started with `$ALBERT_OP` set to `QUERY` and `$ALBERT_QUERY` set to the string that the user entered. + +The bash script in the listing above extracts the query string by cutting the trigger prefix and runs goldendict with this query string, which opens the goldendict scan popup with the query string. Now this was quick! For the details check the relevant section in the documentation. + +Further, finally a Firefox bookmark extension made it into the extension inventory. Just as the chrome bookmarks extension the extension basically indexes the bookmarks and makes them accessible via Albert. In the settings you can choose the user profile you want to track and set if the bookmarks should open in the default browser or in Firefox. + +The virtual box extension got some major improvements as well. You can now control the state of the virtual machine, i.e. if it is turned off you can run it (as before), if it runs you can pause, stop or save it, if it is paused... I think you got it. + +Transparent to the user, things changed a lot under the hood to make albert even better and of course several bug fixes made it into v0.9.0 as well. If you want to see the complete changes check the [git log](https://github.com/albertlauncher/albert/commits/v0.9.0). + +Have fun with it! diff --git a/doc/src/_posts/2017-01-23-albert-v0.9.1-released.md b/doc/src/_posts/2017-01-23-albert-v0.9.1-released.md new file mode 100644 index 0000000..917492d --- /dev/null +++ b/doc/src/_posts/2017-01-23-albert-v0.9.1-released.md @@ -0,0 +1,13 @@ +--- +layout: page +title: "Albert 0.9.1 released" +date: 2017-01-23 1:00 +0100 +--- +This release was intended to contain only fixes. +However there are some minor nifty changes recognizable by the user. +- Although not planned to be made official you can scan your files by typing albert scan files. Note that this feature may disappear someday. +- You can choose the terminal command in the settings dialog. The list shows all installed terminals. If you like you can provide a custom command. +- The app icon now uses a theme icon. +- Items of the files extension have now an "Open terminal here" action. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.9.1) for details. diff --git a/doc/src/_posts/2017-01-30-albert-v0.9.2-released.md b/doc/src/_posts/2017-01-30-albert-v0.9.2-released.md new file mode 100644 index 0000000..f19bdc9 --- /dev/null +++ b/doc/src/_posts/2017-01-30-albert-v0.9.2-released.md @@ -0,0 +1,6 @@ +--- +layout: page +title: "Albert 0.9.2 released" +date: 2017-01-30 01:00 +0100 +--- +This release contains just a few but critical fixes. Check the [git log](https://github.com/albertlauncher/albert/commits/v0.9.2) for details. diff --git a/doc/src/_posts/2017-02-05-albert-v0.9.3-released.md b/doc/src/_posts/2017-02-05-albert-v0.9.3-released.md new file mode 100644 index 0000000..60e1413 --- /dev/null +++ b/doc/src/_posts/2017-02-05-albert-v0.9.3-released.md @@ -0,0 +1,6 @@ +--- +layout: page +title: "Albert 0.9.3 released" +date: 2017-02-05 16:39 +0100 +--- +This is a pure bugfix release. Check the [git log](https://github.com/albertlauncher/albert/commits/v0.9.3) for details. diff --git a/doc/src/_posts/2017-03-01-albert-v0.9.4-released.md b/doc/src/_posts/2017-03-01-albert-v0.9.4-released.md new file mode 100644 index 0000000..a8cd960 --- /dev/null +++ b/doc/src/_posts/2017-03-01-albert-v0.9.4-released.md @@ -0,0 +1,6 @@ +--- +layout: page +title: "Albert 0.9.4 released" +date: 2017-03-01 11:36 +0100 +--- +This is a pure bugfix release. Check the [git log](https://github.com/albertlauncher/albert/commits/v0.9.4) for details. diff --git a/doc/src/_posts/2017-03-13-albert-v0.9.5-released.md b/doc/src/_posts/2017-03-13-albert-v0.9.5-released.md new file mode 100644 index 0000000..a110268 --- /dev/null +++ b/doc/src/_posts/2017-03-13-albert-v0.9.5-released.md @@ -0,0 +1,6 @@ +--- +layout: page +title: "Albert 0.9.5 released" +date: 2017-03-13 14:00 +0100 +--- +This is a pure bugfix release. Check the [git log](https://github.com/albertlauncher/albert/commits/v0.9.5) for details. diff --git a/doc/src/_posts/2017-03-19-albert-v0.10.0-released.md b/doc/src/_posts/2017-03-19-albert-v0.10.0-released.md new file mode 100644 index 0000000..3a2b460 --- /dev/null +++ b/doc/src/_posts/2017-03-19-albert-v0.10.0-released.md @@ -0,0 +1,25 @@ +--- +layout: page +title: "Albert 0.10 released" +date: 2017-03-19 23:45 +0100 +--- + +Albert v0.10 introduces tab completion using the Tab key. This allows extensions to suggest a completion text for the input box. An example: You type 2+2 into the box. When you select the calculator item and press complete the equation in the input box resolves to the result 4. The alternative actions have moved to the Alt key, which has to be hold to show the alternative actions. The default fallback is now on Meta. + +Hovering over the input box the mouse wheel can now be used to browse the history, exactly the way you are used to it with Ctrl+. + +Further there is a new group of themes, the Spotlight themes, which come in three flavors: Bright, Dark and Space (Gray with Blue accent). + +
v0.10
+ +Albert v0.10 ships with two new extensions, [MPRIS](/docs/extensions/mpris/) and a rudimentary [Secure Shell](/docs/extensions/ssh/) extension. Check their documentation for more details. + +The terminal extension now provides the shell aliases too. + +Further the files extension provides now a way to browse through paths that are _not_ indexed. Queries that begin with either `/` or `~/` are interpreted as a beginning of a path and the extension lists the files in this directory. In combination with the tab completions this is a nice way to browse the file system. + +The application extension allows now to ignore the `OnlyShowIn` and `NotShowIn` keys in the desktop entries. + +For developers: The bash script to clone the template extension is now deprecated and replaced by a Python script. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.10.0) for details. diff --git a/doc/src/_posts/2017-03-20-albert-v0.10.1-released.md b/doc/src/_posts/2017-03-20-albert-v0.10.1-released.md new file mode 100644 index 0000000..47299e4 --- /dev/null +++ b/doc/src/_posts/2017-03-20-albert-v0.10.1-released.md @@ -0,0 +1,7 @@ +--- +layout: page +title: "Albert 0.10.1 released" +date: 2017-03-20 16:30 +0100 +--- + +This release contains the latest hotfixes. Check the [git log](https://github.com/albertlauncher/albert/commits/v0.10.1) for details. diff --git a/doc/src/_posts/2017-03-20-albert-v0.10.2-released.md b/doc/src/_posts/2017-03-20-albert-v0.10.2-released.md new file mode 100644 index 0000000..03bbe92 --- /dev/null +++ b/doc/src/_posts/2017-03-20-albert-v0.10.2-released.md @@ -0,0 +1,7 @@ +--- +layout: page +title: "Albert 0.10.2 released" +date: 2017-03-24 12:00 +0100 +--- + +This release contains the latest fixes. Check the [git log](https://github.com/albertlauncher/albert/commits/v0.10.2) for details. diff --git a/doc/src/_posts/2017-04-02-albert-v0.10.3-released.md b/doc/src/_posts/2017-04-02-albert-v0.10.3-released.md new file mode 100644 index 0000000..a38fca4 --- /dev/null +++ b/doc/src/_posts/2017-04-02-albert-v0.10.3-released.md @@ -0,0 +1,11 @@ +--- +layout: page +title: "Albert 0.10.3 released" +date: 2017-04-02 19:00 +0100 +--- + +This release contains the latest fixes. + +Due to problems with the indexing (\#419) the terminal extension changed. The extension does no more show suggestions, but a single item to run your command instead. Further the default action is now "Run in terminal". However the "Run in shell" action is still available in the alternative actions. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.10.3) for details. diff --git a/doc/src/_posts/2017-04-14-albert-v0.10.4-released.md b/doc/src/_posts/2017-04-14-albert-v0.10.4-released.md new file mode 100644 index 0000000..6e592bf --- /dev/null +++ b/doc/src/_posts/2017-04-14-albert-v0.10.4-released.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert 0.10.4 released" +date: 2017-04-14 12:00 +0200 +--- + +This release contains the latest fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.10.4) for details. diff --git a/doc/src/_posts/2017-04-15-albert-v0.11.0-released.md b/doc/src/_posts/2017-04-15-albert-v0.11.0-released.md new file mode 100644 index 0000000..1b6d487 --- /dev/null +++ b/doc/src/_posts/2017-04-15-albert-v0.11.0-released.md @@ -0,0 +1,23 @@ +--- +layout: page +title: "Albert 0.11.0 released" +date: 2017-04-16 01:00 +0200 +--- + +Albert v0.11.0 is all about the files extension. The new release finally allows a fine-grained control of the MIME types to be indexed by the files extension. In the settings of the files extension the _Advanced_ button in the _Indexed MIME types_ group box opens a dialog which allows the user to set wildcard patterns that are used to match against the MIME types of the indexed files. Hopefully this is a partial solution for [#1](https://github.com/albertlauncher/albert/issues/1) for some of you too. + +Extensions can now have multiple triggers. An example of multiple triggers is the files extension: A prefix of `/` or `~` triggers the files extension in browse mode. + +The sorting algorithm is now stable. This means that items that are equal regarding their sorting order are now displayed in the order they were added to the results. + +Based on this the browse mode now lists the results in lexicographical order with directories before the files. + +Additionally the use of fallbacks have been disabled for triggered queries. The rationale behind this decision is that the user implicitly tells that he want something special, not a general fallback. + +All of the changes above make the files browse mode extremely convenient and clutter free. + +Further the websearch extension now contains an URL handler. Valid URLs are recognized as such if it contains a top- and second level domain, e.g. `google.com`. The top level domain has to be one of the ones registered by the [Internet Assigned Numbers Authority](http://www.iana.org/). + +Last but not least the qss property `selection-color` works as expected now. + +As always check the [git log](https://github.com/albertlauncher/albert/commits/v0.11.0) for details. diff --git a/doc/src/_posts/2017-04-16-albert-v0.11.1-released.md b/doc/src/_posts/2017-04-16-albert-v0.11.1-released.md new file mode 100644 index 0000000..5e90e4d --- /dev/null +++ b/doc/src/_posts/2017-04-16-albert-v0.11.1-released.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert 0.11.1 released" +date: 2017-04-16 13:00 +0200 +--- + +This release contains the latest fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.11.1) for details. diff --git a/doc/src/_posts/2017-05-13-albert-v0.11.2-released.md b/doc/src/_posts/2017-05-13-albert-v0.11.2-released.md new file mode 100644 index 0000000..82353ea --- /dev/null +++ b/doc/src/_posts/2017-05-13-albert-v0.11.2-released.md @@ -0,0 +1,14 @@ +--- +layout: page +title: "Albert 0.11.2 released" +date: 2017-05-13 15:00 +0200 +--- + +This release contains the latest fixes. Further the following minor things changed: + +- The web searches can not be enabled/disabled anymore as fallbacks. There will be a more generic mechanism that is responsible for that. +- URLs starting with `http` and `https` skip the TLD validation. This way you can access e.g. host in the LAN. +- The files extension **does not** require at least three chars anymore. Make sure you set your file filters correctly. +- Home and End now work for the results list holding Ctrl. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.11.2) for details. diff --git a/doc/src/_posts/2017-05-28-albert-v0.11.3-released.md b/doc/src/_posts/2017-05-28-albert-v0.11.3-released.md new file mode 100644 index 0000000..54e0420 --- /dev/null +++ b/doc/src/_posts/2017-05-28-albert-v0.11.3-released.md @@ -0,0 +1,7 @@ +--- +layout: page +title: "Albert 0.11.3 released" +date: 2017-05-28 22:00 +0200 +--- + +This release contains the latest fixes. Check the [git log](https://github.com/albertlauncher/albert/commits/v0.11.3) for details. diff --git a/doc/src/_posts/2017-06-09-albert-v0.12.0-released.md b/doc/src/_posts/2017-06-09-albert-v0.12.0-released.md new file mode 100644 index 0000000..8f3d895 --- /dev/null +++ b/doc/src/_posts/2017-06-09-albert-v0.12.0-released.md @@ -0,0 +1,13 @@ +--- +layout: page +title: "Albert 0.12.0 released" +date: 2017-06-09 18:30 +0100 +--- + +Albert v0.12.0 finally comes with the capability of git-like ignore files. There have been ignore files in the versions before, but they only supported wildcard matching the filename. The ignores in v0.12.0 now support relative patterns by prefixing the pattern with a slash. This way users can define global excludes. Further the wildcard character `*` now behaves like in git ignore files by matching all characters but slashes. For wildcard matching including slashes use the double asterisks `**`. Further files excluded by loose patterns can be included again by prefixing the pattern by prefixing the pattern with `!`. For more details and caveats check the [docs on the files extension](/docs/extensions/files/). + +The websearch extension got some attention too: The settings UI is now much more comfortable. The list now supports drag and drop and the search engines are now edited using a dedicated dialog. + +A minor change has been made to the terminal extension: The default action now launches in a shell without terminal. + +As always check the [git log](https://github.com/albertlauncher/albert/commits/v0.12.0) for details. diff --git a/doc/src/_posts/2017-09-28-albert-v0.13.0-released.md b/doc/src/_posts/2017-09-28-albert-v0.13.0-released.md new file mode 100644 index 0000000..887c815 --- /dev/null +++ b/doc/src/_posts/2017-09-28-albert-v0.13.0-released.md @@ -0,0 +1,50 @@ +--- +layout: page +title: "Albert 0.13.0 released" +date: 2017-09-28 21:00 +0100 +--- + +Albert v0.13 sets the focus on new frontends and performance optimizations in the core. + +## Changes in the core + +The frontend is now completely modular. From now on albert supports not only theming but an +abstract way to write completely separated user interfaces. You can even write one on your own since they are plugins now! No, don't. Designing frontends is a pain, PRs for curses interface welcome though ;D. The really amazing thing is that this finally allows using QML for designig frontends. + +QML is a user interface markup language. It is a JSON-like declarative language for designing user interface–centric applications. Inline JavaScript code handles imperative aspects. This allows extremely flexible, flashy and animated interfaces, without coding imperative lines for hours and hours. + +v0.13 comes with a new ready to use QML frontend plugin. QML allows to write the entire user interface in QML and Javascript. There is actually no need for another QML UI plugin anymore since the C++ code below to run QML would not change. Hence the QML plugin itself is modular, designed to have several _styles_ adhering to a determined QML-C++ interface. You can even write one on your own! No, dont, unless you're a dev. Actually its still a pain to write polished UIs, although its pretty easy. The devil's in the details. + +A style in this context means a QML Frontend written in QML. v0.13 comes with one standard style: The _Box Model_ style. Looks pretty similar to the Widgets Box Model, but as you guessed, its flexible, animated and whatever. The Box Model style has properties that can be set with predefined themes. You could even make your own theme with the easy to use property editor without touching a single line of code! No don't… just kidding, do it! Its fun. Check out this video how-to video on [youtube](https://youtu.be/aCyB3ZngbLk). + +Under the hood albert got some performance improvements. In the core ranking scores are now precomputed and items are added using move semantics to avoid expensive reference counting. Further you can tick the option lazy sort which delays sorting the items displayed until you actually display them by scrolling down. This has some implications on the scrollbar and the Ctrl+End button. The scrollbars height and position is determined by the amount of sorted instead of the actual amount of items and the Ctrl+End button moves the highlight to the last sorted item, which will trigger fetching and sorting of new items. So you wont be able to go to the actual last item. If you use neither of them enable it. It will save you some milliseconds on queries. + +## Changes in the extensions + +The files extension now has a tree structured folder index for smart indexing an less space +requirements. QStrings are memory expensive. Inherently to the tree structure of the file system, the prefix of a path repeatedly occurs in the file paths. The tree structured index avoids this kind of duplication. Further the tree stores information about the modified times to determine if an update of the directory is necessary at all. This greatly reduces index times and resource consumption. + +Then there are several minor changes, the minimum language standard changed to C++14 and the minimum required CMake version is now 3.1.3. This comes along with the idea to always develop against the latest Ubuntu LTS. + +Further several configuration paths changed. The uniform data location are now like {configPath, dataPath, cachePath}/albert/<extensionId> for each extension and type. If something broke while updating check if the folders are in the correct place. + +The terminals tab completion for the executable is shell like, by completing the common prefix of all matches. + +New actions were introduced. There's a file action "execute file" and a app action "run as root" using `gksudo` now. + +The interface of the external extensions changed slightly. The trigger is now removed from the query string before extension get called. + +## New extensions + +**Key Value Store** lets you store key value pairs for later lookup, e.g. `"IBAN": "DE1329423908429304102"` or `"Telefon": "+49 176 32434920"`. Use the trigger `kv` to interact with the extension. Set values with `kv set `, unset values with `kv unset ` and get them either by directly calling the extension `kv ` or by regular lookup with a prefix of the key. + +**Hash Generator** does string hashing for you. Enter `hash` or the name of the hash directly, e.g. `md5`, and a string you want to hash. You will get the hashes as results. Exmaple: `md5 hashsource`. + +## Notes for devs + +As in the external extensions the query interface changed. The query now has a string and a rawString. The raw string returns the query string including the trigger. If the query is not triggered string and rawString are equivalent. + +The extensions folder is now a git submodule. Expect this to change to a even more fine grained structure in future. + + +As always check the [git log](https://github.com/albertlauncher/albert/commits/v0.13.0) for details. diff --git a/doc/src/_posts/2017-09-30-albert-v0.13.1-released.md b/doc/src/_posts/2017-09-30-albert-v0.13.1-released.md new file mode 100644 index 0000000..768c48d --- /dev/null +++ b/doc/src/_posts/2017-09-30-albert-v0.13.1-released.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert 0.13.1 released" +date: 2017-09-30 12:00 +0100 +--- + +This release contains the latest fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.13.1) for details. diff --git a/doc/src/_posts/2017-10-18-albert-v0.14.0-released.md b/doc/src/_posts/2017-10-18-albert-v0.14.0-released.md new file mode 100644 index 0000000..7b94e3c --- /dev/null +++ b/doc/src/_posts/2017-10-18-albert-v0.14.0-released.md @@ -0,0 +1,72 @@ +--- +layout: page +title: "Albert 0.14.0 released" +date: 2017-10-18 18:00 +0100 +--- + +This release contains internal API changes that make developers lifes easier and and a new extension that allows to embed python scripts. + +With this release the use of the old CGI style external extension is discouraged. External extensions will stay for now but just for personal use. As soon as the scripts in the public repo of the external extensions have been ported it will be deleted. + +With the Python extension writing an extension can be as easy as this: + +```python +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" + +def handleQuery(query): + return [Item(text="Hello")] + +``` + +This is a valid extension. However it makes not much sense, but by adding some docs, metadata and functionality a pretty minimal example, e.g. to run Zeal, can look like this: + +```python +# -*- coding: utf-8 -*- + +"""Fire up an external search in Zeal. +Just type zl """ + +from albertv0 import * +from subprocess import run +from shutil import which + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Zeal" +__version__ = "1.0" +__trigger__ = "zl " +__author__ = "Manuel Schneider" +__dependencies__ = ["zeal"] + + +if which("zeal") is None: + raise Exception("'zeal' is not in $PATH.") + + +iconPath = iconLookup('zeal') + + +def handleQuery(query): + if query.isTriggered: + return [ + Item( + id=__prettyname__, + icon=iconPath, + text=__prettyname__, + subtext="Look up %s" % __prettyname__, + completion=query.rawString, + actions=[ProcAction("Start query in %s" % __prettyname__, + ["zeal", query.string])]) + ] +``` + +This 26 lines build a full fledged extension. In fact it is the Zeal extension. + +The documentation is not written at the moment, but the API is darn easy. Take a look at the [API test extension](https://github.com/albertlauncher/python/blob/master/api_test/__init__.py). It should contain every possible thing you can use. If you want to know it exactly read the [interface definition](https://github.com/albertlauncher/plugins/blob/master/python/src/extension.cpp#L60). For real examples of extensions check the [extensions shipped with albert](https://github.com/albertlauncher/python/). + +I ask the devs of the external extensions in the public repo to port their extensions to the new scripting API and send a pull request. + +I hope you enjoy the new scripting API and I'd be happy to receive pull requests for extensions you wish to see shipped with albert. Have fun. + +As always check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.0) for details. diff --git a/doc/src/_posts/2017-10-19-albert-v0.14.1-released.md b/doc/src/_posts/2017-10-19-albert-v0.14.1-released.md new file mode 100644 index 0000000..b507b75 --- /dev/null +++ b/doc/src/_posts/2017-10-19-albert-v0.14.1-released.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert 0.14.1 released" +date: 2017-10-19 18:00 +0100 +--- + +This release contains the latest fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.1) for details. diff --git a/doc/src/_posts/2017-10-20-albert-v0.14.2-released.md b/doc/src/_posts/2017-10-20-albert-v0.14.2-released.md new file mode 100644 index 0000000..2b7a899 --- /dev/null +++ b/doc/src/_posts/2017-10-20-albert-v0.14.2-released.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert 0.14.2 released" +date: 2017-10-20 01:00 +0100 +--- + +This release contains the latest fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.2) for details. diff --git a/doc/src/_posts/2017-10-21-albert-v0.14.3-released.md b/doc/src/_posts/2017-10-21-albert-v0.14.3-released.md new file mode 100644 index 0000000..ffacd49 --- /dev/null +++ b/doc/src/_posts/2017-10-21-albert-v0.14.3-released.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert 0.14.3 released" +date: 2017-10-21 20:00 +0100 +--- + +This release contains the latest fixes and a new Google Translate Python extension. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.3) for details. diff --git a/doc/src/_posts/2017-10-25-albert-v0.14.4-released.md b/doc/src/_posts/2017-10-25-albert-v0.14.4-released.md new file mode 100644 index 0000000..60e9fa8 --- /dev/null +++ b/doc/src/_posts/2017-10-25-albert-v0.14.4-released.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert 0.14.4 released" +date: 2017-10-25 11:00 +0100 +--- + +This release contains a new base converter plugin, the latest fixes and finally uses GNUInstallDirs. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.4) for details. diff --git a/doc/src/_posts/2017-10-30-albert-v0.14.5-released.md b/doc/src/_posts/2017-10-30-albert-v0.14.5-released.md new file mode 100644 index 0000000..8616036 --- /dev/null +++ b/doc/src/_posts/2017-10-30-albert-v0.14.5-released.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert 0.14.5 released" +date: 2017-10-30 04:00 +0100 +--- + +This release contains the latest fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.5) for details. diff --git a/doc/src/_posts/2017-10-31-albert-v0.14.6-released.md b/doc/src/_posts/2017-10-31-albert-v0.14.6-released.md new file mode 100644 index 0000000..8b6c01a --- /dev/null +++ b/doc/src/_posts/2017-10-31-albert-v0.14.6-released.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert 0.14.6 released" +date: 2017-10-31 04:00 +0100 +--- + +This release contains a wikipedia python extension and the latest fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.6) for details. diff --git a/doc/src/_posts/2017-11-02-official-repos-on-obs.md b/doc/src/_posts/2017-11-02-official-repos-on-obs.md new file mode 100644 index 0000000..871b56c --- /dev/null +++ b/doc/src/_posts/2017-11-02-official-repos-on-obs.md @@ -0,0 +1,7 @@ +--- +layout: page +title: "Official repositories at openSUSE Build Service" +date: 2017-11-02 12:00 +0100 +--- + +Finally there are official repositories other than the Arch Linux User Repositories hosted on the openSUSE Build Service platform. The openSUSE Build Service is the public instance of the Open Build Service (OBS). It builds software for several distributions and architectures in an automated fashion and hosts repositories for the built packages. This means that as soon as a new albert version is released the build service gets triggered to build albert and as soon it is finished, you will be able to get the latest version of albert. Check the [albert package on openSUSE Build Service](https://build.opensuse.org/package/show/home:manuelschneid3r/albert) to see the supported platforms. diff --git a/doc/src/_posts/2017-11-03-albert-v0.14.7-released.md b/doc/src/_posts/2017-11-03-albert-v0.14.7-released.md new file mode 100644 index 0000000..f7bd7c1 --- /dev/null +++ b/doc/src/_posts/2017-11-03-albert-v0.14.7-released.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert 0.14.7 released" +date: 2017-11-03 21:00 +0100 +--- + +This release contains the latest fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.7) for details. diff --git a/doc/src/_posts/2017-11-14-albert-v0.14.8-released.md b/doc/src/_posts/2017-11-14-albert-v0.14.8-released.md new file mode 100644 index 0000000..9f9ba48 --- /dev/null +++ b/doc/src/_posts/2017-11-14-albert-v0.14.8-released.md @@ -0,0 +1,17 @@ +--- +layout: page +title: "Albert 0.14.8 released" +date: 2017-11-14 00:00 +0100 +--- + +This release contains new Python extensions: + +* Gnote extension (Ported from external extension) +* Tomboy extension (Ported from external extension) +* Pacman extension +* Pass extension +* Kill extension + +Of course it also contains the latest fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.8) for details. diff --git a/doc/src/_posts/2017-11-16-albert-v0.14.10-released.md b/doc/src/_posts/2017-11-16-albert-v0.14.10-released.md new file mode 100644 index 0000000..c18f135 --- /dev/null +++ b/doc/src/_posts/2017-11-16-albert-v0.14.10-released.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert 0.14.10 released" +date: 2017-11-16 23:00 +0100 +--- + +This release contains the latest fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.10) for details. diff --git a/doc/src/_posts/2017-11-16-albert-v0.14.9-released.md b/doc/src/_posts/2017-11-16-albert-v0.14.9-released.md new file mode 100644 index 0000000..a3ceaee --- /dev/null +++ b/doc/src/_posts/2017-11-16-albert-v0.14.9-released.md @@ -0,0 +1,14 @@ +--- +layout: page +title: "Albert 0.14.9 released" +date: 2017-11-16 00:00 +0100 +--- +This release contains minor improvements: + +* Add "Open docs" action to tray +* Generally use HiDPI pixmaps (lifts required Qt to 5.6) +* Debug output is now a cmdline option (-d) + +Of course it also contains the latest fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.9) for details. diff --git a/doc/src/_posts/2017-11-19-albert-v0.14.11-released.md b/doc/src/_posts/2017-11-19-albert-v0.14.11-released.md new file mode 100644 index 0000000..29a2a2b --- /dev/null +++ b/doc/src/_posts/2017-11-19-albert-v0.14.11-released.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert 0.14.11 released" +date: 2017-11-19 00:00 +0100 +--- + +This release contains the latest fixes and a locate python extension. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.11) for details. diff --git a/doc/src/_posts/2017-11-23-albert-v0.14.12-released.md b/doc/src/_posts/2017-11-23-albert-v0.14.12-released.md new file mode 100644 index 0000000..c89c27a --- /dev/null +++ b/doc/src/_posts/2017-11-23-albert-v0.14.12-released.md @@ -0,0 +1,9 @@ +--- +layout: page +title: "Albert 0.14.12 released" +date: 2017-11-23 20:00 +0100 +--- + +This release contains the latest fixes the CopyQ port to python. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.12) for details. diff --git a/doc/src/_posts/2017-11-25-albert-v0.14.13-released.md b/doc/src/_posts/2017-11-25-albert-v0.14.13-released.md new file mode 100644 index 0000000..b16de65 --- /dev/null +++ b/doc/src/_posts/2017-11-25-albert-v0.14.13-released.md @@ -0,0 +1,14 @@ +--- +layout: page +title: "Albert 0.14.13 released" +date: 2017-11-25 18:00 +0100 +--- +This release introduces rich text for item texts. Extensions using the offline index do not use it yet, since computing the matching substring is a bit more involved. + +The TermAction now has a new option to set the behavior when the process exited. (Close, Close on success, Don not close). + +This version ships with two new python extension: One interfacing the Arch User Repositories and another adapting scrot, a screenshot tool (credits go to Benedict Dudel). + +As always the release also contains the latest fixes and minor improvements. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.13) for details. diff --git a/doc/src/_posts/2017-12-06-albert-v0.14.14-released.md b/doc/src/_posts/2017-12-06-albert-v0.14.14-released.md new file mode 100644 index 0000000..a3aaa9c --- /dev/null +++ b/doc/src/_posts/2017-12-06-albert-v0.14.14-released.md @@ -0,0 +1,8 @@ +--- +layout: page +title: "Albert 0.14.14 released" +date: 2017-12-06 12:00 +0100 +--- +This release contains the latest fixes and a new npm Python extension (Again credits go to Benedict Dudel :+1:) + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.14) for details. diff --git a/doc/src/_posts/2018-01-26-albert-v0.14.15-released.md b/doc/src/_posts/2018-01-26-albert-v0.14.15-released.md new file mode 100644 index 0000000..65c6c77 --- /dev/null +++ b/doc/src/_posts/2018-01-26-albert-v0.14.15-released.md @@ -0,0 +1,16 @@ +--- +layout: page +title: "Albert 0.14.15 released" +date: 2018-01-26 12:00 +0100 +--- +This release contains the latest fixes and new Python extensions: + +* CoinMarketCap. Quickly view/access coins/tokens on CoinMarketCap. +* Trash extension. Adds an item that opens the trash bin in the file manager. +* Pomodoro extension. Tool to apply the focus and flow enhancing technique. +* Epoch extension. Simply shows current or translates unix timestamps. +* Packagist extension. Search for PHP packages on [Packagist](https://packagist.org/). + +Futher the python API has been extended by three functions: `configLocation()`, `dataLocation()` and `cacheLocation()`. Therefore the minor API version increased. The interface identifier is now **PythonInterface/v0.2**. Note that the Python extension guarantees backward compatibility on minor version changes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.15) for details. diff --git a/doc/src/_posts/2018-03-09-albert-v0.14.16-released.md b/doc/src/_posts/2018-03-09-albert-v0.14.16-released.md new file mode 100644 index 0000000..970ef83 --- /dev/null +++ b/doc/src/_posts/2018-03-09-albert-v0.14.16-released.md @@ -0,0 +1,20 @@ +--- +layout: page +title: "Albert 0.14.16 released" +date: 2018-03-09 18:00 +0100 +--- +This release contains the latest fixes and new Python extensions: + +* Gnome dictionary extension. (nikhilwanpal) +* Mathematica extension. (Asger Hautop Drewsen) +* TeX to unicode extension. (Asger Hautop Drewsen) +* IP address extension. (Benedict Dudel) +* Multi Translate extension. (David Britt) +* Emoji lookup extension. (David Britt) +* Kaomoji lookup extension. (David Britt) +* Timer extension. +* Binance extension. + +Kudos to the contributors. 👏 + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.16) for details. diff --git a/doc/src/_posts/2018-03-23-albert-v0.14.17-released.md b/doc/src/_posts/2018-03-23-albert-v0.14.17-released.md new file mode 100644 index 0000000..2f898ef --- /dev/null +++ b/doc/src/_posts/2018-03-23-albert-v0.14.17-released.md @@ -0,0 +1,14 @@ +--- +layout: page +title: "Albert 0.14.17 released" +date: 2018-03-23 12:00 +0100 +--- +This release contains the latest fixes, minor improvements to the extensions and a new Python extension. + +With the new Python extension _Arch Wiki_ you can search the wiki.archlinux.org mediawiki and directly access articles. + +The applications extension got two new options: _Use keywords for lookup_ and _Use generic name for lookup_. _Keywords_ and _GenericName_ are keys in the desktop entry whose values can be used for lookup. + +The _kvstore_ extension was renamed to _Snippets_ and got an improved config UI. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.17) for details. diff --git a/doc/src/_posts/2018-03-23-albert-v0.14.18-released.md b/doc/src/_posts/2018-03-23-albert-v0.14.18-released.md new file mode 100644 index 0000000..224fd64 --- /dev/null +++ b/doc/src/_posts/2018-03-23-albert-v0.14.18-released.md @@ -0,0 +1,8 @@ +--- +layout: page +title: "Albert 0.14.18 released" +date: 2018-03-23 13:00 +0100 +--- +This release contains a hotfix for a bug that made all single file python extensions disappear. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.18) for details. diff --git a/doc/src/_posts/2018-05-15-albert-v0.14.19-released.md b/doc/src/_posts/2018-05-15-albert-v0.14.19-released.md new file mode 100644 index 0000000..4e5fd7c --- /dev/null +++ b/doc/src/_posts/2018-05-15-albert-v0.14.19-released.md @@ -0,0 +1,17 @@ +--- +layout: page +title: "Albert 0.14.19 released" +date: 2018-05-15 09:00 +0000 +--- +This release contains the latest fixes and two new Python extensions: + +* Datetime. (Time display and conversion. Supersedes the external extension) +* Bitfinex. (Quickly access Bitfinex markets) + +The file browse mode finally mimics bash completion behavior. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.19) for details. + +Further I want to let you know that I will stop posting news on [patch releases](https://semver.org/). +I'll try to move changes that are recognizeable by users into minor releases. +Note that there are no major releases at the moment since albert is still alpha. diff --git a/doc/src/_posts/2018-06-04-albert-v0.14.20-released.md b/doc/src/_posts/2018-06-04-albert-v0.14.20-released.md new file mode 100644 index 0000000..bbe9cce --- /dev/null +++ b/doc/src/_posts/2018-06-04-albert-v0.14.20-released.md @@ -0,0 +1,6 @@ +--- +layout: page +title: "Albert v0.14.20 released" +date: 2018-06-04 12:00 +0200 +--- +This is a patch release. Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.20) for details. diff --git a/doc/src/_posts/2018-06-08-albert-v0.14.21-released.md b/doc/src/_posts/2018-06-08-albert-v0.14.21-released.md new file mode 100644 index 0000000..5d82922 --- /dev/null +++ b/doc/src/_posts/2018-06-08-albert-v0.14.21-released.md @@ -0,0 +1,6 @@ +--- +layout: page +title: "Albert v0.14.21 released" +date: 2018-06-08 15:28 +0200 +--- +This is a patch release. Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.21) for details. diff --git a/doc/src/_posts/2018-09-21-albert-v0.14.22-released.md b/doc/src/_posts/2018-09-21-albert-v0.14.22-released.md new file mode 100644 index 0000000..d4bd45a --- /dev/null +++ b/doc/src/_posts/2018-09-21-albert-v0.14.22-released.md @@ -0,0 +1,8 @@ +--- +layout: page +title: "Albert v0.14.22 released" +date: 2018-09-21 19:00 +0200 +--- +This is mostly a fix release. Telemetry is now opt-in. Some new themes and the Pidgin python extension were added. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.14.22) for details. diff --git a/doc/src/_posts/2018-12-16-albert-v0.15.0-released.md b/doc/src/_posts/2018-12-16-albert-v0.15.0-released.md new file mode 100644 index 0000000..83354cd --- /dev/null +++ b/doc/src/_posts/2018-12-16-albert-v0.15.0-released.md @@ -0,0 +1,18 @@ +--- +layout: page +title: "Albert v0.15.0 released" +date: 2018-12-16 18:00 +0100 +--- + +This release increases the required versions of the dependencies to Qt 5.9 this means that some distributions will not be supported anymore. + +Major changes: +* Fancy usage graph in the settings +* QML frontend: History search of the input now allows substring matching (Type and navigate) +* QML frontend: Store user input of every session +* Add extension "Fortune" +* Add extension "Window switcher" + +Further the release contains minor changes and fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.15.0) for details. diff --git a/doc/src/_posts/2018-12-28-albert-v0.16.0-released.md b/doc/src/_posts/2018-12-28-albert-v0.16.0-released.md new file mode 100644 index 0000000..f14fb59 --- /dev/null +++ b/doc/src/_posts/2018-12-28-albert-v0.16.0-released.md @@ -0,0 +1,36 @@ +--- +layout: page +title: "Albert v0.16.0 released" +date: 2018-12-28 21:52:04+01:00 +--- +## Changes + +### Albert + +* Add jekyll website as submodule +* New project structure +* Derive albert version from CMake project +* Let travis build against Ubuntu 18.04 and 16.04 +* Backward compatibility for Ubuntu 16.04 +* Build without QtCharts if Qt version below 5.6 +* Let fuzzy require an additional character. Tolerance: floor((wordlen - 1)/3)) +* Print logging category to stdout [not all plugins support it yet] + +### Plugins + +* [Python] Use ast to read metadata without loading the modules +* [Term] Change terminal action order: Let "Run w/o term" be the last one +* [VBox] Set default build switch for VirtualBox to OFF +* [Files] Add fancy icons to mime dialog + +### Modules + +* Additional constraint: Metadata have to be string literals (for ast) +* Additional constraint: Name modules according PEP8 +* [WinSwitch] Add close win action +* [VBox] Add VirtualBox extension + + +Further the release contains minor changes and fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.16.0) for details. diff --git a/doc/src/_posts/2018-12-31-albert-v0.16.1-released.md b/doc/src/_posts/2018-12-31-albert-v0.16.1-released.md new file mode 100644 index 0000000..b788dfc --- /dev/null +++ b/doc/src/_posts/2018-12-31-albert-v0.16.1-released.md @@ -0,0 +1,19 @@ +--- +layout: page +title: "Albert v0.16.1 released" +date: 2018-12-31 19:07:03+01:00 +--- +* [albert] Fix default plugin lookup path +* [albert] Fix flicker when changing frontends +* [albert] Fix "Terminal option resets after a restart" +* [albert] Link libglobalshortcut statically +* [albert] Add a build flag for QtCharts +* [albert] Drop debug options if favor of QLoggingCategory env vars +* [plugins:ssh] Fix input regex. Sort by length then lexically. +* [plugins:ssh] Use backward compatible ssh url syntax +* [plugins:qml] Consistent form layout +* [modules:aur] Sort items by length first + +Further the release contains minor changes and fixes. + +Check the [git log](https://github.com/albertlauncher/albert/commits/v0.16.1) for details. diff --git a/doc/src/_sass/_codehighlight.scss b/doc/src/_sass/_codehighlight.scss new file mode 100644 index 0000000..c2a847f --- /dev/null +++ b/doc/src/_sass/_codehighlight.scss @@ -0,0 +1,62 @@ +.highlight + .hll { background-color: #ffffcc } + .c { color: #999988; font-style: italic } /* Comment */ + .err { color: #a61717; background-color: #e3d2d2 } /* Error */ + .k { color: #000000; font-weight: bold } /* Keyword */ + .o { color: #000000; font-weight: bold } /* Operator */ + .cm { color: #999988; font-style: italic } /* Comment.Multiline */ + .cp { color: #999999; font-weight: bold; font-style: italic } /* Comment.Preproc */ + .c1 { color: #999988; font-style: italic } /* Comment.Single */ + .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */ + .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ + .ge { color: #000000; font-style: italic } /* Generic.Emph */ + .gr { color: #aa0000 } /* Generic.Error */ + .gh { color: #999999 } /* Generic.Heading */ + .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ + .go { color: #888888 } /* Generic.Output */ + .gp { color: #555555 } /* Generic.Prompt */ + .gs { font-weight: bold } /* Generic.Strong */ + .gu { color: #aaaaaa } /* Generic.Subheading */ + .gt { color: #aa0000 } /* Generic.Traceback */ + .kc { color: #000000; font-weight: bold } /* Keyword.Constant */ + .kd { color: #000000; font-weight: bold } /* Keyword.Declaration */ + .kn { color: #000000; font-weight: bold } /* Keyword.Namespace */ + .kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */ + .kr { color: #000000; font-weight: bold } /* Keyword.Reserved */ + .kt { color: #445588; font-weight: bold } /* Keyword.Type */ + .m { color: #009999 } /* Literal.Number */ + .s { color: #d01040 } /* Literal.String */ + .na { color: #008080 } /* Name.Attribute */ + .nb { color: #0086B3 } /* Name.Builtin */ + .nc { color: #445588; font-weight: bold } /* Name.Class */ + .no { color: #008080 } /* Name.Constant */ + .nd { color: #3c5d5d; font-weight: bold } /* Name.Decorator */ + .ni { color: #800080 } /* Name.Entity */ + .ne { color: #990000; font-weight: bold } /* Name.Exception */ + .nf { color: #990000; font-weight: bold } /* Name.Function */ + .nl { color: #990000; font-weight: bold } /* Name.Label */ + .nn { color: #555555 } /* Name.Namespace */ + .nt { color: #000080 } /* Name.Tag */ + .nv { color: #008080 } /* Name.Variable */ + .ow { color: #000000; font-weight: bold } /* Operator.Word */ + .w { color: #bbbbbb } /* Text.Whitespace */ + .mf { color: #009999 } /* Literal.Number.Float */ + .mh { color: #009999 } /* Literal.Number.Hex */ + .mi { color: #009999 } /* Literal.Number.Integer */ + .mo { color: #009999 } /* Literal.Number.Oct */ + .sb { color: #d01040 } /* Literal.String.Backtick */ + .sc { color: #d01040 } /* Literal.String.Char */ + .sd { color: #d01040 } /* Literal.String.Doc */ + .s2 { color: #d01040 } /* Literal.String.Double */ + .se { color: #d01040 } /* Literal.String.Escape */ + .sh { color: #d01040 } /* Literal.String.Heredoc */ + .si { color: #d01040 } /* Literal.String.Interpol */ + .sx { color: #d01040 } /* Literal.String.Other */ + .sr { color: #009926 } /* Literal.String.Regex */ + .s1 { color: #d01040 } /* Literal.String.Single */ + .ss { color: #990073 } /* Literal.String.Symbol */ + .bp { color: #999999 } /* Name.Builtin.Pseudo */ + .vc { color: #008080 } /* Name.Variable.Class */ + .vg { color: #008080 } /* Name.Variable.Global */ + .vi { color: #008080 } /* Name.Variable.Instance */ + .il { color: #009999 } /* Literal.Number.Integer.Long */ diff --git a/doc/src/_sass/_fa.scss b/doc/src/_sass/_fa.scss new file mode 100644 index 0000000..eccd47e --- /dev/null +++ b/doc/src/_sass/_fa.scss @@ -0,0 +1,24 @@ +@font-face { + font-family: 'FontAwesome'; + src: url('../fonts/FontAwesome.eot?9h6hxj'); + src: url('../fonts/FontAwesome.eot?9h6hxj#iefix') format('embedded-opentype'), + url('../fonts/FontAwesome.woff?9h6hxj') format('woff'), + url('../fonts/FontAwesome.ttf?9h6hxj') format('truetype'), + url('../fonts/FontAwesome.svg?9h6hxj#FontAwesome') format('svg'); + font-weight: normal; + font-style: normal; +} +.fa { + display: inline-block; + font: normal normal normal 14px/1 FontAwesome; + font-size: inherit; + text-rendering: auto; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} +.fa-link:before { + content: "\f0c1"; +} +.fa-pencil:before { + content: "\f040"; +} diff --git a/doc/src/_sass/_font.sass b/doc/src/_sass/_font.sass new file mode 100644 index 0000000..954a8c8 --- /dev/null +++ b/doc/src/_sass/_font.sass @@ -0,0 +1,30 @@ + +// Font +// –––––––––––––––––––––––––––––––––––––––––––––––––– */ + +// Copyright (C) 2011-2015 Hoefler & Co. +// This software is the property of Hoefler & Co. (H&Co). +// Your right to access and use this software is subject to the +// applicable License Agreement, or Terms of Service, that exists +// between you and H&Co. If no such agreement exists, you may not +// access or use this software for any purpose. +// This software may only be hosted at the locations specified in +// the applicable License Agreement or Terms of Service, and only +// for the purposes expressly set forth therein. You may not copy, +// modify, convert, create derivative works from or distribute this +// software in any way, or make it accessible to any third party, +// without first obtaining the written permission of H&Co. +// For more information, please visit us at http://typography.com. +// 171247-88474-20150623 + +@font-face + font-family: 'Gotham Rounded A' + font-style: normal + font-weight: 300 + src: url(data:application/x-font-woff;base64,d09GRk9UVE8AADBKAA0AAAAAVSgAAQAAAAAuJAAAAiYAAAaMAAAAAAAAAABDRkYgAAAJSAAAHCQAACTauQ+mFEdERUYAACVsAAAAHQAAACAAkAAER1BPUwAAJYwAAAb3AAAcArhEootHU1VCAAAshAAAAFoAAACA6cUtSE9TLzIAAAGMAAAATwAAAGBVxiUrY21hcAAABmQAAALOAAAEmNFOLlRnYXNwAAAs4AAAAAgAAAAIAAAAC2hlYWQAAAEwAAAANAAAADYDcke+aGhlYQAAAWQAAAAgAAAAJAe+A6pobXR4AAAs6AAAATkAAAGM1uIY+21heHAAAAGEAAAABgAAAAYAY1AAbmFtZQAAAdwAAASHAAALuyg1MwRwb3N0AAAJNAAAABMAAAAg/7gAMnjaY2BkYGBgZHDs97b+Gc9v85WBm/kFUIThgg6TPIz+/+K/BYswsxKQy8HABBIFADpACoV42mNgZGBgPvBfgIGBxe//i/8vWIQZgCIoIBkAl34GbwAAUAAAYwAAeNpjYGLSYdRhYGVgYdrD1MXAwNADoRnvMhgx/GJAAgsYGOoDGBi8YHwPNed8IKX8QIhZ4b8FwwnmAwwfgHxukBzjP6Y9DApAyAQAs6gPXgB42rVUTW/bRhAdWXL8kTiIfUxRYNsGRtJKsqgotpNTUQOOc6xjpMhxRa5E2iKXWC6tCMihtx6Kotce+id66Q/on+ivKdC3w1VMxYnqAq0IaR9nZ/a9NzsQET1o/E4Nqj5f41vhBn2Btwqv0BqFHjfpMzr3uFXLWaUt+tHjW9j5xeM1kvSrx+vI+cvjjRreXNlubHp8m3aan3h8p4a3ajl36ctmx+N7NQ3bNbzDuEmN1gbevm9+53GDjpt/erxCd1ufetykb1pfedyq5azS/Vbq8S1ab/3g8Rr90frZ43W6v/qtxxs1vNn6fPXC49v0YOMnj+/U8FYt5y6dbfzm8b2ahu0a3nH4SOczk4xjKx4ePRL9Xm+/7X4PxIlWo4kyYlcc6a6Irc2f7e1Np9OuneV6bGQez7qhThfrT3aPtHgrFlNO1bicSBMcBP3BQefwcHAw6PR7wZPefv9xpz/ATzDo9YOnr5QpEp2JoIvdY53Z59rGMhWnuswiFYmkEFJYIyOVSnMh9GhRY1tM4ySMRSpnYqiEUeOksMq4wkyEyliJ9bw0SREloQVR0V2oP4tBUOiRnUqjHJmNlciNzlE6u8YmXuuSqTJtRYgmtEWqo2SENQKvSYalVW2hjYj0NJtoGeG8GgFvJVlh5WQiEivKHM5lNsNZaY5SwwmxLqzbHRmd8u5Eh9JpZ34jqs5bLcpCLZ7vDBTl8FyFvO+8nCmTFs7IS2Uuk1AJOTZKpSpDRiytUG8gvEDv7FSpTMxgUGbRe7ZfjOAYJ6PRV+VVZZtL5j25rmgEQ85DXppcF6orjhFItdOaYS9lY22RT5RE7WVSwPhH525vqoYjzEhnoaEhIhKOFzXD2/UDxD/O4/Wam6uhI9KU04wMJTSmmCwJeojoI6x96uHZp/Y7fAB0ggpFI5rg1+B9F193Sherq7c47xnt4Zny00VkhpjG+QZ/jTmyZoiGiKRL+U9wttsX9BbfZaecQsuYSmiS2A2gM4DiAdYOHeJxaADsXAT0hF316TFHBh4FQD3ggJ7SK/ZWQJOmDNwBmKraY45Yeo7VQoMEuwC/BntGEeoivCeoFdhzqp1aF09Z2wViGt1b1kfX7ynOTuAuBnaVM6xDZArkOq+OwXLlnNHpDDlikV+9n0OV4dyIT7PeUQGWj/OfMbdzULBWCzWSmebOnHP3liPq7q9ind3Am6DX3KsrVxl3UvBNuklo855mxSP/Hnm/zssQ1c55m9kM72oozMCmudeVvg87uKpKuA+uVxM87t2pKHnGMr69jPVVE5Z7VlM7IcZacFVVO+JupLVapyjE27zvV/4N3+TVzFue8xLnqaX6xbt4iU6cIxLW6uf3csZKU86sbuQlRy55ChQrHPN5bi4VT7Tw8+yQoje+44WfO6dAcaaAs+oGJU/88tt+wewZq3Oaq4n+EHuds11jeX9ObtKjkb+h+T3k3PGc70uxrmOfkfKq/DxUdWntxtpc7ZxJz3vJrNWN//v/uz3u45CZnO/OkgkNfY70d7ysz9W93USB+A/+H2/C8z/05m+zvGomAHjalZNdSFRREMf/o6apaeZH6/qx3tV0q9Vs09x1bde0Tc00PzOz/KjwJSIqRBITJKLHHnqpngrDQpK+SKwkeskUNTMjKyK8PkSPUdE33encu+vmUhDNMOecmTPM/Z175gDwh9sSQFCXp4VHmh/g3y7mfnQjEOmQkIJMZMOKfLhQjHI0ohn7cBhtaEcHunARvbiCq7iOQQxhGCOYwWu8wTt8xlf8pCAKpwiKohjSkZ7iKYVMZKYMyiQLWamQXFREJVRFtVRH9dRATdRCrbSfDtBBOkRHqI06qJO66AexX6yh23DccMLwUYqW4iSDlCylSXap35gsRzILagnJSNVo7ShAEUpRIWj3oFWjPYpO9AjaPg/tXdwXtNN4ARlv8V6lBVOID61hAW0O5Xpoy3xo9/rQtmu030nx0n6QoqRYKUGjzZ2n5TmWeZZf8Ut+zjP8jJ/yND/hKX7Mj3iCx3mML3Ev9/AFPs/n+AzA1fAKF3GxNoewkZM4keNZL7wIDuNQDuYgdU/5pnxRPol5SplUJpRxZUQZFt49ZUi5owwqA8qA8G4o17TcsLm+uctzvYBcIDtlh2yXrXLq7K3ZfKnS3SH/JceEncQpnBX/+6YWuY1Rn4wHPuuHntW0T86UjzemjROY9EZG//rtGugWqHGBmjxqhmWBZol+cavNow44veoSNSxe04vseYsTbyXHawbRcUnI+8OMosa8pYmeVM0sqprF21IrqnHVBwXinz+a4OePgEWBQYuDQ0KXhIWrsaVABLAsMio6Zjl0sfo4xCcAiYYkCcbklBWpaaaVq1ab0zPWZGItLOvEadfnWG259rwNDmf+RgicQmxyYXOR6CedTjSR0WTRJCtbiE2Iw6mKBlBRsgW7gW1b96ieUR1K3WhlVYCzxr0ur24UpcRu7fadDXU7AJcZLU3NYqeyfpd2K5oYxZ2YTCbb7/P9Aoia7d8AAHjaY2BmAIP/WxmMGLAAACzCAeoAeNqdegl4FMXWdmfpmSLBYbNBifSwBQJBRECUJQKibBElwg37DhIWCWACCUlm7ememcpMT/esSVgMyCI7iuBlERVBhQtcURRRr4i7Iiog1bGG//tOT4KJz3//+z/PZebppLuqT506y3veUyGJSU1lkpKS2JGFy4r0X7K0lozWIUnjkzU+RWubOqV5yvN0+h9b6w6wJKtFsAPDdJ7emuxqxaTCS82fHP9E8crCgnmFzy8tXjiicHnpykULC4o6Zo3o0bFvnz4DeunXhzuOLlzw7NIFKzt26ziisHfHgqKi5YMeeGD16tW9i0qXFy5cOWd5QWnveYXPJVTQdWCSGCYliTEkMQUM08zIcAxzD8NksEznFKZ7EpOdwvQxMcMY5rFkZmRz5m8MM4lhpiQx05OZOUnMfIbZzjCYYRYzzGaGqWWYlQwjM0wJw5QxTCHDeBhmOMMghilmmEUMs5phVjEMLFzKMEuSkiSGqWKS3AwzLxnUeBSmPsPQpHHJqcnpydOTd6UMSlmdUpGyNmVjyiepmanzUlek2lLPpX7G9mJD7HXDVMN7xpbGx43HkAHNRgL6stnAZhVpd6eVpcXTs9IXpx9q/nDznc3JXUPvWnbX1rsu3nXLtMr09xadWjhafNZyQcttLU+1atZqbquKVt+2zmq9uvXhNu3brGjzxt0P3b2JQ1wm52n7YNs97Qa0++4e5z0X7p10r3xv5N5r7Ye1P9L+Uvu6jKQMlGHK6JCRnfFIxqSMRRkrM8ru63ffax1LKaLTUzX3H+Vxt+H8FI78gemoeHuWTo+P5nCdQIbFm7OkRGvO4dsCHaY1Zwuf5gjMoH9g1kT/aaJziV+bw3VMo8/SJfDD9AXp/CLnqVDL1+IYDod8MbSN5JB5uJAOYP+vx80wG4tEYjFb2GKmSXg/sRGmyaPueAvpy/qqhOo12ILtDo8FFdKBdN6/f5yGWYvNZrFE7DEzScZzqQ1ENj761XD8EKevME8fYk1kPnyuc53SxtEvOWvYEeWDWJEDKtLK6rJZv1wp4wCO2kNW7MQuSRRQvOx2NuuWvBIWkVawEt6MZ2mZXOc0rSf9A36YPq1r5uCqI5FqM45IAWcQ0SSSyu4+tP34tlM+uVLBflxli1TgCizYPeLKvMJJS2ch+iTJY2/t/cfb+AryGb944lyfzMdGPsh7jDjvxdlvjKeGOaNH4vuRx0gN3w0mLfgf8MWDZy6iG5RhVUERIxjRq9oAbtyZkl34IEg4dfTo+VOHp43TJYyZPLX7ErQ6nsZljzpz2ewz4nNH/kFS9iEyjy5m80aNnpODken9hP9M9Clyg5q5SDAYMeOgpAgyzf5pAOEweQS+lwlHsn9SZVnBQRxxBm1YxKLH40U0JyuLZkLUwPcazSQ5WT5vwBMAufSpSyAvgAM+XyXJuXaNZGIyCr5ZJJPmXPNUij4R27DTqV9klyohkp19mXKYPgLfAZSj2dmCJLnA/LagM5IQSCZpQzivNWSP4igOhb1R5CRJ345jFUn2KDgCj+ASEQKCH3U9cv0Iq/rVgP7EEbZhF5Y8Lgn1GRckSWxl1BG2Yit22CutKEiT+rzHumS3T8A2r8MBCjkUV1BC16d2ncoKbkHA8Cxkj2AFyz5FRt++x5pkso+05yoitqqqSKSKJ/lkirE+cCMQy1NIvkH3dYXNVsHTfDrFWB+HNgjNKQbTmw9yXcDi838gtRxZbqiOxaqrLbFyM11uKLdYystjlmqz6fPjXFeYhFw0hbOGID7DWFXkINIm/5HGQjwFsIyjDohPOxZckhPFJ/+fNNYjeUUsIdNhLe+FJtr1/NEYjYSjUVvEau6lzTestUbX8FYsiC54r218BetyegTsQmURWw2vGQ30ymscuaL1xfG+rGkZydnAVUTtVTwYPSSHEDlV1471K35IGFRlC1Xw8UEGfaf6emYNPPhmnIImIBE0iTe/ohXDTuI5qbCdO3eF8XO6CWRNucHFQpEYpIygOgIonkFmahlkOhsKqCq4LuaIWCDUXCANxfvTpaxFEMEZkA/YFnDEBKTpD8H7iZCTb2q5XGYaLU7NBNkkRbvKWRw2ixnbVCEEWZtBZ8Yz6HTWIYJPbdgSssUgyRWf7AM5ZCkbUwMhHIEswhExZFFhRXgo+VwQqcg0kHjJKC4ITqiMoiBJYQmq+ukMJi1h/q0BX9F7+G541Mz8JyXR44Jos4QdMcgVVQ4oR46f2P0xRr+dHjnQDIr3fHQiTRXKvQ5bpQVFKMdWWlVXEKMltIXucfLY8XWcFSALzB1UA1H0ORmjPYg/p6PZgA3iAFfhCBgGB7wBt4Lo63XtWaHaHi7FyGMoxXa7UI7osdv3sW6XF2IekftJMUfGaT3Ik/EerOn3G5vBl1aIie0Gkv3LBdJMx4Wrww8/XPv2xvcO4x/13R8s27ts2/yXczcOAXipMVRYrRXmY/QoR7YSm5Gknpr0KOyj97DJnXlaRj/nyC5iNxL+oykPweN+QyfS5ryJmLSBVg4Q/uKB82fketyIWaOWBJpK0pgnRy/qBcIHU47w5AnQgTxO2pAOZAj/Mz674ES+LKluFbYa0/cbElUxMOrEY69QBO/MpFn0EToV1qIzSBbtR6bDcoP+3Nc8A1lOesG2p+hSp9BeJJsu5+m8hm3cNnDar2SMkUwiLeh9dJAuZjBtQe+lk3jTKzdqE1KqolGQdFhr3pjT8ebkFW2gofF+Qr1AExmi5Vi5G/jKy2dej4TUCA4jUmqsskYh80VDY94vozMMk2c/8mxf2MLTlCUZZIyuYA5JJ13Jo/xVfHLZm3MUUfHIsONoYtuS6gqMPTJyW2d4ZQHtQIfTPF3dKaQdfZis4E2jic/OHcdH1+/d+/LLL76HP0NafmJlXTM+PtVITWPGPsQPxTN2zj3lDgiqDYqP1QoXEYLa/ero09OuQmRfa7prTPqQx8AZe+ivrAx2D+lOiMEl6A6IEG/7yG9kA6llAwG/glUcs8Tu+BTFn4pPx9pY9k8NTP47XtEeamK5jLo0Q+McErjRBKqw9gUJx9NYxaFKIRyC/FEAcMJaGo7/i/1Tybou9QYWDYDVLpcD0c3xbnSz1o0VQk7FhpF4xzkWbQiEYQHpRIaSCbq9J1AzyaEF8OlEh9IJUCfpBGKmOaSA9x3iwMStSWcyXJ85nLQkHeE6nLSmnelwfeZw2pJ2hF9Nx/4SKE6SZyTdSJuPSXf9xYxOl2hvnpY0RFw8iSM/kalG0vrLPJoCDuzSbxRtyzfo9jW++NLJo+jSCFZ1KbDlat331TgsKU4VDT7Lnjiz6yv8PfrPmp8niyDXurNT5uQ+PwKC5T/uAg8sHDZtIqLGm6yguGQHLtdjohzbZVdQQKZbf9naCxDLZAndyYI6rvCdWFDcih4L00iEJWk1V85i0kzHjaOrDy3eOefVkVseAh1euIMb33DkHHEaSZsL4++H3XfrP542402byA92jmRc/YSwOgL9NuoEHbCTDtq14DV8AWR9eO7kdf48frfk3ekBSYHq3pATYZcqyrmHx266H5Zo22twFx1RO517hgxZRPoteXk2Hg61YfCI8Z35bPzE1idOSX6XX7gT9Y6AEJAujf188U2I+h3k9SYbrUsjRU2S3d0kcYsMJtJVa2njyKOk2S0yw6y1apJk7Yw0p89DYNqsvj+SgbzW+q9jk0l6JwA1E2mvpQmcz1ADJVSpQuTlus5QxLFPL+K2aIXORRyiDax2G9ENdUZWhNJuAafYLDAkYo8PkHzf7Y6sUhFy1ID22hpytJoLVAQdVRj5DAAWYTmGyFTtMpkav8zKlpC9YSAYDsCApa4D6wv4dNKQSFmgtU7Rguji+HU6TbvBShEnrAclBNipQwJFpsVv0EXaL6wUtUd1zmqxwEWqlHwiMv3+4QbOErbF+AhWVRXy00lOE5GehSBRxDDUpqhO0FS34lIRxeQ8jJ9gZR0wFByzQ0W3YUEQIGtL6RFaTo6xrqArYAcyb9VJmSC7AgIiDnqc+umHrCS6oZ4i0y/k8l9gKkQ2aa1YWZHVBAxFdakuAQgNDcaTqKolsa6QoOiIZ2lAPL+IyOY4x5o++Kmt5jP82WfEZ2FtoXaTVYL+AA6hSmPEGrHw8XLDn82D9hSOL4zfBJrkFrEDeY22KOweGOnPXRqqTrkhHAqFw46Q3UwL6kRS0OS+vAGMKNL8QOawDAxZBr4GPE4KCoo94Xy4SMCJJeB3wOPkRLbpfAtHE8z3ct0Arr6mlBvsDofdHnKEzaTgtkgLmtyXG3TjmE1lHtofypwhGgbSZw9bzfFfDVa73WoN26Nm0xxSaeWu4lOHdx9BucbysL2qKhyu5slRIz5VemjRrmf3Tlw/Eo/Fk8snFYkehxNUs0ZsUehfoCvyoVc3HKo6jtHNU/ldzcXGqbGpocchF+/p83QnyMVOv/3tR97/dy7niQMXIK/Pv3OYMPyH+G3rARvKM/bum9uFNx38vgHwwwD4XxtfzT2T9xtGpAVp9SsZpGPWINrqGm0BfGrs+FmjETljrLaFKyrs9nKeqLcHcN3STDPJeSt3BZ/c8/oxGTi53qpZoxA6WIRCNHdu/pIxoFKz3j+TFro80zdXCeL/iQ8v3j8fiEUCTYBDVUGIqpI840Devn4wvRs1ALzrgEK7EJaaSHfetIQkkx1ciLCfXP4VQA6f7KV2RZvpfE5REqvq8aOv6oZV501+7jHcHfe54CBtkNbVEI1GoqRbH5JGu1C+C02jWbrofgR1JO357/DbO48eBdeqpEUTa2jjSb8EVY/Z9Z643xHDlZ2vvs+vx2vdNe5qd0xH4IgzbPOtkUv8K/FMvLBixYply8pm4Dw0ZaLRarNbLWEI2LcMpoPkfTqA+wif2XTw4P79m04ArGq9jYmuxA5dySDjnHdGvpkJ+25BTb1od123bsR0P/SYv+Jzbx08hYYbabtHRgNWP45H1+YdkHzAhOtzFIouBKh4ZsbHz3+GkUAw1/mBT4lRN3X6Nxdu/X5zKE3TyxPqnNOJN7nB3eWRO0G2xfj7xY9/uX5yJJDH3cbG5wfBTcO+ohzfGz8zfdHTiBxq1NUUT/mhrg/XPU253atRlFbQEBdNZ/zt9tfcmQP7PjVr2xtH47uM01YWLeShmazUo9mup5w15Ix6VG8QSAYyTWiqI74ONbMVmUxFVnUG3DoDCusX1ZNgQNMJJk+TZ1gIAVmHHnt9CHhEEdEz9CLWNrJNNf+lieS6x5tsinz1F8NsNl7/4NNvvz0xthNP9zUxzDYjMXx05ssf3s6lyX812X4juXvYZXoXlLqJ+YufKTw58fW+uA+eMWVxPnq/iW3+OwdcaCJhE/kAWFQvkgKG6aK7uQtNJiaaTXvRFD1n+ETOJEPOZPO+v3M07YGGzGt+5Rq5i6R91wPSGeY0758F6gIAUHMTjXz/Xwj4vikCxKfqCHBQO61VcH9as69xzukxJ+rDuVW3elo/iLTKSoTzP04ePIuo0rhZKA9/cL//1o+20+e1zezbqWPvLyErYeEOX39GUgDal5IaB7cNb1Q2qGFZUTGgsS0MdQuX2QswGj9784dm8jnp39hX0/6ks+FPfWjn+mzUgdP8Fr1i6Hl69iXetIh8WMWRudpcKMaVfgCQxIkQxI9TsiOaFx9Hn9JyWTHiCpXrxd+WKFzwQWROfDarWILOO1U9qMSQacbZ9Zw1bIvyIawEFBUBcy8kI+gKNpDgkjEc0aux6g5IAURHk2JggYuhEAMNUHDUHoG6g12iS0B0EJ1PB5NnWTFBCKGU6tVY8IsyrDyMLqZjaDEUYo+oF+JC8gB9mPsQH9v32i1E5mmOf7uXkfGn6GztyX+7l5L4ErfALh666NkJeCkulcsUlz6gn+bp69oUIejeYt/s2qWf+tyn9dTPpTxhUBkHXTCVZu4r24evoY+M+Otnd46uPbV+/x78tX57rWYfydwH0Ky3m1G7YvPQnEVLcnFXNMSYUzS1a5nTabMFnTXXN07N4YcYcdcduSRnESzyL3IXTeb08qiXTP4Pk1Evm3rJhFC470LdDM7ms7t01qS4FA/JXFCzAGehYUbcd+/is8VPlsxdiPvqt1llC2jmApfHpZ9bWcOuiI/k7NpxGl9Hl4yfbDxyvSYYjEScwbKuRUc+4S8Z8fUlp2nOLmQqIIUvcFJp1FID/gqFfWFU8ykb88Tg7iv8zt4jUOWAm6j1TkscSIqzZk1alosRAFml1Ye+0B5nD9h2rXhpWUBsgKxIomkDfRftmPfSxBiKnWblddZYGVjYYffYkWVUOWabVD1MDee7X1+I6F0kwP1ZNUN4YHwom7Nj4qf4B2TaeibGQdOg8toq4E/hhuOuWyRCtjc2eHQ7STfg02tf37lz69a91YfxJXxw0SszADwlXbFIuKHyBtCsY3n7e+Cn8KRVzz47Z05RLh6GaNqYxsOyMzRmyCllnR5JxIJ+VJlKXuBIvqEx6Z7ARCTQqSp+9Q65tGOnqLeEEv0f6iK3WSHsStBAa30EAr1ExEV/pY9j1mqzQYYCJyL5PWi+ARLW0nDbxfBnS3qD5NeXZBsQKZhlIou1vgCHs0h/MvDOKUNf8jCdBZ/+dCCdwiea9L7QpM/it6bSPNqZ9CC5+sRc0oVkk2dIHulMe9BcfWIu0INs+gwfID25d/De2r07ZH+CKUccIf3YUnS7PUsLnyubidGj4859BlI+O3n2Ev8q3lGypQgS263nBdQnINwS9EZLti6oHY9R18H9M8GnXS8NuA4RvIo8pj3AvYp3ravdhpYb7UFnOBwKhnnAL7zbvqV0XXHtc+EFeCFe7lxaIbhFPXr1SXco34bQltBWjF7fsWKyWTQWKc8HFmL02ORF42GJp48/9wbv28MtWLxhDyi3c/um1/m9+EVpowArzZi5dDLfg/bWjzkjoVBE35N+zGlzOGy2kCNiNnXTcg5wOtGthA14ZAkKbGsygrQmw3WgUhJA1XgITzvQUazggI5AAHhyqQ5E9Cd6XwdlnM5um5VmggI9n8S5qxc//dFcafxx6KUePR8d3Iv3Gnt9PORnfn1qvzHvX4aBy2fPX/nqzBMDYGDA6Mf782P/xUFyA64qQf6NV4xHxrOyKLt1IAnoBx2y1w8Bu+A19sXg2vV4C9q9bP1CPtfgdLmc5q3DuVOHjJuq7atKKiwrgegPIsVaH+7SB+c+AYt8MuLckCEjRuWAs3M+GHWJP5iaN/vIGzDwxoEjJ04cmJoPA/mzp+bxps/J6cSZ7yqSD+764t1zl/TXnz77yMNPjRqiv/7O6H/xtA1N40ioiTlDjeYkHHmQy5t1+B148cT+wydPHJz2NLyYN3faeN7UjRzSFnJWu8Nqxi6fS8f21nQEbU2Hsw2HlvrfQXDD30FIBzKKVUOJUx5o5YQQGB+eiKpLdiZM3SPNNJDs19ZxTiy4vFbkpCksRRXZYzBtCU14x8v9yD06l3ztjVMNnozZQ/phkSCJrqkT8gqGYpSZ+8/PEweQF98iqWp1ZSjijSEb4VhvVFBgmR2kBbfFuL6iqqSkoqKEX24sqapYv76qaj1v6vcd2cSRq4mOR++MzPRqos/S+zGziezWh+tmNg7fntl0eGjd41zPNNNJrZbLTrtzID+X3Eg8pqPb9tRv60fJ6LbZ+l1iUsNNN2IlJdy542+dA+3PPf1W7tjxE0eBoUcdn3iON53Wth/neqXRVW0bLiZ6gqw4wOnBeeIb8AGY7kZdN3Ifp1uEdyRie+aYZ6YPxJTFAy4vJa0RWd8EULcaPOu8G/AGXOur9b8AXWyTsbWGHSTt8y9+xd/g1+cfGym7gmKi8utnxIpbccuTPhj1Bk3Wj0twZueFtAsa3ni4cdrgLvYW4yJcUlniK0VPNo6cN+yk99/qQnh8E587eewjvwysIYBMF0gbrQdnV4VwOKgCglR9ZQwFg6GQM+gw04UGh9PpcASdIfNXBjKXVnH2oBBKTMRk1U36IAu9vRSEiArIsoJukgcxXcU2Cttu1OXwkiHRUrkQTQfmkU7GsJIi+Z36sZ5dEOxm0ydk8zru/jR1Ldc7bfwB7oG06uFwEVP7pJGvAw2/xQd+xL2k2mtkQwBjb6WA1I2CwStgr4iRtC5qULHP47Oh4IbJgjpXMLzv5PqkaX+jw7n4t3X7tW8NtNvtPK4aB0OVVchp8DpEARSwu9TqGkAIcxD7JdmKgrUw5GIlWfQLGFVYrKVrIrZ1Ztr6M87lCQRVYCIBn+h0QnNgzh7MbVTFF6tWisJG1XXMYPewnkqp0g1SHS6L2SsI6kqX8TuB26w6awy+AFgcI69R8nv8UBHkgNsv8iKW3G4nCpcKCswtO8MpWA6ywNPcKkZRORqKusAPetHwuNAWmGU8PIWDVyQR+l5zCKBMDqPYdrCIugZjIYCdqx0bFLhbmbhjMY4WyXYv1BwJ+/1eFTZF7ye/c7ioumJjcWStWoPXoo3W6jVlNusa/i16i1NxpcyCiqBAqB4pa553AYb4fD4oHtjv9ktIjbkMHpH1+CUgeQ4s6lBTtgkWxx6Px41FDJMUJBjmknZg8ag/EircXfhS6VqbTawA6ri0tugljGI9OQeYaLXRKYtBPoih7w8h0cd6RRCCkdvr85s3xFRLxEg6k7FcqLzGvg6jrbUbt28vfqHQvBKXVJQ979myOrLcq4T9kB1o9+KXx42eM2c2j5eFS18ozi9dthTPwflH5r2DoVRWbd2+c1Gt7SV8AO/e4zuBBB9rX2O1rsKr8Zroym3VG2pi1SH9XL6cq1WlaoPil0Elt8SXSkKt6lpvBO7l4AUsSW4BhdckHEZWTwP6ZPSCeT0eSXbLYkAF52IFKaLigNgWeGAoblkSPC4RzAMFKQq4GfCBaNHvDYBd/QGfisRK1it5vR4MH58HggM+CgqohoLlnEuSFTOWfX6fLwD8PeBye9wwE9GMPVzYD48rvZjH8LIeWGaxwkjayRxMhnBzu3kseYBvSLLHj/2IsuQYV1MWLY+Vr98Z2FS00WGvsJVY0Jv04p3so88XcNtU57raUqcAP/cH1WUGIVhWXAO/CMG5TqM2WUkEoOR3y3oYy+BrwN81d2txLtiGaaX/V4osZhgzmcHMRuYwc5H5Oal/UnnSnqQrSXXJ5uReyY8mj/eU1/81QA7IMfQ2mcH6Qn5oeVBUCDj4EkMZdjjdpSj9+/cu/wB4/N1Tlx/oPW7A/YDHvd99+Ds+fcL0t/VK+uGr7548fihPL8TD5owfz6fbg6IKBPfFqnXwL/QSPo5ebKw1q4x4ddRWLfkLKooXroaMELGI0ptUoCZ1KV3rDYUmUl9o4r0bCo2typzeKfMr0k5nfm1/+/r3W98/RNvrnK9D30E0hU9fE7OsXVsVW8uvNa6tiK1ZY7Gs4dOj4VDUjBWPovds/w0VUgBgUbp+pui1egWAKdd/V+dF6ARRetgZEKBCrawohX+O5/AEtNJYWl2+bl119Tr+BSPeYI2Uy+7dVbV7NgT8fr1E/FuzriuvLi0tLy/9f5s1BmaN1ZvVAma16GatjLlCFRgBvbFag86YOQII4wsCUgBCQTOKBLc/ZE4P+CSnucIQguji00W3HI0AWgb8ks0KuGdOj4ZC0agjaLU6nFZLyBk1p/8vR0qpHHjaY2BkYGDgA2IJBhBgYmAEwiQgZgHzGAAIgACVAAAAeNq9WT1sHEUU/vZsx84l2EnsOE4cOziBYEJ+IIkCRkGATYJAASFANAghhEgDiiJIARRuQuGCNC6g2QaKE1IaF7i5JhK6xs0JyRTbXLPNNdssxQrpiuGbt7O/t+fbMzE3mr3dmTdv3rx573tvdmEBqOIq3kXljZu3PsT4V5/du4OTGGY7lEKFf1buqfL53W/uYvzLL76+gylpseQK9u/DIaGq4Ij1V9g++xMsa114TOMaruMmbuE27uJ7/Ihf8Rv+wJ/42zpozVvnrcvWe9Zt61tr1fqBoxdVg5zmlI8lzPN5Tm1whnH1ESbULzikArasYlk1scJaYY/HVkfu7pHmIWedVh3y8XCOdZkjRjCiXPbXKU2V49fZ6gtvj7xHeB3nrHPK5qiAo1wsk24IY3yaZu8i+Y+Rbot0a6RbM3QelmQGR2TRnDS9T4pA5l/iv5Z0WFr0epbZusL7IfavmZY6JblIqtFQQvbqp0vC2RfqN2UNmnPYE8iqdGvE+Yy0aFqLOvDl6sksDcqp6bfZNk0uo9iPcUxwz2Ywizmc5thFnMMFXMRrXPcKbuAtvI0PUDl+T+/gsX9mfucOXsH/9qM+oXxVU21lqxrv1027zbomd+3oqhzlkc7LjG+wbrDY5tllDVSDOhDeGVoZSY0J1WORPghrmn/Sl/Sk6ZNR3f3Fc4TFPMm6+Lyl71VLbalHui3SJjXkxXp1Cri5OSmdvHSDrH3wMel1c9e8Aop25lnvls1WO9ac38V2Ki9HSJel1HNROz55uYKKMf9yK+1q7STXyEpL8PLLzdlzfNNYhM+ddM0+ZywttG3xl2a3v3Txa4tWGsK3mbUK6t1TD8QTV83ebMReGUSrF5vr5Lg2pN3RHp3yvHCWRsrzXdURS3ZoyU32O4/JkmN5iLK5PRPdBV2tdliJlrFt5G3M/DTFiKHKUeq18NpifbRHeNkx1u2JJbV7eGW4/mp+X7p+1WILDbUkOm6zuL0wLqvrXv5iPMUXzfvmqUbkWs97qPpO71c0B5+atMH7OjLw7j6vdbEqO8f/gfBrisVGZT2x7v4IV9Yr0zQpG7PFRtsp7PG41np6RkruqTVi9Rrlb/O/oS28IEY1YqxyjCU5xqpq9JGfjU+ECCCzSESIZnnEVpu8bdK62t/4r3XeKvBPW7TTkqL9byuFMG6CtSJLBuvDeCPyaYRx5NozDoS4m/Vj7nxDrYZSaT8P56BE9dQs6+S8yhWvMk44/LfVptBu5vjbQqsl3iTXLWqkoXEqlrEgMmTxz8hHK48wp48VeOXsRag2S/BrFfqLF2kuEx1r8R7V9wBd7P7xL8mido6fZlR1oPl98RQ/svJMdtVJIX+ryJd1rBPE8jNRrBbmEEluOUiUz0aclPc0eiNiD0T1+81TYKlJ3ueV3BdvEAxLe3eZTD2JDql8rppwlt6qRMiMPbMEXTlCM/YkZ69OFoJyPjE3zmEKNBZE0SmJ712ZkBcjxUPBqO1+mpYRGxpRui05k8M4xVmZRN28JQ++FpRYSyPB59Bf4nxso/w5KU9p5gpM3HfzOVeBTc5LnceUjNrmqO0kE4l/8zzDhtcXk1g02Bkm0chjsrS60ZjXjfaZfAx98zGkM6Xszsq+6IiucyJ/dziWjuM6f6aW3X6IUTqKubuNlTGaOLnzvmcwPeh3AjexcsBzVfkz+IB8Q9/3E0ROdJyKZ26IgAWY0JbszdtJr92aj6OTVw75C/GjIbsVZRfV/xAr/SS3ifIbseCNPlHM3zm7iHkF8Vksb912UR6Ty6O20yfG3vFn0PdEYrtTmTO4frNVM5geFJwqz5iRm7vAsc0cNnaNpF+0cl4fRF6po8uAb29Es7t9d6ZPPnmNUo7MOTm0DnNyaicZbh6x1cPYs5pRTTKykjmMn6BtuZPxIO9o9vCNaTtvoYzjbVZ5H6AjbW//zp53d4pGMfo0BV3b5gRbN6fbDCanMM1Pvd/xzZvLTulctBWvSCqjU5m19EXx+GQermVHjWXfdEQWWGYtOWzJ25i/Z/bglcn6e/wsjOBjzPDuPOtx1ieJSKflC8BlnGJJKCsYwjD2YRRj2C/+cQAH8YT5wnAYRzBJPDuKacxhVsYcwwlmagt4Ck9jUVqeZV1keY49wFVcw0tYwsmcVGfju2dwgfKcwUVcomThFZTvLHu07J9wfv1boBTg3DOcM5xjKn5jd9p8u4Jch0xrxdRhcknWdIAth7gScGUTXM8kdXKCd3NcxwSL1sgk67R8RbmE54XX4ZTss7H0Jyn3DIte/VFz1TqZlfWe1V+x9Ncq3o+yWJx/P9sOsHVIZBgl7SnKtMB1T+IF5rsLeJllEdfxKlf5Om5QhndYLuN97uIVauNTvEJOY+aLHcu/eyTbHgB42mNgZGBg4GIwYLBjYHJx8wlh4MtJLMljkGJgAYoz/P/PAJJHZjMWFxsYMnCAWEDMxMDGwAfEIJ4ARJ5BA4g5gJgPiBkZkoCYBUozQDEjA9v/+RBZAJRZDBsAAAABAAH//wAKeNotkC9IQ1EYxc8912KRpRcNwoo41Lm3N94bQ59MnW4KK2qYQSYMFcw2ERmLC4YxDEbTEIMaTFYNMsEsBjGJYcFpmIeH4ce537nfuX8+0wPMhGgjzzskbAYebzGNd+RNB4siK4rcx6y8tGkhlJZNb/DDFia5Iv8L6yJQT1asiU06iFsHGXZR4xsKdkTaRM3GUGAc43xQvae6Ksryzv71Wf4R5thAkt+o8BOZoVWd29XeI9K8jN60bXoYlnrcGHwwhxmeqjeAzyX4ZhcJ1VnuoII+ttAf/HIqWlftjfrk6w4/yqjPNPWeBbj0Mc8iUuYVnhnFodRlHjmeIGQHrs3BNXXlrPbPMWbusRzNoq45WGUdpBhDaI+jGZVEEM2sjZIIRNq84IAXyng6w1PmSX+4gsNrJP8ApTpWeAAAAHja7VXBctMwEL3zFTs+MDAT24kJTQDHPWSmQI8QDhwVax2rWFohyXH996wNaQMJbT+gF0nWat/u232zzi9vdQN7dF6RWUWzZBoBmpKkMrtV9G1zFS+jy+JFrjEIKYL4+2mRt0b9bFFJUJKvFrNsvoiXy/liHmfT2dvpRfYmzua8zObTbPYugrTI92gkOTBC4yr6RNhU6OCl0PYDXDl0GF+TQR9B65pVVIdg36dp13VJ6C3tnLB1n5SkR6hGlWg8PjX4w4hph9uKTIg9VaETDqNiUysPh0/gc6gRrCOLLvRAFXD6VXOX/poS+E4taNGDoQAl2X4CmotZ8S6VD05t24ATYP6SOtOQkIx5FGQ0KeODaBpQAVpLBoTpGUtbdnXjg5p8GKyVIz1aGypF4LaM8R04tasDBIKWixP+JeHb7Q2Wo33gs0Gn/UDmK7o9FxTEziFqNPyiFgHwlhP3sMXQIRromaAw8gz1zxWzZvSyPoL47T0Z3Q51Oc2qYlIDD9s6Sx4TuOILTUO+hm16JDcB26Bg373yTP7pjRxrVvKNYNaneTPHUxB4VE95+kd+RS7Rl07ZIclnzTxr5iHNHEslH5o91r1YH07wav0asun0YjKsizOh/8shT+/x8uCERC3cj+IjcUs0fKHWSJRDMwXcWc8KcgJdrbgjQ+23CA533A+ezOxsoGQdC95vWqe8VOXAxCd5eh/wMJbx8RnPMzw9/FqKX5QpQUs=) + +@font-face + font-family: 'Gotham Rounded B' + font-style: normal + font-weight: 300 + src: url(data:application/x-font-woff;base64,d09GRk9UVE8AABbaAAsAAAAAH5wAAQAAAAAUtAAAAiYAAAaMAAAAAAAAAABDRkYgAAAH6AAADDUAAA5vT7aLY0dERUYAABQgAAAAHQAAACAASAAET1MvMgAAAWQAAABPAAAAYFXHJUtjbWFwAAAGPAAAAZYAAAM67rbLAmdhc3AAABRAAAAACAAAAAgAAAALaGVhZAAAAQgAAAAyAAAANgMWR7xoaGVhAAABPAAAAB0AAAAkB2EDAGhtdHgAABRIAAAAbAAAAGw9xwbVbWF4cAAAAVwAAAAGAAAABgAbUABuYW1lAAABtAAABIcAAAu7KDUzBHBvc3QAAAfUAAAAEwAAACD/uAAyeNpjYGRgYGBkcNRb8/RoPL/NVwZu5hdAEYYLOkzyCPq/BfN8ZgUgl4OBCSQKADP9CZ0AAHjaY2BkYGA+8F8ASF5hAALm+QyMDKhAGgBY0ANpAAAAAABQAAAbAAB42mNgYvJl1GFgZWBh2sPUxcDA0AOhGe8yGDH8YkACCxgY6gMYGLxgfA8153wgpfJAiFnhvwXDCeYDDB+AfG6QHOM/pj0MCkDICAC/ww9/AHjatVRNb9tGEB1ZcvyROIh9TFFg2wZG0kqyqCi2k1NRA45zrGOkyHFFrkTaIpdYLq0IyKG3Hoqi1x76J3rpD+if6K8p0LfDVUzFieoCrQhpH2dn9r03OxARPWj8Tg2qPl/jW+EGfYG3Cq/QGoUeN+kzOve4VctZpS360eNb2PnF4zWS9KvH68j5y+ONGt5c2W5senybdpqfeHynhrdqOXfpy2bH43s1Dds1vMO4SY3WBt6+b37ncYOOm396vEJ3W5963KRvWl953KrlrNL9VurxLVpv/eDxGv3R+tnjdbq/+q3HGzW82fp89cLj2/Rg4yeP79TwVi3nLp1t/ObxvZqG7RrecfhI5zOTjGMrHh49Ev1eb7/tfg/EiVajiTJiVxzproitzZ/t7U2n066d5XpsZB7PuqFOF+tPdo+0eCsWU07VuJxIExwE/cFB5/BwcDDo9HvBk95+/3GnP8BPMOj1g6evlCkSnYmgi91jndnn2sYyFae6zCIViaQQUlgjI5VKcyH0aFFjW0zjJIxFKmdiqIRR46SwyrjCTITKWIn1vDRJESWhBVHRXag/i0FQ6JGdSqMcmY2VyI3OUTq7xiZe65KpMm1FiCa0RaqjZIQ1Aq9JhqVVbaGNiPQ0m2gZ4bwaAW8lWWHlZCISK8oczmU2w1lpjlLDCbEurNsdGZ3y7kSH0mlnfiOqzlstykItnu8MFOXwXIW877ycKZMWzshLZS6TUAk5NkqlKkNGLK1QbyC8QO/sVKlMzGBQZtF7tl+M4Bgno9FX5VVlm0vmPbmuaARDzkNemlwXqiuOEUi105phL2VjbZFPlETtZVLA+Efnbm+qhiPMSGehoSEiEo4XNcPb9QPEP87j9Zqbq6Ej0pTTjAwlNKaYLAl6iOgjrH3q4dmn9jt8AHSCCkUjmuDX4H0XX3dKF6urtzjvGe3hmfLTRWSGmMb5Bn+NObJmiIaIpEv5T3C22xf0Ft9lp5xCy5hKaJLYDaAzgOIB1g4d4nFoAOxcBPSEXfXpMUcGHgVAPeCAntIr9lZAk6YM3AGYqtpjjlh6jtVCgwS7AL8Ge0YR6iK8J6gV2HOqnVoXT1nbBWIa3VvWR9fvKc5O4C4GdpUzrENkCuQ6r47BcuWc0ekMOWKRX72fQ5Xh3IhPs95RAZaP858xt3NQsFYLNZKZ5s6cc/eWI+rur2Kd3cCboNfcqytXGXdS8E26SWjznmbFI/8eeb/OyxDVznmb2QzvaijMwKa515W+Dzu4qkq4D65XEzzu3akoecYyvr2M9VUTlntWUzshxlpwVVU74m6ktVqnKMTbvO9X/g3f5NXMW57zEueppfrFu3iJTpwjEtbq5/dyxkpTzqxu5CVHLnkKFCsc83luLhVPtPDz7JCiN77jhZ87p0BxpoCz6gYlT/zy237B7Bmrc5qrif4Qe52zXWN5f05u0qORv6H5PeTc8ZzvS7GuY5+R8qr8PFR1ae3G2lztnEnPe8ms1Y3/+/+7Pe7jkJmc786SCQ19jvR3vKzP1b3dRIH4D/4fb8LzP/Tmb7O8aiYAeNqtks1LlFEUxp9n0vG7cT4cR5HBIFyIiJBJrRRE1IWFC7VoIYorQ0aTwUEkkOgfiHARIX4iIrgSQUWEIQZDRcr2+hKBa0Ut0HO84ztOgotx4XO4H4dzL7+Hcy+AB7BHCWhmOKpNxqs8zREwawR1SMczPMJjPEENnpu8Ac14gVfoQQiDCGMIw5jELn7gFOd00UMf/QywmGUsZwUrWcV6NrCRLXzJVraxg6/5hp3s4lv2McQBDjLMYY7wPdVRFBwNfgh+PPCoGgelhlyFp8ZDnNyUJL9LkjcN+Qh/Ddl9f2S1dF9/6Z7+1G3d1JhGdUUXdUandFIndFwjgNbGe6amf/JPzuREjuVQ/shvsWRfdmRLvktMvklUNmRd1mRVlmVJFmRe5mRWpmVKxuWrfBHfxbk1Zn22PpVm2q+QQu1mdKPXzP24P+UlwpUI743wJ8Jj6qATKW3SYX+ra6WlOzOQmYXsHDvPtYl46Ipv8pPn3DfueP5vvYCvwPALgUDSb/5trDcuv1EKe14U3bEleS6j25VL40WT/QAAeNpjYGYAg/9bGYwYsAAALMIB6gB42k1WC3wU1dWfPGbmlsci6uCn1tkEDCTKQ0FQMDzSlBBRJDyCoH4oKgUpJTQkDXls9jGv3T2Zmd2Z3Z3dhDfK61NaFcqnolR59KP5qgjVtvgA+SH0V6FqrdyJd/1+353QWn73l5u5e889555z/v9zbgFTXMwUFBSwNQ1rmryPcvc6xv1hgXtboXtbkTuseMmgIiCPfzuhbx+LRwyxb2MYH7oeLx7KFBUUoNqHVj7dsG5184rqhrWtjc+uWNlUUl5dUTL+rrsmjfbme0tqG5b/ZPXyxpKRJdUNY0tWNjWtnTJuXEtLy9im1rUNKxqXrV3ZOvbphp/1W6fm6R9TyLDMUOZ65gbmRmYYcxNzM3MLU8qMZCqYO5hxzGRmJlPHLGAWMouYxcxjzJMFGnNrIT02lZnBtBeMLggWvF5YVrip6OaiTLFQbLGzWWCPsee4Cm4z93/8HF5FDPoxOvYD3w8eGDzgdvJ4sRv9tiMf5U4uEfC3QGblb2HJ4/laAfpkPCM/iMXr3UECfCeTGe4gtmGugKkE+RZYHznsI1/jIvyIIFmybVuWLfa4LWwulAmIQS4QCgX8se8KhbX8+lxg06ZcbpO4g98UyK1fHwisF3278Bt9vxCW88QXnTANRsKo4wvxHasQeYmfaj+8Z8GhqKGYEeiEYJBOEVOxlHfmnfzpORlV8p2ZUDabyWTFP/N4qHn+A/gGLj94hIz+L4Rf4H+jvN5y8BlLScSTkAMnQ6e0moxY9a88sr06iV7hs6FMZ2co1CniFfm3BJg+e96oGMK7eDxszd5lUIPyHP6rAKd6j17SEXmeJ8Ken+6Hd5HvCr4SFHANZvFUXO/XeVxPivD9pIYOlkwl9WKMJ/W4iNyPa0T9NYGUjcNj8CRP8N7P8B24DJddJKPJvZ7YpLvJnaRM9JEteNZWIeAEc7mMkxP7yvlsxGkXY1wIwtGQhohvKRvSJAWCEEyHHTDB7EroCHMvs77OA9uFQCacE91aLpfJ5Lyw+/MDAa/Ci1g8BBcf6oXPEbVeMP4TMlAkA+DBR+omRrW4Chp0ZsJZSEHSTFhvfXBk/1k4A+/XwV0Iqp6ZS9BwRJKklZVkTYEI8lm4lzo++MrH2Ee9AXwj4Y+Tm22EO/BGNpE0bbBQNpzqFPPD+7Pu3cqP/wakjWxkFTmqgII8g+JzHL7+Yn2FP8aPq3xojDgBan+18PdaQkpEIODlOQCyKRva4VlnHsMFgHw6fpsaLv3751jwwjh0+KfkVnE2LG1f2ow24G58GtjvPSdfcFRHJL4etZF9bLzD7EzLtprSHNgAr718ARBmT9eWU9Mjp80gReJMmLW37rCaiJgSNRui8YWIodjSkYVnl56npvEZalm8chn/R79lwp0jN4iEg9lznp6l4lUXcQUeDv8DB5vfeCqhJWL9UHPolNKSchItODD/uSpA5EekiFSSFdQqkLI9M4/O27+st+EUIJPCg530xy+o7k8/PId5XHS6+k4KjPKqyYQVfTvwu2EBj8LsRxh5Ef+49viEXSd2Hj8En/QnlPDvk8F08FWkgJ6C+44/cqJhwpraOTAZUXRRV6fgUaJ7a3H5fUc/pQpOf3jkq68+nF9JZSfeN69cJJeKiTDtxGm6de7i7zCHuYsP3UM3K6fVEEH04Vep7/diHx6P1/YnvOTZ0/VvLdv/8K4Z1KeRo0qJQD0ig74cg0tFXAjv/u6VUzb5STnFdCnMhUXb619VErKuXA1s4Cp50W+e7H32Y6B5OyWQospTl6nmSyfPU9/RJ5Xl1PiE6XdTmPrcwa5GJglfwpkd7x8wdNMECyzFkiEKajwWr1r24+YKeguFTMe1uAmvw1X4QdyO2/AM8gB5kJRVzZk5f9WeI35wjOeSe9GLlAxGT7i73SsikWgHCtWxTQeW/vcUqqOYDC4lI0o/rL7kPw1v7t/35ob5B1e8B+jspVN4Ol5BFuA5JEZHPXmMSETC88kSnPIvwnuFqQvfOIuLPzt74Y+H51ZWTBw9xu97Bw8b5v4n55Ulr8D489X4RXfoNeuheKc77Zr1Yi4QDAb83/2Q9/hPo3731/8sBQ4tBfiYu5Ac479f993O54JOwDsikrfzC/Hb/177yMe46Jqz18r68Nyvt9A6Ecp5TBHB/cJtzl9h7bAtpykOOSeVdvy07ngc8rgrQv5cfrX7OSunpGQIkHT1lj488A+bhc50KCtmwLKsFMIS7sUqeYdNSkk1DVkP/g5Y0aRiIQL4JN0/ypoJIwlJyIYznRACWZYjiLSSg6QDH2IVW0mEr9b3IOU9RQzCEXKYGOQPrKb2Fw3fEbe3b4nQHUoHAuFwh0iO88t6HzhaRnM3hAwdSaZ4MJyCh5bjIeKX8L/HDryDxvIdtPrk0ulukVjuo8I3X00gN3liw8rGl5aM/RTfIlIG3Xb+I1wk+n6FT1Gkj6Yt7Do8wuP5CFKIfRTGoylvryMjvFI9AhcSH75T1F8VyIBxl/EQT27Qub/hwXjAxQoyxJMZdE85GUzT8MRftghXzdNQ4zrKnPsufYSZdE9X2qsN3SGnA6phfP0T5Qhfx191i4bcV4ozYeHyn49e8Nj22cTdk7f9aEvNFjhCyf7mqy+9Jx6Eg+0Hfm7EvDqThUzGm2RLMR/d+fDGhYDKa+omeyXmrouNn6w72dLbDHNpGairX14jPgwLNi96STMUykaaghCdpIRkRg8986e1J2iZS7sb3MA1Ad7Bl06bPur2uhP/EPFe/t+/H6Bt+oMJWBD/Akdee/G3qIr/3k8fzuCULOgcbSh2ohvhke5EXJafyCY6UlIWkM45kLYTOYTvd59g9YTuIcKhcPPKfSQaRqQiP5OUuzNZLSPbAUAxrhNkSQshUt6/Uc1qjpTyxIPe/VVd0VWqLP8EmwikJYd68eiZYW4p56TTjhNOB/3k74Bdt5JNWhR9Nuri06F0UMzfwAXD4aDXR/34PBA3X3m1OUkozoczYUf0XjOlri7YsiVJsiyJ7fkW1qOO6PR3WL/eVyhc84S55mHju4Cf3yiUDLA2CKUD6n4tDB/QXUUntXjEAHw+8c+v/OQPhN1WuMfkEgDxLhlZ22QuLgPtyEjb6HAW6DE9hOzNi2XrKZl7TxJGDHDrSZWQv9C3z73AkZHfzRO6wU515Sgv4xFVlgCFFau7J5m0/TYYmhlE9la6pbCaqRoyoEBnsLUtE9roJ9d/JCixhG3pyWRCVyUppqr+O+8Xtlnqc7lGVd5mKYe4cIyNdWldUao1onT647JsNSr8RVl43pJ6OD1hmDrQYGlGzDANw0xEDVWkr4loVELpVjlJZdt/LyTBtFlDNaMWIMd0Uo5iR/wKqNGYgnZQKf71JQI9oqmmZvlTQN8PaZTdQyNitQHICZBaIpuTdNXYv2IBnCYzHFfpCTCMOG0EiIzB3wjQ1B3Y1pzZYPXABrQt2N3WHgq2iW+TK4IFXSZLr0gv4Kmn/aNnnQI26Lpu0BeUETU0ZGUVLqayMUPTVYiASqsNtG+nxiEWi9FOA1QoiWTuKXwTjbhjZFINext2t24IhdQAdMDqrU27AWXvECI0RC28ZKq2aINp6imk6mxcpUoAReO64d+ctTozPB6OZwupjp7wRkA7t27bs6d5S4O/EdYH2tfFdrRk1saTaYOyGu1d9fKc2mXLnhRhTbp1S/Oi1jWrYRksOvj0b2E/vJjbueeFZ7eGdsOvYe8v9aNI1tlwWzD4C2iBNqdxV/fmnmx3CpHlpEPYamndXNIw6ZWimtiqyVstZRNvR5MRUQZNi8oo3dafMNzymEBzEqfhjcU0M2qqCYsmF5IoSR/NYVqyRcq4qKnJMUWl4ZGSikP5m6CNmSIsnqBxNRK6hdQuNq7F4zGgQ49RcNCRRAmLW7lWUDQz6QdTN3Q9oVIDSjQWpZKI3PpLIW3Qn7viIAI97AHLrwZ4fJMpUGEKt2hUBC0WjdKrxQwwEGHxIaGn3enIdmx6IbG9aVskHAit70RvkT/9i31k3UphlyVt3NoqyfT/Pttaw8l2e3MP/ZDtpyTeXZzsB6BmRE0PxibNtd/XN+xG9wvBvoEpLigYdU/N4q6sQmsOCkUiwaAtZf0ZCiXdppCgUIxRwspRI+UfmNA1yR/gUlSNOFCNmk6G0iJhaKEgBbh/oJNKOU7EDgYjUrAzJTn+gf8Pvh7eOQAAAHjaY2BkYGDgA2IJBhBgYmAEQikgZgHzGAAFaABNAAAAAAEAAf//AAoB9AAAASwAAAD8AF0CeAA9AsYAQQFPAB4CTgAsAmIANwJdADwCggBAAnYANwKCAEID1AA1Ap4AaAL4AGgBEgBvAxYAaALSAEkClAA8AoAAOgGQAF0B8QAzAmUAUwNdADoCKgA9APwAXQK2ADJ42u1VwXLTMBC98xU7PjAwE9uJCU0Axz1kpkCPEA4cFWsdq1haIclx/fesDWkDCW0/oBdJ1mrf7tt9s84vb3UDe3RekVlFs2QaAZqSpDK7VfRtcxUvo8viRa4xCCmC+PtpkbdG/WxRSVCSrxazbL6Il8v5Yh5n09nb6UX2Js7mvMzm02z2LoK0yPdoJDkwQuMq+kTYVOjgpdD2A1w5dBhfk0EfQeuaVVSHYN+nadd1Segt7ZywdZ+UpEeoRpVoPD41+MOIaYfbikyIPVWhEw6jYlMrD4dP4HOoEawjiy70QBVw+lVzl/6aEvhOLWjRg6EAJdl+ApqLWfEulQ9ObduAE2D+kjrTkJCMeRRkNCnjg2gaUAFaSwaE6RlLW3Z144OafBislSM9WhsqReC2jPEdOLWrAwSClosT/iXh2+0NlqN94LNBp/1A5iu6PRcUxM4hajT8ohYB8JYT97DF0CEa6JmgMPIM9c8Vs2b0sj6C+O09Gd0OdTnNqmJSAw/bOkseE7jiC01DvoZteiQ3AdugYN+98kz+6Y0ca1byjWDWp3kzx1MQeFRPefpHfkUu0ZdO2SHJZ808a+YhzRxLJR+aPda9WB9O8Gr9GrLp9GIyrIszof/LIU/v8fLghEQt3I/iI3FLNHyh1kiUQzMF3FnPCnICXa24I0PttwgOd9wPnszsbKBkHQveb1qnvFTlwMQneXof8DCW8fEZzzM8Pfxail+UKUFL) diff --git a/doc/src/_sass/_github.sass b/doc/src/_sass/_github.sass new file mode 100644 index 0000000..3335188 --- /dev/null +++ b/doc/src/_sass/_github.sass @@ -0,0 +1,24 @@ + +// Github +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +.github + border: 0 + color: $color-tertiary + fill: $color-primary + height: 5.2rem + position: fixed + right: 0 + top: 0 + width: 5.2rem + z-index: 99 + + &:hover .octo-arm + animation: octocat-wave 560ms infinite + +@keyframes octocat-wave + 0%, 50% + transform: rotate(0) + + 25%, 75% + transform: rotate(-25deg) diff --git a/doc/src/_sass/_header.sass b/doc/src/_sass/_header.sass new file mode 100644 index 0000000..3ff5456 --- /dev/null +++ b/doc/src/_sass/_header.sass @@ -0,0 +1,35 @@ + +// Header +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +.header + background-color: $color-tertiary + padding-top: 1rem + + @media (min-width: 40.0rem) + padding-top: 5rem + + & + section + border-top: 0 + + .container + border-top: 0 + padding-bottom: 3rem + padding-top: 3rem + position: relative + text-align: center + + .title + font-family: 'Gotham Rounded A', 'Gotham Rounded B', 'Helvetica Neue', Arial, sans-serif + + .img + height: 15.0rem + margin-bottom: 2rem + + .button + margin-bottom: 4rem + margin-top: 2rem + + @media (min-width: 40.0rem) + margin-bottom: 4rem + margin-top: 2rem diff --git a/doc/src/_sass/_misc.sass b/doc/src/_sass/_misc.sass new file mode 100644 index 0000000..4db9880 --- /dev/null +++ b/doc/src/_sass/_misc.sass @@ -0,0 +1,46 @@ + +// Allerlei +// –––––––––––––––––––––––––––––––––––––––––––––––––– +a + @include transition(color 0.5s cubic-bezier(.66,0,.33,1)) + +p + text-align: justify + hyphens: auto + +kbd + @include border-radius(3px) + @include box-shadow(0 2px 0px #ccc,0 2px 4px rgba($color-primary, 0.5) ) + border: 1px solid #ccc + display: inline-block + font-size: .9em + padding: 0em .6em + color: #333 + background-color: $color-tertiary + text-shadow: 0 1px 0 #fff + white-space: nowrap + font: Consolas, "Liberation Mono", Menlo, Courier, monospace + + + + + +// make anchor links easing +.header-link + position: relative + left: 0.5em + opacity: 0 + font-size: 0.8em + @include transition(opacity 0.2s ease-in-out 0.1s) + +h2:hover .header-link, +h3:hover .header-link, +h4:hover .header-link, +h5:hover .header-link, +h6:hover .header-link + opacity: 1 + + +.stuck + position: fixed + top: 20px diff --git a/doc/src/_sass/_mixins.scss b/doc/src/_sass/_mixins.scss new file mode 100644 index 0000000..642189f --- /dev/null +++ b/doc/src/_sass/_mixins.scss @@ -0,0 +1,62 @@ +@mixin box-shadow($shadow...) { + -webkit-box-shadow: $shadow; + -moz-box-shadow: $shadow; + box-shadow: $shadow; +} + +@mixin border-radius($radius...) { + -webkit-border-radius: $radius; + -moz-border-radius: $radius; + border-radius: $radius; +} + +@mixin border-top-left-radius($radius...) { + -webkit-border-top-left-radius: $radius; + -moz-border-radius-topleft: $radius; + border-top-left-radius: $radius; +} + +@mixin border-top-right-radius($radius...) { + -webkit-border-top-right-radius: $radius; + -moz-border-radius-topright: $radius; + border-top-right-radius: $radius; +} + +@mixin transition($transition...) { + -moz-transition: $transition; + -o-transition: $transition; + -webkit-transition: $transition; + transition: $transition; +} +@mixin transition-property($property...) { + -moz-transition-property: $property; + -o-transition-property: $property; + -webkit-transition-property: $property; + transition-property: $property; +} +@mixin transition-duration($duration...) { + -moz-transition-duration: $duration; + -o-transition-duration: $duration; + -webkit-transition-duration: $duration; + transition-duration: $duration; +} +@mixin transition-timing-function($timing...) { + -moz-transition-timing-function: $timing; + -o-transition-timing-function: $timing; + -webkit-transition-timing-function: $timing; + transition-timing-function: $timing; +} +@mixin transition-delay($delay...) { + -moz-transition-delay: $delay; + -o-transition-delay: $delay; + -webkit-transition-delay: $delay; + transition-delay: $delay; +} + +@mixin user-select($select...) { + -webkit-user-select: $select; /* Chrome all / Safari all */ + -moz-user-select: $select; /* Firefox all */ + -ms-user-select: $select; /* IE 10+ */ + -o-user-select: $select; + user-select: $select; +} diff --git a/doc/src/_sass/_navigation.sass b/doc/src/_sass/_navigation.sass new file mode 100644 index 0000000..54993e8 --- /dev/null +++ b/doc/src/_sass/_navigation.sass @@ -0,0 +1,64 @@ + +// Navigation +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +.site-header + background: $color-tertiary + border-bottom: .1rem solid $color-quaternary + display: block + height: 5.2rem + left: 0 + max-width: 100% + // position: fixed + right: 0 + top: 0 + width: 100% + z-index: 99 + padding: 0 + + // Re-overiding the width 100% declaration to match size of% based container + .container + padding-bottom: 0 + padding-top: 0 + + .icon + height: 3.8rem + vertical-align: middle + position: relative + + .title + color: $color-secondary + display: inline + vertical-align: middle + font-family: 'Gotham Rounded A', 'Gotham Rounded B', 'Helvetica Neue', Arial, sans-serif + font-size: 2.8rem + height: 5.2rem + padding: 0 + position: relative + text-decoration: none + +.navigation + + & > ul + list-style: none + margin-bottom: 0 + //margin-right: 5.0rem + + & > li + float: left + margin-bottom: 0 + margin-left: 2.5rem + position: relative + + & > ul > li > a + line-height: 5.2rem + + @media (min-width: 80.0rem) + margin-right: 0 + +aside + ul + padding-left: 0rem + li + margin-bottom: 0rem + list-style: none diff --git a/doc/src/_sass/_share.sass b/doc/src/_sass/_share.sass new file mode 100644 index 0000000..7969f69 --- /dev/null +++ b/doc/src/_sass/_share.sass @@ -0,0 +1,33 @@ + +// Share +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +.share, +.share-list, +.share-list a + position: relative + text-decoration: none + +.share-item + display: inline-block + margin: 1.0rem .1rem + +.share-dialog + background-color: $color-primary + border-radius: .4rem + color: $color-initial + display: block + height: 2.2rem + text-align: center + width: 5.0rem + + &:hover + background-color: $color-secondary + + .share-icon + fill: $color-initial + height: 1.5rem + +@media (min-width: 40.0rem) + .only-mobile + display: none diff --git a/doc/src/_sass/_wrapper.sass b/doc/src/_sass/_wrapper.sass new file mode 100644 index 0000000..cf5a5ba --- /dev/null +++ b/doc/src/_sass/_wrapper.sass @@ -0,0 +1,16 @@ + +// Wrapper +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +.wrapper + display: block + overflow: hidden + position: relative + width: 100% + + .container + max-width: 72.0rem + + & > .container + padding-bottom: 3rem + padding-top: 3rem diff --git a/doc/src/_sass/milligram/_Base.scss b/doc/src/_sass/milligram/_Base.scss new file mode 100644 index 0000000..0444161 --- /dev/null +++ b/doc/src/_sass/milligram/_Base.scss @@ -0,0 +1,29 @@ + +// Base +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +// The base font-size is set at 62.5% for having the convenience +// of sizing rems in a way that is similar to using px. 1.6rem=16px +html { + box-sizing: border-box; + font-size: 62.5%; +} + +// Default body styles +body { + color: $color-secondary; + font-family: 'Roboto', 'Helvetica Neue', 'Helvetica', 'Arial', sans-serif; + font-size: 1.6em; // currently ems cause chrome bug misinterpreting rems on body element + line-height: 1.6; + font-weight: 300; + text-shadow: 0 1px 3px rgba(0, 0, 0, 0.15); + overflow-y: scroll; + margin: 0px; +} + +// Set box-sizing globally to handle padding and border widths +*, +*:after, +*:before { + box-sizing: inherit; +} diff --git a/doc/src/_sass/milligram/_Blockquote.scss b/doc/src/_sass/milligram/_Blockquote.scss new file mode 100644 index 0000000..02962db --- /dev/null +++ b/doc/src/_sass/milligram/_Blockquote.scss @@ -0,0 +1,14 @@ + +// Blockquote +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +blockquote { + border-left: .3rem solid $color-quaternary; + margin-left: 0; + margin-right: 0; + padding: 1rem 1.5rem; + + & *:last-child { + margin: 0; + } +} diff --git a/doc/src/_sass/milligram/_Button.scss b/doc/src/_sass/milligram/_Button.scss new file mode 100644 index 0000000..64f9a41 --- /dev/null +++ b/doc/src/_sass/milligram/_Button.scss @@ -0,0 +1,90 @@ + +// Button +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +.button, +button, +input[type='button'], +input[type='reset'], +input[type='submit'] { + background-color: $color-primary; + border: .1rem solid $color-primary; + border-radius: .4rem; + color: $color-initial; + cursor: pointer; + display: inline-block; + font-size: 1.1rem; + font-weight: 700; + height: 3.8rem; + letter-spacing: .1rem; + line-height: 3.8rem; + padding: 0 3.0rem; + text-align: center; + text-decoration: none; + text-transform: uppercase; + white-space: nowrap; + + &:focus, + &:hover { + background-color: $color-secondary; + border-color: $color-secondary; + color: $color-initial; + outline: 0; + } + + &.button-disabled, + &[disabled] { + cursor: default; + opacity: .5; + + &:focus, + &:hover { + background-color: $color-primary; + border-color: $color-primary; + } + } + + &.button-outline { + background-color: transparent; + color: $color-primary; + + &:focus, + &:hover { + background-color: transparent; + border-color: $color-secondary; + color: $color-secondary; + } + + &.button-disabled, + &[disabled] { + + &:focus, + &:hover { + border-color: inherit; + color: $color-primary; + } + } + } + + &.button-clear { + background-color: transparent; + border-color: transparent; + color: $color-primary; + + &:focus, + &:hover { + background-color: transparent; + border-color: transparent; + color: $color-secondary; + } + + &.button-disabled, + &[disabled] { + + &:focus, + &:hover { + color: $color-primary; + } + } + } +} diff --git a/doc/src/_sass/milligram/_Code.scss b/doc/src/_sass/milligram/_Code.scss new file mode 100644 index 0000000..306354a --- /dev/null +++ b/doc/src/_sass/milligram/_Code.scss @@ -0,0 +1,26 @@ + +// Code +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +code { + background: $color-tertiary; + border-radius: .4rem; + font-size: 86%; + margin: 0 .2rem; + padding: .2rem .5rem; + white-space: nowrap; +} + +pre { + background: $color-tertiary; + border-left: .3rem solid $color-primary; + font-family: 'Menlo', 'Consolas', 'Bitstream Vera Sans Mono', 'DejaVu Sans Mono', 'Monaco', monospace; + + & > code { + background: transparent; + border-radius: 0; + display: block; + padding: 1rem 1.5rem; + white-space: pre; + } +} diff --git a/doc/src/_sass/milligram/_Color.scss b/doc/src/_sass/milligram/_Color.scss new file mode 100644 index 0000000..fbd3007 --- /dev/null +++ b/doc/src/_sass/milligram/_Color.scss @@ -0,0 +1,9 @@ + +// Color +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +$color-initial: #fff; +$color-primary: #00cccc; +$color-secondary: #606c76; +$color-tertiary: #f4f5f6; +$color-quaternary: #d1d1d1; diff --git a/doc/src/_sass/milligram/_Divider.scss b/doc/src/_sass/milligram/_Divider.scss new file mode 100644 index 0000000..2e4156e --- /dev/null +++ b/doc/src/_sass/milligram/_Divider.scss @@ -0,0 +1,10 @@ + +// Divider +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +hr { + border: 0; + border-top: .1rem solid $color-tertiary; + margin-bottom: 3.5rem; + margin-top: 3.0rem; +} diff --git a/doc/src/_sass/milligram/_Form.scss b/doc/src/_sass/milligram/_Form.scss new file mode 100644 index 0000000..5c1138e --- /dev/null +++ b/doc/src/_sass/milligram/_Form.scss @@ -0,0 +1,66 @@ + +// Form +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +input[type='email'], +input[type='number'], +input[type='password'], +input[type='search'], +input[type='tel'], +input[type='text'], +input[type='url'], +textarea, +select { + appearance: none; // Removes awkward default styles on some inputs for iOS + background-color: transparent; + border: .1rem solid $color-quaternary; + border-radius: .4rem; + box-shadow: none; + height: 3.8rem; + padding: .6rem 1.0rem; // The .6rem vertically centers text on FF, ignored by Webkit + width: 100%; + + &:focus { + border: .1rem solid $color-primary; + outline: 0; + } +} + +select { + background: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iMTQiIHZpZXdCb3g9IjAgMCAyOSAxNCIgd2lkdGg9IjI5Ij48cGF0aCBmaWxsPSIjZDFkMWQxIiBkPSJNOS40IDMuNmw1IDcgNS4yLTciLz48L3N2Zz4=) center right no-repeat; + padding: .6rem 3rem .6rem 1rem; + + &:focus { + background-image: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGhlaWdodD0iMTQiIHZpZXdCb3g9IjAgMCAyOSAxNCIgd2lkdGg9IjI5Ij48cGF0aCBmaWxsPSIjOWI0ZGNmIiBkPSJNMTkuNiAzLjZIOS40bDUgNyIvPjwvc3ZnPg==); + } +} + +textarea { + min-height: 6.5rem; + padding-bottom: .6rem; + padding-top: .6rem; +} + +label, +legend { + display: block; + font-size: 1.6rem; + font-weight: 700; + margin-bottom: .5rem; +} + +fieldset { + border-width: 0; + padding: 0; +} + +input[type='checkbox'], +input[type='radio'] { + display: inline; +} + +.label-inline { + display: inline-block; + font-weight: normal; + margin-left: .5rem; +} diff --git a/doc/src/_sass/milligram/_Grid.scss b/doc/src/_sass/milligram/_Grid.scss new file mode 100644 index 0000000..370cf99 --- /dev/null +++ b/doc/src/_sass/milligram/_Grid.scss @@ -0,0 +1,199 @@ + +// Grid +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +// .container is main centered wrapper with a max width of 112.0rem (1120px) +.container { + margin: 0 auto; + max-width: 112.0rem; + padding: 0 2.0rem; + position: relative; + width: 100%; +} + +// Using flexbox for the grid, inspired by Philip Walton: +// http://philipwalton.github.io/solved-by-flexbox/demos/grids/ +// By default each .column within a .row will evenly take up +// available width, and the height of each .column with take +// up the height of the tallest .column in the same .row +.row { + display: flex; + flex-direction: column; + padding: 0; + width: 100%; + + &.row-no-padding { + padding: 0; + + &> .column { + padding: 0; + } + + } + + &.row-wrap { + flex-wrap: wrap; + } + + // & + .row + // margin-top: -.5rem; + // padding-top: 0; + + // Vertically Align Columns + // .row-* vertically aligns every .col in the .row + &.row-top { + align-items: flex-start; + } + + &.row-bottom { + align-items: flex-end; + } + + &.row-center { + align-items: center; + } + + &.row-stretch { + align-items: stretch; + } + + &.row-baseline { + align-items: baseline; + } + + .column { + display: block; + flex: 1; + margin-left: 0; + max-width: 100%; + width: 100%; + + // .column-* vertically aligns an individual .column + .col-top { + align-self: flex-start; + } + + .col-bottom { + align-self: flex-end; + } + + .col-center { + align-self: center; + } + + // Column Offsets + &.column-offset-10 { + margin-left: 10%; + } + + &.column-offset-20 { + margin-left: 20%; + } + + &.column-offset-25 { + margin-left: 25%; + } + + &.column-offset-33, + &.column-offset-34 { + margin-left: 33.3333%; + } + + &.column-offset-50 { + margin-left: 50%; + } + + &.column-offset-66, + &.column-offset-67 { + margin-left: 66.6666%; + } + + &.column-offset-75 { + margin-left: 75%; + } + + &.column-offset-80 { + margin-left: 80%; + } + + &.column-offset-90 { + margin-left: 90%; + } + + // Explicit Column Percent Sizes + // By default each grid column will evenly distribute + // across the grid. However, you can specify individual + // columns to take up a certain size of the available area + &.column-10 { + flex: 0 0 10%; + max-width: 10%; + } + + &.column-20 { + flex: 0 0 20%; + max-width: 20%; + } + + &.column-25 { + flex: 0 0 25%; + max-width: 25%; + } + + &.column-33, + &.column-34 { + flex: 0 0 33.3333%; + max-width: 33.3333%; + } + + &.column-40 { + flex: 0 0 40%; + max-width: 40%; + } + + &.column-50 { + flex: 0 0 50%; + max-width: 50%; + } + + &.column-60 { + flex: 0 0 60%; + max-width: 60%; + } + + &.column-66, + &.column-67 { + flex: 0 0 66.6666%; + max-width: 66.6666%; + } + + &.column-75 { + flex: 0 0 75%; + max-width: 75%; + } + + &.column-80 { + flex: 0 0 80%; + max-width: 80%; + } + + &.column-90 { + flex: 0 0 90%; + max-width: 90%; + } + } +} + +// Larger than mobile screen +@media (min-width: 40.0rem) { + + .row { + flex-direction: row; + margin-left: -1.0rem; + width: calc(100% + 2.0rem); + + .column { + margin-bottom: inherit; + padding: 0 1.0rem; + } + } +} diff --git a/doc/src/_sass/milligram/_Image.scss b/doc/src/_sass/milligram/_Image.scss new file mode 100644 index 0000000..ac11496 --- /dev/null +++ b/doc/src/_sass/milligram/_Image.scss @@ -0,0 +1,7 @@ + +// Image +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +img { + max-width: 100%; +} diff --git a/doc/src/_sass/milligram/_Link.scss b/doc/src/_sass/milligram/_Link.scss new file mode 100644 index 0000000..5743a46 --- /dev/null +++ b/doc/src/_sass/milligram/_Link.scss @@ -0,0 +1,12 @@ + +// Link +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +a { + color: $color-primary; + text-decoration: none; + + &:hover { + color: $color-secondary; + } +} diff --git a/doc/src/_sass/milligram/_List.scss b/doc/src/_sass/milligram/_List.scss new file mode 100644 index 0000000..c091f4b --- /dev/null +++ b/doc/src/_sass/milligram/_List.scss @@ -0,0 +1,35 @@ + +// List +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +dl, +ol, +ul { + margin-top: 0; + padding-left: 2rem; + + dl, + ul, + ol { + font-size: 90%; + margin: 1.5rem 0 1.5rem 3.0rem; + } +} + +dl { + list-style: none; +} + +ul { + list-style: square; +} + +ol { + list-style: decimal; +} + +dt, +dd, +li { + //margin-bottom: 0.5rem; +} diff --git a/doc/src/_sass/milligram/_Spacing.scss b/doc/src/_sass/milligram/_Spacing.scss new file mode 100644 index 0000000..97a47c5 --- /dev/null +++ b/doc/src/_sass/milligram/_Spacing.scss @@ -0,0 +1,27 @@ + +// Spacing +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +.button, +button { + margin-bottom: 1.0rem; +} + +input, +textarea, +select, +fieldset { + margin-bottom: 1.5rem; +} + +pre, +blockquote, +dl, +figure, +table, +p, +ul, +ol, +form { + margin-bottom: 2.5rem; +} diff --git a/doc/src/_sass/milligram/_Table.scss b/doc/src/_sass/milligram/_Table.scss new file mode 100644 index 0000000..f07900e --- /dev/null +++ b/doc/src/_sass/milligram/_Table.scss @@ -0,0 +1,22 @@ + +// Table +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +table { + width: 100%; +} + +th, +td { + border-bottom: .1rem solid #e1e1e1; + padding: 1.2rem 1.5rem; + text-align: left; + + &:first-child { + padding-left: 0; + } + + &:last-child { + padding-right: 0; + } +} diff --git a/doc/src/_sass/milligram/_Typography.scss b/doc/src/_sass/milligram/_Typography.scss new file mode 100644 index 0000000..c7fa45f --- /dev/null +++ b/doc/src/_sass/milligram/_Typography.scss @@ -0,0 +1,82 @@ + +// Typography +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +p { + margin-top: 0; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + font-weight: 300; + margin-bottom: 2.0rem; + margin-top: 0; +} + +h1 { + font-size: 2.2rem; + letter-spacing: -.1rem; + line-height: 1.2; +} + +h2 { + font-size: 2.0rem; + letter-spacing: -.1rem; + line-height: 1.25; +} + +h3 { + font-size: 1.9rem; + letter-spacing: -.1rem; + line-height: 1.3; +} + +h4 { + font-size: 1.8rem; + letter-spacing: -.08rem; + line-height: 1.35; +} + +h5 { + font-size: 1.7rem; + letter-spacing: -.05rem; + line-height: 1.5; +} + +h6 { + font-size: 1.6rem; + letter-spacing: 0; + line-height: 1.4; +} + +// Larger than mobile screen +@media (min-width: 40.0rem) { + + h1 { + font-size: 3.0rem; + } + + h2 { + font-size: 2.6rem; + } + + h3 { + font-size: 2.4rem; + } + + h4 { + font-size: 2.2rem; + } + + h5 { + font-size: 2.0rem; + } + + h6 { + font-size: 1.8rem; + } +} diff --git a/doc/src/_sass/milligram/_Utility.scss b/doc/src/_sass/milligram/_Utility.scss new file mode 100644 index 0000000..6fcbe21 --- /dev/null +++ b/doc/src/_sass/milligram/_Utility.scss @@ -0,0 +1,27 @@ + +// Utility +// –––––––––––––––––––––––––––––––––––––––––––––––––– + +// Float either direction +.float-right { + float: right; +} + +.float-left { + float: left; +} + +// Clear a float with .clearfix +.clearfix { + *zoom: 1; + + &:after, + &:before { + content: ''; + display: table; + } + + &:after { + clear: both; + } +} diff --git a/doc/src/css/main.sass b/doc/src/css/main.sass new file mode 100644 index 0000000..d71954b --- /dev/null +++ b/doc/src/css/main.sass @@ -0,0 +1,30 @@ +--- + +--- + +@import 'milligram/Color' +@import 'milligram/Base' +@import 'milligram/Blockquote' +@import 'milligram/Button' +@import 'milligram/Code' +@import 'milligram/Divider' +@import 'milligram/Form' +@import 'milligram/Grid' +@import 'milligram/Link' +@import 'milligram/List' +@import 'milligram/Spacing' +@import 'milligram/Table' +@import 'milligram/Typography' +@import 'milligram/Image' +@import 'milligram/Utility' + +@import mixins +@import font +@import wrapper +@import header +@import misc +@import navigation +@import github +@import share +@import codehighlight +@import fa diff --git a/doc/src/css/themecreator.css b/doc/src/css/themecreator.css new file mode 100644 index 0000000..19fdc78 --- /dev/null +++ b/doc/src/css/themecreator.css @@ -0,0 +1,287 @@ +:root { + /* General */ + --foreground_color: #808080; + --background_color: #FFFFFF; + + /* Frame*/ + --frame_border_size: 6; + --frame_border_color: #808080; + + /* Input*/ + --input_line_background_color: #D0D0D0; + --input_line_font_size: 36; + --input_color: #808080; + --input_selection_background_color: #808080; + --input_selection_font_color: #FFFFFF; + + /* Settings*/ + --settings_button_color: #808080; + + /*Proposal list */ + --item_icon_size: 44; + --item_font_size: 26; + --item_height: 48; + --item_selected_color: #808080; + + /* Scrollbar*/ + --scrollbar_width: 5; + --scrollbar_color: #808080; + + /*Action list*/ + --action_list_height: 28; + --action_list_font_size: 20; + --action_list_selected_color: #808080; +} + +.wrapper { + overflow: initial; +} + +.welcome { + margin-top: 10px; +} + +@keyframes spin { + 0% { + -webkit-transform: rotate(0deg); + } + 100% { + -webkit-transform: rotate(360deg); + } +} + +#options { + display: none; + max-width: 640px; + margin: 25px auto; +} + +#options > div { + display: inline-block; + width: 49%; + vertical-align: top; +} + +#options > div h5 { + margin-bottom: 10px; +} + +#options label { + display: block; + padding: 2px; + font-weight: normal; + margin-bottom: 5px; + line-height: initial; +} + +#options label span { + display: inline-block; + width: 80%; +} + +#options input[type="color"] { + -webkit-appearance: none; + outline: none; + border: 0; + padding: 0; + background: transparent; + width: 17.3%; + vertical-align: middle; + margin-bottom: 0; + margin-left: -1.6px; + height: 38px; +} + +#options input[type="number"] { + display: inline-block; + width: 16%; + padding: 5px; + border-radius: 0; + text-align: left; + margin-bottom: 0; + color: #000; +} + +.theme { + margin: 0 auto; + max-width: 640px; + position: relative; +} + +.theme pre { + margin-top: 25px; + height: 200px; + overflow-y: scroll; + overflow-x: hidden; + border: 1px solid black; + width: 100%; +} + +.theme button { + position: absolute; + bottom: 7px; + right: 26px; +} + +#albert { + border: none; + display: none; + color: var(--foreground_color); + background-color: var(--background_color); + border-radius: 12px; + max-width: 640px; + margin: 0 auto; + line-height: initial; + font-family: SansSerif; + text-shadow: none; +} + +#resultsList { + position: relative; +} + +#resultsList ul { + list-style: none; + padding: 0; + margin: 10px 0 0 0; +} + +#resultsList ul .item { + width: 100%; + display: table; + height: calc(var(--item_height) * 1px); + -moz-box-sizing: border-box; + -webkit-box-sizing: border-box; + box-sizing: border-box; +} + +#resultsList ul .item .content { + display: table-cell; + vertical-align: middle; +} + +#resultsList ul .item.selected { + /* fade */ + background: var(--item_selected_color); +} + +#resultsList ul .item .icon { + display: table-cell; + text-align: center; + vertical-align: middle; + float: left; + margin: 0 auto; +} + +#resultsList ul .item .icon img { + width: calc(var(--item_icon_size) * 1px); + margin-right: 3px; + vertical-align: middle; +} + +#resultsList ul .item .description { + float: left; +} + +#resultsList ul .item .description p { + margin: 0; + color: var(--foreground_color); +} + +#resultsList ul .item .description .title { + font-size: calc(var(--item_font_size) * 1px); +} + +#resultsList ul .item .description .subtitle { + font-size: 12px; +} + +#frame { + -webkit-box-shadow: 0px 1px 5px 2px rgba(118, 118, 118, 0.54); + box-shadow: 0px 1px 5px 2px rgba(118, 118, 118, 0.54); + padding: 6px; + border-radius: 12px; + background-color: var(--background_color); + border: calc(var(--frame_border_size) * 1px) solid var(--frame_border_color); + min-width: 640px; + max-width: 640px; + position: relative; + display: block; + min-height: 187px; +} + +#inputLine { + background-color: var(--input_line_background_color); + color: var(--input_color); + border-radius: 2px; + padding: 3px; + font-size: calc(var(--input_line_font_size) * 1px); + outline: none; + border: none; + display: table-cell; + width: 100%; + -webkit-box-sizing: border-box; + -moz-box-sizing: border-box; + -o-box-sizing: border-box; + -ms-box-sizing: border-box; + box-sizing: border-box; + margin-bottom: 0; + height: initial; +} + +#inputLine::selection { + color: var(--input_selection_font_color); + background-color: var(--input_selection_background_color); +} + +#settingsButton { + background-color: var(--background_color); + padding: 4px; + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + position: absolute; + top: -5px; + right: -5px; +} + +#settingsButton svg { + display: block; + fill: var(--settings_button_color); + min-width: 13px; + min-height: 13px; + max-width: 13px; + max-height: 13px; + animation: spin 6s infinite linear; +} + +#actionList { + padding: 0; + margin: 0; + list-style: none; + text-align: center; + font-size: calc(var(--action_list_font_size) * 1px); + width: 100%; + display: table; +} + +#actionList li { + height: calc(var(--action_list_height) * 1px); + vertical-align: middle; + display: table-cell; +} + +#actionList li.selected { + /* fade */ + background: var(--action_list_selected_color); +} + +#scrollbar { + background: var(--scrollbar_color); + position: absolute; + top: 0; + right: 0; + width: calc(var(--scrollbar_width) * 1px); + height: 125px; + min-height: 24px; +} \ No newline at end of file diff --git a/doc/src/favicon.ico b/doc/src/favicon.ico new file mode 100644 index 0000000..2a6cc66 Binary files /dev/null and b/doc/src/favicon.ico differ diff --git a/doc/src/feed.xml b/doc/src/feed.xml new file mode 100644 index 0000000..86deb8d --- /dev/null +++ b/doc/src/feed.xml @@ -0,0 +1,22 @@ +--- +layout: null +--- + + + + Albert launcher news feed + Your latest Albert news + {{ site.url }} + {% for post in site.posts %} + {% unless post.draft %} + + {{ post.title | xml_escape }} + {{ post.content | xml_escape }} + {{ post.date | date_to_xmlschema }} + {{ post.url | prepend: site.url }} + {{ post.url | prepend: site.url }} + + {% endunless %} + {% endfor %} + + diff --git a/doc/src/fonts/FontAwesome.eot b/doc/src/fonts/FontAwesome.eot new file mode 100644 index 0000000..4f0b1de Binary files /dev/null and b/doc/src/fonts/FontAwesome.eot differ diff --git a/doc/src/fonts/FontAwesome.svg b/doc/src/fonts/FontAwesome.svg new file mode 100644 index 0000000..32ad8fb --- /dev/null +++ b/doc/src/fonts/FontAwesome.svg @@ -0,0 +1,12 @@ + + + +Generated by IcoMoon + + + + + + + + \ No newline at end of file diff --git a/doc/src/fonts/FontAwesome.ttf b/doc/src/fonts/FontAwesome.ttf new file mode 100644 index 0000000..47e2443 Binary files /dev/null and b/doc/src/fonts/FontAwesome.ttf differ diff --git a/doc/src/fonts/FontAwesome.woff b/doc/src/fonts/FontAwesome.woff new file mode 100644 index 0000000..bec5c4f Binary files /dev/null and b/doc/src/fonts/FontAwesome.woff differ diff --git a/doc/src/help.md b/doc/src/help.md new file mode 100644 index 0000000..f07e73a --- /dev/null +++ b/doc/src/help.md @@ -0,0 +1,22 @@ +--- +layout: page +title: Help +permalink: /help/ +--- + +Problems with Albert? Try these. + +##### [Documentation](/docs/) + +The documentation should cover everything you are concerned about. From a users point of view the user guide explains how to use Albert. Developers will find informations about the development of albert too. + +##### Chats + +- [Telegram](https://telegram.me/albert_launcher_community) +- [Discord](https://discord.gg/enGMWUG) +- [IRC](irc://irc.freenode.net/albertlauncher) / [(Web Client)](http://webchat.freenode.net?channels=%23albertlauncher) + + +##### [Github repository]({{ site.repository }}) + +If you wonder why Albert does this and that check out the source code to see how things work under the hood. If you think you encountered a bug, file an issue or check if somebody did already. diff --git a/doc/src/img/albert.svg b/doc/src/img/albert.svg new file mode 100644 index 0000000..059b7d6 --- /dev/null +++ b/doc/src/img/albert.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/doc/src/img/bitcoin.svg b/doc/src/img/bitcoin.svg new file mode 100644 index 0000000..a29a5de --- /dev/null +++ b/doc/src/img/bitcoin.svg @@ -0,0 +1,93 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + diff --git a/doc/src/img/patreon.png b/doc/src/img/patreon.png new file mode 100644 index 0000000..01f2db8 Binary files /dev/null and b/doc/src/img/patreon.png differ diff --git a/doc/src/img/qrcode.png b/doc/src/img/qrcode.png new file mode 100644 index 0000000..0700d1f Binary files /dev/null and b/doc/src/img/qrcode.png differ diff --git a/doc/src/img/themecreator/ic_amazon.svg b/doc/src/img/themecreator/ic_amazon.svg new file mode 100644 index 0000000..046e2f0 --- /dev/null +++ b/doc/src/img/themecreator/ic_amazon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/doc/src/img/themecreator/ic_google.svg b/doc/src/img/themecreator/ic_google.svg new file mode 100644 index 0000000..657c2a3 --- /dev/null +++ b/doc/src/img/themecreator/ic_google.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/doc/src/img/themecreator/ic_octocat.svg b/doc/src/img/themecreator/ic_octocat.svg new file mode 100644 index 0000000..5fa2ec5 --- /dev/null +++ b/doc/src/img/themecreator/ic_octocat.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/doc/src/img/themecreator/ic_youtube.svg b/doc/src/img/themecreator/ic_youtube.svg new file mode 100644 index 0000000..31a15c7 --- /dev/null +++ b/doc/src/img/themecreator/ic_youtube.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/doc/src/img/v0.10.jpg b/doc/src/img/v0.10.jpg new file mode 100644 index 0000000..d3117f3 Binary files /dev/null and b/doc/src/img/v0.10.jpg differ diff --git a/doc/src/index.md b/doc/src/index.md new file mode 100644 index 0000000..3ff31d6 --- /dev/null +++ b/doc/src/index.md @@ -0,0 +1,10 @@ +--- +layout: page +title: Work in progress +--- + +Access everything with virtually zero effort. Run applications, open files or their paths,
open bookmarks in your browser, search the web, calculate things and a lot more ... + +Albert is a desktop agnostic launcher. Its goals are usability and beauty,
performance and extensibility. It is written in C++ and based on the Qt framework. + +GPL-licensed, 100% free and open source. diff --git a/doc/src/js/themecreator/clipboard.min.js b/doc/src/js/themecreator/clipboard.min.js new file mode 100644 index 0000000..1d7c5d5 --- /dev/null +++ b/doc/src/js/themecreator/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v1.5.16 + * https://zenorocha.github.io/clipboard.js + * + * Licensed MIT © Zeno Rocha + */ +!function(e){if("object"==typeof exports&&"undefined"!=typeof module)module.exports=e();else if("function"==typeof define&&define.amd)define([],e);else{var t;t="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:this,t.Clipboard=e()}}(function(){var e,t,n;return function e(t,n,i){function o(a,c){if(!n[a]){if(!t[a]){var l="function"==typeof require&&require;if(!c&&l)return l(a,!0);if(r)return r(a,!0);var s=new Error("Cannot find module '"+a+"'");throw s.code="MODULE_NOT_FOUND",s}var u=n[a]={exports:{}};t[a][0].call(u.exports,function(e){var n=t[a][1][e];return o(n?n:e)},u,u.exports,e,t,n,i)}return n[a].exports}for(var r="function"==typeof require&&require,a=0;a0&&void 0!==arguments[0]?arguments[0]:{};this.action=t.action,this.emitter=t.emitter,this.target=t.target,this.text=t.text,this.trigger=t.trigger,this.selectedText=""}},{key:"initSelection",value:function e(){this.text?this.selectFake():this.target&&this.selectTarget()}},{key:"selectFake",value:function e(){var t=this,n="rtl"==document.documentElement.getAttribute("dir");this.removeFake(),this.fakeHandlerCallback=function(){return t.removeFake()},this.fakeHandler=document.body.addEventListener("click",this.fakeHandlerCallback)||!0,this.fakeElem=document.createElement("textarea"),this.fakeElem.style.fontSize="12pt",this.fakeElem.style.border="0",this.fakeElem.style.padding="0",this.fakeElem.style.margin="0",this.fakeElem.style.position="absolute",this.fakeElem.style[n?"right":"left"]="-9999px";var i=window.pageYOffset||document.documentElement.scrollTop;this.fakeElem.addEventListener("focus",window.scrollTo(0,i)),this.fakeElem.style.top=i+"px",this.fakeElem.setAttribute("readonly",""),this.fakeElem.value=this.text,document.body.appendChild(this.fakeElem),this.selectedText=(0,o.default)(this.fakeElem),this.copyText()}},{key:"removeFake",value:function e(){this.fakeHandler&&(document.body.removeEventListener("click",this.fakeHandlerCallback),this.fakeHandler=null,this.fakeHandlerCallback=null),this.fakeElem&&(document.body.removeChild(this.fakeElem),this.fakeElem=null)}},{key:"selectTarget",value:function e(){this.selectedText=(0,o.default)(this.target),this.copyText()}},{key:"copyText",value:function e(){var t=void 0;try{t=document.execCommand(this.action)}catch(e){t=!1}this.handleResult(t)}},{key:"handleResult",value:function e(t){this.emitter.emit(t?"success":"error",{action:this.action,text:this.selectedText,trigger:this.trigger,clearSelection:this.clearSelection.bind(this)})}},{key:"clearSelection",value:function e(){this.target&&this.target.blur(),window.getSelection().removeAllRanges()}},{key:"destroy",value:function e(){this.removeFake()}},{key:"action",set:function e(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"copy";if(this._action=t,"copy"!==this._action&&"cut"!==this._action)throw new Error('Invalid "action" value, use either "copy" or "cut"')},get:function e(){return this._action}},{key:"target",set:function e(t){if(void 0!==t){if(!t||"object"!==("undefined"==typeof t?"undefined":r(t))||1!==t.nodeType)throw new Error('Invalid "target" value, use a valid Element');if("copy"===this.action&&t.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if("cut"===this.action&&(t.hasAttribute("readonly")||t.hasAttribute("disabled")))throw new Error('Invalid "target" attribute. You can\'t cut text from elements with "readonly" or "disabled" attributes');this._target=t}},get:function e(){return this._target}}]),e}();e.exports=c})},{select:5}],8:[function(t,n,i){!function(o,r){if("function"==typeof e&&e.amd)e(["module","./clipboard-action","tiny-emitter","good-listener"],r);else if("undefined"!=typeof i)r(n,t("./clipboard-action"),t("tiny-emitter"),t("good-listener"));else{var a={exports:{}};r(a,o.clipboardAction,o.tinyEmitter,o.goodListener),o.clipboard=a.exports}}(this,function(e,t,n,i){"use strict";function o(e){return e&&e.__esModule?e:{default:e}}function r(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")}function a(e,t){if(!e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return!t||"object"!=typeof t&&"function"!=typeof t?e:t}function c(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Super expression must either be null or a function, not "+typeof t);e.prototype=Object.create(t&&t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}}),t&&(Object.setPrototypeOf?Object.setPrototypeOf(e,t):e.__proto__=t)}function l(e,t){var n="data-clipboard-"+e;if(t.hasAttribute(n))return t.getAttribute(n)}var s=o(t),u=o(n),f=o(i),d=function(){function e(e,t){for(var n=0;n0&&void 0!==arguments[0]?arguments[0]:{};this.action="function"==typeof t.action?t.action:this.defaultAction,this.target="function"==typeof t.target?t.target:this.defaultTarget,this.text="function"==typeof t.text?t.text:this.defaultText}},{key:"listenClick",value:function e(t){var n=this;this.listener=(0,f.default)(t,"click",function(e){return n.onClick(e)})}},{key:"onClick",value:function e(t){var n=t.delegateTarget||t.currentTarget;this.clipboardAction&&(this.clipboardAction=null),this.clipboardAction=new s.default({action:this.action(n),target:this.target(n),text:this.text(n),trigger:n,emitter:this})}},{key:"defaultAction",value:function e(t){return l("action",t)}},{key:"defaultTarget",value:function e(t){var n=l("target",t);if(n)return document.querySelector(n)}},{key:"defaultText",value:function e(t){return l("text",t)}},{key:"destroy",value:function e(){this.listener.destroy(),this.clipboardAction&&(this.clipboardAction.destroy(),this.clipboardAction=null)}}]),t}(u.default);e.exports=h})},{"./clipboard-action":7,"good-listener":4,"tiny-emitter":6}]},{},[8])(8)}); \ No newline at end of file diff --git a/doc/src/js/themecreator/generator.js b/doc/src/js/themecreator/generator.js new file mode 100644 index 0000000..aad3e47 --- /dev/null +++ b/doc/src/js/themecreator/generator.js @@ -0,0 +1,108 @@ +var themes, defaultTheme = "Bright"; + +main(); + +/** + * This is the begining. + */ +function main() { + initClipboard(); + loadThemes(function () { + // And finally display albert to the public + document.getElementById('albert').style.display = 'block'; + document.getElementById('options').style.display = 'block'; + }); + + // Get all inputs with the 'style' class and add an event listener + var inputs = [].slice.call(document.querySelectorAll('.style')); + inputs.forEach(function (input) { + input.addEventListener('input', function () { + updateTheme(input.name, input.value); + }); + }); +} + +/** + * Init the clipboard plugin. + */ +function initClipboard() { + var clipboard = new Clipboard(".theme button", { + text: function () { + return document.getElementById("result").innerText; + } + }); + + clipboard.on('success', function (e) { + var trigger = e.trigger, + original = trigger.innerHTML; + + trigger.innerHTML = "Copied!"; + setTimeout(function () { + trigger.innerHTML = original; + }, 1000); + }); +} + +function loadThemes(callback) { + var XmlHttpRequest = new XMLHttpRequest(); + XmlHttpRequest.overrideMimeType("application/json"); + XmlHttpRequest.open('GET', '../themes.json', true); + XmlHttpRequest.onreadystatechange = function () { + if (XmlHttpRequest.readyState == 4 && XmlHttpRequest.status == "200") { + themes = JSON.parse(XmlHttpRequest.responseText); + + // We set the first theme to be the base theme, since it's the default one in albert + for (var prop in themes[defaultTheme]) { + updateTheme(prop, themes[defaultTheme][prop]); + + var els = document.querySelectorAll("[name='" + prop + "']"); + for (var i = 0; i < els.length; i++) { + els[i].value = themes[defaultTheme][prop]; + } + } + + callback(); + } + } + XmlHttpRequest.send(null); +} + +/** + * Update the theme with the user's changes. + * + * @param el + */ +function updateTheme(propName, propValue) { + var original = propValue; + + if (propName == 'item_selected_color' || propName == 'action_list_selected_color') { + propValue = hexToRgbA(propValue, 0.2); + } + + // Update the style in realtime + document.documentElement.style.setProperty('--' + propName, propValue, ""); + + // Update the to be qss file + var els = document.querySelectorAll('.' + propName); + for (var i = 0; i < els.length; i++) { + original = original.replace(/#/g, ''); + els[i].innerHTML = original; + } +} + +/** + * + * @returns {string} + */ +function hexToRgbA(hex, transparency) { + var c; + if (/^#([A-Fa-f0-9]{3}){1,2}$/.test(hex)) { + c = hex.substring(1).split(''); + if (c.length == 3) { + c = [c[0], c[0], c[1], c[1], c[2], c[2]]; + } + c = '0x' + c.join(''); + return 'rgba(' + [(c >> 16) & 255, (c >> 8) & 255, c & 255].join(',') + ', ' + transparency + ')'; + } + throw new Error('Bad Hex'); +} \ No newline at end of file diff --git a/doc/src/news.html b/doc/src/news.html new file mode 100644 index 0000000..74d6829 --- /dev/null +++ b/doc/src/news.html @@ -0,0 +1,18 @@ +--- +layout: page +title: News +permalink: /news/ +--- + +{% for post in site.posts limit:4 %} + {% include news_item.html %} +{% endfor %} + +

All posts:

+
    + {% for post in site.posts %} +
  • {{ post.date | date_to_long_string }} {{ post.title }}
    • + {% endfor %} +
+ +Be up to date with the RSS feed diff --git a/include/albert/action.h b/include/albert/action.h new file mode 100644 index 0000000..9e9ad2f --- /dev/null +++ b/include/albert/action.h @@ -0,0 +1,26 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "core_globals.h" + +namespace Core { + +/** + * @brief The action interface + * A base class for actions (and items) + */ +class EXPORT_CORE Action +{ +public: + + virtual ~Action() {} + + /** The description of the action */ + virtual QString text() const = 0; + + /** Activates the item */ + virtual void activate() = 0; +}; + +} diff --git a/include/albert/core_globals.h b/include/albert/core_globals.h new file mode 100644 index 0000000..95ab7dd --- /dev/null +++ b/include/albert/core_globals.h @@ -0,0 +1,23 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once + +#if defined(_MSC_VER) + #define EXPORT __declspec(dllexport) + #define IMPORT __declspec(dllimport) +#elif defined(__GNUC__) + #define EXPORT __attribute__((visibility("default"))) + #define IMPORT +#else + #define EXPORT + #define IMPORT + #pragma warning Unknown dynamic link import/export semantics. +#endif + +#ifdef CORE + #define EXPORT_CORE EXPORT +#else + #define EXPORT_CORE IMPORT +#endif + +#include diff --git a/include/albert/extension.h b/include/albert/extension.h new file mode 100644 index 0000000..ce3b7e3 --- /dev/null +++ b/include/albert/extension.h @@ -0,0 +1,74 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "plugin.h" +#include "core_globals.h" + +#define ALBERT_EXTENSION_IID ALBERT_PLUGIN_IID_PREFIX".extensionv1-alpha" + +namespace Core { + +struct Private; +class ExtensionManager; +class QueryHandler; +class FallbackProvider; + +/** + * @brief The extension interface + */ +class EXPORT_CORE Extension : public Plugin +{ +public: + + Extension(const QString &id); + ~Extension(); + + /** + * @brief A human readable name of the plugin + * @return The human readable name + */ + virtual QString name() const = 0; + + /** + * @brief The settings widget factory + * This has to return the widget that is accessible to the user from the + * albert settings plugin tab. If the return value is a nullptr there will + * be no settings widget available in the settings. + * @return The settings widget + */ + virtual QWidget* widget(QWidget *parent = nullptr) = 0; + +protected: + + /** + * @brief registerFallbackProvider + */ + void registerQueryHandler(QueryHandler*); + + /** + * @brief unregisterFallbackProvider + */ + void unregisterQueryHandler(QueryHandler*); + + /** + * @brief registerFallbackProvider + */ + void registerFallbackProvider(FallbackProvider*); + + /** + * @brief unregisterFallbackProvider + */ + void unregisterFallbackProvider(FallbackProvider*); + +private: + + std::unique_ptr d; + + static ExtensionManager *extensionManager; + friend class ExtensionManager; + +}; + +} diff --git a/include/albert/fallbackprovider.h b/include/albert/fallbackprovider.h new file mode 100644 index 0000000..2c591dd --- /dev/null +++ b/include/albert/fallbackprovider.h @@ -0,0 +1,27 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include "core_globals.h" + +namespace Core { + +class Item; + +class EXPORT_CORE FallbackProvider +{ +public: + + virtual ~FallbackProvider() {} + + /** + * @brief Fallbacks + * This items show up if a query yields no results + */ + virtual std::vector> fallbacks(const QString &) = 0; + +}; + +} diff --git a/include/albert/frontend.h b/include/albert/frontend.h new file mode 100644 index 0000000..60dda9a --- /dev/null +++ b/include/albert/frontend.h @@ -0,0 +1,42 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include "plugin.h" +#include "core_globals.h" + +class QAbstractItemModel; + +#define ALBERT_FRONTEND_IID ALBERT_PLUGIN_IID_PREFIX".frontendv1-alpha" + +namespace Core { + +class EXPORT_CORE Frontend : public Plugin +{ + Q_OBJECT + +public: + + Frontend(const QString &id) : Plugin(id) {} + + virtual bool isVisible() = 0; + virtual void setVisible(bool visible = true) = 0; + + virtual QString input() = 0; + virtual void setInput(const QString&) = 0; + + virtual void setModel(QAbstractItemModel *) = 0; + + virtual QWidget *widget(QWidget *parent) = 0; + + void toggleVisibility() { setVisible(!isVisible()); } + +signals: + + void widgetShown(); + void widgetHidden(); + void inputChanged(QString qry); + void settingsWidgetRequested(); + +}; + +} diff --git a/include/albert/indexable.h b/include/albert/indexable.h new file mode 100644 index 0000000..75d50c3 --- /dev/null +++ b/include/albert/indexable.h @@ -0,0 +1,31 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "item.h" +#include "core_globals.h" + +namespace Core { + +/** + * @brief The Indexable class + * The interface items need to be indexable by the offline index + */ +class EXPORT_CORE IndexableItem : public Item +{ + +public: + + struct IndexString { + IndexString(const QString& str, uint32_t rel) : string(str), relevance(rel){} + QString string; + uint32_t relevance; + }; + + virtual std::vector indexStrings() const = 0; + +}; + +} + diff --git a/include/albert/item.h b/include/albert/item.h new file mode 100644 index 0000000..5ed8e07 --- /dev/null +++ b/include/albert/item.h @@ -0,0 +1,54 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include "core_globals.h" + +namespace Core { + +class Action; + +/** **************************************************************************** + * @brief The item interface + * Subclass this class to make your object displayable in the results list. + */ +class EXPORT_CORE Item +{ + +public: + + /** + * An enumeration of urgency levels + * Notifications are placed on top. Alert too but additionally get an visual + * emphasis. Normal items are not handled in a special way. + */ + enum class Urgency { Normal, Notification, Alert }; + + virtual ~Item() {} + + /** An persistant, extensionwide unique identifier, "" if item is dynamic */ + virtual QString id() const = 0; + + /** The icon for the item */ + virtual QString iconPath() const = 0; + + /** The title for the item */ + virtual QString text() const = 0; + + /** The declarative subtext for the item */ + virtual QString subtext() const = 0; + + /** The string to use for completion */ + virtual QString completion() const { return text(); } + + /** Urgency level of the item, defautls to "Normal" */ + virtual Urgency urgency() const { return Urgency::Normal; } + + /** The alternative actions of the item*/ + virtual std::vector> actions() = 0; + +}; + +} diff --git a/include/albert/plugin.h b/include/albert/plugin.h new file mode 100644 index 0000000..0d32575 --- /dev/null +++ b/include/albert/plugin.h @@ -0,0 +1,70 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include +#include "core_globals.h" + +#define ALBERT_PLUGIN_IID_PREFIX "org.albert.pluginv1-alpha" + +namespace Core { + +class PluginPrivate; + +class EXPORT_CORE Plugin : public QObject +{ + Q_OBJECT + +public: + + Plugin(const QString &id); + ~Plugin(); + + /** + * @brief id + * This is the global unique identifier of the plugin + * @return + */ + const QString &id() const; + + /** + * @brief cacheLocation + * @return The recommended cache location for the plugin. + * @note If the dir does not exist it will be crated. + */ + QDir cacheLocation() const; + + /** + * @brief configLocation + * @return The recommended config location for the plugin. + * @note If the dir does not exist it will be crated. + */ + QDir configLocation() const; + + /** + * @brief dataLocation + * @return The recommended data location for the plugin + * @note If the dir does not exist it will be crated. + */ + QDir dataLocation() const; + + /** + * @brief settings + * This is a convenience function returning the default settings object for this plugin. It is + * located in the config location defined in this plugin and has the basename "config". Note + * that QSettings is not thread-safe, so if you want to access the settings concurrently you + * should create a new instance with the path of this object. + * @return The settings object + */ + QSettings &settings() const; + +private: + + std::unique_ptr d; + +}; + +} diff --git a/include/albert/query.h b/include/albert/query.h new file mode 100644 index 0000000..c2edd62 --- /dev/null +++ b/include/albert/query.h @@ -0,0 +1,113 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include +#include +#include "core_globals.h" + + +namespace Core { + +class QueryPrivate; +class Item; + +/** + * @brief The Query class + * Represents a query to be handled by the query handlers + */ +class EXPORT_CORE Query final +{ +public: + + /** + * @brief The query string. + * This is the processed query string relevant for most of the handlers. If the raw query string + * is prefixed by a trigger string() returns the query string without the the trigger + * prefix. If there is no trigger string() is equivalent to rawString(). + */ + const QString &string() const; + + /** + * @brief The raw query string. + * This is the raw query string as the users entered it into the input line. + */ + const QString &rawString() const; + + /** + * @brief Indicates a triggered query. + */ + bool isTriggered() const; + + /** + * @brief The trigger of this query + * Note that if the trigger is set, string() differs from rawString(). + */ + const QString &trigger() const; + + /** + * @brief The validity of the query + * If the core cancelled the query for some reason the query gets invalid. Stop handling the + * query if it is not valid anymore to save resources for other queries. + * @return True if valid, else false. + */ + bool isValid() const; + + /** + * @brief addMatch + * Use the addMatches if you have a lot of items to add. + * @param item The to add to the results + * @param score The relevance factor (UINT_MAX -> 1) + * @see addMatches + */ + template + void addMatch(T&& item, uint score = 0) { + if ( isValid_ ) { + mutex_.lock(); + addMatchWithoutLock(std::forward(item), score); + mutex_.unlock(); + } + } + + /** + * @brief addMatches + * Cumulative addMatch function avoiding excessive mutex locking the results + * @param begin + * @param end + */ + template + void addMatches(Iterator begin, Iterator end) { + if ( isValid() ) { + mutex_.lock(); + for (; begin != end; ++begin) + // Must not use operator->() !!! dereferencing a pointer returns an lvalue + addMatchWithoutLock((*begin).first, (*begin).second); + mutex_.unlock(); + } + } + +private: + + void addMatchWithoutLock(const std::shared_ptr &item, uint score); + void addMatchWithoutLock(std::shared_ptr &&item, uint score); + + Query() = default; + ~Query() = default; + + std::vector, uint>> results_; + QMutex mutex_; + QString trigger_; + QString string_; + QString rawString_; + bool isValid_ = true; + std::map scores_; + + friend class QueryExecution; +}; + +} + + diff --git a/include/albert/queryhandler.h b/include/albert/queryhandler.h new file mode 100644 index 0000000..184f7cf --- /dev/null +++ b/include/albert/queryhandler.h @@ -0,0 +1,82 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "query.h" +#include "core_globals.h" + +namespace Core { + +class Query; + +class EXPORT_CORE QueryHandler +{ +public: + + QueryHandler(QString id) : id(id) {} + virtual ~QueryHandler() {} + + const QString id; + + /** + * @brief The triggers that makes the plugin beeing run exclusice + */ + virtual QStringList triggers() const { return QStringList(); } + + /** + * @brief The ExecutionType enum + * The execution type of a queryhandler determines the way the handler is run. Batch handlers + * are runned first. Query results are not displayed until all batch handlers finished. When all + * batch handlers finished the results are sorted and displayed. Batched handlers can be + * triggered or not. + * Realtime handlers are started and the model of the results is shown instantly. The results of + * the realtime handlers are not sorted and displayed instantly (well they are buffered for 50 + * ms). Realtime handler must have triggers otherwise they will never be started. + */ + enum class ExecutionType { Batch, Realtime }; + + /** + * @brief executionType + * @return The execution type of the queryhandler + * @see ExecutionType + */ + virtual ExecutionType executionType() const { return ExecutionType::Batch; } + + /** + * @brief Session setup + * Called when the users started a session, i.e. before the the main window + * is shown. Setup session stage has to be finished before the actual query + * handling will begin so do not do any long running jobs in here. If you + * really have to, do it asynchonous or threaded (only recommended if you + * know what you do). + */ + virtual void setupSession() {} + + /** + * @brief Session teardown + * Called when the user finshed a session, i.e. after the the main window + * has been hidden. Although the app is hidden now this method should not + * block since the user may want start another session immediately. + * @see setupSession + */ + virtual void teardownSession() {} + + /** + * @brief Query handling + * This method is called for every user input. Add the results to the query + * passed as parameter. The results are sorted by usage. After 100 ms + * they are just appended to not disturb the users interaction. Queries can + * get invalidated so make sure to regularly check isValid() to cancel + * long running operations. This method is called in a thread without event + * loop, be aware of the consequences (especially regarding signal/slot + * mechanism). + * Note that this method may run simultaneously in separate threads make + * sure that everything mutable you touch is threadsafe. + * @param query Holds the query context + */ + virtual void handleQuery(Query *query) const = 0; + +}; + +} diff --git a/include/albert/util/history.h b/include/albert/util/history.h new file mode 100644 index 0000000..6953615 --- /dev/null +++ b/include/albert/util/history.h @@ -0,0 +1,30 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "../core_globals.h" + +namespace Core { + +class EXPORT_CORE History final : public QObject +{ + Q_OBJECT + +public: + + History(QObject *parent = nullptr); + + Q_INVOKABLE void add(QString str); + Q_INVOKABLE QString next(const QString &substring = QString{}); + Q_INVOKABLE QString prev(const QString &substring = QString{}); + Q_INVOKABLE void resetIterator(); + +private: + + QStringList lines_; + int currentLine_; + +}; + +} diff --git a/include/albert/util/itemroles.h b/include/albert/util/itemroles.h new file mode 100644 index 0000000..0024b9e --- /dev/null +++ b/include/albert/util/itemroles.h @@ -0,0 +1,18 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include + +namespace Core { + +enum ItemRoles { + TextRole = 0, + ToolTipRole, + DecorationRole, + CompletionRole = Qt::UserRole, // Note this is used as int in QML + ActionRole, + AltActionRole, + FallbackRole +}; + +} diff --git a/include/albert/util/offlineindex.h b/include/albert/util/offlineindex.h new file mode 100644 index 0000000..1ab4d61 --- /dev/null +++ b/include/albert/util/offlineindex.h @@ -0,0 +1,90 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include "../core_globals.h" + +namespace Core { + +class SearchBase; +class IndexableItem; + +class EXPORT_CORE OfflineIndex final { + +public: + + /** + * @brief Contstructs a search + * @param fuzzy Sets the type of the search. Defaults to false. + */ + OfflineIndex(bool fuzzy = false); + OfflineIndex(const OfflineIndex &other) = delete; + OfflineIndex(OfflineIndex &&other); + OfflineIndex &operator=(const OfflineIndex & other) = delete; + OfflineIndex &operator=(OfflineIndex && other); + + /** + * @brief Destructs the search + * @param + */ + ~OfflineIndex(); + + /** + * @brief Sets the type of the search to fuzzy + * @param fuzzy The type to set. Defaults to true. + */ + void setFuzzy(bool fuzzy = true); + + /** + * @brief Type of the search + * @return True if the search is fuzzy else false. + */ + bool fuzzy(); + + /** + * @brief Set the error tolerance of the fuzzy search + * + * If the value d is >1, the search tolerates d errors. If the value d is <1, + * the search tolerates wordlength * d errors. The "amount of tolerance" is + * measures in maximal prefix edit distance. If the search is not set to fuzzy + * setDelta has no effect. + * + * @param t The amount of error tolerance + */ + void setDelta(double d); + + /** + * @brief The error tolerance of the fuzzy search + * @return The amount of error tolerance if search is fuzzy 0 else. + */ + double delta(); + + /** + * @brief Build the search index + * @param The items to index + */ + void add(const std::shared_ptr &idxble); + + /** + * @brief Clear the search index + */ + void clear(); + + /** + * @brief Perform a search on the index + * @param req The query string + */ + std::vector> search(const QString &req) const; + +private: + + std::unique_ptr impl_; + +}; + +} + + + diff --git a/include/albert/util/shutil.h b/include/albert/util/shutil.h new file mode 100644 index 0000000..506fbce --- /dev/null +++ b/include/albert/util/shutil.h @@ -0,0 +1,16 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "../core_globals.h" + +namespace Core { +namespace ShUtil { + +EXPORT_CORE QString quote(QString input); +EXPORT_CORE QStringList split(const QString &input); + +} +} + diff --git a/include/albert/util/standardactions.h b/include/albert/util/standardactions.h new file mode 100644 index 0000000..f384802 --- /dev/null +++ b/include/albert/util/standardactions.h @@ -0,0 +1,108 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "albert/action.h" +#include "../core_globals.h" + +namespace Core { + + +//! @brief Base class for standard actions +struct EXPORT_CORE StandardActionBase : public Action +{ +public: + StandardActionBase(const QString &text); + QString text() const override; + +private: + QString text_; +}; + + + +//! @brief A standard action holding a std::function +struct EXPORT_CORE FuncAction : public StandardActionBase +{ +public: + FuncAction(const QString &text, std::function action); + void activate() override; + +private: + std::function action_; +}; + + + +// A standard action that copies text into the clipboard +struct EXPORT_CORE ClipAction : public StandardActionBase +{ +public: + ClipAction(const QString &text, QString clipBoardText); + void activate() override; + +private: + QString clipBoardText_; +}; + + + +// A standard action that opens an url using QDesktopServices +struct EXPORT_CORE UrlAction : public StandardActionBase +{ +public: + UrlAction(const QString &text, QUrl url); + void activate() override; + +private: + QUrl url_ ; +}; + + + +// A standard action that starts a process +struct EXPORT_CORE ProcAction : public StandardActionBase +{ +public: + ProcAction(const QString &text, const QStringList &commandline, const QString &workingDirectory = QString()); + void activate() override; + +protected: + QStringList commandline_; + QString workingDir_; +}; + + + +// A standard action that runs commands in a terminal +struct EXPORT_CORE TermAction : public ProcAction +{ + enum class CloseBehavior { + CloseOnSuccess, + CloseOnExit, + DoNotClose + }; + +public: + + /** + * @brief TermAction constructor + * @param text The description of the action + * @param commandline The command to execute + * @param workingDirectory The working directory where to run the command + * @param shell Should the command be wrapped in a shell? + * @param behavior The close behavior when using the shell + */ + TermAction(const QString &text, const QStringList &commandline, const QString &workingDirectory = QString(), + bool shell = true, CloseBehavior behavior = CloseBehavior::CloseOnSuccess); + void activate() override; + +private: + bool shell_; + CloseBehavior behavior_; +}; + + + +} diff --git a/include/albert/util/standardindexitem.h b/include/albert/util/standardindexitem.h new file mode 100644 index 0000000..ee7b701 --- /dev/null +++ b/include/albert/util/standardindexitem.h @@ -0,0 +1,67 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "standarditem.h" +#include "albert/indexable.h" + +namespace Core { + +/** +* @brief A standard index item for use with the offline index +* If you dont need the flexibility subclassing the abstract classes provided, +* you can simply use this container, fill it with data. +*/ +class EXPORT_CORE StandardIndexItem final : public IndexableItem +{ +public: + + StandardIndexItem(QString id = QString(), + QString iconPath = QString(), + QString text = QString(), + QString subtext = QString(), + QString completion = QString(), + Urgency urgency = Item::Urgency::Normal, + std::vector> actions = std::vector>(), + std::vector indexStrings = std::vector()); + + QString id() const override; + void setId(QString id); + + QString iconPath() const override; + void setIconPath(QString iconPath); + + QString text() const override; + void setText(QString text); + + QString subtext() const override; + void setSubtext(QString subtext); + + QString completion() const override; + void setCompletion(QString completion); + + Item::Urgency urgency() const override; + void setUrgency(Item::Urgency urgency); + + std::vector> actions() override; + void setActions(std::vector> actions); + void addAction(std::shared_ptr action); + + virtual std::vector indexStrings() const override; + void setIndexKeywords(std::vector indexStrings); + + +protected: + + QString id_; + QString iconPath_; + QString text_; + QString subtext_; + QString completion_; + Item::Urgency urgency_; + std::vector> actions_; + std::vector indexStrings_; + +}; + +} diff --git a/include/albert/util/standarditem.h b/include/albert/util/standarditem.h new file mode 100644 index 0000000..a488b98 --- /dev/null +++ b/include/albert/util/standarditem.h @@ -0,0 +1,66 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include "albert/item.h" + +namespace Core { + +class Action; + +/** +* @brief A standard item +* If you dont need the flexibility subclassing the abstract classes provided, +* you can simply use this container, fill it with data. +*/ +class EXPORT_CORE StandardItem : public Item +{ +public: + + StandardItem(QString id = QString(), + QString iconPath = QString(), + QString text = QString(), + QString subtext = QString(), + QString completion = QString(), + Urgency urgency = Item::Urgency::Normal, + std::vector> actions = std::vector>()); + + QString id() const override; + void setId(QString id); + + QString iconPath() const override; + void setIconPath(QString iconPath); + + QString text() const override; + void setText(QString text); + + QString subtext() const override; + void setSubtext(QString subtext); + + QString completion() const override; + void setCompletion(QString completion); + + Item::Urgency urgency() const override; + void setUrgency(Item::Urgency urgency); + + std::vector> actions() override; + void setActions(std::vector> &&actions); + void setActions(const std::vector> &actions); + void addAction(std::shared_ptr &&action); + void addAction(const std::shared_ptr &action); + +protected: + + QString id_; + QString iconPath_; + QString text_; + QString subtext_; + QString completion_; + Item::Urgency urgency_; + std::vector> actions_; + +}; + +} diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt new file mode 100644 index 0000000..af67f5e --- /dev/null +++ b/lib/CMakeLists.txt @@ -0,0 +1,7 @@ +# Do not export symbols by default +set(CMAKE_CXX_VISIBILITY_PRESET hidden) +set(CMAKE_VISIBILITY_INLINES_HIDDEN 1) + +add_subdirectory(albertcore) +add_subdirectory(xdg) +add_subdirectory(globalshortcut) diff --git a/lib/globalshortcut/CMakeLists.txt b/lib/globalshortcut/CMakeLists.txt new file mode 100644 index 0000000..59eac09 --- /dev/null +++ b/lib/globalshortcut/CMakeLists.txt @@ -0,0 +1,37 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(globalshortcut) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Gui) + +set(SRC + include/globalshortcut/globalshortcut_globals.h + include/globalshortcut/hotkeymanager.h + src/hotkeymanager.cpp +) + +set(LIB Qt5::Gui) + +if(${CMAKE_SYSTEM_NAME} MATCHES "Linux") + find_package(Qt5 5.5.0 REQUIRED X11Extras) + set(SRC ${SRC} src/hotkeymanager_x11.cpp) + set(LIB ${LIB} Qt5::X11Extras X11) +elseif(${CMAKE_SYSTEM_NAME} MATCHES "Windows") + set(SRC ${SRC} src/hotkey/hotkeymanager_win.cpp) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DUNICODE") +endif() + +add_library(${PROJECT_NAME} STATIC ${SRC}) + +target_compile_definitions(${PROJECT_NAME} PRIVATE -DGLOBALSHORTCUT) #export branch + +target_include_directories(${PROJECT_NAME} + PUBLIC + include + PRIVATE + include/globalshortcut + src +) + +target_link_libraries(${PROJECT_NAME} PRIVATE ${LIB}) + diff --git a/lib/globalshortcut/include/globalshortcut/globalshortcut_globals.h b/lib/globalshortcut/include/globalshortcut/globalshortcut_globals.h new file mode 100644 index 0000000..f38ea38 --- /dev/null +++ b/lib/globalshortcut/include/globalshortcut/globalshortcut_globals.h @@ -0,0 +1,21 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once + +#if defined(_MSC_VER) + #define EXPORT __declspec(dllexport) + #define IMPORT __declspec(dllimport) +#elif defined(__GNUC__) + #define EXPORT __attribute__((visibility("default"))) + #define IMPORT +#else + #define EXPORT + #define IMPORT + #pragma warning Unknown dynamic link import/export semantics. +#endif + +#ifdef GLOBALSHORTCUT + #define EXPORT_GLOBALSHORTCUT EXPORT +#else + #define EXPORT_GLOBALSHORTCUT IMPORT +#endif diff --git a/lib/globalshortcut/include/globalshortcut/hotkeymanager.h b/lib/globalshortcut/include/globalshortcut/hotkeymanager.h new file mode 100644 index 0000000..fca0dcd --- /dev/null +++ b/lib/globalshortcut/include/globalshortcut/hotkeymanager.h @@ -0,0 +1,45 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include "globalshortcut_globals.h" + +namespace GlobalShortcut { + +class HotkeyManagerPrivate; + +class EXPORT_GLOBALSHORTCUT HotkeyManager final : public QObject +{ + Q_OBJECT + +public: + HotkeyManager(QObject *parent = 0); + ~HotkeyManager(); + + bool registerHotkey(const QString&); + bool registerHotkey(const QKeySequence&); + bool registerHotkey(const int); + bool unregisterHotkey(const QString&); + bool unregisterHotkey(const QKeySequence&); + void unregisterHotkey(const int); + QSet hotkeys() {return hotkeys_;} + void enable(){ setEnabled(true); } + void disable(){ setEnabled(false); } + void setEnabled(bool enabled = true){enabled_ = enabled;} + bool isEnabled() const {return enabled_;} + +private: + void onHotkeyPressed(); + + bool enabled_; + QSet hotkeys_; + + std::unique_ptr d; + +signals: + void hotKeyPressed(); +}; + +} diff --git a/lib/globalshortcut/src/hotkeymanager.cpp b/lib/globalshortcut/src/hotkeymanager.cpp new file mode 100644 index 0000000..0245e67 --- /dev/null +++ b/lib/globalshortcut/src/hotkeymanager.cpp @@ -0,0 +1,73 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "globalshortcut/hotkeymanager.h" +#if defined __linux__ +#include "hotkeymanager_x11.h" +#elif defined __APPLE__ +#elif defined _WIN32 +#include "hotkeymanager_win.h" +#endif +#include + +/** ***************************************************************************/ +GlobalShortcut::HotkeyManager::HotkeyManager(QObject *parent) : + QObject(parent), d(new HotkeyManagerPrivate) { + connect(d.get(), &HotkeyManagerPrivate::hotKeyPressed, this, &HotkeyManager::onHotkeyPressed); + enabled_ = true; +} + +/** ***************************************************************************/ +GlobalShortcut::HotkeyManager::~HotkeyManager() { + +} + +/** ***************************************************************************/ +bool GlobalShortcut::HotkeyManager::registerHotkey(const QString &hk) { + return registerHotkey(QKeySequence(hk)); +} + +/** ***************************************************************************/ +bool GlobalShortcut::HotkeyManager::registerHotkey(const QKeySequence &hk) { + if (hk.count() != 1) + return false; + return registerHotkey(hk[0]); +} + +/** ***************************************************************************/ +bool GlobalShortcut::HotkeyManager::registerHotkey(const int hk) { + if (hotkeys_.contains(hk)) + return true; + if (d->registerNativeHotkey(hk)) { + hotkeys_.insert(hk); + return true; + } + return false; +} + +/** ***************************************************************************/ +bool GlobalShortcut::HotkeyManager::unregisterHotkey(const QString &hk) { + return unregisterHotkey(QKeySequence(hk)); +} + +/** ***************************************************************************/ +bool GlobalShortcut::HotkeyManager::unregisterHotkey(const QKeySequence &hk) { + if (hk.count() != 1) + return false; + unregisterHotkey(hk[0]); + return true; +} + +/** ***************************************************************************/ +void GlobalShortcut::HotkeyManager::unregisterHotkey(const int hk) { + if (!hotkeys_.contains(hk)) + return; + d->unregisterNativeHotkey(hk); + hotkeys_.remove(hk); +} + +/** ***************************************************************************/ +void GlobalShortcut::HotkeyManager::onHotkeyPressed() { + if (enabled_) + emit hotKeyPressed(); +} + diff --git a/lib/globalshortcut/src/hotkeymanager_win.cpp b/lib/globalshortcut/src/hotkeymanager_win.cpp new file mode 100644 index 0000000..4bf7a5b --- /dev/null +++ b/lib/globalshortcut/src/hotkeymanager_win.cpp @@ -0,0 +1,206 @@ +// albert - a simple application launcher for linux +// Copyright (C) 2014 Manuel Schneider +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +#include "hotkeymanager_win.h" +#include "windows.h" + +namespace { + +static int sid = 0; +QSet sGrabbedIds; + +struct Qt_VK_Keymap +{ + int key; + UINT vk; +}; + +static Qt_VK_Keymap Qt_VK_table[] = { // TODO make this hold groups too e.g. META r+l + { Qt::Key_Escape, VK_ESCAPE }, + { Qt::Key_Tab, VK_TAB }, + { Qt::Key_Backtab, 0 }, + { Qt::Key_Backspace, VK_BACK }, + { Qt::Key_Return, VK_RETURN }, + { Qt::Key_Enter, VK_RETURN }, + { Qt::Key_Insert, VK_INSERT }, + { Qt::Key_Delete, VK_DELETE }, + { Qt::Key_Pause, VK_PAUSE }, + { Qt::Key_Print, VK_SNAPSHOT }, + { Qt::Key_SysReq, 0 }, + { Qt::Key_Clear, VK_CLEAR }, + { Qt::Key_Home, VK_HOME }, + { Qt::Key_End, VK_END }, + { Qt::Key_Left, VK_LEFT }, + { Qt::Key_Up, VK_UP }, + { Qt::Key_Right, VK_RIGHT }, + { Qt::Key_Down, VK_DOWN }, + { Qt::Key_PageUp, VK_PRIOR }, + { Qt::Key_PageDown, VK_NEXT }, + { Qt::Key_Shift, VK_SHIFT }, + { Qt::Key_Control, VK_CONTROL }, + { Qt::Key_Meta, VK_LWIN }, + { Qt::Key_Alt, VK_MENU }, + { Qt::Key_CapsLock, VK_CAPITAL }, + { Qt::Key_NumLock, VK_NUMLOCK }, + { Qt::Key_ScrollLock, VK_SCROLL }, + { Qt::Key_F1, VK_F1 }, + { Qt::Key_F2, VK_F2 }, + { Qt::Key_F3, VK_F3 }, + { Qt::Key_F4, VK_F4 }, + { Qt::Key_F5, VK_F5 }, + { Qt::Key_F6, VK_F6 }, + { Qt::Key_F7, VK_F7 }, + { Qt::Key_F8, VK_F8 }, + { Qt::Key_F9, VK_F9 }, + { Qt::Key_F10, VK_F10 }, + { Qt::Key_F11, VK_F11 }, + { Qt::Key_F12, VK_F12 }, + { Qt::Key_F13, VK_F13 }, + { Qt::Key_F14, VK_F14 }, + { Qt::Key_F15, VK_F15 }, + { Qt::Key_F16, VK_F16 }, + { Qt::Key_F17, VK_F17 }, + { Qt::Key_F18, VK_F18 }, + { Qt::Key_F19, VK_F19 }, + { Qt::Key_F20, VK_F20 }, + { Qt::Key_F21, VK_F21 }, + { Qt::Key_F22, VK_F22 }, + { Qt::Key_F23, VK_F23 }, + { Qt::Key_F24, VK_F24 }, + { Qt::Key_F25, 0 }, + { Qt::Key_F26, 0 }, + { Qt::Key_F27, 0 }, + { Qt::Key_F28, 0 }, + { Qt::Key_F29, 0 }, + { Qt::Key_F30, 0 }, + { Qt::Key_F31, 0 }, + { Qt::Key_F32, 0 }, + { Qt::Key_F33, 0 }, + { Qt::Key_F34, 0 }, + { Qt::Key_F35, 0 }, + { Qt::Key_Super_L, 0 }, + { Qt::Key_Super_R, 0 }, + { Qt::Key_Menu, 0 }, + { Qt::Key_Hyper_L, 0 }, + { Qt::Key_Hyper_R, 0 }, + { Qt::Key_Help, 0 }, + { Qt::Key_Direction_L, 0 }, + { Qt::Key_Direction_R, 0 }, + + { Qt::Key_QuoteLeft, VK_OEM_8 }, + { Qt::Key_Minus, VK_OEM_MINUS }, + { Qt::Key_Equal, VK_OEM_PLUS }, + + { Qt::Key_BracketLeft, VK_OEM_4 }, + { Qt::Key_BracketRight,VK_OEM_6 }, + + { Qt::Key_Semicolon, VK_OEM_1 }, + { Qt::Key_Apostrophe, VK_OEM_3 }, + { Qt::Key_NumberSign, VK_OEM_7 }, + + { Qt::Key_Backslash, VK_OEM_5 }, + { Qt::Key_Comma, VK_OEM_COMMA }, + { Qt::Key_Period, VK_OEM_PERIOD }, + { Qt::Key_Slash, VK_OEM_2 }, + + { Qt::Key_unknown, 0 }, +}; + +} + + +/**************************************************************************/ +/**************************************************************************/ +/**************************************************************************/ +HotkeyManagerPrivate::HotkeyManagerPrivate(QObject *parent) + : QObject(parent) +{ + + QAbstractEventDispatcher::instance()->installNativeEventFilter(this); +} + +/**************************************************************************/ +bool HotkeyManagerPrivate::registerNativeHotkey(const int hk) +{ + int keyQt = hk & ~Qt::KeyboardModifierMask; + int modQt = hk & Qt::KeyboardModifierMask; + + + /* Translate key symbol ( Qt -> X ) */ + UINT key = 0; + if (keyQt == 0x20 || //SPACE + (keyQt >= 0x30 && keyQt <= 0x39) || // NUMBRS + (keyQt > 0x41 && keyQt <= 0x5a) || // LETTERS + (keyQt > 0x60 && keyQt <= 0x7a)) //NUMPAD + key = keyQt; + else { + // Others require lookup from a keymap + for (int n = 0; Qt_VK_table[n].key != Qt::Key_unknown; ++n) { + if (Qt_VK_table[n].key == keyQt) { + key = Qt_VK_table[n].vk; + break; + } + } + if (!key) + return false; + } + + + /* Translate modifiers ( Qt -> X ) */ + + unsigned int mods = 0; // MOD_NOREPEAT; + if (modQt & Qt::META) + mods |= MOD_WIN; + if (modQt & Qt::SHIFT) + mods |= MOD_SHIFT; + if (modQt & Qt::CTRL) + mods |= MOD_CONTROL; + if (modQt & Qt::ALT) + mods |= MOD_ALT; + + /* Grab the key combo*/ + bool success; + success = RegisterHotKey(NULL, sid, mods, key); + if (success) + sGrabbedIds.insert(sid++); + return success; +} + +/**************************************************************************/ +void HotkeyManagerPrivate::unregisterNativeHotkeys() +{ + for ( int i : sGrabbedIds) + UnregisterHotKey(NULL, i); +} + +/**************************************************************************/ +bool HotkeyManagerPrivate::nativeEventFilter(const QByteArray &eventType, void *message, long *result) +{ + if (eventType == "windows_generic_MSG") { + MSG* msg = static_cast(message); + if (msg->message == WM_HOTKEY) + { + // Check if the key is one of the registered + for (int i : sGrabbedIds) + if (msg->wParam == i) + { + emit hotKeyPressed(); + return true; + } + } + } + return false; +} diff --git a/lib/globalshortcut/src/hotkeymanager_x11.cpp b/lib/globalshortcut/src/hotkeymanager_x11.cpp new file mode 100644 index 0000000..8c9cc33 --- /dev/null +++ b/lib/globalshortcut/src/hotkeymanager_x11.cpp @@ -0,0 +1,647 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include "X11/Xlib.h" +#include "X11/Xutil.h" +#include "X11/XKBlib.h" +#include "xcb/xcb.h" +#include "xcb/xproto.h" +#include "hotkeymanager_x11.h" +#include "X11/keysymdef.h" +#include "X11/XF86keysym.h" + +namespace { + + // http://cep.xray.aps.anl.gov/software/qt4-x11-4.2.2-browser/dc/d02/qkeymapper__x11_8cpp-source.html + static std::map> QtToXSymsMap = + { + {Qt::Key_Escape, { XK_Escape }}, // misc keys + {Qt::Key_Tab, { XK_Tab }}, + {Qt::Key_Backtab, { XK_BackSpace }}, + {Qt::Key_Backspace, { XK_BackSpace }}, + {Qt::Key_Return, { XK_Return }}, + {Qt::Key_Enter, { XK_KP_Enter }}, + {Qt::Key_Insert, { XK_Insert, }}, + {Qt::Key_Delete, { XK_Delete }}, + {Qt::Key_Pause, { XK_Pause }}, + {Qt::Key_Print, { XK_Print }}, + {Qt::Key_SysReq, { XK_Sys_Req}}, + {Qt::Key_Clear, { XK_Clear}}, + {Qt::Key_Home, { XK_Home}},// cursor movement + {Qt::Key_End, { XK_End }}, + {Qt::Key_Left, { XK_Left }}, + {Qt::Key_Up, { XK_Up }}, + {Qt::Key_Right, { XK_Right }}, + {Qt::Key_Down, { XK_Down }}, + {Qt::Key_PageUp, { XK_Prior }}, + {Qt::Key_PageDown, { XK_Next }}, + {Qt::Key_Shift, { XK_Shift_L, XK_Shift_R, XK_Shift_Lock }},// modifiers + {Qt::Key_Control, { XK_Control_L, XK_Control_R }}, + {Qt::Key_Meta, { XK_Meta_L, XK_Meta_R }}, + {Qt::Key_Alt, { XK_Alt_L, XK_Alt_R }}, + {Qt::Key_AltGr, { XK_ISO_Level3_Shift }}, + {Qt::Key_CapsLock, { XK_Caps_Lock }}, + {Qt::Key_NumLock, { XK_Num_Lock }}, + {Qt::Key_ScrollLock, { XK_Scroll_Lock }}, + {Qt::Key_F1, { XK_F1 }}, // function keys + {Qt::Key_F2, { XK_F2 }}, + {Qt::Key_F3, { XK_F3 }}, + {Qt::Key_F4, { XK_F4 }}, + {Qt::Key_F5, { XK_F5 }}, + {Qt::Key_F6, { XK_F6 }}, + {Qt::Key_F7, { XK_F7 }}, + {Qt::Key_F8, { XK_F8 }}, + {Qt::Key_F9, { XK_F9 }}, + {Qt::Key_F10, { XK_F10 }}, + {Qt::Key_F11, { XK_F11 }}, + {Qt::Key_F12, { XK_F12 }}, + {Qt::Key_F13, { XK_F13 }}, + {Qt::Key_F14, { XK_F14 }}, + {Qt::Key_F15, { XK_F15 }}, + {Qt::Key_F16, { XK_F16 }}, + {Qt::Key_F17, { XK_F17 }}, + {Qt::Key_F18, { XK_F18 }}, + {Qt::Key_F19, { XK_F19 }}, + {Qt::Key_F20, { XK_F20 }}, + {Qt::Key_F21, { XK_F21 }}, + {Qt::Key_F22, { XK_F22 }}, + {Qt::Key_F23, { XK_F23 }}, + {Qt::Key_F24, { XK_F24 }}, + {Qt::Key_F25, { XK_F25 }}, // F25 .. F35 only on X11 + {Qt::Key_F26, { XK_F26 }}, + {Qt::Key_F27, { XK_F27 }}, + {Qt::Key_F28, { XK_F28 }}, + {Qt::Key_F29, { XK_F29 }}, + {Qt::Key_F30, { XK_F30 }}, + {Qt::Key_F31, { XK_F31 }}, + {Qt::Key_F32, { XK_F32 }}, + {Qt::Key_F33, { XK_F33 }}, + {Qt::Key_F34, { XK_F34 }}, + {Qt::Key_F35, { XK_F35 }}, + {Qt::Key_Super_L, { XK_Super_L }}, // extra keys + {Qt::Key_Super_R, { XK_Super_R }}, + {Qt::Key_Menu, { XK_Menu }}, + {Qt::Key_Hyper_L, { XK_Hyper_L }}, + {Qt::Key_Hyper_R, { XK_Hyper_R }}, + {Qt::Key_Help, { XK_Help }}, +// {Qt::Key_Direction_L, { XF86XK_D }}, +// {Qt::Key_Direction_R, { XK_ }}, + {Qt::Key_Multi_key, {XK_Multi_key}}, + {Qt::Key_Codeinput, {XK_Codeinput}}, + {Qt::Key_SingleCandidate, {XK_SingleCandidate}}, + {Qt::Key_MultipleCandidate, {XK_MultipleCandidate}}, + {Qt::Key_PreviousCandidate, {XK_PreviousCandidate}}, + {Qt::Key_Mode_switch, {XK_Mode_switch}}, + {Qt::Key_Kanji, {XK_Kanji}}, + {Qt::Key_Muhenkan, {XK_Muhenkan}}, + {Qt::Key_Henkan, {XK_Henkan}}, + {Qt::Key_Romaji, {XK_Romaji}}, + {Qt::Key_Hiragana, {XK_Hiragana}}, + {Qt::Key_Katakana, {XK_Katakana}}, + {Qt::Key_Hiragana_Katakana, {XK_Hiragana_Katakana}}, + {Qt::Key_Zenkaku, {XK_Zenkaku}}, + {Qt::Key_Hankaku, {XK_Hankaku}}, + {Qt::Key_Zenkaku_Hankaku, {XK_Zenkaku_Hankaku}}, + {Qt::Key_Touroku, {XK_Touroku}}, + {Qt::Key_Massyo, {XK_Massyo}}, + {Qt::Key_Kana_Lock, {XK_Kana_Lock}}, + {Qt::Key_Kana_Shift, {XK_Kana_Shift}}, + {Qt::Key_Eisu_Shift, {XK_Eisu_Shift}}, + {Qt::Key_Eisu_toggle, {XK_Eisu_toggle}}, + {Qt::Key_Hangul, {XK_Hangul}}, + {Qt::Key_Hangul_Start, {XK_Hangul_Start}}, + {Qt::Key_Hangul_End, {XK_Hangul_End}}, + {Qt::Key_Hangul_Hanja, {XK_Hangul_Hanja}}, + {Qt::Key_Hangul_Jamo, {XK_Hangul_Jamo}}, + {Qt::Key_Hangul_Romaja, {XK_Hangul_Romaja}}, + {Qt::Key_Hangul_Jeonja, {XK_Hangul_Jeonja}}, + {Qt::Key_Hangul_Banja, {XK_Hangul_Banja}}, + {Qt::Key_Hangul_PreHanja, {XK_Hangul_PreHanja}}, + {Qt::Key_Hangul_PostHanja, {XK_Hangul_PostHanja}}, + {Qt::Key_Hangul_Special, {XK_Hangul_Special}}, + {Qt::Key_Dead_Grave, {XK_dead_grave}}, + {Qt::Key_Dead_Acute, {XK_dead_acute}}, + {Qt::Key_Dead_Circumflex, {XK_dead_circumflex}}, + {Qt::Key_Dead_Tilde, {XK_dead_tilde}}, + {Qt::Key_Dead_Macron, {XK_dead_macron}}, + {Qt::Key_Dead_Breve, {XK_dead_breve}}, + {Qt::Key_Dead_Abovedot, {XK_dead_abovedot}}, + {Qt::Key_Dead_Diaeresis, {XK_dead_diaeresis}}, + {Qt::Key_Dead_Abovering, {XK_dead_abovering}}, + {Qt::Key_Dead_Doubleacute, {XK_dead_doubleacute}}, + {Qt::Key_Dead_Caron, {XK_dead_caron}}, + {Qt::Key_Dead_Cedilla, {XK_dead_cedilla}}, + {Qt::Key_Dead_Ogonek, {XK_dead_ogonek}}, + {Qt::Key_Dead_Iota, {XK_dead_iota}}, + {Qt::Key_Dead_Voiced_Sound, {XK_dead_voiced_sound}}, + {Qt::Key_Dead_Semivoiced_Sound, {XK_dead_semivoiced_sound}}, + {Qt::Key_Dead_Belowdot, {XK_dead_belowdot}}, + {Qt::Key_Dead_Hook, {XK_dead_hook}}, + {Qt::Key_Dead_Horn, {XK_dead_horn}}, + {Qt::Key_Back, {XF86XK_Back}}, + {Qt::Key_Forward, {XF86XK_Forward}}, + {Qt::Key_Stop, {XF86XK_Stop}}, + {Qt::Key_Refresh, {XF86XK_Refresh}}, + {Qt::Key_VolumeDown, {XF86XK_AudioLowerVolume}}, + {Qt::Key_VolumeMute, {XF86XK_AudioMute}}, + {Qt::Key_VolumeUp, {XF86XK_AudioRaiseVolume}}, +// {Qt::Key_BassBoost, {}}, +// {Qt::Key_BassUp, {}}, +// {Qt::Key_BassDown, {}}, +// {Qt::Key_TrebleUp, {}}, +// {Qt::Key_TrebleDown, {}}, + {Qt::Key_MediaPlay, {XF86XK_AudioPlay}}, + {Qt::Key_MediaStop, {XF86XK_AudioStop}}, + {Qt::Key_MediaPrevious, {XF86XK_AudioPrev}}, + {Qt::Key_MediaNext, {XF86XK_AudioNext}}, + {Qt::Key_MediaRecord, {XF86XK_AudioRecord}}, + {Qt::Key_MediaPause, {XF86XK_AudioPause}}, +// {Qt::Key_MediaTogglePlayPause, {}}, + {Qt::Key_HomePage, {XF86XK_HomePage}}, + {Qt::Key_Favorites, {XF86XK_Favorites}}, + {Qt::Key_Search, {XF86XK_Search}}, + {Qt::Key_Standby, {XF86XK_Standby}}, + {Qt::Key_OpenUrl, {XF86XK_OpenURL}}, + {Qt::Key_LaunchMail, {XF86XK_Mail}}, +// {Qt::Key_LaunchMedia, {}}, + {Qt::Key_Launch0, {XF86XK_Launch0}}, + {Qt::Key_Launch1, {XF86XK_Launch1}}, + {Qt::Key_Launch2, {XF86XK_Launch2}}, + {Qt::Key_Launch3, {XF86XK_Launch3}}, + {Qt::Key_Launch4, {XF86XK_Launch4}}, + {Qt::Key_Launch5, {XF86XK_Launch5}}, + {Qt::Key_Launch6, {XF86XK_Launch6}}, + {Qt::Key_Launch7, {XF86XK_Launch7}}, + {Qt::Key_Launch8, {XF86XK_Launch8}}, + {Qt::Key_Launch9, {XF86XK_Launch9}}, + {Qt::Key_LaunchA, {XF86XK_LaunchA}}, + {Qt::Key_LaunchB, {XF86XK_LaunchB}}, + {Qt::Key_LaunchC, {XF86XK_LaunchC}}, + {Qt::Key_LaunchD, {XF86XK_LaunchD}}, + {Qt::Key_LaunchE, {XF86XK_LaunchE}}, + {Qt::Key_LaunchF, {XF86XK_LaunchF}}, +// {Qt::Key_LaunchG, {}}, +// {Qt::Key_LaunchH, {}}, + {Qt::Key_MonBrightnessUp, {XF86XK_MonBrightnessUp}}, + {Qt::Key_MonBrightnessDown, {XF86XK_MonBrightnessDown}}, + {Qt::Key_KeyboardLightOnOff, {XF86XK_KbdLightOnOff}}, + {Qt::Key_KeyboardBrightnessUp, {XF86XK_KbdBrightnessUp}}, + {Qt::Key_KeyboardBrightnessDown, {XF86XK_KbdBrightnessDown}}, + {Qt::Key_PowerOff, {XF86XK_PowerOff}}, + {Qt::Key_WakeUp, {XF86XK_WakeUp}}, + {Qt::Key_Eject, {XF86XK_Eject}}, + {Qt::Key_ScreenSaver, {XF86XK_ScreenSaver}}, + {Qt::Key_WWW, {XF86XK_WWW}}, + {Qt::Key_Memo, {XF86XK_Memo}}, + {Qt::Key_LightBulb, {XF86XK_LightBulb}}, + {Qt::Key_Shop, {XF86XK_Shop}}, + {Qt::Key_History, {XF86XK_History}}, + {Qt::Key_AddFavorite, {XF86XK_AddFavorite}}, + {Qt::Key_HotLinks, {XF86XK_HotLinks}}, + {Qt::Key_BrightnessAdjust, {XF86XK_BrightnessAdjust}}, + {Qt::Key_Finance, {XF86XK_Finance}}, + {Qt::Key_Community, {XF86XK_Community}}, + {Qt::Key_AudioRewind, {XF86XK_AudioRewind}}, + {Qt::Key_BackForward, {XF86XK_BackForward}}, + {Qt::Key_ApplicationLeft, {XF86XK_ApplicationLeft}}, + {Qt::Key_ApplicationRight, {XF86XK_ApplicationRight}}, + {Qt::Key_Book, {XF86XK_Book}}, + {Qt::Key_CD, {XF86XK_CD}}, + {Qt::Key_Calculator, {XF86XK_Calculator}}, + {Qt::Key_ToDoList, {XF86XK_ToDoList}}, + {Qt::Key_ClearGrab, {XF86XK_ClearGrab}}, + {Qt::Key_Close, {XF86XK_Close}}, + {Qt::Key_Copy, {XF86XK_Copy}}, + {Qt::Key_Cut, {XF86XK_Cut}}, + {Qt::Key_Display, {XF86XK_Display}}, + {Qt::Key_DOS, {XF86XK_DOS}}, + {Qt::Key_Documents, {XF86XK_Documents}}, + {Qt::Key_Excel, {XF86XK_Excel}}, + {Qt::Key_Explorer, {XF86XK_Explorer}}, + {Qt::Key_Game, {XF86XK_Game}}, + {Qt::Key_Go, {XF86XK_Go}}, + {Qt::Key_iTouch, {XF86XK_iTouch}}, + {Qt::Key_LogOff, {XF86XK_LogOff}}, + {Qt::Key_Market, {XF86XK_Market}}, + {Qt::Key_Meeting, {XF86XK_Meeting}}, + {Qt::Key_MenuKB, {XF86XK_MenuKB}}, + {Qt::Key_MenuPB, {XF86XK_MenuPB}}, + {Qt::Key_MySites, {XF86XK_MySites}}, + {Qt::Key_News, {XF86XK_News}}, + {Qt::Key_OfficeHome, {XF86XK_OfficeHome}}, + {Qt::Key_Option, {XF86XK_Option}}, + {Qt::Key_Paste, {XF86XK_Paste}}, + {Qt::Key_Phone, {XF86XK_Phone}}, + {Qt::Key_Calendar, {XF86XK_Calendar}}, + {Qt::Key_Reply, {XF86XK_Reply}}, + {Qt::Key_Reload, {XF86XK_Reload}}, + {Qt::Key_RotateWindows, {XF86XK_RotateWindows}}, + {Qt::Key_RotationPB, {XF86XK_RotationPB}}, + {Qt::Key_RotationKB, {XF86XK_RotationKB}}, + {Qt::Key_Save, {XF86XK_Save}}, + {Qt::Key_Send, {XF86XK_Send}}, + {Qt::Key_Spell, {XF86XK_Spell}}, + {Qt::Key_SplitScreen, {XF86XK_SplitScreen}}, + {Qt::Key_Support, {XF86XK_Support}}, + {Qt::Key_TaskPane, {XF86XK_TaskPane}}, + {Qt::Key_Terminal, {XF86XK_Terminal}}, + {Qt::Key_Tools, {XF86XK_Tools}}, + {Qt::Key_Travel, {XF86XK_Travel}}, + {Qt::Key_Video, {XF86XK_Video}}, + {Qt::Key_Word, {XF86XK_Word}}, + {Qt::Key_Xfer, {XF86XK_Xfer}}, + {Qt::Key_ZoomIn, {XF86XK_ZoomIn}}, + {Qt::Key_ZoomOut, {XF86XK_ZoomOut}}, + {Qt::Key_Away, {XF86XK_Away}}, + {Qt::Key_Messenger, {XF86XK_Messenger}}, + {Qt::Key_WebCam, {XF86XK_WebCam}}, + {Qt::Key_MailForward, {XF86XK_MailForward}}, + {Qt::Key_Pictures, {XF86XK_Pictures}}, + {Qt::Key_Music, {XF86XK_Music}}, + {Qt::Key_Battery, {XF86XK_Battery}}, + {Qt::Key_Bluetooth, {XF86XK_Bluetooth}}, + {Qt::Key_WLAN, {XF86XK_WLAN}}, + {Qt::Key_UWB, {XF86XK_UWB}}, + {Qt::Key_AudioForward, {XF86XK_AudioForward}}, + {Qt::Key_AudioRepeat, {XF86XK_AudioRepeat}}, + {Qt::Key_AudioRandomPlay, {XF86XK_AudioRandomPlay}}, + {Qt::Key_Subtitle, {XF86XK_Subtitle}}, + {Qt::Key_AudioCycleTrack, {XF86XK_AudioCycleTrack}}, + {Qt::Key_Time, {XF86XK_Time}}, + {Qt::Key_Hibernate, {XF86XK_Hibernate}}, + {Qt::Key_View, {XF86XK_View}}, + {Qt::Key_TopMenu, {XF86XK_TopMenu}}, + {Qt::Key_PowerDown, {XF86XK_PowerDown}}, + {Qt::Key_Suspend, {XF86XK_Suspend}}, + {Qt::Key_ContrastAdjust, {XF86XK_ContrastAdjust}}, + {Qt::Key_TouchpadToggle, {XF86XK_TouchpadToggle}}, + {Qt::Key_TouchpadOn, {XF86XK_TouchpadOn}}, + {Qt::Key_TouchpadOff, {XF86XK_TouchpadOff}}, + {Qt::Key_MicMute, {XF86XK_AudioMicMute}}, + {Qt::Key_Red, {XF86XK_Red}}, + {Qt::Key_Green, {XF86XK_Green}}, + {Qt::Key_Yellow, {XF86XK_Yellow}}, + {Qt::Key_Blue, {XF86XK_Blue}}, +// {Qt::Key_ChannelUp, {}}, +// {Qt::Key_ChannelDown, {}}, +// {Qt::Key_Guide, {}}, +// {Qt::Key_Info, {}}, +// {Qt::Key_Settings, {}}, +// {Qt::Key_MicVolumeUp, {}}, +// {Qt::Key_MicVolumeDown, {}}, + {Qt::Key_New, {XF86XK_New}}, + {Qt::Key_Open, {XF86XK_Open}}, + {Qt::Key_Find, {XK_Find}}, + {Qt::Key_Undo, {XK_Undo}}, + {Qt::Key_Redo, {XK_Redo}}, +// {Qt::Key_MediaLast, {}}, +// {Qt::Key_unknown, {}}, + {Qt::Key_Call, {XF86XK_Phone}}, + {Qt::Key_Camera, {XF86XK_WebCam}}, +// {Qt::Key_CameraFocus, {}}, +// {Qt::Key_Context1, {}}, +// {Qt::Key_Context2, {}}, +// {Qt::Key_Context3, {}}, +// {Qt::Key_Context4, {}}, +// {Qt::Key_Flip, {}}, +// {Qt::Key_Hangup, {}}, +// {Qt::Key_No, {}}, + {Qt::Key_Select, {XF86XK_Select}}, + {Qt::Key_Yes, {}}, + {Qt::Key_ToggleCallHangup, {}}, + {Qt::Key_VoiceDial, {}}, + {Qt::Key_LastNumberRedial, {}}, + {Qt::Key_Execute, {XK_Execute}}, +// {Qt::Key_Printer, {}}, +// {Qt::Key_Play, {}}, + {Qt::Key_Sleep, {XF86XK_Sleep}}, + {Qt::Key_Zoom, {XF86XK_ZoomIn}}, + {Qt::Key_Exit, {XK_Cancel}}, + {Qt::Key_Cancel, {XK_Cancel}} + }; + + + /** ***********************************************************************/ + bool lastGrabFailed; + static int XGrabErrorHandler(Display *, XErrorEvent *e) { + qWarning() << "XGrabError: "<< e->type; + lastGrabFailed = true; + return 0; + } + + +// /** ***********************************************************************/ +// class XLibManager +// { +// public: +// XLibManager(){ +// display = XOpenDisplay(NULL); // Open $DISPLAY +// if ( !display ) +// qFatal("Could not open DISPLAY"); +// defaultScreen = DefaultScreenOfDisplay(display); +// defaultRootWindow = DefaultRootWindow(display); +// } + +// ~XLibManager(){ +// XCloseDisplay(display); +// } + +// Display *display; +// Screen *defaultScreen; +// Window defaultRootWindow; +// }; + + +// /** ***********************************************************************/ +// class XCBManager +// { +// public: +// XCBManager(){ +// connection = xcb_connect(NULL, &defaultScreenNumber); // Open $DISPLAY +// defaultScreen = screen_of_display(connection, defaultScreenNumber); +// if ( !defaultScreen ) +// qFatal("No default screen found!"); +// defaultRootWindow = defaultScreen->root; +// } + +// ~XCBManager(){ +// xcb_disconnect(connection); +// } + +// xcb_connection_t *connection; +// int defaultScreenNumber; +// xcb_screen_t *defaultScreen; +// xcb_window_t defaultRootWindow; +// }; + + + +} + +/** ***************************************************************************/ +GlobalShortcut::HotkeyManagerPrivate::HotkeyManagerPrivate(QObject *parent) + : QObject(parent) { + + Display* dpy = QX11Info::display(); +// xcb_connection_t* conn = QX11Info::connection(); +// xcb_generic_error_t **e = nullptr ; + + XModifierKeymap* map = XGetModifierMapping(dpy); // Contains the keys being used as modifiers. + // TODO +// xcb_get_modifier_mapping_cookie_t mmc = xcb_get_modifier_mapping(conn); +// xcb_get_modifier_mapping_reply_t *mmr = xcb_get_modifier_mapping_reply (conn, mmc, e); + + masks = {0,0,0,0,0,0}; + if (map) { + /* The XDisplayKeycodes() function returns the min-keycodes and + max-keycodes supported by the specified display. The minimum number + of KeyCodes returned is never less than 8, and the maximum number + of KeyCodes returned is never greater than 255. Not all KeyCodes in + this range are required to have corresponding keys.*/ + int min_keycode, max_keycode; + XDisplayKeycodes (dpy, &min_keycode, &max_keycode); +// min_keycode = xcb_get_setup(QX11Info::connection())->min_keycode; +// max_keycode = xcb_get_setup(QX11Info::connection())->max_keycode; + + /* The XGetKeyboardMapping() function returns the symbols for the + specified number of KeyCodes starting with first_keycode. + KeySym number N, counting from zero, for KeyCode K has the following + index in the list, counting from zero: + (K - first_code) * keysyms_per_code_return + N + A special KeySym value of NoSymbol is used to fill in unused + elements for individual KeyCodes. To free the storage returned by + XGetKeyboardMapping(), use XFree(). */ + int keysyms_per_keycode; + XFree(XGetKeyboardMapping (dpy, + (KeyCode)min_keycode, + (max_keycode- min_keycode + 1), + &keysyms_per_keycode)); +// uint8_t keysyms_per_keycode; +// xcb_get_keyboard_mapping_cookie_t kmc = +// xcb_get_keyboard_mapping_unchecked(X11Info::connection(), +// (xcb_keycode_t)min_keycode, +// (max_keycode- min_keycode + 1)); +// xcb_get_keyboard_mapping_reply_t *kmr = +// xcb_get_keyboard_mapping_reply (X11Info::connection(),kmc,NULL); +// keysyms_per_keycode = kmr->keysyms_per_keycode; +// free(kmr); + + KeyCode kc; + for (int maskIndex = 0; maskIndex < 8; maskIndex++) { + for (int i = 0; i < map->max_keypermod; i++) { + kc = map->modifiermap[maskIndex*map->max_keypermod+i]; + if (kc) { + KeySym sym; + int symIndex = 0; + do { + sym = XkbKeycodeToKeysym(dpy, kc, 0, symIndex); +// qDebug() << XKeysymToString(sym); + symIndex++; + } while ( sym == NoSymbol && symIndex < keysyms_per_keycode); + if (masks.alt == 0 && (sym == XK_Alt_L || sym == XK_Alt_R)) + masks.alt = 1 << maskIndex; + if (masks.meta == 0 && (sym == XK_Meta_L || sym == XK_Meta_R)) + masks.meta = 1 << maskIndex; + if (masks.super == 0 && (sym == XK_Super_L || sym == XK_Super_R)) + masks.super = 1 << maskIndex; + if (masks.hyper == 0 && (sym == XK_Hyper_L || sym == XK_Hyper_R)) + masks.hyper = 1 << maskIndex; + if (masks.numlock == 0 && (sym == XK_Num_Lock)) + masks.numlock = 1 << maskIndex; +// if (masks.iso_level3_shift == 0 && (sym == XK_ISO_Level3_Shift)) +// masks.iso_level3_shift = 1 << maskIndex; + } + } + } + XFreeModifiermap(map); + + // logic from qt source see gui/kernel/qkeymapper_x11.cpp + if (masks.meta == 0 || masks.meta == masks.alt) { + // no meta keys... s,meta,super, + masks.meta = masks.super; + if (masks.meta == 0 || masks.meta == masks.alt) { + // no super keys either? guess we'll use hyper then + masks.meta = masks.hyper; + } + } + } + else { + // assume defaults + masks.alt = Mod1Mask; + masks.meta = Mod1Mask; + masks.numlock = Mod2Mask; + masks.super = Mod4Mask; + masks.hyper = Mod4Mask; +// masks.iso_level3_shift = Mod5Mask; + } + + offendingMasks = {0, LockMask, masks.numlock, (LockMask|masks.numlock)}; + + QAbstractEventDispatcher::instance()->installNativeEventFilter(this); +} + + + +/** ***************************************************************************/ +GlobalShortcut::HotkeyManagerPrivate::~HotkeyManagerPrivate() { + +} + + + +/** ***************************************************************************/ +bool GlobalShortcut::HotkeyManagerPrivate::registerNativeHotkey(uint hotkey) { + + // Convert to native format + std::set keysX = nativeKeycodes(hotkey & ~Qt::KeyboardModifierMask); + uint modsX = nativeModifiers(hotkey & Qt::KeyboardModifierMask); + if ( keysX.empty() ) + return false; + + // Set own errorhandler + XErrorHandler savedErrorHandler = XSetErrorHandler(XGrabErrorHandler); + + // Grab the key combos (potenzmenge aus mods und keys) + lastGrabFailed = false; + std::set> tmpGrabbedKeys; + for ( uint keySym : keysX ) { + + // Break if a grab failed + if ( lastGrabFailed ) + break; + + KeyCode XKCode = XKeysymToKeycode(QX11Info::display(), keySym); + + // On X lock and numlock are modifiers. Just grab all of them. + for ( uint mask : offendingMasks ) { + XGrabKey(QX11Info::display(), XKCode, modsX|mask, QX11Info::appRootWindow(), true, GrabModeAsync, GrabModeAsync); + if ( !lastGrabFailed ) + tmpGrabbedKeys.insert({modsX|mask, XKCode}); + } + } + + // Reset errorhandler + XSetErrorHandler(savedErrorHandler); + + if ( !lastGrabFailed ) + std::copy(tmpGrabbedKeys.begin(), tmpGrabbedKeys.end(), + std::inserter(grabbedKeys, grabbedKeys.begin())); + else + // In case of error unregister the partial registration + for (const std::pair &p : tmpGrabbedKeys) + XUngrabKey(QX11Info::display(), p.second, p.first, QX11Info::appRootWindow()); + + XSync(QX11Info::display(), False); + return !lastGrabFailed; + + + + // xcb_void_cookie_t ck = xcb_grab_key( + // QX11Info::connection(), + // true, + // QX11Info::appRootWindow(), + // uint16_t modifiers, + // xcb_keycode_t key, + // XCB_GRAB_MODE_ASYNC, + // XCB_GRAB_MODE_ASYNC + // ); + + + // xcb_generic_error_t *err = xcb_request_check (QX11Info::connection(), ck); + // if (err != NULL) { + // qWarning("X11 error %d", err->error_code); + // free (err); + // } +} + + + +/** ***************************************************************************/ +void GlobalShortcut::HotkeyManagerPrivate::unregisterNativeHotkey(uint hotkey) { + + // Convert to native format + std::set keysX = nativeKeycodes(hotkey & ~Qt::KeyboardModifierMask); + uint modsX = nativeModifiers(hotkey & Qt::KeyboardModifierMask); + if ( keysX.empty() ) + qCritical() << "keysX should not be empty"; + + // Set own errorhandler + XErrorHandler savedErrorHandler = XSetErrorHandler(XGrabErrorHandler); + + // UNgrab the key combos (potenzmenge aus mods und keys) + for ( uint keySym : keysX ) { + + KeyCode XKCode = XKeysymToKeycode(QX11Info::display(), keySym); + + // On X lock and numlock are modifiers. Just ungrab all of them. + for ( uint mask : offendingMasks ) { + XUngrabKey(QX11Info::display(), XKCode, modsX|mask, QX11Info::appRootWindow()); + grabbedKeys.erase({modsX|mask, XKCode}); + } + } + + // Reset errorhandler + XSetErrorHandler(savedErrorHandler); + + XSync(QX11Info::display(), False); +} + + + +/** ***************************************************************************/ +std::set GlobalShortcut::HotkeyManagerPrivate::nativeKeycodes(uint qtKey) { + /* Translate key symbol ( Qt -> X ) */ + // Use latin if possible + if (qtKey >= 0x20 && qtKey <= 0xff) + return std::set({qtKey}); + else { // else check the handcrafted table for fancy keys + auto it = QtToXSymsMap.find(qtKey); + if ( it != QtToXSymsMap.end() ) + return it->second; + else { + qCritical() << "Could not translate key!"<< QKeySequence(qtKey).toString(); + return std::set(); + } + } +} + + + +/** ***************************************************************************/ +uint GlobalShortcut::HotkeyManagerPrivate::nativeModifiers(uint qtMods) { + uint ret = 0; + // if (qtMods & Qt::ShiftModifier) ret |= XCB_MOD_MASK_SHIFT; + // if (qtMods & Qt::ControlModifier) ret |= XCB_MOD_MASK_CONTROL; + if (qtMods & Qt::ShiftModifier) ret |= ShiftMask; + if (qtMods & Qt::ControlModifier) ret |= ControlMask; + if (qtMods & Qt::AltModifier) ret |= masks.alt; + if (qtMods & Qt::MetaModifier) ret |= masks.super; +// if (qtMods & Qt::KeypadModifier) ret |= masks.meta; +// if (qtMods & Qt::GroupSwitchModifier) ret |= masks.iso_level3_shift; + return ret; +} + + + +/** ***************************************************************************/ +bool GlobalShortcut::HotkeyManagerPrivate::nativeEventFilter(const QByteArray &eventType, void *message, long *) { + if ( eventType == "xcb_generic_event_t" ) { + xcb_generic_event_t* ev = static_cast(message); + if ( (ev->response_type & 127) == XCB_KEY_PRESS ) { + xcb_key_press_event_t *k = reinterpret_cast(ev); + // Check if the key is one of the registered + for ( const std::pair &p: grabbedKeys ) { + if (k->detail == p.second && k->state == p.first) { + emit hotKeyPressed(); + return true; + } + } + } + } + return false; +} diff --git a/lib/globalshortcut/src/hotkeymanager_x11.h b/lib/globalshortcut/src/hotkeymanager_x11.h new file mode 100644 index 0000000..bca27bd --- /dev/null +++ b/lib/globalshortcut/src/hotkeymanager_x11.h @@ -0,0 +1,48 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include + +struct _XDisplay; +typedef _XDisplay Display; + +namespace GlobalShortcut { + +class HotkeyManagerPrivate final : public QObject, public QAbstractNativeEventFilter +{ + Q_OBJECT + +public: + + HotkeyManagerPrivate(QObject* parent = 0); + ~HotkeyManagerPrivate(); + + bool registerNativeHotkey(quint32 hk); + void unregisterNativeHotkey(quint32 hk); + +private: + + bool nativeEventFilter(const QByteArray&, void*, long*) override; + std::set nativeKeycodes(uint QtKey); + uint nativeModifiers(uint QtKbdMods); + + std::set> grabbedKeys; + std::set offendingMasks; + + struct Masks { + unsigned int alt; + unsigned int meta; + unsigned int numlock; + unsigned int super; + unsigned int hyper; + unsigned int iso_level3_shift; + } masks; + +signals: + + void hotKeyPressed(); +}; + +} diff --git a/lib/xdg/CMakeLists.txt b/lib/xdg/CMakeLists.txt new file mode 100644 index 0000000..86b748d --- /dev/null +++ b/lib/xdg/CMakeLists.txt @@ -0,0 +1,23 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(xdg) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Gui) + +file(GLOB SRC src/* include/xdg/*) + +add_library(${PROJECT_NAME} SHARED ${SRC}) + +target_compile_definitions(${PROJECT_NAME} PRIVATE -DXDG_DEF) #export branch + +target_include_directories(${PROJECT_NAME} + PUBLIC + include + PRIVATE + include/xdg + src +) + +target_link_libraries(${PROJECT_NAME} PRIVATE Qt5::Gui) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert) diff --git a/lib/xdg/include/xdg/iconlookup.h b/lib/xdg/include/xdg/iconlookup.h new file mode 100644 index 0000000..914d7f0 --- /dev/null +++ b/lib/xdg/include/xdg/iconlookup.h @@ -0,0 +1,45 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include "xdg_globals.h" + +namespace XDG { + +class EXPORT_XDG IconLookup +{ +public: + + /** + * @brief iconPath Does XDG icon lookup for the given icon name + * @param iconName The icon name to lookup + * @param themeName The theme to use + * @return If an icon was found the path to the icon, else an empty string + */ + static QString iconPath(QString iconName, QString themeName = QIcon::themeName()); + + /** + * @brief iconPath Does XDG icon lookup for the given icon names, stops on success + * @param iconNames A list of icon names to lookup + * @param themeName The theme to use + * @return If one of the icons was found the path to the icon, else an empty string + */ + static QString iconPath(std::initializer_list iconNames, QString themeName = QIcon::themeName()); + +private: + + IconLookup(); + static IconLookup *instance(); + + QString themeIconPath(QString iconName, QString themeName = QIcon::themeName()); + QString doRecursiveIconLookup(const QString &iconName, const QString &theme, QStringList *checked); + QString doIconLookup(const QString &iconName, const QString &themeFile); + QString lookupThemeFile(const QString &themeName); + + QStringList iconDirs_; + QMap iconCache_; +}; + +} diff --git a/lib/xdg/include/xdg/xdg_globals.h b/lib/xdg/include/xdg/xdg_globals.h new file mode 100644 index 0000000..9b0ae58 --- /dev/null +++ b/lib/xdg/include/xdg/xdg_globals.h @@ -0,0 +1,21 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once + +#if defined(_MSC_VER) + #define EXPORT __declspec(dllexport) + #define IMPORT __declspec(dllimport) +#elif defined(__GNUC__) + #define EXPORT __attribute__((visibility("default"))) + #define IMPORT +#else + #define EXPORT + #define IMPORT + #pragma warning Unknown dynamic link import/export semantics. +#endif + +#ifdef XDG_DEF + #define EXPORT_XDG EXPORT +#else + #define EXPORT_XDG IMPORT +#endif diff --git a/lib/xdg/src/iconlookup.cpp b/lib/xdg/src/iconlookup.cpp new file mode 100644 index 0000000..7ce48b8 --- /dev/null +++ b/lib/xdg/src/iconlookup.cpp @@ -0,0 +1,209 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include "themefileparser.h" +#include "iconlookup.h" + + +namespace { + QStringList icon_extensions = {"png", "svg", "xpm"}; +} + + +/** ***************************************************************************/ +QString XDG::IconLookup::iconPath(QString iconName, QString themeName){ + return instance()->themeIconPath(iconName, themeName); +} + + + +/** ***************************************************************************/ +QString XDG::IconLookup::iconPath(std::initializer_list iconNames, QString themeName) { + for ( const QString &iconName : iconNames ) { + QString result = instance()->themeIconPath(iconName, themeName); + if ( !result.isEmpty() ) + return result; + } + return QString(); +} + + + +/** ***************************************************************************/ +XDG::IconLookup::IconLookup() +{ + /* + * Icons and themes are looked for in a set of directories. By default, + * apps should look in $HOME/.icons (for backwards compatibility), in + * $XDG_DATA_DIRS/icons and in /usr/share/pixmaps (in that order). + */ + + QString path = QDir::home().filePath(".icons"); + if (QFile::exists(path)) + iconDirs_.append(path); + + for (const QString &basedir : QStandardPaths::standardLocations(QStandardPaths::GenericDataLocation)){ + path = QDir(basedir).filePath("icons"); + if (QFile::exists(path)) + iconDirs_.append(path); + } + + path = "/usr/share/pixmaps"; + if (QFile::exists(path)) + iconDirs_.append(path); +} + + + +/** ***************************************************************************/ +XDG::IconLookup *XDG::IconLookup::instance() +{ + static IconLookup *instance_ = nullptr; + if (!instance_){ + qInfo() << "Systems icon theme is:" << QIcon::themeName(); + instance_ = new IconLookup(); + } + return instance_; +} + + + +/** ***************************************************************************/ +QString XDG::IconLookup::themeIconPath(QString iconName, QString themeName){ + + // if we have an absolute path, just return it + if ( iconName[0]=='/' ){ + if ( QFile::exists(iconName) ) + return iconName; + else + return QString(); + } + + // check if it has an extension and strip it + for (const QString &ext : icon_extensions) + if (iconName.endsWith(QString(".").append(ext))) + iconName.chop(4); + + // Check cache + QString iconPath = iconCache_.value(iconName); + if (!iconPath.isNull()) + return iconPath; + + // Lookup themefile + QStringList checkedThemes; + iconPath = doRecursiveIconLookup(iconName, themeName, &checkedThemes); + if (!iconPath.isNull()){ + iconCache_.insert(iconName, iconPath); + return iconPath; + } + + // Lookup in hicolor + if (!checkedThemes.contains("hicolor")){ + iconPath = doRecursiveIconLookup(iconName, "hicolor", &checkedThemes); + if (!iconPath.isNull()){ + iconCache_.insert(iconName, iconPath); + return iconPath; + } + } + + // Now search unsorted + for (const QString &iconDir : iconDirs_){ + for (const QString &ext : icon_extensions){ + QString filename = QString("%1/%2.%3").arg(iconDir, iconName, ext); + if (QFile(filename).exists()){ + iconCache_.insert(iconName, filename); + return filename; + } + } + } + + // Nothing found, save though to avoid repeated expensive lookups + return iconCache_.insert(iconName, QString("")).value(); +} + + + +/** ***************************************************************************/ +QString XDG::IconLookup::doRecursiveIconLookup(const QString &iconName, const QString &themeName, QStringList *checked){ + + // Exlude multiple scans + if (checked->contains(themeName)) + return QString(); + checked->append(themeName); + + // Check if theme exists + QString themeFile = lookupThemeFile(themeName); + if (themeFile.isNull()) + return QString(); + + // Check if icon exists + QString iconPath; + iconPath = doIconLookup(iconName, themeFile); + if (!iconPath.isNull()) + return iconPath; + + // Check its parents too + for (const QString &parent : ThemeFileParser(themeFile).inherits()){ + iconPath = doRecursiveIconLookup(iconName, parent, checked); + if (!iconPath.isNull()) + return iconPath; + } + + return QString(); +} + + + +/** ***************************************************************************/ +QString XDG::IconLookup::doIconLookup(const QString &iconName, const QString &themeFile) { + + ThemeFileParser themeFileParser(themeFile); + QDir themeDir = QFileInfo(themeFile).dir(); + QString themeName = themeDir.dirName(); + + // Get the sizes of the dirs + std::vector> dirsAndSizes; + for (const QString &subdir : themeFileParser.directories()) + dirsAndSizes.push_back(std::make_pair(subdir, themeFileParser.size(subdir))); + + // Sort them by size + std::sort(dirsAndSizes.begin(), dirsAndSizes.end(), + [](std::pair a, std::pair b) { + return a.second > b.second; + }); + + // Well now search for a file beginning with the greatest + QString filename; + QFile file; + for (const auto &dirAndSize : dirsAndSizes){ + for (const QString &iconDir : iconDirs_){ + for (const QString &ext : icon_extensions){ + filename = QString("%1/%2/%3/%4.%5").arg(iconDir, themeName, dirAndSize.first, iconName, ext); + if (file.exists(filename)){ + return filename; + } + } + } + } + + return QString(); +} + + +/** ***************************************************************************/ +QString XDG::IconLookup::lookupThemeFile(const QString &themeName) +{ + // Lookup themefile + for (const QString &iconDir : iconDirs_){ + QString indexFile = QString("%1/%2/index.theme").arg(iconDir, themeName); + if (QFile(indexFile).exists()) + return indexFile; + } + return QString(); +} diff --git a/lib/xdg/src/themefileparser.cpp b/lib/xdg/src/themefileparser.cpp new file mode 100644 index 0000000..1b585d9 --- /dev/null +++ b/lib/xdg/src/themefileparser.cpp @@ -0,0 +1,105 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "themefileparser.h" + +/** ***************************************************************************/ +XDG::ThemeFileParser::ThemeFileParser(const QString& iniFilePath) + : iniFile_(iniFilePath, QSettings::IniFormat) { +} + + +/** ***************************************************************************/ +QString XDG::ThemeFileParser::path() { + return iniFile_.fileName(); +} + + +/** ***************************************************************************/ +QString XDG::ThemeFileParser::name() { + return iniFile_.value("Icon Theme/Name").toString(); +} + + +/** ***************************************************************************/ +QString XDG::ThemeFileParser::comment() { + return iniFile_.value("Icon Theme/Comment").toString(); +} + + +/** ***************************************************************************/ +QStringList XDG::ThemeFileParser::inherits() { + QStringList inherits = iniFile_.value("Icon Theme/Inherits").toStringList(); + if ( inherits.isEmpty() && name() != "hicolor" ) + inherits << "hicolor"; + return iniFile_.value("Icon Theme/Inherits").toStringList(); +} + + +/** ***************************************************************************/ +QStringList XDG::ThemeFileParser::directories() { + return iniFile_.value("Icon Theme/Directories").toStringList(); +} + + +/** ***************************************************************************/ +bool XDG::ThemeFileParser::hidden() { + return iniFile_.value("Icon Theme/Hidden").toBool(); +} + + +/** ***************************************************************************/ +int XDG::ThemeFileParser::size(const QString& directory) { + iniFile_.beginGroup(directory); + int result = iniFile_.value("Size").toInt(); + iniFile_.endGroup(); + return result; +} + + +/** ***************************************************************************/ +QString XDG::ThemeFileParser::context(const QString& directory) { + iniFile_.beginGroup(directory); + QString result = iniFile_.value("Context").toString(); + iniFile_.endGroup(); + return result; +} + + +/** ***************************************************************************/ +QString XDG::ThemeFileParser::type(const QString& directory) { + iniFile_.beginGroup(directory); + QString result = iniFile_.contains("Type") ? iniFile_.value("Type").toString() + : "Threshold"; + iniFile_.endGroup(); + return result; +} + + +/** ***************************************************************************/ +int XDG::ThemeFileParser::maxSize(const QString& directory) { + iniFile_.beginGroup(directory); + int result = iniFile_.contains("MaxSize") ? iniFile_.value("MaxSize").toInt() + : size(directory); + iniFile_.endGroup(); + return result; +} + + +/** ***************************************************************************/ +int XDG::ThemeFileParser::minSize(const QString& directory) { + iniFile_.beginGroup(directory); + int result = iniFile_.contains("MinSize") ? iniFile_.value("MinSize").toInt() + : size(directory); + iniFile_.endGroup(); + return result; +} + + +/** ***************************************************************************/ +int XDG::ThemeFileParser::threshold(const QString& directory) { + iniFile_.beginGroup(directory); + int result = + iniFile_.contains("Threshold") ? iniFile_.value("Threshold").toInt() : 2; + iniFile_.endGroup(); + return result; +} diff --git a/lib/xdg/src/themefileparser.h b/lib/xdg/src/themefileparser.h new file mode 100644 index 0000000..1d97854 --- /dev/null +++ b/lib/xdg/src/themefileparser.h @@ -0,0 +1,34 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include + +namespace XDG { + +class ThemeFileParser +{ +public: + + ThemeFileParser(const QString &iniFile); + + QString path(); + QString name(); + QString comment(); + QStringList inherits(); + QStringList directories(); + bool hidden(); + int size(const QString& directory); + QString context(const QString& directory); + QString type(const QString& directory); + int maxSize(const QString& directory); + int minSize(const QString& directory); + int threshold(const QString& directory); + +private: + + QSettings iniFile_; + +}; + +} diff --git a/plugins/.gitmodules b/plugins/.gitmodules new file mode 100644 index 0000000..83c2d77 --- /dev/null +++ b/plugins/.gitmodules @@ -0,0 +1,6 @@ +[submodule "python/pybind11"] + path = python/pybind11 + url = https://github.com/pybind/pybind11.git +[submodule "python/share/modules"] + path = python/share/modules + url = https://github.com/albertlauncher/python.git diff --git a/plugins/CMakeLists.txt b/plugins/CMakeLists.txt new file mode 100644 index 0000000..4bdee96 --- /dev/null +++ b/plugins/CMakeLists.txt @@ -0,0 +1,107 @@ +# Do not export symbols by default +set(CMAKE_CXX_VISIBILITY_PRESET hidden) +set(CMAKE_VISIBILITY_INLINES_HIDDEN 1) + +# Set the RPATH for the library lookup +set(CMAKE_INSTALL_RPATH "$ORIGIN/../") + +# FrontendPlugins + +option(BUILD_WIDGETBOXMODEL "Build the frontend" ON) +if (BUILD_WIDGETBOXMODEL) + add_subdirectory(widgetboxmodel) +endif() + +option(BUILD_QMLBOXMODEL "Build the frontend" ON) +if (BUILD_QMLBOXMODEL) + add_subdirectory(qmlboxmodel) +endif() + + + +# ExtensionPlugins + +option(BUILD_APPLICATIONS "Build the extension" ON) +if (BUILD_APPLICATIONS) + add_subdirectory(applications) +endif() + +option(BUILD_CALCULATOR "Build the extension" ON) +if (BUILD_CALCULATOR) + add_subdirectory(calculator) +endif() + +option(BUILD_CHROMEBOOKMARKS "Build the extension" ON) +if (BUILD_CHROMEBOOKMARKS) + add_subdirectory(chromebookmarks) +endif() + +option(BUILD_EXTERNALEXTENSIONS "Build the extension" ON) +if (BUILD_EXTERNALEXTENSIONS) + add_subdirectory(externalextensions) +endif() + +option(BUILD_DEBUG "Build the extension" OFF) +if (BUILD_DEBUG) + add_subdirectory(debug) +endif() + +option(BUILD_FILES "Build the extension" ON) # Deprecated +if (BUILD_FILES) + add_subdirectory(files) +endif() + +option(BUILD_FIREFOXBOOKMARKS "Build the extension" ON) +if (BUILD_FIREFOXBOOKMARKS) + add_subdirectory(firefoxbookmarks) +endif() + +option(BUILD_HASHGENERATOR "Build the extension" ON) +if (BUILD_HASHGENERATOR) + add_subdirectory(hashgenerator) +endif() + +option(BUILD_MPRIS "Build the extension" ON) +if (BUILD_MPRIS) + add_subdirectory(mpris) +endif() + +option(BUILD_PYTHON "Build the extension" ON) +if (BUILD_PYTHON) + add_subdirectory(python) +endif() + +option(BUILD_SNIPPETS "Build the extension" ON) +if (BUILD_SNIPPETS) + add_subdirectory(snippets) +endif() + +option(BUILD_SSH "Build the extension" ON) +if (BUILD_SSH) + add_subdirectory(ssh) +endif() + +option(BUILD_SYSTEM "Build the extension" ON) +if (BUILD_SYSTEM) + add_subdirectory(system) +endif() + +option(BUILD_TEMPLATE "Build the extension" OFF) +if (BUILD_TEMPLATE) + add_subdirectory(templateExtension) +endif() + +option(BUILD_TERMINAL "Build the extension" ON) +if (BUILD_TERMINAL) + add_subdirectory(terminal) +endif() + +option(BUILD_VIRTUALBOX "Build the extension" OFF) # Deprecated +if (BUILD_VIRTUALBOX) + add_subdirectory(virtualbox) +endif() + +option(BUILD_WEBSEARCH "Build the extension" ON) +if (BUILD_WEBSEARCH) + add_subdirectory(websearch) +endif() diff --git a/plugins/applications/CMakeLists.txt b/plugins/applications/CMakeLists.txt new file mode 100644 index 0000000..d930643 --- /dev/null +++ b/plugins/applications/CMakeLists.txt @@ -0,0 +1,22 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(applications) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets Concurrent) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Concurrent + Qt5::Widgets + albert::lib + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) + diff --git a/plugins/applications/applications.qrc b/plugins/applications/applications.qrc new file mode 100644 index 0000000..9f6948c --- /dev/null +++ b/plugins/applications/applications.qrc @@ -0,0 +1,5 @@ + + + resources/application-x-executable.svg + + diff --git a/plugins/applications/metadata.json b/plugins/applications/metadata.json new file mode 100644 index 0000000..5f00dfb --- /dev/null +++ b/plugins/applications/metadata.json @@ -0,0 +1,10 @@ +{ + "id" : "org.albert.extension.applications", + "name" : "Applications", + "version" : "1.1", + "platform" : "Linux", + "group" : "Extensions", + "author" : "Manuel Schneider", + "dependencies" : ["gksu"], + "enabledbydefault": true +} diff --git a/plugins/applications/resources/application-x-executable.svg b/plugins/applications/resources/application-x-executable.svg new file mode 100644 index 0000000..314427e --- /dev/null +++ b/plugins/applications/resources/application-x-executable.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/applications/src/configwidget.cpp b/plugins/applications/src/configwidget.cpp new file mode 100644 index 0000000..b0819f4 --- /dev/null +++ b/plugins/applications/src/configwidget.cpp @@ -0,0 +1,13 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include "configwidget.h" + +/** ***************************************************************************/ +Applications::ConfigWidget::ConfigWidget(QWidget *parent) : QWidget(parent) { + ui.setupUi(this); + + // Show the app dirs in the label + QStringList standardPaths = QStandardPaths::standardLocations(QStandardPaths::ApplicationsLocation); + ui.label->setText(ui.label->text().replace("__XDG_DATA_DIRS__", standardPaths.join(", "))); +} diff --git a/plugins/applications/src/configwidget.h b/plugins/applications/src/configwidget.h new file mode 100644 index 0000000..4e2abf4 --- /dev/null +++ b/plugins/applications/src/configwidget.h @@ -0,0 +1,16 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" + +namespace Applications +{ +class ConfigWidget final : public QWidget +{ + Q_OBJECT +public: + explicit ConfigWidget(QWidget *parent = 0); + Ui::ConfigWidget ui; +}; +} diff --git a/plugins/applications/src/configwidget.ui b/plugins/applications/src/configwidget.ui new file mode 100644 index 0000000..52d8a5c --- /dev/null +++ b/plugins/applications/src/configwidget.ui @@ -0,0 +1,121 @@ + + + Applications::ConfigWidget + + + + 0 + 0 + 800 + 600 + + + + + + + + + <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd"> +<html> +<head> +</head> +<body> +<p>Applications are looked up in the &quot;<span style=" font-style:italic;">applications/&quot;</span> directories in the $XDG_DATA_HOME and $XDG_DATA_DIRS, which are set in the environment variables. Your current environment configuration results in the following applications directories: <span style=" font-weight:600; font-style:italic;">__XDG_DATA_DIRS__</span>. </p> +<p>Every application is represented by a desktop file which has an ID. The desktop file ID is built using the path of the desktop file relative to the applications directory and turning '/' into '-'. If multiple files have the same desktop file ID, the first one in the precedence order given above is used. For more details check the <a href="https://specifications.freedesktop.org/desktop-entry-spec/latest/">desktop entry specification</a>.</p></body></html> + + + true + + + true + + + + + + + + + + + + + Ignore OnlyShowIn/NotShowIn keys + + + + + + + Additionaly use keywords for lookup + + + + + + + Additionally use generic name for lookup + + + + + + + Additionally use non-localized name for lookup + + + + + + + Fuzzy + + + + + + + + + Qt::Horizontal + + + + 0 + 0 + + + + + + + + + + Qt::Vertical + + + + 0 + 0 + + + + + + + + + + + + + + + + + + + + diff --git a/plugins/applications/src/extension.cpp b/plugins/applications/src/extension.cpp new file mode 100644 index 0000000..2dfe8d4 --- /dev/null +++ b/plugins/applications/src/extension.cpp @@ -0,0 +1,642 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "configwidget.h" +#include "extension.h" +#include "albert/queryhandler.h" +#include "albert/util/offlineindex.h" +#include "albert/util/standardactions.h" +#include "albert/util/standardindexitem.h" +#include "albert/util/shutil.h" +#include "xdg/iconlookup.h" +using namespace Core; +using namespace std; + +Q_LOGGING_CATEGORY(qlc_applications, "applications") +#define DEBUG qCDebug(qlc_applications).noquote() +#define INFO qCInfo(qlc_applications).noquote() +#define WARNING qCWarning(qlc_applications).noquote() +#define CRITICAL qCCritical(qlc_applications).noquote() + +extern QString terminalCommand; + + +namespace { + +const char* CFG_FUZZY = "fuzzy"; +const bool DEF_FUZZY = false; +const char* CFG_IGNORESHOWINKEYS = "ignore_show_in_keys"; +const bool DEF_IGNORESHOWINKEYS = false; +const char* CFG_USEKEYWORDS = "use_keywords"; +const bool DEF_USEKEYWORDS = false; +const char* CFG_USEGENERICNAME = "use_generic_name"; +const bool DEF_USEGENERICNAME = false; +const char* CFG_USENONLOCALIZEDNAME = "use_non_localized_name"; +const bool DEF_USENONLOCALIZEDNAME = false; + +/******************************************************************************/ +QStringList expandedFieldCodes(const QStringList & unexpandedFields, + const QString & icon, + const QString & name, + const QString & path) { + /* + * A number of special field codes have been defined which will be expanded + * by the file manager or program launcher when encountered in the command + * line. Field codes consist of the percentage character ("%") followed by + * an alpha character. Literal percentage characters must be escaped as %%. + * Deprecated field codes should be removed from the command line and + * ignored. Field codes are expanded only once, the string that is used to + * replace the field code should not be checked for field codes itself. + * + * http://standards.freedesktop.org/desktop-entry-spec/latest/ar01s06.html + */ + QStringList expandedFields; + + for (const QString & field : unexpandedFields){ + + if (field == "%i" && !icon.isEmpty()) { + expandedFields.push_back("--icon"); + expandedFields.push_back(icon); + } + + QString tmpstr; + QString::const_iterator it = field.begin(); + + while (it != field.end()) { + if (*it == '%'){ + ++it; + if (it == field.end()) + break; + else if (*it=='%') + tmpstr.push_back("%"); + else if (*it=='c') + tmpstr.push_back(name); + else if (*it=='k') + tmpstr.push_back(path); + // TODO Unhandled f F u U + } + else + tmpstr.push_back(*it); + ++it; + } + if (!tmpstr.isEmpty()) + expandedFields.push_back(std::move(tmpstr)); + } + return expandedFields; +} + +/******************************************************************************/ +QString xdgStringEscape(const QString & unescaped) { + /* + * The escape sequences \s, \n, \t, \r, and \\ are supported for values of + * type string and localestring, meaning ASCII space, newline, tab, carriage + * return, and backslash, respectively. + * + * http://standards.freedesktop.org/desktop-entry-spec/latest/ar01s03.html + */ + QString result; + QString::const_iterator it = unescaped.begin(); + while (it != unescaped.end()) { + if (*it == '\\'){ + ++it; + if (it == unescaped.end()) + break; + else if (*it=='s') + result.append(' '); + else if (*it=='n') + result.append('\n'); + else if (*it=='t') + result.append('\t'); + else if (*it=='r') + result.append('\r'); + else if (*it=='\\') + result.append('\\'); + } + else + result.append(*it); + ++it; + } + return result; +} + +/******************************************************************************/ +QString getLocalizedKey(const QString &key, const map &entries, const QLocale &loc) { + map::const_iterator it; + if ( (it = entries.find(QString("%1[%2]").arg(key, loc.name()))) != entries.end() + || (it = entries.find(QString("%1[%2]").arg(key, loc.name().left(2)))) != entries.end() + || (it = entries.find(key)) != entries.end()) + return it->second; + return QString(); +} + +} + + + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +class Applications::Private +{ +public: + Private(Extension *q) : q(q) {} + + Extension *q; + + QPointer widget; + QFileSystemWatcher watcher; + QString graphicalSudoPath; + + vector> index; + OfflineIndex offlineIndex; + + QFutureWatcher>> futureWatcher; + bool rerun = false; + bool ignoreShowInKeys; + bool useKeywords; + bool useGenericName; + bool useNonLocalizedName; + + void finishIndexing(); + void startIndexing(); + vector> indexApplications() const; +}; + + + +/** ***************************************************************************/ +void Applications::Private::startIndexing() { + + // Never run concurrent + if ( futureWatcher.future().isRunning() ) { + rerun = true; + return; + } + + // Run finishIndexing when the indexing thread finished + futureWatcher.disconnect(); + QObject::connect(&futureWatcher, &QFutureWatcher>>::finished, + std::bind(&Private::finishIndexing, this)); + + // Run the indexer thread + futureWatcher.setFuture(QtConcurrent::run(this, &Private::indexApplications)); + + // Notification + INFO << "Start indexing applications."; + emit q->statusInfo("Indexing applications ..."); +} + + + +/** ***************************************************************************/ +void Applications::Private::finishIndexing() { + + // Get the thread results + index = futureWatcher.future().result(); + + // Rebuild the offline index + offlineIndex.clear(); + for (const auto &item : index) + offlineIndex.add(item); + + // Finally update the watches (maybe folders changed) + if (!watcher.directories().isEmpty()) + watcher.removePaths(watcher.directories()); + QStringList xdgAppDirs = QStandardPaths::standardLocations(QStandardPaths::ApplicationsLocation); + for (const QString &path : xdgAppDirs) { + if (QFile::exists(path)) { + watcher.addPath(path); + QDirIterator dit(path, QDir::Dirs|QDir::NoDotAndDotDot); + while (dit.hasNext()) + watcher.addPath(dit.next()); + } + } + + // Notification + INFO << QString("Indexed %1 applications.").arg(index.size()); + emit q->statusInfo(QString("%1 applications indexed.").arg(index.size())); + + if ( rerun ) { + startIndexing(); + rerun = false; + } +} + +/** ***************************************************************************/ +vector> Applications::Private::indexApplications() const { + + // Get a new index [O(n)] + vector> desktopEntries; + QStringList xdg_current_desktop = QString(getenv("XDG_CURRENT_DESKTOP")).split(':',QString::SkipEmptyParts); + QLocale loc; + QStringList xdgAppDirs = QStandardPaths::standardLocations(QStandardPaths::ApplicationsLocation); + + /* + * Create a list of desktop files to index (unique ids) + * To determine the ID of a desktop file, make its full path relative to + * the $XDG_DATA_DIRS component in which the desktop file is installed, + * remove the "applications/" prefix, and turn '/' into '-'. + */ + + map desktopFiles; + for ( const QString &dir : xdgAppDirs ) { + QDirIterator fIt(dir, QStringList("*.desktop"), QDir::Files, + QDirIterator::Subdirectories|QDirIterator::FollowSymlinks); + while (!fIt.next().isEmpty()) { + QString desktopFileId = fIt.filePath().remove(QRegularExpression("^.*applications/")).replace("/","-"); + const auto &pair = desktopFiles.emplace(desktopFileId, fIt.filePath()); + if (!pair.second) + INFO << QString("Desktop file skipped: '%1' overwritten in '%2'").arg(fIt.filePath(), desktopFiles[desktopFileId]); + } + } + + // Iterate over all desktop files + for (const auto &id_path_pair : desktopFiles) { + + const QString &id = id_path_pair.first; + const QString &path = id_path_pair.second; + + DEBUG << "Indexing desktop file:" << id; + + map> sectionMap; + map>::iterator sectionIterator; + + /* + * Get the data from the desktop file + */ + + // Read the file into a map + { + QFile file(path); + if (!file.open(QIODevice::ReadOnly| QIODevice::Text)) continue; + QTextStream stream(&file); + QString currentGroup; + for (QString line=stream.readLine(); !line.isNull(); line=stream.readLine()) { + line = line.trimmed(); + if (line.startsWith('#') || line.isEmpty()) + continue; + if (line.startsWith("[")){ + currentGroup = line.mid(1,line.size()-2).trimmed(); + continue; + } + sectionMap[currentGroup].emplace(line.section('=', 0,0).trimmed(), + line.section('=', 1, -1).trimmed()); + } + file.close(); + } + + + // Skip if there is no "Desktop Entry" section + if ((sectionIterator = sectionMap.find("Desktop Entry")) == sectionMap.end()) + continue; + + map const &entryMap = sectionIterator->second; + map::const_iterator entryIterator; + + // Skip, if type is not found or not application + if ((entryIterator = entryMap.find("Type")) == entryMap.end() || + entryIterator->second != "Application") + continue; + + // Skip, if this desktop entry must not be shown + if ((entryIterator = entryMap.find("NoDisplay")) != entryMap.end() + && entryIterator->second == "true") + continue; + + if (!ignoreShowInKeys) { + // Skip if the current desktop environment is specified in "NotShowIn" + if ((entryIterator = entryMap.find("NotShowIn")) != entryMap.end()) + for (const QString &str : entryIterator->second.split(';',QString::SkipEmptyParts)) + if (xdg_current_desktop.contains(str)) + continue; + + // Skip if the current desktop environment is not specified in "OnlyShowIn" + if ((entryIterator = entryMap.find("OnlyShowIn")) != entryMap.end()) { + bool found = false; + for (const QString &str : entryIterator->second.split(';',QString::SkipEmptyParts)) + if (xdg_current_desktop.contains(str)){ + found = true; + break; + } + if (!found) + continue; + } + } + + bool term; + QString name; + QString nonLocalizedName; + QString genericName; + QString comment; + QString icon; + QString exec; + QString workingDir; + QStringList keywords; + QStringList actionIdentifiers; + + // Try to get the localized name, skip if empty + name = xdgStringEscape(getLocalizedKey("Name", entryMap, loc)); + if (name.isNull()) + continue; + + // Try to get the exec key, skip if not existant + if ((entryIterator = entryMap.find("Exec")) != entryMap.end()) + exec = xdgStringEscape(entryIterator->second); + else + continue; + + // Try to get the localized icon, skip if empty + icon = XDG::IconLookup::iconPath({xdgStringEscape(getLocalizedKey("Icon", entryMap, loc)), + "application-x-executable", + "exec"}); + if (icon.isNull()) + icon = ":application-x-executable"; + + // Check if this is a terminal app + term = (entryIterator = entryMap.find("Terminal")) != entryMap.end() + && entryIterator->second=="true"; + + // Try to get the localized genericName + genericName = xdgStringEscape(getLocalizedKey("GenericName", entryMap, loc)); + + // Try to get the non-localized name + if ((entryIterator = entryMap.find("Name")) != entryMap.end()) + nonLocalizedName = xdgStringEscape(entryIterator->second); + + // Try to get the localized comment + comment = xdgStringEscape(getLocalizedKey("Comment", entryMap, loc)); + + // Try to get the keywords + keywords = xdgStringEscape(getLocalizedKey("Keywords", entryMap, loc)).split(';',QString::SkipEmptyParts); + + // Try to get the workindir + if ((entryIterator = entryMap.find("Path")) != entryMap.end()) + workingDir = xdgStringEscape(entryIterator->second); + + // Try to get the keywords + if ((entryIterator = entryMap.find("Actions")) != entryMap.end()) + actionIdentifiers = xdgStringEscape(entryIterator->second).split(';',QString::SkipEmptyParts); + +// // Try to get the mimetypes +// if ((valueIterator = entryMap.find("MimeType")) != entryMap.end()) +// keywords = xdgStringEscape(valueIterator->second).split(';',QString::SkipEmptyParts); + + /* + * Build the item + */ + + // Unquote arguments and expand field codes + QStringList commandline = expandedFieldCodes(Core::ShUtil::split(exec), + icon, name, path); + // Malformed exec line. Constraint (1) + if (commandline.isEmpty()) + continue; + + // Finally we got everything, build the item + shared_ptr item = std::make_shared(); + item->setIconPath(icon); + item->setId(id); + item->setText(name); + item->setCompletion(name); + + // Set subtext/tootip + if (!comment.isEmpty()) + item->setSubtext(comment); + else if(useGenericName && !genericName.isEmpty()) + item->setSubtext(genericName); + else if(useNonLocalizedName && !nonLocalizedName.isEmpty()) + item->setSubtext(nonLocalizedName); + else + item->setSubtext(exec); + + + // Set index strings + vector indexStrings; + indexStrings.emplace_back(name, UINT_MAX); + + QStringList excludes = { + "java ", + "ruby ", + "python ", + "perl ", + "bash ", + "sh ", + "dbus-send ", + "/" + }; + if (std::none_of(excludes.begin(), excludes.end(), [&exec](const QString &str){ return exec.startsWith(str); })) + indexStrings.emplace_back(commandline[0], UINT_MAX); // safe since (1) + + if (useKeywords) + for (auto & kw : keywords) + indexStrings.emplace_back(kw, UINT_MAX/2); + + if (useGenericName && !genericName.isEmpty()) + indexStrings.emplace_back(genericName, UINT_MAX/2 ); + + if (useNonLocalizedName && !nonLocalizedName.isEmpty()) + indexStrings.emplace_back(nonLocalizedName, UINT_MAX/2 ); + + item->setIndexKeywords(std::move(indexStrings)); + + + + /* + * Build actions + */ + + // Default and root action + if (term) { + item->addAction(make_shared("Run", commandline, workingDir, false)); + item->addAction(make_shared("Run as root", QStringList("sudo")+commandline, workingDir, false)); + } else { + item->addAction(make_shared("Run", commandline, workingDir)); + item->addAction(make_shared("Run as root", QStringList("gksudo")+commandline, workingDir)); + } + + // Desktop Actions + for (const QString &actionIdentifier: actionIdentifiers){ + + // Get iterator to action section + if ((sectionIterator = sectionMap.find(QString("Desktop Action %1").arg(actionIdentifier))) == sectionMap.end()) + continue; + map &valueMap = sectionIterator->second; + + // Try to get the localized action name + QString actionName = xdgStringEscape(getLocalizedKey("Name", valueMap, loc)); + if (actionName.isNull()) + continue; + + // Get action command + if ((entryIterator = valueMap.find("Exec")) == valueMap.end()) + continue; + + // Unquote arguments and expand field codes + QStringList commandline = expandedFieldCodes(Core::ShUtil::split(entryIterator->second), + icon, name, path); + if (term) + item->addAction(make_shared(actionName, commandline, workingDir, false)); + else + item->addAction(make_shared(actionName, commandline, workingDir)); + + } + + + /* + * Add item + */ + + desktopEntries.push_back(std::move(item)); + } + return desktopEntries; +} + + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +Applications::Extension::Extension() + : Core::Extension("org.albert.extension.applications"), + Core::QueryHandler(Core::Plugin::id()), + d(new Private(this)) { + + registerQueryHandler(this); + + qunsetenv("DESKTOP_AUTOSTART_ID"); + + d->graphicalSudoPath = QStandardPaths::findExecutable("gksudo"); + + // Load settings + d->offlineIndex.setFuzzy(settings().value(CFG_FUZZY, DEF_FUZZY).toBool()); + d->ignoreShowInKeys = settings().value(CFG_IGNORESHOWINKEYS, DEF_IGNORESHOWINKEYS).toBool(); + d->useGenericName = settings().value(CFG_USEGENERICNAME, DEF_USEGENERICNAME).toBool(); + d->useNonLocalizedName = settings().value(CFG_USENONLOCALIZEDNAME, DEF_USENONLOCALIZEDNAME).toBool(); + d->useKeywords = settings().value(CFG_USEKEYWORDS, DEF_USEKEYWORDS).toBool(); + + // If the filesystem changed, trigger the scan + connect(&d->watcher, &QFileSystemWatcher::directoryChanged, + std::bind(&Private::startIndexing, d.get())); + + // Trigger initial update + updateIndex(); +} + + + +/** ***************************************************************************/ +Applications::Extension::~Extension() { + d->futureWatcher.waitForFinished(); +} + + + +/** ***************************************************************************/ +QWidget *Applications::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) { + d->widget = new ConfigWidget(parent); + + // Fuzzy + d->widget->ui.checkBox_fuzzy->setChecked(d->offlineIndex.fuzzy()); + connect(d->widget->ui.checkBox_fuzzy, &QCheckBox::toggled, + this, &Extension::setFuzzy); + + // Use keywords + d->widget->ui.checkBox_useKeywords->setChecked(d->useKeywords); + connect(d->widget->ui.checkBox_useKeywords, &QCheckBox::toggled, + this, [this](bool checked){ + settings().setValue(CFG_USEKEYWORDS, checked); + d->useKeywords = checked; + d->startIndexing(); + }); + + // Use generic name + d->widget->ui.checkBox_useGenericName->setChecked(d->useGenericName); + connect(d->widget->ui.checkBox_useGenericName, &QCheckBox::toggled, + this, [this](bool checked){ + settings().setValue(CFG_USEGENERICNAME, checked); + d->useGenericName = checked; + d->startIndexing(); + }); + + // Use non-localized name + d->widget->ui.checkBox_useNonLocalizedName->setChecked(d->useNonLocalizedName); + connect(d->widget->ui.checkBox_useNonLocalizedName, &QCheckBox::toggled, + this, [this](bool checked){ + settings().setValue(CFG_USENONLOCALIZEDNAME, checked); + d->useNonLocalizedName = checked; + d->startIndexing(); + }); + + // Ignore onlyshowin notshowin keys + d->widget->ui.checkBox_ignoreShowInKeys->setChecked(d->ignoreShowInKeys); + connect(d->widget->ui.checkBox_ignoreShowInKeys, &QCheckBox::toggled, + this, [this](bool checked){ + settings().setValue(CFG_IGNORESHOWINKEYS, checked); + d->ignoreShowInKeys = checked; + d->startIndexing(); + }); + + // Status bar + ( d->futureWatcher.isRunning() ) + ? d->widget->ui.label_statusbar->setText("Indexing applications ...") + : d->widget->ui.label_statusbar->setText(QString("%1 applications indexed.").arg(d->index.size())); + connect(this, &Extension::statusInfo, d->widget->ui.label_statusbar, &QLabel::setText); + } + return d->widget; +} + + + +/** ***************************************************************************/ +void Applications::Extension::handleQuery(Core::Query * query) const { + + const vector> &indexables = d->offlineIndex.search(query->string()); + + vector,uint>> results; + for (const shared_ptr &item : indexables) + results.emplace_back(std::static_pointer_cast(item), 1); + + query->addMatches(std::make_move_iterator(results.begin()), + std::make_move_iterator(results.end())); +} + + + +/** ***************************************************************************/ +bool Applications::Extension::fuzzy() { + return d->offlineIndex.fuzzy(); +} + + + +/** ***************************************************************************/ +void Applications::Extension::setFuzzy(bool b) { + settings().setValue(CFG_FUZZY, b); + d->offlineIndex.setFuzzy(b); +} + + + +/** ***************************************************************************/ +void Applications::Extension::updateIndex() { + d->startIndexing(); +} diff --git a/plugins/applications/src/extension.h b/plugins/applications/src/extension.h new file mode 100644 index 0000000..b4697e8 --- /dev/null +++ b/plugins/applications/src/extension.h @@ -0,0 +1,44 @@ +// Copyright (C) 2014-2019 Manuel Schneider + +#pragma once +#include +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +Q_DECLARE_LOGGING_CATEGORY(qlc_applications) + +namespace Applications { + +class Private; + +class Extension final : public Core::Extension, public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension() override; + + QString name() const override { return "Applications"; } + QWidget *widget(QWidget *parent = nullptr) override; + void handleQuery(Core::Query * query) const override; + + bool fuzzy(); + void setFuzzy(bool b = true); + + void updateIndex(); + +private: + + std::unique_ptr d; + +signals: + + void statusInfo(const QString&); + +}; +} diff --git a/plugins/calculator/CMakeLists.txt b/plugins/calculator/CMakeLists.txt new file mode 100644 index 0000000..ff57f11 --- /dev/null +++ b/plugins/calculator/CMakeLists.txt @@ -0,0 +1,21 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(calculator) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Widgets + albert::lib + muparser + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) diff --git a/plugins/calculator/calculator.qrc b/plugins/calculator/calculator.qrc new file mode 100644 index 0000000..a282081 --- /dev/null +++ b/plugins/calculator/calculator.qrc @@ -0,0 +1,5 @@ + + + resources/calc.svg + + diff --git a/plugins/calculator/metadata.json b/plugins/calculator/metadata.json new file mode 100644 index 0000000..adf4e29 --- /dev/null +++ b/plugins/calculator/metadata.json @@ -0,0 +1,10 @@ +{ + "id" : "org.albert.extension.calculator", + "name" : "Calculator", + "version" : "1.0", + "platform" : "All", + "group" : "Extensions", + "author" : "Manuel Schneider", + "dependencies" : ["libmuparser"], + "enabledbydefault": true +} diff --git a/plugins/calculator/resources/calc.svg b/plugins/calculator/resources/calc.svg new file mode 100644 index 0000000..3699075 --- /dev/null +++ b/plugins/calculator/resources/calc.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/calculator/src/configwidget.cpp b/plugins/calculator/src/configwidget.cpp new file mode 100644 index 0000000..adb6da1 --- /dev/null +++ b/plugins/calculator/src/configwidget.cpp @@ -0,0 +1,9 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "configwidget.h" + +/** ***************************************************************************/ +Calculator::ConfigWidget::ConfigWidget(QWidget *parent) : QWidget(parent) { + ui.setupUi(this); +} + diff --git a/plugins/calculator/src/configwidget.h b/plugins/calculator/src/configwidget.h new file mode 100644 index 0000000..a0defc1 --- /dev/null +++ b/plugins/calculator/src/configwidget.h @@ -0,0 +1,17 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" + +namespace Calculator { + +class ConfigWidget final : public QWidget +{ + Q_OBJECT +public: + explicit ConfigWidget(QWidget *parent = 0); + Ui::ConfigWidget ui; +}; + +} diff --git a/plugins/calculator/src/configwidget.ui b/plugins/calculator/src/configwidget.ui new file mode 100644 index 0000000..dd072a2 --- /dev/null +++ b/plugins/calculator/src/configwidget.ui @@ -0,0 +1,43 @@ + + + Calculator::ConfigWidget + + + + + + <html><head/><body><p>This is a simple calculator extension. It lets you evaluate basic math expressions. Check the <a href="https://albertlauncher.github.io/docs/extensions/calculator/"><span style=" text-decoration: underline; color:#0000ff;">docs</span></a> for built-in fuctions and operators.</p></body></html> + + + true + + + true + + + + + + + Show group separators + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + diff --git a/plugins/calculator/src/extension.cpp b/plugins/calculator/src/extension.cpp new file mode 100644 index 0000000..d7029fe --- /dev/null +++ b/plugins/calculator/src/extension.cpp @@ -0,0 +1,120 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include "configwidget.h" +#include "extension.h" +#include "muParser.h" +#include "albert/query.h" +#include "albert/util/standarditem.h" +#include "albert/util/standardactions.h" +#include "xdg/iconlookup.h" +using namespace std; +using namespace Core; + +Q_LOGGING_CATEGORY(qlc_calculator, "calculator") + + +namespace { +const QString CFG_SEPS = "group_separators"; +const bool CFG_SEPS_DEF = false; +} + + + +class Calculator::Private +{ +public: + QPointer widget; + std::unique_ptr parser; + QLocale locale; + QString iconPath; +}; + + + +/** ***************************************************************************/ +Calculator::Extension::Extension() + : Core::Extension("org.albert.extension.calculator"), + Core::QueryHandler(Core::Plugin::id()), + d(new Private){ + + registerQueryHandler(this); + + // FIXME Qt6 Workaround for https://bugreports.qt.io/browse/QTBUG-58504 + d->locale = QLocale(QLocale::system().name()); + + QString iconPath = XDG::IconLookup::iconPath("calc"); + d->iconPath = iconPath.isNull() ? ":calc" : iconPath; + + d->parser.reset(new mu::Parser); + d->parser->SetDecSep(d->locale.decimalPoint().toLatin1()); + d->parser->SetThousandsSep(d->locale.groupSeparator().toLatin1()); + d->parser->SetArgSep(';'); +} + + + +/** ***************************************************************************/ +Calculator::Extension::~Extension() { + +} + + + +/** ***************************************************************************/ +QWidget *Calculator::Extension::widget(QWidget *parent) { + if (d->widget.isNull()){ + d->widget = new ConfigWidget(parent); + + d->widget->ui.checkBox_groupsep->setChecked(!(d->locale.numberOptions() & QLocale::OmitGroupSeparator)); + connect(d->widget->ui.checkBox_groupsep, &QCheckBox::toggled, [this](bool checked){ + settings().setValue(CFG_SEPS, checked); + d->locale.setNumberOptions( (checked) ? d->locale.numberOptions() & ~QLocale::OmitGroupSeparator + : d->locale.numberOptions() | QLocale::OmitGroupSeparator ); + }); + } + return d->widget; +} + + + +/** ***************************************************************************/ +void Calculator::Extension::handleQuery(Core::Query * query) const { + + try { + d->parser->SetExpr(query->string().toStdString()); + } catch (mu::Parser::exception_type &exception) { + qCWarning(qlc_calculator).noquote() << "Muparser SetExpr exception: " << exception.GetMsg().c_str(); + return; + } + double result; + + // http://beltoforion.de/article.php?a=muparser&p=errorhandling + try { + result = d->parser->Eval(); + } catch (mu::Parser::exception_type &) { + // Expected exception in case of invalid input + // qDebug() << "Muparser Eval exception: " << exception.GetMsg().c_str(); + return; + } + + auto item = make_shared("muparser"); + item->setIconPath(d->iconPath); + d->locale.setNumberOptions(settings().value(CFG_SEPS, CFG_SEPS_DEF).toBool() + ? d->locale.numberOptions() & ~QLocale::OmitGroupSeparator + : d->locale.numberOptions() | QLocale::OmitGroupSeparator ); + item->setText(d->locale.toString(result, 'G', 16)); + item->setSubtext(QString("Result of '%1'").arg(query->string())); + item->setCompletion(item->text()); + d->locale.setNumberOptions(d->locale.numberOptions() | QLocale::OmitGroupSeparator); + item->addAction(make_shared("Copy result to clipboard", + d->locale.toString(result, 'G', 16))); + item->addAction(make_shared("Copy equation to clipboard", + QString("%1 = %2").arg(query->string(), item->text()))); + query->addMatch(move(item), UINT_MAX); +} diff --git a/plugins/calculator/src/extension.h b/plugins/calculator/src/extension.h new file mode 100644 index 0000000..0d232de --- /dev/null +++ b/plugins/calculator/src/extension.h @@ -0,0 +1,37 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +Q_DECLARE_LOGGING_CATEGORY(qlc_calculator) + +namespace Calculator { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension() override; + + QString name() const override { return "Calculator"; } + QWidget *widget(QWidget *parent = nullptr) override; + void handleQuery(Core::Query * query) const override; + +private: + + std::unique_ptr d; + +}; +} diff --git a/plugins/chromebookmarks/CMakeLists.txt b/plugins/chromebookmarks/CMakeLists.txt new file mode 100644 index 0000000..5b86155 --- /dev/null +++ b/plugins/chromebookmarks/CMakeLists.txt @@ -0,0 +1,21 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(chromebookmarks) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets Concurrent) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Widgets + Qt5::Concurrent + albert::lib + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) diff --git a/plugins/chromebookmarks/chromebookmarks.qrc b/plugins/chromebookmarks/chromebookmarks.qrc new file mode 100644 index 0000000..d6e44bd --- /dev/null +++ b/plugins/chromebookmarks/chromebookmarks.qrc @@ -0,0 +1,5 @@ + + + resources/favicon.png + + diff --git a/plugins/chromebookmarks/metadata.json b/plugins/chromebookmarks/metadata.json new file mode 100644 index 0000000..06df0e5 --- /dev/null +++ b/plugins/chromebookmarks/metadata.json @@ -0,0 +1,10 @@ +{ + "id" : "org.albert.extension.chromebookmarks", + "name" : "Chrome bookmarks", + "version" : "1.0", + "platform" : "Linux", + "group" : "Extensions", + "author" : "Manuel Schneider", + "dependencies" : [], + "enabledbydefault": false +} diff --git a/plugins/chromebookmarks/resources/favicon.png b/plugins/chromebookmarks/resources/favicon.png new file mode 100644 index 0000000..dd9ffd5 Binary files /dev/null and b/plugins/chromebookmarks/resources/favicon.png differ diff --git a/plugins/chromebookmarks/src/configwidget.cpp b/plugins/chromebookmarks/src/configwidget.cpp new file mode 100644 index 0000000..1261a61 --- /dev/null +++ b/plugins/chromebookmarks/src/configwidget.cpp @@ -0,0 +1,25 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include "configwidget.h" + +/** ***************************************************************************/ +ChromeBookmarks::ConfigWidget::ConfigWidget(QWidget *parent) : QWidget(parent) { + ui.setupUi(this); + + connect(ui.pushButton_editPath, &QPushButton::clicked, + this, &ConfigWidget::onButton_EditPath); +} + +/** ***************************************************************************/ +ChromeBookmarks::ConfigWidget::~ConfigWidget() { + +} + +/** ***************************************************************************/ +void ChromeBookmarks::ConfigWidget::onButton_EditPath() { + QString path = QFileDialog::getOpenFileName(this, tr("Choose path")); + if(path.isEmpty()) return; + emit requestEditPath(path); +} diff --git a/plugins/chromebookmarks/src/configwidget.h b/plugins/chromebookmarks/src/configwidget.h new file mode 100644 index 0000000..a090c3d --- /dev/null +++ b/plugins/chromebookmarks/src/configwidget.h @@ -0,0 +1,23 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" + +namespace ChromeBookmarks { + +class ConfigWidget final : public QWidget +{ + Q_OBJECT +public: + explicit ConfigWidget(QWidget *parent = 0); + ~ConfigWidget(); + Ui::ConfigWidget ui; + +private: + void onButton_EditPath(); + +signals: + void requestEditPath(const QString&); +}; +} diff --git a/plugins/chromebookmarks/src/configwidget.ui b/plugins/chromebookmarks/src/configwidget.ui new file mode 100644 index 0000000..ae506f2 --- /dev/null +++ b/plugins/chromebookmarks/src/configwidget.ui @@ -0,0 +1,95 @@ + + + ChromeBookmarks::ConfigWidget + + + + + + Path to bookmarkfile + + + + 0 + + + 0 + + + 0 + + + 0 + + + + + true + + + + + + + + + Fuzzy + + + + + + + Qt::Horizontal + + + + 40 + 20 + + + + + + + + + 50 + 0 + + + + Edit + + + + + + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + + + + + + + + diff --git a/plugins/chromebookmarks/src/extension.cpp b/plugins/chromebookmarks/src/extension.cpp new file mode 100644 index 0000000..c7ea8a9 --- /dev/null +++ b/plugins/chromebookmarks/src/extension.cpp @@ -0,0 +1,336 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "configwidget.h" +#include "extension.h" +#include "albert/util/standardactions.h" +#include "albert/util/standardindexitem.h" +#include "albert/util/offlineindex.h" +#include "xdg/iconlookup.h" +using namespace std; +using namespace Core; + +namespace { + +const char* EXT_ID = "org.albert.extension.chromebookmarks"; +const char* CFG_PATH = "bookmarkfile"; +const char* CFG_FUZZY = "fuzzy"; +const bool DEF_FUZZY = false; +const char *potentialExecutableNames[] = {"chromium", + "chromium-browser", + "chrome", + "chrome-browser", + "google-chrome", + "google-chrome-beta", + "google-chrome-stable", + "google-chrome-unstable"}; +const char *potentialConfigLocations[] = {"chromium", + "google-chrome"}; + +/** ***************************************************************************/ +vector> indexChromeBookmarks(QString executable, const QString &bookmarksPath) { + + // Build a new index + vector> bookmarks; + + QString icon = XDG::IconLookup::iconPath({"www", "web-browser", "emblem-web"}); + icon = icon.isEmpty() ? ":favicon" : icon; + + // Define a recursive bookmark indexing lambda + std::function rec_bmsearch = + [&rec_bmsearch, &bookmarks, &icon, &executable](const QJsonObject &json) { + QJsonValue type = json["type"]; + if (type == QJsonValue::Undefined) + return; + if (type.toString() == "folder"){ + QJsonArray jarr = json["children"].toArray(); + for (const QJsonValueRef i : jarr) + rec_bmsearch(i.toObject()); + } + if (type.toString() == "url") { + QString name = json["name"].toString(); + QString urlstr = json["url"].toString(); + + vector indexStrings; + QUrl url(urlstr); + QString host = url.host(); + indexStrings.emplace_back(name, UINT_MAX); + indexStrings.emplace_back(host.left(host.size()-url.topLevelDomain().size()), UINT_MAX/2); + + shared_ptr item = std::make_shared(QString("%1.%2").arg(EXT_ID, json["id"].toString())); + item->setText(name); + item->setCompletion(name); + item->setSubtext(urlstr); + item->setIconPath(icon); + item->setIndexKeywords(std::move(indexStrings)); + item->addAction(make_shared("Open URL", + QStringList() << executable << urlstr)); + item->addAction(make_shared("Open URL in new window", + QStringList() << executable << "--new-window" << urlstr)); + item->addAction(make_shared("Copy URL to clipboard", urlstr)); + + bookmarks.push_back(std::move(item)); + } + }; + + QFile f(bookmarksPath); + if (!f.open(QIODevice::ReadOnly)) { + qWarning() << qPrintable(QString("Could not open Chrome bookmarks file '%1'.").arg(bookmarksPath)); + return vector>(); + } + + QJsonObject json = QJsonDocument::fromJson(f.readAll()).object(); + QJsonObject roots = json.value("roots").toObject(); + for (const QJsonValue &i : roots) + if (i.isObject()) + rec_bmsearch(i.toObject()); + + f.close(); + + return bookmarks; +} + +} + + + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +class ChromeBookmarks::Private +{ +public: + Private(Extension *q) : q(q) {} + + Extension *q; + + QPointer widget; + QFileSystemWatcher fileSystemWatcher; + QString bookmarksFile; + QString executable; + + vector> index; + Core::OfflineIndex offlineIndex; + QFutureWatcher>> futureWatcher; + + void finishIndexing(); + void startIndexing(); +}; + + +/** ***************************************************************************/ +void ChromeBookmarks::Private::startIndexing() { + + // Never run concurrent + if ( futureWatcher.future().isRunning() ) + return; + + // Run finishIndexing when the indexing thread finished + futureWatcher.disconnect(); + QObject::connect(&futureWatcher, &QFutureWatcher>>::finished, + std::bind(&Private::finishIndexing, this)); + + // Run the indexer thread + futureWatcher.setFuture(QtConcurrent::run(indexChromeBookmarks, executable, bookmarksFile)); + + // Notification + qInfo() << "Start indexing Chrome bookmarks."; + emit q->statusInfo("Indexing bookmarks ..."); + +} + + +/** ***************************************************************************/ +void ChromeBookmarks::Private::finishIndexing() { + + // Get the thread results + index = futureWatcher.future().result(); + + // Rebuild the offline index + offlineIndex.clear(); + for (const auto &item : index) + offlineIndex.add(item); + + /* + * Finally update the watches (maybe folders changed) + * Note that QFileSystemWatcher stops monitoring files once they have been + * renamed or removed from disk, and directories once they have been removed + * from disk. + * Chromium seems to mv the file (inode change). + */ + if ( fileSystemWatcher.files().empty() ) + if( !fileSystemWatcher.addPath(bookmarksFile)) + qWarning() << qPrintable(QString("%1 can not be watched. Changes in this path will not be noticed.").arg(bookmarksFile)); + + // Notification + qInfo() << qPrintable(QString("Indexed %1 Chrome bookmarks.").arg(index.size())); + emit q->statusInfo(QString("%1 bookmarks indexed.").arg(index.size())); +} + + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +ChromeBookmarks::Extension::Extension() + : Core::Extension(EXT_ID), + Core::QueryHandler(Core::Plugin::id()), + d(new Private(this)) { + + + // Find executable + d->executable = QStandardPaths::findExecutable("chromium"); + for (auto &name : potentialExecutableNames) { + d->executable = QStandardPaths::findExecutable(name);; + if (!d->executable.isEmpty()) + break; + } + if (d->executable.isEmpty()) + throw "Chrome/ium executable not found."; + + // Load settings + d->offlineIndex.setFuzzy(settings().value(CFG_FUZZY, DEF_FUZZY).toBool()); + + // Load and set a valid path + QVariant v = settings().value(CFG_PATH); + if (v.isValid() && v.canConvert(QMetaType::QString) && QFileInfo(v.toString()).exists()) + setPath(v.toString()); + else + restorePath(); + + // If the path changed write it to the settings + connect(this, &Extension::pathChanged, [this](const QString& path){ + settings().setValue(CFG_PATH, path); + }); + + // Update index if bookmark file changed + connect(&d->fileSystemWatcher, &QFileSystemWatcher::fileChanged, + this, &Extension::updateIndex); + + // Update index if bookmark file's path changed + connect(this, &Extension::pathChanged, + this, &Extension::updateIndex); + + // Trigger an initial update + updateIndex(); + + registerQueryHandler(this); +} + + +/** ***************************************************************************/ +ChromeBookmarks::Extension::~Extension() {} + + +/** ***************************************************************************/ +QWidget *ChromeBookmarks::Extension::widget(QWidget *parent) { + if (d->widget.isNull()){ + d->widget = new ConfigWidget(parent); + + // Paths + d->widget->ui.lineEdit_path->setText(d->bookmarksFile); + connect(d->widget.data(), &ConfigWidget::requestEditPath, this, &Extension::setPath); + connect(this, &Extension::pathChanged, d->widget->ui.lineEdit_path, &QLineEdit::setText); + + // Fuzzy + d->widget->ui.checkBox_fuzzy->setChecked(fuzzy()); + connect(d->widget->ui.checkBox_fuzzy, &QCheckBox::toggled, this, &Extension::setFuzzy); + + // Status bar + ( d->futureWatcher.isRunning() ) + ? d->widget->ui.label_statusbar->setText("Indexing bookmarks ...") + : d->widget->ui.label_statusbar->setText(QString("%1 bookmarks indexed.").arg(d->index.size())); + connect(this, &Extension::statusInfo, d->widget->ui.label_statusbar, &QLabel::setText); + } + return d->widget; +} + + +/** ***************************************************************************/ +void ChromeBookmarks::Extension::handleQuery(Core::Query * query) const { + + const vector> &indexables = d->offlineIndex.search(query->string()); + + vector,uint>> results; + for (const shared_ptr &item : indexables) + results.emplace_back(std::static_pointer_cast(item), 0); + + query->addMatches(std::make_move_iterator(results.begin()), + std::make_move_iterator(results.end())); +} + + +/** ***************************************************************************/ +const QString &ChromeBookmarks::Extension::path() { + return d->bookmarksFile; +} + + +/** ***************************************************************************/ +void ChromeBookmarks::Extension::setPath(const QString &path) { + + QFileInfo fi(path); + if (!(fi.exists() && fi.isFile())) + return; + + d->bookmarksFile = path; + + emit pathChanged(path); +} + + +/** ***************************************************************************/ +void ChromeBookmarks::Extension::restorePath() { + // Find a bookmark file (Take first one) + for (const QString &browser : potentialConfigLocations){ + QString root = QDir(QStandardPaths::writableLocation(QStandardPaths::ConfigLocation)).filePath(browser); + QDirIterator it(root, {"Bookmarks"}, QDir::Files, QDirIterator::Subdirectories); + while (it.hasNext()) { + setPath(it.next()); + return; + } + } +} + + +/** ***************************************************************************/ +bool ChromeBookmarks::Extension::fuzzy() { + return d->offlineIndex.fuzzy(); +} + + +/** ***************************************************************************/ +void ChromeBookmarks::Extension::updateIndex() { + d->startIndexing(); +} + + +/** ***************************************************************************/ +void ChromeBookmarks::Extension::setFuzzy(bool b) { + settings().setValue(CFG_FUZZY, b); + d->offlineIndex.setFuzzy(b); +} + diff --git a/plugins/chromebookmarks/src/extension.h b/plugins/chromebookmarks/src/extension.h new file mode 100644 index 0000000..302f4c8 --- /dev/null +++ b/plugins/chromebookmarks/src/extension.h @@ -0,0 +1,48 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +namespace ChromeBookmarks { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension(); + + QString name() const override { return "Chrome bookmarks"; } + QWidget *widget(QWidget *parent = nullptr) override; + void handleQuery(Core::Query * query) const override; + + const QString &path(); + void setPath(const QString &path); + void restorePath(); + + bool fuzzy(); + void setFuzzy(bool b = true); + + void updateIndex(); + +private: + + std::unique_ptr d; + +signals: + + void pathChanged(const QString&); + void statusInfo(const QString&); + +}; +} diff --git a/plugins/create_plugin.py b/plugins/create_plugin.py new file mode 100755 index 0000000..43d0423 --- /dev/null +++ b/plugins/create_plugin.py @@ -0,0 +1,76 @@ +#! /usr/bin/env python3 + +import os +import re +import shutil +import string +import sys + +TEMPLATE_EXTENSION_ID = "projectid" +TEMPLATE_EXTENSION_NAMESPACE = "ProjectNamespace" +TEMPLATE_EXTENSION_PRETTYNAME = "Template" +TEMPLATE_EXTENSION_DIRNAME = "templateExtension" + +RE_ID = "^([a-z0-9]+)$" +RE_NAMESPACE = "^([A-Za-z][A-Za-z0-9]+)$" +RE_PRETTYNAME = "^([A-Za-z0-9 _\\-]+)$" + + +# Check sanity of input + +if len(sys.argv) != 4: + u = "Usage: create_plugin.py \n"\ + "e.g. create_plugin.py applications applicatoins Applications" + sys.stderr.write(u) + sys.exit(1) + +new_id, new_namespace, new_prettyname = sys.argv[1:] + +if not re.match(RE_ID, new_id): + e = "ID has to match " + RE_ID + "\n" + sys.stderr.write(e) + sys.exit(1) + +if not re.match(RE_NAMESPACE, new_namespace): + e = "Namespace has to match " + RE_NAMESPACE + "\n" + sys.stderr.write(e) + sys.exit(1) + +if not re.match(RE_PRETTYNAME, new_prettyname): + e = "Pretty Name has to match " + RE_PRETTYNAME + "\n" + sys.stderr.write(e) + sys.exit(1) + +if not os.path.isdir(TEMPLATE_EXTENSION_DIRNAME): + e = "Template extension missing. Are we in the src/plugins directory?" + sys.stderr.write(e) + sys.exit(1) + + +print("Copying template extension.") +shutil.copytree(TEMPLATE_EXTENSION_DIRNAME, new_id) + + +print("Adjusting file contents…") +os.chdir(new_id) +for root, dirs, files in os.walk("."): + for name in files: + relative_file_path = os.path.join(root, name) + print("\t%s" % relative_file_path) + with open(relative_file_path) as file: + content = file.read() + content = re.sub(TEMPLATE_EXTENSION_ID, new_id, content) + content = re.sub(TEMPLATE_EXTENSION_NAMESPACE, new_namespace, content) + content = re.sub(TEMPLATE_EXTENSION_PRETTYNAME, new_prettyname, content) + with open(relative_file_path, "w") as file: + file.write(content) +os.chdir("..") + + +print("Adding 'add_subdirectory' section to the CMakeLists.txt in the root dir.") +with open("CMakeLists.txt", "a") as file: + cmake_hunk = '\noption(BUILD_{0} "Build the extension" ON)\n'\ + 'if (BUILD_{0})\n'\ + ' add_subdirectory({1})\n'\ + 'endif()\n'.format(new_id.upper(), new_id) + file.write(cmake_hunk) diff --git a/plugins/debug/CMakeLists.txt b/plugins/debug/CMakeLists.txt new file mode 100644 index 0000000..fb68dca --- /dev/null +++ b/plugins/debug/CMakeLists.txt @@ -0,0 +1,19 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(debug) + +file(GLOB_RECURSE SRC src/* metadata.json) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Widgets + albert::lib +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION lib/albert/plugins) diff --git a/plugins/debug/debug.qrc b/plugins/debug/debug.qrc new file mode 100644 index 0000000..90f5d0b --- /dev/null +++ b/plugins/debug/debug.qrc @@ -0,0 +1,5 @@ + + + resources/debug.png + + diff --git a/plugins/debug/metadata.json b/plugins/debug/metadata.json new file mode 100644 index 0000000..8777662 --- /dev/null +++ b/plugins/debug/metadata.json @@ -0,0 +1,10 @@ +{ + "id" : "org.albert.extension.debug", + "name" : "Debug", + "version" : "1.0", + "platform" : "All", + "group" : "Extensions", + "author" : "Manuel Schneider", + "dependencies" : [], + "enabledbydefault": false +} diff --git a/plugins/debug/resources/debug.png b/plugins/debug/resources/debug.png new file mode 100644 index 0000000..43e5034 Binary files /dev/null and b/plugins/debug/resources/debug.png differ diff --git a/plugins/debug/src/configwidget.cpp b/plugins/debug/src/configwidget.cpp new file mode 100644 index 0000000..f6bb62e --- /dev/null +++ b/plugins/debug/src/configwidget.cpp @@ -0,0 +1,41 @@ +// albert - a simple application launcher for linux +// Copyright (C) 2014-2017 Manuel Schneider +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +#include +#include +#include +#include "configwidget.h" + +Debug::ConfigWidget::ConfigWidget(Extension * extension, QWidget * parent) + : QWidget(parent), extension_(extension) +{ + ui.setupUi(this); + ui.spinBox_delay->setValue(extension_->delay()); + connect(ui.spinBox_delay, static_cast(&QSpinBox::valueChanged), + extension_, &Extension::setDelay); + + ui.spinBox_count->setValue(extension_->count()); + connect(ui.spinBox_count, static_cast(&QSpinBox::valueChanged), + extension_, &Extension::setCount); + + ui.groupBox_async->setChecked(extension_->async()); + connect(ui.groupBox_async, &QGroupBox::toggled, + extension_, &Extension::setAsync); + + ui.lineEdit_trigger->setText(extension_->trigger()); + connect(ui.lineEdit_trigger, &QLineEdit::textChanged, + extension_, &Extension::setTrigger); +} diff --git a/plugins/debug/src/configwidget.h b/plugins/debug/src/configwidget.h new file mode 100644 index 0000000..f55a566 --- /dev/null +++ b/plugins/debug/src/configwidget.h @@ -0,0 +1,24 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" +#include "extension.h" + +namespace Debug +{ +class ConfigWidget final : public QWidget +{ + Q_OBJECT + +public: + + explicit ConfigWidget(Extension * extension_, QWidget * parent = 0); + +private: + + Ui::ConfigWidget ui; + Extension * extension_; + +}; +} diff --git a/plugins/debug/src/configwidget.ui b/plugins/debug/src/configwidget.ui new file mode 100644 index 0000000..4a37ef4 --- /dev/null +++ b/plugins/debug/src/configwidget.ui @@ -0,0 +1,113 @@ + + + Debug::ConfigWidget + + + + 0 + 0 + 800 + 600 + + + + + + + + + Trigger + + + + + + + dbg + + + + + + + + 0 + 0 + + + + Count of repeats + + + + + + + + 0 + 0 + + + + 1 + + + 1000000 + + + + + + + + + Asyn&chronous + + + true + + + + + + Delay in ms + + + + + + + 50 + + + 1000 + + + 50 + + + 100 + + + + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + diff --git a/plugins/debug/src/extension.cpp b/plugins/debug/src/extension.cpp new file mode 100644 index 0000000..0ffc0c2 --- /dev/null +++ b/plugins/debug/src/extension.cpp @@ -0,0 +1,172 @@ +// albert - a simple application launcher for linux +// Copyright (C) 2014-2015 Manuel Schneider +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program. If not, see . + +#include +#include +#include +#include +#include +#include +#include "configwidget.h" +#include "extension.h" +#include "albert/query.h" +#include "albert/util/standarditem.h" +using Core::StandardItem; + + +class Debug::Private +{ +public: + QPointer widget; + int delay; + int count; + bool async; + QString trigger; +}; + + + + +/** ***************************************************************************/ +Debug::Extension::Extension() + : Core::Extension("org.albert.extension.debug"), + Core::QueryHandler(Core::Plugin::id()), + d(new Private) { + + registerQueryHandler(this); + + d->delay = settings().value("delay", 50).toInt(); + d->count = settings().value("count", 100).toInt(); + d->async = settings().value("async", true).toBool(); + d->trigger = settings().value("trigger", "dbg").toString(); +} + + + +/** ***************************************************************************/ +Debug::Extension::~Extension() { + +} + + + +/** ***************************************************************************/ +QWidget *Debug::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) + d->widget = new ConfigWidget(this, parent); + return d->widget; +} + + + +/** ***************************************************************************/ +QStringList Debug::Extension::triggers() const { + return {d->trigger}; +} + + + +/** ***************************************************************************/ +const QString& Debug::Extension::trigger() const { + return d->trigger; +} + + + +/** ***************************************************************************/ +void Debug::Extension::handleQuery(Core::Query * query) const { + + // This extension must run only triggered + if ( !query->isTriggered() ) + return; + + for (int i = 0 ; i < d->count; ++i){ + + if (d->async) + std::this_thread::sleep_for(std::chrono::milliseconds(d->delay)); + + if (!query->isValid()) + return; + + auto item = std::make_shared(QString::number(i)); + item->setText(QString("Das Item #%1").arg(i)); + item->setSubtext(QString("Toll, das Item #%1").arg(i)); + item->setIconPath(":debug"); + query->addMatch(std::move(item)); + } +} + + + +/** ***************************************************************************/ +Core::QueryHandler::ExecutionType Debug::Extension::executionType() const { + return ExecutionType::Realtime; +} + + + +/** ***************************************************************************/ +int Debug::Extension::count() const{ + return d->count; +} + + + +/** ***************************************************************************/ +void Debug::Extension::setCount(const int &count){ + settings().setValue("count", count); + d->count = count; +} + + + +/** ***************************************************************************/ +bool Debug::Extension::async() const{ + return d->async; +} + + + +/** ***************************************************************************/ +void Debug::Extension::setAsync(bool async){ + settings().setValue("async", async); + d->async = async; +} + + + +/** ***************************************************************************/ +int Debug::Extension::delay() const { + return d->delay; +} + + + +/** ***************************************************************************/ +void Debug::Extension::setDelay(const int &delay) { + settings().setValue("delay", delay); + d->delay = delay; +} + + + +/** ***************************************************************************/ +void Debug::Extension::setTrigger(const QString &trigger){ + settings().setValue("trigger", trigger); + d->trigger = trigger; +} + + diff --git a/plugins/debug/src/extension.h b/plugins/debug/src/extension.h new file mode 100644 index 0000000..5466737 --- /dev/null +++ b/plugins/debug/src/extension.h @@ -0,0 +1,48 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +namespace Debug { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension(); + + QString name() const override { return "Debug"; } + QWidget *widget(QWidget *parent = nullptr) override; + QStringList triggers() const override; + void handleQuery(Core::Query * query) const override; + ExecutionType executionType() const override; + + int count() const; + void setCount(const int &count); + + bool async() const; + void setAsync(bool async); + + int delay() const; + void setDelay(const int &delay); + + const QString& trigger() const; + void setTrigger(const QString &trigger); + +private: + + std::unique_ptr d; + +}; +} diff --git a/plugins/externalextensions/CMakeLists.txt b/plugins/externalextensions/CMakeLists.txt new file mode 100644 index 0000000..f8bc143 --- /dev/null +++ b/plugins/externalextensions/CMakeLists.txt @@ -0,0 +1,20 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(externalextensions) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets) + +add_library(${PROJECT_NAME} SHARED ${SRC} metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Widgets + albert::lib + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) diff --git a/plugins/externalextensions/metadata.json b/plugins/externalextensions/metadata.json new file mode 100644 index 0000000..c50dcff --- /dev/null +++ b/plugins/externalextensions/metadata.json @@ -0,0 +1,10 @@ +{ + "id" : "org.albert.extension.externalextensions", + "name" : "External extensions", + "version" : "0.3", + "platform" : "All", + "group" : "Extensions", + "author" : "Manuel Schneider", + "dependencies" : [], + "enabledbydefault": false +} diff --git a/plugins/externalextensions/src/configwidget.cpp b/plugins/externalextensions/src/configwidget.cpp new file mode 100644 index 0000000..1261726 --- /dev/null +++ b/plugins/externalextensions/src/configwidget.cpp @@ -0,0 +1,17 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "configwidget.h" + +/** ***************************************************************************/ +ExternalExtensions::ConfigWidget::ConfigWidget(QWidget *parent) : QWidget(parent) { + ui.setupUi(this); + ui.tableView->horizontalHeader()->setSectionResizeMode(QHeaderView::ResizeToContents); + ui.tableView->verticalHeader()->setSectionResizeMode(QHeaderView::ResizeToContents); +} + + + +/** ***************************************************************************/ +ExternalExtensions::ConfigWidget::~ConfigWidget() { + +} diff --git a/plugins/externalextensions/src/configwidget.h b/plugins/externalextensions/src/configwidget.h new file mode 100644 index 0000000..fe4c04e --- /dev/null +++ b/plugins/externalextensions/src/configwidget.h @@ -0,0 +1,18 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" + +namespace ExternalExtensions { + +class ConfigWidget final : public QWidget +{ + Q_OBJECT +public: + explicit ConfigWidget(QWidget *parent = 0); + ~ConfigWidget(); + Ui::ConfigWidget ui; +}; + +} diff --git a/plugins/externalextensions/src/configwidget.ui b/plugins/externalextensions/src/configwidget.ui new file mode 100644 index 0000000..1c4cee5 --- /dev/null +++ b/plugins/externalextensions/src/configwidget.ui @@ -0,0 +1,60 @@ + + + ExternalExtensions::ConfigWidget + + + + + + <html> +<head/> +<body> +<p>External extensions allow the user to rapidly write custom extensions. External extensions are basically programs that follow a specific communication protocol. For the details see the <a href="https://albertlauncher.github.io/docs/extensions/external/">wiki</a>. The list below contains the extensions found on your system. +</p> +</body> +</html> + + + true + + + true + + + + + + + true + + + QAbstractItemView::SingleSelection + + + QAbstractItemView::SelectRows + + + Qt::ElideLeft + + + false + + + false + + + false + + + true + + + false + + + + + + + + diff --git a/plugins/externalextensions/src/extension.cpp b/plugins/externalextensions/src/extension.cpp new file mode 100644 index 0000000..28eda45 --- /dev/null +++ b/plugins/externalextensions/src/extension.cpp @@ -0,0 +1,135 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include "configwidget.h" +#include "extension.h" +#include "externalextension.h" +#include "externalextensionmodel.h" +using namespace std; + + +class ExternalExtensions::Private +{ +public: + std::vector> externalExtensions; + QFileSystemWatcher fileSystemWatcher; + QPointer widget; +}; + + +/** ***************************************************************************/ +ExternalExtensions::Extension::Extension() + : Core::Extension("org.albert.extension.externalextensions"), + d(new Private) { + + QString oldPath = QDir(QStandardPaths::writableLocation(QStandardPaths::DataLocation)).filePath("external"); + if (QFile::exists(oldPath)) + QFile::rename(oldPath, dataLocation().filePath("extensions")); + + if ( !dataLocation().exists("extensions") ) + dataLocation().mkdir("extensions"); + + connect(&d->fileSystemWatcher, &QFileSystemWatcher::fileChanged, + this, &Extension::reloadExtensions); + + connect(&d->fileSystemWatcher, &QFileSystemWatcher::directoryChanged, + this, &Extension::reloadExtensions); + + reloadExtensions(); +} + + + +/** ***************************************************************************/ +ExternalExtensions::Extension::~Extension() { + // Unregister + for ( auto & script : d->externalExtensions ) + if ( script->state() == ExternalExtension::State::Initialized ) + unregisterQueryHandler(script.get()); +} + + + +/** ***************************************************************************/ +QWidget *ExternalExtensions::Extension::widget(QWidget *parent) { + if (d->widget.isNull()){ + d->widget = new ConfigWidget(parent); + + ExternalExtensionsModel *model = new ExternalExtensionsModel(d->externalExtensions, d->widget->ui.tableView); + d->widget->ui.tableView->setModel(model); + + connect(d->widget->ui.tableView, &QTableView::activated, + model, &ExternalExtensionsModel::onActivated); + +// // Reset the widget when +// connect(this, &Extension::extensionsUpdated, +// d->widget->ui.tableView, &QTableView::reset); + } + return d->widget; +} + + + +/** ***************************************************************************/ +void ExternalExtensions::Extension::reloadExtensions() { + + // Unregister + for ( auto & script : d->externalExtensions ) + if ( script->state() == ExternalExtension::State::Initialized ) + unregisterQueryHandler(script.get()); + + d->externalExtensions.clear(); + + // Remove all watches + if ( !d->fileSystemWatcher.files().isEmpty() ) + d->fileSystemWatcher.removePaths(d->fileSystemWatcher.files()); + if ( !d->fileSystemWatcher.directories().isEmpty() ) + d->fileSystemWatcher.removePaths(d->fileSystemWatcher.directories()); + + // Iterate over all files in the plugindirs + for (const QString &pluginDir : QStandardPaths::locateAll(QStandardPaths::DataLocation, + Core::Plugin::id(), + QStandardPaths::LocateDirectory) ) { + QString extensionDir = QDir(pluginDir).filePath("extensions"); + if ( QFile::exists(extensionDir) ) { + + // Watch this dir + d->fileSystemWatcher.addPath(extensionDir); + + QDirIterator dirIterator(extensionDir, QDir::Files|QDir::Executable, QDirIterator::NoIteratorFlags); + while (dirIterator.hasNext()) { + + QString path = dirIterator.next(); + QString id = dirIterator.fileInfo().fileName(); + + // Skip if this id already exists + auto it = find_if(d->externalExtensions.begin(), d->externalExtensions.end(), + [&id](const unique_ptr & rhs){ + return id == rhs->id(); + }); + + if ( it == d->externalExtensions.end() ) { + d->externalExtensions.emplace_back(new ExternalExtension(path, QString("org.albert.extension.external.%1").arg(id))); + d->fileSystemWatcher.addPath(path); + } + } + } + } + + // Register + for ( auto & script : d->externalExtensions ) + if ( script->state() == ExternalExtension::State::Initialized ) + registerQueryHandler(script.get()); + + std::sort(d->externalExtensions.begin(), d->externalExtensions.end(), + [](auto& lhs, auto& rhs){ return 0 > lhs->name().localeAwareCompare(rhs->name()); }); + + emit extensionsUpdated(); +} diff --git a/plugins/externalextensions/src/extension.h b/plugins/externalextensions/src/extension.h new file mode 100644 index 0000000..8134773 --- /dev/null +++ b/plugins/externalextensions/src/extension.h @@ -0,0 +1,38 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "albert/extension.h" +#include "externalextension.h" + +namespace ExternalExtensions { + +class Private; + +class Extension final : + public Core::Extension +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension(); + + QString name() const override { return "External extensions"; } + QWidget *widget(QWidget *parent = nullptr) override; + + void reloadExtensions(); + +private: + + std::unique_ptr d; + +signals: + + void extensionsUpdated(); + +}; +} diff --git a/plugins/externalextensions/src/externalextension.cpp b/plugins/externalextensions/src/externalextension.cpp new file mode 100644 index 0000000..18dc395 --- /dev/null +++ b/plugins/externalextensions/src/externalextension.cpp @@ -0,0 +1,379 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "externalextension.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "albert/util/standardactions.h" +#include "albert/util/standarditem.h" +#include "xdg/iconlookup.h" +using namespace std; +using namespace Core; + +#define EXTERNAL_EXTENSION_IID "org.albert.extension.external/v3.0" + +namespace { + +const constexpr char* ALBERT_OP = "ALBERT_OP"; +const constexpr char* ALBERT_QRY = "ALBERT_QUERY"; +const constexpr uint PROC_TIMEOUT = 5000; + +enum Message { + Metadata, + Initialize, + Finalize, + Query +}; + +QString OP_COMMANDS[] = { + "METADATA", + "INITIALIZE", + "FINALIZE", + "QUERY" +}; + + +bool runProcess (QString path, + std::map *variables, + QByteArray *out, + QString *errorString) { + + // Run the process + QProcess process; + QProcessEnvironment env = QProcessEnvironment::systemEnvironment(); + for ( auto & entry : *variables ) + env.insert(entry.first, entry.second); + process.setProcessEnvironment(env); + process.start(path); + + if ( !process.waitForFinished(PROC_TIMEOUT) ){ + *errorString = "Process timed out."; + process.kill(); + return false; + } + + if ( process.exitStatus() != QProcess::NormalExit ) { + *errorString = "Process crashed."; + return false; + } + + if ( process.exitCode() != 0 ) { + + *errorString = QString("Exit code is %1.").arg(process.exitCode()); + + QByteArray cout = process.readAllStandardOutput(); + QByteArray cerr = process.readAllStandardError(); + + if (!cout.isEmpty()) + errorString->append(QString("\n%1").arg(QString(cout)).trimmed()); + + if (!cerr.isEmpty()) + errorString->append(QString("\n%1").arg(QString(cerr)).trimmed()); + + return false; + } + + *out = process.readAllStandardOutput(); + + return true; +} + + +bool parseJsonObject (const QByteArray &json, + QJsonObject *object, + QString *errorString) { + + // Parse stdout + QJsonParseError error; + QJsonDocument document = QJsonDocument::fromJson(json, &error); + if ( document.isNull() ) { + *errorString = QString("Invalid JSON at %1: %2").arg(error.offset).arg(error.errorString()); + return false; + } + + if ( !document.isObject() ) { + *errorString = "Output does not contain a JSON object."; + return false; + } + + *object = document.object(); + return true; +} + + +bool saveVariables (QJsonObject *object, + std::map *variables, + QString *errorString) { + + variables->clear(); + + if ( !object->contains("variables") ) + return true; + + if ( !object->operator[]("variables").isObject() ) { + *errorString = "'variables' is not a JSON object"; + return false; + } + + QJsonObject vars = object->operator[]("variables").toObject(); + for (auto it = vars.begin(); it != vars.end(); ++it) + if ( it.value().isString() ) + variables->emplace(it.key(), it.value().toString()); + + return true; +} + +} + +/** ***************************************************************************/ +ExternalExtensions::ExternalExtension::ExternalExtension(const QString &path, const QString &id) + : QueryHandler(id), path_(path), id_(id) { + + state_ = State::Error; + name_ = id; // Will be overwritten when available + + /* + * Get the metadata + */ + + QString preparedMessage = QString(OP_COMMANDS[Message::Metadata]).append(": %1 [%2]"); + + // Run the process + QByteArray out; + variables_[ALBERT_OP] = OP_COMMANDS[Message::Metadata]; + if ( !runProcess(path_, &variables_, &out, &errorString_) ){ + qWarning() << qPrintable(preparedMessage.arg(errorString_, path_)); + return; + } + + // Parse stdout + QJsonObject object; + if ( !parseJsonObject(out, &object, &errorString_) ) { + qWarning() << qPrintable(preparedMessage.arg(errorString_, path_)); + return; + } + + // Check for a sane interface ID (IID) + QJsonValue value = object["iid"]; + if (value.isNull()) { + errorString_ = "Metadate does not contain an interface id (iid)."; + qWarning() << qPrintable(preparedMessage.arg(errorString_, path_)); + return; + } + + QString iid = value.toString(); + if (iid != EXTERNAL_EXTENSION_IID) { + errorString_ = QString("Interface id '%1' does not match '%2'.").arg(iid, EXTERNAL_EXTENSION_IID); + qWarning() << qPrintable(preparedMessage.arg(errorString_, path_)); + return; + } + + trigger_ = object["trigger"].toString(); + if ( trigger_.isEmpty() ){ + errorString_ = "No trigger defined in metadata."; + qWarning() << qPrintable(preparedMessage.arg(errorString_, path_)); + return; + } + + // Get opional data + value = object["name"]; + name_ = value.isString() ? value.toString() : id_; + + value = object["version"]; + version_ = value.isString() ? value.toString() : "N/A"; + + value = object["author"]; + author_ = value.isString() ? value.toString() : "N/A"; + + value = object["description"]; + description_ = value.toString(); + + value = object["usage_example"]; + usageExample_ = value.toString(); + + value = object["dependencies"]; + if ( value.isArray() ) + for (const QJsonValue & val : value.toArray()) + dependencies_.append(val.toString()); + + + /* + * Initialize the extension + */ + + preparedMessage = QString(OP_COMMANDS[Message::Initialize]).append(": %1 [%2]"); + + // Run the process + variables_[ALBERT_OP] = OP_COMMANDS[Message::Initialize]; + if ( !runProcess(path_, &variables_, &out, &errorString_) ){ + qWarning() << qPrintable(preparedMessage.arg(errorString_, path_)); + return; + } + + if ( !out.isEmpty() ) { + + // Parse stdout + if ( !parseJsonObject(out, &object, &errorString_) ){ + qWarning() << qPrintable(preparedMessage.arg(errorString_, path_)); + return; + } + + // Finally save the variables, if any + if ( !saveVariables(&object, &variables_, &errorString_) ){ + qWarning() << qPrintable(preparedMessage.arg(errorString_, path_)); + return; + } + } + + state_ = State::Initialized; +} + + +/** ***************************************************************************/ +ExternalExtensions::ExternalExtension::~ExternalExtension() { + + if ( state_ == State::Error ) + return; + + QJsonObject object; + QByteArray out; + + QString preparedMessage = QString(OP_COMMANDS[Message::Finalize]).append(": %1 [%2]"); + + // Run the process + variables_[ALBERT_OP] = OP_COMMANDS[Message::Finalize]; + if ( !runProcess(path_, &variables_, &out, &errorString_) ) { + qWarning() << qPrintable(preparedMessage.arg(errorString_, path_)); + return; + } +} + + +/** ***************************************************************************/ +void ExternalExtensions::ExternalExtension::handleQuery(Core::Query* query) const { + + Q_ASSERT(state_ != State::Error); + + // External extension must run only when triggered, since they are too ressource heavy + if ( query->trigger().isEmpty() ) + return; + + // Never run the extension concurrent + QMutexLocker lock (&processMutex_); + if (!query->isValid()) + return; + + QByteArray out; + QString errorString; + QString preparedMessage = QString(OP_COMMANDS[Message::Query]).append(": %1 [%2]"); + + // Build env + QProcessEnvironment env = QProcessEnvironment::systemEnvironment(); + variables_[ALBERT_OP] = OP_COMMANDS[Message::Query]; + variables_[ALBERT_QRY] = query->string(); + for ( auto & entry : variables_ ) + env.insert(entry.first, entry.second); + + // Run the process + QProcess process; + process.setProcessEnvironment(env); + process.start(path_); + + while( !process.waitForFinished(10) ) { + if (!query->isValid()) { + process.terminate(); + if ( !process.waitForFinished(PROC_TIMEOUT) ) + process.kill(); + return; + } + } + + if ( process.exitStatus() != QProcess::NormalExit ) { + qWarning() << qPrintable(preparedMessage.arg("Process crashed.", path_)); + return; + } + + if ( process.exitCode() != 0 ) { + errorString = QString("Exit code is %1.").arg(process.exitCode()).append(process.readAllStandardError()); + qWarning() << qPrintable(preparedMessage.arg(errorString, path_)); + return; + } + + out = process.readAllStandardOutput(); + + // Parse stdout + QJsonObject object; + if ( !parseJsonObject(out, &object, &errorString) ) { + qWarning() << qPrintable(preparedMessage.arg(errorString, path_)); + return; + } + + if ( out.isEmpty() ) + return; + + // Save the variables, if any + if ( !saveVariables(&object, &variables_, &errorString) ) { + qWarning() << qPrintable(preparedMessage.arg(errorString, path_)); + return; + } + + // Quit if there are no items + QJsonValue value = object["items"]; + if ( value.isNull() ) + return; + + // Check type of items + if ( !value.isArray() ) { + errorString = "'items' is not an array."; + qWarning() << qPrintable(preparedMessage.arg(errorString, path_)); + return; + } + + // Iterate over the results + shared_ptr item; + vector,short>> results; + + int i = 0; + for (const QJsonValue & itemValue : value.toArray() ){ + + if ( !itemValue.isObject() ) { + qWarning() << qPrintable(QString("Returned item %1 Item is not a JSON object. (%2)").arg(i).arg(path_)); + return; + } + object = itemValue.toObject(); + + // Build the item from the json object + item = std::make_shared(object["id"].toString()); + item->setText(object["name"].toString()); + item->setSubtext(object["description"].toString()); + item->setCompletion(object["completion"].toString()); + QString icon = XDG::IconLookup::iconPath({object["icon"].toString(), "unknown"}); + item->setIconPath(icon.isEmpty() ? ":unknown" : icon); + + // Build the actions + for (const QJsonValue & value : object["actions"].toArray()){ + object = value.toObject(); + + QString command = object["command"].toString(); + QStringList arguments; + for (const QJsonValue & value : object["arguments"].toArray()) + arguments.append(value.toString()); + + item->addAction(make_shared(object["name"].toString(), + QStringList(command)+arguments)); + } + results.emplace_back(std::move(item), 0); + } + + query->addMatches(make_move_iterator(results.begin()), + make_move_iterator(results.end())); +} + diff --git a/plugins/externalextensions/src/externalextension.h b/plugins/externalextensions/src/externalextension.h new file mode 100644 index 0000000..7dea51c --- /dev/null +++ b/plugins/externalextensions/src/externalextension.h @@ -0,0 +1,68 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include "albert/queryhandler.h" + +namespace ExternalExtensions { + +class ExternalExtension final : public Core::QueryHandler +{ +public: + + enum class State { + Initialized, + Error + }; + + + ExternalExtension(const QString &path, const QString &id); + ~ExternalExtension(); + + /* + * Implementation of extension interface + */ + + QStringList triggers() const override { return {trigger_}; } + void handleQuery(Core::Query *query) const override; + + /* + * Extension specific members + */ + + + const QString &path() const { return path_; } + const QString &id() const { return id_; } + const QString &name() const { return name_; } + const QString &author() const { return author_; } + const QString &version() const { return version_; } + const QString &description() const { return description_; } + const QString &usageExample() const { return usageExample_; } + const QString &trigger() const { return trigger_; } + const QStringList &dependencies() const { return dependencies_; } + const State &state() const { return state_; } + const QString &errorString() const { return errorString_; } + +private: + + QString runOperation(const QString &); + + QString path_; + QString id_; + QString name_; + QString author_; + QString version_; + QString trigger_; + QString description_; + QString usageExample_; + QStringList dependencies_; + State state_; + QString errorString_; + mutable std::map variables_; + mutable QMutex processMutex_; +}; + +} diff --git a/plugins/externalextensions/src/externalextensionmodel.cpp b/plugins/externalextensions/src/externalextensionmodel.cpp new file mode 100644 index 0000000..af0cc52 --- /dev/null +++ b/plugins/externalextensions/src/externalextensionmodel.cpp @@ -0,0 +1,153 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include "externalextensionmodel.h" +#include "externalextension.h" + + +namespace { +enum class Section{Name, Trigger, Path, Count}; +} + + +/** ***************************************************************************/ +int ExternalExtensions::ExternalExtensionsModel::rowCount(const QModelIndex &) const { + return static_cast(externalExtensions_.size()); +} + + + +/** ***************************************************************************/ +int ExternalExtensions::ExternalExtensionsModel::columnCount(const QModelIndex &) const { + return static_cast(Section::Count); +} + + + +/** ***************************************************************************/ +QVariant ExternalExtensions::ExternalExtensionsModel::headerData(int section, Qt::Orientation orientation, int role) const { + // No sanity check necessary since + if ( section<0 || static_cast(Section::Count)<=section ) + return QVariant(); + + + if (orientation == Qt::Horizontal){ + switch (static_cast
(section)) { + case Section::Name:{ + switch (role) { + case Qt::DisplayRole: return "Name"; + case Qt::ToolTipRole: return "The name of the extension."; + default: return QVariant(); + } + + } + case Section::Trigger:{ + switch (role) { + case Qt::DisplayRole: return "Trigger"; + case Qt::ToolTipRole: return "The term that triggers this extension."; + default: return QVariant(); + } + + } + case Section::Path:{ + switch (role) { + case Qt::DisplayRole: return "Path"; + case Qt::ToolTipRole: return "The path of this extension."; + default: return QVariant(); + } + + } + default: return QVariant(); + } + } + return QVariant(); +} + + + +/** ***************************************************************************/ +QVariant ExternalExtensions::ExternalExtensionsModel::data(const QModelIndex &index, int role) const { + if (!index.isValid() + || index.row() >= static_cast(externalExtensions_.size()) + || index.column() >= static_cast(static_cast(Section::Count))) + return QVariant(); + + switch (role) { + case Qt::DecorationRole: { + if ( static_cast
(index.column()) == Section::Name ) { + switch (externalExtensions_[static_cast(index.row())]->state()) { + case ExternalExtension::State::Initialized: + return QIcon(":plugin_loaded"); + case ExternalExtension::State::Error: + return QIcon(":plugin_error"); + } + } + return QVariant(); + } + case Qt::DisplayRole: { + switch (static_cast
(index.column())) { + case Section::Name: return externalExtensions_[static_cast(index.row())]->name(); + case Section::Trigger: return externalExtensions_[static_cast(index.row())]->trigger(); + case Section::Path: return externalExtensions_[static_cast(index.row())]->path(); + default: return QVariant(); + } + } + case Qt::EditRole: { + switch (static_cast
(index.column())) { + case Section::Name: return externalExtensions_[static_cast(index.row())]->name(); + case Section::Trigger: return externalExtensions_[static_cast(index.row())]->trigger(); + case Section::Path: return externalExtensions_[static_cast(index.row())]->path(); + default: return QVariant(); + } + } + case Qt::ToolTipRole: { + QString toolTip; + const ExternalExtension *ext = externalExtensions_[static_cast(index.row())].get(); + + toolTip = QString("ID: %1").arg(ext->id()); + + if (!ext->version().isEmpty()) + toolTip.append(QString("\nVersion: %1").arg(ext->version())); + + if (!ext->author().isEmpty()) + toolTip.append(QString("\nAuthor: %1").arg(ext->author())); + + if (!ext->dependencies().empty()) + toolTip.append(QString("\nDependencies: %1").arg(ext->dependencies().join(", "))); + + toolTip.append(QString("\nPath: %1").arg(ext->path())); + + if (!ext->description().isEmpty()) + toolTip.append(QString("\nDescription: %1").arg(ext->description())); + + if (!ext->usageExample().isEmpty()) + toolTip.append(QString("\nUsage example: '%1'").arg(ext->usageExample())); + + if (ext->state() == ExternalExtension::State::Error && !ext->errorString().isEmpty()) + toolTip.append(QString("\nERROR: %1").arg(ext->errorString())); + + return toolTip; + } + default: + return QVariant(); + } +} + + +/** ***************************************************************************/ +Qt::ItemFlags ExternalExtensions::ExternalExtensionsModel::flags(const QModelIndex &index) const { + if ( !index.isValid() ) + return Qt::NoItemFlags; + return Qt::ItemIsSelectable|Qt::ItemIsEnabled; +} + + +/** ***************************************************************************/ +void ExternalExtensions::ExternalExtensionsModel::onActivated(const QModelIndex &index) { + QDesktopServices::openUrl(QUrl(externalExtensions_[static_cast(index.row())]->path())); +} diff --git a/plugins/externalextensions/src/externalextensionmodel.h b/plugins/externalextensions/src/externalextensionmodel.h new file mode 100644 index 0000000..3988e9b --- /dev/null +++ b/plugins/externalextensions/src/externalextensionmodel.h @@ -0,0 +1,33 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include "externalextension.h" + +namespace ExternalExtensions { + +class ExternalExtensionsModel : public QAbstractTableModel +{ + Q_OBJECT + +public: + + ExternalExtensionsModel(const std::vector> &exts, QObject *parent = Q_NULLPTR) + : QAbstractTableModel(parent), externalExtensions_(exts) {} + + int rowCount(const QModelIndex & parent = QModelIndex()) const override; + int columnCount(const QModelIndex & parent = QModelIndex()) const override; + QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override; + QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const override; + Qt::ItemFlags flags(const QModelIndex & index) const override; + + void onActivated(const QModelIndex &); + +private: + + const std::vector> &externalExtensions_; +}; + +} diff --git a/plugins/files/CMakeLists.txt b/plugins/files/CMakeLists.txt new file mode 100644 index 0000000..850c468 --- /dev/null +++ b/plugins/files/CMakeLists.txt @@ -0,0 +1,21 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(files) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets Concurrent) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Concurrent + Qt5::Widgets + albert::lib + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) diff --git a/plugins/files/files.qrc b/plugins/files/files.qrc new file mode 100644 index 0000000..92e6a18 --- /dev/null +++ b/plugins/files/files.qrc @@ -0,0 +1,5 @@ + + + resources/inode-directory.svg + + diff --git a/plugins/files/metadata.json b/plugins/files/metadata.json new file mode 100644 index 0000000..291cbf2 --- /dev/null +++ b/plugins/files/metadata.json @@ -0,0 +1,10 @@ +{ + "id" : "org.albert.extension.files", + "name" : "Files", + "version" : "1.1", + "platform" : "All", + "group" : "Extensions", + "author" : "Manuel Schneider", + "dependencies" : [], + "enabledbydefault": true +} diff --git a/plugins/files/resources/inode-directory.svg b/plugins/files/resources/inode-directory.svg new file mode 100644 index 0000000..b9b8eb8 --- /dev/null +++ b/plugins/files/resources/inode-directory.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/files/src/configwidget.cpp b/plugins/files/src/configwidget.cpp new file mode 100644 index 0000000..47a2237 --- /dev/null +++ b/plugins/files/src/configwidget.cpp @@ -0,0 +1,227 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include "configwidget.h" +#include "extension.h" +#include "mimetypedialog.h" + +/** ***************************************************************************/ +Files::ConfigWidget::ConfigWidget(Extension *_extension, QWidget *_parent) + : QWidget(_parent), extension(_extension) { + ui.setupUi(this); + + // Paths + QStringListModel *pathsModel = new QStringListModel(this); + pathsModel->setStringList(extension->paths()); + ui.listView_paths->setModel(pathsModel); + connect(extension, &Extension::pathsChanged, + pathsModel, &QStringListModel::setStringList); + + // Buttons + connect(ui.pushButton_add, &QPushButton::clicked, [=](){ + QFileInfo fileInfo(QFileDialog::getExistingDirectory( + this, + tr("Choose directory"), + QStandardPaths::writableLocation(QStandardPaths::HomeLocation))); + if(fileInfo.exists()) + extension->setPaths(QStringList(extension->paths()) << fileInfo.absoluteFilePath()); + }); + + connect(ui.pushButton_remove, &QPushButton::clicked, [this, pathsModel](){ + if ( !ui.listView_paths->currentIndex().isValid() ) + return; + QStringList paths(extension->paths()); + paths.removeAll(pathsModel->stringList()[ui.listView_paths->currentIndex().row()]); + extension->setPaths(paths); + }); + + connect(ui.pushButton_restore, &QPushButton::clicked, + extension, &Extension::restorePaths); + + connect(ui.pushButton_update, &QPushButton::clicked, + extension, &Extension::updateIndex); + + /* + * Initialize the indexing options + */ + + ui.checkBox_hidden->setChecked(extension->indexHidden()); + connect(ui.checkBox_hidden, &QCheckBox::toggled, extension, &Extension::setIndexHidden); + + ui.checkBox_followSymlinks->setChecked(extension->followSymlinks()); + connect(ui.checkBox_followSymlinks, &QCheckBox::toggled, extension, &Extension::setFollowSymlinks); + + ui.checkBox_fuzzy->setChecked(extension->fuzzy()); + connect(ui.checkBox_fuzzy, &QCheckBox::toggled, extension, &Extension::setFuzzy); + + ui.spinBox_interval->setValue(static_cast(extension->scanInterval())); + connect(ui.spinBox_interval, static_cast(&QSpinBox::valueChanged), + extension, &Extension::setScanInterval); + + /* + * Initialize the mime options + */ + + QStringList filters = extension->filters(); + + if (filters.contains("audio/*")) + ui.checkBox_audio->setCheckState(Qt::Checked); + else if (std::any_of(filters.begin(), filters.end(), + [](const QString & str){ return str.startsWith("audio/"); })) + ui.checkBox_audio->setCheckState(Qt::PartiallyChecked); + else + ui.checkBox_audio->setCheckState(Qt::Unchecked); + + if (filters.contains("video/*")) + ui.checkBox_video->setCheckState(Qt::Checked); + else if (std::any_of(filters.begin(), filters.end(), + [](const QString & str){ return str.startsWith("video/"); })) + ui.checkBox_video->setCheckState(Qt::PartiallyChecked); + else + ui.checkBox_video->setCheckState(Qt::Unchecked); + + if (filters.contains("image/*")) + ui.checkBox_image->setCheckState(Qt::Checked); + else if (std::any_of(filters.begin(), filters.end(), + [](const QString & str){ return str.startsWith("image/"); })) + ui.checkBox_image->setCheckState(Qt::PartiallyChecked); + else + ui.checkBox_image->setCheckState(Qt::Unchecked); + + if (filters.contains("application/*")) + ui.checkBox_docs->setCheckState(Qt::Checked); + else if (std::any_of(filters.begin(), filters.end(), + [](const QString & str){ return str.startsWith("application/"); })) + ui.checkBox_docs->setCheckState(Qt::PartiallyChecked); + else + ui.checkBox_docs->setCheckState(Qt::Unchecked); + + if (filters.contains("inode/directory")) + ui.checkBox_dirs->setCheckState(Qt::Checked); + else + ui.checkBox_dirs->setCheckState(Qt::Unchecked); + + /* + * Set the actions for checking the mime options + */ + + connect(ui.checkBox_audio, &QCheckBox::clicked, extension, [this]() { + ui.checkBox_audio->setTristate(false); + QStringList filters = extension->filters(); + filters.erase(std::remove_if(filters.begin(), filters.end(), + [](const QString &str){ return str.startsWith("audio/"); }), + filters.end()); + if (ui.checkBox_audio->checkState() == Qt::Checked) + filters.push_back("audio/*"); + extension->setFilters(filters); + }); + + connect(ui.checkBox_video, &QCheckBox::clicked, extension, [this]() { + ui.checkBox_video->setTristate(false); + QStringList filters = extension->filters(); + filters.erase(std::remove_if(filters.begin(), filters.end(), + [](const QString &str){ return str.startsWith("video/"); }), + filters.end()); + if (ui.checkBox_video->checkState() == Qt::Checked) + filters.push_back("video/*"); + extension->setFilters(filters); + }); + + connect(ui.checkBox_image, &QCheckBox::clicked, extension, [this]() { + ui.checkBox_image->setTristate(false); + QStringList filters = extension->filters(); + filters.erase(std::remove_if(filters.begin(), filters.end(), + [](const QString &str){ return str.startsWith("image/"); }), + filters.end()); + if (ui.checkBox_image->checkState() == Qt::Checked) + filters.push_back("image/*"); + extension->setFilters(filters); + }); + + connect(ui.checkBox_docs, &QCheckBox::clicked, extension, [this]() { + ui.checkBox_docs->setTristate(false); + QStringList filters = extension->filters(); + filters.erase(std::remove_if(filters.begin(), filters.end(), + [](const QString &str){ return str.startsWith("application/"); }), + filters.end()); + if (ui.checkBox_docs->checkState() == Qt::Checked) + filters.push_back("application/*"); + extension->setFilters(filters); + }); + + connect(ui.checkBox_dirs, &QCheckBox::toggled, extension, [=](bool checked){ + QStringList filters = extension->filters(); + filters.removeAll("inode/directory"); + if (checked) + filters.push_back("inode/directory"); + extension->setFilters(filters); + }); + + // The advanced button action + connect(ui.pushButton_advanced, &QPushButton::clicked, [=](){ + + MimeTypeDialog dialog(extension->filters(), this); + dialog.setWindowModality(Qt::WindowModal); + if ( dialog.exec() ) { + + // If the dialog has been accepted, update extension and checkboxes + extension->setFilters(dialog.filters()); + + // Set the shortcuts + QStringList filters = extension->filters(); + + if (filters.contains("audio/*")) + ui.checkBox_audio->setCheckState(Qt::Checked); + else if (std::any_of(filters.begin(), filters.end(), + [](const QString & str){ return str.startsWith("audio/"); })) + ui.checkBox_audio->setCheckState(Qt::PartiallyChecked); + else + ui.checkBox_audio->setCheckState(Qt::Unchecked); + + if (filters.contains("video/*")) + ui.checkBox_video->setCheckState(Qt::Checked); + else if (std::any_of(filters.begin(), filters.end(), + [](const QString & str){ return str.startsWith("video/"); })) + ui.checkBox_video->setCheckState(Qt::PartiallyChecked); + else + ui.checkBox_video->setCheckState(Qt::Unchecked); + + if (filters.contains("image/*")) + ui.checkBox_image->setCheckState(Qt::Checked); + else if (std::any_of(filters.begin(), filters.end(), + [](const QString & str){ return str.startsWith("image/"); })) + ui.checkBox_image->setCheckState(Qt::PartiallyChecked); + else + ui.checkBox_image->setCheckState(Qt::Unchecked); + + if (filters.contains("application/*")) + ui.checkBox_docs->setCheckState(Qt::Checked); + else if (std::any_of(filters.begin(), filters.end(), + [](const QString & str){ return str.startsWith("application/"); })) + ui.checkBox_docs->setCheckState(Qt::PartiallyChecked); + else + ui.checkBox_docs->setCheckState(Qt::Unchecked); + + if (filters.contains("inode/directory")) + ui.checkBox_dirs->setCheckState(Qt::Checked); + else + ui.checkBox_dirs->setCheckState(Qt::Unchecked); + } + }); + + // Status bar + connect(extension, &Extension::statusInfo, this, [this](const QString& text){ + QFontMetrics metrics(ui.label_statusbar->font()); + QString elidedText = metrics.elidedText(text, Qt::ElideMiddle, ui.label_statusbar->width()-5); + ui.label_statusbar->setText(elidedText); + }); +} + + + +/** ***************************************************************************/ +Files::ConfigWidget::~ConfigWidget() { + +} diff --git a/plugins/files/src/configwidget.h b/plugins/files/src/configwidget.h new file mode 100644 index 0000000..b2aa851 --- /dev/null +++ b/plugins/files/src/configwidget.h @@ -0,0 +1,33 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "ui_configwidget.h" + +namespace Files { + +class Extension; + +class ConfigWidget final : public QWidget +{ + Q_OBJECT + +public: + + explicit ConfigWidget(Extension *ext, QWidget *parent = 0); + ~ConfigWidget(); + +private: + + Extension *extension; + Ui::ConfigWidget ui; + +signals: + + void requestAddPath(const QString&); + void requestRemovePath(const QString&); + +}; + +} diff --git a/plugins/files/src/configwidget.ui b/plugins/files/src/configwidget.ui new file mode 100644 index 0000000..6b6b2e4 --- /dev/null +++ b/plugins/files/src/configwidget.ui @@ -0,0 +1,243 @@ + + + Files::ConfigWidget + + + + 0 + + + 0 + + + 0 + + + 0 + + + + + + + Paths + + + + + + QAbstractItemView::NoEditTriggers + + + true + + + true + + + + + + + + + + 0 + 0 + + + + + .. + + + + + + + + 0 + 0 + + + + + .. + + + + + + + Restore + + + + + + + Qt::Horizontal + + + + 0 + 0 + + + + + + + + + + + + + + + Indexed MIME types + + + + + + Documents + + + + + + + Folders + + + + + + + Images + + + + + + + Video + + + + + + + Audio + + + + + + + Advanced + + + + + + + + + + Misc settings + + + + + + Fuzzy Search + + + + + + + Index hidden files + + + + + + + <html><head/><body><p>This option should by used with care and only if necessary. It may cause indexing of way more files you wanted when the indexed file tree contains links to directories outside the specified file tree.</p></body></html> + + + Follow symlinks + + + + + + + + + + Scan interval + + + + + + Start scan + + + + + + + mins + + + 0 + + + 1440 + + + 5 + + + 60 + + + + + + + + + + Qt::Vertical + + + + 0 + 0 + + + + + + + + + + + + + + + + + + + + diff --git a/plugins/files/src/extension.cpp b/plugins/files/src/extension.cpp new file mode 100644 index 0000000..12998b8 --- /dev/null +++ b/plugins/files/src/extension.cpp @@ -0,0 +1,540 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "configwidget.h" +#include "file.h" +#include "standardfile.h" +#include "extension.h" +#include "indextreenode.h" +#include "albert/util/offlineindex.h" +#include "albert/util/standarditem.h" +#include "albert/util/standardactions.h" +#include "xdg/iconlookup.h" +using namespace Core; +using namespace std; + + +namespace { + +const char* CFG_PATHS = "paths"; +const char* CFG_FILTERS = "filters"; +const QStringList DEF_FILTERS = { "inode/directory", "application/*" }; +const char* CFG_FUZZY = "fuzzy"; +const bool DEF_FUZZY = false; +const char* CFG_INDEX_HIDDEN = "indexhidden"; +const bool DEF_INDEX_HIDDEN = false; +const char* CFG_FOLLOW_SYMLINKS = "follow_symlinks"; +const bool DEF_FOLLOW_SYMLINKS = false; +const char* CFG_SCAN_INTERVAL = "scan_interval"; +const uint DEF_SCAN_INTERVAL = 15; + + + +class OfflineIndexBuilderVisitor : public Files::Visitor { + Core::OfflineIndex &offlineIndex; +public: + OfflineIndexBuilderVisitor(Core::OfflineIndex &offlineIndex) + : offlineIndex(offlineIndex) { } + + void visit(Files::IndexTreeNode *node) override { + for ( const shared_ptr &item : node->items() ) + offlineIndex.add(item); + } +}; + + +class CounterVisitor : public Files::Visitor { +public: + uint itemCount = 0; + uint dirCount = 0; + void visit(Files::IndexTreeNode *node) override { + ++dirCount; + itemCount += node->items().size(); + } +}; + +} + + + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +class Files::Private +{ +public: + Private(Extension *q) : q(q), abort(false), rerun(false) {} + + Extension *q; + + QPointer widget; + + QStringList indexRootDirs; + IndexSettings indexSettings; + vector> indexTrees; + unique_ptr> futureWatcher; + Core::OfflineIndex offlineIndex; + QTimer indexIntervalTimer; + bool abort; + bool rerun; + + + void finishIndexing(); + void startIndexing(); + Core::OfflineIndex *indexFiles(); +}; + + + +/** ***************************************************************************/ +void Files::Private::startIndexing() { + + // Abort and rerun + if ( futureWatcher ) { + emit q->statusInfo("Waiting for indexer to shut down ..."); + abort = true; + rerun = true; + return; + } + + // Run finishIndexing when the indexing thread finished + futureWatcher.reset(new QFutureWatcher); + QObject::connect(futureWatcher.get(), &QFutureWatcher::finished, + [this](){ this->finishIndexing(); }); + + // Restart the timer (Index update may have been started manually) + if (indexIntervalTimer.interval() != 0) + indexIntervalTimer.start(); + + // Run the indexer thread + qInfo() << "Start indexing files."; + futureWatcher->setFuture(QtConcurrent::run(this, &Private::indexFiles)); + + // Notification + emit q->statusInfo("Indexing files ..."); +} + + + +/** ***************************************************************************/ +void Files::Private::finishIndexing() { + + // In case of abortion the returned data is invalid + if ( !abort ) { + OfflineIndex *retval = futureWatcher->future().result(); + if (retval) { + offlineIndex = std::move(*retval); + delete retval; + } + + // Notification + CounterVisitor counterVisitor; + for (const auto & tree : indexTrees ) + tree->accept(counterVisitor); + qInfo() << qPrintable(QString("Indexed %1 files in %2 directories.") + .arg(counterVisitor.itemCount).arg(counterVisitor.dirCount)); + emit q->statusInfo(QString("Indexed %1 files in %2 directories.") + .arg(counterVisitor.itemCount).arg(counterVisitor.dirCount)); + } + + futureWatcher.reset(); + abort = false; + + if ( rerun ) { + rerun = false; + startIndexing(); + } +} + + + +/** ***************************************************************************/ +OfflineIndex* Files::Private::indexFiles() { + + // Remove the subtrees not wanted anymore + auto it = indexTrees.begin(); + while ( it != indexTrees.end() ) { + if ( indexRootDirs.contains((*it)->path()) ) + ++it; + else { + (*it)->removeDownlinks(); + it = indexTrees.erase(it); + } + } + + // Start the indexing + for ( const QString &rootDir : indexRootDirs ) { + + emit q->statusInfo(QString("Indexing %1…").arg(rootDir)); + + // If this root dir does not exist create it + auto it = find_if(indexTrees.begin(), indexTrees.end(), + [&rootDir](const shared_ptr& tree){ return tree->path() == rootDir; }); + if ( it == indexTrees.end() ) { + indexTrees.push_back(make_shared(rootDir)); + indexTrees.back()->update(abort, indexSettings); + } + else + (*it)->update(abort, indexSettings); + + + if ( abort ) + return nullptr; + } + + // Serialize data + qDebug() << "Serializing files…"; + emit q->statusInfo("Serializing index data…"); + QFile file(q->cacheLocation().filePath("fileindex.json")); + if (file.open(QIODevice::WriteOnly)) { + QJsonArray array; + for (auto& tree : this->indexTrees) + array.push_back(tree->serialize()); + QJsonDocument doc(array); + file.write(doc.toJson(QJsonDocument::Compact)); + file.close(); + } + else + qWarning() << "Couldn't write to file:" << file.fileName(); + + + // Build offline index + qDebug() << "Building inverted file index…"; + emit q->statusInfo("Building inverted index…"); + Core::OfflineIndex *offline = new Core::OfflineIndex(indexSettings.fuzzy()); + OfflineIndexBuilderVisitor visitor(*offline); + for (auto& tree : this->indexTrees) + tree->accept(visitor); + return offline; +} + + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +Files::Extension::Extension() + : Core::Extension("org.albert.extension.files"), + Core::QueryHandler(Core::Plugin::id()), + d(new Private(this)) { + + registerQueryHandler(this); + + // Load settings + d->indexSettings.setFilters(settings().value(CFG_FILTERS, DEF_FILTERS).toStringList()); + d->indexSettings.setIndexHidden(settings().value(CFG_INDEX_HIDDEN, DEF_INDEX_HIDDEN).toBool()); + d->indexSettings.setFollowSymlinks(settings().value(CFG_FOLLOW_SYMLINKS, DEF_FOLLOW_SYMLINKS).toBool()); + d->indexSettings.setFuzzy(settings().value(CFG_FUZZY, DEF_FUZZY).toBool()); + d->indexSettings.setForceUpdate(false); + d->offlineIndex.setFuzzy(d->indexSettings.fuzzy()); + d->indexIntervalTimer.setInterval(settings().value(CFG_SCAN_INTERVAL, DEF_SCAN_INTERVAL).toInt()*60000); // Will be started in the initial index update + d->indexRootDirs = settings().value(CFG_PATHS, QDir::homePath()).toStringList(); + + // Index timer + connect(&d->indexIntervalTimer, &QTimer::timeout, this, &Extension::updateIndex); + + // If the root dirs change write it to the settings + connect(this, &Extension::pathsChanged, [this](const QStringList& dirs){ + settings().setValue(CFG_PATHS, dirs); + }); + + // Deserialize data + qDebug() << "Loading file index from cache."; + QFile file(cacheLocation().filePath("fileindex.json")); + if ( file.exists() ) { + if (file.open(QIODevice::ReadOnly)) { + QJsonDocument loadDoc{QJsonDocument::fromJson(file.readAll())}; + for ( const QJsonValueRef value : loadDoc.array()){ + d->indexTrees.push_back(make_shared()); // Invalid node + d->indexTrees.back()->deserialize(value.toObject()); + } + file.close(); + + // Build offline index + qDebug() << "Building inverted file index."; + OfflineIndexBuilderVisitor visitor(d->offlineIndex); + for (auto& tree : d->indexTrees) + tree->accept(visitor); + } + else + qWarning() << "Could not read from file: " << file.fileName(); + } + + // Trigger an initial update + updateIndex(); +} + + + +/** ***************************************************************************/ +Files::Extension::~Extension() { + + // The indexer thread has sideeffects wait for termination + d->abort = true; + d->rerun = false; + if ( d->futureWatcher ){ + disconnect(d->futureWatcher.get(), 0, 0, 0); + d->futureWatcher->waitForFinished(); + } +} + + + +/** ***************************************************************************/ +QWidget *Files::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) + d->widget = new ConfigWidget(this, parent); + return d->widget; +} + + + +/** ***************************************************************************/ +void Files::Extension::handleQuery(Core::Query * query) const { + + if ( query->trigger()=="/" || query->trigger()=="~" ) { + + QFileInfo queryFileInfo(query->rawString()); + + // Substitute tilde + if ( query->rawString()[0] == '~' ) + queryFileInfo.setFile(QDir::homePath()+query->string()); + + // Get all matching files + QFileInfo pathInfo(queryFileInfo.path()); + if ( pathInfo.exists() && pathInfo.isDir() ) { + + QMimeDatabase mimeDatabase; + QDir dir(pathInfo.filePath()); + QString commonPrefix; + QString queryFileName = queryFileInfo.fileName(); + vector> items; + + for (const QFileInfo& fileInfo : dir.entryInfoList(QDir::AllEntries|QDir::Hidden|QDir::NoDotAndDotDot, + QDir::DirsFirst|QDir::Name|QDir::IgnoreCase) ) { + QString fileName = fileInfo.fileName(); + + if ( fileName.startsWith(queryFileName) ) { + + if (fileInfo.isDir()) + fileName.append(QDir::separator()); + + if (commonPrefix.isNull()) + commonPrefix = fileName; + else { + auto pair = mismatch(commonPrefix.begin() , commonPrefix.end(), fileName.begin(), fileName.end()); + commonPrefix.resize(distance(commonPrefix.begin(), pair.first)); + } + + QMimeType mimetype = mimeDatabase.mimeTypeForFile(fileInfo.filePath()); + QString icon = XDG::IconLookup::iconPath({mimetype.iconName(), mimetype.genericIconName(), "unknown"}); + if (icon.isEmpty()) + icon = (mimetype.iconName() == "inode-directory") ? ":directory" : ":unknown"; + + auto item = make_shared(fileInfo.filePath(), + icon, + fileName, + fileInfo.filePath()); + item->setActions(File::buildFileActions(fileInfo.filePath())); + items.push_back(move(item)); + } + } + for (auto &item : items) { + item->setCompletion(dir.filePath(commonPrefix)); + query->addMatch(std::move(item)); + } + } + } + else + { + if ( query->string().isEmpty() ) + return; + + if ( QString("albert scan files").startsWith(query->string()) ) { + + auto item = make_shared("files.action.index"); + item->setText("albert scan files"); + item->setSubtext("Update the file index"); + item->setIconPath(":app_icon"); + // Const cast is fine since the action will not be called here + item->addAction(make_shared("Update the file index", + [this](){ const_cast(this)->updateIndex();})); + + query->addMatch(move(item)); + } + + // Search for matches + const vector> &indexables = d->offlineIndex.search(query->string()); + + // Add results to query + vector,uint>> results; + for (const shared_ptr &item : indexables) + // TODO `Search` has to determine the relevance. Set to 0 for now + results.emplace_back(static_pointer_cast(item), 0); + + query->addMatches(make_move_iterator(results.begin()), + make_move_iterator(results.end())); + } +} + + + +/** ***************************************************************************/ +const QStringList &Files::Extension::paths() const { + return d->indexRootDirs; +} + + + +/** ***************************************************************************/ +void Files::Extension::setPaths(const QStringList &paths) { + + if (d->indexRootDirs == paths) + return; + + d->indexRootDirs.clear(); + + // Check sanity and add path + for ( const QString& path : paths ) { + + QFileInfo fileInfo(path); + QString absPath = fileInfo.absoluteFilePath(); + + if (d->indexRootDirs.contains(absPath)) { + qWarning() << QString("Duplicate paths: %1.").arg(path); + continue; + } + + if (!fileInfo.exists()) { + qWarning() << QString("Path does not exist: %1.").arg(path); + continue; + } + + if(!fileInfo.isDir()) { + qWarning() << QString("Path is not a directory: %1.").arg(path); + continue; + } + + d->indexRootDirs << absPath; + } + + sort(d->indexRootDirs.begin(), d->indexRootDirs.end()); + + emit pathsChanged(d->indexRootDirs); + + // Store to settings + settings().setValue(CFG_PATHS, d->indexRootDirs); + +} + + + +/** ***************************************************************************/ +void Files::Extension::restorePaths() { + // Add standard path + d->indexRootDirs.clear(); + d->indexRootDirs << QStandardPaths::writableLocation(QStandardPaths::HomeLocation); + emit pathsChanged(d->indexRootDirs); +} + + + +/** ***************************************************************************/ +void Files::Extension::updateIndex() { + d->startIndexing(); +} + + + +/** ***************************************************************************/ +bool Files::Extension::indexHidden() const { + return d->indexSettings.indexHidden(); +} + + + +/** ***************************************************************************/ +void Files::Extension::setIndexHidden(bool b) { + settings().setValue(CFG_INDEX_HIDDEN, b); + d->indexSettings.setIndexHidden(b); +} + + + +/** ***************************************************************************/ +bool Files::Extension::followSymlinks() const { + return d->indexSettings.followSymlinks(); +} + + + +/** ***************************************************************************/ +void Files::Extension::setFollowSymlinks(bool b) { + settings().setValue(CFG_FOLLOW_SYMLINKS, b); + d->indexSettings.setFollowSymlinks(b); +} + + + +/** ***************************************************************************/ +unsigned int Files::Extension::scanInterval() const { + return static_cast(d->indexIntervalTimer.interval()/60000); +} + + + +/** ***************************************************************************/ +void Files::Extension::setScanInterval(uint minutes) { + settings().setValue(CFG_SCAN_INTERVAL, minutes); + (minutes == 0) ? d->indexIntervalTimer.stop() + : d->indexIntervalTimer.start(static_cast(minutes*60000)); +} + + + +/** ***************************************************************************/ +bool Files::Extension::fuzzy() const { + return d->offlineIndex.fuzzy(); +} + + + +/** ***************************************************************************/ +void Files::Extension::setFuzzy(bool b) { + settings().setValue(CFG_FUZZY, b); + d->offlineIndex.setFuzzy(b); +} + + + +/** ***************************************************************************/ +QStringList Files::Extension::filters() const { + QStringList retval; + for ( auto const & regex : d->indexSettings.filters() ) + retval.push_back(regex.pattern()); + return retval; +} + + + +/** ***************************************************************************/ +void Files::Extension::setFilters(const QStringList &filters) { + settings().setValue(CFG_FILTERS, filters); + d->indexSettings.setFilters(filters); +} diff --git a/plugins/files/src/extension.h b/plugins/files/src/extension.h new file mode 100644 index 0000000..6b0866d --- /dev/null +++ b/plugins/files/src/extension.h @@ -0,0 +1,63 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +namespace Files { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + + Q_PROPERTY(QStringList paths READ paths WRITE setPaths NOTIFY pathsChanged) + +public: + + Extension(); + ~Extension(); + + QString name() const override { return "Files"; } + QStringList triggers() const override { return {"/", "~"}; } + QWidget *widget(QWidget *parent = nullptr) override; + void handleQuery(Core::Query * query) const override; + + const QStringList &paths() const; + void setPaths(const QStringList &); + void restorePaths(); + + bool indexHidden() const; + void setIndexHidden(bool b = true); + + bool followSymlinks() const; + void setFollowSymlinks(bool b = true); + + uint scanInterval() const; + void setScanInterval(uint minutes); + + bool fuzzy() const; + void setFuzzy(bool b = true); + + QStringList filters() const; + void setFilters(const QStringList &); + + void updateIndex(); + +private: + + std::unique_ptr d; + +signals: + + void pathsChanged(const QStringList&); + void statusInfo(const QString&); + +}; +} diff --git a/plugins/files/src/file.cpp b/plugins/files/src/file.cpp new file mode 100644 index 0000000..a6b61ba --- /dev/null +++ b/plugins/files/src/file.cpp @@ -0,0 +1,128 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "file.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include "xdg/iconlookup.h" +#include "albert/util/standardactions.h" +using namespace std; +using namespace Core; +extern QString terminalCommand; + + +/** ***************************************************************************/ +QString Files::File::id() const { + return filePath(); +} + + +/** ***************************************************************************/ +QString Files::File::text() const { + return name(); +} + + +/** ***************************************************************************/ +QString Files::File::subtext() const { + return path(); +} + + +/** ***************************************************************************/ +QString Files::File::completion() const { + const QString &path = filePath(); + QString result = ( QFileInfo(path).isDir() ) ? QString("%1/").arg(path) : path; +#ifdef __linux__ + if ( result.startsWith(QDir::homePath()) ) + result.replace(QDir::homePath(), "~"); +#endif + return result; +} + + +/** ***************************************************************************/ +QString Files::File::iconPath() const { + QString icon = XDG::IconLookup::iconPath({mimetype().iconName(), mimetype().genericIconName(), "unknown"}); + if ( !icon.isEmpty() ) + return icon; + + // Nothing found, return a fallback icon + return (mimetype().iconName() == "inode-directory") ? ":directory" : ":unknown"; +} + + +/** ***************************************************************************/ +vector> Files::File::actions() { + return buildFileActions(filePath()); +} + +/** ***************************************************************************/ +std::vector > Files::File::buildFileActions(const QString &filePath) +{ + vector> actions; + + actions.push_back(make_shared("Open with default application", + QUrl::fromLocalFile(filePath))); + + QFileInfo fileInfo(filePath); + if ( fileInfo.isFile() && fileInfo.isExecutable() ) + actions.push_back(make_shared("Execute file", QStringList{filePath})); + + + actions.push_back(make_shared("Reveal in file browser", + QUrl::fromLocalFile(QFileInfo(filePath).path()))); + + + actions.push_back(make_shared("Open terminal at this path", [filePath](){ + QFileInfo fileInfo(filePath); + QStringList commandLine = terminalCommand.trimmed().split(' '); + if ( commandLine.size() == 0 ) + return; + QProcess::startDetached(commandLine[0], {}, fileInfo.isDir() ? fileInfo.filePath() : fileInfo.path()); + })); + + actions.push_back(make_shared("Copy file to clipboard", [filePath](){ + // Get clipboard + QClipboard *cb = QApplication::clipboard(); + + // Ownership of the new data is transferred to the clipboard. + QMimeData* newMimeData = new QMimeData(); + + // Copy old mimedata + const QMimeData* oldMimeData = cb->mimeData(); + for (const QString &f : oldMimeData->formats()) + newMimeData->setData(f, oldMimeData->data(f)); + + // Copy path of file + newMimeData->setText(filePath); + + // Copy file + newMimeData->setUrls({QUrl::fromLocalFile(filePath)}); + + // Copy file (f*** you gnome) + QByteArray gnomeFormat = QByteArray("copy\n").append(QUrl::fromLocalFile(filePath).toEncoded()); + newMimeData->setData("x-special/gnome-copied-files", gnomeFormat); + + // Set the mimedata + cb->setMimeData(newMimeData); + })); + + actions.push_back(make_shared("Copy path to clipboard", filePath)); + + return actions; + +} + +/** ***************************************************************************/ +vector Files::File::indexStrings() const { + vector res; + res.emplace_back(name(), UINT_MAX); + // TODO ADD PATH + return res; +} diff --git a/plugins/files/src/file.h b/plugins/files/src/file.h new file mode 100644 index 0000000..8fe1630 --- /dev/null +++ b/plugins/files/src/file.h @@ -0,0 +1,40 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include "albert/indexable.h" + +namespace Files { + +class File : public Core::IndexableItem +{ +public: + + QString id() const override; + QString text() const override; + QString subtext() const override; + QString completion() const override; + QString iconPath() const override; + std::vector indexStrings() const override; + std::vector> actions() override; + + static std::vector> buildFileActions(const QString &filePath); + + /** Return the filename of the file */ + virtual QString name() const = 0; + + /** Return the path exclusive the filename of the file */ + virtual QString path() const = 0; + + /** Return the path inclusive the filename of the file */ + virtual QString filePath() const = 0; + + /** Return the mimetype of the file */ + virtual const QMimeType &mimetype() const = 0; + +}; + +} diff --git a/plugins/files/src/indexfile.cpp b/plugins/files/src/indexfile.cpp new file mode 100644 index 0000000..d012370 --- /dev/null +++ b/plugins/files/src/indexfile.cpp @@ -0,0 +1,36 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include "indexfile.h" +#include "indextreenode.h" +using namespace std; + + + +/** ***************************************************************************/ +Files::IndexFile::IndexFile(QString name, const shared_ptr &pathNode, QMimeType mimetype) + : name_(name), pathNode_(pathNode), mimetype_(mimetype) { } + + +/** ***************************************************************************/ +QString Files::IndexFile::name() const { + return name_; +} + + +/** ***************************************************************************/ +QString Files::IndexFile::path() const { + return pathNode_->path(); +} + + +/** ***************************************************************************/ +QString Files::IndexFile::filePath() const { + return QDir(pathNode_->path()).filePath(name_); +} + +/** ***************************************************************************/ +const QMimeType &Files::IndexFile::mimetype() const { + return mimetype_; +} diff --git a/plugins/files/src/indexfile.h b/plugins/files/src/indexfile.h new file mode 100644 index 0000000..e1e80a8 --- /dev/null +++ b/plugins/files/src/indexfile.h @@ -0,0 +1,34 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include "file.h" + +namespace Files { + +class IndexTreeNode; + +class IndexFile : public File +{ +public: + + IndexFile(QString name, const std::shared_ptr &pathNode, QMimeType mimetype); + + QString name() const override; + QString path() const override; + QString filePath() const override; + const QMimeType &mimetype() const override; + +protected: + + + QString name_; + std::shared_ptr pathNode_; + QMimeType mimetype_; + +}; + +} diff --git a/plugins/files/src/indextreenode.cpp b/plugins/files/src/indextreenode.cpp new file mode 100644 index 0000000..d8cefc0 --- /dev/null +++ b/plugins/files/src/indextreenode.cpp @@ -0,0 +1,309 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include "indextreenode.h" +#include "indexfile.h" +using namespace std; + + +/**************************************************************************************************/ +Files::IndexTreeNode::IndexTreeNode() { } + + + +/**************************************************************************************************/ +Files::IndexTreeNode::IndexTreeNode(QString name, QDateTime lastModified, shared_ptr parent) + : enable_shared_from_this(), parent(parent), name(name), lastModified(lastModified) { } + + +/**************************************************************************************************/ +Files::IndexTreeNode::IndexTreeNode(QString name, shared_ptr parent) + : IndexTreeNode(name, QDateTime::fromMSecsSinceEpoch(0), parent) { } + + +/**************************************************************************************************/ +Files::IndexTreeNode::IndexTreeNode(const IndexTreeNode &other) + : enable_shared_from_this(), + children(other.children), + name(other.name), + lastModified(other.lastModified), + items_(other.items_) { } + + +/**************************************************************************************************/ +Files::IndexTreeNode::~IndexTreeNode() { + removeDownlinks(); +} + + +/**************************************************************************************************/ +void Files::IndexTreeNode::accept(Visitor &visitor) { + visitor.visit(this); + for ( auto & child : children ) + child->accept(visitor); +} + + +/**************************************************************************************************/ +void Files::IndexTreeNode::removeDownlinks() { + for ( shared_ptr & child : children ) + child->removeDownlinks(); + children.clear(); + items_.clear(); +} + + +/**************************************************************************************************/ +QString Files::IndexTreeNode::path() const { + return ( parent ) ? QDir(parent->path()).filePath(name) : name; +} + + +/**************************************************************************************************/ +void Files::IndexTreeNode::update(const bool &abort, IndexSettings indexSettings) { + set indexedDirs; + QMimeDatabase mimeDatabase; + updateRecursion(abort, mimeDatabase, indexSettings, &indexedDirs); +} + + +/**************************************************************************************************/ +QJsonObject Files::IndexTreeNode::serialize(){ + + QJsonObject jsonNode; + + jsonNode.insert("name", this->name); + jsonNode.insert("lastmodified", this->lastModified.toMSecsSinceEpoch()); + + QJsonArray itemArray; + for ( const shared_ptr &file : items_ ) { + QJsonObject jsonFile; + jsonFile.insert("name", file->name()); + jsonFile.insert("mimetype", file->mimetype().name()); + itemArray.push_back(jsonFile); + } + jsonNode.insert("items", itemArray); + + QJsonArray nodeArray; + for ( const shared_ptr &childNode : children ) + nodeArray.push_back(childNode->serialize()); + jsonNode.insert("children", nodeArray); + + return jsonNode; +} + + +/**************************************************************************************************/ +void Files::IndexTreeNode::deserialize(const QJsonObject &object, shared_ptr parent) { + + this->parent = parent; + name = object["name"].toString(); + lastModified = QDateTime::fromMSecsSinceEpoch(object["lastmodified"].toVariant().toLongLong()); + + for (const QJsonValueRef child : object["children"].toArray()) { + children.push_back(make_shared()); // Invalid node + children.back()->deserialize(child.toObject(), shared_from_this()); + } + + for (const QJsonValueRef item : object["items"].toArray()){ + const QJsonObject &object = item.toObject(); + items_.push_back(make_shared( + object["name"].toString(), + shared_from_this(), + QMimeDatabase().mimeTypeForName(object["mimetype"].toString()))); + } +} + + +/**************************************************************************************************/ +const std::vector > &Files::IndexTreeNode::items() const { + return items_; +} + + +/**************************************************************************************************/ +void Files::IndexTreeNode::updateRecursion(const bool &abort, + const QMimeDatabase &mimeDatabase, + const IndexSettings &indexSettings, + std::set *indexedDirs, + const vector &ignoreEntries){ + const QFileInfo fileInfo(path()); + + // Skip if this dir has already been indexed (loop detection) + if ( indexedDirs->count(fileInfo.canonicalFilePath()) ) + return; + + // Read the ignore file, see http://doc.qt.io/qt-5/qregexp.html#wildcard-matching + vector localIgnoreEntries = ignoreEntries; + QFile file(QDir(fileInfo.filePath()).filePath(IGNOREFILE)); + if ( file.open(QIODevice::ReadOnly | QIODevice::Text) ) { + QTextStream in(&file); + while ( !in.atEnd() ) { + QString pattern = QDir::cleanPath(in.readLine()); + + if ( pattern.isEmpty() || pattern.startsWith("#") ) + continue; + + // Replace ** and * by their regex analogons + pattern.replace(QRegularExpression("(?insert(fileInfo.canonicalFilePath()); + + QString absFilePath = fileInfo.absoluteFilePath(); + qDebug() << "Indexing directory " << absFilePath; + + lastModified = fileInfo.lastModified(); + + // Drop nonexistant child nodes + decltype(children)::iterator childIt = children.begin(); + while ( childIt != children.end() ) + if ( !QFile::exists((*childIt)->path()) ) { + (*childIt)->removeDownlinks(); + childIt = children.erase(childIt); + } else + ++childIt; + + + // Handle the directory contents + items_.clear(); + auto filters = QDir::Files | QDir::Dirs | QDir::NoDotAndDotDot | QDir::Hidden; + for ( const QFileInfo &fileInfo : QDir(absFilePath).entryInfoList(filters, QDir::Name) ){ + + // Skip check if this file should be excluded + PatternType patternType = PatternType::Include; + for ( const IgnoreEntry &ignoreEntry : localIgnoreEntries ) + if ( ignoreEntry.regex.match(fileInfo.filePath()).hasMatch() ) + patternType = ignoreEntry.type; + + // Add directories as nodes + if ( fileInfo.isDir() ) { + + // Get the place where the item were if would exist in log(n) time + decltype(children)::iterator lb = lower_bound( + children.begin(), children.end(), fileInfo.fileName(), + [&](const shared_ptr & child, QString name) { + return child->name < name; + }); + + if ( lb == children.end() || (*lb)->name != fileInfo.fileName() ) { + // If does not exist and is valid insert + if (!( patternType == PatternType::Exclude // Skip check if this file should be excluded + || ( fileInfo.isSymLink() && !indexSettings.followSymlinks() ) // Skip if symlink and we should skip these + || ( fileInfo.isHidden() && !indexSettings.indexHidden() ))) // Skip if hidden and we should skip these + children.insert(lb, make_shared(fileInfo.fileName(), shared_from_this())); + } + else if (patternType == PatternType::Exclude // Skip check if this file should be excluded + || ( fileInfo.isSymLink() && !indexSettings.followSymlinks() ) // Skip if symlink and we should skip these + || ( fileInfo.isHidden() && !indexSettings.indexHidden() )) { // Skip if hidden and we should skip these + // If does exist and is invalid remove node + (*lb)->removeDownlinks(); + children.erase(lb); + } + } + + // Add entries as items + const QMimeType mimetype = mimeDatabase.mimeTypeForFile(fileInfo.filePath()); + const QString mimeName = mimetype.name(); + + // If the entry is valid and a mime filter matches add it to the items + if (!( patternType == PatternType::Exclude // Skip check if this file should be excluded + || ( fileInfo.isHidden() && !indexSettings.indexHidden()) ) // Skip if hidden and we should skip these + && any_of(indexSettings.filters().begin(), indexSettings.filters().end(), + [&](const QRegExp &re){ return re.exactMatch(mimeName); }) ) + items_.push_back(make_shared(fileInfo.fileName(), + shared_from_this(), + mimetype)); + } + } + + // Recursively check all childnodes too + for ( auto it = children.begin(); !abort && it < children.end(); ++it) + (*it)->updateRecursion(abort, mimeDatabase, indexSettings, indexedDirs, localIgnoreEntries); + +} + + +/**************************************************************************************************/ +/**************************************************************************************************/ + + +const std::vector &Files::IndexSettings::filters() const { + return mimefilters_; +} + +void Files::IndexSettings::setFilters(std::vector value) { + forceUpdate_= true; + mimefilters_= value; +} + +void Files::IndexSettings::setFilters(QStringList value) { + forceUpdate_= true; + mimefilters_.clear(); + for ( const QString &re : value ) + mimefilters_.emplace_back(re, Qt::CaseInsensitive, QRegExp::Wildcard); +} + +bool Files::IndexSettings::indexHidden() const { + return indexHidden_; +} + +void Files::IndexSettings::setIndexHidden(bool value) { + forceUpdate_= true; + indexHidden_= value; +} + +bool Files::IndexSettings::followSymlinks() const { + return followSymlinks_; +} + +void Files::IndexSettings::setFollowSymlinks(bool value) { + forceUpdate_= true; + followSymlinks_= value; +} + +bool Files::IndexSettings::forceUpdate() const { + return forceUpdate_; +} + +void Files::IndexSettings::setForceUpdate(bool value) { + forceUpdate_= value; +} + +bool Files::IndexSettings::fuzzy() const { + return fuzzy_; +} + +void Files::IndexSettings::setFuzzy(bool value) { + fuzzy_= value; +} + + +/**************************************************************************************************/ +/**************************************************************************************************/ diff --git a/plugins/files/src/indextreenode.h b/plugins/files/src/indextreenode.h new file mode 100644 index 0000000..27e5af6 --- /dev/null +++ b/plugins/files/src/indextreenode.h @@ -0,0 +1,111 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "indexfile.h" + +namespace Files { + +class Visitor; +class IndexSettings; + +enum class PatternType { + Include, + Exclude +}; + +struct IgnoreEntry { + IgnoreEntry(QRegularExpression regex, PatternType type) : regex(regex), type(type) {} + QRegularExpression regex; + PatternType type; +}; + +class IndexTreeNode final : public std::enable_shared_from_this +{ +public: + + IndexTreeNode(); + IndexTreeNode(const IndexTreeNode & other); + IndexTreeNode(QString name, QDateTime lastModified, std::shared_ptr parent = std::shared_ptr()); + IndexTreeNode(QString name, std::shared_ptr parent = std::shared_ptr()); + ~IndexTreeNode(); + + void accept(Visitor &visitor); + + void removeDownlinks(); + + QString path() const; + + void update(const bool &abort, IndexSettings indexSettings); + + QJsonObject serialize(); + void deserialize(const QJsonObject &, std::shared_ptr parent = std::shared_ptr()); + + const std::vector > &items() const; + +private: + + void updateRecursion(const bool &abort, + const QMimeDatabase &mimeDatabase, + const IndexSettings &indexSettings, + std::set *indexedDirs, + const std::vector &ignoreEntries = std::vector()); + + std::shared_ptr parent; + std::vector> children; + QString name; + QDateTime lastModified; + std::vector> items_; + + static constexpr const char* IGNOREFILE = ".albertignore"; +}; + + +/** ***********************************************************************************************/ +class IndexSettings +{ +public: + const std::vector &filters() const; + void setFilters(std::vector value); + void setFilters(QStringList value); + + bool indexHidden() const; + void setIndexHidden(bool value); + + bool followSymlinks() const; + void setFollowSymlinks(bool value); + + bool forceUpdate() const; + void setForceUpdate(bool value); + + bool fuzzy() const; + void setFuzzy(bool value); + + +private: + + std::vector mimefilters_; + bool indexHidden_ = false; + bool followSymlinks_ = false; + bool fuzzy_ = false; + bool forceUpdate_ = false; // Ignore lastModified, force update + +}; + + +/** ***********************************************************************************************/ +class Visitor { +public: + virtual ~Visitor() { } + virtual void visit(IndexTreeNode *) = 0; +}; + +} diff --git a/plugins/files/src/mimetypedialog.cpp b/plugins/files/src/mimetypedialog.cpp new file mode 100644 index 0000000..de6a4be --- /dev/null +++ b/plugins/files/src/mimetypedialog.cpp @@ -0,0 +1,140 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include "mimetypedialog.h" +#include "ui_mimetypedialog.h" + + +/** ***************************************************************************/ +Files::MimeTypeDialog::MimeTypeDialog(const QStringList &filters, QWidget *parent) : + QDialog(parent), ui(new Ui::MimeTypeDialog) { + ui->setupUi(this); + + // Populate a standard itemmodel with mime types + QStandardItemModel *standardItemModel = new QStandardItemModel(this); + QList items; + for (QMimeType mimeType : QMimeDatabase().allMimeTypes()) { + QStandardItem *item = new QStandardItem(mimeType.name()); + item->setToolTip(mimeType.filterString()); + item->setData(mimeType.iconName()); + items.append(item); + } + standardItemModel->appendColumn(items); + standardItemModel->sort(0); + + // Get the images in background + auto bg_task = [this, standardItemModel](){ + static QIcon fallback = QIcon::fromTheme("unknown"); // TODO: resource fallback + for (int i = 0; i < standardItemModel->rowCount(); ++i) { + QStandardItem *item = standardItemModel->item(i); + item->setIcon(QIcon::fromTheme(item->data().toString(), fallback)); + if (exit_thread) + break; + } + qDebug() << "DONE"; + }; + + future = QtConcurrent::run(bg_task); + + // Add a proxy model for mimtype filtering + QSortFilterProxyModel *mimeFilterModel = new QSortFilterProxyModel(this); + mimeFilterModel->setSourceModel(standardItemModel); + ui->listView_mimeTypes->setModel(mimeFilterModel); + + // Add a stinglist model to the filter model + filtersModel = new QStringListModel(filters, this); + ui->listView_filters->setModel(filtersModel); + + // Set the filter for the proxymodel if the users typed something + connect(ui->lineEdit, &QLineEdit::textChanged, + mimeFilterModel, &QSortFilterProxyModel::setFilterFixedString); + + // On mimetype list activation add the mimetype to the filter list + connect(ui->listView_mimeTypes, &QListView::activated, [this](const QModelIndex &index){ + filtersModel->insertRow(filtersModel->rowCount()); + filtersModel->setData(filtersModel->index(filtersModel->rowCount()-1,0), index.data()); + }); + + // On ">" button click add the mimetype to the filter list + connect(ui->toolButton_copyMimetype, &QToolButton::clicked, [this](){ + QModelIndex index = ui->listView_mimeTypes->currentIndex(); + filtersModel->insertRow(filtersModel->rowCount()); + filtersModel->setData(filtersModel->index(filtersModel->rowCount()-1,0), index.data()); + }); + + // Add a new line on "+" + connect(ui->toolButton_add, &QToolButton::clicked, [this](){ + int row = filtersModel->rowCount(); + filtersModel->insertRow(row); + ui->listView_filters->setCurrentIndex(filtersModel->index(row, 0)); + ui->listView_filters->edit(filtersModel->index(row, 0)); + }); + + // Remove the selected line on "-" + connect(ui->toolButton_remove, &QToolButton::clicked, [this](){ + QModelIndex index = ui->listView_filters->currentIndex(); + if ( index.isValid() ) + filtersModel->removeRow(index.row()); + }); + + // Let the listview intercept the input of the filter line edit (for navigation and activation) + ui->lineEdit->installEventFilter(this); +} + + + +/** ***************************************************************************/ +Files::MimeTypeDialog::~MimeTypeDialog() { + exit_thread = true; + future.waitForFinished(); + delete ui; +} + + + +/** ***************************************************************************/ +QStringList Files::MimeTypeDialog::filters() const { + return filtersModel->stringList(); +} + + + +/** ***************************************************************************/ +bool Files::MimeTypeDialog::eventFilter(QObject * /*theres only the linedit*/, QEvent *event) { + + if (event->type() == QEvent::KeyPress) { + QKeyEvent *keyEvent = static_cast(event); + switch (keyEvent->key()) { + case Qt::Key_Up: + case Qt::Key_Down: + case Qt::Key_Enter: + case Qt::Key_Return: + QApplication::sendEvent(ui->listView_mimeTypes, keyEvent); + return true; + default: + return false; + } + } + return false; +} + + + +/** ***************************************************************************/ +void Files::MimeTypeDialog::keyPressEvent(QKeyEvent *evt) { + // Eat keys for desired behaviour + switch ( evt->key() ) { + case Qt::Key_Enter: + case Qt::Key_Return: + case Qt::Key_Escape: + return; + } + QDialog::keyPressEvent(evt); +} diff --git a/plugins/files/src/mimetypedialog.h b/plugins/files/src/mimetypedialog.h new file mode 100644 index 0000000..f6aa11a --- /dev/null +++ b/plugins/files/src/mimetypedialog.h @@ -0,0 +1,35 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include + +namespace Files{ +namespace Ui { +class MimeTypeDialog; +} + +class MimeTypeDialog : public QDialog +{ + Q_OBJECT + +public: + + explicit MimeTypeDialog(const QStringList &filters, QWidget *parent = nullptr); + ~MimeTypeDialog() override; + + QStringList filters() const; + +protected: + + bool eventFilter(QObject *watched, QEvent *event) override; + void keyPressEvent(QKeyEvent *evt) override; + + QStringListModel *filtersModel; + Ui::MimeTypeDialog *ui; + bool exit_thread; + QFuture future; + +}; +} diff --git a/plugins/files/src/mimetypedialog.ui b/plugins/files/src/mimetypedialog.ui new file mode 100644 index 0000000..19d9e1d --- /dev/null +++ b/plugins/files/src/mimetypedialog.ui @@ -0,0 +1,222 @@ + + + Files::MimeTypeDialog + + + + 0 + 0 + 600 + 480 + + + + MIME filters + + + + 4 + + + 4 + + + 4 + + + 4 + + + + + <html><head/><body><p style=" color:#808080;"> +Choose the MIME types you want to be indexed by the files extension. The left box contains the known MIME types. Use it to find your desired MIME types. The right box contains the list of patterns that is used to filter the indexed files by matching their MIME type. The patterns support wildcard matching. Check the <a href="https://albertlauncher.github.io/docs/extensions/files/#mime-filters">docs</a> for more details and examples. +</p></body></html> + + + true + + + true + + + + + + + + + MIME Types + + + + 4 + + + 4 + + + 4 + + + 4 + + + + + Qt::ScrollBarAlwaysOn + + + false + + + + 22 + 22 + + + + QListView::Batched + + + + 0 + 24 + + + + true + + + + + + + Filter for the mimetypes… + + + + + + + + + + + + + Filter patterns + + + + 4 + + + 4 + + + 4 + + + 4 + + + + + Qt::ScrollBarAlwaysOn + + + false + + + + 0 + 24 + + + + + + + + + + > + + + + .. + + + + + + + + .. + + + + + + + + .. + + + + + + + + + + + + + + + + + QDialogButtonBox::Cancel|QDialogButtonBox::Ok + + + + + + + + + buttonBox + accepted() + Files::MimeTypeDialog + accept() + + + 248 + 254 + + + 157 + 274 + + + + + buttonBox + rejected() + Files::MimeTypeDialog + reject() + + + 316 + 260 + + + 286 + 274 + + + + + diff --git a/plugins/files/src/standardfile.cpp b/plugins/files/src/standardfile.cpp new file mode 100644 index 0000000..16f2b2e --- /dev/null +++ b/plugins/files/src/standardfile.cpp @@ -0,0 +1,38 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include "standardfile.h" +using namespace std; + + +/** ***************************************************************************/ +Files::StandardFile::StandardFile(QString path, QMimeType mimetype) + : mimetype_(mimetype){ + QFileInfo fileInfo(path); + name_ = fileInfo.fileName(); + path_ = fileInfo.canonicalPath(); +} + + +/** ***************************************************************************/ +QString Files::StandardFile::name() const { + return name_; +} + + +/** ***************************************************************************/ +QString Files::StandardFile::path() const { + return path_; +} + + +/** ***************************************************************************/ +QString Files::StandardFile::filePath() const { + return QDir(path_).filePath(name_); +} + +/** ***************************************************************************/ +const QMimeType &Files::StandardFile::mimetype() const { + return mimetype_; +} diff --git a/plugins/files/src/standardfile.h b/plugins/files/src/standardfile.h new file mode 100644 index 0000000..6cb25ee --- /dev/null +++ b/plugins/files/src/standardfile.h @@ -0,0 +1,31 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include "file.h" + +namespace Files { + +class StandardFile : public File +{ +public: + + StandardFile(QString path, QMimeType mimetype); + + QString name() const override; + QString path() const override; + QString filePath() const override; + const QMimeType &mimetype() const override; + +protected: + + QString name_; + QString path_; + QMimeType mimetype_; + +}; + +} diff --git a/plugins/firefoxbookmarks/CMakeLists.txt b/plugins/firefoxbookmarks/CMakeLists.txt new file mode 100644 index 0000000..624da85 --- /dev/null +++ b/plugins/firefoxbookmarks/CMakeLists.txt @@ -0,0 +1,22 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(firefoxbookmarks) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets Concurrent Sql) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Concurrent + Qt5::Sql + Qt5::Widgets + albert::lib + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) diff --git a/plugins/firefoxbookmarks/firefoxbookmarks.qrc b/plugins/firefoxbookmarks/firefoxbookmarks.qrc new file mode 100644 index 0000000..ee1f574 --- /dev/null +++ b/plugins/firefoxbookmarks/firefoxbookmarks.qrc @@ -0,0 +1,5 @@ + + + resources/favicon.png + + diff --git a/plugins/firefoxbookmarks/metadata.json b/plugins/firefoxbookmarks/metadata.json new file mode 100644 index 0000000..e12540e --- /dev/null +++ b/plugins/firefoxbookmarks/metadata.json @@ -0,0 +1,10 @@ +{ + "id" : "org.albert.extension.firefoxbookmarks", + "name" : "Firefox bookmarks", + "version" : "1.0", + "platform" : "All", + "group" : "Extensions", + "author" : "Martin Buergmann, Manuel Schneider", + "dependencies" : ["firefox"], + "enabledbydefault": false +} diff --git a/plugins/firefoxbookmarks/resources/favicon.png b/plugins/firefoxbookmarks/resources/favicon.png new file mode 100644 index 0000000..dd9ffd5 Binary files /dev/null and b/plugins/firefoxbookmarks/resources/favicon.png differ diff --git a/plugins/firefoxbookmarks/src/configwidget.cpp b/plugins/firefoxbookmarks/src/configwidget.cpp new file mode 100644 index 0000000..40e8b93 --- /dev/null +++ b/plugins/firefoxbookmarks/src/configwidget.cpp @@ -0,0 +1,15 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "configwidget.h" + +/** ***************************************************************************/ +FirefoxBookmarks::ConfigWidget::ConfigWidget(QWidget *parent) : QWidget(parent) { + ui.setupUi(this); +} + + + +/** ***************************************************************************/ +FirefoxBookmarks::ConfigWidget::~ConfigWidget() { + +} diff --git a/plugins/firefoxbookmarks/src/configwidget.h b/plugins/firefoxbookmarks/src/configwidget.h new file mode 100644 index 0000000..25f03ed --- /dev/null +++ b/plugins/firefoxbookmarks/src/configwidget.h @@ -0,0 +1,16 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" + +namespace FirefoxBookmarks { +class ConfigWidget final : public QWidget +{ + Q_OBJECT +public: + explicit ConfigWidget(QWidget *parent = 0); + ~ConfigWidget(); + Ui::ConfigWidget ui; +}; +} diff --git a/plugins/firefoxbookmarks/src/configwidget.ui b/plugins/firefoxbookmarks/src/configwidget.ui new file mode 100644 index 0000000..d85c310 --- /dev/null +++ b/plugins/firefoxbookmarks/src/configwidget.ui @@ -0,0 +1,68 @@ + + + FirefoxBookmarks::ConfigWidget + + + + 0 + 0 + 480 + 320 + + + + + + + Select your firefox profile: + + + + + + + + + + Fuzzy Search + + + true + + + + + + + Open with firefox by default + + + true + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + + + + + + + + diff --git a/plugins/firefoxbookmarks/src/extension.cpp b/plugins/firefoxbookmarks/src/extension.cpp new file mode 100644 index 0000000..ab799b5 --- /dev/null +++ b/plugins/firefoxbookmarks/src/extension.cpp @@ -0,0 +1,419 @@ +// Copyright (C) 2014-2018 Manuel Schneider + + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "extension.h" +#include "configwidget.h" +#include "albert/extension.h" +#include "albert/util/offlineindex.h" +#include "albert/util/standardindexitem.h" +#include "albert/util/standardactions.h" +#include "xdg/iconlookup.h" +using namespace std; +using namespace Core; + +namespace { +const QString CFG_PROFILE = "profile"; +const QString CFG_FUZZY = "fuzzy"; +const bool DEF_FUZZY = false; +const QString CFG_USE_FIREFOX = "openWithFirefox"; +const bool DEF_USE_FIREFOX = false; +const uint UPDATE_DELAY = 60000; +} + + + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +class FirefoxBookmarks::Private +{ +public: + Private(Extension *q) : q(q) {} + + Extension *q; + + bool openWithFirefox; + QPointer widget; + QString firefoxExecutable; + QString profilesIniPath; + QString currentProfileId; + QString dbPath; + QFileSystemWatcher databaseWatcher; + + vector> index; + Core::OfflineIndex offlineIndex; + + QTimer updateDelayTimer; + void startIndexing(); + void finishIndexing(); + QFutureWatcher>> futureWatcher; + vector> indexFirefoxBookmarks() const; +}; + + +/** ***************************************************************************/ +void FirefoxBookmarks::Private::startIndexing() { + + // Never run concurrent + if ( futureWatcher.future().isRunning() ) + return; + + // Run finishIndexing when the indexing thread finished + futureWatcher.disconnect(); + QObject::connect(&futureWatcher, &QFutureWatcher>>::finished, + bind(&Private::finishIndexing, this)); + + // Run the indexer thread + futureWatcher.setFuture(QtConcurrent::run(this, &Private::indexFirefoxBookmarks)); + + // Notification + qInfo() << "Start indexing Firefox bookmarks."; + emit q->statusInfo("Indexing bookmarks ..."); +} + + +/** ***************************************************************************/ +void FirefoxBookmarks::Private::finishIndexing() { + + // Get the thread results + index = futureWatcher.future().result(); + + // Rebuild the offline index + offlineIndex.clear(); + for (const auto &item : index) + offlineIndex.add(item); + + // Notification + qInfo() << qPrintable(QString("Indexed %1 Firefox bookmarks.").arg(index.size())); + emit q->statusInfo(QString("%1 bookmarks indexed.").arg(index.size())); +} + + + +/** ***************************************************************************/ +vector> +FirefoxBookmarks::Private::indexFirefoxBookmarks() const { + // Build a new index + vector> bookmarks; + + { + QSqlDatabase database = QSqlDatabase::addDatabase("QSQLITE", q->Core::Plugin::id());; + database.setDatabaseName(dbPath); + + if (!database.open()) { + qWarning() << qPrintable(QString("Could not open Firefox database: %1").arg(database.databaseName())); + return vector>(); + } + + QSqlQuery result(database); + + if ( !result.exec("SELECT bookmarks.guid, bookmarks.title, places.url " + "FROM moz_bookmarks bookmarks " + "JOIN moz_bookmarks parents ON bookmarks.parent = parents.id AND parents.parent <> 4 " + "JOIN moz_places places ON bookmarks.fk = places.id " + "WHERE NOT hidden") ) { // Those with place:... will not work with xdg-open + qWarning() << qPrintable(QString("Querying Firefox bookmarks failed: %1").arg(result.lastError().text())); + return vector>(); + } + + // Find an appropriate icon + QString icon = XDG::IconLookup::iconPath({"www", "web-browser", "emblem-web"}); + icon = icon.isEmpty() ? ":favicon" : icon; + + while (result.next()) { + + // Url will be used more often + QString urlstr = result.value(2).toString(); + + // Create item + shared_ptr item = make_shared(result.value(0).toString()); + item->setText(result.value(1).toString()); + item->setSubtext(urlstr); + item->setIconPath(icon); + + // Add severeal secondary index keywords + vector indexStrings; + QUrl url(urlstr); + QString host = url.host(); + indexStrings.emplace_back(item->text(), UINT_MAX); + indexStrings.emplace_back(host.left(host.size()-url.topLevelDomain().size()), UINT_MAX/2); + indexStrings.emplace_back(result.value(2).toString(), UINT_MAX/4); // parent dirname + item->setIndexKeywords(move(indexStrings)); + + // Add actions + vector> actions; + actions.push_back(make_shared("Open URL in Firefox", + QStringList({firefoxExecutable, urlstr}))); + actions.push_back(make_shared("Open URL in new Firefox window", + QStringList({firefoxExecutable, "--new-window", urlstr}))); + actions.insert(openWithFirefox ? actions.end() : actions.begin(), + make_shared("Open URL in your default browser", urlstr)); + actions.push_back(make_shared("Copy url to clipboard", urlstr)); + item->setActions(move(actions)); + + bookmarks.push_back(move(item)); + } + + database.close(); + } + + QSqlDatabase::removeDatabase(q->Core::Plugin::id()); + + return bookmarks; +} + + + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +FirefoxBookmarks::Extension::Extension() + : Core::Extension("org.albert.extension.firefoxbookmarks"), + Core::QueryHandler(Core::Plugin::id()), + d(new Private(this)){ + + registerQueryHandler(this); + + // Add a sqlite database connection for this extension, check requirements + { + QSqlDatabase db = QSqlDatabase::addDatabase("QSQLITE", Core::Plugin::id()); + if ( !db.isValid() ) + throw "Invalid Database."; + if (!db.driver()->hasFeature(QSqlDriver::Transactions)) + throw "DB Driver does not support transactions."; + } + QSqlDatabase::removeDatabase(Core::Plugin::id()); + + // Find firefox executable + d->firefoxExecutable = QStandardPaths::findExecutable("firefox"); + if (d->firefoxExecutable.isEmpty()) + throw "Firefox executable not found."; + + // Locate profiles ini + d->profilesIniPath = QStandardPaths::locate(QStandardPaths::HomeLocation, + ".mozilla/firefox/profiles.ini", + QStandardPaths::LocateFile); + if (d->profilesIniPath.isEmpty()) // Try a windowsy approach + d->profilesIniPath = QStandardPaths::locate(QStandardPaths::DataLocation, + "Mozilla/firefox/profiles.ini", + QStandardPaths::LocateFile); + if (d->profilesIniPath.isEmpty()) + throw "Could not locate profiles.ini."; + + // Load the settings + d->currentProfileId = settings().value(CFG_PROFILE).toString(); + d->offlineIndex.setFuzzy(settings().value(CFG_FUZZY, DEF_FUZZY).toBool()); + d->openWithFirefox = settings().value(CFG_USE_FIREFOX, DEF_USE_FIREFOX).toBool(); + + // If the id does not exist find a proper default + QSettings profilesIni(d->profilesIniPath, QSettings::IniFormat); + if ( !profilesIni.contains(d->currentProfileId) ){ + + d->currentProfileId = QString(); + + QStringList ids = profilesIni.childGroups(); + if ( ids.isEmpty() ) + qWarning() << "No Firefox profiles found."; + else { + + // Use the last used profile + if ( d->currentProfileId.isNull() ) { + for (QString &id : ids) { + profilesIni.beginGroup(id); + if ( profilesIni.contains("Default") + && profilesIni.value("Default").toBool() ) { + d->currentProfileId = id; + } + profilesIni.endGroup(); + } + } + + // Use the default profile + if ( d->currentProfileId.isNull() && ids.contains("default")) { + d->currentProfileId = "default"; + } + + // Use the first + d->currentProfileId = ids[0]; + } + } + + // Set the profile + setProfile(d->currentProfileId); + + // Delay the indexing to avoid excessice resource consumption + d->updateDelayTimer.setInterval(UPDATE_DELAY); + d->updateDelayTimer.setSingleShot(true); + + // If the database changed, trigger the update delay + connect(&d->databaseWatcher, &QFileSystemWatcher::fileChanged, + &d->updateDelayTimer, static_cast(&QTimer::start)); + + // If the update delay passed, update the index + connect(&d->updateDelayTimer, &QTimer::timeout, + bind(&Private::startIndexing, d.get())); +} + + + +/** ***************************************************************************/ +FirefoxBookmarks::Extension::~Extension() { + +} + + + +/** ***************************************************************************/ +QWidget *FirefoxBookmarks::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) { + d->widget = new ConfigWidget(parent); + + // Get the profiles keys + QSettings profilesIni(d->profilesIniPath, QSettings::IniFormat); + QStringList groups = profilesIni.childGroups(); + + // Extract all profiles and names and put it in the checkbox + QComboBox *cmb = d->widget->ui.comboBox; + for (QString &profileId : groups) { + profilesIni.beginGroup(profileId); + + // Use name if available else id + if ( profilesIni.contains("Name") ) + cmb->addItem( QString("%1 (%2)").arg(profilesIni.value("Name").toString(), profileId), profileId); + else { + cmb->addItem(profileId, profileId); + qWarning() << qPrintable(QString("Firefox profile '%1' does not contain a name.").arg(profileId)); + } + + // If the profileId match set the current item of the checkbox + if (profileId == d->currentProfileId) + cmb->setCurrentIndex(cmb->count() - 1); + + profilesIni.endGroup(); + } + + connect(cmb, static_cast(&QComboBox::currentIndexChanged), + this, &Extension::setProfile); + + // Fuzzy + QCheckBox *ckb = d->widget->ui.fuzzy; + ckb->setChecked(d->offlineIndex.fuzzy()); + connect(ckb, &QCheckBox::clicked, this, &Extension::changeFuzzyness); + + // Which app to use + ckb = d->widget->ui.openWithFirefox; + ckb->setChecked(d->openWithFirefox); + connect(ckb, &QCheckBox::clicked, this, &Extension::changeOpenPolicy); + + // Status bar + ( d->futureWatcher.isRunning() ) + ? d->widget->ui.label_statusbar->setText("Indexing bookmarks ...") + : d->widget->ui.label_statusbar->setText(QString("%1 bookmarks indexed.").arg(d->index.size())); + connect(this, &Extension::statusInfo, d->widget->ui.label_statusbar, &QLabel::setText); + + } + return d->widget; +} + + + +/** ***************************************************************************/ +void FirefoxBookmarks::Extension::handleQuery(Core::Query *query) const { + + const vector> &indexables = d->offlineIndex.search(query->string()); + + vector,uint>> results; + for (const shared_ptr &item : indexables) + results.emplace_back(static_pointer_cast(item), 0); + + query->addMatches(make_move_iterator(results.begin()), + make_move_iterator(results.end())); +} + + + +/** ***************************************************************************/ +void FirefoxBookmarks::Extension::setProfile(const QString& profile) { + + d->currentProfileId = profile; + + QSettings profilesIni(d->profilesIniPath, QSettings::IniFormat); + + // Check if profile id is in profiles file + if ( !profilesIni.childGroups().contains(d->currentProfileId) ){ + qWarning() << qPrintable(QString("Firefox user profile '%2' not found.").arg(d->currentProfileId)); + return; + } + + // Enter the group + profilesIni.beginGroup(d->currentProfileId); + + // Check if the profile contains a path key + if ( !profilesIni.contains("Path") ){ + qWarning() << qPrintable(QString("Firefox profile '%2' does not contain a path.").arg(d->currentProfileId)); + return; + } + + // Get the correct absolute profile path + QString profilePath = ( profilesIni.contains("IsRelative") && profilesIni.value("IsRelative").toBool()) + ? QFileInfo(d->profilesIniPath).dir().absoluteFilePath(profilesIni.value("Path").toString()) + : profilesIni.value("Path").toString(); + + // Build the database path + QString dbPath = QString("%1/places.sqlite").arg(profilePath); + + // Set the databases path + d->dbPath = dbPath; + + // Set a file system watcher on the database monitoring changes + if (!d->databaseWatcher.files().isEmpty()) + d->databaseWatcher.removePaths(d->databaseWatcher.files()); + d->databaseWatcher.addPath(dbPath); + + d->startIndexing(); + + settings().setValue(CFG_PROFILE, d->currentProfileId); +} + + + +/** ***************************************************************************/ +void FirefoxBookmarks::Extension::changeFuzzyness(bool fuzzy) { + d->offlineIndex.setFuzzy(fuzzy); + settings().setValue(CFG_FUZZY, fuzzy); +} + + + +/** ***************************************************************************/ +void FirefoxBookmarks::Extension::changeOpenPolicy(bool useFirefox) { + d->openWithFirefox = useFirefox; + settings().setValue(CFG_USE_FIREFOX, useFirefox); + d->startIndexing(); +} diff --git a/plugins/firefoxbookmarks/src/extension.h b/plugins/firefoxbookmarks/src/extension.h new file mode 100644 index 0000000..12db4b2 --- /dev/null +++ b/plugins/firefoxbookmarks/src/extension.h @@ -0,0 +1,41 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" +#include + +namespace FirefoxBookmarks { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension(); + + QString name() const override { return "Firefox bookmarks"; } + QWidget *widget(QWidget *parent = nullptr) override; + void handleQuery(Core::Query * query) const override; + + void setProfile(const QString &profile); + void changeFuzzyness(bool fuzzy); + void changeOpenPolicy(bool withFirefox); + +private: + + std::unique_ptr d; + +signals: + + void statusInfo(const QString&); +}; +} diff --git a/plugins/hashgenerator/CMakeLists.txt b/plugins/hashgenerator/CMakeLists.txt new file mode 100644 index 0000000..640ccc4 --- /dev/null +++ b/plugins/hashgenerator/CMakeLists.txt @@ -0,0 +1,19 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(hashgenerator) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Widgets + albert::lib +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) diff --git a/plugins/hashgenerator/hashgenerator.qrc b/plugins/hashgenerator/hashgenerator.qrc new file mode 100644 index 0000000..298d379 --- /dev/null +++ b/plugins/hashgenerator/hashgenerator.qrc @@ -0,0 +1,5 @@ + + + resources/hash.svg + + diff --git a/plugins/hashgenerator/metadata.json b/plugins/hashgenerator/metadata.json new file mode 100644 index 0000000..5ab967f --- /dev/null +++ b/plugins/hashgenerator/metadata.json @@ -0,0 +1,9 @@ +{ + "id" : "org.albert.extension.hashgenerator", + "name" : "Hash Generator", + "version" : "1.0", + "platform" : "All", + "group" : "Extensions", + "author" : "manuelschneid3r", + "dependencies" : [] +} diff --git a/plugins/hashgenerator/resources/hash.svg b/plugins/hashgenerator/resources/hash.svg new file mode 100644 index 0000000..6c65825 --- /dev/null +++ b/plugins/hashgenerator/resources/hash.svg @@ -0,0 +1 @@ +Width: 2pxBlur: 12Opacity: 60 \ No newline at end of file diff --git a/plugins/hashgenerator/src/configwidget.cpp b/plugins/hashgenerator/src/configwidget.cpp new file mode 100644 index 0000000..074c8b7 --- /dev/null +++ b/plugins/hashgenerator/src/configwidget.cpp @@ -0,0 +1,15 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "configwidget.h" + +/** ***************************************************************************/ +HashGenerator::ConfigWidget::ConfigWidget(QWidget *parent) : QWidget(parent) { + ui.setupUi(this); +} + + + +/** ***************************************************************************/ +HashGenerator::ConfigWidget::~ConfigWidget() { + +} diff --git a/plugins/hashgenerator/src/configwidget.h b/plugins/hashgenerator/src/configwidget.h new file mode 100644 index 0000000..01a25dd --- /dev/null +++ b/plugins/hashgenerator/src/configwidget.h @@ -0,0 +1,16 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" + +namespace HashGenerator { +class ConfigWidget final : public QWidget +{ + Q_OBJECT +public: + explicit ConfigWidget(QWidget *parent = 0); + ~ConfigWidget(); + Ui::ConfigWidget ui; +}; +} diff --git a/plugins/hashgenerator/src/configwidget.ui b/plugins/hashgenerator/src/configwidget.ui new file mode 100644 index 0000000..ddf3fdb --- /dev/null +++ b/plugins/hashgenerator/src/configwidget.ui @@ -0,0 +1,46 @@ + + + HashGenerator::ConfigWidget + + + + 0 + 0 + 480 + 320 + + + + + + + <html> +<head/> +<body> +<p>This is a simple hashing extension. Just type &quot;hash &quot; and the string you would like to hash. You will get a list of items containing the hash value of your string generated with the state of the art hashing algorithms. You can also compute the hash you want directly by using the hash name as prefix, e.g. &quot;md5 Hello world&quot;.</p> +</body> +</html> + + + true + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + diff --git a/plugins/hashgenerator/src/extension.cpp b/plugins/hashgenerator/src/extension.cpp new file mode 100644 index 0000000..e55feb8 --- /dev/null +++ b/plugins/hashgenerator/src/extension.cpp @@ -0,0 +1,118 @@ +// Copyright (C) 2014-2015 Manuel Schneider + +#include +#include +#include +#include +#include +#include "configwidget.h" +#include "albert/util/standardactions.h" +#include "albert/util/standarditem.h" +#include "extension.h" +using namespace std; +using namespace Core; + +namespace { +const QStringList algorithmNames = { + "MD4", + "MD5", + "SHA1", + "SHA224", + "SHA256", + "SHA384", + "SHA512", + "SHA3_224", + "SHA3_256", + "SHA3_384", + "SHA3_512" +}; +} + + +class HashGenerator::Private +{ +public: + QPointer widget; +}; + + + +/** ***************************************************************************/ +HashGenerator::Extension::Extension() + : Core::Extension("org.albert.extension.hashgenerator"), // Must match the id in metadata + Core::QueryHandler(Core::Plugin::id()), + d(new Private) { + registerQueryHandler(this); +} + + + +/** ***************************************************************************/ +HashGenerator::Extension::~Extension() { + +} + + + +/** ***************************************************************************/ +QWidget *HashGenerator::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) { + d->widget = new ConfigWidget(parent); + } + return d->widget; +} + + + +/** ***************************************************************************/ +QStringList HashGenerator::Extension::triggers() const { + return { + "hash ", + "md4 ", + "md5 ", + "sha1 ", + "sha224 ", + "sha256 ", + "sha384 ", + "sha512 ", + "sha3_224 ", + "sha3_256 ", + "sha3_384 ", + "sha3_512 " + }; +} + + +/** ***************************************************************************/ +void HashGenerator::Extension::handleQuery(Core::Query * query) const { + + auto buildItem = [](int algorithm, QString string){ + QCryptographicHash hash(static_cast(algorithm)); + hash.addData(string.toUtf8()); + QByteArray hashString = hash.result().toHex(); + + auto item = make_shared(algorithmNames[algorithm]); + item->setText(QString("%1 of '%2'").arg(algorithmNames[algorithm], string)); + item->setSubtext(hashString); + item->setIconPath(":hash"); + item->setCompletion(QString("%1 %2").arg(algorithmNames[algorithm].toLower(), string)); + item->addAction(make_shared("Copy hash value to clipboard", + QString(hashString))); + return item; + }; + + if ( query->trigger() == "hash " ) { + // Output all hashes + for (int algorithm = 0; algorithm < 11; ++algorithm) + query->addMatch(buildItem(algorithm, query->string())); + } else { + // Output particular hash if name matches + auto it = find(algorithmNames.begin(), algorithmNames.end(), + query->trigger().trimmed().toUpper()); + if (it != algorithmNames.end()) { + int algorithm = static_cast(distance(algorithmNames.begin(), it)); + query->addMatch(buildItem(algorithm, query->string())); + } + } +} + diff --git a/plugins/hashgenerator/src/extension.h b/plugins/hashgenerator/src/extension.h new file mode 100644 index 0000000..7b6f78a --- /dev/null +++ b/plugins/hashgenerator/src/extension.h @@ -0,0 +1,35 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +namespace HashGenerator { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension(); + + QString name() const override { return "Hash Generator"; } + QWidget *widget(QWidget *parent = nullptr) override; + QStringList triggers() const override; + void handleQuery(Core::Query * query) const override; + +private: + + std::unique_ptr d; + +}; +} diff --git a/plugins/mpris/CMakeLists.txt b/plugins/mpris/CMakeLists.txt new file mode 100644 index 0000000..370904e --- /dev/null +++ b/plugins/mpris/CMakeLists.txt @@ -0,0 +1,21 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(mpris) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets DBus) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::DBus + Qt5::Widgets + albert::lib + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) diff --git a/plugins/mpris/metadata.json b/plugins/mpris/metadata.json new file mode 100644 index 0000000..d9ad37d --- /dev/null +++ b/plugins/mpris/metadata.json @@ -0,0 +1,9 @@ +{ + "id" : "org.albert.extension.mpris", + "name" : "MPRIS Control", + "version" : "1.0", + "platform" : "Linux", + "group" : "Extensions", + "author" : "Martin Buergmann", + "dependencies" : ["dbus-daemon"] +} diff --git a/plugins/mpris/mpris.qrc b/plugins/mpris/mpris.qrc new file mode 100644 index 0000000..1ce5b47 --- /dev/null +++ b/plugins/mpris/mpris.qrc @@ -0,0 +1,9 @@ + + + resources/1485099680_playback-play.svg + resources/1485099683_playback-fast-forward.svg + resources/1485099687_playback-rewind.svg + resources/1485099690_playback-pause.svg + resources/1485100510_primitive-square.svg + + diff --git a/plugins/mpris/resources/1485099680_playback-play.svg b/plugins/mpris/resources/1485099680_playback-play.svg new file mode 100644 index 0000000..3fd0b79 --- /dev/null +++ b/plugins/mpris/resources/1485099680_playback-play.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/mpris/resources/1485099683_playback-fast-forward.svg b/plugins/mpris/resources/1485099683_playback-fast-forward.svg new file mode 100644 index 0000000..f8e45eb --- /dev/null +++ b/plugins/mpris/resources/1485099683_playback-fast-forward.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/mpris/resources/1485099687_playback-rewind.svg b/plugins/mpris/resources/1485099687_playback-rewind.svg new file mode 100644 index 0000000..c39452a --- /dev/null +++ b/plugins/mpris/resources/1485099687_playback-rewind.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/mpris/resources/1485099690_playback-pause.svg b/plugins/mpris/resources/1485099690_playback-pause.svg new file mode 100644 index 0000000..3ebe08b --- /dev/null +++ b/plugins/mpris/resources/1485099690_playback-pause.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/mpris/resources/1485100510_primitive-square.svg b/plugins/mpris/resources/1485100510_primitive-square.svg new file mode 100644 index 0000000..883d812 --- /dev/null +++ b/plugins/mpris/resources/1485100510_primitive-square.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/mpris/src/command.cpp b/plugins/mpris/src/command.cpp new file mode 100644 index 0000000..ee32621 --- /dev/null +++ b/plugins/mpris/src/command.cpp @@ -0,0 +1,105 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "command.h" +#include +#include +#include +#include +#include "item.h" + +/** ***************************************************************************/ +MPRIS::Command::Command(const QString &label, const QString &title, const QString &subtext, const QString &method, QString iconpath) + : label_(label), title_(title), subtext_(subtext), method_(method), iconpath_(iconpath) { +} + + + +/** ***************************************************************************/ +QString& MPRIS::Command::getIconPath() { + return iconpath_; +} + + + +/** ***************************************************************************/ +MPRIS::Command &MPRIS::Command::applicableWhen(const char* path, const char *property, const QVariant expectedValue, bool positivity) { + path_ = path; + property_ = property; + expectedValue_ = expectedValue; + positivity_ = positivity; + applicableCheck_ = true; + return *this; +} + + + +/** ***************************************************************************/ +SharedItem MPRIS::Command::produceAlbertItem(Player &player) const { + QDBusMessage msg = QDBusMessage::createMethodCall(player.busId(), "/org/mpris/MediaPlayer2", "org.mpris.MediaPlayer2.Player", method_); + SharedItem ptr(new MPRIS::Item(player, title_, subtext_, iconpath_, msg)); + return ptr; +} + + + +/** ***************************************************************************/ +bool MPRIS::Command::isApplicable(Player &p) const { + // Check the applicable-option if given + if (!applicableCheck_) + return true; + + // split DBus interface and property into seperate strings + int splitAt = property_.lastIndexOf('.'); + QString ifaceName = property_.left(splitAt); + QString propertyName = property_.right(property_.length() - splitAt -1); + + // Compose Get-Property-Message + QDBusMessage mesg = QDBusMessage::createMethodCall( + p.busId(), //"org.mpris.MediaPlayer2.rhythmbox", + path_, //"/org/mpris/MediaPlayer2", + "org.freedesktop.DBus.Properties", + "Get"); + QList args; + // Specify DBus interface to get the property from and the property-name + args.append(ifaceName); //"org.mpris.MediaPlayer2.Player"); + args.append(propertyName); //"CanGoNext"); + mesg.setArguments(args); + + // Query the property + QDBusMessage reply = QDBusConnection::sessionBus().call(mesg); + + // Check if the result is as expected + if ( reply.type() != QDBusMessage::ReplyMessage ){ + qWarning() << "Error while querying the property 'PlaybackStatus'"; + return true; + } + + if ( reply.arguments().empty() ) { + qWarning() << "Reply query 'PlaybackStatus' is empty"; + return true; + } + + return (reply.arguments().at(0).value().variant() == expectedValue_) == positivity_; +} + + + +/** ***************************************************************************/ +QString& MPRIS::Command::getLabel() { + return label_; +} + + + +/** ***************************************************************************/ +QString& MPRIS::Command::getMethod() { + return method_; +} + + + +/** ***************************************************************************/ +QString& MPRIS::Command::getTitle() { + return title_; +} + diff --git a/plugins/mpris/src/command.h b/plugins/mpris/src/command.h new file mode 100644 index 0000000..0cd8ff6 --- /dev/null +++ b/plugins/mpris/src/command.h @@ -0,0 +1,64 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once + +#include +#include +#include +#include "albert/query.h" +#include "player.h" +using std::function; +typedef std::shared_ptr SharedItem; + +namespace MPRIS { + +class Command +{ +public: + /** + * @brief Command Constructs a DBus command to launch from albert with the given parameters. + * @param label An internal variable to query at a later point. Not needed for the DBus query. + * @param title The title of the StandardItem which will be created. + * @param subtext The subtext of the StandardItem which will be created. + * @param method The DBus method to invoke when this command is performed. + * @param iconpath The path to the icon which the StandardItem will get. + */ + Command(const QString& label, const QString& title, const QString& subtext, const QString& method, QString iconpath); + + QString& getLabel(); + QString& getTitle(); + QString& getMethod(); + QString& getIconPath(); + + /** + * @brief applicableWhen Configure this command to be only appicable under a certian (given) conditions. + * @param path The path to query the property from. + * @param property The name of the property. This property will be checked as condition. + * @param expectedValue The value of the property. + * @param positivity The result of the equality-check (queriedValue == expectedValue). Here you can negate the result. + * @return Returns itself, but now configured for applicability-check + */ + Command& applicableWhen(const char *path, const char* property, const QVariant expectedValue, bool positivity); + + /** + * @brief produceStandardItem Produces an instance of AlbertItem for this command to invoke on a given Player. + * @return Returns a shared_ptr on this AlbertItem. + */ + SharedItem produceAlbertItem(Player &) const; + + /** + * @brief isApplicable If configured, checks if the given property meets the expected criteria. + * @return True if not configured or match, false if the property is different than expected. + */ + bool isApplicable(Player&) const; + +private: + QString label_, title_, subtext_, method_, iconpath_; + bool applicableCheck_; + QString path_; + QString property_; + QVariant expectedValue_; + bool positivity_; +}; + +} // namespace MPRIS diff --git a/plugins/mpris/src/configwidget.cpp b/plugins/mpris/src/configwidget.cpp new file mode 100644 index 0000000..8d03014 --- /dev/null +++ b/plugins/mpris/src/configwidget.cpp @@ -0,0 +1,15 @@ +// Copyright (C) 2016-2017 Martin Buergmann + +#include "configwidget.h" + +/** ***************************************************************************/ +MPRIS::ConfigWidget::ConfigWidget(QWidget *parent) : QWidget(parent) { + ui.setupUi(this); +} + + + +/** ***************************************************************************/ +MPRIS::ConfigWidget::~ConfigWidget() { + +} diff --git a/plugins/mpris/src/configwidget.h b/plugins/mpris/src/configwidget.h new file mode 100644 index 0000000..6b471c1 --- /dev/null +++ b/plugins/mpris/src/configwidget.h @@ -0,0 +1,16 @@ +// Copyright (C) 2016-2017 Martin Buergmann + +#pragma once +#include +#include "ui_configwidget.h" + +namespace MPRIS { +class ConfigWidget final : public QWidget +{ + Q_OBJECT +public: + explicit ConfigWidget(QWidget *parent = 0); + ~ConfigWidget(); + Ui::ConfigWidget ui; +}; +} diff --git a/plugins/mpris/src/configwidget.ui b/plugins/mpris/src/configwidget.ui new file mode 100644 index 0000000..aed64ab --- /dev/null +++ b/plugins/mpris/src/configwidget.ui @@ -0,0 +1,46 @@ + + + MPRIS::ConfigWidget + + + + 0 + 0 + 480 + 320 + + + + + + + <html> +<head/> +<body> +<p>If you have MPRIS-capable media players running (like Rhythmbox, VLC, ...) just type any of &quot;play&quot;, &quot;pause&quot;, &quot;stop&quot;, &quot;next&quot;, &quot;previous&quot; and you can send these commands directly to your player from albert.</p> +</body> +</html> + + + true + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + diff --git a/plugins/mpris/src/extension.cpp b/plugins/mpris/src/extension.cpp new file mode 100644 index 0000000..5171e22 --- /dev/null +++ b/plugins/mpris/src/extension.cpp @@ -0,0 +1,272 @@ +// Copyright (C) 2016-2017 Martin Buergmann + +#include "extension.h" +#include +#include +#include +#include +#include +#include +#include +#include "albert/query.h" +#include "xdg/iconlookup.h" +#include "command.h" +#include "configwidget.h" +#include "player.h" + +#define themeOr(name, fallbk) XDG::IconLookup::iconPath(name).isEmpty() ? fallbk : XDG::IconLookup::iconPath(name) + +namespace { +static const int DBUS_TIMEOUT = 25 /* ms */; +} + +class MPRIS::Private +{ +public: + ~Private(); + + const char* name = "MPRIS Control"; + static QDBusMessage findPlayerMsg; + QPointer widget; + QList mediaPlayers; + QStringList commands; + QMap commandObjects; + + + QDBusMessage call(QDBusMessage &toDispatch); + +}; + + +QDBusMessage MPRIS::Private::findPlayerMsg = QDBusMessage::createMethodCall("org.freedesktop.DBus", "/", "org.freedesktop.DBus", "ListNames"); + + + +/** ***************************************************************************/ +MPRIS::Private::~Private() { + // If there are still media player objects, delete them + qDeleteAll(mediaPlayers); + // Don't need to destruct the command objects. + // This is done by the destructor of QMap +} + + + +/** ***************************************************************************/ +QDBusMessage MPRIS::Private::call(QDBusMessage &toDispatch) { + return QDBusConnection::sessionBus().call(toDispatch, QDBus::Block, DBUS_TIMEOUT); +} + + + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +MPRIS::Extension::Extension() + : Core::Extension("org.albert.extension.mpris"), + Core::QueryHandler(Core::Plugin::id()), + d(new Private) { + + registerQueryHandler(this); + + QString icon; + + // Setup the DBus commands + icon = themeOr("media-playback-start", ":play"); + Command* nextToAdd = new Command( + "play", // Label + "Play", // Title + "Start playing on %1", // Subtext + "Play", // DBus Method + icon + ); + nextToAdd->applicableWhen("/org/mpris/MediaPlayer2", "org.mpris.MediaPlayer2.Player.PlaybackStatus", "Playing", false); + d->commands.append("play"); + d->commandObjects.insert("play", *nextToAdd); + + icon = themeOr("media-playback-pause", ":pause"); + nextToAdd = new Command( + "pause", + "Pause", + "Pause %1", + "Pause", + icon + ); + nextToAdd->applicableWhen("/org/mpris/MediaPlayer2", "org.mpris.MediaPlayer2.Player.PlaybackStatus", "Playing", true); + d->commands.append("pause"); + d->commandObjects.insert("pause", *nextToAdd); + + icon = themeOr("media-playback-stop", ":stop"); + nextToAdd = new Command( + "stop", + "Stop", + "Stop %1", + "Stop", + icon + ); + nextToAdd->applicableWhen("/org/mpris/MediaPlayer2", "org.mpris.MediaPlayer2.Player.PlaybackStatus", "Playing", true); + d->commands.append("stop"); + d->commandObjects.insert("stop", *nextToAdd); + + icon = themeOr("media-skip-forward", ":next"); + nextToAdd = new Command( + "next track", + "Next track", + "Play next track on %1", + "Next", + icon + ); + nextToAdd->applicableWhen("/org/mpris/MediaPlayer2", "org.mpris.MediaPlayer2.Player.CanGoNext", true, true); + //.fireCallback([](){qInfo("NEXT");}) + d->commands.append("next track"); + d->commandObjects.insert("next track", *nextToAdd); + + icon = themeOr("media-skip-backward", ":prev"); + nextToAdd = new Command( + "previous track", + "Previous track", + "Play previous track on %1", + "Previous", + icon + ); + nextToAdd->applicableWhen("/org/mpris/MediaPlayer2", "org.mpris.MediaPlayer2.Player.CanGoPrevious", true, true); + d->commands.append("previous track"); + d->commandObjects.insert("previous track", *nextToAdd); +} + + + +/** ***************************************************************************/ +MPRIS::Extension::~Extension() { + +} + + + +/** ***************************************************************************/ +QWidget *MPRIS::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) { + d->widget = new ConfigWidget(parent); + } + return d->widget; +} + + + +/** ***************************************************************************/ +void MPRIS::Extension::setupSession() { + + // Clean the memory + qDeleteAll(d->mediaPlayers); + d->mediaPlayers.clear(); + + // If there is no session bus, abort + if (!QDBusConnection::sessionBus().isConnected()) + return; + + // Querying the DBus to list all available services + QDBusMessage response = d->call(Private::findPlayerMsg); + + // Do some error checking + if (response.type() == QDBusMessage::ReplyMessage) { + QList args = response.arguments(); + if (args.length() == 1) { + QVariant arg = args.at(0); + if (!arg.isNull() && arg.isValid()) { + QStringList runningBusEndpoints = arg.toStringList(); + if (!runningBusEndpoints.isEmpty()) { + // No errors + + // Filter all mpris capable + //names = names.filter(filterRegex); + QStringList busids; + for (QString& id: runningBusEndpoints) { + if (id.startsWith("org.mpris.MediaPlayer2.")) + busids.append(id); + } + + for (QString& busId : busids) { + + // Query the name of the media player of which we have the bus id. + QDBusInterface iface(busId, "/org/mpris/MediaPlayer2", "org.mpris.MediaPlayer2"); + iface.setTimeout(DBUS_TIMEOUT); + + QString name = busId; + QVariant prop = iface.property("Identity"); + if (prop.isValid() && !prop.isNull() && prop.canConvert(QVariant::String)) { + name = prop.toString(); + } else { + qWarning("DBus: Name is either invalid, null or not instanceof string"); + } + + bool canRaise = false; + prop = iface.property("CanRaise"); + if (prop.isValid() && !prop.isNull() && prop.canConvert(QVariant::Bool)) { + canRaise = prop.toBool(); + } else { + qWarning("DBus: CanRaise is either invalid, null or not instanceof bool"); + } + + // And add their player object to the list + d->mediaPlayers.push_back(new Player{busId, name, canRaise}); + + } + + + } else { + qCritical("[%s] DBus error: Argument is either not type of QStringList or is empty!", d->name); + } + } else { + qCritical("[%s] DBus error: Reply argument not valid or null!", d->name); + } + } else { + qCritical("[%s] DBus error: Expected 1 argument for DBus reply. Got %d", d->name, args.length()); + } + } else { + qCritical("[%s] DBus error: %s", d->name, response.errorMessage().toStdString().c_str()); + } +} + + + +/** ***************************************************************************/ +void MPRIS::Extension::handleQuery(Core::Query *query) const { + + const QString& q = query->string().trimmed().toLower(); + + if ( q.isEmpty() ) + return; + + // Do not proceed if there are no players running. Why would you even? + if (d->mediaPlayers.isEmpty()) + return; + + // Filter applicable commands + QStringList cmds; + for (QString& cmd : d->commands) { + if (cmd.startsWith(q)) + cmds.append(cmd); + } + + + // For every option create entries for every player + for (QString& cmd: cmds) { + // Get the command + Command& toExec = d->commandObjects.find(cmd).value(); + // For every player: + for (Player *p : d->mediaPlayers) { + // See if it's applicable for this player + if (toExec.isApplicable(*p)) + // And add a match if so + query->addMatch(toExec.produceAlbertItem(*p), + static_cast(1.0*q.length()/cmd.length())*UINT_MAX); + } + } +} + + + +/** ***************************************************************************/ +QString MPRIS::Extension::name() const { + return d->name; +} diff --git a/plugins/mpris/src/extension.h b/plugins/mpris/src/extension.h new file mode 100644 index 0000000..2697864 --- /dev/null +++ b/plugins/mpris/src/extension.h @@ -0,0 +1,34 @@ +// Copyright (C) 2016-2017 Martin Buergmann + +#pragma once +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +namespace MPRIS { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + Extension(); + ~Extension(); + + QString name() const override; + QWidget *widget(QWidget *parent = nullptr) override; + void setupSession() override; + void handleQuery(Core::Query *query) const override; + +private: + + std::unique_ptr d; + +}; +} diff --git a/plugins/mpris/src/item.cpp b/plugins/mpris/src/item.cpp new file mode 100644 index 0000000..a81d93a --- /dev/null +++ b/plugins/mpris/src/item.cpp @@ -0,0 +1,46 @@ +// Copyright (C) 2016-2017 Martin Buergmann + +#include "item.h" +#include "albert/util/standardactions.h" +#include + + +/** ***************************************************************************/ +MPRIS::Item::Item(Player &p, const QString &title, const QString &subtext, const QString &iconPath, const QDBusMessage &msg) + : iconPath_(iconPath), message_(msg) { + if (title.contains("%1")) + text_ = title.arg(p.name()); + else + text_ = title; + if (subtext.contains("%1")) + subtext_ = subtext.arg(p.name()); + else + subtext_ = subtext; + actions_.push_back(std::make_shared(subtext_, [this](){ QDBusConnection::sessionBus().send(message_); })); + if (p.canRaise()) { + actions_.push_back(std::make_shared("Raise Window", [&p](){ + QString busid = p.busId(); + QDBusMessage raise = QDBusMessage::createMethodCall(busid, "/org/mpris/MediaPlayer2", "org.mpris.MediaPlayer2", "Raise"); + if (!QDBusConnection::sessionBus().send(raise)) { + qWarning("Error calling raise method on dbus://%s", busid.toStdString().c_str()); + } + })); + } + id_ = "extension.mpris.item:%1.%2"; + id_ = id_.arg(p.busId()).arg(msg.member()); +} + + + +/** ***************************************************************************/ +MPRIS::Item::~Item() { + +} + + + +/** ***************************************************************************/ +vector> MPRIS::Item::actions() { + return actions_; +} + diff --git a/plugins/mpris/src/item.h b/plugins/mpris/src/item.h new file mode 100644 index 0000000..73cb15d --- /dev/null +++ b/plugins/mpris/src/item.h @@ -0,0 +1,39 @@ +// Copyright (C) 2016-2017 Martin Buergmann + +#pragma once +#include +#include +#include +#include "albert/util/standarditem.h" +#include "player.h" +using std::vector; +using std::shared_ptr; +using Core::Action; + +namespace MPRIS { + +class Item final : public Core::Item +{ +public: + + Item(Player &p, const QString& title, const QString& subtext, const QString& iconPath, const QDBusMessage& msg); + ~Item(); + + QString id() const override { return id_; } + QString text() const override { return text_; } + QString subtext() const override { return subtext_; } + QString iconPath() const override { return iconPath_; } + vector> actions() override; + +private: + + QString id_; + QString text_; + QString subtext_; + QString iconPath_; + QDBusMessage message_; + vector> actions_; + +}; + +} diff --git a/plugins/mpris/src/player.h b/plugins/mpris/src/player.h new file mode 100644 index 0000000..41d436b --- /dev/null +++ b/plugins/mpris/src/player.h @@ -0,0 +1,26 @@ +// Copyright (C) 2016-2017 Martin Buergmann + +#pragma once + +#include + +namespace MPRIS { + +class Player +{ +public: + Player(const QString& busid, const QString& name, bool canRaise) + : busId_(busid), name_(name), canRaise_(canRaise) {} + + const QString& name() const { return name_; } + const QString& busId() const { return busId_; } + bool canRaise() const { return canRaise_; } + +private: + + QString busId_; + QString name_; + bool canRaise_; +}; + +} // namespace MPRIS diff --git a/plugins/python/CMakeLists.txt b/plugins/python/CMakeLists.txt new file mode 100644 index 0000000..2dd085d --- /dev/null +++ b/plugins/python/CMakeLists.txt @@ -0,0 +1,24 @@ +cmake_minimum_required(VERSION 3.1.3) + +PROJECT(python) + +FILE(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets) +add_subdirectory(pybind11) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PUBLIC + Qt5::Widgets + PRIVATE + pybind11::embed + albert::lib + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) +install(DIRECTORY "share/" DESTINATION "${CMAKE_INSTALL_DATADIR}/albert/org.albert.extension.python") diff --git a/plugins/python/metadata.json b/plugins/python/metadata.json new file mode 100644 index 0000000..b3511dc --- /dev/null +++ b/plugins/python/metadata.json @@ -0,0 +1,9 @@ +{ + "id" : "org.albert.extension.python", + "name" : "Python", + "version" : "1.2", + "platform" : "All", + "group" : "Extensions", + "author" : "Manuel Schneider", + "dependencies" : ["python"] +} diff --git a/plugins/python/pybind11/.appveyor.yml b/plugins/python/pybind11/.appveyor.yml new file mode 100644 index 0000000..4b8f3f8 --- /dev/null +++ b/plugins/python/pybind11/.appveyor.yml @@ -0,0 +1,67 @@ +version: 1.0.{build} +image: +- Visual Studio 2017 +- Visual Studio 2015 +test: off +build: + parallel: true +platform: +- x64 +- x86 +environment: + matrix: + - PYTHON: 36 + CPP: 14 + CONFIG: Debug + - PYTHON: 27 + CPP: 14 + CONFIG: Debug + - CONDA: 36 + CPP: latest + CONFIG: Release +matrix: + exclude: + - image: Visual Studio 2015 + platform: x86 + - image: Visual Studio 2015 + CPP: latest + - image: Visual Studio 2017 + CPP: latest + platform: x86 +install: +- ps: | + if ($env:PLATFORM -eq "x64") { $env:CMAKE_ARCH = "x64" } + if ($env:APPVEYOR_JOB_NAME -like "*Visual Studio 2017*") { + $env:CMAKE_GENERATOR = "Visual Studio 15 2017" + $env:CMAKE_INCLUDE_PATH = "C:\Libraries\boost_1_64_0" + $env:CXXFLAGS = "-permissive-" + } else { + $env:CMAKE_GENERATOR = "Visual Studio 14 2015" + } + if ($env:PYTHON) { + if ($env:PLATFORM -eq "x64") { $env:PYTHON = "$env:PYTHON-x64" } + $env:PATH = "C:\Python$env:PYTHON\;C:\Python$env:PYTHON\Scripts\;$env:PATH" + python -m pip install --upgrade pip wheel + python -m pip install pytest numpy --no-warn-script-location + } elseif ($env:CONDA) { + if ($env:CONDA -eq "27") { $env:CONDA = "" } + if ($env:PLATFORM -eq "x64") { $env:CONDA = "$env:CONDA-x64" } + $env:PATH = "C:\Miniconda$env:CONDA\;C:\Miniconda$env:CONDA\Scripts\;$env:PATH" + $env:PYTHONHOME = "C:\Miniconda$env:CONDA" + conda install -y -q pytest numpy scipy + } +- ps: | + Start-FileDownload 'http://bitbucket.org/eigen/eigen/get/3.3.3.zip' + 7z x 3.3.3.zip -y > $null + $env:CMAKE_INCLUDE_PATH = "eigen-eigen-67e894c6cd8f;$env:CMAKE_INCLUDE_PATH" +build_script: +- cmake -G "%CMAKE_GENERATOR%" -A "%CMAKE_ARCH%" + -DPYBIND11_CPP_STANDARD=/std:c++%CPP% + -DPYBIND11_WERROR=ON + -DDOWNLOAD_CATCH=ON + -DCMAKE_SUPPRESS_REGENERATION=1 +- set MSBuildLogger="C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll" +- cmake --build . --config %CONFIG% --target pytest -- /m /v:m /logger:%MSBuildLogger% +- cmake --build . --config %CONFIG% --target cpptest -- /m /v:m /logger:%MSBuildLogger% +- if "%CPP%"=="latest" (cmake --build . --config %CONFIG% --target test_cmake_build -- /m /v:m /logger:%MSBuildLogger%) +on_failure: if exist "tests\test_cmake_build" type tests\test_cmake_build\*.log* diff --git a/plugins/python/pybind11/.gitmodules b/plugins/python/pybind11/.gitmodules new file mode 100644 index 0000000..5191885 --- /dev/null +++ b/plugins/python/pybind11/.gitmodules @@ -0,0 +1,3 @@ +[submodule "tools/clang"] + path = tools/clang + url = https://github.com/wjakob/clang-cindex-python3 diff --git a/plugins/python/pybind11/.readthedocs.yml b/plugins/python/pybind11/.readthedocs.yml new file mode 100644 index 0000000..c9c6161 --- /dev/null +++ b/plugins/python/pybind11/.readthedocs.yml @@ -0,0 +1,3 @@ +python: + version: 3 +requirements_file: docs/requirements.txt diff --git a/plugins/python/pybind11/.travis.yml b/plugins/python/pybind11/.travis.yml new file mode 100644 index 0000000..2d3f972 --- /dev/null +++ b/plugins/python/pybind11/.travis.yml @@ -0,0 +1,212 @@ +language: cpp +dist: trusty +sudo: false +matrix: + include: + # This config does a few things: + # - Checks C++ and Python code styles (check-style.sh and flake8). + # - Makes sure sphinx can build the docs without any errors or warnings. + # - Tests setup.py sdist and install (all header files should be present). + # - Makes sure that everything still works without optional deps (numpy/scipy/eigen) and + # also tests the automatic discovery functions in CMake (Python version, C++ standard). + - os: linux + env: STYLE DOCS PIP + cache: false + before_install: + - pyenv global $(pyenv whence 2to3) # activate all python versions + - PY_CMD=python3 + - $PY_CMD -m pip install --user --upgrade pip wheel + install: + - $PY_CMD -m pip install --user --upgrade sphinx sphinx_rtd_theme breathe flake8 pep8-naming pytest + - curl -fsSL ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.12.linux.bin.tar.gz | tar xz + - export PATH="$PWD/doxygen-1.8.12/bin:$PATH" + script: + - tools/check-style.sh + - flake8 + - $PY_CMD -m sphinx -W -b html docs docs/.build + - | + # Make sure setup.py distributes and installs all the headers + $PY_CMD setup.py sdist + $PY_CMD -m pip install --user -U ./dist/* + installed=$($PY_CMD -c "import pybind11; print(pybind11.get_include(True) + '/pybind11')") + diff -rq $installed ./include/pybind11 + - | + # Barebones build + cmake -DCMAKE_BUILD_TYPE=Debug -DPYBIND11_WERROR=ON -DDOWNLOAD_CATCH=ON + make pytest -j 2 + make cpptest -j 2 + # The following are regular test configurations, including optional dependencies. + # With regard to each other they differ in Python version, C++ standard and compiler. + - os: linux + env: PYTHON=2.7 CPP=11 GCC=4.8 + addons: + apt: + packages: [cmake=2.\*, cmake-data=2.\*] + - os: linux + env: PYTHON=3.6 CPP=11 GCC=4.8 + addons: + apt: + sources: [deadsnakes] + packages: [python3.6-dev python3.6-venv, cmake=2.\*, cmake-data=2.\*] + - sudo: true + services: docker + env: PYTHON=2.7 CPP=14 GCC=6 CMAKE=1 + - sudo: true + services: docker + env: PYTHON=3.5 CPP=14 GCC=6 DEBUG=1 + - sudo: true + services: docker + env: PYTHON=3.6 CPP=17 GCC=7 + - os: linux + env: PYTHON=3.6 CPP=17 CLANG=5.0 + addons: + apt: + sources: [deadsnakes, llvm-toolchain-trusty-5.0, ubuntu-toolchain-r-test] + packages: [python3.6-dev python3.6-venv clang-5.0 llvm-5.0-dev, lld-5.0] + - os: osx + osx_image: xcode7.3 + env: PYTHON=2.7 CPP=14 CLANG CMAKE=1 + - os: osx + osx_image: xcode9 + env: PYTHON=3.7 CPP=14 CLANG DEBUG=1 + # Test a PyPy 2.7 build + - os: linux + env: PYPY=5.8 PYTHON=2.7 CPP=11 GCC=4.8 + addons: + apt: + packages: [libblas-dev, liblapack-dev, gfortran] + # Build in 32-bit mode and tests against the CMake-installed version + - sudo: true + services: docker + env: ARCH=i386 PYTHON=3.5 CPP=14 GCC=6 INSTALL=1 + script: + - | + $SCRIPT_RUN_PREFIX sh -c "set -e + cmake ${CMAKE_EXTRA_ARGS} -DPYBIND11_INSTALL=1 -DPYBIND11_TEST=0 + make install + cp -a tests /pybind11-tests + mkdir /build-tests && cd /build-tests + cmake ../pybind11-tests ${CMAKE_EXTRA_ARGS} -DPYBIND11_WERROR=ON + make pytest -j 2" +cache: + directories: + - $HOME/.local/bin + - $HOME/.local/lib + - $HOME/.local/include + - $HOME/Library/Python +before_install: +- | + # Configure build variables + if [ "$TRAVIS_OS_NAME" = "linux" ]; then + if [ -n "$CLANG" ]; then + export CXX=clang++-$CLANG CC=clang-$CLANG + EXTRA_PACKAGES+=" clang-$CLANG llvm-$CLANG-dev" + else + if [ -z "$GCC" ]; then GCC=4.8 + else EXTRA_PACKAGES+=" g++-$GCC" + fi + export CXX=g++-$GCC CC=gcc-$GCC + fi + if [ "$GCC" = "6" ]; then DOCKER=${ARCH:+$ARCH/}debian:stretch + elif [ "$GCC" = "7" ]; then DOCKER=debian:buster EXTRA_PACKAGES+=" catch python3-distutils" DOWNLOAD_CATCH=OFF + fi + elif [ "$TRAVIS_OS_NAME" = "osx" ]; then + export CXX=clang++ CC=clang; + fi + if [ -n "$CPP" ]; then CPP=-std=c++$CPP; fi + if [ "${PYTHON:0:1}" = "3" ]; then PY=3; fi + if [ -n "$DEBUG" ]; then CMAKE_EXTRA_ARGS+=" -DCMAKE_BUILD_TYPE=Debug"; fi +- | + # Initialize environment + set -e + if [ -n "$DOCKER" ]; then + docker pull $DOCKER + + containerid=$(docker run --detach --tty \ + --volume="$PWD":/pybind11 --workdir=/pybind11 \ + --env="CC=$CC" --env="CXX=$CXX" --env="DEBIAN_FRONTEND=$DEBIAN_FRONTEND" \ + --env=GCC_COLORS=\ \ + $DOCKER) + SCRIPT_RUN_PREFIX="docker exec --tty $containerid" + $SCRIPT_RUN_PREFIX sh -c 'for s in 0 15; do sleep $s; apt-get update && apt-get -qy dist-upgrade && break; done' + else + if [ "$PYPY" = "5.8" ]; then + curl -fSL https://bitbucket.org/pypy/pypy/downloads/pypy2-v5.8.0-linux64.tar.bz2 | tar xj + PY_CMD=$(echo `pwd`/pypy2-v5.8.0-linux64/bin/pypy) + CMAKE_EXTRA_ARGS+=" -DPYTHON_EXECUTABLE:FILEPATH=$PY_CMD" + else + PY_CMD=python$PYTHON + if [ "$TRAVIS_OS_NAME" = "osx" ]; then + if [ "$PY" = "3" ]; then + brew install python$PY; + else + curl -fsSL https://bootstrap.pypa.io/get-pip.py | $PY_CMD - --user + fi + fi + fi + if [ "$PY" = 3 ] || [ -n "$PYPY" ]; then + $PY_CMD -m ensurepip --user + fi + $PY_CMD -m pip install --user --upgrade pip wheel + fi + set +e +install: +- | + # Install dependencies + set -e + if [ -n "$DOCKER" ]; then + if [ -n "$DEBUG" ]; then + PY_DEBUG="python$PYTHON-dbg python$PY-scipy-dbg" + CMAKE_EXTRA_ARGS+=" -DPYTHON_EXECUTABLE=/usr/bin/python${PYTHON}dm" + fi + $SCRIPT_RUN_PREFIX sh -c "for s in 0 15; do sleep \$s; \ + apt-get -qy --no-install-recommends install \ + $PY_DEBUG python$PYTHON-dev python$PY-pytest python$PY-scipy \ + libeigen3-dev libboost-dev cmake make ${EXTRA_PACKAGES} && break; done" + else + + if [ "$CLANG" = "5.0" ]; then + if ! [ -d ~/.local/include/c++/v1 ]; then + # Neither debian nor llvm provide a libc++ 5.0 deb; luckily it's fairly quick + # to build, install (and cache), so do it ourselves: + git clone --depth=1 https://github.com/llvm-mirror/llvm.git llvm-source + git clone https://github.com/llvm-mirror/libcxx.git llvm-source/projects/libcxx -b release_50 + git clone https://github.com/llvm-mirror/libcxxabi.git llvm-source/projects/libcxxabi -b release_50 + mkdir llvm-build && cd llvm-build + # Building llvm requires a newer cmake than is provided by the trusty container: + CMAKE_VER=cmake-3.8.0-Linux-x86_64 + curl https://cmake.org/files/v3.8/$CMAKE_VER.tar.gz | tar xz + ./$CMAKE_VER/bin/cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=~/.local ../llvm-source + make -j2 install-cxxabi install-cxx + cp -a include/c++/v1/*cxxabi*.h ~/.local/include/c++/v1 + cd .. + fi + export CXXFLAGS="-isystem $HOME/.local/include/c++/v1 -stdlib=libc++" + export LDFLAGS="-L$HOME/.local/lib -fuse-ld=lld-$CLANG" + export LD_LIBRARY_PATH="$HOME/.local/lib${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}" + if [ "$CPP" = "-std=c++17" ]; then CPP="-std=c++1z"; fi + fi + + export NPY_NUM_BUILD_JOBS=2 + echo "Installing pytest, numpy, scipy..." + ${PYPY:+travis_wait 30} $PY_CMD -m pip install --user --upgrade pytest numpy scipy \ + ${PYPY:+--extra-index-url https://imaginary.ca/trusty-pypi} + echo "done." + + wget -q -O eigen.tar.gz https://bitbucket.org/eigen/eigen/get/3.3.3.tar.gz + tar xzf eigen.tar.gz + export CMAKE_INCLUDE_PATH="${CMAKE_INCLUDE_PATH:+$CMAKE_INCLUDE_PATH:}$PWD/eigen-eigen-67e894c6cd8f" + fi + set +e +script: +- $SCRIPT_RUN_PREFIX cmake ${CMAKE_EXTRA_ARGS} + -DPYBIND11_PYTHON_VERSION=$PYTHON + -DPYBIND11_CPP_STANDARD=$CPP + -DPYBIND11_WERROR=${WERROR:-ON} + -DDOWNLOAD_CATCH=${DOWNLOAD_CATCH:-ON} +- $SCRIPT_RUN_PREFIX make pytest -j 2 +- $SCRIPT_RUN_PREFIX make cpptest -j 2 +- if [ -n "$CMAKE" ]; then $SCRIPT_RUN_PREFIX make test_cmake_build; fi +after_failure: cat tests/test_cmake_build/*.log* +after_script: +- if [ -n "$DOCKER" ]; then docker stop "$containerid"; docker rm "$containerid"; fi diff --git a/plugins/python/pybind11/CMakeLists.txt b/plugins/python/pybind11/CMakeLists.txt new file mode 100644 index 0000000..85ecd90 --- /dev/null +++ b/plugins/python/pybind11/CMakeLists.txt @@ -0,0 +1,157 @@ +# CMakeLists.txt -- Build system for the pybind11 modules +# +# Copyright (c) 2015 Wenzel Jakob +# +# All rights reserved. Use of this source code is governed by a +# BSD-style license that can be found in the LICENSE file. + +cmake_minimum_required(VERSION 2.8.12) + +if (POLICY CMP0048) + # cmake warns if loaded from a min-3.0-required parent dir, so silence the warning: + cmake_policy(SET CMP0048 NEW) +endif() + +# CMake versions < 3.4.0 do not support try_compile/pthread checks without C as active language. +if(CMAKE_VERSION VERSION_LESS 3.4.0) + project(pybind11) +else() + project(pybind11 CXX) +endif() + +# Check if pybind11 is being used directly or via add_subdirectory +set(PYBIND11_MASTER_PROJECT OFF) +if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) + set(PYBIND11_MASTER_PROJECT ON) +endif() + +option(PYBIND11_INSTALL "Install pybind11 header files?" ${PYBIND11_MASTER_PROJECT}) +option(PYBIND11_TEST "Build pybind11 test suite?" ${PYBIND11_MASTER_PROJECT}) + +list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/tools") + +include(pybind11Tools) + +# Cache variables so pybind11_add_module can be used in parent projects +set(PYBIND11_INCLUDE_DIR "${CMAKE_CURRENT_LIST_DIR}/include" CACHE INTERNAL "") +set(PYTHON_INCLUDE_DIRS ${PYTHON_INCLUDE_DIRS} CACHE INTERNAL "") +set(PYTHON_LIBRARIES ${PYTHON_LIBRARIES} CACHE INTERNAL "") +set(PYTHON_MODULE_PREFIX ${PYTHON_MODULE_PREFIX} CACHE INTERNAL "") +set(PYTHON_MODULE_EXTENSION ${PYTHON_MODULE_EXTENSION} CACHE INTERNAL "") +set(PYTHON_VERSION_MAJOR ${PYTHON_VERSION_MAJOR} CACHE INTERNAL "") +set(PYTHON_VERSION_MINOR ${PYTHON_VERSION_MINOR} CACHE INTERNAL "") + +# NB: when adding a header don't forget to also add it to setup.py +set(PYBIND11_HEADERS + include/pybind11/detail/class.h + include/pybind11/detail/common.h + include/pybind11/detail/descr.h + include/pybind11/detail/init.h + include/pybind11/detail/internals.h + include/pybind11/detail/typeid.h + include/pybind11/attr.h + include/pybind11/buffer_info.h + include/pybind11/cast.h + include/pybind11/chrono.h + include/pybind11/common.h + include/pybind11/complex.h + include/pybind11/options.h + include/pybind11/eigen.h + include/pybind11/embed.h + include/pybind11/eval.h + include/pybind11/functional.h + include/pybind11/numpy.h + include/pybind11/operators.h + include/pybind11/pybind11.h + include/pybind11/pytypes.h + include/pybind11/stl.h + include/pybind11/stl_bind.h +) +string(REPLACE "include/" "${CMAKE_CURRENT_SOURCE_DIR}/include/" + PYBIND11_HEADERS "${PYBIND11_HEADERS}") + +if (PYBIND11_TEST) + add_subdirectory(tests) +endif() + +include(GNUInstallDirs) +include(CMakePackageConfigHelpers) + +# extract project version from source +file(STRINGS "${PYBIND11_INCLUDE_DIR}/pybind11/detail/common.h" pybind11_version_defines + REGEX "#define PYBIND11_VERSION_(MAJOR|MINOR|PATCH) ") +foreach(ver ${pybind11_version_defines}) + if (ver MATCHES "#define PYBIND11_VERSION_(MAJOR|MINOR|PATCH) +([^ ]+)$") + set(PYBIND11_VERSION_${CMAKE_MATCH_1} "${CMAKE_MATCH_2}" CACHE INTERNAL "") + endif() +endforeach() +set(${PROJECT_NAME}_VERSION ${PYBIND11_VERSION_MAJOR}.${PYBIND11_VERSION_MINOR}.${PYBIND11_VERSION_PATCH}) +message(STATUS "pybind11 v${${PROJECT_NAME}_VERSION}") + +option (USE_PYTHON_INCLUDE_DIR "Install pybind11 headers in Python include directory instead of default installation prefix" OFF) +if (USE_PYTHON_INCLUDE_DIR) + file(RELATIVE_PATH CMAKE_INSTALL_INCLUDEDIR ${CMAKE_INSTALL_PREFIX} ${PYTHON_INCLUDE_DIRS}) +endif() + +if(NOT (CMAKE_VERSION VERSION_LESS 3.0)) # CMake >= 3.0 + # Build an interface library target: + add_library(pybind11 INTERFACE) + add_library(pybind11::pybind11 ALIAS pybind11) # to match exported target + target_include_directories(pybind11 INTERFACE $ + $ + $) + target_compile_options(pybind11 INTERFACE $) + + add_library(module INTERFACE) + add_library(pybind11::module ALIAS module) + if(NOT MSVC) + target_compile_options(module INTERFACE -fvisibility=hidden) + endif() + target_link_libraries(module INTERFACE pybind11::pybind11) + if(WIN32 OR CYGWIN) + target_link_libraries(module INTERFACE $) + elseif(APPLE) + target_link_libraries(module INTERFACE "-undefined dynamic_lookup") + endif() + + add_library(embed INTERFACE) + add_library(pybind11::embed ALIAS embed) + target_link_libraries(embed INTERFACE pybind11::pybind11 $) +endif() + +if (PYBIND11_INSTALL) + install(DIRECTORY ${PYBIND11_INCLUDE_DIR}/pybind11 DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}) + # GNUInstallDirs "DATADIR" wrong here; CMake search path wants "share". + set(PYBIND11_CMAKECONFIG_INSTALL_DIR "share/cmake/${PROJECT_NAME}" CACHE STRING "install path for pybind11Config.cmake") + + configure_package_config_file(tools/${PROJECT_NAME}Config.cmake.in + "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake" + INSTALL_DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR}) + # Remove CMAKE_SIZEOF_VOID_P from ConfigVersion.cmake since the library does + # not depend on architecture specific settings or libraries. + set(_PYBIND11_CMAKE_SIZEOF_VOID_P ${CMAKE_SIZEOF_VOID_P}) + unset(CMAKE_SIZEOF_VOID_P) + write_basic_package_version_file(${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake + VERSION ${${PROJECT_NAME}_VERSION} + COMPATIBILITY AnyNewerVersion) + set(CMAKE_SIZEOF_VOID_P ${_PYBIND11_CMAKE_SIZEOF_VOID_P}) + install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake + ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake + tools/FindPythonLibsNew.cmake + tools/pybind11Tools.cmake + DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR}) + + if(NOT (CMAKE_VERSION VERSION_LESS 3.0)) + if(NOT PYBIND11_EXPORT_NAME) + set(PYBIND11_EXPORT_NAME "${PROJECT_NAME}Targets") + endif() + + install(TARGETS pybind11 module embed + EXPORT "${PYBIND11_EXPORT_NAME}") + if(PYBIND11_MASTER_PROJECT) + install(EXPORT "${PYBIND11_EXPORT_NAME}" + NAMESPACE "${PROJECT_NAME}::" + DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR}) + endif() + endif() +endif() diff --git a/plugins/python/pybind11/CONTRIBUTING.md b/plugins/python/pybind11/CONTRIBUTING.md new file mode 100644 index 0000000..375735f --- /dev/null +++ b/plugins/python/pybind11/CONTRIBUTING.md @@ -0,0 +1,47 @@ +Thank you for your interest in this project! Please refer to the following +sections on how to contribute code and bug reports. + +### Reporting bugs + +At the moment, this project is run in the spare time of a single person +([Wenzel Jakob](http://rgl.epfl.ch/people/wjakob)) with very limited resources +for issue tracker tickets. Thus, before submitting a question or bug report, +please take a moment of your time and ensure that your issue isn't already +discussed in the project documentation provided at +[http://pybind11.readthedocs.org/en/latest](http://pybind11.readthedocs.org/en/latest). + +Assuming that you have identified a previously unknown problem or an important +question, it's essential that you submit a self-contained and minimal piece of +code that reproduces the problem. In other words: no external dependencies, +isolate the function(s) that cause breakage, submit matched and complete C++ +and Python snippets that can be easily compiled and run on my end. + +## Pull requests +Contributions are submitted, reviewed, and accepted using Github pull requests. +Please refer to [this +article](https://help.github.com/articles/using-pull-requests) for details and +adhere to the following rules to make the process as smooth as possible: + +* Make a new branch for every feature you're working on. +* Make small and clean pull requests that are easy to review but make sure they + do add value by themselves. +* Add tests for any new functionality and run the test suite (``make pytest``) + to ensure that no existing features break. +* This project has a strong focus on providing general solutions using a + minimal amount of code, thus small pull requests are greatly preferred. + +### Licensing of contributions + +pybind11 is provided under a BSD-style license that can be found in the +``LICENSE`` file. By using, distributing, or contributing to this project, you +agree to the terms and conditions of this license. + +You are under no obligation whatsoever to provide any bug fixes, patches, or +upgrades to the features, functionality or performance of the source code +("Enhancements") to anyone; however, if you choose to make your Enhancements +available either publicly, or directly to the author of this software, without +imposing a separate written license agreement for such Enhancements, then you +hereby grant the following license: a non-exclusive, royalty-free perpetual +license to install, use, modify, prepare derivative works, incorporate into +other computer software, distribute, and sublicense such enhancements or +derivative works thereof, in binary and source code form. diff --git a/plugins/python/pybind11/ISSUE_TEMPLATE.md b/plugins/python/pybind11/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..75df399 --- /dev/null +++ b/plugins/python/pybind11/ISSUE_TEMPLATE.md @@ -0,0 +1,17 @@ +Make sure you've completed the following steps before submitting your issue -- thank you! + +1. Check if your question has already been answered in the [FAQ](http://pybind11.readthedocs.io/en/latest/faq.html) section. +2. Make sure you've read the [documentation](http://pybind11.readthedocs.io/en/latest/). Your issue may be addressed there. +3. If those resources didn't help and you only have a short question (not a bug report), consider asking in the [Gitter chat room](https://gitter.im/pybind/Lobby). +4. If you have a genuine bug report or a more complex question which is not answered in the previous items (or not suitable for chat), please fill in the details below. +5. Include a self-contained and minimal piece of code that reproduces the problem. If that's not possible, try to make the description as clear as possible. + +*After reading, remove this checklist and the template text in parentheses below.* + +## Issue description + +(Provide a short description, state the expected behavior and what actually happens.) + +## Reproducible example code + +(The code should be minimal, have no external dependencies, isolate the function(s) that cause breakage. Submit matched and complete C++ and Python snippets that can be easily compiled and run to diagnose the issue.) diff --git a/plugins/python/pybind11/LICENSE b/plugins/python/pybind11/LICENSE new file mode 100644 index 0000000..6f15578 --- /dev/null +++ b/plugins/python/pybind11/LICENSE @@ -0,0 +1,29 @@ +Copyright (c) 2016 Wenzel Jakob , All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. 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. + +3. Neither the name of the copyright holder 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. + +Please also refer to the file CONTRIBUTING.md, which clarifies licensing of +external contributions to this project including patches, pull requests, etc. diff --git a/plugins/python/pybind11/MANIFEST.in b/plugins/python/pybind11/MANIFEST.in new file mode 100644 index 0000000..6e57bae --- /dev/null +++ b/plugins/python/pybind11/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include include/pybind11 *.h +include LICENSE README.md CONTRIBUTING.md diff --git a/plugins/python/pybind11/README.md b/plugins/python/pybind11/README.md new file mode 100644 index 0000000..17cf115 --- /dev/null +++ b/plugins/python/pybind11/README.md @@ -0,0 +1,129 @@ +![pybind11 logo](https://github.com/pybind/pybind11/raw/master/docs/pybind11-logo.png) + +# pybind11 — Seamless operability between C++11 and Python + +[![Documentation Status](https://readthedocs.org/projects/pybind11/badge/?version=master)](http://pybind11.readthedocs.org/en/master/?badge=master) +[![Documentation Status](https://readthedocs.org/projects/pybind11/badge/?version=stable)](http://pybind11.readthedocs.org/en/stable/?badge=stable) +[![Gitter chat](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/pybind/Lobby) +[![Build Status](https://travis-ci.org/pybind/pybind11.svg?branch=master)](https://travis-ci.org/pybind/pybind11) +[![Build status](https://ci.appveyor.com/api/projects/status/riaj54pn4h08xy40?svg=true)](https://ci.appveyor.com/project/wjakob/pybind11) + +**pybind11** is a lightweight header-only library that exposes C++ types in Python +and vice versa, mainly to create Python bindings of existing C++ code. Its +goals and syntax are similar to the excellent +[Boost.Python](http://www.boost.org/doc/libs/1_58_0/libs/python/doc/) library +by David Abrahams: to minimize boilerplate code in traditional extension +modules by inferring type information using compile-time introspection. + +The main issue with Boost.Python—and the reason for creating such a similar +project—is Boost. Boost is an enormously large and complex suite of utility +libraries that works with almost every C++ compiler in existence. This +compatibility has its cost: arcane template tricks and workarounds are +necessary to support the oldest and buggiest of compiler specimens. Now that +C++11-compatible compilers are widely available, this heavy machinery has +become an excessively large and unnecessary dependency. + +Think of this library as a tiny self-contained version of Boost.Python with +everything stripped away that isn't relevant for binding generation. Without +comments, the core header files only require ~4K lines of code and depend on +Python (2.7 or 3.x, or PyPy2.7 >= 5.7) and the C++ standard library. This +compact implementation was possible thanks to some of the new C++11 language +features (specifically: tuples, lambda functions and variadic templates). Since +its creation, this library has grown beyond Boost.Python in many ways, leading +to dramatically simpler binding code in many common situations. + +Tutorial and reference documentation is provided at +[http://pybind11.readthedocs.org/en/master](http://pybind11.readthedocs.org/en/master). +A PDF version of the manual is available +[here](https://media.readthedocs.org/pdf/pybind11/master/pybind11.pdf). + +## Core features +pybind11 can map the following core C++ features to Python + +- Functions accepting and returning custom data structures per value, reference, or pointer +- Instance methods and static methods +- Overloaded functions +- Instance attributes and static attributes +- Arbitrary exception types +- Enumerations +- Callbacks +- Iterators and ranges +- Custom operators +- Single and multiple inheritance +- STL data structures +- Iterators and ranges +- Smart pointers with reference counting like ``std::shared_ptr`` +- Internal references with correct reference counting +- C++ classes with virtual (and pure virtual) methods can be extended in Python + +## Goodies +In addition to the core functionality, pybind11 provides some extra goodies: + +- Python 2.7, 3.x, and PyPy (PyPy2.7 >= 5.7) are supported with an + implementation-agnostic interface. + +- It is possible to bind C++11 lambda functions with captured variables. The + lambda capture data is stored inside the resulting Python function object. + +- pybind11 uses C++11 move constructors and move assignment operators whenever + possible to efficiently transfer custom data types. + +- It's easy to expose the internal storage of custom data types through + Pythons' buffer protocols. This is handy e.g. for fast conversion between + C++ matrix classes like Eigen and NumPy without expensive copy operations. + +- pybind11 can automatically vectorize functions so that they are transparently + applied to all entries of one or more NumPy array arguments. + +- Python's slice-based access and assignment operations can be supported with + just a few lines of code. + +- Everything is contained in just a few header files; there is no need to link + against any additional libraries. + +- Binaries are generally smaller by a factor of at least 2 compared to + equivalent bindings generated by Boost.Python. A recent pybind11 conversion + of PyRosetta, an enormous Boost.Python binding project, + [reported](http://graylab.jhu.edu/RosettaCon2016/PyRosetta-4.pdf) a binary + size reduction of **5.4x** and compile time reduction by **5.8x**. + +- When supported by the compiler, two new C++14 features (relaxed constexpr and + return value deduction) are used to precompute function signatures at compile + time, leading to smaller binaries. + +- With little extra effort, C++ types can be pickled and unpickled similar to + regular Python objects. + +## Supported compilers + +1. Clang/LLVM 3.3 or newer (for Apple Xcode's clang, this is 5.0.0 or newer) +2. GCC 4.8 or newer +3. Microsoft Visual Studio 2015 Update 3 or newer +4. Intel C++ compiler 17 or newer (16 with pybind11 v2.0 and 15 with pybind11 v2.0 and a [workaround](https://github.com/pybind/pybind11/issues/276)) +5. Cygwin/GCC (tested on 2.5.1) + +## About + +This project was created by [Wenzel Jakob](http://rgl.epfl.ch/people/wjakob). +Significant features and/or improvements to the code were contributed by +Jonas Adler, +Sylvain Corlay, +Trent Houliston, +Axel Huebl, +@hulucc, +Sergey Lyskov +Johan Mabille, +Tomasz Miąsko, +Dean Moldovan, +Ben Pritchard, +Jason Rhinelander, +Boris Schäling, +Pim Schellart, +Ivan Smirnov, and +Patrick Stewart. + +### License + +pybind11 is provided under a BSD-style license that can be found in the +``LICENSE`` file. By using, distributing, or contributing to this project, +you agree to the terms and conditions of this license. diff --git a/plugins/python/pybind11/docs/Doxyfile b/plugins/python/pybind11/docs/Doxyfile new file mode 100644 index 0000000..1b9d129 --- /dev/null +++ b/plugins/python/pybind11/docs/Doxyfile @@ -0,0 +1,20 @@ +PROJECT_NAME = pybind11 +INPUT = ../include/pybind11/ +RECURSIVE = YES + +GENERATE_HTML = NO +GENERATE_LATEX = NO +GENERATE_XML = YES +XML_OUTPUT = .build/doxygenxml +XML_PROGRAMLISTING = YES + +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES +EXPAND_AS_DEFINED = PYBIND11_RUNTIME_EXCEPTION + +ALIASES = "rst=\verbatim embed:rst" +ALIASES += "endrst=\endverbatim" + +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = NO diff --git a/plugins/python/pybind11/docs/Makefile b/plugins/python/pybind11/docs/Makefile new file mode 100644 index 0000000..511b47c --- /dev/null +++ b/plugins/python/pybind11/docs/Makefile @@ -0,0 +1,192 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = .build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pybind11.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pybind11.qhc" + +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/pybind11" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pybind11" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/plugins/python/pybind11/docs/_static/theme_overrides.css b/plugins/python/pybind11/docs/_static/theme_overrides.css new file mode 100644 index 0000000..1071809 --- /dev/null +++ b/plugins/python/pybind11/docs/_static/theme_overrides.css @@ -0,0 +1,11 @@ +.wy-table-responsive table td, +.wy-table-responsive table th { + white-space: initial !important; +} +.rst-content table.docutils td { + vertical-align: top !important; +} +div[class^='highlight'] pre { + white-space: pre; + white-space: pre-wrap; +} diff --git a/plugins/python/pybind11/docs/advanced/cast/chrono.rst b/plugins/python/pybind11/docs/advanced/cast/chrono.rst new file mode 100644 index 0000000..8c6b3d7 --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/cast/chrono.rst @@ -0,0 +1,81 @@ +Chrono +====== + +When including the additional header file :file:`pybind11/chrono.h` conversions +from C++11 chrono datatypes to python datetime objects are automatically enabled. +This header also enables conversions of python floats (often from sources such +as ``time.monotonic()``, ``time.perf_counter()`` and ``time.process_time()``) +into durations. + +An overview of clocks in C++11 +------------------------------ + +A point of confusion when using these conversions is the differences between +clocks provided in C++11. There are three clock types defined by the C++11 +standard and users can define their own if needed. Each of these clocks have +different properties and when converting to and from python will give different +results. + +The first clock defined by the standard is ``std::chrono::system_clock``. This +clock measures the current date and time. However, this clock changes with to +updates to the operating system time. For example, if your time is synchronised +with a time server this clock will change. This makes this clock a poor choice +for timing purposes but good for measuring the wall time. + +The second clock defined in the standard is ``std::chrono::steady_clock``. +This clock ticks at a steady rate and is never adjusted. This makes it excellent +for timing purposes, however the value in this clock does not correspond to the +current date and time. Often this clock will be the amount of time your system +has been on, although it does not have to be. This clock will never be the same +clock as the system clock as the system clock can change but steady clocks +cannot. + +The third clock defined in the standard is ``std::chrono::high_resolution_clock``. +This clock is the clock that has the highest resolution out of the clocks in the +system. It is normally a typedef to either the system clock or the steady clock +but can be its own independent clock. This is important as when using these +conversions as the types you get in python for this clock might be different +depending on the system. +If it is a typedef of the system clock, python will get datetime objects, but if +it is a different clock they will be timedelta objects. + +Provided conversions +-------------------- + +.. rubric:: C++ to Python + +- ``std::chrono::system_clock::time_point`` → ``datetime.datetime`` + System clock times are converted to python datetime instances. They are + in the local timezone, but do not have any timezone information attached + to them (they are naive datetime objects). + +- ``std::chrono::duration`` → ``datetime.timedelta`` + Durations are converted to timedeltas, any precision in the duration + greater than microseconds is lost by rounding towards zero. + +- ``std::chrono::[other_clocks]::time_point`` → ``datetime.timedelta`` + Any clock time that is not the system clock is converted to a time delta. + This timedelta measures the time from the clocks epoch to now. + +.. rubric:: Python to C++ + +- ``datetime.datetime`` → ``std::chrono::system_clock::time_point`` + Date/time objects are converted into system clock timepoints. Any + timezone information is ignored and the type is treated as a naive + object. + +- ``datetime.timedelta`` → ``std::chrono::duration`` + Time delta are converted into durations with microsecond precision. + +- ``datetime.timedelta`` → ``std::chrono::[other_clocks]::time_point`` + Time deltas that are converted into clock timepoints are treated as + the amount of time from the start of the clocks epoch. + +- ``float`` → ``std::chrono::duration`` + Floats that are passed to C++ as durations be interpreted as a number of + seconds. These will be converted to the duration using ``duration_cast`` + from the float. + +- ``float`` → ``std::chrono::[other_clocks]::time_point`` + Floats that are passed to C++ as time points will be interpreted as the + number of seconds from the start of the clocks epoch. diff --git a/plugins/python/pybind11/docs/advanced/cast/custom.rst b/plugins/python/pybind11/docs/advanced/cast/custom.rst new file mode 100644 index 0000000..e4f99ac --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/cast/custom.rst @@ -0,0 +1,91 @@ +Custom type casters +=================== + +In very rare cases, applications may require custom type casters that cannot be +expressed using the abstractions provided by pybind11, thus requiring raw +Python C API calls. This is fairly advanced usage and should only be pursued by +experts who are familiar with the intricacies of Python reference counting. + +The following snippets demonstrate how this works for a very simple ``inty`` +type that that should be convertible from Python types that provide a +``__int__(self)`` method. + +.. code-block:: cpp + + struct inty { long long_value; }; + + void print(inty s) { + std::cout << s.long_value << std::endl; + } + +The following Python snippet demonstrates the intended usage from the Python side: + +.. code-block:: python + + class A: + def __int__(self): + return 123 + + from example import print + print(A()) + +To register the necessary conversion routines, it is necessary to add +a partial overload to the ``pybind11::detail::type_caster`` template. +Although this is an implementation detail, adding partial overloads to this +type is explicitly allowed. + +.. code-block:: cpp + + namespace pybind11 { namespace detail { + template <> struct type_caster { + public: + /** + * This macro establishes the name 'inty' in + * function signatures and declares a local variable + * 'value' of type inty + */ + PYBIND11_TYPE_CASTER(inty, _("inty")); + + /** + * Conversion part 1 (Python->C++): convert a PyObject into a inty + * instance or return false upon failure. The second argument + * indicates whether implicit conversions should be applied. + */ + bool load(handle src, bool) { + /* Extract PyObject from handle */ + PyObject *source = src.ptr(); + /* Try converting into a Python integer value */ + PyObject *tmp = PyNumber_Long(source); + if (!tmp) + return false; + /* Now try to convert into a C++ int */ + value.long_value = PyLong_AsLong(tmp); + Py_DECREF(tmp); + /* Ensure return code was OK (to avoid out-of-range errors etc) */ + return !(value.long_value == -1 && !PyErr_Occurred()); + } + + /** + * Conversion part 2 (C++ -> Python): convert an inty instance into + * a Python object. The second and third arguments are used to + * indicate the return value policy and parent object (for + * ``return_value_policy::reference_internal``) and are generally + * ignored by implicit casters. + */ + static handle cast(inty src, return_value_policy /* policy */, handle /* parent */) { + return PyLong_FromLong(src.long_value); + } + }; + }} // namespace pybind11::detail + +.. note:: + + A ``type_caster`` defined with ``PYBIND11_TYPE_CASTER(T, ...)`` requires + that ``T`` is default-constructible (``value`` is first default constructed + and then ``load()`` assigns to it). + +.. warning:: + + When using custom type casters, it's important to declare them consistently + in every compilation unit of the Python extension module. Otherwise, + undefined behavior can ensue. diff --git a/plugins/python/pybind11/docs/advanced/cast/eigen.rst b/plugins/python/pybind11/docs/advanced/cast/eigen.rst new file mode 100644 index 0000000..7cbeac0 --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/cast/eigen.rst @@ -0,0 +1,310 @@ +Eigen +##### + +`Eigen `_ is C++ header-based library for dense and +sparse linear algebra. Due to its popularity and widespread adoption, pybind11 +provides transparent conversion and limited mapping support between Eigen and +Scientific Python linear algebra data types. + +To enable the built-in Eigen support you must include the optional header file +:file:`pybind11/eigen.h`. + +Pass-by-value +============= + +When binding a function with ordinary Eigen dense object arguments (for +example, ``Eigen::MatrixXd``), pybind11 will accept any input value that is +already (or convertible to) a ``numpy.ndarray`` with dimensions compatible with +the Eigen type, copy its values into a temporary Eigen variable of the +appropriate type, then call the function with this temporary variable. + +Sparse matrices are similarly copied to or from +``scipy.sparse.csr_matrix``/``scipy.sparse.csc_matrix`` objects. + +Pass-by-reference +================= + +One major limitation of the above is that every data conversion implicitly +involves a copy, which can be both expensive (for large matrices) and disallows +binding functions that change their (Matrix) arguments. Pybind11 allows you to +work around this by using Eigen's ``Eigen::Ref`` class much as you +would when writing a function taking a generic type in Eigen itself (subject to +some limitations discussed below). + +When calling a bound function accepting a ``Eigen::Ref`` +type, pybind11 will attempt to avoid copying by using an ``Eigen::Map`` object +that maps into the source ``numpy.ndarray`` data: this requires both that the +data types are the same (e.g. ``dtype='float64'`` and ``MatrixType::Scalar`` is +``double``); and that the storage is layout compatible. The latter limitation +is discussed in detail in the section below, and requires careful +consideration: by default, numpy matrices and eigen matrices are *not* storage +compatible. + +If the numpy matrix cannot be used as is (either because its types differ, e.g. +passing an array of integers to an Eigen parameter requiring doubles, or +because the storage is incompatible), pybind11 makes a temporary copy and +passes the copy instead. + +When a bound function parameter is instead ``Eigen::Ref`` (note the +lack of ``const``), pybind11 will only allow the function to be called if it +can be mapped *and* if the numpy array is writeable (that is +``a.flags.writeable`` is true). Any access (including modification) made to +the passed variable will be transparently carried out directly on the +``numpy.ndarray``. + +This means you can can write code such as the following and have it work as +expected: + +.. code-block:: cpp + + void scale_by_2(Eigen::Ref v) { + v *= 2; + } + +Note, however, that you will likely run into limitations due to numpy and +Eigen's difference default storage order for data; see the below section on +:ref:`storage_orders` for details on how to bind code that won't run into such +limitations. + +.. note:: + + Passing by reference is not supported for sparse types. + +Returning values to Python +========================== + +When returning an ordinary dense Eigen matrix type to numpy (e.g. +``Eigen::MatrixXd`` or ``Eigen::RowVectorXf``) pybind11 keeps the matrix and +returns a numpy array that directly references the Eigen matrix: no copy of the +data is performed. The numpy array will have ``array.flags.owndata`` set to +``False`` to indicate that it does not own the data, and the lifetime of the +stored Eigen matrix will be tied to the returned ``array``. + +If you bind a function with a non-reference, ``const`` return type (e.g. +``const Eigen::MatrixXd``), the same thing happens except that pybind11 also +sets the numpy array's ``writeable`` flag to false. + +If you return an lvalue reference or pointer, the usual pybind11 rules apply, +as dictated by the binding function's return value policy (see the +documentation on :ref:`return_value_policies` for full details). That means, +without an explicit return value policy, lvalue references will be copied and +pointers will be managed by pybind11. In order to avoid copying, you should +explicitly specify an appropriate return value policy, as in the following +example: + +.. code-block:: cpp + + class MyClass { + Eigen::MatrixXd big_mat = Eigen::MatrixXd::Zero(10000, 10000); + public: + Eigen::MatrixXd &getMatrix() { return big_mat; } + const Eigen::MatrixXd &viewMatrix() { return big_mat; } + }; + + // Later, in binding code: + py::class_(m, "MyClass") + .def(py::init<>()) + .def("copy_matrix", &MyClass::getMatrix) // Makes a copy! + .def("get_matrix", &MyClass::getMatrix, py::return_value_policy::reference_internal) + .def("view_matrix", &MyClass::viewMatrix, py::return_value_policy::reference_internal) + ; + +.. code-block:: python + + a = MyClass() + m = a.get_matrix() # flags.writeable = True, flags.owndata = False + v = a.view_matrix() # flags.writeable = False, flags.owndata = False + c = a.copy_matrix() # flags.writeable = True, flags.owndata = True + # m[5,6] and v[5,6] refer to the same element, c[5,6] does not. + +Note in this example that ``py::return_value_policy::reference_internal`` is +used to tie the life of the MyClass object to the life of the returned arrays. + +You may also return an ``Eigen::Ref``, ``Eigen::Map`` or other map-like Eigen +object (for example, the return value of ``matrix.block()`` and related +methods) that map into a dense Eigen type. When doing so, the default +behaviour of pybind11 is to simply reference the returned data: you must take +care to ensure that this data remains valid! You may ask pybind11 to +explicitly *copy* such a return value by using the +``py::return_value_policy::copy`` policy when binding the function. You may +also use ``py::return_value_policy::reference_internal`` or a +``py::keep_alive`` to ensure the data stays valid as long as the returned numpy +array does. + +When returning such a reference of map, pybind11 additionally respects the +readonly-status of the returned value, marking the numpy array as non-writeable +if the reference or map was itself read-only. + +.. note:: + + Sparse types are always copied when returned. + +.. _storage_orders: + +Storage orders +============== + +Passing arguments via ``Eigen::Ref`` has some limitations that you must be +aware of in order to effectively pass matrices by reference. First and +foremost is that the default ``Eigen::Ref`` class requires +contiguous storage along columns (for column-major types, the default in Eigen) +or rows if ``MatrixType`` is specifically an ``Eigen::RowMajor`` storage type. +The former, Eigen's default, is incompatible with ``numpy``'s default row-major +storage, and so you will not be able to pass numpy arrays to Eigen by reference +without making one of two changes. + +(Note that this does not apply to vectors (or column or row matrices): for such +types the "row-major" and "column-major" distinction is meaningless). + +The first approach is to change the use of ``Eigen::Ref`` to the +more general ``Eigen::Ref>`` (or similar type with a fully dynamic stride type in the +third template argument). Since this is a rather cumbersome type, pybind11 +provides a ``py::EigenDRef`` type alias for your convenience (along +with EigenDMap for the equivalent Map, and EigenDStride for just the stride +type). + +This type allows Eigen to map into any arbitrary storage order. This is not +the default in Eigen for performance reasons: contiguous storage allows +vectorization that cannot be done when storage is not known to be contiguous at +compile time. The default ``Eigen::Ref`` stride type allows non-contiguous +storage along the outer dimension (that is, the rows of a column-major matrix +or columns of a row-major matrix), but not along the inner dimension. + +This type, however, has the added benefit of also being able to map numpy array +slices. For example, the following (contrived) example uses Eigen with a numpy +slice to multiply by 2 all coefficients that are both on even rows (0, 2, 4, +...) and in columns 2, 5, or 8: + +.. code-block:: cpp + + m.def("scale", [](py::EigenDRef m, double c) { m *= c; }); + +.. code-block:: python + + # a = np.array(...) + scale_by_2(myarray[0::2, 2:9:3]) + +The second approach to avoid copying is more intrusive: rearranging the +underlying data types to not run into the non-contiguous storage problem in the +first place. In particular, that means using matrices with ``Eigen::RowMajor`` +storage, where appropriate, such as: + +.. code-block:: cpp + + using RowMatrixXd = Eigen::Matrix; + // Use RowMatrixXd instead of MatrixXd + +Now bound functions accepting ``Eigen::Ref`` arguments will be +callable with numpy's (default) arrays without involving a copying. + +You can, alternatively, change the storage order that numpy arrays use by +adding the ``order='F'`` option when creating an array: + +.. code-block:: python + + myarray = np.array(source, order='F') + +Such an object will be passable to a bound function accepting an +``Eigen::Ref`` (or similar column-major Eigen type). + +One major caveat with this approach, however, is that it is not entirely as +easy as simply flipping all Eigen or numpy usage from one to the other: some +operations may alter the storage order of a numpy array. For example, ``a2 = +array.transpose()`` results in ``a2`` being a view of ``array`` that references +the same data, but in the opposite storage order! + +While this approach allows fully optimized vectorized calculations in Eigen, it +cannot be used with array slices, unlike the first approach. + +When *returning* a matrix to Python (either a regular matrix, a reference via +``Eigen::Ref<>``, or a map/block into a matrix), no special storage +consideration is required: the created numpy array will have the required +stride that allows numpy to properly interpret the array, whatever its storage +order. + +Failing rather than copying +=========================== + +The default behaviour when binding ``Eigen::Ref`` eigen +references is to copy matrix values when passed a numpy array that does not +conform to the element type of ``MatrixType`` or does not have a compatible +stride layout. If you want to explicitly avoid copying in such a case, you +should bind arguments using the ``py::arg().noconvert()`` annotation (as +described in the :ref:`nonconverting_arguments` documentation). + +The following example shows an example of arguments that don't allow data +copying to take place: + +.. code-block:: cpp + + // The method and function to be bound: + class MyClass { + // ... + double some_method(const Eigen::Ref &matrix) { /* ... */ } + }; + float some_function(const Eigen::Ref &big, + const Eigen::Ref &small) { + // ... + } + + // The associated binding code: + using namespace pybind11::literals; // for "arg"_a + py::class_(m, "MyClass") + // ... other class definitions + .def("some_method", &MyClass::some_method, py::arg().noconvert()); + + m.def("some_function", &some_function, + "big"_a.noconvert(), // <- Don't allow copying for this arg + "small"_a // <- This one can be copied if needed + ); + +With the above binding code, attempting to call the the ``some_method(m)`` +method on a ``MyClass`` object, or attempting to call ``some_function(m, m2)`` +will raise a ``RuntimeError`` rather than making a temporary copy of the array. +It will, however, allow the ``m2`` argument to be copied into a temporary if +necessary. + +Note that explicitly specifying ``.noconvert()`` is not required for *mutable* +Eigen references (e.g. ``Eigen::Ref`` without ``const`` on the +``MatrixXd``): mutable references will never be called with a temporary copy. + +Vectors versus column/row matrices +================================== + +Eigen and numpy have fundamentally different notions of a vector. In Eigen, a +vector is simply a matrix with the number of columns or rows set to 1 at +compile time (for a column vector or row vector, respectively). Numpy, in +contrast, has comparable 2-dimensional 1xN and Nx1 arrays, but *also* has +1-dimensional arrays of size N. + +When passing a 2-dimensional 1xN or Nx1 array to Eigen, the Eigen type must +have matching dimensions: That is, you cannot pass a 2-dimensional Nx1 numpy +array to an Eigen value expecting a row vector, or a 1xN numpy array as a +column vector argument. + +On the other hand, pybind11 allows you to pass 1-dimensional arrays of length N +as Eigen parameters. If the Eigen type can hold a column vector of length N it +will be passed as such a column vector. If not, but the Eigen type constraints +will accept a row vector, it will be passed as a row vector. (The column +vector takes precedence when both are supported, for example, when passing a +1D numpy array to a MatrixXd argument). Note that the type need not be +expicitly a vector: it is permitted to pass a 1D numpy array of size 5 to an +Eigen ``Matrix``: you would end up with a 1x5 Eigen matrix. +Passing the same to an ``Eigen::MatrixXd`` would result in a 5x1 Eigen matrix. + +When returning an eigen vector to numpy, the conversion is ambiguous: a row +vector of length 4 could be returned as either a 1D array of length 4, or as a +2D array of size 1x4. When encoutering such a situation, pybind11 compromises +by considering the returned Eigen type: if it is a compile-time vector--that +is, the type has either the number of rows or columns set to 1 at compile +time--pybind11 converts to a 1D numpy array when returning the value. For +instances that are a vector only at run-time (e.g. ``MatrixXd``, +``Matrix``), pybind11 returns the vector as a 2D array to +numpy. If this isn't want you want, you can use ``array.reshape(...)`` to get +a view of the same data in the desired dimensions. + +.. seealso:: + + The file :file:`tests/test_eigen.cpp` contains a complete example that + shows how to pass Eigen sparse and dense data types in more detail. diff --git a/plugins/python/pybind11/docs/advanced/cast/functional.rst b/plugins/python/pybind11/docs/advanced/cast/functional.rst new file mode 100644 index 0000000..d9b4605 --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/cast/functional.rst @@ -0,0 +1,109 @@ +Functional +########## + +The following features must be enabled by including :file:`pybind11/functional.h`. + + +Callbacks and passing anonymous functions +========================================= + +The C++11 standard brought lambda functions and the generic polymorphic +function wrapper ``std::function<>`` to the C++ programming language, which +enable powerful new ways of working with functions. Lambda functions come in +two flavors: stateless lambda function resemble classic function pointers that +link to an anonymous piece of code, while stateful lambda functions +additionally depend on captured variables that are stored in an anonymous +*lambda closure object*. + +Here is a simple example of a C++ function that takes an arbitrary function +(stateful or stateless) with signature ``int -> int`` as an argument and runs +it with the value 10. + +.. code-block:: cpp + + int func_arg(const std::function &f) { + return f(10); + } + +The example below is more involved: it takes a function of signature ``int -> int`` +and returns another function of the same kind. The return value is a stateful +lambda function, which stores the value ``f`` in the capture object and adds 1 to +its return value upon execution. + +.. code-block:: cpp + + std::function func_ret(const std::function &f) { + return [f](int i) { + return f(i) + 1; + }; + } + +This example demonstrates using python named parameters in C++ callbacks which +requires using ``py::cpp_function`` as a wrapper. Usage is similar to defining +methods of classes: + +.. code-block:: cpp + + py::cpp_function func_cpp() { + return py::cpp_function([](int i) { return i+1; }, + py::arg("number")); + } + +After including the extra header file :file:`pybind11/functional.h`, it is almost +trivial to generate binding code for all of these functions. + +.. code-block:: cpp + + #include + + PYBIND11_MODULE(example, m) { + m.def("func_arg", &func_arg); + m.def("func_ret", &func_ret); + m.def("func_cpp", &func_cpp); + } + +The following interactive session shows how to call them from Python. + +.. code-block:: pycon + + $ python + >>> import example + >>> def square(i): + ... return i * i + ... + >>> example.func_arg(square) + 100L + >>> square_plus_1 = example.func_ret(square) + >>> square_plus_1(4) + 17L + >>> plus_1 = func_cpp() + >>> plus_1(number=43) + 44L + +.. warning:: + + Keep in mind that passing a function from C++ to Python (or vice versa) + will instantiate a piece of wrapper code that translates function + invocations between the two languages. Naturally, this translation + increases the computational cost of each function call somewhat. A + problematic situation can arise when a function is copied back and forth + between Python and C++ many times in a row, in which case the underlying + wrappers will accumulate correspondingly. The resulting long sequence of + C++ -> Python -> C++ -> ... roundtrips can significantly decrease + performance. + + There is one exception: pybind11 detects case where a stateless function + (i.e. a function pointer or a lambda function without captured variables) + is passed as an argument to another C++ function exposed in Python. In this + case, there is no overhead. Pybind11 will extract the underlying C++ + function pointer from the wrapped function to sidestep a potential C++ -> + Python -> C++ roundtrip. This is demonstrated in :file:`tests/test_callbacks.cpp`. + +.. note:: + + This functionality is very useful when generating bindings for callbacks in + C++ libraries (e.g. GUI libraries, asynchronous networking libraries, etc.). + + The file :file:`tests/test_callbacks.cpp` contains a complete example + that demonstrates how to work with callbacks and anonymous functions in + more detail. diff --git a/plugins/python/pybind11/docs/advanced/cast/index.rst b/plugins/python/pybind11/docs/advanced/cast/index.rst new file mode 100644 index 0000000..54c1057 --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/cast/index.rst @@ -0,0 +1,42 @@ +Type conversions +################ + +Apart from enabling cross-language function calls, a fundamental problem +that a binding tool like pybind11 must address is to provide access to +native Python types in C++ and vice versa. There are three fundamentally +different ways to do this—which approach is preferable for a particular type +depends on the situation at hand. + +1. Use a native C++ type everywhere. In this case, the type must be wrapped + using pybind11-generated bindings so that Python can interact with it. + +2. Use a native Python type everywhere. It will need to be wrapped so that + C++ functions can interact with it. + +3. Use a native C++ type on the C++ side and a native Python type on the + Python side. pybind11 refers to this as a *type conversion*. + + Type conversions are the most "natural" option in the sense that native + (non-wrapped) types are used everywhere. The main downside is that a copy + of the data must be made on every Python ↔ C++ transition: this is + needed since the C++ and Python versions of the same type generally won't + have the same memory layout. + + pybind11 can perform many kinds of conversions automatically. An overview + is provided in the table ":ref:`conversion_table`". + +The following subsections discuss the differences between these options in more +detail. The main focus in this section is on type conversions, which represent +the last case of the above list. + +.. toctree:: + :maxdepth: 1 + + overview + strings + stl + functional + chrono + eigen + custom + diff --git a/plugins/python/pybind11/docs/advanced/cast/overview.rst b/plugins/python/pybind11/docs/advanced/cast/overview.rst new file mode 100644 index 0000000..2ac7d30 --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/cast/overview.rst @@ -0,0 +1,163 @@ +Overview +######## + +.. rubric:: 1. Native type in C++, wrapper in Python + +Exposing a custom C++ type using :class:`py::class_` was covered in detail +in the :doc:`/classes` section. There, the underlying data structure is +always the original C++ class while the :class:`py::class_` wrapper provides +a Python interface. Internally, when an object like this is sent from C++ to +Python, pybind11 will just add the outer wrapper layer over the native C++ +object. Getting it back from Python is just a matter of peeling off the +wrapper. + +.. rubric:: 2. Wrapper in C++, native type in Python + +This is the exact opposite situation. Now, we have a type which is native to +Python, like a ``tuple`` or a ``list``. One way to get this data into C++ is +with the :class:`py::object` family of wrappers. These are explained in more +detail in the :doc:`/advanced/pycpp/object` section. We'll just give a quick +example here: + +.. code-block:: cpp + + void print_list(py::list my_list) { + for (auto item : my_list) + std::cout << item << " "; + } + +.. code-block:: pycon + + >>> print_list([1, 2, 3]) + 1 2 3 + +The Python ``list`` is not converted in any way -- it's just wrapped in a C++ +:class:`py::list` class. At its core it's still a Python object. Copying a +:class:`py::list` will do the usual reference-counting like in Python. +Returning the object to Python will just remove the thin wrapper. + +.. rubric:: 3. Converting between native C++ and Python types + +In the previous two cases we had a native type in one language and a wrapper in +the other. Now, we have native types on both sides and we convert between them. + +.. code-block:: cpp + + void print_vector(const std::vector &v) { + for (auto item : v) + std::cout << item << "\n"; + } + +.. code-block:: pycon + + >>> print_vector([1, 2, 3]) + 1 2 3 + +In this case, pybind11 will construct a new ``std::vector`` and copy each +element from the Python ``list``. The newly constructed object will be passed +to ``print_vector``. The same thing happens in the other direction: a new +``list`` is made to match the value returned from C++. + +Lots of these conversions are supported out of the box, as shown in the table +below. They are very convenient, but keep in mind that these conversions are +fundamentally based on copying data. This is perfectly fine for small immutable +types but it may become quite expensive for large data structures. This can be +avoided by overriding the automatic conversion with a custom wrapper (i.e. the +above-mentioned approach 1). This requires some manual effort and more details +are available in the :ref:`opaque` section. + +.. _conversion_table: + +List of all builtin conversions +------------------------------- + +The following basic data types are supported out of the box (some may require +an additional extension header to be included). To pass other data structures +as arguments and return values, refer to the section on binding :ref:`classes`. + ++------------------------------------+---------------------------+-------------------------------+ +| Data type | Description | Header file | ++====================================+===========================+===============================+ +| ``int8_t``, ``uint8_t`` | 8-bit integers | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``int16_t``, ``uint16_t`` | 16-bit integers | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``int32_t``, ``uint32_t`` | 32-bit integers | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``int64_t``, ``uint64_t`` | 64-bit integers | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``ssize_t``, ``size_t`` | Platform-dependent size | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``float``, ``double`` | Floating point types | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``bool`` | Two-state Boolean type | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``char`` | Character literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``char16_t`` | UTF-16 character literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``char32_t`` | UTF-32 character literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``wchar_t`` | Wide character literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``const char *`` | UTF-8 string literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``const char16_t *`` | UTF-16 string literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``const char32_t *`` | UTF-32 string literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``const wchar_t *`` | Wide string literal | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::string`` | STL dynamic UTF-8 string | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::u16string`` | STL dynamic UTF-16 string | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::u32string`` | STL dynamic UTF-32 string | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::wstring`` | STL dynamic wide string | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::string_view``, | STL C++17 string views | :file:`pybind11/pybind11.h` | +| ``std::u16string_view``, etc. | | | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::pair`` | Pair of two custom types | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::tuple<...>`` | Arbitrary tuple of types | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::reference_wrapper<...>`` | Reference type wrapper | :file:`pybind11/pybind11.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::complex`` | Complex numbers | :file:`pybind11/complex.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::array`` | STL static array | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::vector`` | STL dynamic array | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::valarray`` | STL value array | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::list`` | STL linked list | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::map`` | STL ordered map | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::unordered_map`` | STL unordered map | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::set`` | STL ordered set | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::unordered_set`` | STL unordered set | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::optional`` | STL optional type (C++17) | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::experimental::optional`` | STL optional type (exp.) | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::variant<...>`` | Type-safe union (C++17) | :file:`pybind11/stl.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::function<...>`` | STL polymorphic function | :file:`pybind11/functional.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::chrono::duration<...>`` | STL time duration | :file:`pybind11/chrono.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``std::chrono::time_point<...>`` | STL date/time | :file:`pybind11/chrono.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``Eigen::Matrix<...>`` | Eigen: dense matrix | :file:`pybind11/eigen.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``Eigen::Map<...>`` | Eigen: mapped memory | :file:`pybind11/eigen.h` | ++------------------------------------+---------------------------+-------------------------------+ +| ``Eigen::SparseMatrix<...>`` | Eigen: sparse matrix | :file:`pybind11/eigen.h` | ++------------------------------------+---------------------------+-------------------------------+ diff --git a/plugins/python/pybind11/docs/advanced/cast/stl.rst b/plugins/python/pybind11/docs/advanced/cast/stl.rst new file mode 100644 index 0000000..3f30c02 --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/cast/stl.rst @@ -0,0 +1,243 @@ +STL containers +############## + +Automatic conversion +==================== + +When including the additional header file :file:`pybind11/stl.h`, conversions +between ``std::vector<>``/``std::list<>``/``std::array<>``, +``std::set<>``/``std::unordered_set<>``, and +``std::map<>``/``std::unordered_map<>`` and the Python ``list``, ``set`` and +``dict`` data structures are automatically enabled. The types ``std::pair<>`` +and ``std::tuple<>`` are already supported out of the box with just the core +:file:`pybind11/pybind11.h` header. + +The major downside of these implicit conversions is that containers must be +converted (i.e. copied) on every Python->C++ and C++->Python transition, which +can have implications on the program semantics and performance. Please read the +next sections for more details and alternative approaches that avoid this. + +.. note:: + + Arbitrary nesting of any of these types is possible. + +.. seealso:: + + The file :file:`tests/test_stl.cpp` contains a complete + example that demonstrates how to pass STL data types in more detail. + +.. _cpp17_container_casters: + +C++17 library containers +======================== + +The :file:`pybind11/stl.h` header also includes support for ``std::optional<>`` +and ``std::variant<>``. These require a C++17 compiler and standard library. +In C++14 mode, ``std::experimental::optional<>`` is supported if available. + +Various versions of these containers also exist for C++11 (e.g. in Boost). +pybind11 provides an easy way to specialize the ``type_caster`` for such +types: + +.. code-block:: cpp + + // `boost::optional` as an example -- can be any `std::optional`-like container + namespace pybind11 { namespace detail { + template + struct type_caster> : optional_caster> {}; + }} + +The above should be placed in a header file and included in all translation units +where automatic conversion is needed. Similarly, a specialization can be provided +for custom variant types: + +.. code-block:: cpp + + // `boost::variant` as an example -- can be any `std::variant`-like container + namespace pybind11 { namespace detail { + template + struct type_caster> : variant_caster> {}; + + // Specifies the function used to visit the variant -- `apply_visitor` instead of `visit` + template <> + struct visit_helper { + template + static auto call(Args &&...args) -> decltype(boost::apply_visitor(args...)) { + return boost::apply_visitor(args...); + } + }; + }} // namespace pybind11::detail + +The ``visit_helper`` specialization is not required if your ``name::variant`` provides +a ``name::visit()`` function. For any other function name, the specialization must be +included to tell pybind11 how to visit the variant. + +.. note:: + + pybind11 only supports the modern implementation of ``boost::variant`` + which makes use of variadic templates. This requires Boost 1.56 or newer. + Additionally, on Windows, MSVC 2017 is required because ``boost::variant`` + falls back to the old non-variadic implementation on MSVC 2015. + +.. _opaque: + +Making opaque types +=================== + +pybind11 heavily relies on a template matching mechanism to convert parameters +and return values that are constructed from STL data types such as vectors, +linked lists, hash tables, etc. This even works in a recursive manner, for +instance to deal with lists of hash maps of pairs of elementary and custom +types, etc. + +However, a fundamental limitation of this approach is that internal conversions +between Python and C++ types involve a copy operation that prevents +pass-by-reference semantics. What does this mean? + +Suppose we bind the following function + +.. code-block:: cpp + + void append_1(std::vector &v) { + v.push_back(1); + } + +and call it from Python, the following happens: + +.. code-block:: pycon + + >>> v = [5, 6] + >>> append_1(v) + >>> print(v) + [5, 6] + +As you can see, when passing STL data structures by reference, modifications +are not propagated back the Python side. A similar situation arises when +exposing STL data structures using the ``def_readwrite`` or ``def_readonly`` +functions: + +.. code-block:: cpp + + /* ... definition ... */ + + class MyClass { + std::vector contents; + }; + + /* ... binding code ... */ + + py::class_(m, "MyClass") + .def(py::init<>()) + .def_readwrite("contents", &MyClass::contents); + +In this case, properties can be read and written in their entirety. However, an +``append`` operation involving such a list type has no effect: + +.. code-block:: pycon + + >>> m = MyClass() + >>> m.contents = [5, 6] + >>> print(m.contents) + [5, 6] + >>> m.contents.append(7) + >>> print(m.contents) + [5, 6] + +Finally, the involved copy operations can be costly when dealing with very +large lists. To deal with all of the above situations, pybind11 provides a +macro named ``PYBIND11_MAKE_OPAQUE(T)`` that disables the template-based +conversion machinery of types, thus rendering them *opaque*. The contents of +opaque objects are never inspected or extracted, hence they *can* be passed by +reference. For instance, to turn ``std::vector`` into an opaque type, add +the declaration + +.. code-block:: cpp + + PYBIND11_MAKE_OPAQUE(std::vector); + +before any binding code (e.g. invocations to ``class_::def()``, etc.). This +macro must be specified at the top level (and outside of any namespaces), since +it instantiates a partial template overload. If your binding code consists of +multiple compilation units, it must be present in every file (typically via a +common header) preceding any usage of ``std::vector``. Opaque types must +also have a corresponding ``class_`` declaration to associate them with a name +in Python, and to define a set of available operations, e.g.: + +.. code-block:: cpp + + py::class_>(m, "IntVector") + .def(py::init<>()) + .def("clear", &std::vector::clear) + .def("pop_back", &std::vector::pop_back) + .def("__len__", [](const std::vector &v) { return v.size(); }) + .def("__iter__", [](std::vector &v) { + return py::make_iterator(v.begin(), v.end()); + }, py::keep_alive<0, 1>()) /* Keep vector alive while iterator is used */ + // .... + +Please take a look at the :ref:`macro_notes` before using the +``PYBIND11_MAKE_OPAQUE`` macro. + +.. seealso:: + + The file :file:`tests/test_opaque_types.cpp` contains a complete + example that demonstrates how to create and expose opaque types using + pybind11 in more detail. + +.. _stl_bind: + +Binding STL containers +====================== + +The ability to expose STL containers as native Python objects is a fairly +common request, hence pybind11 also provides an optional header file named +:file:`pybind11/stl_bind.h` that does exactly this. The mapped containers try +to match the behavior of their native Python counterparts as much as possible. + +The following example showcases usage of :file:`pybind11/stl_bind.h`: + +.. code-block:: cpp + + // Don't forget this + #include + + PYBIND11_MAKE_OPAQUE(std::vector); + PYBIND11_MAKE_OPAQUE(std::map); + + // ... + + // later in binding code: + py::bind_vector>(m, "VectorInt"); + py::bind_map>(m, "MapStringDouble"); + +When binding STL containers pybind11 considers the types of the container's +elements to decide whether the container should be confined to the local module +(via the :ref:`module_local` feature). If the container element types are +anything other than already-bound custom types bound without +``py::module_local()`` the container binding will have ``py::module_local()`` +applied. This includes converting types such as numeric types, strings, Eigen +types; and types that have not yet been bound at the time of the stl container +binding. This module-local binding is designed to avoid potential conflicts +between module bindings (for example, from two separate modules each attempting +to bind ``std::vector`` as a python type). + +It is possible to override this behavior to force a definition to be either +module-local or global. To do so, you can pass the attributes +``py::module_local()`` (to make the binding module-local) or +``py::module_local(false)`` (to make the binding global) into the +``py::bind_vector`` or ``py::bind_map`` arguments: + +.. code-block:: cpp + + py::bind_vector>(m, "VectorInt", py::module_local(false)); + +Note, however, that such a global binding would make it impossible to load this +module at the same time as any other pybind module that also attempts to bind +the same container type (``std::vector`` in the above example). + +See :ref:`module_local` for more details on module-local bindings. + +.. seealso:: + + The file :file:`tests/test_stl_binders.cpp` shows how to use the + convenience STL container wrappers. diff --git a/plugins/python/pybind11/docs/advanced/cast/strings.rst b/plugins/python/pybind11/docs/advanced/cast/strings.rst new file mode 100644 index 0000000..e25701e --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/cast/strings.rst @@ -0,0 +1,305 @@ +Strings, bytes and Unicode conversions +###################################### + +.. note:: + + This section discusses string handling in terms of Python 3 strings. For + Python 2.7, replace all occurrences of ``str`` with ``unicode`` and + ``bytes`` with ``str``. Python 2.7 users may find it best to use ``from + __future__ import unicode_literals`` to avoid unintentionally using ``str`` + instead of ``unicode``. + +Passing Python strings to C++ +============================= + +When a Python ``str`` is passed from Python to a C++ function that accepts +``std::string`` or ``char *`` as arguments, pybind11 will encode the Python +string to UTF-8. All Python ``str`` can be encoded in UTF-8, so this operation +does not fail. + +The C++ language is encoding agnostic. It is the responsibility of the +programmer to track encodings. It's often easiest to simply `use UTF-8 +everywhere `_. + +.. code-block:: c++ + + m.def("utf8_test", + [](const std::string &s) { + cout << "utf-8 is icing on the cake.\n"; + cout << s; + } + ); + m.def("utf8_charptr", + [](const char *s) { + cout << "My favorite food is\n"; + cout << s; + } + ); + +.. code-block:: python + + >>> utf8_test('🎂') + utf-8 is icing on the cake. + 🎂 + + >>> utf8_charptr('🍕') + My favorite food is + 🍕 + +.. note:: + + Some terminal emulators do not support UTF-8 or emoji fonts and may not + display the example above correctly. + +The results are the same whether the C++ function accepts arguments by value or +reference, and whether or not ``const`` is used. + +Passing bytes to C++ +-------------------- + +A Python ``bytes`` object will be passed to C++ functions that accept +``std::string`` or ``char*`` *without* conversion. On Python 3, in order to +make a function *only* accept ``bytes`` (and not ``str``), declare it as taking +a ``py::bytes`` argument. + + +Returning C++ strings to Python +=============================== + +When a C++ function returns a ``std::string`` or ``char*`` to a Python caller, +**pybind11 will assume that the string is valid UTF-8** and will decode it to a +native Python ``str``, using the same API as Python uses to perform +``bytes.decode('utf-8')``. If this implicit conversion fails, pybind11 will +raise a ``UnicodeDecodeError``. + +.. code-block:: c++ + + m.def("std_string_return", + []() { + return std::string("This string needs to be UTF-8 encoded"); + } + ); + +.. code-block:: python + + >>> isinstance(example.std_string_return(), str) + True + + +Because UTF-8 is inclusive of pure ASCII, there is never any issue with +returning a pure ASCII string to Python. If there is any possibility that the +string is not pure ASCII, it is necessary to ensure the encoding is valid +UTF-8. + +.. warning:: + + Implicit conversion assumes that a returned ``char *`` is null-terminated. + If there is no null terminator a buffer overrun will occur. + +Explicit conversions +-------------------- + +If some C++ code constructs a ``std::string`` that is not a UTF-8 string, one +can perform a explicit conversion and return a ``py::str`` object. Explicit +conversion has the same overhead as implicit conversion. + +.. code-block:: c++ + + // This uses the Python C API to convert Latin-1 to Unicode + m.def("str_output", + []() { + std::string s = "Send your r\xe9sum\xe9 to Alice in HR"; // Latin-1 + py::str py_s = PyUnicode_DecodeLatin1(s.data(), s.length()); + return py_s; + } + ); + +.. code-block:: python + + >>> str_output() + 'Send your résumé to Alice in HR' + +The `Python C API +`_ provides +several built-in codecs. + + +One could also use a third party encoding library such as libiconv to transcode +to UTF-8. + +Return C++ strings without conversion +------------------------------------- + +If the data in a C++ ``std::string`` does not represent text and should be +returned to Python as ``bytes``, then one can return the data as a +``py::bytes`` object. + +.. code-block:: c++ + + m.def("return_bytes", + []() { + std::string s("\xba\xd0\xba\xd0"); // Not valid UTF-8 + return py::bytes(s); // Return the data without transcoding + } + ); + +.. code-block:: python + + >>> example.return_bytes() + b'\xba\xd0\xba\xd0' + + +Note the asymmetry: pybind11 will convert ``bytes`` to ``std::string`` without +encoding, but cannot convert ``std::string`` back to ``bytes`` implicitly. + +.. code-block:: c++ + + m.def("asymmetry", + [](std::string s) { // Accepts str or bytes from Python + return s; // Looks harmless, but implicitly converts to str + } + ); + +.. code-block:: python + + >>> isinstance(example.asymmetry(b"have some bytes"), str) + True + + >>> example.asymmetry(b"\xba\xd0\xba\xd0") # invalid utf-8 as bytes + UnicodeDecodeError: 'utf-8' codec can't decode byte 0xba in position 0: invalid start byte + + +Wide character strings +====================== + +When a Python ``str`` is passed to a C++ function expecting ``std::wstring``, +``wchar_t*``, ``std::u16string`` or ``std::u32string``, the ``str`` will be +encoded to UTF-16 or UTF-32 depending on how the C++ compiler implements each +type, in the platform's native endianness. When strings of these types are +returned, they are assumed to contain valid UTF-16 or UTF-32, and will be +decoded to Python ``str``. + +.. code-block:: c++ + + #define UNICODE + #include + + m.def("set_window_text", + [](HWND hwnd, std::wstring s) { + // Call SetWindowText with null-terminated UTF-16 string + ::SetWindowText(hwnd, s.c_str()); + } + ); + m.def("get_window_text", + [](HWND hwnd) { + const int buffer_size = ::GetWindowTextLength(hwnd) + 1; + auto buffer = std::make_unique< wchar_t[] >(buffer_size); + + ::GetWindowText(hwnd, buffer.data(), buffer_size); + + std::wstring text(buffer.get()); + + // wstring will be converted to Python str + return text; + } + ); + +.. warning:: + + Wide character strings may not work as described on Python 2.7 or Python + 3.3 compiled with ``--enable-unicode=ucs2``. + +Strings in multibyte encodings such as Shift-JIS must transcoded to a +UTF-8/16/32 before being returned to Python. + + +Character literals +================== + +C++ functions that accept character literals as input will receive the first +character of a Python ``str`` as their input. If the string is longer than one +Unicode character, trailing characters will be ignored. + +When a character literal is returned from C++ (such as a ``char`` or a +``wchar_t``), it will be converted to a ``str`` that represents the single +character. + +.. code-block:: c++ + + m.def("pass_char", [](char c) { return c; }); + m.def("pass_wchar", [](wchar_t w) { return w; }); + +.. code-block:: python + + >>> example.pass_char('A') + 'A' + +While C++ will cast integers to character types (``char c = 0x65;``), pybind11 +does not convert Python integers to characters implicitly. The Python function +``chr()`` can be used to convert integers to characters. + +.. code-block:: python + + >>> example.pass_char(0x65) + TypeError + + >>> example.pass_char(chr(0x65)) + 'A' + +If the desire is to work with an 8-bit integer, use ``int8_t`` or ``uint8_t`` +as the argument type. + +Grapheme clusters +----------------- + +A single grapheme may be represented by two or more Unicode characters. For +example 'é' is usually represented as U+00E9 but can also be expressed as the +combining character sequence U+0065 U+0301 (that is, the letter 'e' followed by +a combining acute accent). The combining character will be lost if the +two-character sequence is passed as an argument, even though it renders as a +single grapheme. + +.. code-block:: python + + >>> example.pass_wchar('é') + 'é' + + >>> combining_e_acute = 'e' + '\u0301' + + >>> combining_e_acute + 'é' + + >>> combining_e_acute == 'é' + False + + >>> example.pass_wchar(combining_e_acute) + 'e' + +Normalizing combining characters before passing the character literal to C++ +may resolve *some* of these issues: + +.. code-block:: python + + >>> example.pass_wchar(unicodedata.normalize('NFC', combining_e_acute)) + 'é' + +In some languages (Thai for example), there are `graphemes that cannot be +expressed as a single Unicode code point +`_, so there is +no way to capture them in a C++ character type. + + +C++17 string views +================== + +C++17 string views are automatically supported when compiling in C++17 mode. +They follow the same rules for encoding and decoding as the corresponding STL +string type (for example, a ``std::u16string_view`` argument will be passed +UTF-16-encoded data, and a returned ``std::string_view`` will be decoded as +UTF-8). + +References +========== + +* `The Absolute Minimum Every Software Developer Absolutely, Positively Must Know About Unicode and Character Sets (No Excuses!) `_ +* `C++ - Using STL Strings at Win32 API Boundaries `_ diff --git a/plugins/python/pybind11/docs/advanced/classes.rst b/plugins/python/pybind11/docs/advanced/classes.rst new file mode 100644 index 0000000..93deeec --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/classes.rst @@ -0,0 +1,1001 @@ +Classes +####### + +This section presents advanced binding code for classes and it is assumed +that you are already familiar with the basics from :doc:`/classes`. + +.. _overriding_virtuals: + +Overriding virtual functions in Python +====================================== + +Suppose that a C++ class or interface has a virtual function that we'd like to +to override from within Python (we'll focus on the class ``Animal``; ``Dog`` is +given as a specific example of how one would do this with traditional C++ +code). + +.. code-block:: cpp + + class Animal { + public: + virtual ~Animal() { } + virtual std::string go(int n_times) = 0; + }; + + class Dog : public Animal { + public: + std::string go(int n_times) override { + std::string result; + for (int i=0; igo(3); + } + +Normally, the binding code for these classes would look as follows: + +.. code-block:: cpp + + PYBIND11_MODULE(example, m) { + py::class_ animal(m, "Animal"); + animal + .def("go", &Animal::go); + + py::class_(m, "Dog", animal) + .def(py::init<>()); + + m.def("call_go", &call_go); + } + +However, these bindings are impossible to extend: ``Animal`` is not +constructible, and we clearly require some kind of "trampoline" that +redirects virtual calls back to Python. + +Defining a new type of ``Animal`` from within Python is possible but requires a +helper class that is defined as follows: + +.. code-block:: cpp + + class PyAnimal : public Animal { + public: + /* Inherit the constructors */ + using Animal::Animal; + + /* Trampoline (need one for each virtual function) */ + std::string go(int n_times) override { + PYBIND11_OVERLOAD_PURE( + std::string, /* Return type */ + Animal, /* Parent class */ + go, /* Name of function in C++ (must match Python name) */ + n_times /* Argument(s) */ + ); + } + }; + +The macro :func:`PYBIND11_OVERLOAD_PURE` should be used for pure virtual +functions, and :func:`PYBIND11_OVERLOAD` should be used for functions which have +a default implementation. There are also two alternate macros +:func:`PYBIND11_OVERLOAD_PURE_NAME` and :func:`PYBIND11_OVERLOAD_NAME` which +take a string-valued name argument between the *Parent class* and *Name of the +function* slots, which defines the name of function in Python. This is required +when the C++ and Python versions of the +function have different names, e.g. ``operator()`` vs ``__call__``. + +The binding code also needs a few minor adaptations (highlighted): + +.. code-block:: cpp + :emphasize-lines: 2,4,5 + + PYBIND11_MODULE(example, m) { + py::class_ animal(m, "Animal"); + animal + .def(py::init<>()) + .def("go", &Animal::go); + + py::class_(m, "Dog", animal) + .def(py::init<>()); + + m.def("call_go", &call_go); + } + +Importantly, pybind11 is made aware of the trampoline helper class by +specifying it as an extra template argument to :class:`class_`. (This can also +be combined with other template arguments such as a custom holder type; the +order of template types does not matter). Following this, we are able to +define a constructor as usual. + +Bindings should be made against the actual class, not the trampoline helper class. + +.. code-block:: cpp + + py::class_ animal(m, "Animal"); + animal + .def(py::init<>()) + .def("go", &PyAnimal::go); /* <--- THIS IS WRONG, use &Animal::go */ + +Note, however, that the above is sufficient for allowing python classes to +extend ``Animal``, but not ``Dog``: see :ref:`virtual_and_inheritance` for the +necessary steps required to providing proper overload support for inherited +classes. + +The Python session below shows how to override ``Animal::go`` and invoke it via +a virtual method call. + +.. code-block:: pycon + + >>> from example import * + >>> d = Dog() + >>> call_go(d) + u'woof! woof! woof! ' + >>> class Cat(Animal): + ... def go(self, n_times): + ... return "meow! " * n_times + ... + >>> c = Cat() + >>> call_go(c) + u'meow! meow! meow! ' + +If you are defining a custom constructor in a derived Python class, you *must* +ensure that you explicitly call the bound C++ constructor using ``__init__``, +*regardless* of whether it is a default constructor or not. Otherwise, the +memory for the C++ portion of the instance will be left uninitialized, which +will generally leave the C++ instance in an invalid state and cause undefined +behavior if the C++ instance is subsequently used. + +Here is an example: + +.. code-block:: python + + class Dachschund(Dog): + def __init__(self, name): + Dog.__init__(self) # Without this, undefind behavior may occur if the C++ portions are referenced. + self.name = name + def bark(self): + return "yap!" + +Note that a direct ``__init__`` constructor *should be called*, and ``super()`` +should not be used. For simple cases of linear inheritance, ``super()`` +may work, but once you begin mixing Python and C++ multiple inheritance, +things will fall apart due to differences between Python's MRO and C++'s +mechanisms. + +Please take a look at the :ref:`macro_notes` before using this feature. + +.. note:: + + When the overridden type returns a reference or pointer to a type that + pybind11 converts from Python (for example, numeric values, std::string, + and other built-in value-converting types), there are some limitations to + be aware of: + + - because in these cases there is no C++ variable to reference (the value + is stored in the referenced Python variable), pybind11 provides one in + the PYBIND11_OVERLOAD macros (when needed) with static storage duration. + Note that this means that invoking the overloaded method on *any* + instance will change the referenced value stored in *all* instances of + that type. + + - Attempts to modify a non-const reference will not have the desired + effect: it will change only the static cache variable, but this change + will not propagate to underlying Python instance, and the change will be + replaced the next time the overload is invoked. + +.. seealso:: + + The file :file:`tests/test_virtual_functions.cpp` contains a complete + example that demonstrates how to override virtual functions using pybind11 + in more detail. + +.. _virtual_and_inheritance: + +Combining virtual functions and inheritance +=========================================== + +When combining virtual methods with inheritance, you need to be sure to provide +an override for each method for which you want to allow overrides from derived +python classes. For example, suppose we extend the above ``Animal``/``Dog`` +example as follows: + +.. code-block:: cpp + + class Animal { + public: + virtual std::string go(int n_times) = 0; + virtual std::string name() { return "unknown"; } + }; + class Dog : public Animal { + public: + std::string go(int n_times) override { + std::string result; + for (int i=0; i class PyAnimal : public AnimalBase { + public: + using AnimalBase::AnimalBase; // Inherit constructors + std::string go(int n_times) override { PYBIND11_OVERLOAD_PURE(std::string, AnimalBase, go, n_times); } + std::string name() override { PYBIND11_OVERLOAD(std::string, AnimalBase, name, ); } + }; + template class PyDog : public PyAnimal { + public: + using PyAnimal::PyAnimal; // Inherit constructors + // Override PyAnimal's pure virtual go() with a non-pure one: + std::string go(int n_times) override { PYBIND11_OVERLOAD(std::string, DogBase, go, n_times); } + std::string bark() override { PYBIND11_OVERLOAD(std::string, DogBase, bark, ); } + }; + +This technique has the advantage of requiring just one trampoline method to be +declared per virtual method and pure virtual method override. It does, +however, require the compiler to generate at least as many methods (and +possibly more, if both pure virtual and overridden pure virtual methods are +exposed, as above). + +The classes are then registered with pybind11 using: + +.. code-block:: cpp + + py::class_> animal(m, "Animal"); + py::class_> dog(m, "Dog"); + py::class_> husky(m, "Husky"); + // ... add animal, dog, husky definitions + +Note that ``Husky`` did not require a dedicated trampoline template class at +all, since it neither declares any new virtual methods nor provides any pure +virtual method implementations. + +With either the repeated-virtuals or templated trampoline methods in place, you +can now create a python class that inherits from ``Dog``: + +.. code-block:: python + + class ShihTzu(Dog): + def bark(self): + return "yip!" + +.. seealso:: + + See the file :file:`tests/test_virtual_functions.cpp` for complete examples + using both the duplication and templated trampoline approaches. + +.. _extended_aliases: + +Extended trampoline class functionality +======================================= + +The trampoline classes described in the previous sections are, by default, only +initialized when needed. More specifically, they are initialized when a python +class actually inherits from a registered type (instead of merely creating an +instance of the registered type), or when a registered constructor is only +valid for the trampoline class but not the registered class. This is primarily +for performance reasons: when the trampoline class is not needed for anything +except virtual method dispatching, not initializing the trampoline class +improves performance by avoiding needing to do a run-time check to see if the +inheriting python instance has an overloaded method. + +Sometimes, however, it is useful to always initialize a trampoline class as an +intermediate class that does more than just handle virtual method dispatching. +For example, such a class might perform extra class initialization, extra +destruction operations, and might define new members and methods to enable a +more python-like interface to a class. + +In order to tell pybind11 that it should *always* initialize the trampoline +class when creating new instances of a type, the class constructors should be +declared using ``py::init_alias()`` instead of the usual +``py::init()``. This forces construction via the trampoline class, +ensuring member initialization and (eventual) destruction. + +.. seealso:: + + See the file :file:`tests/test_virtual_functions.cpp` for complete examples + showing both normal and forced trampoline instantiation. + +.. _custom_constructors: + +Custom constructors +=================== + +The syntax for binding constructors was previously introduced, but it only +works when a constructor of the appropriate arguments actually exists on the +C++ side. To extend this to more general cases, pybind11 makes it possible +to bind factory functions as constructors. For example, suppose you have a +class like this: + +.. code-block:: cpp + + class Example { + private: + Example(int); // private constructor + public: + // Factory function: + static Example create(int a) { return Example(a); } + }; + + py::class_(m, "Example") + .def(py::init(&Example::create)); + +While it is possible to create a straightforward binding of the static +``create`` method, it may sometimes be preferable to expose it as a constructor +on the Python side. This can be accomplished by calling ``.def(py::init(...))`` +with the function reference returning the new instance passed as an argument. +It is also possible to use this approach to bind a function returning a new +instance by raw pointer or by the holder (e.g. ``std::unique_ptr``). + +The following example shows the different approaches: + +.. code-block:: cpp + + class Example { + private: + Example(int); // private constructor + public: + // Factory function - returned by value: + static Example create(int a) { return Example(a); } + + // These constructors are publicly callable: + Example(double); + Example(int, int); + Example(std::string); + }; + + py::class_(m, "Example") + // Bind the factory function as a constructor: + .def(py::init(&Example::create)) + // Bind a lambda function returning a pointer wrapped in a holder: + .def(py::init([](std::string arg) { + return std::unique_ptr(new Example(arg)); + })) + // Return a raw pointer: + .def(py::init([](int a, int b) { return new Example(a, b); })) + // You can mix the above with regular C++ constructor bindings as well: + .def(py::init()) + ; + +When the constructor is invoked from Python, pybind11 will call the factory +function and store the resulting C++ instance in the Python instance. + +When combining factory functions constructors with :ref:`virtual function +trampolines ` there are two approaches. The first is to +add a constructor to the alias class that takes a base value by +rvalue-reference. If such a constructor is available, it will be used to +construct an alias instance from the value returned by the factory function. +The second option is to provide two factory functions to ``py::init()``: the +first will be invoked when no alias class is required (i.e. when the class is +being used but not inherited from in Python), and the second will be invoked +when an alias is required. + +You can also specify a single factory function that always returns an alias +instance: this will result in behaviour similar to ``py::init_alias<...>()``, +as described in the :ref:`extended trampoline class documentation +`. + +The following example shows the different factory approaches for a class with +an alias: + +.. code-block:: cpp + + #include + class Example { + public: + // ... + virtual ~Example() = default; + }; + class PyExample : public Example { + public: + using Example::Example; + PyExample(Example &&base) : Example(std::move(base)) {} + }; + py::class_(m, "Example") + // Returns an Example pointer. If a PyExample is needed, the Example + // instance will be moved via the extra constructor in PyExample, above. + .def(py::init([]() { return new Example(); })) + // Two callbacks: + .def(py::init([]() { return new Example(); } /* no alias needed */, + []() { return new PyExample(); } /* alias needed */)) + // *Always* returns an alias instance (like py::init_alias<>()) + .def(py::init([]() { return new PyExample(); })) + ; + +Brace initialization +-------------------- + +``pybind11::init<>`` internally uses C++11 brace initialization to call the +constructor of the target class. This means that it can be used to bind +*implicit* constructors as well: + +.. code-block:: cpp + + struct Aggregate { + int a; + std::string b; + }; + + py::class_(m, "Aggregate") + .def(py::init()); + +.. note:: + + Note that brace initialization preferentially invokes constructor overloads + taking a ``std::initializer_list``. In the rare event that this causes an + issue, you can work around it by using ``py::init(...)`` with a lambda + function that constructs the new object as desired. + +.. _classes_with_non_public_destructors: + +Non-public destructors +====================== + +If a class has a private or protected destructor (as might e.g. be the case in +a singleton pattern), a compile error will occur when creating bindings via +pybind11. The underlying issue is that the ``std::unique_ptr`` holder type that +is responsible for managing the lifetime of instances will reference the +destructor even if no deallocations ever take place. In order to expose classes +with private or protected destructors, it is possible to override the holder +type via a holder type argument to ``class_``. Pybind11 provides a helper class +``py::nodelete`` that disables any destructor invocations. In this case, it is +crucial that instances are deallocated on the C++ side to avoid memory leaks. + +.. code-block:: cpp + + /* ... definition ... */ + + class MyClass { + private: + ~MyClass() { } + }; + + /* ... binding code ... */ + + py::class_>(m, "MyClass") + .def(py::init<>()) + +.. _implicit_conversions: + +Implicit conversions +==================== + +Suppose that instances of two types ``A`` and ``B`` are used in a project, and +that an ``A`` can easily be converted into an instance of type ``B`` (examples of this +could be a fixed and an arbitrary precision number type). + +.. code-block:: cpp + + py::class_(m, "A") + /// ... members ... + + py::class_(m, "B") + .def(py::init()) + /// ... members ... + + m.def("func", + [](const B &) { /* .... */ } + ); + +To invoke the function ``func`` using a variable ``a`` containing an ``A`` +instance, we'd have to write ``func(B(a))`` in Python. On the other hand, C++ +will automatically apply an implicit type conversion, which makes it possible +to directly write ``func(a)``. + +In this situation (i.e. where ``B`` has a constructor that converts from +``A``), the following statement enables similar implicit conversions on the +Python side: + +.. code-block:: cpp + + py::implicitly_convertible(); + +.. note:: + + Implicit conversions from ``A`` to ``B`` only work when ``B`` is a custom + data type that is exposed to Python via pybind11. + + To prevent runaway recursion, implicit conversions are non-reentrant: an + implicit conversion invoked as part of another implicit conversion of the + same type (i.e. from ``A`` to ``B``) will fail. + +.. _static_properties: + +Static properties +================= + +The section on :ref:`properties` discussed the creation of instance properties +that are implemented in terms of C++ getters and setters. + +Static properties can also be created in a similar way to expose getters and +setters of static class attributes. Note that the implicit ``self`` argument +also exists in this case and is used to pass the Python ``type`` subclass +instance. This parameter will often not be needed by the C++ side, and the +following example illustrates how to instantiate a lambda getter function +that ignores it: + +.. code-block:: cpp + + py::class_(m, "Foo") + .def_property_readonly_static("foo", [](py::object /* self */) { return Foo(); }); + +Operator overloading +==================== + +Suppose that we're given the following ``Vector2`` class with a vector addition +and scalar multiplication operation, all implemented using overloaded operators +in C++. + +.. code-block:: cpp + + class Vector2 { + public: + Vector2(float x, float y) : x(x), y(y) { } + + Vector2 operator+(const Vector2 &v) const { return Vector2(x + v.x, y + v.y); } + Vector2 operator*(float value) const { return Vector2(x * value, y * value); } + Vector2& operator+=(const Vector2 &v) { x += v.x; y += v.y; return *this; } + Vector2& operator*=(float v) { x *= v; y *= v; return *this; } + + friend Vector2 operator*(float f, const Vector2 &v) { + return Vector2(f * v.x, f * v.y); + } + + std::string toString() const { + return "[" + std::to_string(x) + ", " + std::to_string(y) + "]"; + } + private: + float x, y; + }; + +The following snippet shows how the above operators can be conveniently exposed +to Python. + +.. code-block:: cpp + + #include + + PYBIND11_MODULE(example, m) { + py::class_(m, "Vector2") + .def(py::init()) + .def(py::self + py::self) + .def(py::self += py::self) + .def(py::self *= float()) + .def(float() * py::self) + .def(py::self * float()) + .def("__repr__", &Vector2::toString); + } + +Note that a line like + +.. code-block:: cpp + + .def(py::self * float()) + +is really just short hand notation for + +.. code-block:: cpp + + .def("__mul__", [](const Vector2 &a, float b) { + return a * b; + }, py::is_operator()) + +This can be useful for exposing additional operators that don't exist on the +C++ side, or to perform other types of customization. The ``py::is_operator`` +flag marker is needed to inform pybind11 that this is an operator, which +returns ``NotImplemented`` when invoked with incompatible arguments rather than +throwing a type error. + +.. note:: + + To use the more convenient ``py::self`` notation, the additional + header file :file:`pybind11/operators.h` must be included. + +.. seealso:: + + The file :file:`tests/test_operator_overloading.cpp` contains a + complete example that demonstrates how to work with overloaded operators in + more detail. + +.. _pickling: + +Pickling support +================ + +Python's ``pickle`` module provides a powerful facility to serialize and +de-serialize a Python object graph into a binary data stream. To pickle and +unpickle C++ classes using pybind11, a ``py::pickle()`` definition must be +provided. Suppose the class in question has the following signature: + +.. code-block:: cpp + + class Pickleable { + public: + Pickleable(const std::string &value) : m_value(value) { } + const std::string &value() const { return m_value; } + + void setExtra(int extra) { m_extra = extra; } + int extra() const { return m_extra; } + private: + std::string m_value; + int m_extra = 0; + }; + +Pickling support in Python is enabled by defining the ``__setstate__`` and +``__getstate__`` methods [#f3]_. For pybind11 classes, use ``py::pickle()`` +to bind these two functions: + +.. code-block:: cpp + + py::class_(m, "Pickleable") + .def(py::init()) + .def("value", &Pickleable::value) + .def("extra", &Pickleable::extra) + .def("setExtra", &Pickleable::setExtra) + .def(py::pickle( + [](const Pickleable &p) { // __getstate__ + /* Return a tuple that fully encodes the state of the object */ + return py::make_tuple(p.value(), p.extra()); + }, + [](py::tuple t) { // __setstate__ + if (t.size() != 2) + throw std::runtime_error("Invalid state!"); + + /* Create a new C++ instance */ + Pickleable p(t[0].cast()); + + /* Assign any additional state */ + p.setExtra(t[1].cast()); + + return p; + } + )); + +The ``__setstate__`` part of the ``py::picke()`` definition follows the same +rules as the single-argument version of ``py::init()``. The return type can be +a value, pointer or holder type. See :ref:`custom_constructors` for details. + +An instance can now be pickled as follows: + +.. code-block:: python + + try: + import cPickle as pickle # Use cPickle on Python 2.7 + except ImportError: + import pickle + + p = Pickleable("test_value") + p.setExtra(15) + data = pickle.dumps(p, 2) + +Note that only the cPickle module is supported on Python 2.7. The second +argument to ``dumps`` is also crucial: it selects the pickle protocol version +2, since the older version 1 is not supported. Newer versions are also fine—for +instance, specify ``-1`` to always use the latest available version. Beware: +failure to follow these instructions will cause important pybind11 memory +allocation routines to be skipped during unpickling, which will likely lead to +memory corruption and/or segmentation faults. + +.. seealso:: + + The file :file:`tests/test_pickling.cpp` contains a complete example + that demonstrates how to pickle and unpickle types using pybind11 in more + detail. + +.. [#f3] http://docs.python.org/3/library/pickle.html#pickling-class-instances + +Multiple Inheritance +==================== + +pybind11 can create bindings for types that derive from multiple base types +(aka. *multiple inheritance*). To do so, specify all bases in the template +arguments of the ``class_`` declaration: + +.. code-block:: cpp + + py::class_(m, "MyType") + ... + +The base types can be specified in arbitrary order, and they can even be +interspersed with alias types and holder types (discussed earlier in this +document)---pybind11 will automatically find out which is which. The only +requirement is that the first template argument is the type to be declared. + +It is also permitted to inherit multiply from exported C++ classes in Python, +as well as inheriting from multiple Python and/or pybind-exported classes. + +There is one caveat regarding the implementation of this feature: + +When only one base type is specified for a C++ type that actually has multiple +bases, pybind11 will assume that it does not participate in multiple +inheritance, which can lead to undefined behavior. In such cases, add the tag +``multiple_inheritance`` to the class constructor: + +.. code-block:: cpp + + py::class_(m, "MyType", py::multiple_inheritance()); + +The tag is redundant and does not need to be specified when multiple base types +are listed. + +.. _module_local: + +Module-local class bindings +=========================== + +When creating a binding for a class, pybind by default makes that binding +"global" across modules. What this means is that a type defined in one module +can be returned from any module resulting in the same Python type. For +example, this allows the following: + +.. code-block:: cpp + + // In the module1.cpp binding code for module1: + py::class_(m, "Pet") + .def(py::init()) + .def_readonly("name", &Pet::name); + +.. code-block:: cpp + + // In the module2.cpp binding code for module2: + m.def("create_pet", [](std::string name) { return new Pet(name); }); + +.. code-block:: pycon + + >>> from module1 import Pet + >>> from module2 import create_pet + >>> pet1 = Pet("Kitty") + >>> pet2 = create_pet("Doggy") + >>> pet2.name() + 'Doggy' + +When writing binding code for a library, this is usually desirable: this +allows, for example, splitting up a complex library into multiple Python +modules. + +In some cases, however, this can cause conflicts. For example, suppose two +unrelated modules make use of an external C++ library and each provide custom +bindings for one of that library's classes. This will result in an error when +a Python program attempts to import both modules (directly or indirectly) +because of conflicting definitions on the external type: + +.. code-block:: cpp + + // dogs.cpp + + // Binding for external library class: + py::class(m, "Pet") + .def("name", &pets::Pet::name); + + // Binding for local extension class: + py::class(m, "Dog") + .def(py::init()); + +.. code-block:: cpp + + // cats.cpp, in a completely separate project from the above dogs.cpp. + + // Binding for external library class: + py::class(m, "Pet") + .def("get_name", &pets::Pet::name); + + // Binding for local extending class: + py::class(m, "Cat") + .def(py::init()); + +.. code-block:: pycon + + >>> import cats + >>> import dogs + Traceback (most recent call last): + File "", line 1, in + ImportError: generic_type: type "Pet" is already registered! + +To get around this, you can tell pybind11 to keep the external class binding +localized to the module by passing the ``py::module_local()`` attribute into +the ``py::class_`` constructor: + +.. code-block:: cpp + + // Pet binding in dogs.cpp: + py::class(m, "Pet", py::module_local()) + .def("name", &pets::Pet::name); + +.. code-block:: cpp + + // Pet binding in cats.cpp: + py::class(m, "Pet", py::module_local()) + .def("get_name", &pets::Pet::name); + +This makes the Python-side ``dogs.Pet`` and ``cats.Pet`` into distinct classes, +avoiding the conflict and allowing both modules to be loaded. C++ code in the +``dogs`` module that casts or returns a ``Pet`` instance will result in a +``dogs.Pet`` Python instance, while C++ code in the ``cats`` module will result +in a ``cats.Pet`` Python instance. + +This does come with two caveats, however: First, external modules cannot return +or cast a ``Pet`` instance to Python (unless they also provide their own local +bindings). Second, from the Python point of view they are two distinct classes. + +Note that the locality only applies in the C++ -> Python direction. When +passing such a ``py::module_local`` type into a C++ function, the module-local +classes are still considered. This means that if the following function is +added to any module (including but not limited to the ``cats`` and ``dogs`` +modules above) it will be callable with either a ``dogs.Pet`` or ``cats.Pet`` +argument: + +.. code-block:: cpp + + m.def("pet_name", [](const pets::Pet &pet) { return pet.name(); }); + +For example, suppose the above function is added to each of ``cats.cpp``, +``dogs.cpp`` and ``frogs.cpp`` (where ``frogs.cpp`` is some other module that +does *not* bind ``Pets`` at all). + +.. code-block:: pycon + + >>> import cats, dogs, frogs # No error because of the added py::module_local() + >>> mycat, mydog = cats.Cat("Fluffy"), dogs.Dog("Rover") + >>> (cats.pet_name(mycat), dogs.pet_name(mydog)) + ('Fluffy', 'Rover') + >>> (cats.pet_name(mydog), dogs.pet_name(mycat), frogs.pet_name(mycat)) + ('Rover', 'Fluffy', 'Fluffy') + +It is possible to use ``py::module_local()`` registrations in one module even +if another module registers the same type globally: within the module with the +module-local definition, all C++ instances will be cast to the associated bound +Python type. In other modules any such values are converted to the global +Python type created elsewhere. + +.. note:: + + STL bindings (as provided via the optional :file:`pybind11/stl_bind.h` + header) apply ``py::module_local`` by default when the bound type might + conflict with other modules; see :ref:`stl_bind` for details. + +.. note:: + + The localization of the bound types is actually tied to the shared object + or binary generated by the compiler/linker. For typical modules created + with ``PYBIND11_MODULE()``, this distinction is not significant. It is + possible, however, when :ref:`embedding` to embed multiple modules in the + same binary (see :ref:`embedding_modules`). In such a case, the + localization will apply across all embedded modules within the same binary. + +.. seealso:: + + The file :file:`tests/test_local_bindings.cpp` contains additional examples + that demonstrate how ``py::module_local()`` works. + +Binding protected member functions +================================== + +It's normally not possible to expose ``protected`` member functions to Python: + +.. code-block:: cpp + + class A { + protected: + int foo() const { return 42; } + }; + + py::class_(m, "A") + .def("foo", &A::foo); // error: 'foo' is a protected member of 'A' + +On one hand, this is good because non-``public`` members aren't meant to be +accessed from the outside. But we may want to make use of ``protected`` +functions in derived Python classes. + +The following pattern makes this possible: + +.. code-block:: cpp + + class A { + protected: + int foo() const { return 42; } + }; + + class Publicist : public A { // helper type for exposing protected functions + public: + using A::foo; // inherited with different access modifier + }; + + py::class_(m, "A") // bind the primary class + .def("foo", &Publicist::foo); // expose protected methods via the publicist + +This works because ``&Publicist::foo`` is exactly the same function as +``&A::foo`` (same signature and address), just with a different access +modifier. The only purpose of the ``Publicist`` helper class is to make +the function name ``public``. + +If the intent is to expose ``protected`` ``virtual`` functions which can be +overridden in Python, the publicist pattern can be combined with the previously +described trampoline: + +.. code-block:: cpp + + class A { + public: + virtual ~A() = default; + + protected: + virtual int foo() const { return 42; } + }; + + class Trampoline : public A { + public: + int foo() const override { PYBIND11_OVERLOAD(int, A, foo, ); } + }; + + class Publicist : public A { + public: + using A::foo; + }; + + py::class_(m, "A") // <-- `Trampoline` here + .def("foo", &Publicist::foo); // <-- `Publicist` here, not `Trampoline`! + +.. note:: + + MSVC 2015 has a compiler bug (fixed in version 2017) which + requires a more explicit function binding in the form of + ``.def("foo", static_cast(&Publicist::foo));`` + where ``int (A::*)() const`` is the type of ``A::foo``. diff --git a/plugins/python/pybind11/docs/advanced/embedding.rst b/plugins/python/pybind11/docs/advanced/embedding.rst new file mode 100644 index 0000000..3930316 --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/embedding.rst @@ -0,0 +1,261 @@ +.. _embedding: + +Embedding the interpreter +######################### + +While pybind11 is mainly focused on extending Python using C++, it's also +possible to do the reverse: embed the Python interpreter into a C++ program. +All of the other documentation pages still apply here, so refer to them for +general pybind11 usage. This section will cover a few extra things required +for embedding. + +Getting started +=============== + +A basic executable with an embedded interpreter can be created with just a few +lines of CMake and the ``pybind11::embed`` target, as shown below. For more +information, see :doc:`/compiling`. + +.. code-block:: cmake + + cmake_minimum_required(VERSION 3.0) + project(example) + + find_package(pybind11 REQUIRED) # or `add_subdirectory(pybind11)` + + add_executable(example main.cpp) + target_link_libraries(example PRIVATE pybind11::embed) + +The essential structure of the ``main.cpp`` file looks like this: + +.. code-block:: cpp + + #include // everything needed for embedding + namespace py = pybind11; + + int main() { + py::scoped_interpreter guard{}; // start the interpreter and keep it alive + + py::print("Hello, World!"); // use the Python API + } + +The interpreter must be initialized before using any Python API, which includes +all the functions and classes in pybind11. The RAII guard class `scoped_interpreter` +takes care of the interpreter lifetime. After the guard is destroyed, the interpreter +shuts down and clears its memory. No Python functions can be called after this. + +Executing Python code +===================== + +There are a few different ways to run Python code. One option is to use `eval`, +`exec` or `eval_file`, as explained in :ref:`eval`. Here is a quick example in +the context of an executable with an embedded interpreter: + +.. code-block:: cpp + + #include + namespace py = pybind11; + + int main() { + py::scoped_interpreter guard{}; + + py::exec(R"( + kwargs = dict(name="World", number=42) + message = "Hello, {name}! The answer is {number}".format(**kwargs) + print(message) + )"); + } + +Alternatively, similar results can be achieved using pybind11's API (see +:doc:`/advanced/pycpp/index` for more details). + +.. code-block:: cpp + + #include + namespace py = pybind11; + using namespace py::literals; + + int main() { + py::scoped_interpreter guard{}; + + auto kwargs = py::dict("name"_a="World", "number"_a=42); + auto message = "Hello, {name}! The answer is {number}"_s.format(**kwargs); + py::print(message); + } + +The two approaches can also be combined: + +.. code-block:: cpp + + #include + #include + + namespace py = pybind11; + using namespace py::literals; + + int main() { + py::scoped_interpreter guard{}; + + auto locals = py::dict("name"_a="World", "number"_a=42); + py::exec(R"( + message = "Hello, {name}! The answer is {number}".format(**locals()) + )", py::globals(), locals); + + auto message = locals["message"].cast(); + std::cout << message; + } + +Importing modules +================= + +Python modules can be imported using `module::import()`: + +.. code-block:: cpp + + py::module sys = py::module::import("sys"); + py::print(sys.attr("path")); + +For convenience, the current working directory is included in ``sys.path`` when +embedding the interpreter. This makes it easy to import local Python files: + +.. code-block:: python + + """calc.py located in the working directory""" + + def add(i, j): + return i + j + + +.. code-block:: cpp + + py::module calc = py::module::import("calc"); + py::object result = calc.attr("add")(1, 2); + int n = result.cast(); + assert(n == 3); + +Modules can be reloaded using `module::reload()` if the source is modified e.g. +by an external process. This can be useful in scenarios where the application +imports a user defined data processing script which needs to be updated after +changes by the user. Note that this function does not reload modules recursively. + +.. _embedding_modules: + +Adding embedded modules +======================= + +Embedded binary modules can be added using the `PYBIND11_EMBEDDED_MODULE` macro. +Note that the definition must be placed at global scope. They can be imported +like any other module. + +.. code-block:: cpp + + #include + namespace py = pybind11; + + PYBIND11_EMBEDDED_MODULE(fast_calc, m) { + // `m` is a `py::module` which is used to bind functions and classes + m.def("add", [](int i, int j) { + return i + j; + }); + } + + int main() { + py::scoped_interpreter guard{}; + + auto fast_calc = py::module::import("fast_calc"); + auto result = fast_calc.attr("add")(1, 2).cast(); + assert(result == 3); + } + +Unlike extension modules where only a single binary module can be created, on +the embedded side an unlimited number of modules can be added using multiple +`PYBIND11_EMBEDDED_MODULE` definitions (as long as they have unique names). + +These modules are added to Python's list of builtins, so they can also be +imported in pure Python files loaded by the interpreter. Everything interacts +naturally: + +.. code-block:: python + + """py_module.py located in the working directory""" + import cpp_module + + a = cpp_module.a + b = a + 1 + + +.. code-block:: cpp + + #include + namespace py = pybind11; + + PYBIND11_EMBEDDED_MODULE(cpp_module, m) { + m.attr("a") = 1; + } + + int main() { + py::scoped_interpreter guard{}; + + auto py_module = py::module::import("py_module"); + + auto locals = py::dict("fmt"_a="{} + {} = {}", **py_module.attr("__dict__")); + assert(locals["a"].cast() == 1); + assert(locals["b"].cast() == 2); + + py::exec(R"( + c = a + b + message = fmt.format(a, b, c) + )", py::globals(), locals); + + assert(locals["c"].cast() == 3); + assert(locals["message"].cast() == "1 + 2 = 3"); + } + + +Interpreter lifetime +==================== + +The Python interpreter shuts down when `scoped_interpreter` is destroyed. After +this, creating a new instance will restart the interpreter. Alternatively, the +`initialize_interpreter` / `finalize_interpreter` pair of functions can be used +to directly set the state at any time. + +Modules created with pybind11 can be safely re-initialized after the interpreter +has been restarted. However, this may not apply to third-party extension modules. +The issue is that Python itself cannot completely unload extension modules and +there are several caveats with regard to interpreter restarting. In short, not +all memory may be freed, either due to Python reference cycles or user-created +global data. All the details can be found in the CPython documentation. + +.. warning:: + + Creating two concurrent `scoped_interpreter` guards is a fatal error. So is + calling `initialize_interpreter` for a second time after the interpreter + has already been initialized. + + Do not use the raw CPython API functions ``Py_Initialize`` and + ``Py_Finalize`` as these do not properly handle the lifetime of + pybind11's internal data. + + +Sub-interpreter support +======================= + +Creating multiple copies of `scoped_interpreter` is not possible because it +represents the main Python interpreter. Sub-interpreters are something different +and they do permit the existence of multiple interpreters. This is an advanced +feature of the CPython API and should be handled with care. pybind11 does not +currently offer a C++ interface for sub-interpreters, so refer to the CPython +documentation for all the details regarding this feature. + +We'll just mention a couple of caveats the sub-interpreters support in pybind11: + + 1. Sub-interpreters will not receive independent copies of embedded modules. + Instead, these are shared and modifications in one interpreter may be + reflected in another. + + 2. Managing multiple threads, multiple interpreters and the GIL can be + challenging and there are several caveats here, even within the pure + CPython API (please refer to the Python docs for details). As for + pybind11, keep in mind that `gil_scoped_release` and `gil_scoped_acquire` + do not take sub-interpreters into account. diff --git a/plugins/python/pybind11/docs/advanced/exceptions.rst b/plugins/python/pybind11/docs/advanced/exceptions.rst new file mode 100644 index 0000000..3122c37 --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/exceptions.rst @@ -0,0 +1,142 @@ +Exceptions +########## + +Built-in exception translation +============================== + +When C++ code invoked from Python throws an ``std::exception``, it is +automatically converted into a Python ``Exception``. pybind11 defines multiple +special exception classes that will map to different types of Python +exceptions: + +.. tabularcolumns:: |p{0.5\textwidth}|p{0.45\textwidth}| + ++--------------------------------------+------------------------------+ +| C++ exception type | Python exception type | ++======================================+==============================+ +| :class:`std::exception` | ``RuntimeError`` | ++--------------------------------------+------------------------------+ +| :class:`std::bad_alloc` | ``MemoryError`` | ++--------------------------------------+------------------------------+ +| :class:`std::domain_error` | ``ValueError`` | ++--------------------------------------+------------------------------+ +| :class:`std::invalid_argument` | ``ValueError`` | ++--------------------------------------+------------------------------+ +| :class:`std::length_error` | ``ValueError`` | ++--------------------------------------+------------------------------+ +| :class:`std::out_of_range` | ``ValueError`` | ++--------------------------------------+------------------------------+ +| :class:`std::range_error` | ``ValueError`` | ++--------------------------------------+------------------------------+ +| :class:`pybind11::stop_iteration` | ``StopIteration`` (used to | +| | implement custom iterators) | ++--------------------------------------+------------------------------+ +| :class:`pybind11::index_error` | ``IndexError`` (used to | +| | indicate out of bounds | +| | accesses in ``__getitem__``, | +| | ``__setitem__``, etc.) | ++--------------------------------------+------------------------------+ +| :class:`pybind11::value_error` | ``ValueError`` (used to | +| | indicate wrong value passed | +| | in ``container.remove(...)`` | ++--------------------------------------+------------------------------+ +| :class:`pybind11::key_error` | ``KeyError`` (used to | +| | indicate out of bounds | +| | accesses in ``__getitem__``, | +| | ``__setitem__`` in dict-like | +| | objects, etc.) | ++--------------------------------------+------------------------------+ +| :class:`pybind11::error_already_set` | Indicates that the Python | +| | exception flag has already | +| | been initialized | ++--------------------------------------+------------------------------+ + +When a Python function invoked from C++ throws an exception, it is converted +into a C++ exception of type :class:`error_already_set` whose string payload +contains a textual summary. + +There is also a special exception :class:`cast_error` that is thrown by +:func:`handle::call` when the input arguments cannot be converted to Python +objects. + +Registering custom translators +============================== + +If the default exception conversion policy described above is insufficient, +pybind11 also provides support for registering custom exception translators. +To register a simple exception conversion that translates a C++ exception into +a new Python exception using the C++ exception's ``what()`` method, a helper +function is available: + +.. code-block:: cpp + + py::register_exception(module, "PyExp"); + +This call creates a Python exception class with the name ``PyExp`` in the given +module and automatically converts any encountered exceptions of type ``CppExp`` +into Python exceptions of type ``PyExp``. + +When more advanced exception translation is needed, the function +``py::register_exception_translator(translator)`` can be used to register +functions that can translate arbitrary exception types (and which may include +additional logic to do so). The function takes a stateless callable (e.g. a +function pointer or a lambda function without captured variables) with the call +signature ``void(std::exception_ptr)``. + +When a C++ exception is thrown, the registered exception translators are tried +in reverse order of registration (i.e. the last registered translator gets the +first shot at handling the exception). + +Inside the translator, ``std::rethrow_exception`` should be used within +a try block to re-throw the exception. One or more catch clauses to catch +the appropriate exceptions should then be used with each clause using +``PyErr_SetString`` to set a Python exception or ``ex(string)`` to set +the python exception to a custom exception type (see below). + +To declare a custom Python exception type, declare a ``py::exception`` variable +and use this in the associated exception translator (note: it is often useful +to make this a static declaration when using it inside a lambda expression +without requiring capturing). + + +The following example demonstrates this for a hypothetical exception classes +``MyCustomException`` and ``OtherException``: the first is translated to a +custom python exception ``MyCustomError``, while the second is translated to a +standard python RuntimeError: + +.. code-block:: cpp + + static py::exception exc(m, "MyCustomError"); + py::register_exception_translator([](std::exception_ptr p) { + try { + if (p) std::rethrow_exception(p); + } catch (const MyCustomException &e) { + exc(e.what()); + } catch (const OtherException &e) { + PyErr_SetString(PyExc_RuntimeError, e.what()); + } + }); + +Multiple exceptions can be handled by a single translator, as shown in the +example above. If the exception is not caught by the current translator, the +previously registered one gets a chance. + +If none of the registered exception translators is able to handle the +exception, it is handled by the default converter as described in the previous +section. + +.. seealso:: + + The file :file:`tests/test_exceptions.cpp` contains examples + of various custom exception translators and custom exception types. + +.. note:: + + You must call either ``PyErr_SetString`` or a custom exception's call + operator (``exc(string)``) for every exception caught in a custom exception + translator. Failure to do so will cause Python to crash with ``SystemError: + error return without exception set``. + + Exceptions that you do not plan to handle should simply not be caught, or + may be explicitly (re-)thrown to delegate it to the other, + previously-declared existing exception translators. diff --git a/plugins/python/pybind11/docs/advanced/functions.rst b/plugins/python/pybind11/docs/advanced/functions.rst new file mode 100644 index 0000000..e3acff0 --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/functions.rst @@ -0,0 +1,498 @@ +Functions +######### + +Before proceeding with this section, make sure that you are already familiar +with the basics of binding functions and classes, as explained in :doc:`/basics` +and :doc:`/classes`. The following guide is applicable to both free and member +functions, i.e. *methods* in Python. + +.. _return_value_policies: + +Return value policies +===================== + +Python and C++ use fundamentally different ways of managing the memory and +lifetime of objects managed by them. This can lead to issues when creating +bindings for functions that return a non-trivial type. Just by looking at the +type information, it is not clear whether Python should take charge of the +returned value and eventually free its resources, or if this is handled on the +C++ side. For this reason, pybind11 provides a several *return value policy* +annotations that can be passed to the :func:`module::def` and +:func:`class_::def` functions. The default policy is +:enum:`return_value_policy::automatic`. + +Return value policies are tricky, and it's very important to get them right. +Just to illustrate what can go wrong, consider the following simple example: + +.. code-block:: cpp + + /* Function declaration */ + Data *get_data() { return _data; /* (pointer to a static data structure) */ } + ... + + /* Binding code */ + m.def("get_data", &get_data); // <-- KABOOM, will cause crash when called from Python + +What's going on here? When ``get_data()`` is called from Python, the return +value (a native C++ type) must be wrapped to turn it into a usable Python type. +In this case, the default return value policy (:enum:`return_value_policy::automatic`) +causes pybind11 to assume ownership of the static ``_data`` instance. + +When Python's garbage collector eventually deletes the Python +wrapper, pybind11 will also attempt to delete the C++ instance (via ``operator +delete()``) due to the implied ownership. At this point, the entire application +will come crashing down, though errors could also be more subtle and involve +silent data corruption. + +In the above example, the policy :enum:`return_value_policy::reference` should have +been specified so that the global data instance is only *referenced* without any +implied transfer of ownership, i.e.: + +.. code-block:: cpp + + m.def("get_data", &get_data, return_value_policy::reference); + +On the other hand, this is not the right policy for many other situations, +where ignoring ownership could lead to resource leaks. +As a developer using pybind11, it's important to be familiar with the different +return value policies, including which situation calls for which one of them. +The following table provides an overview of available policies: + +.. tabularcolumns:: |p{0.5\textwidth}|p{0.45\textwidth}| + ++--------------------------------------------------+----------------------------------------------------------------------------+ +| Return value policy | Description | ++==================================================+============================================================================+ +| :enum:`return_value_policy::take_ownership` | Reference an existing object (i.e. do not create a new copy) and take | +| | ownership. Python will call the destructor and delete operator when the | +| | object's reference count reaches zero. Undefined behavior ensues when the | +| | C++ side does the same, or when the data was not dynamically allocated. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::copy` | Create a new copy of the returned object, which will be owned by Python. | +| | This policy is comparably safe because the lifetimes of the two instances | +| | are decoupled. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::move` | Use ``std::move`` to move the return value contents into a new instance | +| | that will be owned by Python. This policy is comparably safe because the | +| | lifetimes of the two instances (move source and destination) are decoupled.| ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::reference` | Reference an existing object, but do not take ownership. The C++ side is | +| | responsible for managing the object's lifetime and deallocating it when | +| | it is no longer used. Warning: undefined behavior will ensue when the C++ | +| | side deletes an object that is still referenced and used by Python. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::reference_internal` | Indicates that the lifetime of the return value is tied to the lifetime | +| | of a parent object, namely the implicit ``this``, or ``self`` argument of | +| | the called method or property. Internally, this policy works just like | +| | :enum:`return_value_policy::reference` but additionally applies a | +| | ``keep_alive<0, 1>`` *call policy* (described in the next section) that | +| | prevents the parent object from being garbage collected as long as the | +| | return value is referenced by Python. This is the default policy for | +| | property getters created via ``def_property``, ``def_readwrite``, etc. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::automatic` | **Default policy.** This policy falls back to the policy | +| | :enum:`return_value_policy::take_ownership` when the return value is a | +| | pointer. Otherwise, it uses :enum:`return_value_policy::move` or | +| | :enum:`return_value_policy::copy` for rvalue and lvalue references, | +| | respectively. See above for a description of what all of these different | +| | policies do. | ++--------------------------------------------------+----------------------------------------------------------------------------+ +| :enum:`return_value_policy::automatic_reference` | As above, but use policy :enum:`return_value_policy::reference` when the | +| | return value is a pointer. This is the default conversion policy for | +| | function arguments when calling Python functions manually from C++ code | +| | (i.e. via handle::operator()). You probably won't need to use this. | ++--------------------------------------------------+----------------------------------------------------------------------------+ + +Return value policies can also be applied to properties: + +.. code-block:: cpp + + class_(m, "MyClass") + .def_property("data", &MyClass::getData, &MyClass::setData, + py::return_value_policy::copy); + +Technically, the code above applies the policy to both the getter and the +setter function, however, the setter doesn't really care about *return* +value policies which makes this a convenient terse syntax. Alternatively, +targeted arguments can be passed through the :class:`cpp_function` constructor: + +.. code-block:: cpp + + class_(m, "MyClass") + .def_property("data" + py::cpp_function(&MyClass::getData, py::return_value_policy::copy), + py::cpp_function(&MyClass::setData) + ); + +.. warning:: + + Code with invalid return value policies might access uninitialized memory or + free data structures multiple times, which can lead to hard-to-debug + non-determinism and segmentation faults, hence it is worth spending the + time to understand all the different options in the table above. + +.. note:: + + One important aspect of the above policies is that they only apply to + instances which pybind11 has *not* seen before, in which case the policy + clarifies essential questions about the return value's lifetime and + ownership. When pybind11 knows the instance already (as identified by its + type and address in memory), it will return the existing Python object + wrapper rather than creating a new copy. + +.. note:: + + The next section on :ref:`call_policies` discusses *call policies* that can be + specified *in addition* to a return value policy from the list above. Call + policies indicate reference relationships that can involve both return values + and parameters of functions. + +.. note:: + + As an alternative to elaborate call policies and lifetime management logic, + consider using smart pointers (see the section on :ref:`smart_pointers` for + details). Smart pointers can tell whether an object is still referenced from + C++ or Python, which generally eliminates the kinds of inconsistencies that + can lead to crashes or undefined behavior. For functions returning smart + pointers, it is not necessary to specify a return value policy. + +.. _call_policies: + +Additional call policies +======================== + +In addition to the above return value policies, further *call policies* can be +specified to indicate dependencies between parameters or ensure a certain state +for the function call. + +Keep alive +---------- + +In general, this policy is required when the C++ object is any kind of container +and another object is being added to the container. ``keep_alive`` +indicates that the argument with index ``Patient`` should be kept alive at least +until the argument with index ``Nurse`` is freed by the garbage collector. Argument +indices start at one, while zero refers to the return value. For methods, index +``1`` refers to the implicit ``this`` pointer, while regular arguments begin at +index ``2``. Arbitrarily many call policies can be specified. When a ``Nurse`` +with value ``None`` is detected at runtime, the call policy does nothing. + +When the nurse is not a pybind11-registered type, the implementation internally +relies on the ability to create a *weak reference* to the nurse object. When +the nurse object is not a pybind11-registered type and does not support weak +references, an exception will be thrown. + +Consider the following example: here, the binding code for a list append +operation ties the lifetime of the newly added element to the underlying +container: + +.. code-block:: cpp + + py::class_(m, "List") + .def("append", &List::append, py::keep_alive<1, 2>()); + +For consistency, the argument indexing is identical for constructors. Index +``1`` still refers to the implicit ``this`` pointer, i.e. the object which is +being constructed. Index ``0`` refers to the return type which is presumed to +be ``void`` when a constructor is viewed like a function. The following example +ties the lifetime of the constructor element to the constructed object: + +.. code-block:: cpp + + py::class_(m, "Nurse") + .def(py::init(), py::keep_alive<1, 2>()); + +.. note:: + + ``keep_alive`` is analogous to the ``with_custodian_and_ward`` (if Nurse, + Patient != 0) and ``with_custodian_and_ward_postcall`` (if Nurse/Patient == + 0) policies from Boost.Python. + +Call guard +---------- + +The ``call_guard`` policy allows any scope guard type ``T`` to be placed +around the function call. For example, this definition: + +.. code-block:: cpp + + m.def("foo", foo, py::call_guard()); + +is equivalent to the following pseudocode: + +.. code-block:: cpp + + m.def("foo", [](args...) { + T scope_guard; + return foo(args...); // forwarded arguments + }); + +The only requirement is that ``T`` is default-constructible, but otherwise any +scope guard will work. This is very useful in combination with `gil_scoped_release`. +See :ref:`gil`. + +Multiple guards can also be specified as ``py::call_guard``. The +constructor order is left to right and destruction happens in reverse. + +.. seealso:: + + The file :file:`tests/test_call_policies.cpp` contains a complete example + that demonstrates using `keep_alive` and `call_guard` in more detail. + +.. _python_objects_as_args: + +Python objects as arguments +=========================== + +pybind11 exposes all major Python types using thin C++ wrapper classes. These +wrapper classes can also be used as parameters of functions in bindings, which +makes it possible to directly work with native Python types on the C++ side. +For instance, the following statement iterates over a Python ``dict``: + +.. code-block:: cpp + + void print_dict(py::dict dict) { + /* Easily interact with Python types */ + for (auto item : dict) + std::cout << "key=" << std::string(py::str(item.first)) << ", " + << "value=" << std::string(py::str(item.second)) << std::endl; + } + +It can be exported: + +.. code-block:: cpp + + m.def("print_dict", &print_dict); + +And used in Python as usual: + +.. code-block:: pycon + + >>> print_dict({'foo': 123, 'bar': 'hello'}) + key=foo, value=123 + key=bar, value=hello + +For more information on using Python objects in C++, see :doc:`/advanced/pycpp/index`. + +Accepting \*args and \*\*kwargs +=============================== + +Python provides a useful mechanism to define functions that accept arbitrary +numbers of arguments and keyword arguments: + +.. code-block:: python + + def generic(*args, **kwargs): + ... # do something with args and kwargs + +Such functions can also be created using pybind11: + +.. code-block:: cpp + + void generic(py::args args, py::kwargs kwargs) { + /// .. do something with args + if (kwargs) + /// .. do something with kwargs + } + + /// Binding code + m.def("generic", &generic); + +The class ``py::args`` derives from ``py::tuple`` and ``py::kwargs`` derives +from ``py::dict``. + +You may also use just one or the other, and may combine these with other +arguments as long as the ``py::args`` and ``py::kwargs`` arguments are the last +arguments accepted by the function. + +Please refer to the other examples for details on how to iterate over these, +and on how to cast their entries into C++ objects. A demonstration is also +available in ``tests/test_kwargs_and_defaults.cpp``. + +.. note:: + + When combining \*args or \*\*kwargs with :ref:`keyword_args` you should + *not* include ``py::arg`` tags for the ``py::args`` and ``py::kwargs`` + arguments. + +Default arguments revisited +=========================== + +The section on :ref:`default_args` previously discussed basic usage of default +arguments using pybind11. One noteworthy aspect of their implementation is that +default arguments are converted to Python objects right at declaration time. +Consider the following example: + +.. code-block:: cpp + + py::class_("MyClass") + .def("myFunction", py::arg("arg") = SomeType(123)); + +In this case, pybind11 must already be set up to deal with values of the type +``SomeType`` (via a prior instantiation of ``py::class_``), or an +exception will be thrown. + +Another aspect worth highlighting is that the "preview" of the default argument +in the function signature is generated using the object's ``__repr__`` method. +If not available, the signature may not be very helpful, e.g.: + +.. code-block:: pycon + + FUNCTIONS + ... + | myFunction(...) + | Signature : (MyClass, arg : SomeType = ) -> NoneType + ... + +The first way of addressing this is by defining ``SomeType.__repr__``. +Alternatively, it is possible to specify the human-readable preview of the +default argument manually using the ``arg_v`` notation: + +.. code-block:: cpp + + py::class_("MyClass") + .def("myFunction", py::arg_v("arg", SomeType(123), "SomeType(123)")); + +Sometimes it may be necessary to pass a null pointer value as a default +argument. In this case, remember to cast it to the underlying type in question, +like so: + +.. code-block:: cpp + + py::class_("MyClass") + .def("myFunction", py::arg("arg") = (SomeType *) nullptr); + +.. _nonconverting_arguments: + +Non-converting arguments +======================== + +Certain argument types may support conversion from one type to another. Some +examples of conversions are: + +* :ref:`implicit_conversions` declared using ``py::implicitly_convertible()`` +* Calling a method accepting a double with an integer argument +* Calling a ``std::complex`` argument with a non-complex python type + (for example, with a float). (Requires the optional ``pybind11/complex.h`` + header). +* Calling a function taking an Eigen matrix reference with a numpy array of the + wrong type or of an incompatible data layout. (Requires the optional + ``pybind11/eigen.h`` header). + +This behaviour is sometimes undesirable: the binding code may prefer to raise +an error rather than convert the argument. This behaviour can be obtained +through ``py::arg`` by calling the ``.noconvert()`` method of the ``py::arg`` +object, such as: + +.. code-block:: cpp + + m.def("floats_only", [](double f) { return 0.5 * f; }, py::arg("f").noconvert()); + m.def("floats_preferred", [](double f) { return 0.5 * f; }, py::arg("f")); + +Attempting the call the second function (the one without ``.noconvert()``) with +an integer will succeed, but attempting to call the ``.noconvert()`` version +will fail with a ``TypeError``: + +.. code-block:: pycon + + >>> floats_preferred(4) + 2.0 + >>> floats_only(4) + Traceback (most recent call last): + File "", line 1, in + TypeError: floats_only(): incompatible function arguments. The following argument types are supported: + 1. (f: float) -> float + + Invoked with: 4 + +You may, of course, combine this with the :var:`_a` shorthand notation (see +:ref:`keyword_args`) and/or :ref:`default_args`. It is also permitted to omit +the argument name by using the ``py::arg()`` constructor without an argument +name, i.e. by specifying ``py::arg().noconvert()``. + +.. note:: + + When specifying ``py::arg`` options it is necessary to provide the same + number of options as the bound function has arguments. Thus if you want to + enable no-convert behaviour for just one of several arguments, you will + need to specify a ``py::arg()`` annotation for each argument with the + no-convert argument modified to ``py::arg().noconvert()``. + +.. _none_arguments: + +Allow/Prohibiting None arguments +================================ + +When a C++ type registered with :class:`py::class_` is passed as an argument to +a function taking the instance as pointer or shared holder (e.g. ``shared_ptr`` +or a custom, copyable holder as described in :ref:`smart_pointers`), pybind +allows ``None`` to be passed from Python which results in calling the C++ +function with ``nullptr`` (or an empty holder) for the argument. + +To explicitly enable or disable this behaviour, using the +``.none`` method of the :class:`py::arg` object: + +.. code-block:: cpp + + py::class_(m, "Dog").def(py::init<>()); + py::class_(m, "Cat").def(py::init<>()); + m.def("bark", [](Dog *dog) -> std::string { + if (dog) return "woof!"; /* Called with a Dog instance */ + else return "(no dog)"; /* Called with None, d == nullptr */ + }, py::arg("dog").none(true)); + m.def("meow", [](Cat *cat) -> std::string { + // Can't be called with None argument + return "meow"; + }, py::arg("cat").none(false)); + +With the above, the Python call ``bark(None)`` will return the string ``"(no +dog)"``, while attempting to call ``meow(None)`` will raise a ``TypeError``: + +.. code-block:: pycon + + >>> from animals import Dog, Cat, bark, meow + >>> bark(Dog()) + 'woof!' + >>> meow(Cat()) + 'meow' + >>> bark(None) + '(no dog)' + >>> meow(None) + Traceback (most recent call last): + File "", line 1, in + TypeError: meow(): incompatible function arguments. The following argument types are supported: + 1. (cat: animals.Cat) -> str + + Invoked with: None + +The default behaviour when the tag is unspecified is to allow ``None``. + +Overload resolution order +========================= + +When a function or method with multiple overloads is called from Python, +pybind11 determines which overload to call in two passes. The first pass +attempts to call each overload without allowing argument conversion (as if +every argument had been specified as ``py::arg().noconvert()`` as described +above). + +If no overload succeeds in the no-conversion first pass, a second pass is +attempted in which argument conversion is allowed (except where prohibited via +an explicit ``py::arg().noconvert()`` attribute in the function definition). + +If the second pass also fails a ``TypeError`` is raised. + +Within each pass, overloads are tried in the order they were registered with +pybind11. + +What this means in practice is that pybind11 will prefer any overload that does +not require conversion of arguments to an overload that does, but otherwise prefers +earlier-defined overloads to later-defined ones. + +.. note:: + + pybind11 does *not* further prioritize based on the number/pattern of + overloaded arguments. That is, pybind11 does not prioritize a function + requiring one conversion over one requiring three, but only prioritizes + overloads requiring no conversion at all to overloads that require + conversion of at least one argument. diff --git a/plugins/python/pybind11/docs/advanced/misc.rst b/plugins/python/pybind11/docs/advanced/misc.rst new file mode 100644 index 0000000..87481ba --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/misc.rst @@ -0,0 +1,272 @@ +Miscellaneous +############# + +.. _macro_notes: + +General notes regarding convenience macros +========================================== + +pybind11 provides a few convenience macros such as +:func:`PYBIND11_MAKE_OPAQUE` and :func:`PYBIND11_DECLARE_HOLDER_TYPE`, and +``PYBIND11_OVERLOAD_*``. Since these are "just" macros that are evaluated +in the preprocessor (which has no concept of types), they *will* get confused +by commas in a template argument such as ``PYBIND11_OVERLOAD(MyReturnValue, myFunc)``. In this case, the preprocessor assumes that the comma indicates +the beginning of the next parameter. Use a ``typedef`` to bind the template to +another name and use it in the macro to avoid this problem. + +.. _gil: + +Global Interpreter Lock (GIL) +============================= + +When calling a C++ function from Python, the GIL is always held. +The classes :class:`gil_scoped_release` and :class:`gil_scoped_acquire` can be +used to acquire and release the global interpreter lock in the body of a C++ +function call. In this way, long-running C++ code can be parallelized using +multiple Python threads. Taking :ref:`overriding_virtuals` as an example, this +could be realized as follows (important changes highlighted): + +.. code-block:: cpp + :emphasize-lines: 8,9,31,32 + + class PyAnimal : public Animal { + public: + /* Inherit the constructors */ + using Animal::Animal; + + /* Trampoline (need one for each virtual function) */ + std::string go(int n_times) { + /* Acquire GIL before calling Python code */ + py::gil_scoped_acquire acquire; + + PYBIND11_OVERLOAD_PURE( + std::string, /* Return type */ + Animal, /* Parent class */ + go, /* Name of function */ + n_times /* Argument(s) */ + ); + } + }; + + PYBIND11_MODULE(example, m) { + py::class_ animal(m, "Animal"); + animal + .def(py::init<>()) + .def("go", &Animal::go); + + py::class_(m, "Dog", animal) + .def(py::init<>()); + + m.def("call_go", [](Animal *animal) -> std::string { + /* Release GIL before calling into (potentially long-running) C++ code */ + py::gil_scoped_release release; + return call_go(animal); + }); + } + +The ``call_go`` wrapper can also be simplified using the `call_guard` policy +(see :ref:`call_policies`) which yields the same result: + +.. code-block:: cpp + + m.def("call_go", &call_go, py::call_guard()); + + +Binding sequence data types, iterators, the slicing protocol, etc. +================================================================== + +Please refer to the supplemental example for details. + +.. seealso:: + + The file :file:`tests/test_sequences_and_iterators.cpp` contains a + complete example that shows how to bind a sequence data type, including + length queries (``__len__``), iterators (``__iter__``), the slicing + protocol and other kinds of useful operations. + + +Partitioning code over multiple extension modules +================================================= + +It's straightforward to split binding code over multiple extension modules, +while referencing types that are declared elsewhere. Everything "just" works +without any special precautions. One exception to this rule occurs when +extending a type declared in another extension module. Recall the basic example +from Section :ref:`inheritance`. + +.. code-block:: cpp + + py::class_ pet(m, "Pet"); + pet.def(py::init()) + .def_readwrite("name", &Pet::name); + + py::class_(m, "Dog", pet /* <- specify parent */) + .def(py::init()) + .def("bark", &Dog::bark); + +Suppose now that ``Pet`` bindings are defined in a module named ``basic``, +whereas the ``Dog`` bindings are defined somewhere else. The challenge is of +course that the variable ``pet`` is not available anymore though it is needed +to indicate the inheritance relationship to the constructor of ``class_``. +However, it can be acquired as follows: + +.. code-block:: cpp + + py::object pet = (py::object) py::module::import("basic").attr("Pet"); + + py::class_(m, "Dog", pet) + .def(py::init()) + .def("bark", &Dog::bark); + +Alternatively, you can specify the base class as a template parameter option to +``class_``, which performs an automated lookup of the corresponding Python +type. Like the above code, however, this also requires invoking the ``import`` +function once to ensure that the pybind11 binding code of the module ``basic`` +has been executed: + +.. code-block:: cpp + + py::module::import("basic"); + + py::class_(m, "Dog") + .def(py::init()) + .def("bark", &Dog::bark); + +Naturally, both methods will fail when there are cyclic dependencies. + +Note that pybind11 code compiled with hidden-by-default symbol visibility (e.g. +via the command line flag ``-fvisibility=hidden`` on GCC/Clang), which is +required proper pybind11 functionality, can interfere with the ability to +access types defined in another extension module. Working around this requires +manually exporting types that are accessed by multiple extension modules; +pybind11 provides a macro to do just this: + +.. code-block:: cpp + + class PYBIND11_EXPORT Dog : public Animal { + ... + }; + +Note also that it is possible (although would rarely be required) to share arbitrary +C++ objects between extension modules at runtime. Internal library data is shared +between modules using capsule machinery [#f6]_ which can be also utilized for +storing, modifying and accessing user-defined data. Note that an extension module +will "see" other extensions' data if and only if they were built with the same +pybind11 version. Consider the following example: + +.. code-block:: cpp + + auto data = (MyData *) py::get_shared_data("mydata"); + if (!data) + data = (MyData *) py::set_shared_data("mydata", new MyData(42)); + +If the above snippet was used in several separately compiled extension modules, +the first one to be imported would create a ``MyData`` instance and associate +a ``"mydata"`` key with a pointer to it. Extensions that are imported later +would be then able to access the data behind the same pointer. + +.. [#f6] https://docs.python.org/3/extending/extending.html#using-capsules + +Module Destructors +================== + +pybind11 does not provide an explicit mechanism to invoke cleanup code at +module destruction time. In rare cases where such functionality is required, it +is possible to emulate it using Python capsules or weak references with a +destruction callback. + +.. code-block:: cpp + + auto cleanup_callback = []() { + // perform cleanup here -- this function is called with the GIL held + }; + + m.add_object("_cleanup", py::capsule(cleanup_callback)); + +This approach has the potential downside that instances of classes exposed +within the module may still be alive when the cleanup callback is invoked +(whether this is acceptable will generally depend on the application). + +Alternatively, the capsule may also be stashed within a type object, which +ensures that it not called before all instances of that type have been +collected: + +.. code-block:: cpp + + auto cleanup_callback = []() { /* ... */ }; + m.attr("BaseClass").attr("_cleanup") = py::capsule(cleanup_callback); + +Both approaches also expose a potentially dangerous ``_cleanup`` attribute in +Python, which may be undesirable from an API standpoint (a premature explicit +call from Python might lead to undefined behavior). Yet another approach that +avoids this issue involves weak reference with a cleanup callback: + +.. code-block:: cpp + + // Register a callback function that is invoked when the BaseClass object is colelcted + py::cpp_function cleanup_callback( + [](py::handle weakref) { + // perform cleanup here -- this function is called with the GIL held + + weakref.dec_ref(); // release weak reference + } + ); + + // Create a weak reference with a cleanup callback and initially leak it + (void) py::weakref(m.attr("BaseClass"), cleanup_callback).release(); + + +Generating documentation using Sphinx +===================================== + +Sphinx [#f4]_ has the ability to inspect the signatures and documentation +strings in pybind11-based extension modules to automatically generate beautiful +documentation in a variety formats. The python_example repository [#f5]_ contains a +simple example repository which uses this approach. + +There are two potential gotchas when using this approach: first, make sure that +the resulting strings do not contain any :kbd:`TAB` characters, which break the +docstring parsing routines. You may want to use C++11 raw string literals, +which are convenient for multi-line comments. Conveniently, any excess +indentation will be automatically be removed by Sphinx. However, for this to +work, it is important that all lines are indented consistently, i.e.: + +.. code-block:: cpp + + // ok + m.def("foo", &foo, R"mydelimiter( + The foo function + + Parameters + ---------- + )mydelimiter"); + + // *not ok* + m.def("foo", &foo, R"mydelimiter(The foo function + + Parameters + ---------- + )mydelimiter"); + +By default, pybind11 automatically generates and prepends a signature to the docstring of a function +registered with ``module::def()`` and ``class_::def()``. Sometimes this +behavior is not desirable, because you want to provide your own signature or remove +the docstring completely to exclude the function from the Sphinx documentation. +The class ``options`` allows you to selectively suppress auto-generated signatures: + +.. code-block:: cpp + + PYBIND11_MODULE(example, m) { + py::options options; + options.disable_function_signatures(); + + m.def("add", [](int a, int b) { return a + b; }, "A function which adds two numbers"); + } + +Note that changes to the settings affect only function bindings created during the +lifetime of the ``options`` instance. When it goes out of scope at the end of the module's init function, +the default settings are restored to prevent unwanted side effects. + +.. [#f4] http://www.sphinx-doc.org +.. [#f5] http://github.com/pybind/python_example diff --git a/plugins/python/pybind11/docs/advanced/pycpp/index.rst b/plugins/python/pybind11/docs/advanced/pycpp/index.rst new file mode 100644 index 0000000..6885bdc --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/pycpp/index.rst @@ -0,0 +1,13 @@ +Python C++ interface +#################### + +pybind11 exposes Python types and functions using thin C++ wrappers, which +makes it possible to conveniently call Python code from C++ without resorting +to Python's C API. + +.. toctree:: + :maxdepth: 2 + + object + numpy + utilities diff --git a/plugins/python/pybind11/docs/advanced/pycpp/numpy.rst b/plugins/python/pybind11/docs/advanced/pycpp/numpy.rst new file mode 100644 index 0000000..50e5533 --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/pycpp/numpy.rst @@ -0,0 +1,366 @@ +.. _numpy: + +NumPy +##### + +Buffer protocol +=============== + +Python supports an extremely general and convenient approach for exchanging +data between plugin libraries. Types can expose a buffer view [#f2]_, which +provides fast direct access to the raw internal data representation. Suppose we +want to bind the following simplistic Matrix class: + +.. code-block:: cpp + + class Matrix { + public: + Matrix(size_t rows, size_t cols) : m_rows(rows), m_cols(cols) { + m_data = new float[rows*cols]; + } + float *data() { return m_data; } + size_t rows() const { return m_rows; } + size_t cols() const { return m_cols; } + private: + size_t m_rows, m_cols; + float *m_data; + }; + +The following binding code exposes the ``Matrix`` contents as a buffer object, +making it possible to cast Matrices into NumPy arrays. It is even possible to +completely avoid copy operations with Python expressions like +``np.array(matrix_instance, copy = False)``. + +.. code-block:: cpp + + py::class_(m, "Matrix", py::buffer_protocol()) + .def_buffer([](Matrix &m) -> py::buffer_info { + return py::buffer_info( + m.data(), /* Pointer to buffer */ + sizeof(float), /* Size of one scalar */ + py::format_descriptor::format(), /* Python struct-style format descriptor */ + 2, /* Number of dimensions */ + { m.rows(), m.cols() }, /* Buffer dimensions */ + { sizeof(float) * m.rows(), /* Strides (in bytes) for each index */ + sizeof(float) } + ); + }); + +Supporting the buffer protocol in a new type involves specifying the special +``py::buffer_protocol()`` tag in the ``py::class_`` constructor and calling the +``def_buffer()`` method with a lambda function that creates a +``py::buffer_info`` description record on demand describing a given matrix +instance. The contents of ``py::buffer_info`` mirror the Python buffer protocol +specification. + +.. code-block:: cpp + + struct buffer_info { + void *ptr; + ssize_t itemsize; + std::string format; + ssize_t ndim; + std::vector shape; + std::vector strides; + }; + +To create a C++ function that can take a Python buffer object as an argument, +simply use the type ``py::buffer`` as one of its arguments. Buffers can exist +in a great variety of configurations, hence some safety checks are usually +necessary in the function body. Below, you can see an basic example on how to +define a custom constructor for the Eigen double precision matrix +(``Eigen::MatrixXd``) type, which supports initialization from compatible +buffer objects (e.g. a NumPy matrix). + +.. code-block:: cpp + + /* Bind MatrixXd (or some other Eigen type) to Python */ + typedef Eigen::MatrixXd Matrix; + + typedef Matrix::Scalar Scalar; + constexpr bool rowMajor = Matrix::Flags & Eigen::RowMajorBit; + + py::class_(m, "Matrix", py::buffer_protocol()) + .def("__init__", [](Matrix &m, py::buffer b) { + typedef Eigen::Stride Strides; + + /* Request a buffer descriptor from Python */ + py::buffer_info info = b.request(); + + /* Some sanity checks ... */ + if (info.format != py::format_descriptor::format()) + throw std::runtime_error("Incompatible format: expected a double array!"); + + if (info.ndim != 2) + throw std::runtime_error("Incompatible buffer dimension!"); + + auto strides = Strides( + info.strides[rowMajor ? 0 : 1] / (py::ssize_t)sizeof(Scalar), + info.strides[rowMajor ? 1 : 0] / (py::ssize_t)sizeof(Scalar)); + + auto map = Eigen::Map( + static_cast(info.ptr), info.shape[0], info.shape[1], strides); + + new (&m) Matrix(map); + }); + +For reference, the ``def_buffer()`` call for this Eigen data type should look +as follows: + +.. code-block:: cpp + + .def_buffer([](Matrix &m) -> py::buffer_info { + return py::buffer_info( + m.data(), /* Pointer to buffer */ + sizeof(Scalar), /* Size of one scalar */ + py::format_descriptor::format(), /* Python struct-style format descriptor */ + 2, /* Number of dimensions */ + { m.rows(), m.cols() }, /* Buffer dimensions */ + { sizeof(Scalar) * (rowMajor ? m.cols() : 1), + sizeof(Scalar) * (rowMajor ? 1 : m.rows()) } + /* Strides (in bytes) for each index */ + ); + }) + +For a much easier approach of binding Eigen types (although with some +limitations), refer to the section on :doc:`/advanced/cast/eigen`. + +.. seealso:: + + The file :file:`tests/test_buffers.cpp` contains a complete example + that demonstrates using the buffer protocol with pybind11 in more detail. + +.. [#f2] http://docs.python.org/3/c-api/buffer.html + +Arrays +====== + +By exchanging ``py::buffer`` with ``py::array`` in the above snippet, we can +restrict the function so that it only accepts NumPy arrays (rather than any +type of Python object satisfying the buffer protocol). + +In many situations, we want to define a function which only accepts a NumPy +array of a certain data type. This is possible via the ``py::array_t`` +template. For instance, the following function requires the argument to be a +NumPy array containing double precision values. + +.. code-block:: cpp + + void f(py::array_t array); + +When it is invoked with a different type (e.g. an integer or a list of +integers), the binding code will attempt to cast the input into a NumPy array +of the requested type. Note that this feature requires the +:file:`pybind11/numpy.h` header to be included. + +Data in NumPy arrays is not guaranteed to packed in a dense manner; +furthermore, entries can be separated by arbitrary column and row strides. +Sometimes, it can be useful to require a function to only accept dense arrays +using either the C (row-major) or Fortran (column-major) ordering. This can be +accomplished via a second template argument with values ``py::array::c_style`` +or ``py::array::f_style``. + +.. code-block:: cpp + + void f(py::array_t array); + +The ``py::array::forcecast`` argument is the default value of the second +template parameter, and it ensures that non-conforming arguments are converted +into an array satisfying the specified requirements instead of trying the next +function overload. + +Structured types +================ + +In order for ``py::array_t`` to work with structured (record) types, we first +need to register the memory layout of the type. This can be done via +``PYBIND11_NUMPY_DTYPE`` macro, called in the plugin definition code, which +expects the type followed by field names: + +.. code-block:: cpp + + struct A { + int x; + double y; + }; + + struct B { + int z; + A a; + }; + + // ... + PYBIND11_MODULE(test, m) { + // ... + + PYBIND11_NUMPY_DTYPE(A, x, y); + PYBIND11_NUMPY_DTYPE(B, z, a); + /* now both A and B can be used as template arguments to py::array_t */ + } + +The structure should consist of fundamental arithmetic types, ``std::complex``, +previously registered substructures, and arrays of any of the above. Both C++ +arrays and ``std::array`` are supported. While there is a static assertion to +prevent many types of unsupported structures, it is still the user's +responsibility to use only "plain" structures that can be safely manipulated as +raw memory without violating invariants. + +Vectorizing functions +===================== + +Suppose we want to bind a function with the following signature to Python so +that it can process arbitrary NumPy array arguments (vectors, matrices, general +N-D arrays) in addition to its normal arguments: + +.. code-block:: cpp + + double my_func(int x, float y, double z); + +After including the ``pybind11/numpy.h`` header, this is extremely simple: + +.. code-block:: cpp + + m.def("vectorized_func", py::vectorize(my_func)); + +Invoking the function like below causes 4 calls to be made to ``my_func`` with +each of the array elements. The significant advantage of this compared to +solutions like ``numpy.vectorize()`` is that the loop over the elements runs +entirely on the C++ side and can be crunched down into a tight, optimized loop +by the compiler. The result is returned as a NumPy array of type +``numpy.dtype.float64``. + +.. code-block:: pycon + + >>> x = np.array([[1, 3],[5, 7]]) + >>> y = np.array([[2, 4],[6, 8]]) + >>> z = 3 + >>> result = vectorized_func(x, y, z) + +The scalar argument ``z`` is transparently replicated 4 times. The input +arrays ``x`` and ``y`` are automatically converted into the right types (they +are of type ``numpy.dtype.int64`` but need to be ``numpy.dtype.int32`` and +``numpy.dtype.float32``, respectively). + +.. note:: + + Only arithmetic, complex, and POD types passed by value or by ``const &`` + reference are vectorized; all other arguments are passed through as-is. + Functions taking rvalue reference arguments cannot be vectorized. + +In cases where the computation is too complicated to be reduced to +``vectorize``, it will be necessary to create and access the buffer contents +manually. The following snippet contains a complete example that shows how this +works (the code is somewhat contrived, since it could have been done more +simply using ``vectorize``). + +.. code-block:: cpp + + #include + #include + + namespace py = pybind11; + + py::array_t add_arrays(py::array_t input1, py::array_t input2) { + py::buffer_info buf1 = input1.request(), buf2 = input2.request(); + + if (buf1.ndim != 1 || buf2.ndim != 1) + throw std::runtime_error("Number of dimensions must be one"); + + if (buf1.size != buf2.size) + throw std::runtime_error("Input shapes must match"); + + /* No pointer is passed, so NumPy will allocate the buffer */ + auto result = py::array_t(buf1.size); + + py::buffer_info buf3 = result.request(); + + double *ptr1 = (double *) buf1.ptr, + *ptr2 = (double *) buf2.ptr, + *ptr3 = (double *) buf3.ptr; + + for (size_t idx = 0; idx < buf1.shape[0]; idx++) + ptr3[idx] = ptr1[idx] + ptr2[idx]; + + return result; + } + + PYBIND11_MODULE(test, m) { + m.def("add_arrays", &add_arrays, "Add two NumPy arrays"); + } + +.. seealso:: + + The file :file:`tests/test_numpy_vectorize.cpp` contains a complete + example that demonstrates using :func:`vectorize` in more detail. + +Direct access +============= + +For performance reasons, particularly when dealing with very large arrays, it +is often desirable to directly access array elements without internal checking +of dimensions and bounds on every access when indices are known to be already +valid. To avoid such checks, the ``array`` class and ``array_t`` template +class offer an unchecked proxy object that can be used for this unchecked +access through the ``unchecked`` and ``mutable_unchecked`` methods, +where ``N`` gives the required dimensionality of the array: + +.. code-block:: cpp + + m.def("sum_3d", [](py::array_t x) { + auto r = x.unchecked<3>(); // x must have ndim = 3; can be non-writeable + double sum = 0; + for (ssize_t i = 0; i < r.shape(0); i++) + for (ssize_t j = 0; j < r.shape(1); j++) + for (ssize_t k = 0; k < r.shape(2); k++) + sum += r(i, j, k); + return sum; + }); + m.def("increment_3d", [](py::array_t x) { + auto r = x.mutable_unchecked<3>(); // Will throw if ndim != 3 or flags.writeable is false + for (ssize_t i = 0; i < r.shape(0); i++) + for (ssize_t j = 0; j < r.shape(1); j++) + for (ssize_t k = 0; k < r.shape(2); k++) + r(i, j, k) += 1.0; + }, py::arg().noconvert()); + +To obtain the proxy from an ``array`` object, you must specify both the data +type and number of dimensions as template arguments, such as ``auto r = +myarray.mutable_unchecked()``. + +If the number of dimensions is not known at compile time, you can omit the +dimensions template parameter (i.e. calling ``arr_t.unchecked()`` or +``arr.unchecked()``. This will give you a proxy object that works in the +same way, but results in less optimizable code and thus a small efficiency +loss in tight loops. + +Note that the returned proxy object directly references the array's data, and +only reads its shape, strides, and writeable flag when constructed. You must +take care to ensure that the referenced array is not destroyed or reshaped for +the duration of the returned object, typically by limiting the scope of the +returned instance. + +The returned proxy object supports some of the same methods as ``py::array`` so +that it can be used as a drop-in replacement for some existing, index-checked +uses of ``py::array``: + +- ``r.ndim()`` returns the number of dimensions + +- ``r.data(1, 2, ...)`` and ``r.mutable_data(1, 2, ...)``` returns a pointer to + the ``const T`` or ``T`` data, respectively, at the given indices. The + latter is only available to proxies obtained via ``a.mutable_unchecked()``. + +- ``itemsize()`` returns the size of an item in bytes, i.e. ``sizeof(T)``. + +- ``ndim()`` returns the number of dimensions. + +- ``shape(n)`` returns the size of dimension ``n`` + +- ``size()`` returns the total number of elements (i.e. the product of the shapes). + +- ``nbytes()`` returns the number of bytes used by the referenced elements + (i.e. ``itemsize()`` times ``size()``). + +.. seealso:: + + The file :file:`tests/test_numpy_array.cpp` contains additional examples + demonstrating the use of this feature. diff --git a/plugins/python/pybind11/docs/advanced/pycpp/object.rst b/plugins/python/pybind11/docs/advanced/pycpp/object.rst new file mode 100644 index 0000000..117131e --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/pycpp/object.rst @@ -0,0 +1,170 @@ +Python types +############ + +Available wrappers +================== + +All major Python types are available as thin C++ wrapper classes. These +can also be used as function parameters -- see :ref:`python_objects_as_args`. + +Available types include :class:`handle`, :class:`object`, :class:`bool_`, +:class:`int_`, :class:`float_`, :class:`str`, :class:`bytes`, :class:`tuple`, +:class:`list`, :class:`dict`, :class:`slice`, :class:`none`, :class:`capsule`, +:class:`iterable`, :class:`iterator`, :class:`function`, :class:`buffer`, +:class:`array`, and :class:`array_t`. + +Casting back and forth +====================== + +In this kind of mixed code, it is often necessary to convert arbitrary C++ +types to Python, which can be done using :func:`py::cast`: + +.. code-block:: cpp + + MyClass *cls = ..; + py::object obj = py::cast(cls); + +The reverse direction uses the following syntax: + +.. code-block:: cpp + + py::object obj = ...; + MyClass *cls = obj.cast(); + +When conversion fails, both directions throw the exception :class:`cast_error`. + +.. _python_libs: + +Accessing Python libraries from C++ +=================================== + +It is also possible to import objects defined in the Python standard +library or available in the current Python environment (``sys.path``) and work +with these in C++. + +This example obtains a reference to the Python ``Decimal`` class. + +.. code-block:: cpp + + // Equivalent to "from decimal import Decimal" + py::object Decimal = py::module::import("decimal").attr("Decimal"); + +.. code-block:: cpp + + // Try to import scipy + py::object scipy = py::module::import("scipy"); + return scipy.attr("__version__"); + +.. _calling_python_functions: + +Calling Python functions +======================== + +It is also possible to call Python classes, functions and methods +via ``operator()``. + +.. code-block:: cpp + + // Construct a Python object of class Decimal + py::object pi = Decimal("3.14159"); + +.. code-block:: cpp + + // Use Python to make our directories + py::object os = py::module::import("os"); + py::object makedirs = os.attr("makedirs"); + makedirs("/tmp/path/to/somewhere"); + +One can convert the result obtained from Python to a pure C++ version +if a ``py::class_`` or type conversion is defined. + +.. code-block:: cpp + + py::function f = <...>; + py::object result_py = f(1234, "hello", some_instance); + MyClass &result = result_py.cast(); + +.. _calling_python_methods: + +Calling Python methods +======================== + +To call an object's method, one can again use ``.attr`` to obtain access to the +Python method. + +.. code-block:: cpp + + // Calculate e^π in decimal + py::object exp_pi = pi.attr("exp")(); + py::print(py::str(exp_pi)); + +In the example above ``pi.attr("exp")`` is a *bound method*: it will always call +the method for that same instance of the class. Alternately one can create an +*unbound method* via the Python class (instead of instance) and pass the ``self`` +object explicitly, followed by other arguments. + +.. code-block:: cpp + + py::object decimal_exp = Decimal.attr("exp"); + + // Compute the e^n for n=0..4 + for (int n = 0; n < 5; n++) { + py::print(decimal_exp(Decimal(n)); + } + +Keyword arguments +================= + +Keyword arguments are also supported. In Python, there is the usual call syntax: + +.. code-block:: python + + def f(number, say, to): + ... # function code + + f(1234, say="hello", to=some_instance) # keyword call in Python + +In C++, the same call can be made using: + +.. code-block:: cpp + + using namespace pybind11::literals; // to bring in the `_a` literal + f(1234, "say"_a="hello", "to"_a=some_instance); // keyword call in C++ + +Unpacking arguments +=================== + +Unpacking of ``*args`` and ``**kwargs`` is also possible and can be mixed with +other arguments: + +.. code-block:: cpp + + // * unpacking + py::tuple args = py::make_tuple(1234, "hello", some_instance); + f(*args); + + // ** unpacking + py::dict kwargs = py::dict("number"_a=1234, "say"_a="hello", "to"_a=some_instance); + f(**kwargs); + + // mixed keywords, * and ** unpacking + py::tuple args = py::make_tuple(1234); + py::dict kwargs = py::dict("to"_a=some_instance); + f(*args, "say"_a="hello", **kwargs); + +Generalized unpacking according to PEP448_ is also supported: + +.. code-block:: cpp + + py::dict kwargs1 = py::dict("number"_a=1234); + py::dict kwargs2 = py::dict("to"_a=some_instance); + f(**kwargs1, "say"_a="hello", **kwargs2); + +.. seealso:: + + The file :file:`tests/test_pytypes.cpp` contains a complete + example that demonstrates passing native Python types in more detail. The + file :file:`tests/test_callbacks.cpp` presents a few examples of calling + Python functions from C++, including keywords arguments and unpacking. + +.. _PEP448: https://www.python.org/dev/peps/pep-0448/ diff --git a/plugins/python/pybind11/docs/advanced/pycpp/utilities.rst b/plugins/python/pybind11/docs/advanced/pycpp/utilities.rst new file mode 100644 index 0000000..369e7c9 --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/pycpp/utilities.rst @@ -0,0 +1,144 @@ +Utilities +######### + +Using Python's print function in C++ +==================================== + +The usual way to write output in C++ is using ``std::cout`` while in Python one +would use ``print``. Since these methods use different buffers, mixing them can +lead to output order issues. To resolve this, pybind11 modules can use the +:func:`py::print` function which writes to Python's ``sys.stdout`` for consistency. + +Python's ``print`` function is replicated in the C++ API including optional +keyword arguments ``sep``, ``end``, ``file``, ``flush``. Everything works as +expected in Python: + +.. code-block:: cpp + + py::print(1, 2.0, "three"); // 1 2.0 three + py::print(1, 2.0, "three", "sep"_a="-"); // 1-2.0-three + + auto args = py::make_tuple("unpacked", true); + py::print("->", *args, "end"_a="<-"); // -> unpacked True <- + +.. _ostream_redirect: + +Capturing standard output from ostream +====================================== + +Often, a library will use the streams ``std::cout`` and ``std::cerr`` to print, +but this does not play well with Python's standard ``sys.stdout`` and ``sys.stderr`` +redirection. Replacing a library's printing with `py::print ` may not +be feasible. This can be fixed using a guard around the library function that +redirects output to the corresponding Python streams: + +.. code-block:: cpp + + #include + + ... + + // Add a scoped redirect for your noisy code + m.def("noisy_func", []() { + py::scoped_ostream_redirect stream( + std::cout, // std::ostream& + py::module::import("sys").attr("stdout") // Python output + ); + call_noisy_func(); + }); + +This method respects flushes on the output streams and will flush if needed +when the scoped guard is destroyed. This allows the output to be redirected in +real time, such as to a Jupyter notebook. The two arguments, the C++ stream and +the Python output, are optional, and default to standard output if not given. An +extra type, `py::scoped_estream_redirect `, is identical +except for defaulting to ``std::cerr`` and ``sys.stderr``; this can be useful with +`py::call_guard`, which allows multiple items, but uses the default constructor: + +.. code-block:: py + + // Alternative: Call single function using call guard + m.def("noisy_func", &call_noisy_function, + py::call_guard()); + +The redirection can also be done in Python with the addition of a context +manager, using the `py::add_ostream_redirect() ` function: + +.. code-block:: cpp + + py::add_ostream_redirect(m, "ostream_redirect"); + +The name in Python defaults to ``ostream_redirect`` if no name is passed. This +creates the following context manager in Python: + +.. code-block:: python + + with ostream_redirect(stdout=True, stderr=True): + noisy_function() + +It defaults to redirecting both streams, though you can use the keyword +arguments to disable one of the streams if needed. + +.. note:: + + The above methods will not redirect C-level output to file descriptors, such + as ``fprintf``. For those cases, you'll need to redirect the file + descriptors either directly in C or with Python's ``os.dup2`` function + in an operating-system dependent way. + +.. _eval: + +Evaluating Python expressions from strings and files +==================================================== + +pybind11 provides the `eval`, `exec` and `eval_file` functions to evaluate +Python expressions and statements. The following example illustrates how they +can be used. + +.. code-block:: cpp + + // At beginning of file + #include + + ... + + // Evaluate in scope of main module + py::object scope = py::module::import("__main__").attr("__dict__"); + + // Evaluate an isolated expression + int result = py::eval("my_variable + 10", scope).cast(); + + // Evaluate a sequence of statements + py::exec( + "print('Hello')\n" + "print('world!');", + scope); + + // Evaluate the statements in an separate Python file on disk + py::eval_file("script.py", scope); + +C++11 raw string literals are also supported and quite handy for this purpose. +The only requirement is that the first statement must be on a new line following +the raw string delimiter ``R"(``, ensuring all lines have common leading indent: + +.. code-block:: cpp + + py::exec(R"( + x = get_answer() + if x == 42: + print('Hello World!') + else: + print('Bye!') + )", scope + ); + +.. note:: + + `eval` and `eval_file` accept a template parameter that describes how the + string/file should be interpreted. Possible choices include ``eval_expr`` + (isolated expression), ``eval_single_statement`` (a single statement, return + value is always ``none``), and ``eval_statements`` (sequence of statements, + return value is always ``none``). `eval` defaults to ``eval_expr``, + `eval_file` defaults to ``eval_statements`` and `exec` is just a shortcut + for ``eval``. diff --git a/plugins/python/pybind11/docs/advanced/smart_ptrs.rst b/plugins/python/pybind11/docs/advanced/smart_ptrs.rst new file mode 100644 index 0000000..da57748 --- /dev/null +++ b/plugins/python/pybind11/docs/advanced/smart_ptrs.rst @@ -0,0 +1,173 @@ +Smart pointers +############## + +std::unique_ptr +=============== + +Given a class ``Example`` with Python bindings, it's possible to return +instances wrapped in C++11 unique pointers, like so + +.. code-block:: cpp + + std::unique_ptr create_example() { return std::unique_ptr(new Example()); } + +.. code-block:: cpp + + m.def("create_example", &create_example); + +In other words, there is nothing special that needs to be done. While returning +unique pointers in this way is allowed, it is *illegal* to use them as function +arguments. For instance, the following function signature cannot be processed +by pybind11. + +.. code-block:: cpp + + void do_something_with_example(std::unique_ptr ex) { ... } + +The above signature would imply that Python needs to give up ownership of an +object that is passed to this function, which is generally not possible (for +instance, the object might be referenced elsewhere). + +std::shared_ptr +=============== + +The binding generator for classes, :class:`class_`, can be passed a template +type that denotes a special *holder* type that is used to manage references to +the object. If no such holder type template argument is given, the default for +a type named ``Type`` is ``std::unique_ptr``, which means that the object +is deallocated when Python's reference count goes to zero. + +It is possible to switch to other types of reference counting wrappers or smart +pointers, which is useful in codebases that rely on them. For instance, the +following snippet causes ``std::shared_ptr`` to be used instead. + +.. code-block:: cpp + + py::class_ /* <- holder type */> obj(m, "Example"); + +Note that any particular class can only be associated with a single holder type. + +One potential stumbling block when using holder types is that they need to be +applied consistently. Can you guess what's broken about the following binding +code? + +.. code-block:: cpp + + class Child { }; + + class Parent { + public: + Parent() : child(std::make_shared()) { } + Child *get_child() { return child.get(); } /* Hint: ** DON'T DO THIS ** */ + private: + std::shared_ptr child; + }; + + PYBIND11_MODULE(example, m) { + py::class_>(m, "Child"); + + py::class_>(m, "Parent") + .def(py::init<>()) + .def("get_child", &Parent::get_child); + } + +The following Python code will cause undefined behavior (and likely a +segmentation fault). + +.. code-block:: python + + from example import Parent + print(Parent().get_child()) + +The problem is that ``Parent::get_child()`` returns a pointer to an instance of +``Child``, but the fact that this instance is already managed by +``std::shared_ptr<...>`` is lost when passing raw pointers. In this case, +pybind11 will create a second independent ``std::shared_ptr<...>`` that also +claims ownership of the pointer. In the end, the object will be freed **twice** +since these shared pointers have no way of knowing about each other. + +There are two ways to resolve this issue: + +1. For types that are managed by a smart pointer class, never use raw pointers + in function arguments or return values. In other words: always consistently + wrap pointers into their designated holder types (such as + ``std::shared_ptr<...>``). In this case, the signature of ``get_child()`` + should be modified as follows: + +.. code-block:: cpp + + std::shared_ptr get_child() { return child; } + +2. Adjust the definition of ``Child`` by specifying + ``std::enable_shared_from_this`` (see cppreference_ for details) as a + base class. This adds a small bit of information to ``Child`` that allows + pybind11 to realize that there is already an existing + ``std::shared_ptr<...>`` and communicate with it. In this case, the + declaration of ``Child`` should look as follows: + +.. _cppreference: http://en.cppreference.com/w/cpp/memory/enable_shared_from_this + +.. code-block:: cpp + + class Child : public std::enable_shared_from_this { }; + +.. _smart_pointers: + +Custom smart pointers +===================== + +pybind11 supports ``std::unique_ptr`` and ``std::shared_ptr`` right out of the +box. For any other custom smart pointer, transparent conversions can be enabled +using a macro invocation similar to the following. It must be declared at the +top namespace level before any binding code: + +.. code-block:: cpp + + PYBIND11_DECLARE_HOLDER_TYPE(T, SmartPtr); + +The first argument of :func:`PYBIND11_DECLARE_HOLDER_TYPE` should be a +placeholder name that is used as a template parameter of the second argument. +Thus, feel free to use any identifier, but use it consistently on both sides; +also, don't use the name of a type that already exists in your codebase. + +The macro also accepts a third optional boolean parameter that is set to false +by default. Specify + +.. code-block:: cpp + + PYBIND11_DECLARE_HOLDER_TYPE(T, SmartPtr, true); + +if ``SmartPtr`` can always be initialized from a ``T*`` pointer without the +risk of inconsistencies (such as multiple independent ``SmartPtr`` instances +believing that they are the sole owner of the ``T*`` pointer). A common +situation where ``true`` should be passed is when the ``T`` instances use +*intrusive* reference counting. + +Please take a look at the :ref:`macro_notes` before using this feature. + +By default, pybind11 assumes that your custom smart pointer has a standard +interface, i.e. provides a ``.get()`` member function to access the underlying +raw pointer. If this is not the case, pybind11's ``holder_helper`` must be +specialized: + +.. code-block:: cpp + + // Always needed for custom holder types + PYBIND11_DECLARE_HOLDER_TYPE(T, SmartPtr); + + // Only needed if the type's `.get()` goes by another name + namespace pybind11 { namespace detail { + template + struct holder_helper> { // <-- specialization + static const T *get(const SmartPtr &p) { return p.getPointer(); } + }; + }} + +The above specialization informs pybind11 that the custom ``SmartPtr`` class +provides ``.get()`` functionality via ``.getPointer()``. + +.. seealso:: + + The file :file:`tests/test_smart_ptr.cpp` contains a complete example + that demonstrates how to work with custom reference-counting holder types + in more detail. diff --git a/plugins/python/pybind11/docs/basics.rst b/plugins/python/pybind11/docs/basics.rst new file mode 100644 index 0000000..447250e --- /dev/null +++ b/plugins/python/pybind11/docs/basics.rst @@ -0,0 +1,293 @@ +.. _basics: + +First steps +########### + +This sections demonstrates the basic features of pybind11. Before getting +started, make sure that development environment is set up to compile the +included set of test cases. + + +Compiling the test cases +======================== + +Linux/MacOS +----------- + +On Linux you'll need to install the **python-dev** or **python3-dev** packages as +well as **cmake**. On Mac OS, the included python version works out of the box, +but **cmake** must still be installed. + +After installing the prerequisites, run + +.. code-block:: bash + + mkdir build + cd build + cmake .. + make check -j 4 + +The last line will both compile and run the tests. + +Windows +------- + +On Windows, only **Visual Studio 2015** and newer are supported since pybind11 relies +on various C++11 language features that break older versions of Visual Studio. + +To compile and run the tests: + +.. code-block:: batch + + mkdir build + cd build + cmake .. + cmake --build . --config Release --target check + +This will create a Visual Studio project, compile and run the target, all from the +command line. + +.. Note:: + + If all tests fail, make sure that the Python binary and the testcases are compiled + for the same processor type and bitness (i.e. either **i386** or **x86_64**). You + can specify **x86_64** as the target architecture for the generated Visual Studio + project using ``cmake -A x64 ..``. + +.. seealso:: + + Advanced users who are already familiar with Boost.Python may want to skip + the tutorial and look at the test cases in the :file:`tests` directory, + which exercise all features of pybind11. + +Header and namespace conventions +================================ + +For brevity, all code examples assume that the following two lines are present: + +.. code-block:: cpp + + #include + + namespace py = pybind11; + +Some features may require additional headers, but those will be specified as needed. + +.. _simple_example: + +Creating bindings for a simple function +======================================= + +Let's start by creating Python bindings for an extremely simple function, which +adds two numbers and returns their result: + +.. code-block:: cpp + + int add(int i, int j) { + return i + j; + } + +For simplicity [#f1]_, we'll put both this function and the binding code into +a file named :file:`example.cpp` with the following contents: + +.. code-block:: cpp + + #include + + int add(int i, int j) { + return i + j; + } + + PYBIND11_MODULE(example, m) { + m.doc() = "pybind11 example plugin"; // optional module docstring + + m.def("add", &add, "A function which adds two numbers"); + } + +.. [#f1] In practice, implementation and binding code will generally be located + in separate files. + +The :func:`PYBIND11_MODULE` macro creates a function that will be called when an +``import`` statement is issued from within Python. The module name (``example``) +is given as the first macro argument (it should not be in quotes). The second +argument (``m``) defines a variable of type :class:`py::module ` which +is the main interface for creating bindings. The method :func:`module::def` +generates binding code that exposes the ``add()`` function to Python. + +.. note:: + + Notice how little code was needed to expose our function to Python: all + details regarding the function's parameters and return value were + automatically inferred using template metaprogramming. This overall + approach and the used syntax are borrowed from Boost.Python, though the + underlying implementation is very different. + +pybind11 is a header-only library, hence it is not necessary to link against +any special libraries and there are no intermediate (magic) translation steps. +On Linux, the above example can be compiled using the following command: + +.. code-block:: bash + + $ c++ -O3 -Wall -shared -std=c++11 -fPIC `python3 -m pybind11 --includes` example.cpp -o example`python3-config --extension-suffix` + +For more details on the required compiler flags on Linux and MacOS, see +:ref:`building_manually`. For complete cross-platform compilation instructions, +refer to the :ref:`compiling` page. + +The `python_example`_ and `cmake_example`_ repositories are also a good place +to start. They are both complete project examples with cross-platform build +systems. The only difference between the two is that `python_example`_ uses +Python's ``setuptools`` to build the module, while `cmake_example`_ uses CMake +(which may be preferable for existing C++ projects). + +.. _python_example: https://github.com/pybind/python_example +.. _cmake_example: https://github.com/pybind/cmake_example + +Building the above C++ code will produce a binary module file that can be +imported to Python. Assuming that the compiled module is located in the +current directory, the following interactive Python session shows how to +load and execute the example: + +.. code-block:: pycon + + $ python + Python 2.7.10 (default, Aug 22 2015, 20:33:39) + [GCC 4.2.1 Compatible Apple LLVM 7.0.0 (clang-700.0.59.1)] on darwin + Type "help", "copyright", "credits" or "license" for more information. + >>> import example + >>> example.add(1, 2) + 3L + >>> + +.. _keyword_args: + +Keyword arguments +================= + +With a simple modification code, it is possible to inform Python about the +names of the arguments ("i" and "j" in this case). + +.. code-block:: cpp + + m.def("add", &add, "A function which adds two numbers", + py::arg("i"), py::arg("j")); + +:class:`arg` is one of several special tag classes which can be used to pass +metadata into :func:`module::def`. With this modified binding code, we can now +call the function using keyword arguments, which is a more readable alternative +particularly for functions taking many parameters: + +.. code-block:: pycon + + >>> import example + >>> example.add(i=1, j=2) + 3L + +The keyword names also appear in the function signatures within the documentation. + +.. code-block:: pycon + + >>> help(example) + + .... + + FUNCTIONS + add(...) + Signature : (i: int, j: int) -> int + + A function which adds two numbers + +A shorter notation for named arguments is also available: + +.. code-block:: cpp + + // regular notation + m.def("add1", &add, py::arg("i"), py::arg("j")); + // shorthand + using namespace pybind11::literals; + m.def("add2", &add, "i"_a, "j"_a); + +The :var:`_a` suffix forms a C++11 literal which is equivalent to :class:`arg`. +Note that the literal operator must first be made visible with the directive +``using namespace pybind11::literals``. This does not bring in anything else +from the ``pybind11`` namespace except for literals. + +.. _default_args: + +Default arguments +================= + +Suppose now that the function to be bound has default arguments, e.g.: + +.. code-block:: cpp + + int add(int i = 1, int j = 2) { + return i + j; + } + +Unfortunately, pybind11 cannot automatically extract these parameters, since they +are not part of the function's type information. However, they are simple to specify +using an extension of :class:`arg`: + +.. code-block:: cpp + + m.def("add", &add, "A function which adds two numbers", + py::arg("i") = 1, py::arg("j") = 2); + +The default values also appear within the documentation. + +.. code-block:: pycon + + >>> help(example) + + .... + + FUNCTIONS + add(...) + Signature : (i: int = 1, j: int = 2) -> int + + A function which adds two numbers + +The shorthand notation is also available for default arguments: + +.. code-block:: cpp + + // regular notation + m.def("add1", &add, py::arg("i") = 1, py::arg("j") = 2); + // shorthand + m.def("add2", &add, "i"_a=1, "j"_a=2); + +Exporting variables +=================== + +To expose a value from C++, use the ``attr`` function to register it in a +module as shown below. Built-in types and general objects (more on that later) +are automatically converted when assigned as attributes, and can be explicitly +converted using the function ``py::cast``. + +.. code-block:: cpp + + PYBIND11_MODULE(example, m) { + m.attr("the_answer") = 42; + py::object world = py::cast("World"); + m.attr("what") = world; + } + +These are then accessible from Python: + +.. code-block:: pycon + + >>> import example + >>> example.the_answer + 42 + >>> example.what + 'World' + +.. _supported_types: + +Supported data types +==================== + +A large number of data types are supported out of the box and can be used +seamlessly as functions arguments, return values or with ``py::cast`` in general. +For a full overview, see the :doc:`advanced/cast/index` section. diff --git a/plugins/python/pybind11/docs/benchmark.py b/plugins/python/pybind11/docs/benchmark.py new file mode 100644 index 0000000..6dc0604 --- /dev/null +++ b/plugins/python/pybind11/docs/benchmark.py @@ -0,0 +1,88 @@ +import random +import os +import time +import datetime as dt + +nfns = 4 # Functions per class +nargs = 4 # Arguments per function + + +def generate_dummy_code_pybind11(nclasses=10): + decl = "" + bindings = "" + + for cl in range(nclasses): + decl += "class cl%03i;\n" % cl + decl += '\n' + + for cl in range(nclasses): + decl += "class cl%03i {\n" % cl + decl += "public:\n" + bindings += ' py::class_(m, "cl%03i")\n' % (cl, cl) + for fn in range(nfns): + ret = random.randint(0, nclasses - 1) + params = [random.randint(0, nclasses - 1) for i in range(nargs)] + decl += " cl%03i *fn_%03i(" % (ret, fn) + decl += ", ".join("cl%03i *" % p for p in params) + decl += ");\n" + bindings += ' .def("fn_%03i", &cl%03i::fn_%03i)\n' % \ + (fn, cl, fn) + decl += "};\n\n" + bindings += ' ;\n' + + result = "#include \n\n" + result += "namespace py = pybind11;\n\n" + result += decl + '\n' + result += "PYBIND11_MODULE(example, m) {\n" + result += bindings + result += "}" + return result + + +def generate_dummy_code_boost(nclasses=10): + decl = "" + bindings = "" + + for cl in range(nclasses): + decl += "class cl%03i;\n" % cl + decl += '\n' + + for cl in range(nclasses): + decl += "class cl%03i {\n" % cl + decl += "public:\n" + bindings += ' py::class_("cl%03i")\n' % (cl, cl) + for fn in range(nfns): + ret = random.randint(0, nclasses - 1) + params = [random.randint(0, nclasses - 1) for i in range(nargs)] + decl += " cl%03i *fn_%03i(" % (ret, fn) + decl += ", ".join("cl%03i *" % p for p in params) + decl += ");\n" + bindings += ' .def("fn_%03i", &cl%03i::fn_%03i, py::return_value_policy())\n' % \ + (fn, cl, fn) + decl += "};\n\n" + bindings += ' ;\n' + + result = "#include \n\n" + result += "namespace py = boost::python;\n\n" + result += decl + '\n' + result += "BOOST_PYTHON_MODULE(example) {\n" + result += bindings + result += "}" + return result + + +for codegen in [generate_dummy_code_pybind11, generate_dummy_code_boost]: + print ("{") + for i in range(0, 10): + nclasses = 2 ** i + with open("test.cpp", "w") as f: + f.write(codegen(nclasses)) + n1 = dt.datetime.now() + os.system("g++ -Os -shared -rdynamic -undefined dynamic_lookup " + "-fvisibility=hidden -std=c++14 test.cpp -I include " + "-I /System/Library/Frameworks/Python.framework/Headers -o test.so") + n2 = dt.datetime.now() + elapsed = (n2 - n1).total_seconds() + size = os.stat('test.so').st_size + print(" {%i, %f, %i}," % (nclasses * nfns, elapsed, size)) + print ("}") diff --git a/plugins/python/pybind11/docs/benchmark.rst b/plugins/python/pybind11/docs/benchmark.rst new file mode 100644 index 0000000..59d533d --- /dev/null +++ b/plugins/python/pybind11/docs/benchmark.rst @@ -0,0 +1,97 @@ +Benchmark +========= + +The following is the result of a synthetic benchmark comparing both compilation +time and module size of pybind11 against Boost.Python. A detailed report about a +Boost.Python to pybind11 conversion of a real project is available here: [#f1]_. + +.. [#f1] http://graylab.jhu.edu/RosettaCon2016/PyRosetta-4.pdf + +Setup +----- + +A python script (see the ``docs/benchmark.py`` file) was used to generate a set +of files with dummy classes whose count increases for each successive benchmark +(between 1 and 2048 classes in powers of two). Each class has four methods with +a randomly generated signature with a return value and four arguments. (There +was no particular reason for this setup other than the desire to generate many +unique function signatures whose count could be controlled in a simple way.) + +Here is an example of the binding code for one class: + +.. code-block:: cpp + + ... + class cl034 { + public: + cl279 *fn_000(cl084 *, cl057 *, cl065 *, cl042 *); + cl025 *fn_001(cl098 *, cl262 *, cl414 *, cl121 *); + cl085 *fn_002(cl445 *, cl297 *, cl145 *, cl421 *); + cl470 *fn_003(cl200 *, cl323 *, cl332 *, cl492 *); + }; + ... + + PYBIND11_MODULE(example, m) { + ... + py::class_(m, "cl034") + .def("fn_000", &cl034::fn_000) + .def("fn_001", &cl034::fn_001) + .def("fn_002", &cl034::fn_002) + .def("fn_003", &cl034::fn_003) + ... + } + +The Boost.Python version looks almost identical except that a return value +policy had to be specified as an argument to ``def()``. For both libraries, +compilation was done with + +.. code-block:: bash + + Apple LLVM version 7.0.2 (clang-700.1.81) + +and the following compilation flags + +.. code-block:: bash + + g++ -Os -shared -rdynamic -undefined dynamic_lookup -fvisibility=hidden -std=c++14 + +Compilation time +---------------- + +The following log-log plot shows how the compilation time grows for an +increasing number of class and function declarations. pybind11 includes many +fewer headers, which initially leads to shorter compilation times, but the +performance is ultimately fairly similar (pybind11 is 19.8 seconds faster for +the largest largest file with 2048 classes and a total of 8192 methods -- a +modest **1.2x** speedup relative to Boost.Python, which required 116.35 +seconds). + +.. only:: not latex + + .. image:: pybind11_vs_boost_python1.svg + +.. only:: latex + + .. image:: pybind11_vs_boost_python1.png + +Module size +----------- + +Differences between the two libraries become much more pronounced when +considering the file size of the generated Python plugin: for the largest file, +the binary generated by Boost.Python required 16.8 MiB, which was **2.17 +times** / **9.1 megabytes** larger than the output generated by pybind11. For +very small inputs, Boost.Python has an edge in the plot below -- however, note +that it stores many definitions in an external library, whose size was not +included here, hence the comparison is slightly shifted in Boost.Python's +favor. + +.. only:: not latex + + .. image:: pybind11_vs_boost_python2.svg + +.. only:: latex + + .. image:: pybind11_vs_boost_python2.png + + diff --git a/plugins/python/pybind11/docs/changelog.rst b/plugins/python/pybind11/docs/changelog.rst new file mode 100644 index 0000000..1a7fd56 --- /dev/null +++ b/plugins/python/pybind11/docs/changelog.rst @@ -0,0 +1,1054 @@ +.. _changelog: + +Changelog +######### + +Starting with version 1.8.0, pybind11 releases use a `semantic versioning +`_ policy. + +v2.2.4 (September 11, 2018) +----------------------------------------------------- + +* Use new Python 3.7 Thread Specific Storage (TSS) implementation if available. + `#1454 `_, + `#1517 `_. + +* Fixes for newer MSVC versions and C++17 mode. + `#1347 `_. + `#1462 `_. + +* Propagate return value policies to type-specific casters + when casting STL containers. + `#1455 `_. + +* Allow ostream-redirection of more than 1024 characters. + `#1479 `_. + +* Set ``Py_DEBUG`` define when compiling against a debug Python build. + `#1438 `_. + +* Untangle integer logic in number type caster to work for custom + types that may only be castable to a restricted set of builtin types. + `#1442 `_. + +* CMake build system: Remember Python version in cache file. + `#1434 `_. + +* Fix for custom smart pointers: use ``std::addressof`` to obtain holder + address instead of ``operator&``. + `#1435 `_. + +* Properly report exceptions thrown during module initialization. + `#1362 `_. + +* Fixed a segmentation fault when creating empty-shaped NumPy array. + `#1371 `_. + +* The version of Intel C++ compiler must be >= 2017, and this is now checked by + the header files. `#1363 `_. + +* A few minor typo fixes and improvements to the test suite, and + patches that silence compiler warnings. + +v2.2.3 (April 29, 2018) +----------------------------------------------------- + +* The pybind11 header location detection was replaced by a new implementation + that no longer depends on ``pip`` internals (the recently released ``pip`` + 10 has restricted access to this API). + `#1190 `_. + +* Small adjustment to an implementation detail to work around a compiler segmentation fault in Clang 3.3/3.4. + `#1350 `_. + +* The minimal supported version of the Intel compiler was >= 17.0 since + pybind11 v2.1. This check is now explicit, and a compile-time error is raised + if the compiler meet the requirement. + `#1363 `_. + +* Fixed an endianness-related fault in the test suite. + `#1287 `_. + +* Intel compilers have needed to be >= 17.0 since v2.1. Now the check + is explicit and a compile-time error is raised if the compiler does + not meet the requirements. + +v2.2.2 (February 7, 2018) +----------------------------------------------------- + +* Fixed a segfault when combining embedded interpreter + shutdown/reinitialization with external loaded pybind11 modules. + `#1092 `_. + +* Eigen support: fixed a bug where Nx1/1xN numpy inputs couldn't be passed as + arguments to Eigen vectors (which for Eigen are simply compile-time fixed + Nx1/1xN matrices). + `#1106 `_. + +* Clarified to license by moving the licensing of contributions from + ``LICENSE`` into ``CONTRIBUTING.md``: the licensing of contributions is not + actually part of the software license as distributed. This isn't meant to be + a substantial change in the licensing of the project, but addresses concerns + that the clause made the license non-standard. + `#1109 `_. + +* Fixed a regression introduced in 2.1 that broke binding functions with lvalue + character literal arguments. + `#1128 `_. + +* MSVC: fix for compilation failures under /permissive-, and added the flag to + the appveyor test suite. + `#1155 `_. + +* Fixed ``__qualname__`` generation, and in turn, fixes how class names + (especially nested class names) are shown in generated docstrings. + `#1171 `_. + +* Updated the FAQ with a suggested project citation reference. + `#1189 `_. + +* Added fixes for deprecation warnings when compiled under C++17 with + ``-Wdeprecated`` turned on, and add ``-Wdeprecated`` to the test suite + compilation flags. + `#1191 `_. + +* Fixed outdated PyPI URLs in ``setup.py``. + `#1213 `_. + +* Fixed a refcount leak for arguments that end up in a ``py::args`` argument + for functions with both fixed positional and ``py::args`` arguments. + `#1216 `_. + +* Fixed a potential segfault resulting from possible premature destruction of + ``py::args``/``py::kwargs`` arguments with overloaded functions. + `#1223 `_. + +* Fixed ``del map[item]`` for a ``stl_bind.h`` bound stl map. + `#1229 `_. + +* Fixed a regression from v2.1.x where the aggregate initialization could + unintentionally end up at a constructor taking a templated + ``std::initializer_list`` argument. + `#1249 `_. + +* Fixed an issue where calling a function with a keep_alive policy on the same + nurse/patient pair would cause the internal patient storage to needlessly + grow (unboundedly, if the nurse is long-lived). + `#1251 `_. + +* Various other minor fixes. + +v2.2.1 (September 14, 2017) +----------------------------------------------------- + +* Added ``py::module::reload()`` member function for reloading a module. + `#1040 `_. + +* Fixed a reference leak in the number converter. + `#1078 `_. + +* Fixed compilation with Clang on host GCC < 5 (old libstdc++ which isn't fully + C++11 compliant). `#1062 `_. + +* Fixed a regression where the automatic ``std::vector`` caster would + fail to compile. The same fix also applies to any container which returns + element proxies instead of references. + `#1053 `_. + +* Fixed a regression where the ``py::keep_alive`` policy could not be applied + to constructors. `#1065 `_. + +* Fixed a nullptr dereference when loading a ``py::module_local`` type + that's only registered in an external module. + `#1058 `_. + +* Fixed implicit conversion of accessors to types derived from ``py::object``. + `#1076 `_. + +* The ``name`` in ``PYBIND11_MODULE(name, variable)`` can now be a macro. + `#1082 `_. + +* Relaxed overly strict ``py::pickle()`` check for matching get and set types. + `#1064 `_. + +* Conversion errors now try to be more informative when it's likely that + a missing header is the cause (e.g. forgetting ````). + `#1077 `_. + +v2.2.0 (August 31, 2017) +----------------------------------------------------- + +* Support for embedding the Python interpreter. See the + :doc:`documentation page ` for a + full overview of the new features. + `#774 `_, + `#889 `_, + `#892 `_, + `#920 `_. + + .. code-block:: cpp + + #include + namespace py = pybind11; + + int main() { + py::scoped_interpreter guard{}; // start the interpreter and keep it alive + + py::print("Hello, World!"); // use the Python API + } + +* Support for inheriting from multiple C++ bases in Python. + `#693 `_. + + .. code-block:: python + + from cpp_module import CppBase1, CppBase2 + + class PyDerived(CppBase1, CppBase2): + def __init__(self): + CppBase1.__init__(self) # C++ bases must be initialized explicitly + CppBase2.__init__(self) + +* ``PYBIND11_MODULE`` is now the preferred way to create module entry points. + ``PYBIND11_PLUGIN`` is deprecated. See :ref:`macros` for details. + `#879 `_. + + .. code-block:: cpp + + // new + PYBIND11_MODULE(example, m) { + m.def("add", [](int a, int b) { return a + b; }); + } + + // old + PYBIND11_PLUGIN(example) { + py::module m("example"); + m.def("add", [](int a, int b) { return a + b; }); + return m.ptr(); + } + +* pybind11's headers and build system now more strictly enforce hidden symbol + visibility for extension modules. This should be seamless for most users, + but see the :doc:`upgrade` if you use a custom build system. + `#995 `_. + +* Support for ``py::module_local`` types which allow multiple modules to + export the same C++ types without conflicts. This is useful for opaque + types like ``std::vector``. ``py::bind_vector`` and ``py::bind_map`` + now default to ``py::module_local`` if their elements are builtins or + local types. See :ref:`module_local` for details. + `#949 `_, + `#981 `_, + `#995 `_, + `#997 `_. + +* Custom constructors can now be added very easily using lambdas or factory + functions which return a class instance by value, pointer or holder. This + supersedes the old placement-new ``__init__`` technique. + See :ref:`custom_constructors` for details. + `#805 `_, + `#1014 `_. + + .. code-block:: cpp + + struct Example { + Example(std::string); + }; + + py::class_(m, "Example") + .def(py::init()) // existing constructor + .def(py::init([](int n) { // custom constructor + return std::make_unique(std::to_string(n)); + })); + +* Similarly to custom constructors, pickling support functions are now bound + using the ``py::pickle()`` adaptor which improves type safety. See the + :doc:`upgrade` and :ref:`pickling` for details. + `#1038 `_. + +* Builtin support for converting C++17 standard library types and general + conversion improvements: + + 1. C++17 ``std::variant`` is supported right out of the box. C++11/14 + equivalents (e.g. ``boost::variant``) can also be added with a simple + user-defined specialization. See :ref:`cpp17_container_casters` for details. + `#811 `_, + `#845 `_, + `#989 `_. + + 2. Out-of-the-box support for C++17 ``std::string_view``. + `#906 `_. + + 3. Improved compatibility of the builtin ``optional`` converter. + `#874 `_. + + 4. The ``bool`` converter now accepts ``numpy.bool_`` and types which + define ``__bool__`` (Python 3.x) or ``__nonzero__`` (Python 2.7). + `#925 `_. + + 5. C++-to-Python casters are now more efficient and move elements out + of rvalue containers whenever possible. + `#851 `_, + `#936 `_, + `#938 `_. + + 6. Fixed ``bytes`` to ``std::string/char*`` conversion on Python 3. + `#817 `_. + + 7. Fixed lifetime of temporary C++ objects created in Python-to-C++ conversions. + `#924 `_. + +* Scope guard call policy for RAII types, e.g. ``py::call_guard()``, + ``py::call_guard()``. See :ref:`call_policies` for details. + `#740 `_. + +* Utility for redirecting C++ streams to Python (e.g. ``std::cout`` -> + ``sys.stdout``). Scope guard ``py::scoped_ostream_redirect`` in C++ and + a context manager in Python. See :ref:`ostream_redirect`. + `#1009 `_. + +* Improved handling of types and exceptions across module boundaries. + `#915 `_, + `#951 `_, + `#995 `_. + +* Fixed destruction order of ``py::keep_alive`` nurse/patient objects + in reference cycles. + `#856 `_. + +* Numpy and buffer protocol related improvements: + + 1. Support for negative strides in Python buffer objects/numpy arrays. This + required changing integers from unsigned to signed for the related C++ APIs. + Note: If you have compiler warnings enabled, you may notice some new conversion + warnings after upgrading. These can be resolved with ``static_cast``. + `#782 `_. + + 2. Support ``std::complex`` and arrays inside ``PYBIND11_NUMPY_DTYPE``. + `#831 `_, + `#832 `_. + + 3. Support for constructing ``py::buffer_info`` and ``py::arrays`` using + arbitrary containers or iterators instead of requiring a ``std::vector``. + `#788 `_, + `#822 `_, + `#860 `_. + + 4. Explicitly check numpy version and require >= 1.7.0. + `#819 `_. + +* Support for allowing/prohibiting ``None`` for specific arguments and improved + ``None`` overload resolution order. See :ref:`none_arguments` for details. + `#843 `_. + `#859 `_. + +* Added ``py::exec()`` as a shortcut for ``py::eval()`` + and support for C++11 raw string literals as input. See :ref:`eval`. + `#766 `_, + `#827 `_. + +* ``py::vectorize()`` ignores non-vectorizable arguments and supports + member functions. + `#762 `_. + +* Support for bound methods as callbacks (``pybind11/functional.h``). + `#815 `_. + +* Allow aliasing pybind11 methods: ``cls.attr("foo") = cls.attr("bar")``. + `#802 `_. + +* Don't allow mixed static/non-static overloads. + `#804 `_. + +* Fixed overriding static properties in derived classes. + `#784 `_. + +* Improved deduction of member functions of a derived class when its bases + aren't registered with pybind11. + `#855 `_. + + .. code-block:: cpp + + struct Base { + int foo() { return 42; } + } + + struct Derived : Base {} + + // Now works, but previously required also binding `Base` + py::class_(m, "Derived") + .def("foo", &Derived::foo); // function is actually from `Base` + +* The implementation of ``py::init<>`` now uses C++11 brace initialization + syntax to construct instances, which permits binding implicit constructors of + aggregate types. `#1015 `_. + + .. code-block:: cpp + + struct Aggregate { + int a; + std::string b; + }; + + py::class_(m, "Aggregate") + .def(py::init()); + +* Fixed issues with multiple inheritance with offset base/derived pointers. + `#812 `_, + `#866 `_, + `#960 `_. + +* Fixed reference leak of type objects. + `#1030 `_. + +* Improved support for the ``/std:c++14`` and ``/std:c++latest`` modes + on MSVC 2017. + `#841 `_, + `#999 `_. + +* Fixed detection of private operator new on MSVC. + `#893 `_, + `#918 `_. + +* Intel C++ compiler compatibility fixes. + `#937 `_. + +* Fixed implicit conversion of `py::enum_` to integer types on Python 2.7. + `#821 `_. + +* Added ``py::hash`` to fetch the hash value of Python objects, and + ``.def(hash(py::self))`` to provide the C++ ``std::hash`` as the Python + ``__hash__`` method. + `#1034 `_. + +* Fixed ``__truediv__`` on Python 2 and ``__itruediv__`` on Python 3. + `#867 `_. + +* ``py::capsule`` objects now support the ``name`` attribute. This is useful + for interfacing with ``scipy.LowLevelCallable``. + `#902 `_. + +* Fixed ``py::make_iterator``'s ``__next__()`` for past-the-end calls. + `#897 `_. + +* Added ``error_already_set::matches()`` for checking Python exceptions. + `#772 `_. + +* Deprecated ``py::error_already_set::clear()``. It's no longer needed + following a simplification of the ``py::error_already_set`` class. + `#954 `_. + +* Deprecated ``py::handle::operator==()`` in favor of ``py::handle::is()`` + `#825 `_. + +* Deprecated ``py::object::borrowed``/``py::object::stolen``. + Use ``py::object::borrowed_t{}``/``py::object::stolen_t{}`` instead. + `#771 `_. + +* Changed internal data structure versioning to avoid conflicts between + modules compiled with different revisions of pybind11. + `#1012 `_. + +* Additional compile-time and run-time error checking and more informative messages. + `#786 `_, + `#794 `_, + `#803 `_. + +* Various minor improvements and fixes. + `#764 `_, + `#791 `_, + `#795 `_, + `#840 `_, + `#844 `_, + `#846 `_, + `#849 `_, + `#858 `_, + `#862 `_, + `#871 `_, + `#872 `_, + `#881 `_, + `#888 `_, + `#899 `_, + `#928 `_, + `#931 `_, + `#944 `_, + `#950 `_, + `#952 `_, + `#962 `_, + `#965 `_, + `#970 `_, + `#978 `_, + `#979 `_, + `#986 `_, + `#1020 `_, + `#1027 `_, + `#1037 `_. + +* Testing improvements. + `#798 `_, + `#882 `_, + `#898 `_, + `#900 `_, + `#921 `_, + `#923 `_, + `#963 `_. + +v2.1.1 (April 7, 2017) +----------------------------------------------------- + +* Fixed minimum version requirement for MSVC 2015u3 + `#773 `_. + +v2.1.0 (March 22, 2017) +----------------------------------------------------- + +* pybind11 now performs function overload resolution in two phases. The first + phase only considers exact type matches, while the second allows for implicit + conversions to take place. A special ``noconvert()`` syntax can be used to + completely disable implicit conversions for specific arguments. + `#643 `_, + `#634 `_, + `#650 `_. + +* Fixed a regression where static properties no longer worked with classes + using multiple inheritance. The ``py::metaclass`` attribute is no longer + necessary (and deprecated as of this release) when binding classes with + static properties. + `#679 `_, + +* Classes bound using ``pybind11`` can now use custom metaclasses. + `#679 `_, + +* ``py::args`` and ``py::kwargs`` can now be mixed with other positional + arguments when binding functions using pybind11. + `#611 `_. + +* Improved support for C++11 unicode string and character types; added + extensive documentation regarding pybind11's string conversion behavior. + `#624 `_, + `#636 `_, + `#715 `_. + +* pybind11 can now avoid expensive copies when converting Eigen arrays to NumPy + arrays (and vice versa). `#610 `_. + +* The "fast path" in ``py::vectorize`` now works for any full-size group of C or + F-contiguous arrays. The non-fast path is also faster since it no longer performs + copies of the input arguments (except when type conversions are necessary). + `#610 `_. + +* Added fast, unchecked access to NumPy arrays via a proxy object. + `#746 `_. + +* Transparent support for class-specific ``operator new`` and + ``operator delete`` implementations. + `#755 `_. + +* Slimmer and more efficient STL-compatible iterator interface for sequence types. + `#662 `_. + +* Improved custom holder type support. + `#607 `_. + +* ``nullptr`` to ``None`` conversion fixed in various builtin type casters. + `#732 `_. + +* ``enum_`` now exposes its members via a special ``__members__`` attribute. + `#666 `_. + +* ``std::vector`` bindings created using ``stl_bind.h`` can now optionally + implement the buffer protocol. `#488 `_. + +* Automated C++ reference documentation using doxygen and breathe. + `#598 `_. + +* Added minimum compiler version assertions. + `#727 `_. + +* Improved compatibility with C++1z. + `#677 `_. + +* Improved ``py::capsule`` API. Can be used to implement cleanup + callbacks that are involved at module destruction time. + `#752 `_. + +* Various minor improvements and fixes. + `#595 `_, + `#588 `_, + `#589 `_, + `#603 `_, + `#619 `_, + `#648 `_, + `#695 `_, + `#720 `_, + `#723 `_, + `#729 `_, + `#724 `_, + `#742 `_, + `#753 `_. + +v2.0.1 (Jan 4, 2017) +----------------------------------------------------- + +* Fix pointer to reference error in type_caster on MSVC + `#583 `_. + +* Fixed a segmentation in the test suite due to a typo + `cd7eac `_. + +v2.0.0 (Jan 1, 2017) +----------------------------------------------------- + +* Fixed a reference counting regression affecting types with custom metaclasses + (introduced in v2.0.0-rc1). + `#571 `_. + +* Quenched a CMake policy warning. + `#570 `_. + +v2.0.0-rc1 (Dec 23, 2016) +----------------------------------------------------- + +The pybind11 developers are excited to issue a release candidate of pybind11 +with a subsequent v2.0.0 release planned in early January next year. + +An incredible amount of effort by went into pybind11 over the last ~5 months, +leading to a release that is jam-packed with exciting new features and numerous +usability improvements. The following list links PRs or individual commits +whenever applicable. + +Happy Christmas! + +* Support for binding C++ class hierarchies that make use of multiple + inheritance. `#410 `_. + +* PyPy support: pybind11 now supports nightly builds of PyPy and will + interoperate with the future 5.7 release. No code changes are necessary, + everything "just" works as usual. Note that we only target the Python 2.7 + branch for now; support for 3.x will be added once its ``cpyext`` extension + support catches up. A few minor features remain unsupported for the time + being (notably dynamic attributes in custom types). + `#527 `_. + +* Significant work on the documentation -- in particular, the monolithic + ``advanced.rst`` file was restructured into a easier to read hierarchical + organization. `#448 `_. + +* Many NumPy-related improvements: + + 1. Object-oriented API to access and modify NumPy ``ndarray`` instances, + replicating much of the corresponding NumPy C API functionality. + `#402 `_. + + 2. NumPy array ``dtype`` array descriptors are now first-class citizens and + are exposed via a new class ``py::dtype``. + + 3. Structured dtypes can be registered using the ``PYBIND11_NUMPY_DTYPE()`` + macro. Special ``array`` constructors accepting dtype objects were also + added. + + One potential caveat involving this change: format descriptor strings + should now be accessed via ``format_descriptor::format()`` (however, for + compatibility purposes, the old syntax ``format_descriptor::value`` will + still work for non-structured data types). `#308 + `_. + + 4. Further improvements to support structured dtypes throughout the system. + `#472 `_, + `#474 `_, + `#459 `_, + `#453 `_, + `#452 `_, and + `#505 `_. + + 5. Fast access operators. `#497 `_. + + 6. Constructors for arrays whose storage is owned by another object. + `#440 `_. + + 7. Added constructors for ``array`` and ``array_t`` explicitly accepting shape + and strides; if strides are not provided, they are deduced assuming + C-contiguity. Also added simplified constructors for 1-dimensional case. + + 8. Added buffer/NumPy support for ``char[N]`` and ``std::array`` types. + + 9. Added ``memoryview`` wrapper type which is constructible from ``buffer_info``. + +* Eigen: many additional conversions and support for non-contiguous + arrays/slices. + `#427 `_, + `#315 `_, + `#316 `_, + `#312 `_, and + `#267 `_ + +* Incompatible changes in ``class_<...>::class_()``: + + 1. Declarations of types that provide access via the buffer protocol must + now include the ``py::buffer_protocol()`` annotation as an argument to + the ``class_`` constructor. + + 2. Declarations of types that require a custom metaclass (i.e. all classes + which include static properties via commands such as + ``def_readwrite_static()``) must now include the ``py::metaclass()`` + annotation as an argument to the ``class_`` constructor. + + These two changes were necessary to make type definitions in pybind11 + future-proof, and to support PyPy via its cpyext mechanism. `#527 + `_. + + + 3. This version of pybind11 uses a redesigned mechanism for instantiating + trampoline classes that are used to override virtual methods from within + Python. This led to the following user-visible syntax change: instead of + + .. code-block:: cpp + + py::class_("MyClass") + .alias() + .... + + write + + .. code-block:: cpp + + py::class_("MyClass") + .... + + Importantly, both the original and the trampoline class are now + specified as an arguments (in arbitrary order) to the ``py::class_`` + template, and the ``alias<..>()`` call is gone. The new scheme has zero + overhead in cases when Python doesn't override any functions of the + underlying C++ class. `rev. 86d825 + `_. + +* Added ``eval`` and ``eval_file`` functions for evaluating expressions and + statements from a string or file. `rev. 0d3fc3 + `_. + +* pybind11 can now create types with a modifiable dictionary. + `#437 `_ and + `#444 `_. + +* Support for translation of arbitrary C++ exceptions to Python counterparts. + `#296 `_ and + `#273 `_. + +* Report full backtraces through mixed C++/Python code, better reporting for + import errors, fixed GIL management in exception processing. + `#537 `_, + `#494 `_, + `rev. e72d95 `_, and + `rev. 099d6e `_. + +* Support for bit-level operations, comparisons, and serialization of C++ + enumerations. `#503 `_, + `#508 `_, + `#380 `_, + `#309 `_. + `#311 `_. + +* The ``class_`` constructor now accepts its template arguments in any order. + `#385 `_. + +* Attribute and item accessors now have a more complete interface which makes + it possible to chain attributes as in + ``obj.attr("a")[key].attr("b").attr("method")(1, 2, 3)``. `#425 + `_. + +* Major redesign of the default and conversion constructors in ``pytypes.h``. + `#464 `_. + +* Added built-in support for ``std::shared_ptr`` holder type. It is no longer + necessary to to include a declaration of the form + ``PYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr)`` (though continuing to + do so won't cause an error). + `#454 `_. + +* New ``py::overload_cast`` casting operator to select among multiple possible + overloads of a function. An example: + + .. code-block:: cpp + + py::class_(m, "Pet") + .def("set", py::overload_cast(&Pet::set), "Set the pet's age") + .def("set", py::overload_cast(&Pet::set), "Set the pet's name"); + + This feature only works on C++14-capable compilers. + `#541 `_. + +* C++ types are automatically cast to Python types, e.g. when assigning + them as an attribute. For instance, the following is now legal: + + .. code-block:: cpp + + py::module m = /* ... */ + m.attr("constant") = 123; + + (Previously, a ``py::cast`` call was necessary to avoid a compilation error.) + `#551 `_. + +* Redesigned ``pytest``-based test suite. `#321 `_. + +* Instance tracking to detect reference leaks in test suite. `#324 `_ + +* pybind11 can now distinguish between multiple different instances that are + located at the same memory address, but which have different types. + `#329 `_. + +* Improved logic in ``move`` return value policy. + `#510 `_, + `#297 `_. + +* Generalized unpacking API to permit calling Python functions from C++ using + notation such as ``foo(a1, a2, *args, "ka"_a=1, "kb"_a=2, **kwargs)``. `#372 `_. + +* ``py::print()`` function whose behavior matches that of the native Python + ``print()`` function. `#372 `_. + +* Added ``py::dict`` keyword constructor:``auto d = dict("number"_a=42, + "name"_a="World");``. `#372 `_. + +* Added ``py::str::format()`` method and ``_s`` literal: ``py::str s = "1 + 2 + = {}"_s.format(3);``. `#372 `_. + +* Added ``py::repr()`` function which is equivalent to Python's builtin + ``repr()``. `#333 `_. + +* Improved construction and destruction logic for holder types. It is now + possible to reference instances with smart pointer holder types without + constructing the holder if desired. The ``PYBIND11_DECLARE_HOLDER_TYPE`` + macro now accepts an optional second parameter to indicate whether the holder + type uses intrusive reference counting. + `#533 `_ and + `#561 `_. + +* Mapping a stateless C++ function to Python and back is now "for free" (i.e. + no extra indirections or argument conversion overheads). `rev. 954b79 + `_. + +* Bindings for ``std::valarray``. + `#545 `_. + +* Improved support for C++17 capable compilers. + `#562 `_. + +* Bindings for ``std::optional``. + `#475 `_, + `#476 `_, + `#479 `_, + `#499 `_, and + `#501 `_. + +* ``stl_bind.h``: general improvements and support for ``std::map`` and + ``std::unordered_map``. + `#490 `_, + `#282 `_, + `#235 `_. + +* The ``std::tuple``, ``std::pair``, ``std::list``, and ``std::vector`` type + casters now accept any Python sequence type as input. `rev. 107285 + `_. + +* Improved CMake Python detection on multi-architecture Linux. + `#532 `_. + +* Infrastructure to selectively disable or enable parts of the automatically + generated docstrings. `#486 `_. + +* ``reference`` and ``reference_internal`` are now the default return value + properties for static and non-static properties, respectively. `#473 + `_. (the previous defaults + were ``automatic``). `#473 `_. + +* Support for ``std::unique_ptr`` with non-default deleters or no deleter at + all (``py::nodelete``). `#384 `_. + +* Deprecated ``handle::call()`` method. The new syntax to call Python + functions is simply ``handle()``. It can also be invoked explicitly via + ``handle::operator()``, where ``X`` is an optional return value policy. + +* Print more informative error messages when ``make_tuple()`` or ``cast()`` + fail. `#262 `_. + +* Creation of holder types for classes deriving from + ``std::enable_shared_from_this<>`` now also works for ``const`` values. + `#260 `_. + +* ``make_iterator()`` improvements for better compatibility with various + types (now uses prefix increment operator); it now also accepts iterators + with different begin/end types as long as they are equality comparable. + `#247 `_. + +* ``arg()`` now accepts a wider range of argument types for default values. + `#244 `_. + +* Support ``keep_alive`` where the nurse object may be ``None``. `#341 + `_. + +* Added constructors for ``str`` and ``bytes`` from zero-terminated char + pointers, and from char pointers and length. Added constructors for ``str`` + from ``bytes`` and for ``bytes`` from ``str``, which will perform UTF-8 + decoding/encoding as required. + +* Many other improvements of library internals without user-visible changes + + +1.8.1 (July 12, 2016) +---------------------- +* Fixed a rare but potentially very severe issue when the garbage collector ran + during pybind11 type creation. + +1.8.0 (June 14, 2016) +---------------------- +* Redesigned CMake build system which exports a convenient + ``pybind11_add_module`` function to parent projects. +* ``std::vector<>`` type bindings analogous to Boost.Python's ``indexing_suite`` +* Transparent conversion of sparse and dense Eigen matrices and vectors (``eigen.h``) +* Added an ``ExtraFlags`` template argument to the NumPy ``array_t<>`` wrapper + to disable an enforced cast that may lose precision, e.g. to create overloads + for different precisions and complex vs real-valued matrices. +* Prevent implicit conversion of floating point values to integral types in + function arguments +* Fixed incorrect default return value policy for functions returning a shared + pointer +* Don't allow registering a type via ``class_`` twice +* Don't allow casting a ``None`` value into a C++ lvalue reference +* Fixed a crash in ``enum_::operator==`` that was triggered by the ``help()`` command +* Improved detection of whether or not custom C++ types can be copy/move-constructed +* Extended ``str`` type to also work with ``bytes`` instances +* Added a ``"name"_a`` user defined string literal that is equivalent to ``py::arg("name")``. +* When specifying function arguments via ``py::arg``, the test that verifies + the number of arguments now runs at compile time. +* Added ``[[noreturn]]`` attribute to ``pybind11_fail()`` to quench some + compiler warnings +* List function arguments in exception text when the dispatch code cannot find + a matching overload +* Added ``PYBIND11_OVERLOAD_NAME`` and ``PYBIND11_OVERLOAD_PURE_NAME`` macros which + can be used to override virtual methods whose name differs in C++ and Python + (e.g. ``__call__`` and ``operator()``) +* Various minor ``iterator`` and ``make_iterator()`` improvements +* Transparently support ``__bool__`` on Python 2.x and Python 3.x +* Fixed issue with destructor of unpickled object not being called +* Minor CMake build system improvements on Windows +* New ``pybind11::args`` and ``pybind11::kwargs`` types to create functions which + take an arbitrary number of arguments and keyword arguments +* New syntax to call a Python function from C++ using ``*args`` and ``*kwargs`` +* The functions ``def_property_*`` now correctly process docstring arguments (these + formerly caused a segmentation fault) +* Many ``mkdoc.py`` improvements (enumerations, template arguments, ``DOC()`` + macro accepts more arguments) +* Cygwin support +* Documentation improvements (pickling support, ``keep_alive``, macro usage) + +1.7 (April 30, 2016) +---------------------- +* Added a new ``move`` return value policy that triggers C++11 move semantics. + The automatic return value policy falls back to this case whenever a rvalue + reference is encountered +* Significantly more general GIL state routines that are used instead of + Python's troublesome ``PyGILState_Ensure`` and ``PyGILState_Release`` API +* Redesign of opaque types that drastically simplifies their usage +* Extended ability to pass values of type ``[const] void *`` +* ``keep_alive`` fix: don't fail when there is no patient +* ``functional.h``: acquire the GIL before calling a Python function +* Added Python RAII type wrappers ``none`` and ``iterable`` +* Added ``*args`` and ``*kwargs`` pass-through parameters to + ``pybind11.get_include()`` function +* Iterator improvements and fixes +* Documentation on return value policies and opaque types improved + +1.6 (April 30, 2016) +---------------------- +* Skipped due to upload to PyPI gone wrong and inability to recover + (https://github.com/pypa/packaging-problems/issues/74) + +1.5 (April 21, 2016) +---------------------- +* For polymorphic types, use RTTI to try to return the closest type registered with pybind11 +* Pickling support for serializing and unserializing C++ instances to a byte stream in Python +* Added a convenience routine ``make_iterator()`` which turns a range indicated + by a pair of C++ iterators into a iterable Python object +* Added ``len()`` and a variadic ``make_tuple()`` function +* Addressed a rare issue that could confuse the current virtual function + dispatcher and another that could lead to crashes in multi-threaded + applications +* Added a ``get_include()`` function to the Python module that returns the path + of the directory containing the installed pybind11 header files +* Documentation improvements: import issues, symbol visibility, pickling, limitations +* Added casting support for ``std::reference_wrapper<>`` + +1.4 (April 7, 2016) +-------------------------- +* Transparent type conversion for ``std::wstring`` and ``wchar_t`` +* Allow passing ``nullptr``-valued strings +* Transparent passing of ``void *`` pointers using capsules +* Transparent support for returning values wrapped in ``std::unique_ptr<>`` +* Improved docstring generation for compatibility with Sphinx +* Nicer debug error message when default parameter construction fails +* Support for "opaque" types that bypass the transparent conversion layer for STL containers +* Redesigned type casting interface to avoid ambiguities that could occasionally cause compiler errors +* Redesigned property implementation; fixes crashes due to an unfortunate default return value policy +* Anaconda package generation support + +1.3 (March 8, 2016) +-------------------------- + +* Added support for the Intel C++ compiler (v15+) +* Added support for the STL unordered set/map data structures +* Added support for the STL linked list data structure +* NumPy-style broadcasting support in ``pybind11::vectorize`` +* pybind11 now displays more verbose error messages when ``arg::operator=()`` fails +* pybind11 internal data structures now live in a version-dependent namespace to avoid ABI issues +* Many, many bugfixes involving corner cases and advanced usage + +1.2 (February 7, 2016) +-------------------------- + +* Optional: efficient generation of function signatures at compile time using C++14 +* Switched to a simpler and more general way of dealing with function default + arguments. Unused keyword arguments in function calls are now detected and + cause errors as expected +* New ``keep_alive`` call policy analogous to Boost.Python's ``with_custodian_and_ward`` +* New ``pybind11::base<>`` attribute to indicate a subclass relationship +* Improved interface for RAII type wrappers in ``pytypes.h`` +* Use RAII type wrappers consistently within pybind11 itself. This + fixes various potential refcount leaks when exceptions occur +* Added new ``bytes`` RAII type wrapper (maps to ``string`` in Python 2.7) +* Made handle and related RAII classes const correct, using them more + consistently everywhere now +* Got rid of the ugly ``__pybind11__`` attributes on the Python side---they are + now stored in a C++ hash table that is not visible in Python +* Fixed refcount leaks involving NumPy arrays and bound functions +* Vastly improved handling of shared/smart pointers +* Removed an unnecessary copy operation in ``pybind11::vectorize`` +* Fixed naming clashes when both pybind11 and NumPy headers are included +* Added conversions for additional exception types +* Documentation improvements (using multiple extension modules, smart pointers, + other minor clarifications) +* unified infrastructure for parsing variadic arguments in ``class_`` and cpp_function +* Fixed license text (was: ZLIB, should have been: 3-clause BSD) +* Python 3.2 compatibility +* Fixed remaining issues when accessing types in another plugin module +* Added enum comparison and casting methods +* Improved SFINAE-based detection of whether types are copy-constructible +* Eliminated many warnings about unused variables and the use of ``offsetof()`` +* Support for ``std::array<>`` conversions + +1.1 (December 7, 2015) +-------------------------- + +* Documentation improvements (GIL, wrapping functions, casting, fixed many typos) +* Generalized conversion of integer types +* Improved support for casting function objects +* Improved support for ``std::shared_ptr<>`` conversions +* Initial support for ``std::set<>`` conversions +* Fixed type resolution issue for types defined in a separate plugin module +* Cmake build system improvements +* Factored out generic functionality to non-templated code (smaller code size) +* Added a code size / compile time benchmark vs Boost.Python +* Added an appveyor CI script + +1.0 (October 15, 2015) +------------------------ +* Initial release diff --git a/plugins/python/pybind11/docs/classes.rst b/plugins/python/pybind11/docs/classes.rst new file mode 100644 index 0000000..ca2477e --- /dev/null +++ b/plugins/python/pybind11/docs/classes.rst @@ -0,0 +1,500 @@ +.. _classes: + +Object-oriented code +#################### + +Creating bindings for a custom type +=================================== + +Let's now look at a more complex example where we'll create bindings for a +custom C++ data structure named ``Pet``. Its definition is given below: + +.. code-block:: cpp + + struct Pet { + Pet(const std::string &name) : name(name) { } + void setName(const std::string &name_) { name = name_; } + const std::string &getName() const { return name; } + + std::string name; + }; + +The binding code for ``Pet`` looks as follows: + +.. code-block:: cpp + + #include + + namespace py = pybind11; + + PYBIND11_MODULE(example, m) { + py::class_(m, "Pet") + .def(py::init()) + .def("setName", &Pet::setName) + .def("getName", &Pet::getName); + } + +:class:`class_` creates bindings for a C++ *class* or *struct*-style data +structure. :func:`init` is a convenience function that takes the types of a +constructor's parameters as template arguments and wraps the corresponding +constructor (see the :ref:`custom_constructors` section for details). An +interactive Python session demonstrating this example is shown below: + +.. code-block:: pycon + + % python + >>> import example + >>> p = example.Pet('Molly') + >>> print(p) + + >>> p.getName() + u'Molly' + >>> p.setName('Charly') + >>> p.getName() + u'Charly' + +.. seealso:: + + Static member functions can be bound in the same way using + :func:`class_::def_static`. + +Keyword and default arguments +============================= +It is possible to specify keyword and default arguments using the syntax +discussed in the previous chapter. Refer to the sections :ref:`keyword_args` +and :ref:`default_args` for details. + +Binding lambda functions +======================== + +Note how ``print(p)`` produced a rather useless summary of our data structure in the example above: + +.. code-block:: pycon + + >>> print(p) + + +To address this, we could bind an utility function that returns a human-readable +summary to the special method slot named ``__repr__``. Unfortunately, there is no +suitable functionality in the ``Pet`` data structure, and it would be nice if +we did not have to change it. This can easily be accomplished by binding a +Lambda function instead: + +.. code-block:: cpp + + py::class_(m, "Pet") + .def(py::init()) + .def("setName", &Pet::setName) + .def("getName", &Pet::getName) + .def("__repr__", + [](const Pet &a) { + return ""; + } + ); + +Both stateless [#f1]_ and stateful lambda closures are supported by pybind11. +With the above change, the same Python code now produces the following output: + +.. code-block:: pycon + + >>> print(p) + + +.. [#f1] Stateless closures are those with an empty pair of brackets ``[]`` as the capture object. + +.. _properties: + +Instance and static fields +========================== + +We can also directly expose the ``name`` field using the +:func:`class_::def_readwrite` method. A similar :func:`class_::def_readonly` +method also exists for ``const`` fields. + +.. code-block:: cpp + + py::class_(m, "Pet") + .def(py::init()) + .def_readwrite("name", &Pet::name) + // ... remainder ... + +This makes it possible to write + +.. code-block:: pycon + + >>> p = example.Pet('Molly') + >>> p.name + u'Molly' + >>> p.name = 'Charly' + >>> p.name + u'Charly' + +Now suppose that ``Pet::name`` was a private internal variable +that can only be accessed via setters and getters. + +.. code-block:: cpp + + class Pet { + public: + Pet(const std::string &name) : name(name) { } + void setName(const std::string &name_) { name = name_; } + const std::string &getName() const { return name; } + private: + std::string name; + }; + +In this case, the method :func:`class_::def_property` +(:func:`class_::def_property_readonly` for read-only data) can be used to +provide a field-like interface within Python that will transparently call +the setter and getter functions: + +.. code-block:: cpp + + py::class_(m, "Pet") + .def(py::init()) + .def_property("name", &Pet::getName, &Pet::setName) + // ... remainder ... + +.. seealso:: + + Similar functions :func:`class_::def_readwrite_static`, + :func:`class_::def_readonly_static` :func:`class_::def_property_static`, + and :func:`class_::def_property_readonly_static` are provided for binding + static variables and properties. Please also see the section on + :ref:`static_properties` in the advanced part of the documentation. + +Dynamic attributes +================== + +Native Python classes can pick up new attributes dynamically: + +.. code-block:: pycon + + >>> class Pet: + ... name = 'Molly' + ... + >>> p = Pet() + >>> p.name = 'Charly' # overwrite existing + >>> p.age = 2 # dynamically add a new attribute + +By default, classes exported from C++ do not support this and the only writable +attributes are the ones explicitly defined using :func:`class_::def_readwrite` +or :func:`class_::def_property`. + +.. code-block:: cpp + + py::class_(m, "Pet") + .def(py::init<>()) + .def_readwrite("name", &Pet::name); + +Trying to set any other attribute results in an error: + +.. code-block:: pycon + + >>> p = example.Pet() + >>> p.name = 'Charly' # OK, attribute defined in C++ + >>> p.age = 2 # fail + AttributeError: 'Pet' object has no attribute 'age' + +To enable dynamic attributes for C++ classes, the :class:`py::dynamic_attr` tag +must be added to the :class:`py::class_` constructor: + +.. code-block:: cpp + + py::class_(m, "Pet", py::dynamic_attr()) + .def(py::init<>()) + .def_readwrite("name", &Pet::name); + +Now everything works as expected: + +.. code-block:: pycon + + >>> p = example.Pet() + >>> p.name = 'Charly' # OK, overwrite value in C++ + >>> p.age = 2 # OK, dynamically add a new attribute + >>> p.__dict__ # just like a native Python class + {'age': 2} + +Note that there is a small runtime cost for a class with dynamic attributes. +Not only because of the addition of a ``__dict__``, but also because of more +expensive garbage collection tracking which must be activated to resolve +possible circular references. Native Python classes incur this same cost by +default, so this is not anything to worry about. By default, pybind11 classes +are more efficient than native Python classes. Enabling dynamic attributes +just brings them on par. + +.. _inheritance: + +Inheritance and automatic upcasting +=================================== + +Suppose now that the example consists of two data structures with an +inheritance relationship: + +.. code-block:: cpp + + struct Pet { + Pet(const std::string &name) : name(name) { } + std::string name; + }; + + struct Dog : Pet { + Dog(const std::string &name) : Pet(name) { } + std::string bark() const { return "woof!"; } + }; + +There are two different ways of indicating a hierarchical relationship to +pybind11: the first specifies the C++ base class as an extra template +parameter of the :class:`class_`: + +.. code-block:: cpp + + py::class_(m, "Pet") + .def(py::init()) + .def_readwrite("name", &Pet::name); + + // Method 1: template parameter: + py::class_(m, "Dog") + .def(py::init()) + .def("bark", &Dog::bark); + +Alternatively, we can also assign a name to the previously bound ``Pet`` +:class:`class_` object and reference it when binding the ``Dog`` class: + +.. code-block:: cpp + + py::class_ pet(m, "Pet"); + pet.def(py::init()) + .def_readwrite("name", &Pet::name); + + // Method 2: pass parent class_ object: + py::class_(m, "Dog", pet /* <- specify Python parent type */) + .def(py::init()) + .def("bark", &Dog::bark); + +Functionality-wise, both approaches are equivalent. Afterwards, instances will +expose fields and methods of both types: + +.. code-block:: pycon + + >>> p = example.Dog('Molly') + >>> p.name + u'Molly' + >>> p.bark() + u'woof!' + +The C++ classes defined above are regular non-polymorphic types with an +inheritance relationship. This is reflected in Python: + +.. code-block:: cpp + + // Return a base pointer to a derived instance + m.def("pet_store", []() { return std::unique_ptr(new Dog("Molly")); }); + +.. code-block:: pycon + + >>> p = example.pet_store() + >>> type(p) # `Dog` instance behind `Pet` pointer + Pet # no pointer upcasting for regular non-polymorphic types + >>> p.bark() + AttributeError: 'Pet' object has no attribute 'bark' + +The function returned a ``Dog`` instance, but because it's a non-polymorphic +type behind a base pointer, Python only sees a ``Pet``. In C++, a type is only +considered polymorphic if it has at least one virtual function and pybind11 +will automatically recognize this: + +.. code-block:: cpp + + struct PolymorphicPet { + virtual ~PolymorphicPet() = default; + }; + + struct PolymorphicDog : PolymorphicPet { + std::string bark() const { return "woof!"; } + }; + + // Same binding code + py::class_(m, "PolymorphicPet"); + py::class_(m, "PolymorphicDog") + .def(py::init<>()) + .def("bark", &PolymorphicDog::bark); + + // Again, return a base pointer to a derived instance + m.def("pet_store2", []() { return std::unique_ptr(new PolymorphicDog); }); + +.. code-block:: pycon + + >>> p = example.pet_store2() + >>> type(p) + PolymorphicDog # automatically upcast + >>> p.bark() + u'woof!' + +Given a pointer to a polymorphic base, pybind11 performs automatic upcasting +to the actual derived type. Note that this goes beyond the usual situation in +C++: we don't just get access to the virtual functions of the base, we get the +concrete derived type including functions and attributes that the base type may +not even be aware of. + +.. seealso:: + + For more information about polymorphic behavior see :ref:`overriding_virtuals`. + + +Overloaded methods +================== + +Sometimes there are several overloaded C++ methods with the same name taking +different kinds of input arguments: + +.. code-block:: cpp + + struct Pet { + Pet(const std::string &name, int age) : name(name), age(age) { } + + void set(int age_) { age = age_; } + void set(const std::string &name_) { name = name_; } + + std::string name; + int age; + }; + +Attempting to bind ``Pet::set`` will cause an error since the compiler does not +know which method the user intended to select. We can disambiguate by casting +them to function pointers. Binding multiple functions to the same Python name +automatically creates a chain of function overloads that will be tried in +sequence. + +.. code-block:: cpp + + py::class_(m, "Pet") + .def(py::init()) + .def("set", (void (Pet::*)(int)) &Pet::set, "Set the pet's age") + .def("set", (void (Pet::*)(const std::string &)) &Pet::set, "Set the pet's name"); + +The overload signatures are also visible in the method's docstring: + +.. code-block:: pycon + + >>> help(example.Pet) + + class Pet(__builtin__.object) + | Methods defined here: + | + | __init__(...) + | Signature : (Pet, str, int) -> NoneType + | + | set(...) + | 1. Signature : (Pet, int) -> NoneType + | + | Set the pet's age + | + | 2. Signature : (Pet, str) -> NoneType + | + | Set the pet's name + +If you have a C++14 compatible compiler [#cpp14]_, you can use an alternative +syntax to cast the overloaded function: + +.. code-block:: cpp + + py::class_(m, "Pet") + .def("set", py::overload_cast(&Pet::set), "Set the pet's age") + .def("set", py::overload_cast(&Pet::set), "Set the pet's name"); + +Here, ``py::overload_cast`` only requires the parameter types to be specified. +The return type and class are deduced. This avoids the additional noise of +``void (Pet::*)()`` as seen in the raw cast. If a function is overloaded based +on constness, the ``py::const_`` tag should be used: + +.. code-block:: cpp + + struct Widget { + int foo(int x, float y); + int foo(int x, float y) const; + }; + + py::class_(m, "Widget") + .def("foo_mutable", py::overload_cast(&Widget::foo)) + .def("foo_const", py::overload_cast(&Widget::foo, py::const_)); + + +.. [#cpp14] A compiler which supports the ``-std=c++14`` flag + or Visual Studio 2015 Update 2 and newer. + +.. note:: + + To define multiple overloaded constructors, simply declare one after the + other using the ``.def(py::init<...>())`` syntax. The existing machinery + for specifying keyword and default arguments also works. + +Enumerations and internal types +=============================== + +Let's now suppose that the example class contains an internal enumeration type, +e.g.: + +.. code-block:: cpp + + struct Pet { + enum Kind { + Dog = 0, + Cat + }; + + Pet(const std::string &name, Kind type) : name(name), type(type) { } + + std::string name; + Kind type; + }; + +The binding code for this example looks as follows: + +.. code-block:: cpp + + py::class_ pet(m, "Pet"); + + pet.def(py::init()) + .def_readwrite("name", &Pet::name) + .def_readwrite("type", &Pet::type); + + py::enum_(pet, "Kind") + .value("Dog", Pet::Kind::Dog) + .value("Cat", Pet::Kind::Cat) + .export_values(); + +To ensure that the ``Kind`` type is created within the scope of ``Pet``, the +``pet`` :class:`class_` instance must be supplied to the :class:`enum_`. +constructor. The :func:`enum_::export_values` function exports the enum entries +into the parent scope, which should be skipped for newer C++11-style strongly +typed enums. + +.. code-block:: pycon + + >>> p = Pet('Lucy', Pet.Cat) + >>> p.type + Kind.Cat + >>> int(p.type) + 1L + +The entries defined by the enumeration type are exposed in the ``__members__`` property: + +.. code-block:: pycon + + >>> Pet.Kind.__members__ + {'Dog': Kind.Dog, 'Cat': Kind.Cat} + +.. note:: + + When the special tag ``py::arithmetic()`` is specified to the ``enum_`` + constructor, pybind11 creates an enumeration that also supports rudimentary + arithmetic and bit-level operations like comparisons, and, or, xor, negation, + etc. + + .. code-block:: cpp + + py::enum_(pet, "Kind", py::arithmetic()) + ... + + By default, these are omitted to conserve space. diff --git a/plugins/python/pybind11/docs/compiling.rst b/plugins/python/pybind11/docs/compiling.rst new file mode 100644 index 0000000..b5d6ce9 --- /dev/null +++ b/plugins/python/pybind11/docs/compiling.rst @@ -0,0 +1,273 @@ +.. _compiling: + +Build systems +############# + +Building with setuptools +======================== + +For projects on PyPI, building with setuptools is the way to go. Sylvain Corlay +has kindly provided an example project which shows how to set up everything, +including automatic generation of documentation using Sphinx. Please refer to +the [python_example]_ repository. + +.. [python_example] https://github.com/pybind/python_example + +Building with cppimport +======================== + +[cppimport]_ is a small Python import hook that determines whether there is a C++ +source file whose name matches the requested module. If there is, the file is +compiled as a Python extension using pybind11 and placed in the same folder as +the C++ source file. Python is then able to find the module and load it. + +.. [cppimport] https://github.com/tbenthompson/cppimport + +.. _cmake: + +Building with CMake +=================== + +For C++ codebases that have an existing CMake-based build system, a Python +extension module can be created with just a few lines of code: + +.. code-block:: cmake + + cmake_minimum_required(VERSION 2.8.12) + project(example) + + add_subdirectory(pybind11) + pybind11_add_module(example example.cpp) + +This assumes that the pybind11 repository is located in a subdirectory named +:file:`pybind11` and that the code is located in a file named :file:`example.cpp`. +The CMake command ``add_subdirectory`` will import the pybind11 project which +provides the ``pybind11_add_module`` function. It will take care of all the +details needed to build a Python extension module on any platform. + +A working sample project, including a way to invoke CMake from :file:`setup.py` for +PyPI integration, can be found in the [cmake_example]_ repository. + +.. [cmake_example] https://github.com/pybind/cmake_example + +pybind11_add_module +------------------- + +To ease the creation of Python extension modules, pybind11 provides a CMake +function with the following signature: + +.. code-block:: cmake + + pybind11_add_module( [MODULE | SHARED] [EXCLUDE_FROM_ALL] + [NO_EXTRAS] [THIN_LTO] source1 [source2 ...]) + +This function behaves very much like CMake's builtin ``add_library`` (in fact, +it's a wrapper function around that command). It will add a library target +called ```` to be built from the listed source files. In addition, it +will take care of all the Python-specific compiler and linker flags as well +as the OS- and Python-version-specific file extension. The produced target +```` can be further manipulated with regular CMake commands. + +``MODULE`` or ``SHARED`` may be given to specify the type of library. If no +type is given, ``MODULE`` is used by default which ensures the creation of a +Python-exclusive module. Specifying ``SHARED`` will create a more traditional +dynamic library which can also be linked from elsewhere. ``EXCLUDE_FROM_ALL`` +removes this target from the default build (see CMake docs for details). + +Since pybind11 is a template library, ``pybind11_add_module`` adds compiler +flags to ensure high quality code generation without bloat arising from long +symbol names and duplication of code in different translation units. It +sets default visibility to *hidden*, which is required for some pybind11 +features and functionality when attempting to load multiple pybind11 modules +compiled under different pybind11 versions. It also adds additional flags +enabling LTO (Link Time Optimization) and strip unneeded symbols. See the +:ref:`FAQ entry ` for a more detailed explanation. These +latter optimizations are never applied in ``Debug`` mode. If ``NO_EXTRAS`` is +given, they will always be disabled, even in ``Release`` mode. However, this +will result in code bloat and is generally not recommended. + +As stated above, LTO is enabled by default. Some newer compilers also support +different flavors of LTO such as `ThinLTO`_. Setting ``THIN_LTO`` will cause +the function to prefer this flavor if available. The function falls back to +regular LTO if ``-flto=thin`` is not available. + +.. _ThinLTO: http://clang.llvm.org/docs/ThinLTO.html + +Configuration variables +----------------------- + +By default, pybind11 will compile modules with the C++14 standard, if available +on the target compiler, falling back to C++11 if C++14 support is not +available. Note, however, that this default is subject to change: future +pybind11 releases are expected to migrate to newer C++ standards as they become +available. To override this, the standard flag can be given explicitly in +``PYBIND11_CPP_STANDARD``: + +.. code-block:: cmake + + # Use just one of these: + # GCC/clang: + set(PYBIND11_CPP_STANDARD -std=c++11) + set(PYBIND11_CPP_STANDARD -std=c++14) + set(PYBIND11_CPP_STANDARD -std=c++1z) # Experimental C++17 support + # MSVC: + set(PYBIND11_CPP_STANDARD /std:c++14) + set(PYBIND11_CPP_STANDARD /std:c++latest) # Enables some MSVC C++17 features + + add_subdirectory(pybind11) # or find_package(pybind11) + +Note that this and all other configuration variables must be set **before** the +call to ``add_subdirectory`` or ``find_package``. The variables can also be set +when calling CMake from the command line using the ``-D=`` flag. + +The target Python version can be selected by setting ``PYBIND11_PYTHON_VERSION`` +or an exact Python installation can be specified with ``PYTHON_EXECUTABLE``. +For example: + +.. code-block:: bash + + cmake -DPYBIND11_PYTHON_VERSION=3.6 .. + # or + cmake -DPYTHON_EXECUTABLE=path/to/python .. + +find_package vs. add_subdirectory +--------------------------------- + +For CMake-based projects that don't include the pybind11 repository internally, +an external installation can be detected through ``find_package(pybind11)``. +See the `Config file`_ docstring for details of relevant CMake variables. + +.. code-block:: cmake + + cmake_minimum_required(VERSION 2.8.12) + project(example) + + find_package(pybind11 REQUIRED) + pybind11_add_module(example example.cpp) + +Once detected, the aforementioned ``pybind11_add_module`` can be employed as +before. The function usage and configuration variables are identical no matter +if pybind11 is added as a subdirectory or found as an installed package. You +can refer to the same [cmake_example]_ repository for a full sample project +-- just swap out ``add_subdirectory`` for ``find_package``. + +.. _Config file: https://github.com/pybind/pybind11/blob/master/tools/pybind11Config.cmake.in + +Advanced: interface library target +---------------------------------- + +When using a version of CMake greater than 3.0, pybind11 can additionally +be used as a special *interface library* . The target ``pybind11::module`` +is available with pybind11 headers, Python headers and libraries as needed, +and C++ compile definitions attached. This target is suitable for linking +to an independently constructed (through ``add_library``, not +``pybind11_add_module``) target in the consuming project. + +.. code-block:: cmake + + cmake_minimum_required(VERSION 3.0) + project(example) + + find_package(pybind11 REQUIRED) # or add_subdirectory(pybind11) + + add_library(example MODULE main.cpp) + target_link_libraries(example PRIVATE pybind11::module) + set_target_properties(example PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}" + SUFFIX "${PYTHON_MODULE_EXTENSION}") + +.. warning:: + + Since pybind11 is a metatemplate library, it is crucial that certain + compiler flags are provided to ensure high quality code generation. In + contrast to the ``pybind11_add_module()`` command, the CMake interface + library only provides the *minimal* set of parameters to ensure that the + code using pybind11 compiles, but it does **not** pass these extra compiler + flags (i.e. this is up to you). + + These include Link Time Optimization (``-flto`` on GCC/Clang/ICPC, ``/GL`` + and ``/LTCG`` on Visual Studio) and .OBJ files with many sections on Visual + Studio (``/bigobj``). The :ref:`FAQ ` contains an + explanation on why these are needed. + +Embedding the Python interpreter +-------------------------------- + +In addition to extension modules, pybind11 also supports embedding Python into +a C++ executable or library. In CMake, simply link with the ``pybind11::embed`` +target. It provides everything needed to get the interpreter running. The Python +headers and libraries are attached to the target. Unlike ``pybind11::module``, +there is no need to manually set any additional properties here. For more +information about usage in C++, see :doc:`/advanced/embedding`. + +.. code-block:: cmake + + cmake_minimum_required(VERSION 3.0) + project(example) + + find_package(pybind11 REQUIRED) # or add_subdirectory(pybind11) + + add_executable(example main.cpp) + target_link_libraries(example PRIVATE pybind11::embed) + +.. _building_manually: + +Building manually +================= + +pybind11 is a header-only library, hence it is not necessary to link against +any special libraries and there are no intermediate (magic) translation steps. + +On Linux, you can compile an example such as the one given in +:ref:`simple_example` using the following command: + +.. code-block:: bash + + $ c++ -O3 -Wall -shared -std=c++11 -fPIC `python3 -m pybind11 --includes` example.cpp -o example`python3-config --extension-suffix` + +The flags given here assume that you're using Python 3. For Python 2, just +change the executable appropriately (to ``python`` or ``python2``). + +The ``python3 -m pybind11 --includes`` command fetches the include paths for +both pybind11 and Python headers. This assumes that pybind11 has been installed +using ``pip`` or ``conda``. If it hasn't, you can also manually specify +``-I /include`` together with the Python includes path +``python3-config --includes``. + +Note that Python 2.7 modules don't use a special suffix, so you should simply +use ``example.so`` instead of ``example`python3-config --extension-suffix```. +Besides, the ``--extension-suffix`` option may or may not be available, depending +on the distribution; in the latter case, the module extension can be manually +set to ``.so``. + +On Mac OS: the build command is almost the same but it also requires passing +the ``-undefined dynamic_lookup`` flag so as to ignore missing symbols when +building the module: + +.. code-block:: bash + + $ c++ -O3 -Wall -shared -std=c++11 -undefined dynamic_lookup `python3 -m pybind11 --includes` example.cpp -o example`python3-config --extension-suffix` + +In general, it is advisable to include several additional build parameters +that can considerably reduce the size of the created binary. Refer to section +:ref:`cmake` for a detailed example of a suitable cross-platform CMake-based +build system that works on all platforms including Windows. + +.. note:: + + On Linux and macOS, it's better to (intentionally) not link against + ``libpython``. The symbols will be resolved when the extension library + is loaded into a Python binary. This is preferable because you might + have several different installations of a given Python version (e.g. the + system-provided Python, and one that ships with a piece of commercial + software). In this way, the plugin will work with both versions, instead + of possibly importing a second Python library into a process that already + contains one (which will lead to a segfault). + +Generating binding code automatically +===================================== + +The ``Binder`` project is a tool for automatic generation of pybind11 binding +code by introspecting existing C++ codebases using LLVM/Clang. See the +[binder]_ documentation for details. + +.. [binder] http://cppbinder.readthedocs.io/en/latest/about.html diff --git a/plugins/python/pybind11/docs/conf.py b/plugins/python/pybind11/docs/conf.py new file mode 100644 index 0000000..e328eb1 --- /dev/null +++ b/plugins/python/pybind11/docs/conf.py @@ -0,0 +1,332 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# pybind11 documentation build configuration file, created by +# sphinx-quickstart on Sun Oct 11 19:23:48 2015. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex +import subprocess + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['breathe'] + +breathe_projects = {'pybind11': '.build/doxygenxml/'} +breathe_default_project = 'pybind11' +breathe_domain_by_extension = {'h': 'cpp'} + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['.templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'pybind11' +copyright = '2017, Wenzel Jakob' +author = 'Wenzel Jakob' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '2.2' +# The full version, including alpha/beta/rc tags. +release = '2.2.3' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['.build', 'release.rst'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +default_role = 'any' + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +#pygments_style = 'monokai' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. + +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + + html_context = { + 'css_files': [ + '_static/theme_overrides.css' + ] + } +else: + html_context = { + 'css_files': [ + '//media.readthedocs.org/css/sphinx_rtd_theme.css', + '//media.readthedocs.org/css/readthedocs-doc-embed.css', + '_static/theme_overrides.css' + ] + } + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'pybind11doc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +'preamble': '\DeclareUnicodeCharacter{00A0}{}', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'pybind11.tex', 'pybind11 Documentation', + 'Wenzel Jakob', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = 'pybind11-logo.png' + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'pybind11', 'pybind11 Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'pybind11', 'pybind11 Documentation', + author, 'pybind11', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + +primary_domain = 'cpp' +highlight_language = 'cpp' + + +def generate_doxygen_xml(app): + build_dir = os.path.join(app.confdir, '.build') + if not os.path.exists(build_dir): + os.mkdir(build_dir) + + try: + subprocess.call(['doxygen', '--version']) + retcode = subprocess.call(['doxygen'], cwd=app.confdir) + if retcode < 0: + sys.stderr.write("doxygen error code: {}\n".format(-retcode)) + except OSError as e: + sys.stderr.write("doxygen execution failed: {}\n".format(e)) + + +def setup(app): + """Add hook for building doxygen xml when needed""" + app.connect("builder-inited", generate_doxygen_xml) diff --git a/plugins/python/pybind11/docs/faq.rst b/plugins/python/pybind11/docs/faq.rst new file mode 100644 index 0000000..530f1ce --- /dev/null +++ b/plugins/python/pybind11/docs/faq.rst @@ -0,0 +1,289 @@ +Frequently asked questions +########################## + +"ImportError: dynamic module does not define init function" +=========================================================== + +You are likely using an incompatible version of Python (for instance, the +extension library was compiled against Python 2, while the interpreter is +running on top of some version of Python 3, or vice versa). + +"Symbol not found: ``__Py_ZeroStruct`` / ``_PyInstanceMethod_Type``" +======================================================================== + +See the first answer. + +"SystemError: dynamic module not initialized properly" +====================================================== + +See the first answer. + +The Python interpreter immediately crashes when importing my module +=================================================================== + +See the first answer. + +CMake doesn't detect the right Python version +============================================= + +The CMake-based build system will try to automatically detect the installed +version of Python and link against that. When this fails, or when there are +multiple versions of Python and it finds the wrong one, delete +``CMakeCache.txt`` and then invoke CMake as follows: + +.. code-block:: bash + + cmake -DPYTHON_EXECUTABLE:FILEPATH= . + +Limitations involving reference arguments +========================================= + +In C++, it's fairly common to pass arguments using mutable references or +mutable pointers, which allows both read and write access to the value +supplied by the caller. This is sometimes done for efficiency reasons, or to +realize functions that have multiple return values. Here are two very basic +examples: + +.. code-block:: cpp + + void increment(int &i) { i++; } + void increment_ptr(int *i) { (*i)++; } + +In Python, all arguments are passed by reference, so there is no general +issue in binding such code from Python. + +However, certain basic Python types (like ``str``, ``int``, ``bool``, +``float``, etc.) are **immutable**. This means that the following attempt +to port the function to Python doesn't have the same effect on the value +provided by the caller -- in fact, it does nothing at all. + +.. code-block:: python + + def increment(i): + i += 1 # nope.. + +pybind11 is also affected by such language-level conventions, which means that +binding ``increment`` or ``increment_ptr`` will also create Python functions +that don't modify their arguments. + +Although inconvenient, one workaround is to encapsulate the immutable types in +a custom type that does allow modifications. + +An other alternative involves binding a small wrapper lambda function that +returns a tuple with all output arguments (see the remainder of the +documentation for examples on binding lambda functions). An example: + +.. code-block:: cpp + + int foo(int &i) { i++; return 123; } + +and the binding code + +.. code-block:: cpp + + m.def("foo", [](int i) { int rv = foo(i); return std::make_tuple(rv, i); }); + + +How can I reduce the build time? +================================ + +It's good practice to split binding code over multiple files, as in the +following example: + +:file:`example.cpp`: + +.. code-block:: cpp + + void init_ex1(py::module &); + void init_ex2(py::module &); + /* ... */ + + PYBIND11_MODULE(example, m) { + init_ex1(m); + init_ex2(m); + /* ... */ + } + +:file:`ex1.cpp`: + +.. code-block:: cpp + + void init_ex1(py::module &m) { + m.def("add", [](int a, int b) { return a + b; }); + } + +:file:`ex2.cpp`: + +.. code-block:: cpp + + void init_ex2(py::module &m) { + m.def("sub", [](int a, int b) { return a - b; }); + } + +:command:`python`: + +.. code-block:: pycon + + >>> import example + >>> example.add(1, 2) + 3 + >>> example.sub(1, 1) + 0 + +As shown above, the various ``init_ex`` functions should be contained in +separate files that can be compiled independently from one another, and then +linked together into the same final shared object. Following this approach +will: + +1. reduce memory requirements per compilation unit. + +2. enable parallel builds (if desired). + +3. allow for faster incremental builds. For instance, when a single class + definition is changed, only a subset of the binding code will generally need + to be recompiled. + +"recursive template instantiation exceeded maximum depth of 256" +================================================================ + +If you receive an error about excessive recursive template evaluation, try +specifying a larger value, e.g. ``-ftemplate-depth=1024`` on GCC/Clang. The +culprit is generally the generation of function signatures at compile time +using C++14 template metaprogramming. + +.. _`faq:hidden_visibility`: + +"‘SomeClass’ declared with greater visibility than the type of its field ‘SomeClass::member’ [-Wattributes]" +============================================================================================================ + +This error typically indicates that you are compiling without the required +``-fvisibility`` flag. pybind11 code internally forces hidden visibility on +all internal code, but if non-hidden (and thus *exported*) code attempts to +include a pybind type (for example, ``py::object`` or ``py::list``) you can run +into this warning. + +To avoid it, make sure you are specifying ``-fvisibility=hidden`` when +compiling pybind code. + +As to why ``-fvisibility=hidden`` is necessary, because pybind modules could +have been compiled under different versions of pybind itself, it is also +important that the symbols defined in one module do not clash with the +potentially-incompatible symbols defined in another. While Python extension +modules are usually loaded with localized symbols (under POSIX systems +typically using ``dlopen`` with the ``RTLD_LOCAL`` flag), this Python default +can be changed, but even if it isn't it is not always enough to guarantee +complete independence of the symbols involved when not using +``-fvisibility=hidden``. + +Additionally, ``-fvisiblity=hidden`` can deliver considerably binary size +savings. (See the following section for more details). + + +.. _`faq:symhidden`: + +How can I create smaller binaries? +================================== + +To do its job, pybind11 extensively relies on a programming technique known as +*template metaprogramming*, which is a way of performing computation at compile +time using type information. Template metaprogamming usually instantiates code +involving significant numbers of deeply nested types that are either completely +removed or reduced to just a few instructions during the compiler's optimization +phase. However, due to the nested nature of these types, the resulting symbol +names in the compiled extension library can be extremely long. For instance, +the included test suite contains the following symbol: + +.. only:: html + + .. code-block:: none + + _​_​Z​N​8​p​y​b​i​n​d​1​1​1​2​c​p​p​_​f​u​n​c​t​i​o​n​C​1​I​v​8​E​x​a​m​p​l​e​2​J​R​N​S​t​3​_​_​1​6​v​e​c​t​o​r​I​N​S​3​_​1​2​b​a​s​i​c​_​s​t​r​i​n​g​I​w​N​S​3​_​1​1​c​h​a​r​_​t​r​a​i​t​s​I​w​E​E​N​S​3​_​9​a​l​l​o​c​a​t​o​r​I​w​E​E​E​E​N​S​8​_​I​S​A​_​E​E​E​E​E​J​N​S​_​4​n​a​m​e​E​N​S​_​7​s​i​b​l​i​n​g​E​N​S​_​9​i​s​_​m​e​t​h​o​d​E​A​2​8​_​c​E​E​E​M​T​0​_​F​T​_​D​p​T​1​_​E​D​p​R​K​T​2​_ + +.. only:: not html + + .. code-block:: cpp + + __ZN8pybind1112cpp_functionC1Iv8Example2JRNSt3__16vectorINS3_12basic_stringIwNS3_11char_traitsIwEENS3_9allocatorIwEEEENS8_ISA_EEEEEJNS_4nameENS_7siblingENS_9is_methodEA28_cEEEMT0_FT_DpT1_EDpRKT2_ + +which is the mangled form of the following function type: + +.. code-block:: cpp + + pybind11::cpp_function::cpp_function, std::__1::allocator >, std::__1::allocator, std::__1::allocator > > >&, pybind11::name, pybind11::sibling, pybind11::is_method, char [28]>(void (Example2::*)(std::__1::vector, std::__1::allocator >, std::__1::allocator, std::__1::allocator > > >&), pybind11::name const&, pybind11::sibling const&, pybind11::is_method const&, char const (&) [28]) + +The memory needed to store just the mangled name of this function (196 bytes) +is larger than the actual piece of code (111 bytes) it represents! On the other +hand, it's silly to even give this function a name -- after all, it's just a +tiny cog in a bigger piece of machinery that is not exposed to the outside +world. So we'll generally only want to export symbols for those functions which +are actually called from the outside. + +This can be achieved by specifying the parameter ``-fvisibility=hidden`` to GCC +and Clang, which sets the default symbol visibility to *hidden*, which has a +tremendous impact on the final binary size of the resulting extension library. +(On Visual Studio, symbols are already hidden by default, so nothing needs to +be done there.) + +In addition to decreasing binary size, ``-fvisibility=hidden`` also avoids +potential serious issues when loading multiple modules and is required for +proper pybind operation. See the previous FAQ entry for more details. + +Another aspect that can require a fair bit of code are function signature +descriptions. pybind11 automatically generates human-readable function +signatures for docstrings, e.g.: + +.. code-block:: none + + | __init__(...) + | __init__(*args, **kwargs) + | Overloaded function. + | + | 1. __init__(example.Example1) -> NoneType + | + | Docstring for overload #1 goes here + | + | 2. __init__(example.Example1, int) -> NoneType + | + | Docstring for overload #2 goes here + | + | 3. __init__(example.Example1, example.Example1) -> NoneType + | + | Docstring for overload #3 goes here + + +In C++11 mode, these are generated at run time using string concatenation, +which can amount to 10-20% of the size of the resulting binary. If you can, +enable C++14 language features (using ``-std=c++14`` for GCC/Clang), in which +case signatures are efficiently pre-generated at compile time. Unfortunately, +Visual Studio's C++14 support (``constexpr``) is not good enough as of April +2016, so it always uses the more expensive run-time approach. + +Working with ancient Visual Studio 2009 builds on Windows +========================================================= + +The official Windows distributions of Python are compiled using truly +ancient versions of Visual Studio that lack good C++11 support. Some users +implicitly assume that it would be impossible to load a plugin built with +Visual Studio 2015 into a Python distribution that was compiled using Visual +Studio 2009. However, no such issue exists: it's perfectly legitimate to +interface DLLs that are built with different compilers and/or C libraries. +Common gotchas to watch out for involve not ``free()``-ing memory region +that that were ``malloc()``-ed in another shared library, using data +structures with incompatible ABIs, and so on. pybind11 is very careful not +to make these types of mistakes. + +How to cite this project? +========================= + +We suggest the following BibTeX template to cite pybind11 in scientific +discourse: + +.. code-block:: bash + + @misc{pybind11, + author = {Wenzel Jakob and Jason Rhinelander and Dean Moldovan}, + year = {2017}, + note = {https://github.com/pybind/pybind11}, + title = {pybind11 -- Seamless operability between C++11 and Python} + } + diff --git a/plugins/python/pybind11/docs/index.rst b/plugins/python/pybind11/docs/index.rst new file mode 100644 index 0000000..d236611 --- /dev/null +++ b/plugins/python/pybind11/docs/index.rst @@ -0,0 +1,47 @@ +.. only: not latex + + .. image:: pybind11-logo.png + +pybind11 --- Seamless operability between C++11 and Python +========================================================== + +.. only: not latex + + Contents: + +.. toctree:: + :maxdepth: 1 + + intro + changelog + upgrade + +.. toctree:: + :caption: The Basics + :maxdepth: 2 + + basics + classes + compiling + +.. toctree:: + :caption: Advanced Topics + :maxdepth: 2 + + advanced/functions + advanced/classes + advanced/exceptions + advanced/smart_ptrs + advanced/cast/index + advanced/pycpp/index + advanced/embedding + advanced/misc + +.. toctree:: + :caption: Extra Information + :maxdepth: 1 + + faq + benchmark + limitations + reference diff --git a/plugins/python/pybind11/docs/intro.rst b/plugins/python/pybind11/docs/intro.rst new file mode 100644 index 0000000..ea03ef9 --- /dev/null +++ b/plugins/python/pybind11/docs/intro.rst @@ -0,0 +1,95 @@ +.. image:: pybind11-logo.png + +About this project +================== +**pybind11** is a lightweight header-only library that exposes C++ types in Python +and vice versa, mainly to create Python bindings of existing C++ code. Its +goals and syntax are similar to the excellent `Boost.Python`_ library by David +Abrahams: to minimize boilerplate code in traditional extension modules by +inferring type information using compile-time introspection. + +.. _Boost.Python: http://www.boost.org/doc/libs/release/libs/python/doc/index.html + +The main issue with Boost.Python—and the reason for creating such a similar +project—is Boost. Boost is an enormously large and complex suite of utility +libraries that works with almost every C++ compiler in existence. This +compatibility has its cost: arcane template tricks and workarounds are +necessary to support the oldest and buggiest of compiler specimens. Now that +C++11-compatible compilers are widely available, this heavy machinery has +become an excessively large and unnecessary dependency. +Think of this library as a tiny self-contained version of Boost.Python with +everything stripped away that isn't relevant for binding generation. Without +comments, the core header files only require ~4K lines of code and depend on +Python (2.7 or 3.x, or PyPy2.7 >= 5.7) and the C++ standard library. This +compact implementation was possible thanks to some of the new C++11 language +features (specifically: tuples, lambda functions and variadic templates). Since +its creation, this library has grown beyond Boost.Python in many ways, leading +to dramatically simpler binding code in many common situations. + +Core features +************* +The following core C++ features can be mapped to Python + +- Functions accepting and returning custom data structures per value, reference, or pointer +- Instance methods and static methods +- Overloaded functions +- Instance attributes and static attributes +- Arbitrary exception types +- Enumerations +- Callbacks +- Iterators and ranges +- Custom operators +- Single and multiple inheritance +- STL data structures +- Iterators and ranges +- Smart pointers with reference counting like ``std::shared_ptr`` +- Internal references with correct reference counting +- C++ classes with virtual (and pure virtual) methods can be extended in Python + +Goodies +******* +In addition to the core functionality, pybind11 provides some extra goodies: + +- Python 2.7, 3.x, and PyPy (PyPy2.7 >= 5.7) are supported with an + implementation-agnostic interface. + +- It is possible to bind C++11 lambda functions with captured variables. The + lambda capture data is stored inside the resulting Python function object. + +- pybind11 uses C++11 move constructors and move assignment operators whenever + possible to efficiently transfer custom data types. + +- It's easy to expose the internal storage of custom data types through + Pythons' buffer protocols. This is handy e.g. for fast conversion between + C++ matrix classes like Eigen and NumPy without expensive copy operations. + +- pybind11 can automatically vectorize functions so that they are transparently + applied to all entries of one or more NumPy array arguments. + +- Python's slice-based access and assignment operations can be supported with + just a few lines of code. + +- Everything is contained in just a few header files; there is no need to link + against any additional libraries. + +- Binaries are generally smaller by a factor of at least 2 compared to + equivalent bindings generated by Boost.Python. A recent pybind11 conversion + of `PyRosetta`_, an enormous Boost.Python binding project, reported a binary + size reduction of **5.4x** and compile time reduction by **5.8x**. + +- When supported by the compiler, two new C++14 features (relaxed constexpr and + return value deduction) are used to precompute function signatures at compile + time, leading to smaller binaries. + +- With little extra effort, C++ types can be pickled and unpickled similar to + regular Python objects. + +.. _PyRosetta: http://graylab.jhu.edu/RosettaCon2016/PyRosetta-4.pdf + +Supported compilers +******************* + +1. Clang/LLVM (any non-ancient version with C++11 support) +2. GCC 4.8 or newer +3. Microsoft Visual Studio 2015 or newer +4. Intel C++ compiler v17 or newer (v16 with pybind11 v2.0 and v15 with pybind11 v2.0 and a `workaround `_ ) diff --git a/plugins/python/pybind11/docs/limitations.rst b/plugins/python/pybind11/docs/limitations.rst new file mode 100644 index 0000000..a1a4f1a --- /dev/null +++ b/plugins/python/pybind11/docs/limitations.rst @@ -0,0 +1,20 @@ +Limitations +########### + +pybind11 strives to be a general solution to binding generation, but it also has +certain limitations: + +- pybind11 casts away ``const``-ness in function arguments and return values. + This is in line with the Python language, which has no concept of ``const`` + values. This means that some additional care is needed to avoid bugs that + would be caught by the type checker in a traditional C++ program. + +- The NumPy interface ``pybind11::array`` greatly simplifies accessing + numerical data from C++ (and vice versa), but it's not a full-blown array + class like ``Eigen::Array`` or ``boost.multi_array``. + +These features could be implemented but would lead to a significant increase in +complexity. I've decided to draw the line here to keep this project simple and +compact. Users who absolutely require these features are encouraged to fork +pybind11. + diff --git a/plugins/python/pybind11/docs/pybind11-logo.png b/plugins/python/pybind11/docs/pybind11-logo.png new file mode 100644 index 0000000..4cbad54 Binary files /dev/null and b/plugins/python/pybind11/docs/pybind11-logo.png differ diff --git a/plugins/python/pybind11/docs/pybind11_vs_boost_python1.png b/plugins/python/pybind11/docs/pybind11_vs_boost_python1.png new file mode 100644 index 0000000..833231f Binary files /dev/null and b/plugins/python/pybind11/docs/pybind11_vs_boost_python1.png differ diff --git a/plugins/python/pybind11/docs/pybind11_vs_boost_python1.svg b/plugins/python/pybind11/docs/pybind11_vs_boost_python1.svg new file mode 100644 index 0000000..5bf950e --- /dev/null +++ b/plugins/python/pybind11/docs/pybind11_vs_boost_python1.svg @@ -0,0 +1,427 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/plugins/python/pybind11/docs/pybind11_vs_boost_python2.png b/plugins/python/pybind11/docs/pybind11_vs_boost_python2.png new file mode 100644 index 0000000..9f17272 Binary files /dev/null and b/plugins/python/pybind11/docs/pybind11_vs_boost_python2.png differ diff --git a/plugins/python/pybind11/docs/pybind11_vs_boost_python2.svg b/plugins/python/pybind11/docs/pybind11_vs_boost_python2.svg new file mode 100644 index 0000000..5ed6530 --- /dev/null +++ b/plugins/python/pybind11/docs/pybind11_vs_boost_python2.svg @@ -0,0 +1,427 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/plugins/python/pybind11/docs/reference.rst b/plugins/python/pybind11/docs/reference.rst new file mode 100644 index 0000000..3f74849 --- /dev/null +++ b/plugins/python/pybind11/docs/reference.rst @@ -0,0 +1,102 @@ +.. _reference: + +.. warning:: + + Please be advised that the reference documentation discussing pybind11 + internals is currently incomplete. Please refer to the previous sections + and the pybind11 header files for the nitty gritty details. + +Reference +######### + +.. _macros: + +Macros +====== + +.. doxygendefine:: PYBIND11_MODULE + +.. _core_types: + +Convenience classes for arbitrary Python types +============================================== + +Common member functions +----------------------- + +.. doxygenclass:: object_api + :members: + +Without reference counting +-------------------------- + +.. doxygenclass:: handle + :members: + +With reference counting +----------------------- + +.. doxygenclass:: object + :members: + +.. doxygenfunction:: reinterpret_borrow + +.. doxygenfunction:: reinterpret_steal + +Convenience classes for specific Python types +============================================= + +.. doxygenclass:: module + :members: + +.. doxygengroup:: pytypes + :members: + +.. _extras: + +Passing extra arguments to ``def`` or ``class_`` +================================================ + +.. doxygengroup:: annotations + :members: + +Embedding the interpreter +========================= + +.. doxygendefine:: PYBIND11_EMBEDDED_MODULE + +.. doxygenfunction:: initialize_interpreter + +.. doxygenfunction:: finalize_interpreter + +.. doxygenclass:: scoped_interpreter + +Redirecting C++ streams +======================= + +.. doxygenclass:: scoped_ostream_redirect + +.. doxygenclass:: scoped_estream_redirect + +.. doxygenfunction:: add_ostream_redirect + +Python built-in functions +========================= + +.. doxygengroup:: python_builtins + :members: + +Exceptions +========== + +.. doxygenclass:: error_already_set + :members: + +.. doxygenclass:: builtin_exception + :members: + + +Literals +======== + +.. doxygennamespace:: literals diff --git a/plugins/python/pybind11/docs/release.rst b/plugins/python/pybind11/docs/release.rst new file mode 100644 index 0000000..b31bbe9 --- /dev/null +++ b/plugins/python/pybind11/docs/release.rst @@ -0,0 +1,25 @@ +To release a new version of pybind11: + +- Update the version number and push to pypi + - Update ``pybind11/_version.py`` (set release version, remove 'dev'). + - Update ``PYBIND11_VERSION_MAJOR`` etc. in ``include/pybind11/detail/common.h``. + - Ensure that all the information in ``setup.py`` is up-to-date. + - Update version in ``docs/conf.py``. + - Tag release date in ``docs/changelog.rst``. + - ``git add`` and ``git commit``. + - if new minor version: ``git checkout -b vX.Y``, ``git push -u origin vX.Y`` + - ``git tag -a vX.Y.Z -m 'vX.Y.Z release'``. + - ``git push`` + - ``git push --tags``. + - ``python setup.py sdist upload``. + - ``python setup.py bdist_wheel upload``. +- Update conda-forge (https://github.com/conda-forge/pybind11-feedstock) via PR + - download release package from Github: ``wget https://github.com/pybind/pybind11/archive/vX.Y.Z.tar.gz`` + - compute checksum: ``shasum -a 256 vX.Y.Z.tar.gz`` + - change version number and checksum in ``recipe/meta.yml`` +- Get back to work + - Update ``_version.py`` (add 'dev' and increment minor). + - Update version in ``docs/conf.py`` + - Update version macros in ``include/pybind11/common.h`` + - ``git add`` and ``git commit``. + ``git push`` diff --git a/plugins/python/pybind11/docs/requirements.txt b/plugins/python/pybind11/docs/requirements.txt new file mode 100644 index 0000000..3818fe8 --- /dev/null +++ b/plugins/python/pybind11/docs/requirements.txt @@ -0,0 +1 @@ +breathe == 4.5.0 diff --git a/plugins/python/pybind11/docs/upgrade.rst b/plugins/python/pybind11/docs/upgrade.rst new file mode 100644 index 0000000..3f56973 --- /dev/null +++ b/plugins/python/pybind11/docs/upgrade.rst @@ -0,0 +1,404 @@ +Upgrade guide +############# + +This is a companion guide to the :doc:`changelog`. While the changelog briefly +lists all of the new features, improvements and bug fixes, this upgrade guide +focuses only the subset which directly impacts your experience when upgrading +to a new version. But it goes into more detail. This includes things like +deprecated APIs and their replacements, build system changes, general code +modernization and other useful information. + + +v2.2 +==== + +Deprecation of the ``PYBIND11_PLUGIN`` macro +-------------------------------------------- + +``PYBIND11_MODULE`` is now the preferred way to create module entry points. +The old macro emits a compile-time deprecation warning. + +.. code-block:: cpp + + // old + PYBIND11_PLUGIN(example) { + py::module m("example", "documentation string"); + + m.def("add", [](int a, int b) { return a + b; }); + + return m.ptr(); + } + + // new + PYBIND11_MODULE(example, m) { + m.doc() = "documentation string"; // optional + + m.def("add", [](int a, int b) { return a + b; }); + } + + +New API for defining custom constructors and pickling functions +--------------------------------------------------------------- + +The old placement-new custom constructors have been deprecated. The new approach +uses ``py::init()`` and factory functions to greatly improve type safety. + +Placement-new can be called accidentally with an incompatible type (without any +compiler errors or warnings), or it can initialize the same object multiple times +if not careful with the Python-side ``__init__`` calls. The new-style custom +constructors prevent such mistakes. See :ref:`custom_constructors` for details. + +.. code-block:: cpp + + // old -- deprecated (runtime warning shown only in debug mode) + py::class(m, "Foo") + .def("__init__", [](Foo &self, ...) { + new (&self) Foo(...); // uses placement-new + }); + + // new + py::class(m, "Foo") + .def(py::init([](...) { // Note: no `self` argument + return new Foo(...); // return by raw pointer + // or: return std::make_unique(...); // return by holder + // or: return Foo(...); // return by value (move constructor) + })); + +Mirroring the custom constructor changes, ``py::pickle()`` is now the preferred +way to get and set object state. See :ref:`pickling` for details. + +.. code-block:: cpp + + // old -- deprecated (runtime warning shown only in debug mode) + py::class(m, "Foo") + ... + .def("__getstate__", [](const Foo &self) { + return py::make_tuple(self.value1(), self.value2(), ...); + }) + .def("__setstate__", [](Foo &self, py::tuple t) { + new (&self) Foo(t[0].cast(), ...); + }); + + // new + py::class(m, "Foo") + ... + .def(py::pickle( + [](const Foo &self) { // __getstate__ + return py::make_tuple(f.value1(), f.value2(), ...); // unchanged + }, + [](py::tuple t) { // __setstate__, note: no `self` argument + return new Foo(t[0].cast(), ...); + // or: return std::make_unique(...); // return by holder + // or: return Foo(...); // return by value (move constructor) + } + )); + +For both the constructors and pickling, warnings are shown at module +initialization time (on import, not when the functions are called). +They're only visible when compiled in debug mode. Sample warning: + +.. code-block:: none + + pybind11-bound class 'mymodule.Foo' is using an old-style placement-new '__init__' + which has been deprecated. See the upgrade guide in pybind11's docs. + + +Stricter enforcement of hidden symbol visibility for pybind11 modules +--------------------------------------------------------------------- + +pybind11 now tries to actively enforce hidden symbol visibility for modules. +If you're using either one of pybind11's :doc:`CMake or Python build systems +` (the two example repositories) and you haven't been exporting any +symbols, there's nothing to be concerned about. All the changes have been done +transparently in the background. If you were building manually or relied on +specific default visibility, read on. + +Setting default symbol visibility to *hidden* has always been recommended for +pybind11 (see :ref:`faq:symhidden`). On Linux and macOS, hidden symbol +visibility (in conjunction with the ``strip`` utility) yields much smaller +module binaries. `CPython's extension docs`_ also recommend hiding symbols +by default, with the goal of avoiding symbol name clashes between modules. +Starting with v2.2, pybind11 enforces this more strictly: (1) by declaring +all symbols inside the ``pybind11`` namespace as hidden and (2) by including +the ``-fvisibility=hidden`` flag on Linux and macOS (only for extension +modules, not for embedding the interpreter). + +.. _CPython's extension docs: https://docs.python.org/3/extending/extending.html#providing-a-c-api-for-an-extension-module + +The namespace-scope hidden visibility is done automatically in pybind11's +headers and it's generally transparent to users. It ensures that: + +* Modules compiled with different pybind11 versions don't clash with each other. + +* Some new features, like ``py::module_local`` bindings, can work as intended. + +The ``-fvisibility=hidden`` flag applies the same visibility to user bindings +outside of the ``pybind11`` namespace. It's now set automatic by pybind11's +CMake and Python build systems, but this needs to be done manually by users +of other build systems. Adding this flag: + +* Minimizes the chances of symbol conflicts between modules. E.g. if two + unrelated modules were statically linked to different (ABI-incompatible) + versions of the same third-party library, a symbol clash would be likely + (and would end with unpredictable results). + +* Produces smaller binaries on Linux and macOS, as pointed out previously. + +Within pybind11's CMake build system, ``pybind11_add_module`` has always been +setting the ``-fvisibility=hidden`` flag in release mode. From now on, it's +being applied unconditionally, even in debug mode and it can no longer be opted +out of with the ``NO_EXTRAS`` option. The ``pybind11::module`` target now also +adds this flag to it's interface. The ``pybind11::embed`` target is unchanged. + +The most significant change here is for the ``pybind11::module`` target. If you +were previously relying on default visibility, i.e. if your Python module was +doubling as a shared library with dependents, you'll need to either export +symbols manually (recommended for cross-platform libraries) or factor out the +shared library (and have the Python module link to it like the other +dependents). As a temporary workaround, you can also restore default visibility +using the CMake code below, but this is not recommended in the long run: + +.. code-block:: cmake + + target_link_libraries(mymodule PRIVATE pybind11::module) + + add_library(restore_default_visibility INTERFACE) + target_compile_options(restore_default_visibility INTERFACE -fvisibility=default) + target_link_libraries(mymodule PRIVATE restore_default_visibility) + + +Local STL container bindings +---------------------------- + +Previous pybind11 versions could only bind types globally -- all pybind11 +modules, even unrelated ones, would have access to the same exported types. +However, this would also result in a conflict if two modules exported the +same C++ type, which is especially problematic for very common types, e.g. +``std::vector``. :ref:`module_local` were added to resolve this (see +that section for a complete usage guide). + +``py::class_`` still defaults to global bindings (because these types are +usually unique across modules), however in order to avoid clashes of opaque +types, ``py::bind_vector`` and ``py::bind_map`` will now bind STL containers +as ``py::module_local`` if their elements are: builtins (``int``, ``float``, +etc.), not bound using ``py::class_``, or bound as ``py::module_local``. For +example, this change allows multiple modules to bind ``std::vector`` +without causing conflicts. See :ref:`stl_bind` for more details. + +When upgrading to this version, if you have multiple modules which depend on +a single global binding of an STL container, note that all modules can still +accept foreign ``py::module_local`` types in the direction of Python-to-C++. +The locality only affects the C++-to-Python direction. If this is needed in +multiple modules, you'll need to either: + +* Add a copy of the same STL binding to all of the modules which need it. + +* Restore the global status of that single binding by marking it + ``py::module_local(false)``. + +The latter is an easy workaround, but in the long run it would be best to +localize all common type bindings in order to avoid conflicts with +third-party modules. + + +Negative strides for Python buffer objects and numpy arrays +----------------------------------------------------------- + +Support for negative strides required changing the integer type from unsigned +to signed in the interfaces of ``py::buffer_info`` and ``py::array``. If you +have compiler warnings enabled, you may notice some new conversion warnings +after upgrading. These can be resolved using ``static_cast``. + + +Deprecation of some ``py::object`` APIs +--------------------------------------- + +To compare ``py::object`` instances by pointer, you should now use +``obj1.is(obj2)`` which is equivalent to ``obj1 is obj2`` in Python. +Previously, pybind11 used ``operator==`` for this (``obj1 == obj2``), but +that could be confusing and is now deprecated (so that it can eventually +be replaced with proper rich object comparison in a future release). + +For classes which inherit from ``py::object``, ``borrowed`` and ``stolen`` +were previously available as protected constructor tags. Now the types +should be used directly instead: ``borrowed_t{}`` and ``stolen_t{}`` +(`#771 `_). + + +Stricter compile-time error checking +------------------------------------ + +Some error checks have been moved from run time to compile time. Notably, +automatic conversion of ``std::shared_ptr`` is not possible when ``T`` is +not directly registered with ``py::class_`` (e.g. ``std::shared_ptr`` +or ``std::shared_ptr>`` are not automatically convertible). +Attempting to bind a function with such arguments now results in a compile-time +error instead of waiting to fail at run time. + +``py::init<...>()`` constructor definitions are also stricter and now prevent +bindings which could cause unexpected behavior: + +.. code-block:: cpp + + struct Example { + Example(int &); + }; + + py::class_(m, "Example") + .def(py::init()); // OK, exact match + // .def(py::init()); // compile-time error, mismatch + +A non-``const`` lvalue reference is not allowed to bind to an rvalue. However, +note that a constructor taking ``const T &`` can still be registered using +``py::init()`` because a ``const`` lvalue reference can bind to an rvalue. + +v2.1 +==== + +Minimum compiler versions are enforced at compile time +------------------------------------------------------ + +The minimums also apply to v2.0 but the check is now explicit and a compile-time +error is raised if the compiler does not meet the requirements: + +* GCC >= 4.8 +* clang >= 3.3 (appleclang >= 5.0) +* MSVC >= 2015u3 +* Intel C++ >= 15.0 + + +The ``py::metaclass`` attribute is not required for static properties +--------------------------------------------------------------------- + +Binding classes with static properties is now possible by default. The +zero-parameter version of ``py::metaclass()`` is deprecated. However, a new +one-parameter ``py::metaclass(python_type)`` version was added for rare +cases when a custom metaclass is needed to override pybind11's default. + +.. code-block:: cpp + + // old -- emits a deprecation warning + py::class_(m, "Foo", py::metaclass()) + .def_property_readonly_static("foo", ...); + + // new -- static properties work without the attribute + py::class_(m, "Foo") + .def_property_readonly_static("foo", ...); + + // new -- advanced feature, override pybind11's default metaclass + py::class_(m, "Bar", py::metaclass(custom_python_type)) + ... + + +v2.0 +==== + +Breaking changes in ``py::class_`` +---------------------------------- + +These changes were necessary to make type definitions in pybind11 +future-proof, to support PyPy via its ``cpyext`` mechanism (`#527 +`_), and to improve efficiency +(`rev. 86d825 `_). + +1. Declarations of types that provide access via the buffer protocol must + now include the ``py::buffer_protocol()`` annotation as an argument to + the ``py::class_`` constructor. + + .. code-block:: cpp + + py::class_("Matrix", py::buffer_protocol()) + .def(py::init<...>()) + .def_buffer(...); + +2. Classes which include static properties (e.g. ``def_readwrite_static()``) + must now include the ``py::metaclass()`` attribute. Note: this requirement + has since been removed in v2.1. If you're upgrading from 1.x, it's + recommended to skip directly to v2.1 or newer. + +3. This version of pybind11 uses a redesigned mechanism for instantiating + trampoline classes that are used to override virtual methods from within + Python. This led to the following user-visible syntax change: + + .. code-block:: cpp + + // old v1.x syntax + py::class_("MyClass") + .alias() + ... + + // new v2.x syntax + py::class_("MyClass") + ... + + Importantly, both the original and the trampoline class are now specified + as arguments to the ``py::class_`` template, and the ``alias<..>()`` call + is gone. The new scheme has zero overhead in cases when Python doesn't + override any functions of the underlying C++ class. + `rev. 86d825 `_. + + The class type must be the first template argument given to ``py::class_`` + while the trampoline can be mixed in arbitrary order with other arguments + (see the following section). + + +Deprecation of the ``py::base()`` attribute +---------------------------------------------- + +``py::base()`` was deprecated in favor of specifying ``T`` as a template +argument to ``py::class_``. This new syntax also supports multiple inheritance. +Note that, while the type being exported must be the first argument in the +``py::class_`` template, the order of the following types (bases, +holder and/or trampoline) is not important. + +.. code-block:: cpp + + // old v1.x + py::class_("Derived", py::base()); + + // new v2.x + py::class_("Derived"); + + // new -- multiple inheritance + py::class_("Derived"); + + // new -- apart from `Derived` the argument order can be arbitrary + py::class_("Derived"); + + +Out-of-the-box support for ``std::shared_ptr`` +---------------------------------------------- + +The relevant type caster is now built in, so it's no longer necessary to +include a declaration of the form: + +.. code-block:: cpp + + PYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr) + +Continuing to do so won’t cause an error or even a deprecation warning, +but it's completely redundant. + + +Deprecation of a few ``py::object`` APIs +---------------------------------------- + +All of the old-style calls emit deprecation warnings. + ++---------------------------------------+---------------------------------------------+ +| Old syntax | New syntax | ++=======================================+=============================================+ +| ``obj.call(args...)`` | ``obj(args...)`` | ++---------------------------------------+---------------------------------------------+ +| ``obj.str()`` | ``py::str(obj)`` | ++---------------------------------------+---------------------------------------------+ +| ``auto l = py::list(obj); l.check()`` | ``py::isinstance(obj)`` | ++---------------------------------------+---------------------------------------------+ +| ``py::object(ptr, true)`` | ``py::reinterpret_borrow(ptr)`` | ++---------------------------------------+---------------------------------------------+ +| ``py::object(ptr, false)`` | ``py::reinterpret_steal(ptr)`` | ++---------------------------------------+---------------------------------------------+ +| ``if (obj.attr("foo"))`` | ``if (py::hasattr(obj, "foo"))`` | ++---------------------------------------+---------------------------------------------+ +| ``if (obj["bar"])`` | ``if (obj.contains("bar"))`` | ++---------------------------------------+---------------------------------------------+ diff --git a/plugins/python/pybind11/include/pybind11/attr.h b/plugins/python/pybind11/include/pybind11/attr.h new file mode 100644 index 0000000..dce875a --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/attr.h @@ -0,0 +1,489 @@ +/* + pybind11/attr.h: Infrastructure for processing custom + type and function attributes + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "cast.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +/// \addtogroup annotations +/// @{ + +/// Annotation for methods +struct is_method { handle class_; is_method(const handle &c) : class_(c) { } }; + +/// Annotation for operators +struct is_operator { }; + +/// Annotation for parent scope +struct scope { handle value; scope(const handle &s) : value(s) { } }; + +/// Annotation for documentation +struct doc { const char *value; doc(const char *value) : value(value) { } }; + +/// Annotation for function names +struct name { const char *value; name(const char *value) : value(value) { } }; + +/// Annotation indicating that a function is an overload associated with a given "sibling" +struct sibling { handle value; sibling(const handle &value) : value(value.ptr()) { } }; + +/// Annotation indicating that a class derives from another given type +template struct base { + PYBIND11_DEPRECATED("base() was deprecated in favor of specifying 'T' as a template argument to class_") + base() { } +}; + +/// Keep patient alive while nurse lives +template struct keep_alive { }; + +/// Annotation indicating that a class is involved in a multiple inheritance relationship +struct multiple_inheritance { }; + +/// Annotation which enables dynamic attributes, i.e. adds `__dict__` to a class +struct dynamic_attr { }; + +/// Annotation which enables the buffer protocol for a type +struct buffer_protocol { }; + +/// Annotation which requests that a special metaclass is created for a type +struct metaclass { + handle value; + + PYBIND11_DEPRECATED("py::metaclass() is no longer required. It's turned on by default now.") + metaclass() {} + + /// Override pybind11's default metaclass + explicit metaclass(handle value) : value(value) { } +}; + +/// Annotation that marks a class as local to the module: +struct module_local { const bool value; constexpr module_local(bool v = true) : value(v) { } }; + +/// Annotation to mark enums as an arithmetic type +struct arithmetic { }; + +/** \rst + A call policy which places one or more guard variables (``Ts...``) around the function call. + + For example, this definition: + + .. code-block:: cpp + + m.def("foo", foo, py::call_guard()); + + is equivalent to the following pseudocode: + + .. code-block:: cpp + + m.def("foo", [](args...) { + T scope_guard; + return foo(args...); // forwarded arguments + }); + \endrst */ +template struct call_guard; + +template <> struct call_guard<> { using type = detail::void_type; }; + +template +struct call_guard { + static_assert(std::is_default_constructible::value, + "The guard type must be default constructible"); + + using type = T; +}; + +template +struct call_guard { + struct type { + T guard{}; // Compose multiple guard types with left-to-right default-constructor order + typename call_guard::type next{}; + }; +}; + +/// @} annotations + +NAMESPACE_BEGIN(detail) +/* Forward declarations */ +enum op_id : int; +enum op_type : int; +struct undefined_t; +template struct op_; +inline void keep_alive_impl(size_t Nurse, size_t Patient, function_call &call, handle ret); + +/// Internal data structure which holds metadata about a keyword argument +struct argument_record { + const char *name; ///< Argument name + const char *descr; ///< Human-readable version of the argument value + handle value; ///< Associated Python object + bool convert : 1; ///< True if the argument is allowed to convert when loading + bool none : 1; ///< True if None is allowed when loading + + argument_record(const char *name, const char *descr, handle value, bool convert, bool none) + : name(name), descr(descr), value(value), convert(convert), none(none) { } +}; + +/// Internal data structure which holds metadata about a bound function (signature, overloads, etc.) +struct function_record { + function_record() + : is_constructor(false), is_new_style_constructor(false), is_stateless(false), + is_operator(false), has_args(false), has_kwargs(false), is_method(false) { } + + /// Function name + char *name = nullptr; /* why no C++ strings? They generate heavier code.. */ + + // User-specified documentation string + char *doc = nullptr; + + /// Human-readable version of the function signature + char *signature = nullptr; + + /// List of registered keyword arguments + std::vector args; + + /// Pointer to lambda function which converts arguments and performs the actual call + handle (*impl) (function_call &) = nullptr; + + /// Storage for the wrapped function pointer and captured data, if any + void *data[3] = { }; + + /// Pointer to custom destructor for 'data' (if needed) + void (*free_data) (function_record *ptr) = nullptr; + + /// Return value policy associated with this function + return_value_policy policy = return_value_policy::automatic; + + /// True if name == '__init__' + bool is_constructor : 1; + + /// True if this is a new-style `__init__` defined in `detail/init.h` + bool is_new_style_constructor : 1; + + /// True if this is a stateless function pointer + bool is_stateless : 1; + + /// True if this is an operator (__add__), etc. + bool is_operator : 1; + + /// True if the function has a '*args' argument + bool has_args : 1; + + /// True if the function has a '**kwargs' argument + bool has_kwargs : 1; + + /// True if this is a method + bool is_method : 1; + + /// Number of arguments (including py::args and/or py::kwargs, if present) + std::uint16_t nargs; + + /// Python method object + PyMethodDef *def = nullptr; + + /// Python handle to the parent scope (a class or a module) + handle scope; + + /// Python handle to the sibling function representing an overload chain + handle sibling; + + /// Pointer to next overload + function_record *next = nullptr; +}; + +/// Special data structure which (temporarily) holds metadata about a bound class +struct type_record { + PYBIND11_NOINLINE type_record() + : multiple_inheritance(false), dynamic_attr(false), buffer_protocol(false), module_local(false) { } + + /// Handle to the parent scope + handle scope; + + /// Name of the class + const char *name = nullptr; + + // Pointer to RTTI type_info data structure + const std::type_info *type = nullptr; + + /// How large is the underlying C++ type? + size_t type_size = 0; + + /// How large is the type's holder? + size_t holder_size = 0; + + /// The global operator new can be overridden with a class-specific variant + void *(*operator_new)(size_t) = ::operator new; + + /// Function pointer to class_<..>::init_instance + void (*init_instance)(instance *, const void *) = nullptr; + + /// Function pointer to class_<..>::dealloc + void (*dealloc)(detail::value_and_holder &) = nullptr; + + /// List of base classes of the newly created type + list bases; + + /// Optional docstring + const char *doc = nullptr; + + /// Custom metaclass (optional) + handle metaclass; + + /// Multiple inheritance marker + bool multiple_inheritance : 1; + + /// Does the class manage a __dict__? + bool dynamic_attr : 1; + + /// Does the class implement the buffer protocol? + bool buffer_protocol : 1; + + /// Is the default (unique_ptr) holder type used? + bool default_holder : 1; + + /// Is the class definition local to the module shared object? + bool module_local : 1; + + PYBIND11_NOINLINE void add_base(const std::type_info &base, void *(*caster)(void *)) { + auto base_info = detail::get_type_info(base, false); + if (!base_info) { + std::string tname(base.name()); + detail::clean_type_id(tname); + pybind11_fail("generic_type: type \"" + std::string(name) + + "\" referenced unknown base type \"" + tname + "\""); + } + + if (default_holder != base_info->default_holder) { + std::string tname(base.name()); + detail::clean_type_id(tname); + pybind11_fail("generic_type: type \"" + std::string(name) + "\" " + + (default_holder ? "does not have" : "has") + + " a non-default holder type while its base \"" + tname + "\" " + + (base_info->default_holder ? "does not" : "does")); + } + + bases.append((PyObject *) base_info->type); + + if (base_info->type->tp_dictoffset != 0) + dynamic_attr = true; + + if (caster) + base_info->implicit_casts.emplace_back(type, caster); + } +}; + +inline function_call::function_call(function_record &f, handle p) : + func(f), parent(p) { + args.reserve(f.nargs); + args_convert.reserve(f.nargs); +} + +/// Tag for a new-style `__init__` defined in `detail/init.h` +struct is_new_style_constructor { }; + +/** + * Partial template specializations to process custom attributes provided to + * cpp_function_ and class_. These are either used to initialize the respective + * fields in the type_record and function_record data structures or executed at + * runtime to deal with custom call policies (e.g. keep_alive). + */ +template struct process_attribute; + +template struct process_attribute_default { + /// Default implementation: do nothing + static void init(const T &, function_record *) { } + static void init(const T &, type_record *) { } + static void precall(function_call &) { } + static void postcall(function_call &, handle) { } +}; + +/// Process an attribute specifying the function's name +template <> struct process_attribute : process_attribute_default { + static void init(const name &n, function_record *r) { r->name = const_cast(n.value); } +}; + +/// Process an attribute specifying the function's docstring +template <> struct process_attribute : process_attribute_default { + static void init(const doc &n, function_record *r) { r->doc = const_cast(n.value); } +}; + +/// Process an attribute specifying the function's docstring (provided as a C-style string) +template <> struct process_attribute : process_attribute_default { + static void init(const char *d, function_record *r) { r->doc = const_cast(d); } + static void init(const char *d, type_record *r) { r->doc = const_cast(d); } +}; +template <> struct process_attribute : process_attribute { }; + +/// Process an attribute indicating the function's return value policy +template <> struct process_attribute : process_attribute_default { + static void init(const return_value_policy &p, function_record *r) { r->policy = p; } +}; + +/// Process an attribute which indicates that this is an overloaded function associated with a given sibling +template <> struct process_attribute : process_attribute_default { + static void init(const sibling &s, function_record *r) { r->sibling = s.value; } +}; + +/// Process an attribute which indicates that this function is a method +template <> struct process_attribute : process_attribute_default { + static void init(const is_method &s, function_record *r) { r->is_method = true; r->scope = s.class_; } +}; + +/// Process an attribute which indicates the parent scope of a method +template <> struct process_attribute : process_attribute_default { + static void init(const scope &s, function_record *r) { r->scope = s.value; } +}; + +/// Process an attribute which indicates that this function is an operator +template <> struct process_attribute : process_attribute_default { + static void init(const is_operator &, function_record *r) { r->is_operator = true; } +}; + +template <> struct process_attribute : process_attribute_default { + static void init(const is_new_style_constructor &, function_record *r) { r->is_new_style_constructor = true; } +}; + +/// Process a keyword argument attribute (*without* a default value) +template <> struct process_attribute : process_attribute_default { + static void init(const arg &a, function_record *r) { + if (r->is_method && r->args.empty()) + r->args.emplace_back("self", nullptr, handle(), true /*convert*/, false /*none not allowed*/); + r->args.emplace_back(a.name, nullptr, handle(), !a.flag_noconvert, a.flag_none); + } +}; + +/// Process a keyword argument attribute (*with* a default value) +template <> struct process_attribute : process_attribute_default { + static void init(const arg_v &a, function_record *r) { + if (r->is_method && r->args.empty()) + r->args.emplace_back("self", nullptr /*descr*/, handle() /*parent*/, true /*convert*/, false /*none not allowed*/); + + if (!a.value) { +#if !defined(NDEBUG) + std::string descr("'"); + if (a.name) descr += std::string(a.name) + ": "; + descr += a.type + "'"; + if (r->is_method) { + if (r->name) + descr += " in method '" + (std::string) str(r->scope) + "." + (std::string) r->name + "'"; + else + descr += " in method of '" + (std::string) str(r->scope) + "'"; + } else if (r->name) { + descr += " in function '" + (std::string) r->name + "'"; + } + pybind11_fail("arg(): could not convert default argument " + + descr + " into a Python object (type not registered yet?)"); +#else + pybind11_fail("arg(): could not convert default argument " + "into a Python object (type not registered yet?). " + "Compile in debug mode for more information."); +#endif + } + r->args.emplace_back(a.name, a.descr, a.value.inc_ref(), !a.flag_noconvert, a.flag_none); + } +}; + +/// Process a parent class attribute. Single inheritance only (class_ itself already guarantees that) +template +struct process_attribute::value>> : process_attribute_default { + static void init(const handle &h, type_record *r) { r->bases.append(h); } +}; + +/// Process a parent class attribute (deprecated, does not support multiple inheritance) +template +struct process_attribute> : process_attribute_default> { + static void init(const base &, type_record *r) { r->add_base(typeid(T), nullptr); } +}; + +/// Process a multiple inheritance attribute +template <> +struct process_attribute : process_attribute_default { + static void init(const multiple_inheritance &, type_record *r) { r->multiple_inheritance = true; } +}; + +template <> +struct process_attribute : process_attribute_default { + static void init(const dynamic_attr &, type_record *r) { r->dynamic_attr = true; } +}; + +template <> +struct process_attribute : process_attribute_default { + static void init(const buffer_protocol &, type_record *r) { r->buffer_protocol = true; } +}; + +template <> +struct process_attribute : process_attribute_default { + static void init(const metaclass &m, type_record *r) { r->metaclass = m.value; } +}; + +template <> +struct process_attribute : process_attribute_default { + static void init(const module_local &l, type_record *r) { r->module_local = l.value; } +}; + +/// Process an 'arithmetic' attribute for enums (does nothing here) +template <> +struct process_attribute : process_attribute_default {}; + +template +struct process_attribute> : process_attribute_default> { }; + +/** + * Process a keep_alive call policy -- invokes keep_alive_impl during the + * pre-call handler if both Nurse, Patient != 0 and use the post-call handler + * otherwise + */ +template struct process_attribute> : public process_attribute_default> { + template = 0> + static void precall(function_call &call) { keep_alive_impl(Nurse, Patient, call, handle()); } + template = 0> + static void postcall(function_call &, handle) { } + template = 0> + static void precall(function_call &) { } + template = 0> + static void postcall(function_call &call, handle ret) { keep_alive_impl(Nurse, Patient, call, ret); } +}; + +/// Recursively iterate over variadic template arguments +template struct process_attributes { + static void init(const Args&... args, function_record *r) { + int unused[] = { 0, (process_attribute::type>::init(args, r), 0) ... }; + ignore_unused(unused); + } + static void init(const Args&... args, type_record *r) { + int unused[] = { 0, (process_attribute::type>::init(args, r), 0) ... }; + ignore_unused(unused); + } + static void precall(function_call &call) { + int unused[] = { 0, (process_attribute::type>::precall(call), 0) ... }; + ignore_unused(unused); + } + static void postcall(function_call &call, handle fn_ret) { + int unused[] = { 0, (process_attribute::type>::postcall(call, fn_ret), 0) ... }; + ignore_unused(unused); + } +}; + +template +using is_call_guard = is_instantiation; + +/// Extract the ``type`` from the first `call_guard` in `Extras...` (or `void_type` if none found) +template +using extract_guard_t = typename exactly_one_t, Extra...>::type; + +/// Check the number of named arguments at compile time +template ::value...), + size_t self = constexpr_sum(std::is_same::value...)> +constexpr bool expected_num_args(size_t nargs, bool has_args, bool has_kwargs) { + return named == 0 || (self + named + has_args + has_kwargs) == nargs; +} + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/buffer_info.h b/plugins/python/pybind11/include/pybind11/buffer_info.h new file mode 100644 index 0000000..9f072fa --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/buffer_info.h @@ -0,0 +1,108 @@ +/* + pybind11/buffer_info.h: Python buffer object interface + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "detail/common.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +/// Information record describing a Python buffer object +struct buffer_info { + void *ptr = nullptr; // Pointer to the underlying storage + ssize_t itemsize = 0; // Size of individual items in bytes + ssize_t size = 0; // Total number of entries + std::string format; // For homogeneous buffers, this should be set to format_descriptor::format() + ssize_t ndim = 0; // Number of dimensions + std::vector shape; // Shape of the tensor (1 entry per dimension) + std::vector strides; // Number of entries between adjacent entries (for each per dimension) + + buffer_info() { } + + buffer_info(void *ptr, ssize_t itemsize, const std::string &format, ssize_t ndim, + detail::any_container shape_in, detail::any_container strides_in) + : ptr(ptr), itemsize(itemsize), size(1), format(format), ndim(ndim), + shape(std::move(shape_in)), strides(std::move(strides_in)) { + if (ndim != (ssize_t) shape.size() || ndim != (ssize_t) strides.size()) + pybind11_fail("buffer_info: ndim doesn't match shape and/or strides length"); + for (size_t i = 0; i < (size_t) ndim; ++i) + size *= shape[i]; + } + + template + buffer_info(T *ptr, detail::any_container shape_in, detail::any_container strides_in) + : buffer_info(private_ctr_tag(), ptr, sizeof(T), format_descriptor::format(), static_cast(shape_in->size()), std::move(shape_in), std::move(strides_in)) { } + + buffer_info(void *ptr, ssize_t itemsize, const std::string &format, ssize_t size) + : buffer_info(ptr, itemsize, format, 1, {size}, {itemsize}) { } + + template + buffer_info(T *ptr, ssize_t size) + : buffer_info(ptr, sizeof(T), format_descriptor::format(), size) { } + + explicit buffer_info(Py_buffer *view, bool ownview = true) + : buffer_info(view->buf, view->itemsize, view->format, view->ndim, + {view->shape, view->shape + view->ndim}, {view->strides, view->strides + view->ndim}) { + this->view = view; + this->ownview = ownview; + } + + buffer_info(const buffer_info &) = delete; + buffer_info& operator=(const buffer_info &) = delete; + + buffer_info(buffer_info &&other) { + (*this) = std::move(other); + } + + buffer_info& operator=(buffer_info &&rhs) { + ptr = rhs.ptr; + itemsize = rhs.itemsize; + size = rhs.size; + format = std::move(rhs.format); + ndim = rhs.ndim; + shape = std::move(rhs.shape); + strides = std::move(rhs.strides); + std::swap(view, rhs.view); + std::swap(ownview, rhs.ownview); + return *this; + } + + ~buffer_info() { + if (view && ownview) { PyBuffer_Release(view); delete view; } + } + +private: + struct private_ctr_tag { }; + + buffer_info(private_ctr_tag, void *ptr, ssize_t itemsize, const std::string &format, ssize_t ndim, + detail::any_container &&shape_in, detail::any_container &&strides_in) + : buffer_info(ptr, itemsize, format, ndim, std::move(shape_in), std::move(strides_in)) { } + + Py_buffer *view = nullptr; + bool ownview = false; +}; + +NAMESPACE_BEGIN(detail) + +template struct compare_buffer_info { + static bool compare(const buffer_info& b) { + return b.format == format_descriptor::format() && b.itemsize == (ssize_t) sizeof(T); + } +}; + +template struct compare_buffer_info::value>> { + static bool compare(const buffer_info& b) { + return (size_t) b.itemsize == sizeof(T) && (b.format == format_descriptor::value || + ((sizeof(T) == sizeof(long)) && b.format == (std::is_unsigned::value ? "L" : "l")) || + ((sizeof(T) == sizeof(size_t)) && b.format == (std::is_unsigned::value ? "N" : "n"))); + } +}; + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/cast.h b/plugins/python/pybind11/include/pybind11/cast.h new file mode 100644 index 0000000..2145450 --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/cast.h @@ -0,0 +1,2067 @@ +/* + pybind11/cast.h: Partial template specializations to cast between + C++ and Python types + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pytypes.h" +#include "detail/typeid.h" +#include "detail/descr.h" +#include "detail/internals.h" +#include +#include +#include + +#if defined(PYBIND11_CPP17) +# if defined(__has_include) +# if __has_include() +# define PYBIND11_HAS_STRING_VIEW +# endif +# elif defined(_MSC_VER) +# define PYBIND11_HAS_STRING_VIEW +# endif +#endif +#ifdef PYBIND11_HAS_STRING_VIEW +#include +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/// A life support system for temporary objects created by `type_caster::load()`. +/// Adding a patient will keep it alive up until the enclosing function returns. +class loader_life_support { +public: + /// A new patient frame is created when a function is entered + loader_life_support() { + get_internals().loader_patient_stack.push_back(nullptr); + } + + /// ... and destroyed after it returns + ~loader_life_support() { + auto &stack = get_internals().loader_patient_stack; + if (stack.empty()) + pybind11_fail("loader_life_support: internal error"); + + auto ptr = stack.back(); + stack.pop_back(); + Py_CLEAR(ptr); + + // A heuristic to reduce the stack's capacity (e.g. after long recursive calls) + if (stack.capacity() > 16 && stack.size() != 0 && stack.capacity() / stack.size() > 2) + stack.shrink_to_fit(); + } + + /// This can only be used inside a pybind11-bound function, either by `argument_loader` + /// at argument preparation time or by `py::cast()` at execution time. + PYBIND11_NOINLINE static void add_patient(handle h) { + auto &stack = get_internals().loader_patient_stack; + if (stack.empty()) + throw cast_error("When called outside a bound function, py::cast() cannot " + "do Python -> C++ conversions which require the creation " + "of temporary values"); + + auto &list_ptr = stack.back(); + if (list_ptr == nullptr) { + list_ptr = PyList_New(1); + if (!list_ptr) + pybind11_fail("loader_life_support: error allocating list"); + PyList_SET_ITEM(list_ptr, 0, h.inc_ref().ptr()); + } else { + auto result = PyList_Append(list_ptr, h.ptr()); + if (result == -1) + pybind11_fail("loader_life_support: error adding patient"); + } + } +}; + +// Gets the cache entry for the given type, creating it if necessary. The return value is the pair +// returned by emplace, i.e. an iterator for the entry and a bool set to `true` if the entry was +// just created. +inline std::pair all_type_info_get_cache(PyTypeObject *type); + +// Populates a just-created cache entry. +PYBIND11_NOINLINE inline void all_type_info_populate(PyTypeObject *t, std::vector &bases) { + std::vector check; + for (handle parent : reinterpret_borrow(t->tp_bases)) + check.push_back((PyTypeObject *) parent.ptr()); + + auto const &type_dict = get_internals().registered_types_py; + for (size_t i = 0; i < check.size(); i++) { + auto type = check[i]; + // Ignore Python2 old-style class super type: + if (!PyType_Check((PyObject *) type)) continue; + + // Check `type` in the current set of registered python types: + auto it = type_dict.find(type); + if (it != type_dict.end()) { + // We found a cache entry for it, so it's either pybind-registered or has pre-computed + // pybind bases, but we have to make sure we haven't already seen the type(s) before: we + // want to follow Python/virtual C++ rules that there should only be one instance of a + // common base. + for (auto *tinfo : it->second) { + // NB: Could use a second set here, rather than doing a linear search, but since + // having a large number of immediate pybind11-registered types seems fairly + // unlikely, that probably isn't worthwhile. + bool found = false; + for (auto *known : bases) { + if (known == tinfo) { found = true; break; } + } + if (!found) bases.push_back(tinfo); + } + } + else if (type->tp_bases) { + // It's some python type, so keep follow its bases classes to look for one or more + // registered types + if (i + 1 == check.size()) { + // When we're at the end, we can pop off the current element to avoid growing + // `check` when adding just one base (which is typical--i.e. when there is no + // multiple inheritance) + check.pop_back(); + i--; + } + for (handle parent : reinterpret_borrow(type->tp_bases)) + check.push_back((PyTypeObject *) parent.ptr()); + } + } +} + +/** + * Extracts vector of type_info pointers of pybind-registered roots of the given Python type. Will + * be just 1 pybind type for the Python type of a pybind-registered class, or for any Python-side + * derived class that uses single inheritance. Will contain as many types as required for a Python + * class that uses multiple inheritance to inherit (directly or indirectly) from multiple + * pybind-registered classes. Will be empty if neither the type nor any base classes are + * pybind-registered. + * + * The value is cached for the lifetime of the Python type. + */ +inline const std::vector &all_type_info(PyTypeObject *type) { + auto ins = all_type_info_get_cache(type); + if (ins.second) + // New cache entry: populate it + all_type_info_populate(type, ins.first->second); + + return ins.first->second; +} + +/** + * Gets a single pybind11 type info for a python type. Returns nullptr if neither the type nor any + * ancestors are pybind11-registered. Throws an exception if there are multiple bases--use + * `all_type_info` instead if you want to support multiple bases. + */ +PYBIND11_NOINLINE inline detail::type_info* get_type_info(PyTypeObject *type) { + auto &bases = all_type_info(type); + if (bases.size() == 0) + return nullptr; + if (bases.size() > 1) + pybind11_fail("pybind11::detail::get_type_info: type has multiple pybind11-registered bases"); + return bases.front(); +} + +inline detail::type_info *get_local_type_info(const std::type_index &tp) { + auto &locals = registered_local_types_cpp(); + auto it = locals.find(tp); + if (it != locals.end()) + return it->second; + return nullptr; +} + +inline detail::type_info *get_global_type_info(const std::type_index &tp) { + auto &types = get_internals().registered_types_cpp; + auto it = types.find(tp); + if (it != types.end()) + return it->second; + return nullptr; +} + +/// Return the type info for a given C++ type; on lookup failure can either throw or return nullptr. +PYBIND11_NOINLINE inline detail::type_info *get_type_info(const std::type_index &tp, + bool throw_if_missing = false) { + if (auto ltype = get_local_type_info(tp)) + return ltype; + if (auto gtype = get_global_type_info(tp)) + return gtype; + + if (throw_if_missing) { + std::string tname = tp.name(); + detail::clean_type_id(tname); + pybind11_fail("pybind11::detail::get_type_info: unable to find type info for \"" + tname + "\""); + } + return nullptr; +} + +PYBIND11_NOINLINE inline handle get_type_handle(const std::type_info &tp, bool throw_if_missing) { + detail::type_info *type_info = get_type_info(tp, throw_if_missing); + return handle(type_info ? ((PyObject *) type_info->type) : nullptr); +} + +struct value_and_holder { + instance *inst; + size_t index; + const detail::type_info *type; + void **vh; + + // Main constructor for a found value/holder: + value_and_holder(instance *i, const detail::type_info *type, size_t vpos, size_t index) : + inst{i}, index{index}, type{type}, + vh{inst->simple_layout ? inst->simple_value_holder : &inst->nonsimple.values_and_holders[vpos]} + {} + + // Default constructor (used to signal a value-and-holder not found by get_value_and_holder()) + value_and_holder() : inst{nullptr} {} + + // Used for past-the-end iterator + value_and_holder(size_t index) : index{index} {} + + template V *&value_ptr() const { + return reinterpret_cast(vh[0]); + } + // True if this `value_and_holder` has a non-null value pointer + explicit operator bool() const { return value_ptr(); } + + template H &holder() const { + return reinterpret_cast(vh[1]); + } + bool holder_constructed() const { + return inst->simple_layout + ? inst->simple_holder_constructed + : inst->nonsimple.status[index] & instance::status_holder_constructed; + } + void set_holder_constructed(bool v = true) { + if (inst->simple_layout) + inst->simple_holder_constructed = v; + else if (v) + inst->nonsimple.status[index] |= instance::status_holder_constructed; + else + inst->nonsimple.status[index] &= (uint8_t) ~instance::status_holder_constructed; + } + bool instance_registered() const { + return inst->simple_layout + ? inst->simple_instance_registered + : inst->nonsimple.status[index] & instance::status_instance_registered; + } + void set_instance_registered(bool v = true) { + if (inst->simple_layout) + inst->simple_instance_registered = v; + else if (v) + inst->nonsimple.status[index] |= instance::status_instance_registered; + else + inst->nonsimple.status[index] &= (uint8_t) ~instance::status_instance_registered; + } +}; + +// Container for accessing and iterating over an instance's values/holders +struct values_and_holders { +private: + instance *inst; + using type_vec = std::vector; + const type_vec &tinfo; + +public: + values_and_holders(instance *inst) : inst{inst}, tinfo(all_type_info(Py_TYPE(inst))) {} + + struct iterator { + private: + instance *inst; + const type_vec *types; + value_and_holder curr; + friend struct values_and_holders; + iterator(instance *inst, const type_vec *tinfo) + : inst{inst}, types{tinfo}, + curr(inst /* instance */, + types->empty() ? nullptr : (*types)[0] /* type info */, + 0, /* vpos: (non-simple types only): the first vptr comes first */ + 0 /* index */) + {} + // Past-the-end iterator: + iterator(size_t end) : curr(end) {} + public: + bool operator==(const iterator &other) { return curr.index == other.curr.index; } + bool operator!=(const iterator &other) { return curr.index != other.curr.index; } + iterator &operator++() { + if (!inst->simple_layout) + curr.vh += 1 + (*types)[curr.index]->holder_size_in_ptrs; + ++curr.index; + curr.type = curr.index < types->size() ? (*types)[curr.index] : nullptr; + return *this; + } + value_and_holder &operator*() { return curr; } + value_and_holder *operator->() { return &curr; } + }; + + iterator begin() { return iterator(inst, &tinfo); } + iterator end() { return iterator(tinfo.size()); } + + iterator find(const type_info *find_type) { + auto it = begin(), endit = end(); + while (it != endit && it->type != find_type) ++it; + return it; + } + + size_t size() { return tinfo.size(); } +}; + +/** + * Extracts C++ value and holder pointer references from an instance (which may contain multiple + * values/holders for python-side multiple inheritance) that match the given type. Throws an error + * if the given type (or ValueType, if omitted) is not a pybind11 base of the given instance. If + * `find_type` is omitted (or explicitly specified as nullptr) the first value/holder are returned, + * regardless of type (and the resulting .type will be nullptr). + * + * The returned object should be short-lived: in particular, it must not outlive the called-upon + * instance. + */ +PYBIND11_NOINLINE inline value_and_holder instance::get_value_and_holder(const type_info *find_type /*= nullptr default in common.h*/, bool throw_if_missing /*= true in common.h*/) { + // Optimize common case: + if (!find_type || Py_TYPE(this) == find_type->type) + return value_and_holder(this, find_type, 0, 0); + + detail::values_and_holders vhs(this); + auto it = vhs.find(find_type); + if (it != vhs.end()) + return *it; + + if (!throw_if_missing) + return value_and_holder(); + +#if defined(NDEBUG) + pybind11_fail("pybind11::detail::instance::get_value_and_holder: " + "type is not a pybind11 base of the given instance " + "(compile in debug mode for type details)"); +#else + pybind11_fail("pybind11::detail::instance::get_value_and_holder: `" + + std::string(find_type->type->tp_name) + "' is not a pybind11 base of the given `" + + std::string(Py_TYPE(this)->tp_name) + "' instance"); +#endif +} + +PYBIND11_NOINLINE inline void instance::allocate_layout() { + auto &tinfo = all_type_info(Py_TYPE(this)); + + const size_t n_types = tinfo.size(); + + if (n_types == 0) + pybind11_fail("instance allocation failed: new instance has no pybind11-registered base types"); + + simple_layout = + n_types == 1 && tinfo.front()->holder_size_in_ptrs <= instance_simple_holder_in_ptrs(); + + // Simple path: no python-side multiple inheritance, and a small-enough holder + if (simple_layout) { + simple_value_holder[0] = nullptr; + simple_holder_constructed = false; + simple_instance_registered = false; + } + else { // multiple base types or a too-large holder + // Allocate space to hold: [v1*][h1][v2*][h2]...[bb...] where [vN*] is a value pointer, + // [hN] is the (uninitialized) holder instance for value N, and [bb...] is a set of bool + // values that tracks whether each associated holder has been initialized. Each [block] is + // padded, if necessary, to an integer multiple of sizeof(void *). + size_t space = 0; + for (auto t : tinfo) { + space += 1; // value pointer + space += t->holder_size_in_ptrs; // holder instance + } + size_t flags_at = space; + space += size_in_ptrs(n_types); // status bytes (holder_constructed and instance_registered) + + // Allocate space for flags, values, and holders, and initialize it to 0 (flags and values, + // in particular, need to be 0). Use Python's memory allocation functions: in Python 3.6 + // they default to using pymalloc, which is designed to be efficient for small allocations + // like the one we're doing here; in earlier versions (and for larger allocations) they are + // just wrappers around malloc. +#if PY_VERSION_HEX >= 0x03050000 + nonsimple.values_and_holders = (void **) PyMem_Calloc(space, sizeof(void *)); + if (!nonsimple.values_and_holders) throw std::bad_alloc(); +#else + nonsimple.values_and_holders = (void **) PyMem_New(void *, space); + if (!nonsimple.values_and_holders) throw std::bad_alloc(); + std::memset(nonsimple.values_and_holders, 0, space * sizeof(void *)); +#endif + nonsimple.status = reinterpret_cast(&nonsimple.values_and_holders[flags_at]); + } + owned = true; +} + +PYBIND11_NOINLINE inline void instance::deallocate_layout() { + if (!simple_layout) + PyMem_Free(nonsimple.values_and_holders); +} + +PYBIND11_NOINLINE inline bool isinstance_generic(handle obj, const std::type_info &tp) { + handle type = detail::get_type_handle(tp, false); + if (!type) + return false; + return isinstance(obj, type); +} + +PYBIND11_NOINLINE inline std::string error_string() { + if (!PyErr_Occurred()) { + PyErr_SetString(PyExc_RuntimeError, "Unknown internal error occurred"); + return "Unknown internal error occurred"; + } + + error_scope scope; // Preserve error state + + std::string errorString; + if (scope.type) { + errorString += handle(scope.type).attr("__name__").cast(); + errorString += ": "; + } + if (scope.value) + errorString += (std::string) str(scope.value); + + PyErr_NormalizeException(&scope.type, &scope.value, &scope.trace); + +#if PY_MAJOR_VERSION >= 3 + if (scope.trace != nullptr) + PyException_SetTraceback(scope.value, scope.trace); +#endif + +#if !defined(PYPY_VERSION) + if (scope.trace) { + PyTracebackObject *trace = (PyTracebackObject *) scope.trace; + + /* Get the deepest trace possible */ + while (trace->tb_next) + trace = trace->tb_next; + + PyFrameObject *frame = trace->tb_frame; + errorString += "\n\nAt:\n"; + while (frame) { + int lineno = PyFrame_GetLineNumber(frame); + errorString += + " " + handle(frame->f_code->co_filename).cast() + + "(" + std::to_string(lineno) + "): " + + handle(frame->f_code->co_name).cast() + "\n"; + frame = frame->f_back; + } + } +#endif + + return errorString; +} + +PYBIND11_NOINLINE inline handle get_object_handle(const void *ptr, const detail::type_info *type ) { + auto &instances = get_internals().registered_instances; + auto range = instances.equal_range(ptr); + for (auto it = range.first; it != range.second; ++it) { + for (auto vh : values_and_holders(it->second)) { + if (vh.type == type) + return handle((PyObject *) it->second); + } + } + return handle(); +} + +inline PyThreadState *get_thread_state_unchecked() { +#if defined(PYPY_VERSION) + return PyThreadState_GET(); +#elif PY_VERSION_HEX < 0x03000000 + return _PyThreadState_Current; +#elif PY_VERSION_HEX < 0x03050000 + return (PyThreadState*) _Py_atomic_load_relaxed(&_PyThreadState_Current); +#elif PY_VERSION_HEX < 0x03050200 + return (PyThreadState*) _PyThreadState_Current.value; +#else + return _PyThreadState_UncheckedGet(); +#endif +} + +// Forward declarations +inline void keep_alive_impl(handle nurse, handle patient); +inline PyObject *make_new_instance(PyTypeObject *type); + +class type_caster_generic { +public: + PYBIND11_NOINLINE type_caster_generic(const std::type_info &type_info) + : typeinfo(get_type_info(type_info)), cpptype(&type_info) { } + + type_caster_generic(const type_info *typeinfo) + : typeinfo(typeinfo), cpptype(typeinfo ? typeinfo->cpptype : nullptr) { } + + bool load(handle src, bool convert) { + return load_impl(src, convert); + } + + PYBIND11_NOINLINE static handle cast(const void *_src, return_value_policy policy, handle parent, + const detail::type_info *tinfo, + void *(*copy_constructor)(const void *), + void *(*move_constructor)(const void *), + const void *existing_holder = nullptr) { + if (!tinfo) // no type info: error will be set already + return handle(); + + void *src = const_cast(_src); + if (src == nullptr) + return none().release(); + + auto it_instances = get_internals().registered_instances.equal_range(src); + for (auto it_i = it_instances.first; it_i != it_instances.second; ++it_i) { + for (auto instance_type : detail::all_type_info(Py_TYPE(it_i->second))) { + if (instance_type && same_type(*instance_type->cpptype, *tinfo->cpptype)) + return handle((PyObject *) it_i->second).inc_ref(); + } + } + + auto inst = reinterpret_steal(make_new_instance(tinfo->type)); + auto wrapper = reinterpret_cast(inst.ptr()); + wrapper->owned = false; + void *&valueptr = values_and_holders(wrapper).begin()->value_ptr(); + + switch (policy) { + case return_value_policy::automatic: + case return_value_policy::take_ownership: + valueptr = src; + wrapper->owned = true; + break; + + case return_value_policy::automatic_reference: + case return_value_policy::reference: + valueptr = src; + wrapper->owned = false; + break; + + case return_value_policy::copy: + if (copy_constructor) + valueptr = copy_constructor(src); + else + throw cast_error("return_value_policy = copy, but the " + "object is non-copyable!"); + wrapper->owned = true; + break; + + case return_value_policy::move: + if (move_constructor) + valueptr = move_constructor(src); + else if (copy_constructor) + valueptr = copy_constructor(src); + else + throw cast_error("return_value_policy = move, but the " + "object is neither movable nor copyable!"); + wrapper->owned = true; + break; + + case return_value_policy::reference_internal: + valueptr = src; + wrapper->owned = false; + keep_alive_impl(inst, parent); + break; + + default: + throw cast_error("unhandled return_value_policy: should not happen!"); + } + + tinfo->init_instance(wrapper, existing_holder); + + return inst.release(); + } + + // Base methods for generic caster; there are overridden in copyable_holder_caster + void load_value(value_and_holder &&v_h) { + auto *&vptr = v_h.value_ptr(); + // Lazy allocation for unallocated values: + if (vptr == nullptr) { + auto *type = v_h.type ? v_h.type : typeinfo; + vptr = type->operator_new(type->type_size); + } + value = vptr; + } + bool try_implicit_casts(handle src, bool convert) { + for (auto &cast : typeinfo->implicit_casts) { + type_caster_generic sub_caster(*cast.first); + if (sub_caster.load(src, convert)) { + value = cast.second(sub_caster.value); + return true; + } + } + return false; + } + bool try_direct_conversions(handle src) { + for (auto &converter : *typeinfo->direct_conversions) { + if (converter(src.ptr(), value)) + return true; + } + return false; + } + void check_holder_compat() {} + + PYBIND11_NOINLINE static void *local_load(PyObject *src, const type_info *ti) { + auto caster = type_caster_generic(ti); + if (caster.load(src, false)) + return caster.value; + return nullptr; + } + + /// Try to load with foreign typeinfo, if available. Used when there is no + /// native typeinfo, or when the native one wasn't able to produce a value. + PYBIND11_NOINLINE bool try_load_foreign_module_local(handle src) { + constexpr auto *local_key = PYBIND11_MODULE_LOCAL_ID; + const auto pytype = src.get_type(); + if (!hasattr(pytype, local_key)) + return false; + + type_info *foreign_typeinfo = reinterpret_borrow(getattr(pytype, local_key)); + // Only consider this foreign loader if actually foreign and is a loader of the correct cpp type + if (foreign_typeinfo->module_local_load == &local_load + || (cpptype && !same_type(*cpptype, *foreign_typeinfo->cpptype))) + return false; + + if (auto result = foreign_typeinfo->module_local_load(src.ptr(), foreign_typeinfo)) { + value = result; + return true; + } + return false; + } + + // Implementation of `load`; this takes the type of `this` so that it can dispatch the relevant + // bits of code between here and copyable_holder_caster where the two classes need different + // logic (without having to resort to virtual inheritance). + template + PYBIND11_NOINLINE bool load_impl(handle src, bool convert) { + if (!src) return false; + if (!typeinfo) return try_load_foreign_module_local(src); + if (src.is_none()) { + // Defer accepting None to other overloads (if we aren't in convert mode): + if (!convert) return false; + value = nullptr; + return true; + } + + auto &this_ = static_cast(*this); + this_.check_holder_compat(); + + PyTypeObject *srctype = Py_TYPE(src.ptr()); + + // Case 1: If src is an exact type match for the target type then we can reinterpret_cast + // the instance's value pointer to the target type: + if (srctype == typeinfo->type) { + this_.load_value(reinterpret_cast(src.ptr())->get_value_and_holder()); + return true; + } + // Case 2: We have a derived class + else if (PyType_IsSubtype(srctype, typeinfo->type)) { + auto &bases = all_type_info(srctype); + bool no_cpp_mi = typeinfo->simple_type; + + // Case 2a: the python type is a Python-inherited derived class that inherits from just + // one simple (no MI) pybind11 class, or is an exact match, so the C++ instance is of + // the right type and we can use reinterpret_cast. + // (This is essentially the same as case 2b, but because not using multiple inheritance + // is extremely common, we handle it specially to avoid the loop iterator and type + // pointer lookup overhead) + if (bases.size() == 1 && (no_cpp_mi || bases.front()->type == typeinfo->type)) { + this_.load_value(reinterpret_cast(src.ptr())->get_value_and_holder()); + return true; + } + // Case 2b: the python type inherits from multiple C++ bases. Check the bases to see if + // we can find an exact match (or, for a simple C++ type, an inherited match); if so, we + // can safely reinterpret_cast to the relevant pointer. + else if (bases.size() > 1) { + for (auto base : bases) { + if (no_cpp_mi ? PyType_IsSubtype(base->type, typeinfo->type) : base->type == typeinfo->type) { + this_.load_value(reinterpret_cast(src.ptr())->get_value_and_holder(base)); + return true; + } + } + } + + // Case 2c: C++ multiple inheritance is involved and we couldn't find an exact type match + // in the registered bases, above, so try implicit casting (needed for proper C++ casting + // when MI is involved). + if (this_.try_implicit_casts(src, convert)) + return true; + } + + // Perform an implicit conversion + if (convert) { + for (auto &converter : typeinfo->implicit_conversions) { + auto temp = reinterpret_steal(converter(src.ptr(), typeinfo->type)); + if (load_impl(temp, false)) { + loader_life_support::add_patient(temp); + return true; + } + } + if (this_.try_direct_conversions(src)) + return true; + } + + // Failed to match local typeinfo. Try again with global. + if (typeinfo->module_local) { + if (auto gtype = get_global_type_info(*typeinfo->cpptype)) { + typeinfo = gtype; + return load(src, false); + } + } + + // Global typeinfo has precedence over foreign module_local + return try_load_foreign_module_local(src); + } + + + // Called to do type lookup and wrap the pointer and type in a pair when a dynamic_cast + // isn't needed or can't be used. If the type is unknown, sets the error and returns a pair + // with .second = nullptr. (p.first = nullptr is not an error: it becomes None). + PYBIND11_NOINLINE static std::pair src_and_type( + const void *src, const std::type_info &cast_type, const std::type_info *rtti_type = nullptr) { + if (auto *tpi = get_type_info(cast_type)) + return {src, const_cast(tpi)}; + + // Not found, set error: + std::string tname = rtti_type ? rtti_type->name() : cast_type.name(); + detail::clean_type_id(tname); + std::string msg = "Unregistered type : " + tname; + PyErr_SetString(PyExc_TypeError, msg.c_str()); + return {nullptr, nullptr}; + } + + const type_info *typeinfo = nullptr; + const std::type_info *cpptype = nullptr; + void *value = nullptr; +}; + +/** + * Determine suitable casting operator for pointer-or-lvalue-casting type casters. The type caster + * needs to provide `operator T*()` and `operator T&()` operators. + * + * If the type supports moving the value away via an `operator T&&() &&` method, it should use + * `movable_cast_op_type` instead. + */ +template +using cast_op_type = + conditional_t>::value, + typename std::add_pointer>::type, + typename std::add_lvalue_reference>::type>; + +/** + * Determine suitable casting operator for a type caster with a movable value. Such a type caster + * needs to provide `operator T*()`, `operator T&()`, and `operator T&&() &&`. The latter will be + * called in appropriate contexts where the value can be moved rather than copied. + * + * These operator are automatically provided when using the PYBIND11_TYPE_CASTER macro. + */ +template +using movable_cast_op_type = + conditional_t::type>::value, + typename std::add_pointer>::type, + conditional_t::value, + typename std::add_rvalue_reference>::type, + typename std::add_lvalue_reference>::type>>; + +// std::is_copy_constructible isn't quite enough: it lets std::vector (and similar) through when +// T is non-copyable, but code containing such a copy constructor fails to actually compile. +template struct is_copy_constructible : std::is_copy_constructible {}; + +// Specialization for types that appear to be copy constructible but also look like stl containers +// (we specifically check for: has `value_type` and `reference` with `reference = value_type&`): if +// so, copy constructability depends on whether the value_type is copy constructible. +template struct is_copy_constructible, + std::is_same + >::value>> : is_copy_constructible {}; + +#if !defined(PYBIND11_CPP17) +// Likewise for std::pair before C++17 (which mandates that the copy constructor not exist when the +// two types aren't themselves copy constructible). +template struct is_copy_constructible> + : all_of, is_copy_constructible> {}; +#endif + +/// Generic type caster for objects stored on the heap +template class type_caster_base : public type_caster_generic { + using itype = intrinsic_t; +public: + static PYBIND11_DESCR name() { return type_descr(_()); } + + type_caster_base() : type_caster_base(typeid(type)) { } + explicit type_caster_base(const std::type_info &info) : type_caster_generic(info) { } + + static handle cast(const itype &src, return_value_policy policy, handle parent) { + if (policy == return_value_policy::automatic || policy == return_value_policy::automatic_reference) + policy = return_value_policy::copy; + return cast(&src, policy, parent); + } + + static handle cast(itype &&src, return_value_policy, handle parent) { + return cast(&src, return_value_policy::move, parent); + } + + // Returns a (pointer, type_info) pair taking care of necessary RTTI type lookup for a + // polymorphic type. If the instance isn't derived, returns the non-RTTI base version. + template ::value, int> = 0> + static std::pair src_and_type(const itype *src) { + const void *vsrc = src; + auto &cast_type = typeid(itype); + const std::type_info *instance_type = nullptr; + if (vsrc) { + instance_type = &typeid(*src); + if (!same_type(cast_type, *instance_type)) { + // This is a base pointer to a derived type; if it is a pybind11-registered type, we + // can get the correct derived pointer (which may be != base pointer) by a + // dynamic_cast to most derived type: + if (auto *tpi = get_type_info(*instance_type)) + return {dynamic_cast(src), const_cast(tpi)}; + } + } + // Otherwise we have either a nullptr, an `itype` pointer, or an unknown derived pointer, so + // don't do a cast + return type_caster_generic::src_and_type(vsrc, cast_type, instance_type); + } + + // Non-polymorphic type, so no dynamic casting; just call the generic version directly + template ::value, int> = 0> + static std::pair src_and_type(const itype *src) { + return type_caster_generic::src_and_type(src, typeid(itype)); + } + + static handle cast(const itype *src, return_value_policy policy, handle parent) { + auto st = src_and_type(src); + return type_caster_generic::cast( + st.first, policy, parent, st.second, + make_copy_constructor(src), make_move_constructor(src)); + } + + static handle cast_holder(const itype *src, const void *holder) { + auto st = src_and_type(src); + return type_caster_generic::cast( + st.first, return_value_policy::take_ownership, {}, st.second, + nullptr, nullptr, holder); + } + + template using cast_op_type = cast_op_type; + + operator itype*() { return (type *) value; } + operator itype&() { if (!value) throw reference_cast_error(); return *((itype *) value); } + +protected: + using Constructor = void *(*)(const void *); + + /* Only enabled when the types are {copy,move}-constructible *and* when the type + does not have a private operator new implementation. */ + template ::value>> + static auto make_copy_constructor(const T *x) -> decltype(new T(*x), Constructor{}) { + return [](const void *arg) -> void * { + return new T(*reinterpret_cast(arg)); + }; + } + + template ::value>> + static auto make_move_constructor(const T *x) -> decltype(new T(std::move(*const_cast(x))), Constructor{}) { + return [](const void *arg) -> void * { + return new T(std::move(*const_cast(reinterpret_cast(arg)))); + }; + } + + static Constructor make_copy_constructor(...) { return nullptr; } + static Constructor make_move_constructor(...) { return nullptr; } +}; + +template class type_caster : public type_caster_base { }; +template using make_caster = type_caster>; + +// Shortcut for calling a caster's `cast_op_type` cast operator for casting a type_caster to a T +template typename make_caster::template cast_op_type cast_op(make_caster &caster) { + return caster.operator typename make_caster::template cast_op_type(); +} +template typename make_caster::template cast_op_type::type> +cast_op(make_caster &&caster) { + return std::move(caster).operator + typename make_caster::template cast_op_type::type>(); +} + +template class type_caster> { +private: + using caster_t = make_caster; + caster_t subcaster; + using subcaster_cast_op_type = typename caster_t::template cast_op_type; + static_assert(std::is_same::type &, subcaster_cast_op_type>::value, + "std::reference_wrapper caster requires T to have a caster with an `T &` operator"); +public: + bool load(handle src, bool convert) { return subcaster.load(src, convert); } + static PYBIND11_DESCR name() { return caster_t::name(); } + static handle cast(const std::reference_wrapper &src, return_value_policy policy, handle parent) { + // It is definitely wrong to take ownership of this pointer, so mask that rvp + if (policy == return_value_policy::take_ownership || policy == return_value_policy::automatic) + policy = return_value_policy::automatic_reference; + return caster_t::cast(&src.get(), policy, parent); + } + template using cast_op_type = std::reference_wrapper; + operator std::reference_wrapper() { return subcaster.operator subcaster_cast_op_type&(); } +}; + +#define PYBIND11_TYPE_CASTER(type, py_name) \ + protected: \ + type value; \ + public: \ + static PYBIND11_DESCR name() { return type_descr(py_name); } \ + template >::value, int> = 0> \ + static handle cast(T_ *src, return_value_policy policy, handle parent) { \ + if (!src) return none().release(); \ + if (policy == return_value_policy::take_ownership) { \ + auto h = cast(std::move(*src), policy, parent); delete src; return h; \ + } else { \ + return cast(*src, policy, parent); \ + } \ + } \ + operator type*() { return &value; } \ + operator type&() { return value; } \ + operator type&&() && { return std::move(value); } \ + template using cast_op_type = pybind11::detail::movable_cast_op_type + + +template using is_std_char_type = any_of< + std::is_same, /* std::string */ + std::is_same, /* std::u16string */ + std::is_same, /* std::u32string */ + std::is_same /* std::wstring */ +>; + +template +struct type_caster::value && !is_std_char_type::value>> { + using _py_type_0 = conditional_t; + using _py_type_1 = conditional_t::value, _py_type_0, typename std::make_unsigned<_py_type_0>::type>; + using py_type = conditional_t::value, double, _py_type_1>; +public: + + bool load(handle src, bool convert) { + py_type py_value; + + if (!src) + return false; + + if (std::is_floating_point::value) { + if (convert || PyFloat_Check(src.ptr())) + py_value = (py_type) PyFloat_AsDouble(src.ptr()); + else + return false; + } else if (PyFloat_Check(src.ptr())) { + return false; + } else if (std::is_unsigned::value) { + py_value = as_unsigned(src.ptr()); + } else { // signed integer: + py_value = sizeof(T) <= sizeof(long) + ? (py_type) PyLong_AsLong(src.ptr()) + : (py_type) PYBIND11_LONG_AS_LONGLONG(src.ptr()); + } + + bool py_err = py_value == (py_type) -1 && PyErr_Occurred(); + if (py_err || (std::is_integral::value && sizeof(py_type) != sizeof(T) && + (py_value < (py_type) std::numeric_limits::min() || + py_value > (py_type) std::numeric_limits::max()))) { + bool type_error = py_err && PyErr_ExceptionMatches( +#if PY_VERSION_HEX < 0x03000000 && !defined(PYPY_VERSION) + PyExc_SystemError +#else + PyExc_TypeError +#endif + ); + PyErr_Clear(); + if (type_error && convert && PyNumber_Check(src.ptr())) { + auto tmp = reinterpret_steal(std::is_floating_point::value + ? PyNumber_Float(src.ptr()) + : PyNumber_Long(src.ptr())); + PyErr_Clear(); + return load(tmp, false); + } + return false; + } + + value = (T) py_value; + return true; + } + + static handle cast(T src, return_value_policy /* policy */, handle /* parent */) { + if (std::is_floating_point::value) { + return PyFloat_FromDouble((double) src); + } else if (sizeof(T) <= sizeof(long)) { + if (std::is_signed::value) + return PyLong_FromLong((long) src); + else + return PyLong_FromUnsignedLong((unsigned long) src); + } else { + if (std::is_signed::value) + return PyLong_FromLongLong((long long) src); + else + return PyLong_FromUnsignedLongLong((unsigned long long) src); + } + } + + PYBIND11_TYPE_CASTER(T, _::value>("int", "float")); +}; + +template struct void_caster { +public: + bool load(handle src, bool) { + if (src && src.is_none()) + return true; + return false; + } + static handle cast(T, return_value_policy /* policy */, handle /* parent */) { + return none().inc_ref(); + } + PYBIND11_TYPE_CASTER(T, _("None")); +}; + +template <> class type_caster : public void_caster {}; + +template <> class type_caster : public type_caster { +public: + using type_caster::cast; + + bool load(handle h, bool) { + if (!h) { + return false; + } else if (h.is_none()) { + value = nullptr; + return true; + } + + /* Check if this is a capsule */ + if (isinstance(h)) { + value = reinterpret_borrow(h); + return true; + } + + /* Check if this is a C++ type */ + auto &bases = all_type_info((PyTypeObject *) h.get_type().ptr()); + if (bases.size() == 1) { // Only allowing loading from a single-value type + value = values_and_holders(reinterpret_cast(h.ptr())).begin()->value_ptr(); + return true; + } + + /* Fail */ + return false; + } + + static handle cast(const void *ptr, return_value_policy /* policy */, handle /* parent */) { + if (ptr) + return capsule(ptr).release(); + else + return none().inc_ref(); + } + + template using cast_op_type = void*&; + operator void *&() { return value; } + static PYBIND11_DESCR name() { return type_descr(_("capsule")); } +private: + void *value = nullptr; +}; + +template <> class type_caster : public void_caster { }; + +template <> class type_caster { +public: + bool load(handle src, bool convert) { + if (!src) return false; + else if (src.ptr() == Py_True) { value = true; return true; } + else if (src.ptr() == Py_False) { value = false; return true; } + else if (convert || !strcmp("numpy.bool_", Py_TYPE(src.ptr())->tp_name)) { + // (allow non-implicit conversion for numpy booleans) + + Py_ssize_t res = -1; + if (src.is_none()) { + res = 0; // None is implicitly converted to False + } + #if defined(PYPY_VERSION) + // On PyPy, check that "__bool__" (or "__nonzero__" on Python 2.7) attr exists + else if (hasattr(src, PYBIND11_BOOL_ATTR)) { + res = PyObject_IsTrue(src.ptr()); + } + #else + // Alternate approach for CPython: this does the same as the above, but optimized + // using the CPython API so as to avoid an unneeded attribute lookup. + else if (auto tp_as_number = src.ptr()->ob_type->tp_as_number) { + if (PYBIND11_NB_BOOL(tp_as_number)) { + res = (*PYBIND11_NB_BOOL(tp_as_number))(src.ptr()); + } + } + #endif + if (res == 0 || res == 1) { + value = (bool) res; + return true; + } + } + return false; + } + static handle cast(bool src, return_value_policy /* policy */, handle /* parent */) { + return handle(src ? Py_True : Py_False).inc_ref(); + } + PYBIND11_TYPE_CASTER(bool, _("bool")); +}; + +// Helper class for UTF-{8,16,32} C++ stl strings: +template struct string_caster { + using CharT = typename StringType::value_type; + + // Simplify life by being able to assume standard char sizes (the standard only guarantees + // minimums, but Python requires exact sizes) + static_assert(!std::is_same::value || sizeof(CharT) == 1, "Unsupported char size != 1"); + static_assert(!std::is_same::value || sizeof(CharT) == 2, "Unsupported char16_t size != 2"); + static_assert(!std::is_same::value || sizeof(CharT) == 4, "Unsupported char32_t size != 4"); + // wchar_t can be either 16 bits (Windows) or 32 (everywhere else) + static_assert(!std::is_same::value || sizeof(CharT) == 2 || sizeof(CharT) == 4, + "Unsupported wchar_t size != 2/4"); + static constexpr size_t UTF_N = 8 * sizeof(CharT); + + bool load(handle src, bool) { +#if PY_MAJOR_VERSION < 3 + object temp; +#endif + handle load_src = src; + if (!src) { + return false; + } else if (!PyUnicode_Check(load_src.ptr())) { +#if PY_MAJOR_VERSION >= 3 + return load_bytes(load_src); +#else + if (sizeof(CharT) == 1) { + return load_bytes(load_src); + } + + // The below is a guaranteed failure in Python 3 when PyUnicode_Check returns false + if (!PYBIND11_BYTES_CHECK(load_src.ptr())) + return false; + + temp = reinterpret_steal(PyUnicode_FromObject(load_src.ptr())); + if (!temp) { PyErr_Clear(); return false; } + load_src = temp; +#endif + } + + object utfNbytes = reinterpret_steal(PyUnicode_AsEncodedString( + load_src.ptr(), UTF_N == 8 ? "utf-8" : UTF_N == 16 ? "utf-16" : "utf-32", nullptr)); + if (!utfNbytes) { PyErr_Clear(); return false; } + + const CharT *buffer = reinterpret_cast(PYBIND11_BYTES_AS_STRING(utfNbytes.ptr())); + size_t length = (size_t) PYBIND11_BYTES_SIZE(utfNbytes.ptr()) / sizeof(CharT); + if (UTF_N > 8) { buffer++; length--; } // Skip BOM for UTF-16/32 + value = StringType(buffer, length); + + // If we're loading a string_view we need to keep the encoded Python object alive: + if (IsView) + loader_life_support::add_patient(utfNbytes); + + return true; + } + + static handle cast(const StringType &src, return_value_policy /* policy */, handle /* parent */) { + const char *buffer = reinterpret_cast(src.data()); + ssize_t nbytes = ssize_t(src.size() * sizeof(CharT)); + handle s = decode_utfN(buffer, nbytes); + if (!s) throw error_already_set(); + return s; + } + + PYBIND11_TYPE_CASTER(StringType, _(PYBIND11_STRING_NAME)); + +private: + static handle decode_utfN(const char *buffer, ssize_t nbytes) { +#if !defined(PYPY_VERSION) + return + UTF_N == 8 ? PyUnicode_DecodeUTF8(buffer, nbytes, nullptr) : + UTF_N == 16 ? PyUnicode_DecodeUTF16(buffer, nbytes, nullptr, nullptr) : + PyUnicode_DecodeUTF32(buffer, nbytes, nullptr, nullptr); +#else + // PyPy seems to have multiple problems related to PyUnicode_UTF*: the UTF8 version + // sometimes segfaults for unknown reasons, while the UTF16 and 32 versions require a + // non-const char * arguments, which is also a nuisance, so bypass the whole thing by just + // passing the encoding as a string value, which works properly: + return PyUnicode_Decode(buffer, nbytes, UTF_N == 8 ? "utf-8" : UTF_N == 16 ? "utf-16" : "utf-32", nullptr); +#endif + } + + // When loading into a std::string or char*, accept a bytes object as-is (i.e. + // without any encoding/decoding attempt). For other C++ char sizes this is a no-op. + // which supports loading a unicode from a str, doesn't take this path. + template + bool load_bytes(enable_if_t src) { + if (PYBIND11_BYTES_CHECK(src.ptr())) { + // We were passed a Python 3 raw bytes; accept it into a std::string or char* + // without any encoding attempt. + const char *bytes = PYBIND11_BYTES_AS_STRING(src.ptr()); + if (bytes) { + value = StringType(bytes, (size_t) PYBIND11_BYTES_SIZE(src.ptr())); + return true; + } + } + + return false; + } + + template + bool load_bytes(enable_if_t) { return false; } +}; + +template +struct type_caster, enable_if_t::value>> + : string_caster> {}; + +#ifdef PYBIND11_HAS_STRING_VIEW +template +struct type_caster, enable_if_t::value>> + : string_caster, true> {}; +#endif + +// Type caster for C-style strings. We basically use a std::string type caster, but also add the +// ability to use None as a nullptr char* (which the string caster doesn't allow). +template struct type_caster::value>> { + using StringType = std::basic_string; + using StringCaster = type_caster; + StringCaster str_caster; + bool none = false; + CharT one_char = 0; +public: + bool load(handle src, bool convert) { + if (!src) return false; + if (src.is_none()) { + // Defer accepting None to other overloads (if we aren't in convert mode): + if (!convert) return false; + none = true; + return true; + } + return str_caster.load(src, convert); + } + + static handle cast(const CharT *src, return_value_policy policy, handle parent) { + if (src == nullptr) return pybind11::none().inc_ref(); + return StringCaster::cast(StringType(src), policy, parent); + } + + static handle cast(CharT src, return_value_policy policy, handle parent) { + if (std::is_same::value) { + handle s = PyUnicode_DecodeLatin1((const char *) &src, 1, nullptr); + if (!s) throw error_already_set(); + return s; + } + return StringCaster::cast(StringType(1, src), policy, parent); + } + + operator CharT*() { return none ? nullptr : const_cast(static_cast(str_caster).c_str()); } + operator CharT&() { + if (none) + throw value_error("Cannot convert None to a character"); + + auto &value = static_cast(str_caster); + size_t str_len = value.size(); + if (str_len == 0) + throw value_error("Cannot convert empty string to a character"); + + // If we're in UTF-8 mode, we have two possible failures: one for a unicode character that + // is too high, and one for multiple unicode characters (caught later), so we need to figure + // out how long the first encoded character is in bytes to distinguish between these two + // errors. We also allow want to allow unicode characters U+0080 through U+00FF, as those + // can fit into a single char value. + if (StringCaster::UTF_N == 8 && str_len > 1 && str_len <= 4) { + unsigned char v0 = static_cast(value[0]); + size_t char0_bytes = !(v0 & 0x80) ? 1 : // low bits only: 0-127 + (v0 & 0xE0) == 0xC0 ? 2 : // 0b110xxxxx - start of 2-byte sequence + (v0 & 0xF0) == 0xE0 ? 3 : // 0b1110xxxx - start of 3-byte sequence + 4; // 0b11110xxx - start of 4-byte sequence + + if (char0_bytes == str_len) { + // If we have a 128-255 value, we can decode it into a single char: + if (char0_bytes == 2 && (v0 & 0xFC) == 0xC0) { // 0x110000xx 0x10xxxxxx + one_char = static_cast(((v0 & 3) << 6) + (static_cast(value[1]) & 0x3F)); + return one_char; + } + // Otherwise we have a single character, but it's > U+00FF + throw value_error("Character code point not in range(0x100)"); + } + } + + // UTF-16 is much easier: we can only have a surrogate pair for values above U+FFFF, thus a + // surrogate pair with total length 2 instantly indicates a range error (but not a "your + // string was too long" error). + else if (StringCaster::UTF_N == 16 && str_len == 2) { + one_char = static_cast(value[0]); + if (one_char >= 0xD800 && one_char < 0xE000) + throw value_error("Character code point not in range(0x10000)"); + } + + if (str_len != 1) + throw value_error("Expected a character, but multi-character string found"); + + one_char = value[0]; + return one_char; + } + + static PYBIND11_DESCR name() { return type_descr(_(PYBIND11_STRING_NAME)); } + template using cast_op_type = pybind11::detail::cast_op_type<_T>; +}; + +// Base implementation for std::tuple and std::pair +template class Tuple, typename... Ts> class tuple_caster { + using type = Tuple; + static constexpr auto size = sizeof...(Ts); + using indices = make_index_sequence; +public: + + bool load(handle src, bool convert) { + if (!isinstance(src)) + return false; + const auto seq = reinterpret_borrow(src); + if (seq.size() != size) + return false; + return load_impl(seq, convert, indices{}); + } + + template + static handle cast(T &&src, return_value_policy policy, handle parent) { + return cast_impl(std::forward(src), policy, parent, indices{}); + } + + static PYBIND11_DESCR name() { + return type_descr(_("Tuple[") + detail::concat(make_caster::name()...) + _("]")); + } + + template using cast_op_type = type; + + operator type() & { return implicit_cast(indices{}); } + operator type() && { return std::move(*this).implicit_cast(indices{}); } + +protected: + template + type implicit_cast(index_sequence) & { return type(cast_op(std::get(subcasters))...); } + template + type implicit_cast(index_sequence) && { return type(cast_op(std::move(std::get(subcasters)))...); } + + static constexpr bool load_impl(const sequence &, bool, index_sequence<>) { return true; } + + template + bool load_impl(const sequence &seq, bool convert, index_sequence) { + for (bool r : {std::get(subcasters).load(seq[Is], convert)...}) + if (!r) + return false; + return true; + } + + /* Implementation: Convert a C++ tuple into a Python tuple */ + template + static handle cast_impl(T &&src, return_value_policy policy, handle parent, index_sequence) { + std::array entries{{ + reinterpret_steal(make_caster::cast(std::get(std::forward(src)), policy, parent))... + }}; + for (const auto &entry: entries) + if (!entry) + return handle(); + tuple result(size); + int counter = 0; + for (auto & entry: entries) + PyTuple_SET_ITEM(result.ptr(), counter++, entry.release().ptr()); + return result.release(); + } + + Tuple...> subcasters; +}; + +template class type_caster> + : public tuple_caster {}; + +template class type_caster> + : public tuple_caster {}; + +/// Helper class which abstracts away certain actions. Users can provide specializations for +/// custom holders, but it's only necessary if the type has a non-standard interface. +template +struct holder_helper { + static auto get(const T &p) -> decltype(p.get()) { return p.get(); } +}; + +/// Type caster for holder types like std::shared_ptr, etc. +template +struct copyable_holder_caster : public type_caster_base { +public: + using base = type_caster_base; + static_assert(std::is_base_of>::value, + "Holder classes are only supported for custom types"); + using base::base; + using base::cast; + using base::typeinfo; + using base::value; + + bool load(handle src, bool convert) { + return base::template load_impl>(src, convert); + } + + explicit operator type*() { return this->value; } + explicit operator type&() { return *(this->value); } + explicit operator holder_type*() { return std::addressof(holder); } + + // Workaround for Intel compiler bug + // see pybind11 issue 94 + #if defined(__ICC) || defined(__INTEL_COMPILER) + operator holder_type&() { return holder; } + #else + explicit operator holder_type&() { return holder; } + #endif + + static handle cast(const holder_type &src, return_value_policy, handle) { + const auto *ptr = holder_helper::get(src); + return type_caster_base::cast_holder(ptr, &src); + } + +protected: + friend class type_caster_generic; + void check_holder_compat() { + if (typeinfo->default_holder) + throw cast_error("Unable to load a custom holder type from a default-holder instance"); + } + + bool load_value(value_and_holder &&v_h) { + if (v_h.holder_constructed()) { + value = v_h.value_ptr(); + holder = v_h.template holder(); + return true; + } else { + throw cast_error("Unable to cast from non-held to held instance (T& to Holder) " +#if defined(NDEBUG) + "(compile in debug mode for type information)"); +#else + "of type '" + type_id() + "''"); +#endif + } + } + + template ::value, int> = 0> + bool try_implicit_casts(handle, bool) { return false; } + + template ::value, int> = 0> + bool try_implicit_casts(handle src, bool convert) { + for (auto &cast : typeinfo->implicit_casts) { + copyable_holder_caster sub_caster(*cast.first); + if (sub_caster.load(src, convert)) { + value = cast.second(sub_caster.value); + holder = holder_type(sub_caster.holder, (type *) value); + return true; + } + } + return false; + } + + static bool try_direct_conversions(handle) { return false; } + + + holder_type holder; +}; + +/// Specialize for the common std::shared_ptr, so users don't need to +template +class type_caster> : public copyable_holder_caster> { }; + +template +struct move_only_holder_caster { + static_assert(std::is_base_of, type_caster>::value, + "Holder classes are only supported for custom types"); + + static handle cast(holder_type &&src, return_value_policy, handle) { + auto *ptr = holder_helper::get(src); + return type_caster_base::cast_holder(ptr, std::addressof(src)); + } + static PYBIND11_DESCR name() { return type_caster_base::name(); } +}; + +template +class type_caster> + : public move_only_holder_caster> { }; + +template +using type_caster_holder = conditional_t::value, + copyable_holder_caster, + move_only_holder_caster>; + +template struct always_construct_holder { static constexpr bool value = Value; }; + +/// Create a specialization for custom holder types (silently ignores std::shared_ptr) +#define PYBIND11_DECLARE_HOLDER_TYPE(type, holder_type, ...) \ + namespace pybind11 { namespace detail { \ + template \ + struct always_construct_holder : always_construct_holder { }; \ + template \ + class type_caster::value>> \ + : public type_caster_holder { }; \ + }} + +// PYBIND11_DECLARE_HOLDER_TYPE holder types: +template struct is_holder_type : + std::is_base_of, detail::type_caster> {}; +// Specialization for always-supported unique_ptr holders: +template struct is_holder_type> : + std::true_type {}; + +template struct handle_type_name { static PYBIND11_DESCR name() { return _(); } }; +template <> struct handle_type_name { static PYBIND11_DESCR name() { return _(PYBIND11_BYTES_NAME); } }; +template <> struct handle_type_name { static PYBIND11_DESCR name() { return _("*args"); } }; +template <> struct handle_type_name { static PYBIND11_DESCR name() { return _("**kwargs"); } }; + +template +struct pyobject_caster { + template ::value, int> = 0> + bool load(handle src, bool /* convert */) { value = src; return static_cast(value); } + + template ::value, int> = 0> + bool load(handle src, bool /* convert */) { + if (!isinstance(src)) + return false; + value = reinterpret_borrow(src); + return true; + } + + static handle cast(const handle &src, return_value_policy /* policy */, handle /* parent */) { + return src.inc_ref(); + } + PYBIND11_TYPE_CASTER(type, handle_type_name::name()); +}; + +template +class type_caster::value>> : public pyobject_caster { }; + +// Our conditions for enabling moving are quite restrictive: +// At compile time: +// - T needs to be a non-const, non-pointer, non-reference type +// - type_caster::operator T&() must exist +// - the type must be move constructible (obviously) +// At run-time: +// - if the type is non-copy-constructible, the object must be the sole owner of the type (i.e. it +// must have ref_count() == 1)h +// If any of the above are not satisfied, we fall back to copying. +template using move_is_plain_type = satisfies_none_of; +template struct move_always : std::false_type {}; +template struct move_always, + negation>, + std::is_move_constructible, + std::is_same>().operator T&()), T&> +>::value>> : std::true_type {}; +template struct move_if_unreferenced : std::false_type {}; +template struct move_if_unreferenced, + negation>, + std::is_move_constructible, + std::is_same>().operator T&()), T&> +>::value>> : std::true_type {}; +template using move_never = none_of, move_if_unreferenced>; + +// Detect whether returning a `type` from a cast on type's type_caster is going to result in a +// reference or pointer to a local variable of the type_caster. Basically, only +// non-reference/pointer `type`s and reference/pointers from a type_caster_generic are safe; +// everything else returns a reference/pointer to a local variable. +template using cast_is_temporary_value_reference = bool_constant< + (std::is_reference::value || std::is_pointer::value) && + !std::is_base_of>::value +>; + +// When a value returned from a C++ function is being cast back to Python, we almost always want to +// force `policy = move`, regardless of the return value policy the function/method was declared +// with. +template struct return_value_policy_override { + static return_value_policy policy(return_value_policy p) { return p; } +}; + +template struct return_value_policy_override>::value, void>> { + static return_value_policy policy(return_value_policy p) { + return !std::is_lvalue_reference::value && !std::is_pointer::value + ? return_value_policy::move : p; + } +}; + +// Basic python -> C++ casting; throws if casting fails +template type_caster &load_type(type_caster &conv, const handle &handle) { + if (!conv.load(handle, true)) { +#if defined(NDEBUG) + throw cast_error("Unable to cast Python instance to C++ type (compile in debug mode for details)"); +#else + throw cast_error("Unable to cast Python instance of type " + + (std::string) str(handle.get_type()) + " to C++ type '" + type_id() + "'"); +#endif + } + return conv; +} +// Wrapper around the above that also constructs and returns a type_caster +template make_caster load_type(const handle &handle) { + make_caster conv; + load_type(conv, handle); + return conv; +} + +NAMESPACE_END(detail) + +// pytype -> C++ type +template ::value, int> = 0> +T cast(const handle &handle) { + using namespace detail; + static_assert(!cast_is_temporary_value_reference::value, + "Unable to cast type to reference: value is local to type caster"); + return cast_op(load_type(handle)); +} + +// pytype -> pytype (calls converting constructor) +template ::value, int> = 0> +T cast(const handle &handle) { return T(reinterpret_borrow(handle)); } + +// C++ type -> py::object +template ::value, int> = 0> +object cast(const T &value, return_value_policy policy = return_value_policy::automatic_reference, + handle parent = handle()) { + if (policy == return_value_policy::automatic) + policy = std::is_pointer::value ? return_value_policy::take_ownership : return_value_policy::copy; + else if (policy == return_value_policy::automatic_reference) + policy = std::is_pointer::value ? return_value_policy::reference : return_value_policy::copy; + return reinterpret_steal(detail::make_caster::cast(value, policy, parent)); +} + +template T handle::cast() const { return pybind11::cast(*this); } +template <> inline void handle::cast() const { return; } + +template +detail::enable_if_t::value, T> move(object &&obj) { + if (obj.ref_count() > 1) +#if defined(NDEBUG) + throw cast_error("Unable to cast Python instance to C++ rvalue: instance has multiple references" + " (compile in debug mode for details)"); +#else + throw cast_error("Unable to move from Python " + (std::string) str(obj.get_type()) + + " instance to C++ " + type_id() + " instance: instance has multiple references"); +#endif + + // Move into a temporary and return that, because the reference may be a local value of `conv` + T ret = std::move(detail::load_type(obj).operator T&()); + return ret; +} + +// Calling cast() on an rvalue calls pybind::cast with the object rvalue, which does: +// - If we have to move (because T has no copy constructor), do it. This will fail if the moved +// object has multiple references, but trying to copy will fail to compile. +// - If both movable and copyable, check ref count: if 1, move; otherwise copy +// - Otherwise (not movable), copy. +template detail::enable_if_t::value, T> cast(object &&object) { + return move(std::move(object)); +} +template detail::enable_if_t::value, T> cast(object &&object) { + if (object.ref_count() > 1) + return cast(object); + else + return move(std::move(object)); +} +template detail::enable_if_t::value, T> cast(object &&object) { + return cast(object); +} + +template T object::cast() const & { return pybind11::cast(*this); } +template T object::cast() && { return pybind11::cast(std::move(*this)); } +template <> inline void object::cast() const & { return; } +template <> inline void object::cast() && { return; } + +NAMESPACE_BEGIN(detail) + +// Declared in pytypes.h: +template ::value, int>> +object object_or_cast(T &&o) { return pybind11::cast(std::forward(o)); } + +struct overload_unused {}; // Placeholder type for the unneeded (and dead code) static variable in the OVERLOAD_INT macro +template using overload_caster_t = conditional_t< + cast_is_temporary_value_reference::value, make_caster, overload_unused>; + +// Trampoline use: for reference/pointer types to value-converted values, we do a value cast, then +// store the result in the given variable. For other types, this is a no-op. +template enable_if_t::value, T> cast_ref(object &&o, make_caster &caster) { + return cast_op(load_type(caster, o)); +} +template enable_if_t::value, T> cast_ref(object &&, overload_unused &) { + pybind11_fail("Internal error: cast_ref fallback invoked"); } + +// Trampoline use: Having a pybind11::cast with an invalid reference type is going to static_assert, even +// though if it's in dead code, so we provide a "trampoline" to pybind11::cast that only does anything in +// cases where pybind11::cast is valid. +template enable_if_t::value, T> cast_safe(object &&o) { + return pybind11::cast(std::move(o)); } +template enable_if_t::value, T> cast_safe(object &&) { + pybind11_fail("Internal error: cast_safe fallback invoked"); } +template <> inline void cast_safe(object &&) {} + +NAMESPACE_END(detail) + +template +tuple make_tuple() { return tuple(0); } + +template tuple make_tuple(Args&&... args_) { + constexpr size_t size = sizeof...(Args); + std::array args { + { reinterpret_steal(detail::make_caster::cast( + std::forward(args_), policy, nullptr))... } + }; + for (size_t i = 0; i < args.size(); i++) { + if (!args[i]) { +#if defined(NDEBUG) + throw cast_error("make_tuple(): unable to convert arguments to Python object (compile in debug mode for details)"); +#else + std::array argtypes { {type_id()...} }; + throw cast_error("make_tuple(): unable to convert argument of type '" + + argtypes[i] + "' to Python object"); +#endif + } + } + tuple result(size); + int counter = 0; + for (auto &arg_value : args) + PyTuple_SET_ITEM(result.ptr(), counter++, arg_value.release().ptr()); + return result; +} + +/// \ingroup annotations +/// Annotation for arguments +struct arg { + /// Constructs an argument with the name of the argument; if null or omitted, this is a positional argument. + constexpr explicit arg(const char *name = nullptr) : name(name), flag_noconvert(false), flag_none(true) { } + /// Assign a value to this argument + template arg_v operator=(T &&value) const; + /// Indicate that the type should not be converted in the type caster + arg &noconvert(bool flag = true) { flag_noconvert = flag; return *this; } + /// Indicates that the argument should/shouldn't allow None (e.g. for nullable pointer args) + arg &none(bool flag = true) { flag_none = flag; return *this; } + + const char *name; ///< If non-null, this is a named kwargs argument + bool flag_noconvert : 1; ///< If set, do not allow conversion (requires a supporting type caster!) + bool flag_none : 1; ///< If set (the default), allow None to be passed to this argument +}; + +/// \ingroup annotations +/// Annotation for arguments with values +struct arg_v : arg { +private: + template + arg_v(arg &&base, T &&x, const char *descr = nullptr) + : arg(base), + value(reinterpret_steal( + detail::make_caster::cast(x, return_value_policy::automatic, {}) + )), + descr(descr) +#if !defined(NDEBUG) + , type(type_id()) +#endif + { } + +public: + /// Direct construction with name, default, and description + template + arg_v(const char *name, T &&x, const char *descr = nullptr) + : arg_v(arg(name), std::forward(x), descr) { } + + /// Called internally when invoking `py::arg("a") = value` + template + arg_v(const arg &base, T &&x, const char *descr = nullptr) + : arg_v(arg(base), std::forward(x), descr) { } + + /// Same as `arg::noconvert()`, but returns *this as arg_v&, not arg& + arg_v &noconvert(bool flag = true) { arg::noconvert(flag); return *this; } + + /// Same as `arg::nonone()`, but returns *this as arg_v&, not arg& + arg_v &none(bool flag = true) { arg::none(flag); return *this; } + + /// The default value + object value; + /// The (optional) description of the default value + const char *descr; +#if !defined(NDEBUG) + /// The C++ type name of the default value (only available when compiled in debug mode) + std::string type; +#endif +}; + +template +arg_v arg::operator=(T &&value) const { return {std::move(*this), std::forward(value)}; } + +/// Alias for backward compatibility -- to be removed in version 2.0 +template using arg_t = arg_v; + +inline namespace literals { +/** \rst + String literal version of `arg` + \endrst */ +constexpr arg operator"" _a(const char *name, size_t) { return arg(name); } +} + +NAMESPACE_BEGIN(detail) + +// forward declaration (definition in attr.h) +struct function_record; + +/// Internal data associated with a single function call +struct function_call { + function_call(function_record &f, handle p); // Implementation in attr.h + + /// The function data: + const function_record &func; + + /// Arguments passed to the function: + std::vector args; + + /// The `convert` value the arguments should be loaded with + std::vector args_convert; + + /// Extra references for the optional `py::args` and/or `py::kwargs` arguments (which, if + /// present, are also in `args` but without a reference). + object args_ref, kwargs_ref; + + /// The parent, if any + handle parent; + + /// If this is a call to an initializer, this argument contains `self` + handle init_self; +}; + + +/// Helper class which loads arguments for C++ functions called from Python +template +class argument_loader { + using indices = make_index_sequence; + + template using argument_is_args = std::is_same, args>; + template using argument_is_kwargs = std::is_same, kwargs>; + // Get args/kwargs argument positions relative to the end of the argument list: + static constexpr auto args_pos = constexpr_first() - (int) sizeof...(Args), + kwargs_pos = constexpr_first() - (int) sizeof...(Args); + + static constexpr bool args_kwargs_are_last = kwargs_pos >= - 1 && args_pos >= kwargs_pos - 1; + + static_assert(args_kwargs_are_last, "py::args/py::kwargs are only permitted as the last argument(s) of a function"); + +public: + static constexpr bool has_kwargs = kwargs_pos < 0; + static constexpr bool has_args = args_pos < 0; + + static PYBIND11_DESCR arg_names() { return detail::concat(make_caster::name()...); } + + bool load_args(function_call &call) { + return load_impl_sequence(call, indices{}); + } + + template + enable_if_t::value, Return> call(Func &&f) && { + return std::move(*this).template call_impl(std::forward(f), indices{}, Guard{}); + } + + template + enable_if_t::value, void_type> call(Func &&f) && { + std::move(*this).template call_impl(std::forward(f), indices{}, Guard{}); + return void_type(); + } + +private: + + static bool load_impl_sequence(function_call &, index_sequence<>) { return true; } + + template + bool load_impl_sequence(function_call &call, index_sequence) { + for (bool r : {std::get(argcasters).load(call.args[Is], call.args_convert[Is])...}) + if (!r) + return false; + return true; + } + + template + Return call_impl(Func &&f, index_sequence, Guard &&) { + return std::forward(f)(cast_op(std::move(std::get(argcasters)))...); + } + + std::tuple...> argcasters; +}; + +/// Helper class which collects only positional arguments for a Python function call. +/// A fancier version below can collect any argument, but this one is optimal for simple calls. +template +class simple_collector { +public: + template + explicit simple_collector(Ts &&...values) + : m_args(pybind11::make_tuple(std::forward(values)...)) { } + + const tuple &args() const & { return m_args; } + dict kwargs() const { return {}; } + + tuple args() && { return std::move(m_args); } + + /// Call a Python function and pass the collected arguments + object call(PyObject *ptr) const { + PyObject *result = PyObject_CallObject(ptr, m_args.ptr()); + if (!result) + throw error_already_set(); + return reinterpret_steal(result); + } + +private: + tuple m_args; +}; + +/// Helper class which collects positional, keyword, * and ** arguments for a Python function call +template +class unpacking_collector { +public: + template + explicit unpacking_collector(Ts &&...values) { + // Tuples aren't (easily) resizable so a list is needed for collection, + // but the actual function call strictly requires a tuple. + auto args_list = list(); + int _[] = { 0, (process(args_list, std::forward(values)), 0)... }; + ignore_unused(_); + + m_args = std::move(args_list); + } + + const tuple &args() const & { return m_args; } + const dict &kwargs() const & { return m_kwargs; } + + tuple args() && { return std::move(m_args); } + dict kwargs() && { return std::move(m_kwargs); } + + /// Call a Python function and pass the collected arguments + object call(PyObject *ptr) const { + PyObject *result = PyObject_Call(ptr, m_args.ptr(), m_kwargs.ptr()); + if (!result) + throw error_already_set(); + return reinterpret_steal(result); + } + +private: + template + void process(list &args_list, T &&x) { + auto o = reinterpret_steal(detail::make_caster::cast(std::forward(x), policy, {})); + if (!o) { +#if defined(NDEBUG) + argument_cast_error(); +#else + argument_cast_error(std::to_string(args_list.size()), type_id()); +#endif + } + args_list.append(o); + } + + void process(list &args_list, detail::args_proxy ap) { + for (const auto &a : ap) + args_list.append(a); + } + + void process(list &/*args_list*/, arg_v a) { + if (!a.name) +#if defined(NDEBUG) + nameless_argument_error(); +#else + nameless_argument_error(a.type); +#endif + + if (m_kwargs.contains(a.name)) { +#if defined(NDEBUG) + multiple_values_error(); +#else + multiple_values_error(a.name); +#endif + } + if (!a.value) { +#if defined(NDEBUG) + argument_cast_error(); +#else + argument_cast_error(a.name, a.type); +#endif + } + m_kwargs[a.name] = a.value; + } + + void process(list &/*args_list*/, detail::kwargs_proxy kp) { + if (!kp) + return; + for (const auto &k : reinterpret_borrow(kp)) { + if (m_kwargs.contains(k.first)) { +#if defined(NDEBUG) + multiple_values_error(); +#else + multiple_values_error(str(k.first)); +#endif + } + m_kwargs[k.first] = k.second; + } + } + + [[noreturn]] static void nameless_argument_error() { + throw type_error("Got kwargs without a name; only named arguments " + "may be passed via py::arg() to a python function call. " + "(compile in debug mode for details)"); + } + [[noreturn]] static void nameless_argument_error(std::string type) { + throw type_error("Got kwargs without a name of type '" + type + "'; only named " + "arguments may be passed via py::arg() to a python function call. "); + } + [[noreturn]] static void multiple_values_error() { + throw type_error("Got multiple values for keyword argument " + "(compile in debug mode for details)"); + } + + [[noreturn]] static void multiple_values_error(std::string name) { + throw type_error("Got multiple values for keyword argument '" + name + "'"); + } + + [[noreturn]] static void argument_cast_error() { + throw cast_error("Unable to convert call argument to Python object " + "(compile in debug mode for details)"); + } + + [[noreturn]] static void argument_cast_error(std::string name, std::string type) { + throw cast_error("Unable to convert call argument '" + name + + "' of type '" + type + "' to Python object"); + } + +private: + tuple m_args; + dict m_kwargs; +}; + +/// Collect only positional arguments for a Python function call +template ...>::value>> +simple_collector collect_arguments(Args &&...args) { + return simple_collector(std::forward(args)...); +} + +/// Collect all arguments, including keywords and unpacking (only instantiated when needed) +template ...>::value>> +unpacking_collector collect_arguments(Args &&...args) { + // Following argument order rules for generalized unpacking according to PEP 448 + static_assert( + constexpr_last() < constexpr_first() + && constexpr_last() < constexpr_first(), + "Invalid function call: positional args must precede keywords and ** unpacking; " + "* unpacking must precede ** unpacking" + ); + return unpacking_collector(std::forward(args)...); +} + +template +template +object object_api::operator()(Args &&...args) const { + return detail::collect_arguments(std::forward(args)...).call(derived().ptr()); +} + +template +template +object object_api::call(Args &&...args) const { + return operator()(std::forward(args)...); +} + +NAMESPACE_END(detail) + +#define PYBIND11_MAKE_OPAQUE(Type) \ + namespace pybind11 { namespace detail { \ + template<> class type_caster : public type_caster_base { }; \ + }} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/chrono.h b/plugins/python/pybind11/include/pybind11/chrono.h new file mode 100644 index 0000000..95ada76 --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/chrono.h @@ -0,0 +1,162 @@ +/* + pybind11/chrono.h: Transparent conversion between std::chrono and python's datetime + + Copyright (c) 2016 Trent Houliston and + Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include +#include +#include +#include + +// Backport the PyDateTime_DELTA functions from Python3.3 if required +#ifndef PyDateTime_DELTA_GET_DAYS +#define PyDateTime_DELTA_GET_DAYS(o) (((PyDateTime_Delta*)o)->days) +#endif +#ifndef PyDateTime_DELTA_GET_SECONDS +#define PyDateTime_DELTA_GET_SECONDS(o) (((PyDateTime_Delta*)o)->seconds) +#endif +#ifndef PyDateTime_DELTA_GET_MICROSECONDS +#define PyDateTime_DELTA_GET_MICROSECONDS(o) (((PyDateTime_Delta*)o)->microseconds) +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +template class duration_caster { +public: + typedef typename type::rep rep; + typedef typename type::period period; + + typedef std::chrono::duration> days; + + bool load(handle src, bool) { + using namespace std::chrono; + + // Lazy initialise the PyDateTime import + if (!PyDateTimeAPI) { PyDateTime_IMPORT; } + + if (!src) return false; + // If invoked with datetime.delta object + if (PyDelta_Check(src.ptr())) { + value = type(duration_cast>( + days(PyDateTime_DELTA_GET_DAYS(src.ptr())) + + seconds(PyDateTime_DELTA_GET_SECONDS(src.ptr())) + + microseconds(PyDateTime_DELTA_GET_MICROSECONDS(src.ptr())))); + return true; + } + // If invoked with a float we assume it is seconds and convert + else if (PyFloat_Check(src.ptr())) { + value = type(duration_cast>(duration(PyFloat_AsDouble(src.ptr())))); + return true; + } + else return false; + } + + // If this is a duration just return it back + static const std::chrono::duration& get_duration(const std::chrono::duration &src) { + return src; + } + + // If this is a time_point get the time_since_epoch + template static std::chrono::duration get_duration(const std::chrono::time_point> &src) { + return src.time_since_epoch(); + } + + static handle cast(const type &src, return_value_policy /* policy */, handle /* parent */) { + using namespace std::chrono; + + // Use overloaded function to get our duration from our source + // Works out if it is a duration or time_point and get the duration + auto d = get_duration(src); + + // Lazy initialise the PyDateTime import + if (!PyDateTimeAPI) { PyDateTime_IMPORT; } + + // Declare these special duration types so the conversions happen with the correct primitive types (int) + using dd_t = duration>; + using ss_t = duration>; + using us_t = duration; + + auto dd = duration_cast(d); + auto subd = d - dd; + auto ss = duration_cast(subd); + auto us = duration_cast(subd - ss); + return PyDelta_FromDSU(dd.count(), ss.count(), us.count()); + } + + PYBIND11_TYPE_CASTER(type, _("datetime.timedelta")); +}; + +// This is for casting times on the system clock into datetime.datetime instances +template class type_caster> { +public: + typedef std::chrono::time_point type; + bool load(handle src, bool) { + using namespace std::chrono; + + // Lazy initialise the PyDateTime import + if (!PyDateTimeAPI) { PyDateTime_IMPORT; } + + if (!src) return false; + if (PyDateTime_Check(src.ptr())) { + std::tm cal; + cal.tm_sec = PyDateTime_DATE_GET_SECOND(src.ptr()); + cal.tm_min = PyDateTime_DATE_GET_MINUTE(src.ptr()); + cal.tm_hour = PyDateTime_DATE_GET_HOUR(src.ptr()); + cal.tm_mday = PyDateTime_GET_DAY(src.ptr()); + cal.tm_mon = PyDateTime_GET_MONTH(src.ptr()) - 1; + cal.tm_year = PyDateTime_GET_YEAR(src.ptr()) - 1900; + cal.tm_isdst = -1; + + value = system_clock::from_time_t(std::mktime(&cal)) + microseconds(PyDateTime_DATE_GET_MICROSECOND(src.ptr())); + return true; + } + else return false; + } + + static handle cast(const std::chrono::time_point &src, return_value_policy /* policy */, handle /* parent */) { + using namespace std::chrono; + + // Lazy initialise the PyDateTime import + if (!PyDateTimeAPI) { PyDateTime_IMPORT; } + + std::time_t tt = system_clock::to_time_t(src); + // this function uses static memory so it's best to copy it out asap just in case + // otherwise other code that is using localtime may break this (not just python code) + std::tm localtime = *std::localtime(&tt); + + // Declare these special duration types so the conversions happen with the correct primitive types (int) + using us_t = duration; + + return PyDateTime_FromDateAndTime(localtime.tm_year + 1900, + localtime.tm_mon + 1, + localtime.tm_mday, + localtime.tm_hour, + localtime.tm_min, + localtime.tm_sec, + (duration_cast(src.time_since_epoch() % seconds(1))).count()); + } + PYBIND11_TYPE_CASTER(type, _("datetime.datetime")); +}; + +// Other clocks that are not the system clock are not measured as datetime.datetime objects +// since they are not measured on calendar time. So instead we just make them timedeltas +// Or if they have passed us a time as a float we convert that +template class type_caster> +: public duration_caster> { +}; + +template class type_caster> +: public duration_caster> { +}; + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/common.h b/plugins/python/pybind11/include/pybind11/common.h new file mode 100644 index 0000000..6c8a4f1 --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/common.h @@ -0,0 +1,2 @@ +#include "detail/common.h" +#warning "Including 'common.h' is deprecated. It will be removed in v3.0. Use 'pybind11.h'." diff --git a/plugins/python/pybind11/include/pybind11/complex.h b/plugins/python/pybind11/include/pybind11/complex.h new file mode 100644 index 0000000..5dac27c --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/complex.h @@ -0,0 +1,61 @@ +/* + pybind11/complex.h: Complex number support + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include + +/// glibc defines I as a macro which breaks things, e.g., boost template names +#ifdef I +# undef I +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +template struct format_descriptor, detail::enable_if_t::value>> { + static constexpr const char c = format_descriptor::c; + static constexpr const char value[3] = { 'Z', c, '\0' }; + static std::string format() { return std::string(value); } +}; + +template constexpr const char format_descriptor< + std::complex, detail::enable_if_t::value>>::value[3]; + +NAMESPACE_BEGIN(detail) + +template struct is_fmt_numeric, detail::enable_if_t::value>> { + static constexpr bool value = true; + static constexpr int index = is_fmt_numeric::index + 3; +}; + +template class type_caster> { +public: + bool load(handle src, bool convert) { + if (!src) + return false; + if (!convert && !PyComplex_Check(src.ptr())) + return false; + Py_complex result = PyComplex_AsCComplex(src.ptr()); + if (result.real == -1.0 && PyErr_Occurred()) { + PyErr_Clear(); + return false; + } + value = std::complex((T) result.real, (T) result.imag); + return true; + } + + static handle cast(const std::complex &src, return_value_policy /* policy */, handle /* parent */) { + return PyComplex_FromDoubles((double) src.real(), (double) src.imag()); + } + + PYBIND11_TYPE_CASTER(std::complex, _("complex")); +}; +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/detail/class.h b/plugins/python/pybind11/include/pybind11/detail/class.h new file mode 100644 index 0000000..ff06370 --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/detail/class.h @@ -0,0 +1,626 @@ +/* + pybind11/detail/class.h: Python C API implementation details for py::class_ + + Copyright (c) 2017 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "../attr.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +#if PY_VERSION_HEX >= 0x03030000 +# define PYBIND11_BUILTIN_QUALNAME +# define PYBIND11_SET_OLDPY_QUALNAME(obj, nameobj) +#else +// In pre-3.3 Python, we still set __qualname__ so that we can produce reliable function type +// signatures; in 3.3+ this macro expands to nothing: +# define PYBIND11_SET_OLDPY_QUALNAME(obj, nameobj) setattr((PyObject *) obj, "__qualname__", nameobj) +#endif + +inline PyTypeObject *type_incref(PyTypeObject *type) { + Py_INCREF(type); + return type; +} + +#if !defined(PYPY_VERSION) + +/// `pybind11_static_property.__get__()`: Always pass the class instead of the instance. +extern "C" inline PyObject *pybind11_static_get(PyObject *self, PyObject * /*ob*/, PyObject *cls) { + return PyProperty_Type.tp_descr_get(self, cls, cls); +} + +/// `pybind11_static_property.__set__()`: Just like the above `__get__()`. +extern "C" inline int pybind11_static_set(PyObject *self, PyObject *obj, PyObject *value) { + PyObject *cls = PyType_Check(obj) ? obj : (PyObject *) Py_TYPE(obj); + return PyProperty_Type.tp_descr_set(self, cls, value); +} + +/** A `static_property` is the same as a `property` but the `__get__()` and `__set__()` + methods are modified to always use the object type instead of a concrete instance. + Return value: New reference. */ +inline PyTypeObject *make_static_property_type() { + constexpr auto *name = "pybind11_static_property"; + auto name_obj = reinterpret_steal(PYBIND11_FROM_STRING(name)); + + /* Danger zone: from now (and until PyType_Ready), make sure to + issue no Python C API calls which could potentially invoke the + garbage collector (the GC will call type_traverse(), which will in + turn find the newly constructed type in an invalid state) */ + auto heap_type = (PyHeapTypeObject *) PyType_Type.tp_alloc(&PyType_Type, 0); + if (!heap_type) + pybind11_fail("make_static_property_type(): error allocating type!"); + + heap_type->ht_name = name_obj.inc_ref().ptr(); +#ifdef PYBIND11_BUILTIN_QUALNAME + heap_type->ht_qualname = name_obj.inc_ref().ptr(); +#endif + + auto type = &heap_type->ht_type; + type->tp_name = name; + type->tp_base = type_incref(&PyProperty_Type); + type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; + type->tp_descr_get = pybind11_static_get; + type->tp_descr_set = pybind11_static_set; + + if (PyType_Ready(type) < 0) + pybind11_fail("make_static_property_type(): failure in PyType_Ready()!"); + + setattr((PyObject *) type, "__module__", str("pybind11_builtins")); + PYBIND11_SET_OLDPY_QUALNAME(type, name_obj); + + return type; +} + +#else // PYPY + +/** PyPy has some issues with the above C API, so we evaluate Python code instead. + This function will only be called once so performance isn't really a concern. + Return value: New reference. */ +inline PyTypeObject *make_static_property_type() { + auto d = dict(); + PyObject *result = PyRun_String(R"(\ + class pybind11_static_property(property): + def __get__(self, obj, cls): + return property.__get__(self, cls, cls) + + def __set__(self, obj, value): + cls = obj if isinstance(obj, type) else type(obj) + property.__set__(self, cls, value) + )", Py_file_input, d.ptr(), d.ptr() + ); + if (result == nullptr) + throw error_already_set(); + Py_DECREF(result); + return (PyTypeObject *) d["pybind11_static_property"].cast().release().ptr(); +} + +#endif // PYPY + +/** Types with static properties need to handle `Type.static_prop = x` in a specific way. + By default, Python replaces the `static_property` itself, but for wrapped C++ types + we need to call `static_property.__set__()` in order to propagate the new value to + the underlying C++ data structure. */ +extern "C" inline int pybind11_meta_setattro(PyObject* obj, PyObject* name, PyObject* value) { + // Use `_PyType_Lookup()` instead of `PyObject_GetAttr()` in order to get the raw + // descriptor (`property`) instead of calling `tp_descr_get` (`property.__get__()`). + PyObject *descr = _PyType_Lookup((PyTypeObject *) obj, name); + + // The following assignment combinations are possible: + // 1. `Type.static_prop = value` --> descr_set: `Type.static_prop.__set__(value)` + // 2. `Type.static_prop = other_static_prop` --> setattro: replace existing `static_prop` + // 3. `Type.regular_attribute = value` --> setattro: regular attribute assignment + const auto static_prop = (PyObject *) get_internals().static_property_type; + const auto call_descr_set = descr && PyObject_IsInstance(descr, static_prop) + && !PyObject_IsInstance(value, static_prop); + if (call_descr_set) { + // Call `static_property.__set__()` instead of replacing the `static_property`. +#if !defined(PYPY_VERSION) + return Py_TYPE(descr)->tp_descr_set(descr, obj, value); +#else + if (PyObject *result = PyObject_CallMethod(descr, "__set__", "OO", obj, value)) { + Py_DECREF(result); + return 0; + } else { + return -1; + } +#endif + } else { + // Replace existing attribute. + return PyType_Type.tp_setattro(obj, name, value); + } +} + +#if PY_MAJOR_VERSION >= 3 +/** + * Python 3's PyInstanceMethod_Type hides itself via its tp_descr_get, which prevents aliasing + * methods via cls.attr("m2") = cls.attr("m1"): instead the tp_descr_get returns a plain function, + * when called on a class, or a PyMethod, when called on an instance. Override that behaviour here + * to do a special case bypass for PyInstanceMethod_Types. + */ +extern "C" inline PyObject *pybind11_meta_getattro(PyObject *obj, PyObject *name) { + PyObject *descr = _PyType_Lookup((PyTypeObject *) obj, name); + if (descr && PyInstanceMethod_Check(descr)) { + Py_INCREF(descr); + return descr; + } + else { + return PyType_Type.tp_getattro(obj, name); + } +} +#endif + +/** This metaclass is assigned by default to all pybind11 types and is required in order + for static properties to function correctly. Users may override this using `py::metaclass`. + Return value: New reference. */ +inline PyTypeObject* make_default_metaclass() { + constexpr auto *name = "pybind11_type"; + auto name_obj = reinterpret_steal(PYBIND11_FROM_STRING(name)); + + /* Danger zone: from now (and until PyType_Ready), make sure to + issue no Python C API calls which could potentially invoke the + garbage collector (the GC will call type_traverse(), which will in + turn find the newly constructed type in an invalid state) */ + auto heap_type = (PyHeapTypeObject *) PyType_Type.tp_alloc(&PyType_Type, 0); + if (!heap_type) + pybind11_fail("make_default_metaclass(): error allocating metaclass!"); + + heap_type->ht_name = name_obj.inc_ref().ptr(); +#ifdef PYBIND11_BUILTIN_QUALNAME + heap_type->ht_qualname = name_obj.inc_ref().ptr(); +#endif + + auto type = &heap_type->ht_type; + type->tp_name = name; + type->tp_base = type_incref(&PyType_Type); + type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; + + type->tp_setattro = pybind11_meta_setattro; +#if PY_MAJOR_VERSION >= 3 + type->tp_getattro = pybind11_meta_getattro; +#endif + + if (PyType_Ready(type) < 0) + pybind11_fail("make_default_metaclass(): failure in PyType_Ready()!"); + + setattr((PyObject *) type, "__module__", str("pybind11_builtins")); + PYBIND11_SET_OLDPY_QUALNAME(type, name_obj); + + return type; +} + +/// For multiple inheritance types we need to recursively register/deregister base pointers for any +/// base classes with pointers that are difference from the instance value pointer so that we can +/// correctly recognize an offset base class pointer. This calls a function with any offset base ptrs. +inline void traverse_offset_bases(void *valueptr, const detail::type_info *tinfo, instance *self, + bool (*f)(void * /*parentptr*/, instance * /*self*/)) { + for (handle h : reinterpret_borrow(tinfo->type->tp_bases)) { + if (auto parent_tinfo = get_type_info((PyTypeObject *) h.ptr())) { + for (auto &c : parent_tinfo->implicit_casts) { + if (c.first == tinfo->cpptype) { + auto *parentptr = c.second(valueptr); + if (parentptr != valueptr) + f(parentptr, self); + traverse_offset_bases(parentptr, parent_tinfo, self, f); + break; + } + } + } + } +} + +inline bool register_instance_impl(void *ptr, instance *self) { + get_internals().registered_instances.emplace(ptr, self); + return true; // unused, but gives the same signature as the deregister func +} +inline bool deregister_instance_impl(void *ptr, instance *self) { + auto ®istered_instances = get_internals().registered_instances; + auto range = registered_instances.equal_range(ptr); + for (auto it = range.first; it != range.second; ++it) { + if (Py_TYPE(self) == Py_TYPE(it->second)) { + registered_instances.erase(it); + return true; + } + } + return false; +} + +inline void register_instance(instance *self, void *valptr, const type_info *tinfo) { + register_instance_impl(valptr, self); + if (!tinfo->simple_ancestors) + traverse_offset_bases(valptr, tinfo, self, register_instance_impl); +} + +inline bool deregister_instance(instance *self, void *valptr, const type_info *tinfo) { + bool ret = deregister_instance_impl(valptr, self); + if (!tinfo->simple_ancestors) + traverse_offset_bases(valptr, tinfo, self, deregister_instance_impl); + return ret; +} + +/// Instance creation function for all pybind11 types. It allocates the internal instance layout for +/// holding C++ objects and holders. Allocation is done lazily (the first time the instance is cast +/// to a reference or pointer), and initialization is done by an `__init__` function. +inline PyObject *make_new_instance(PyTypeObject *type) { +#if defined(PYPY_VERSION) + // PyPy gets tp_basicsize wrong (issue 2482) under multiple inheritance when the first inherited + // object is a a plain Python type (i.e. not derived from an extension type). Fix it. + ssize_t instance_size = static_cast(sizeof(instance)); + if (type->tp_basicsize < instance_size) { + type->tp_basicsize = instance_size; + } +#endif + PyObject *self = type->tp_alloc(type, 0); + auto inst = reinterpret_cast(self); + // Allocate the value/holder internals: + inst->allocate_layout(); + + inst->owned = true; + + return self; +} + +/// Instance creation function for all pybind11 types. It only allocates space for the +/// C++ object, but doesn't call the constructor -- an `__init__` function must do that. +extern "C" inline PyObject *pybind11_object_new(PyTypeObject *type, PyObject *, PyObject *) { + return make_new_instance(type); +} + +/// An `__init__` function constructs the C++ object. Users should provide at least one +/// of these using `py::init` or directly with `.def(__init__, ...)`. Otherwise, the +/// following default function will be used which simply throws an exception. +extern "C" inline int pybind11_object_init(PyObject *self, PyObject *, PyObject *) { + PyTypeObject *type = Py_TYPE(self); + std::string msg; +#if defined(PYPY_VERSION) + msg += handle((PyObject *) type).attr("__module__").cast() + "."; +#endif + msg += type->tp_name; + msg += ": No constructor defined!"; + PyErr_SetString(PyExc_TypeError, msg.c_str()); + return -1; +} + +inline void add_patient(PyObject *nurse, PyObject *patient) { + auto &internals = get_internals(); + auto instance = reinterpret_cast(nurse); + auto ¤t_patients = internals.patients[nurse]; + instance->has_patients = true; + for (auto &p : current_patients) + if (p == patient) + return; + Py_INCREF(patient); + current_patients.push_back(patient); +} + +inline void clear_patients(PyObject *self) { + auto instance = reinterpret_cast(self); + auto &internals = get_internals(); + auto pos = internals.patients.find(self); + assert(pos != internals.patients.end()); + // Clearing the patients can cause more Python code to run, which + // can invalidate the iterator. Extract the vector of patients + // from the unordered_map first. + auto patients = std::move(pos->second); + internals.patients.erase(pos); + instance->has_patients = false; + for (PyObject *&patient : patients) + Py_CLEAR(patient); +} + +/// Clears all internal data from the instance and removes it from registered instances in +/// preparation for deallocation. +inline void clear_instance(PyObject *self) { + auto instance = reinterpret_cast(self); + + // Deallocate any values/holders, if present: + for (auto &v_h : values_and_holders(instance)) { + if (v_h) { + + // We have to deregister before we call dealloc because, for virtual MI types, we still + // need to be able to get the parent pointers. + if (v_h.instance_registered() && !deregister_instance(instance, v_h.value_ptr(), v_h.type)) + pybind11_fail("pybind11_object_dealloc(): Tried to deallocate unregistered instance!"); + + if (instance->owned || v_h.holder_constructed()) + v_h.type->dealloc(v_h); + } + } + // Deallocate the value/holder layout internals: + instance->deallocate_layout(); + + if (instance->weakrefs) + PyObject_ClearWeakRefs(self); + + PyObject **dict_ptr = _PyObject_GetDictPtr(self); + if (dict_ptr) + Py_CLEAR(*dict_ptr); + + if (instance->has_patients) + clear_patients(self); +} + +/// Instance destructor function for all pybind11 types. It calls `type_info.dealloc` +/// to destroy the C++ object itself, while the rest is Python bookkeeping. +extern "C" inline void pybind11_object_dealloc(PyObject *self) { + clear_instance(self); + + auto type = Py_TYPE(self); + type->tp_free(self); + + // `type->tp_dealloc != pybind11_object_dealloc` means that we're being called + // as part of a derived type's dealloc, in which case we're not allowed to decref + // the type here. For cross-module compatibility, we shouldn't compare directly + // with `pybind11_object_dealloc`, but with the common one stashed in internals. + auto pybind11_object_type = (PyTypeObject *) get_internals().instance_base; + if (type->tp_dealloc == pybind11_object_type->tp_dealloc) + Py_DECREF(type); +} + +/** Create the type which can be used as a common base for all classes. This is + needed in order to satisfy Python's requirements for multiple inheritance. + Return value: New reference. */ +inline PyObject *make_object_base_type(PyTypeObject *metaclass) { + constexpr auto *name = "pybind11_object"; + auto name_obj = reinterpret_steal(PYBIND11_FROM_STRING(name)); + + /* Danger zone: from now (and until PyType_Ready), make sure to + issue no Python C API calls which could potentially invoke the + garbage collector (the GC will call type_traverse(), which will in + turn find the newly constructed type in an invalid state) */ + auto heap_type = (PyHeapTypeObject *) metaclass->tp_alloc(metaclass, 0); + if (!heap_type) + pybind11_fail("make_object_base_type(): error allocating type!"); + + heap_type->ht_name = name_obj.inc_ref().ptr(); +#ifdef PYBIND11_BUILTIN_QUALNAME + heap_type->ht_qualname = name_obj.inc_ref().ptr(); +#endif + + auto type = &heap_type->ht_type; + type->tp_name = name; + type->tp_base = type_incref(&PyBaseObject_Type); + type->tp_basicsize = static_cast(sizeof(instance)); + type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; + + type->tp_new = pybind11_object_new; + type->tp_init = pybind11_object_init; + type->tp_dealloc = pybind11_object_dealloc; + + /* Support weak references (needed for the keep_alive feature) */ + type->tp_weaklistoffset = offsetof(instance, weakrefs); + + if (PyType_Ready(type) < 0) + pybind11_fail("PyType_Ready failed in make_object_base_type():" + error_string()); + + setattr((PyObject *) type, "__module__", str("pybind11_builtins")); + PYBIND11_SET_OLDPY_QUALNAME(type, name_obj); + + assert(!PyType_HasFeature(type, Py_TPFLAGS_HAVE_GC)); + return (PyObject *) heap_type; +} + +/// dynamic_attr: Support for `d = instance.__dict__`. +extern "C" inline PyObject *pybind11_get_dict(PyObject *self, void *) { + PyObject *&dict = *_PyObject_GetDictPtr(self); + if (!dict) + dict = PyDict_New(); + Py_XINCREF(dict); + return dict; +} + +/// dynamic_attr: Support for `instance.__dict__ = dict()`. +extern "C" inline int pybind11_set_dict(PyObject *self, PyObject *new_dict, void *) { + if (!PyDict_Check(new_dict)) { + PyErr_Format(PyExc_TypeError, "__dict__ must be set to a dictionary, not a '%.200s'", + Py_TYPE(new_dict)->tp_name); + return -1; + } + PyObject *&dict = *_PyObject_GetDictPtr(self); + Py_INCREF(new_dict); + Py_CLEAR(dict); + dict = new_dict; + return 0; +} + +/// dynamic_attr: Allow the garbage collector to traverse the internal instance `__dict__`. +extern "C" inline int pybind11_traverse(PyObject *self, visitproc visit, void *arg) { + PyObject *&dict = *_PyObject_GetDictPtr(self); + Py_VISIT(dict); + return 0; +} + +/// dynamic_attr: Allow the GC to clear the dictionary. +extern "C" inline int pybind11_clear(PyObject *self) { + PyObject *&dict = *_PyObject_GetDictPtr(self); + Py_CLEAR(dict); + return 0; +} + +/// Give instances of this type a `__dict__` and opt into garbage collection. +inline void enable_dynamic_attributes(PyHeapTypeObject *heap_type) { + auto type = &heap_type->ht_type; +#if defined(PYPY_VERSION) + pybind11_fail(std::string(type->tp_name) + ": dynamic attributes are " + "currently not supported in " + "conjunction with PyPy!"); +#endif + type->tp_flags |= Py_TPFLAGS_HAVE_GC; + type->tp_dictoffset = type->tp_basicsize; // place dict at the end + type->tp_basicsize += (ssize_t)sizeof(PyObject *); // and allocate enough space for it + type->tp_traverse = pybind11_traverse; + type->tp_clear = pybind11_clear; + + static PyGetSetDef getset[] = { + {const_cast("__dict__"), pybind11_get_dict, pybind11_set_dict, nullptr, nullptr}, + {nullptr, nullptr, nullptr, nullptr, nullptr} + }; + type->tp_getset = getset; +} + +/// buffer_protocol: Fill in the view as specified by flags. +extern "C" inline int pybind11_getbuffer(PyObject *obj, Py_buffer *view, int flags) { + // Look for a `get_buffer` implementation in this type's info or any bases (following MRO). + type_info *tinfo = nullptr; + for (auto type : reinterpret_borrow(Py_TYPE(obj)->tp_mro)) { + tinfo = get_type_info((PyTypeObject *) type.ptr()); + if (tinfo && tinfo->get_buffer) + break; + } + if (view == nullptr || obj == nullptr || !tinfo || !tinfo->get_buffer) { + if (view) + view->obj = nullptr; + PyErr_SetString(PyExc_BufferError, "pybind11_getbuffer(): Internal error"); + return -1; + } + std::memset(view, 0, sizeof(Py_buffer)); + buffer_info *info = tinfo->get_buffer(obj, tinfo->get_buffer_data); + view->obj = obj; + view->ndim = 1; + view->internal = info; + view->buf = info->ptr; + view->itemsize = info->itemsize; + view->len = view->itemsize; + for (auto s : info->shape) + view->len *= s; + if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT) + view->format = const_cast(info->format.c_str()); + if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES) { + view->ndim = (int) info->ndim; + view->strides = &info->strides[0]; + view->shape = &info->shape[0]; + } + Py_INCREF(view->obj); + return 0; +} + +/// buffer_protocol: Release the resources of the buffer. +extern "C" inline void pybind11_releasebuffer(PyObject *, Py_buffer *view) { + delete (buffer_info *) view->internal; +} + +/// Give this type a buffer interface. +inline void enable_buffer_protocol(PyHeapTypeObject *heap_type) { + heap_type->ht_type.tp_as_buffer = &heap_type->as_buffer; +#if PY_MAJOR_VERSION < 3 + heap_type->ht_type.tp_flags |= Py_TPFLAGS_HAVE_NEWBUFFER; +#endif + + heap_type->as_buffer.bf_getbuffer = pybind11_getbuffer; + heap_type->as_buffer.bf_releasebuffer = pybind11_releasebuffer; +} + +/** Create a brand new Python type according to the `type_record` specification. + Return value: New reference. */ +inline PyObject* make_new_python_type(const type_record &rec) { + auto name = reinterpret_steal(PYBIND11_FROM_STRING(rec.name)); + + auto qualname = name; + if (rec.scope && !PyModule_Check(rec.scope.ptr()) && hasattr(rec.scope, "__qualname__")) { +#if PY_MAJOR_VERSION >= 3 + qualname = reinterpret_steal( + PyUnicode_FromFormat("%U.%U", rec.scope.attr("__qualname__").ptr(), name.ptr())); +#else + qualname = str(rec.scope.attr("__qualname__").cast() + "." + rec.name); +#endif + } + + object module; + if (rec.scope) { + if (hasattr(rec.scope, "__module__")) + module = rec.scope.attr("__module__"); + else if (hasattr(rec.scope, "__name__")) + module = rec.scope.attr("__name__"); + } + + auto full_name = c_str( +#if !defined(PYPY_VERSION) + module ? str(module).cast() + "." + rec.name : +#endif + rec.name); + + char *tp_doc = nullptr; + if (rec.doc && options::show_user_defined_docstrings()) { + /* Allocate memory for docstring (using PyObject_MALLOC, since + Python will free this later on) */ + size_t size = strlen(rec.doc) + 1; + tp_doc = (char *) PyObject_MALLOC(size); + memcpy((void *) tp_doc, rec.doc, size); + } + + auto &internals = get_internals(); + auto bases = tuple(rec.bases); + auto base = (bases.size() == 0) ? internals.instance_base + : bases[0].ptr(); + + /* Danger zone: from now (and until PyType_Ready), make sure to + issue no Python C API calls which could potentially invoke the + garbage collector (the GC will call type_traverse(), which will in + turn find the newly constructed type in an invalid state) */ + auto metaclass = rec.metaclass.ptr() ? (PyTypeObject *) rec.metaclass.ptr() + : internals.default_metaclass; + + auto heap_type = (PyHeapTypeObject *) metaclass->tp_alloc(metaclass, 0); + if (!heap_type) + pybind11_fail(std::string(rec.name) + ": Unable to create type object!"); + + heap_type->ht_name = name.release().ptr(); +#ifdef PYBIND11_BUILTIN_QUALNAME + heap_type->ht_qualname = qualname.inc_ref().ptr(); +#endif + + auto type = &heap_type->ht_type; + type->tp_name = full_name; + type->tp_doc = tp_doc; + type->tp_base = type_incref((PyTypeObject *)base); + type->tp_basicsize = static_cast(sizeof(instance)); + if (bases.size() > 0) + type->tp_bases = bases.release().ptr(); + + /* Don't inherit base __init__ */ + type->tp_init = pybind11_object_init; + + /* Supported protocols */ + type->tp_as_number = &heap_type->as_number; + type->tp_as_sequence = &heap_type->as_sequence; + type->tp_as_mapping = &heap_type->as_mapping; + + /* Flags */ + type->tp_flags |= Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; +#if PY_MAJOR_VERSION < 3 + type->tp_flags |= Py_TPFLAGS_CHECKTYPES; +#endif + + if (rec.dynamic_attr) + enable_dynamic_attributes(heap_type); + + if (rec.buffer_protocol) + enable_buffer_protocol(heap_type); + + if (PyType_Ready(type) < 0) + pybind11_fail(std::string(rec.name) + ": PyType_Ready failed (" + error_string() + ")!"); + + assert(rec.dynamic_attr ? PyType_HasFeature(type, Py_TPFLAGS_HAVE_GC) + : !PyType_HasFeature(type, Py_TPFLAGS_HAVE_GC)); + + /* Register type with the parent scope */ + if (rec.scope) + setattr(rec.scope, rec.name, (PyObject *) type); + else + Py_INCREF(type); // Keep it alive forever (reference leak) + + if (module) // Needed by pydoc + setattr((PyObject *) type, "__module__", module); + + PYBIND11_SET_OLDPY_QUALNAME(type, qualname); + + return (PyObject *) type; +} + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/detail/common.h b/plugins/python/pybind11/include/pybind11/detail/common.h new file mode 100644 index 0000000..892de0f --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/detail/common.h @@ -0,0 +1,803 @@ +/* + pybind11/detail/common.h -- Basic macros + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#if !defined(NAMESPACE_BEGIN) +# define NAMESPACE_BEGIN(name) namespace name { +#endif +#if !defined(NAMESPACE_END) +# define NAMESPACE_END(name) } +#endif + +// Robust support for some features and loading modules compiled against different pybind versions +// requires forcing hidden visibility on pybind code, so we enforce this by setting the attribute on +// the main `pybind11` namespace. +#if !defined(PYBIND11_NAMESPACE) +# ifdef __GNUG__ +# define PYBIND11_NAMESPACE pybind11 __attribute__((visibility("hidden"))) +# else +# define PYBIND11_NAMESPACE pybind11 +# endif +#endif + +#if !(defined(_MSC_VER) && __cplusplus == 199711L) && !defined(__INTEL_COMPILER) +# if __cplusplus >= 201402L +# define PYBIND11_CPP14 +# if __cplusplus >= 201703L +# define PYBIND11_CPP17 +# endif +# endif +#elif defined(_MSC_VER) && __cplusplus == 199711L +// MSVC sets _MSVC_LANG rather than __cplusplus (supposedly until the standard is fully implemented) +// Unless you use the /Zc:__cplusplus flag on Visual Studio 2017 15.7 Preview 3 or newer +# if _MSVC_LANG >= 201402L +# define PYBIND11_CPP14 +# if _MSVC_LANG > 201402L && _MSC_VER >= 1910 +# define PYBIND11_CPP17 +# endif +# endif +#endif + +// Compiler version assertions +#if defined(__INTEL_COMPILER) +# if __INTEL_COMPILER < 1700 +# error pybind11 requires Intel C++ compiler v17 or newer +# endif +#elif defined(__clang__) && !defined(__apple_build_version__) +# if __clang_major__ < 3 || (__clang_major__ == 3 && __clang_minor__ < 3) +# error pybind11 requires clang 3.3 or newer +# endif +#elif defined(__clang__) +// Apple changes clang version macros to its Xcode version; the first Xcode release based on +// (upstream) clang 3.3 was Xcode 5: +# if __clang_major__ < 5 +# error pybind11 requires Xcode/clang 5.0 or newer +# endif +#elif defined(__GNUG__) +# if __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 8) +# error pybind11 requires gcc 4.8 or newer +# endif +#elif defined(_MSC_VER) +// Pybind hits various compiler bugs in 2015u2 and earlier, and also makes use of some stl features +// (e.g. std::negation) added in 2015u3: +# if _MSC_FULL_VER < 190024210 +# error pybind11 requires MSVC 2015 update 3 or newer +# endif +#endif + +#if !defined(PYBIND11_EXPORT) +# if defined(WIN32) || defined(_WIN32) +# define PYBIND11_EXPORT __declspec(dllexport) +# else +# define PYBIND11_EXPORT __attribute__ ((visibility("default"))) +# endif +#endif + +#if defined(_MSC_VER) +# define PYBIND11_NOINLINE __declspec(noinline) +#else +# define PYBIND11_NOINLINE __attribute__ ((noinline)) +#endif + +#if defined(PYBIND11_CPP14) +# define PYBIND11_DEPRECATED(reason) [[deprecated(reason)]] +#else +# define PYBIND11_DEPRECATED(reason) __attribute__((deprecated(reason))) +#endif + +#define PYBIND11_VERSION_MAJOR 2 +#define PYBIND11_VERSION_MINOR 2 +#define PYBIND11_VERSION_PATCH 4 + +/// Include Python header, disable linking to pythonX_d.lib on Windows in debug mode +#if defined(_MSC_VER) +# if (PY_MAJOR_VERSION == 3 && PY_MINOR_VERSION < 4) +# define HAVE_ROUND 1 +# endif +# pragma warning(push) +# pragma warning(disable: 4510 4610 4512 4005) +# if defined(_DEBUG) +# define PYBIND11_DEBUG_MARKER +# undef _DEBUG +# endif +#endif + +#include +#include +#include + +#if defined(_WIN32) && (defined(min) || defined(max)) +# error Macro clash with min and max -- define NOMINMAX when compiling your program on Windows +#endif + +#if defined(isalnum) +# undef isalnum +# undef isalpha +# undef islower +# undef isspace +# undef isupper +# undef tolower +# undef toupper +#endif + +#if defined(_MSC_VER) +# if defined(PYBIND11_DEBUG_MARKER) +# define _DEBUG +# undef PYBIND11_DEBUG_MARKER +# endif +# pragma warning(pop) +#endif + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#if PY_MAJOR_VERSION >= 3 /// Compatibility macros for various Python versions +#define PYBIND11_INSTANCE_METHOD_NEW(ptr, class_) PyInstanceMethod_New(ptr) +#define PYBIND11_INSTANCE_METHOD_CHECK PyInstanceMethod_Check +#define PYBIND11_INSTANCE_METHOD_GET_FUNCTION PyInstanceMethod_GET_FUNCTION +#define PYBIND11_BYTES_CHECK PyBytes_Check +#define PYBIND11_BYTES_FROM_STRING PyBytes_FromString +#define PYBIND11_BYTES_FROM_STRING_AND_SIZE PyBytes_FromStringAndSize +#define PYBIND11_BYTES_AS_STRING_AND_SIZE PyBytes_AsStringAndSize +#define PYBIND11_BYTES_AS_STRING PyBytes_AsString +#define PYBIND11_BYTES_SIZE PyBytes_Size +#define PYBIND11_LONG_CHECK(o) PyLong_Check(o) +#define PYBIND11_LONG_AS_LONGLONG(o) PyLong_AsLongLong(o) +#define PYBIND11_BYTES_NAME "bytes" +#define PYBIND11_STRING_NAME "str" +#define PYBIND11_SLICE_OBJECT PyObject +#define PYBIND11_FROM_STRING PyUnicode_FromString +#define PYBIND11_STR_TYPE ::pybind11::str +#define PYBIND11_BOOL_ATTR "__bool__" +#define PYBIND11_NB_BOOL(ptr) ((ptr)->nb_bool) +#define PYBIND11_PLUGIN_IMPL(name) \ + extern "C" PYBIND11_EXPORT PyObject *PyInit_##name() + +#else +#define PYBIND11_INSTANCE_METHOD_NEW(ptr, class_) PyMethod_New(ptr, nullptr, class_) +#define PYBIND11_INSTANCE_METHOD_CHECK PyMethod_Check +#define PYBIND11_INSTANCE_METHOD_GET_FUNCTION PyMethod_GET_FUNCTION +#define PYBIND11_BYTES_CHECK PyString_Check +#define PYBIND11_BYTES_FROM_STRING PyString_FromString +#define PYBIND11_BYTES_FROM_STRING_AND_SIZE PyString_FromStringAndSize +#define PYBIND11_BYTES_AS_STRING_AND_SIZE PyString_AsStringAndSize +#define PYBIND11_BYTES_AS_STRING PyString_AsString +#define PYBIND11_BYTES_SIZE PyString_Size +#define PYBIND11_LONG_CHECK(o) (PyInt_Check(o) || PyLong_Check(o)) +#define PYBIND11_LONG_AS_LONGLONG(o) (PyInt_Check(o) ? (long long) PyLong_AsLong(o) : PyLong_AsLongLong(o)) +#define PYBIND11_BYTES_NAME "str" +#define PYBIND11_STRING_NAME "unicode" +#define PYBIND11_SLICE_OBJECT PySliceObject +#define PYBIND11_FROM_STRING PyString_FromString +#define PYBIND11_STR_TYPE ::pybind11::bytes +#define PYBIND11_BOOL_ATTR "__nonzero__" +#define PYBIND11_NB_BOOL(ptr) ((ptr)->nb_nonzero) +#define PYBIND11_PLUGIN_IMPL(name) \ + static PyObject *pybind11_init_wrapper(); \ + extern "C" PYBIND11_EXPORT void init##name() { \ + (void)pybind11_init_wrapper(); \ + } \ + PyObject *pybind11_init_wrapper() +#endif + +#if PY_VERSION_HEX >= 0x03050000 && PY_VERSION_HEX < 0x03050200 +extern "C" { + struct _Py_atomic_address { void *value; }; + PyAPI_DATA(_Py_atomic_address) _PyThreadState_Current; +} +#endif + +#define PYBIND11_TRY_NEXT_OVERLOAD ((PyObject *) 1) // special failure return code +#define PYBIND11_STRINGIFY(x) #x +#define PYBIND11_TOSTRING(x) PYBIND11_STRINGIFY(x) +#define PYBIND11_CONCAT(first, second) first##second + +/** \rst + ***Deprecated in favor of PYBIND11_MODULE*** + + This macro creates the entry point that will be invoked when the Python interpreter + imports a plugin library. Please create a `module` in the function body and return + the pointer to its underlying Python object at the end. + + .. code-block:: cpp + + PYBIND11_PLUGIN(example) { + pybind11::module m("example", "pybind11 example plugin"); + /// Set up bindings here + return m.ptr(); + } +\endrst */ +#define PYBIND11_PLUGIN(name) \ + PYBIND11_DEPRECATED("PYBIND11_PLUGIN is deprecated, use PYBIND11_MODULE") \ + static PyObject *pybind11_init(); \ + PYBIND11_PLUGIN_IMPL(name) { \ + int major, minor; \ + if (sscanf(Py_GetVersion(), "%i.%i", &major, &minor) != 2) { \ + PyErr_SetString(PyExc_ImportError, "Can't parse Python version."); \ + return nullptr; \ + } else if (major != PY_MAJOR_VERSION || minor != PY_MINOR_VERSION) { \ + PyErr_Format(PyExc_ImportError, \ + "Python version mismatch: module was compiled for " \ + "version %i.%i, while the interpreter is running " \ + "version %i.%i.", PY_MAJOR_VERSION, PY_MINOR_VERSION, \ + major, minor); \ + return nullptr; \ + } \ + try { \ + return pybind11_init(); \ + } catch (pybind11::error_already_set &e) { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } catch (const std::exception &e) { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } \ + } \ + PyObject *pybind11_init() + +/** \rst + This macro creates the entry point that will be invoked when the Python interpreter + imports an extension module. The module name is given as the fist argument and it + should not be in quotes. The second macro argument defines a variable of type + `py::module` which can be used to initialize the module. + + .. code-block:: cpp + + PYBIND11_MODULE(example, m) { + m.doc() = "pybind11 example module"; + + // Add bindings here + m.def("foo", []() { + return "Hello, World!"; + }); + } +\endrst */ +#define PYBIND11_MODULE(name, variable) \ + static void PYBIND11_CONCAT(pybind11_init_, name)(pybind11::module &); \ + PYBIND11_PLUGIN_IMPL(name) { \ + int major, minor; \ + if (sscanf(Py_GetVersion(), "%i.%i", &major, &minor) != 2) { \ + PyErr_SetString(PyExc_ImportError, "Can't parse Python version."); \ + return nullptr; \ + } else if (major != PY_MAJOR_VERSION || minor != PY_MINOR_VERSION) { \ + PyErr_Format(PyExc_ImportError, \ + "Python version mismatch: module was compiled for " \ + "version %i.%i, while the interpreter is running " \ + "version %i.%i.", PY_MAJOR_VERSION, PY_MINOR_VERSION, \ + major, minor); \ + return nullptr; \ + } \ + auto m = pybind11::module(PYBIND11_TOSTRING(name)); \ + try { \ + PYBIND11_CONCAT(pybind11_init_, name)(m); \ + return m.ptr(); \ + } catch (pybind11::error_already_set &e) { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } catch (const std::exception &e) { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } \ + } \ + void PYBIND11_CONCAT(pybind11_init_, name)(pybind11::module &variable) + + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +using ssize_t = Py_ssize_t; +using size_t = std::size_t; + +/// Approach used to cast a previously unknown C++ instance into a Python object +enum class return_value_policy : uint8_t { + /** This is the default return value policy, which falls back to the policy + return_value_policy::take_ownership when the return value is a pointer. + Otherwise, it uses return_value::move or return_value::copy for rvalue + and lvalue references, respectively. See below for a description of what + all of these different policies do. */ + automatic = 0, + + /** As above, but use policy return_value_policy::reference when the return + value is a pointer. This is the default conversion policy for function + arguments when calling Python functions manually from C++ code (i.e. via + handle::operator()). You probably won't need to use this. */ + automatic_reference, + + /** Reference an existing object (i.e. do not create a new copy) and take + ownership. Python will call the destructor and delete operator when the + object’s reference count reaches zero. Undefined behavior ensues when + the C++ side does the same.. */ + take_ownership, + + /** Create a new copy of the returned object, which will be owned by + Python. This policy is comparably safe because the lifetimes of the two + instances are decoupled. */ + copy, + + /** Use std::move to move the return value contents into a new instance + that will be owned by Python. This policy is comparably safe because the + lifetimes of the two instances (move source and destination) are + decoupled. */ + move, + + /** Reference an existing object, but do not take ownership. The C++ side + is responsible for managing the object’s lifetime and deallocating it + when it is no longer used. Warning: undefined behavior will ensue when + the C++ side deletes an object that is still referenced and used by + Python. */ + reference, + + /** This policy only applies to methods and properties. It references the + object without taking ownership similar to the above + return_value_policy::reference policy. In contrast to that policy, the + function or property’s implicit this argument (called the parent) is + considered to be the the owner of the return value (the child). + pybind11 then couples the lifetime of the parent to the child via a + reference relationship that ensures that the parent cannot be garbage + collected while Python is still using the child. More advanced + variations of this scheme are also possible using combinations of + return_value_policy::reference and the keep_alive call policy */ + reference_internal +}; + +NAMESPACE_BEGIN(detail) + +inline static constexpr int log2(size_t n, int k = 0) { return (n <= 1) ? k : log2(n >> 1, k + 1); } + +// Returns the size as a multiple of sizeof(void *), rounded up. +inline static constexpr size_t size_in_ptrs(size_t s) { return 1 + ((s - 1) >> log2(sizeof(void *))); } + +/** + * The space to allocate for simple layout instance holders (see below) in multiple of the size of + * a pointer (e.g. 2 means 16 bytes on 64-bit architectures). The default is the minimum required + * to holder either a std::unique_ptr or std::shared_ptr (which is almost always + * sizeof(std::shared_ptr)). + */ +constexpr size_t instance_simple_holder_in_ptrs() { + static_assert(sizeof(std::shared_ptr) >= sizeof(std::unique_ptr), + "pybind assumes std::shared_ptrs are at least as big as std::unique_ptrs"); + return size_in_ptrs(sizeof(std::shared_ptr)); +} + +// Forward declarations +struct type_info; +struct value_and_holder; + +struct nonsimple_values_and_holders { + void **values_and_holders; + uint8_t *status; +}; + +/// The 'instance' type which needs to be standard layout (need to be able to use 'offsetof') +struct instance { + PyObject_HEAD + /// Storage for pointers and holder; see simple_layout, below, for a description + union { + void *simple_value_holder[1 + instance_simple_holder_in_ptrs()]; + nonsimple_values_and_holders nonsimple; + }; + /// Weak references (needed for keep alive): + PyObject *weakrefs; + /// If true, the pointer is owned which means we're free to manage it with a holder. + bool owned : 1; + /** + * An instance has two possible value/holder layouts. + * + * Simple layout (when this flag is true), means the `simple_value_holder` is set with a pointer + * and the holder object governing that pointer, i.e. [val1*][holder]. This layout is applied + * whenever there is no python-side multiple inheritance of bound C++ types *and* the type's + * holder will fit in the default space (which is large enough to hold either a std::unique_ptr + * or std::shared_ptr). + * + * Non-simple layout applies when using custom holders that require more space than `shared_ptr` + * (which is typically the size of two pointers), or when multiple inheritance is used on the + * python side. Non-simple layout allocates the required amount of memory to have multiple + * bound C++ classes as parents. Under this layout, `nonsimple.values_and_holders` is set to a + * pointer to allocated space of the required space to hold a a sequence of value pointers and + * holders followed `status`, a set of bit flags (1 byte each), i.e. + * [val1*][holder1][val2*][holder2]...[bb...] where each [block] is rounded up to a multiple of + * `sizeof(void *)`. `nonsimple.holder_constructed` is, for convenience, a pointer to the + * beginning of the [bb...] block (but not independently allocated). + * + * Status bits indicate whether the associated holder is constructed (& + * status_holder_constructed) and whether the value pointer is registered (& + * status_instance_registered) in `registered_instances`. + */ + bool simple_layout : 1; + /// For simple layout, tracks whether the holder has been constructed + bool simple_holder_constructed : 1; + /// For simple layout, tracks whether the instance is registered in `registered_instances` + bool simple_instance_registered : 1; + /// If true, get_internals().patients has an entry for this object + bool has_patients : 1; + + /// Initializes all of the above type/values/holders data (but not the instance values themselves) + void allocate_layout(); + + /// Destroys/deallocates all of the above + void deallocate_layout(); + + /// Returns the value_and_holder wrapper for the given type (or the first, if `find_type` + /// omitted). Returns a default-constructed (with `.inst = nullptr`) object on failure if + /// `throw_if_missing` is false. + value_and_holder get_value_and_holder(const type_info *find_type = nullptr, bool throw_if_missing = true); + + /// Bit values for the non-simple status flags + static constexpr uint8_t status_holder_constructed = 1; + static constexpr uint8_t status_instance_registered = 2; +}; + +static_assert(std::is_standard_layout::value, "Internal error: `pybind11::detail::instance` is not standard layout!"); + +/// from __cpp_future__ import (convenient aliases from C++14/17) +#if defined(PYBIND11_CPP14) && (!defined(_MSC_VER) || _MSC_VER >= 1910) +using std::enable_if_t; +using std::conditional_t; +using std::remove_cv_t; +using std::remove_reference_t; +#else +template using enable_if_t = typename std::enable_if::type; +template using conditional_t = typename std::conditional::type; +template using remove_cv_t = typename std::remove_cv::type; +template using remove_reference_t = typename std::remove_reference::type; +#endif + +/// Index sequences +#if defined(PYBIND11_CPP14) +using std::index_sequence; +using std::make_index_sequence; +#else +template struct index_sequence { }; +template struct make_index_sequence_impl : make_index_sequence_impl { }; +template struct make_index_sequence_impl <0, S...> { typedef index_sequence type; }; +template using make_index_sequence = typename make_index_sequence_impl::type; +#endif + +/// Make an index sequence of the indices of true arguments +template struct select_indices_impl { using type = ISeq; }; +template struct select_indices_impl, I, B, Bs...> + : select_indices_impl, index_sequence>, I + 1, Bs...> {}; +template using select_indices = typename select_indices_impl, 0, Bs...>::type; + +/// Backports of std::bool_constant and std::negation to accommodate older compilers +template using bool_constant = std::integral_constant; +template struct negation : bool_constant { }; + +template struct void_t_impl { using type = void; }; +template using void_t = typename void_t_impl::type; + +/// Compile-time all/any/none of that check the boolean value of all template types +#if defined(__cpp_fold_expressions) && !(defined(_MSC_VER) && (_MSC_VER < 1916)) +template using all_of = bool_constant<(Ts::value && ...)>; +template using any_of = bool_constant<(Ts::value || ...)>; +#elif !defined(_MSC_VER) +template struct bools {}; +template using all_of = std::is_same< + bools, + bools>; +template using any_of = negation...>>; +#else +// MSVC has trouble with the above, but supports std::conjunction, which we can use instead (albeit +// at a slight loss of compilation efficiency). +template using all_of = std::conjunction; +template using any_of = std::disjunction; +#endif +template using none_of = negation>; + +template class... Predicates> using satisfies_all_of = all_of...>; +template class... Predicates> using satisfies_any_of = any_of...>; +template class... Predicates> using satisfies_none_of = none_of...>; + +/// Strip the class from a method type +template struct remove_class { }; +template struct remove_class { typedef R type(A...); }; +template struct remove_class { typedef R type(A...); }; + +/// Helper template to strip away type modifiers +template struct intrinsic_type { typedef T type; }; +template struct intrinsic_type { typedef typename intrinsic_type::type type; }; +template struct intrinsic_type { typedef typename intrinsic_type::type type; }; +template struct intrinsic_type { typedef typename intrinsic_type::type type; }; +template struct intrinsic_type { typedef typename intrinsic_type::type type; }; +template struct intrinsic_type { typedef typename intrinsic_type::type type; }; +template struct intrinsic_type { typedef typename intrinsic_type::type type; }; +template using intrinsic_t = typename intrinsic_type::type; + +/// Helper type to replace 'void' in some expressions +struct void_type { }; + +/// Helper template which holds a list of types +template struct type_list { }; + +/// Compile-time integer sum +#ifdef __cpp_fold_expressions +template constexpr size_t constexpr_sum(Ts... ns) { return (0 + ... + size_t{ns}); } +#else +constexpr size_t constexpr_sum() { return 0; } +template +constexpr size_t constexpr_sum(T n, Ts... ns) { return size_t{n} + constexpr_sum(ns...); } +#endif + +NAMESPACE_BEGIN(constexpr_impl) +/// Implementation details for constexpr functions +constexpr int first(int i) { return i; } +template +constexpr int first(int i, T v, Ts... vs) { return v ? i : first(i + 1, vs...); } + +constexpr int last(int /*i*/, int result) { return result; } +template +constexpr int last(int i, int result, T v, Ts... vs) { return last(i + 1, v ? i : result, vs...); } +NAMESPACE_END(constexpr_impl) + +/// Return the index of the first type in Ts which satisfies Predicate. Returns sizeof...(Ts) if +/// none match. +template class Predicate, typename... Ts> +constexpr int constexpr_first() { return constexpr_impl::first(0, Predicate::value...); } + +/// Return the index of the last type in Ts which satisfies Predicate, or -1 if none match. +template class Predicate, typename... Ts> +constexpr int constexpr_last() { return constexpr_impl::last(0, -1, Predicate::value...); } + +/// Return the Nth element from the parameter pack +template +struct pack_element { using type = typename pack_element::type; }; +template +struct pack_element<0, T, Ts...> { using type = T; }; + +/// Return the one and only type which matches the predicate, or Default if none match. +/// If more than one type matches the predicate, fail at compile-time. +template class Predicate, typename Default, typename... Ts> +struct exactly_one { + static constexpr auto found = constexpr_sum(Predicate::value...); + static_assert(found <= 1, "Found more than one type matching the predicate"); + + static constexpr auto index = found ? constexpr_first() : 0; + using type = conditional_t::type, Default>; +}; +template class P, typename Default> +struct exactly_one { using type = Default; }; + +template class Predicate, typename Default, typename... Ts> +using exactly_one_t = typename exactly_one::type; + +/// Defer the evaluation of type T until types Us are instantiated +template struct deferred_type { using type = T; }; +template using deferred_t = typename deferred_type::type; + +/// Like is_base_of, but requires a strict base (i.e. `is_strict_base_of::value == false`, +/// unlike `std::is_base_of`) +template using is_strict_base_of = bool_constant< + std::is_base_of::value && !std::is_same::value>; + +template class Base> +struct is_template_base_of_impl { + template static std::true_type check(Base *); + static std::false_type check(...); +}; + +/// Check if a template is the base of a type. For example: +/// `is_template_base_of` is true if `struct T : Base {}` where U can be anything +template class Base, typename T> +#if !defined(_MSC_VER) +using is_template_base_of = decltype(is_template_base_of_impl::check((intrinsic_t*)nullptr)); +#else // MSVC2015 has trouble with decltype in template aliases +struct is_template_base_of : decltype(is_template_base_of_impl::check((intrinsic_t*)nullptr)) { }; +#endif + +/// Check if T is an instantiation of the template `Class`. For example: +/// `is_instantiation` is true if `T == shared_ptr` where U can be anything. +template class Class, typename T> +struct is_instantiation : std::false_type { }; +template class Class, typename... Us> +struct is_instantiation> : std::true_type { }; + +/// Check if T is std::shared_ptr where U can be anything +template using is_shared_ptr = is_instantiation; + +/// Check if T looks like an input iterator +template struct is_input_iterator : std::false_type {}; +template +struct is_input_iterator()), decltype(++std::declval())>> + : std::true_type {}; + +template using is_function_pointer = bool_constant< + std::is_pointer::value && std::is_function::type>::value>; + +template struct strip_function_object { + using type = typename remove_class::type; +}; + +// Extracts the function signature from a function, function pointer or lambda. +template > +using function_signature_t = conditional_t< + std::is_function::value, + F, + typename conditional_t< + std::is_pointer::value || std::is_member_pointer::value, + std::remove_pointer, + strip_function_object + >::type +>; + +/// Returns true if the type looks like a lambda: that is, isn't a function, pointer or member +/// pointer. Note that this can catch all sorts of other things, too; this is intended to be used +/// in a place where passing a lambda makes sense. +template using is_lambda = satisfies_none_of, + std::is_function, std::is_pointer, std::is_member_pointer>; + +/// Ignore that a variable is unused in compiler warnings +inline void ignore_unused(const int *) { } + +/// Apply a function over each element of a parameter pack +#ifdef __cpp_fold_expressions +#define PYBIND11_EXPAND_SIDE_EFFECTS(PATTERN) (((PATTERN), void()), ...) +#else +using expand_side_effects = bool[]; +#define PYBIND11_EXPAND_SIDE_EFFECTS(PATTERN) pybind11::detail::expand_side_effects{ ((PATTERN), void(), false)..., false } +#endif + +NAMESPACE_END(detail) + +/// C++ bindings of builtin Python exceptions +class builtin_exception : public std::runtime_error { +public: + using std::runtime_error::runtime_error; + /// Set the error using the Python C API + virtual void set_error() const = 0; +}; + +#define PYBIND11_RUNTIME_EXCEPTION(name, type) \ + class name : public builtin_exception { public: \ + using builtin_exception::builtin_exception; \ + name() : name("") { } \ + void set_error() const override { PyErr_SetString(type, what()); } \ + }; + +PYBIND11_RUNTIME_EXCEPTION(stop_iteration, PyExc_StopIteration) +PYBIND11_RUNTIME_EXCEPTION(index_error, PyExc_IndexError) +PYBIND11_RUNTIME_EXCEPTION(key_error, PyExc_KeyError) +PYBIND11_RUNTIME_EXCEPTION(value_error, PyExc_ValueError) +PYBIND11_RUNTIME_EXCEPTION(type_error, PyExc_TypeError) +PYBIND11_RUNTIME_EXCEPTION(cast_error, PyExc_RuntimeError) /// Thrown when pybind11::cast or handle::call fail due to a type casting error +PYBIND11_RUNTIME_EXCEPTION(reference_cast_error, PyExc_RuntimeError) /// Used internally + +[[noreturn]] PYBIND11_NOINLINE inline void pybind11_fail(const char *reason) { throw std::runtime_error(reason); } +[[noreturn]] PYBIND11_NOINLINE inline void pybind11_fail(const std::string &reason) { throw std::runtime_error(reason); } + +template struct format_descriptor { }; + +NAMESPACE_BEGIN(detail) +// Returns the index of the given type in the type char array below, and in the list in numpy.h +// The order here is: bool; 8 ints ((signed,unsigned)x(8,16,32,64)bits); float,double,long double; +// complex float,double,long double. Note that the long double types only participate when long +// double is actually longer than double (it isn't under MSVC). +// NB: not only the string below but also complex.h and numpy.h rely on this order. +template struct is_fmt_numeric { static constexpr bool value = false; }; +template struct is_fmt_numeric::value>> { + static constexpr bool value = true; + static constexpr int index = std::is_same::value ? 0 : 1 + ( + std::is_integral::value ? detail::log2(sizeof(T))*2 + std::is_unsigned::value : 8 + ( + std::is_same::value ? 1 : std::is_same::value ? 2 : 0)); +}; +NAMESPACE_END(detail) + +template struct format_descriptor::value>> { + static constexpr const char c = "?bBhHiIqQfdg"[detail::is_fmt_numeric::index]; + static constexpr const char value[2] = { c, '\0' }; + static std::string format() { return std::string(1, c); } +}; + +template constexpr const char format_descriptor< + T, detail::enable_if_t::value>>::value[2]; + +/// RAII wrapper that temporarily clears any Python error state +struct error_scope { + PyObject *type, *value, *trace; + error_scope() { PyErr_Fetch(&type, &value, &trace); } + ~error_scope() { PyErr_Restore(type, value, trace); } +}; + +/// Dummy destructor wrapper that can be used to expose classes with a private destructor +struct nodelete { template void operator()(T*) { } }; + +// overload_cast requires variable templates: C++14 +#if defined(PYBIND11_CPP14) +#define PYBIND11_OVERLOAD_CAST 1 + +NAMESPACE_BEGIN(detail) +template +struct overload_cast_impl { + constexpr overload_cast_impl() {} // MSVC 2015 needs this + + template + constexpr auto operator()(Return (*pf)(Args...)) const noexcept + -> decltype(pf) { return pf; } + + template + constexpr auto operator()(Return (Class::*pmf)(Args...), std::false_type = {}) const noexcept + -> decltype(pmf) { return pmf; } + + template + constexpr auto operator()(Return (Class::*pmf)(Args...) const, std::true_type) const noexcept + -> decltype(pmf) { return pmf; } +}; +NAMESPACE_END(detail) + +/// Syntax sugar for resolving overloaded function pointers: +/// - regular: static_cast(&Class::func) +/// - sweet: overload_cast(&Class::func) +template +static constexpr detail::overload_cast_impl overload_cast = {}; +// MSVC 2015 only accepts this particular initialization syntax for this variable template. + +/// Const member function selector for overload_cast +/// - regular: static_cast(&Class::func) +/// - sweet: overload_cast(&Class::func, const_) +static constexpr auto const_ = std::true_type{}; + +#else // no overload_cast: providing something that static_assert-fails: +template struct overload_cast { + static_assert(detail::deferred_t::value, + "pybind11::overload_cast<...> requires compiling in C++14 mode"); +}; +#endif // overload_cast + +NAMESPACE_BEGIN(detail) + +// Adaptor for converting arbitrary container arguments into a vector; implicitly convertible from +// any standard container (or C-style array) supporting std::begin/std::end, any singleton +// arithmetic type (if T is arithmetic), or explicitly constructible from an iterator pair. +template +class any_container { + std::vector v; +public: + any_container() = default; + + // Can construct from a pair of iterators + template ::value>> + any_container(It first, It last) : v(first, last) { } + + // Implicit conversion constructor from any arbitrary container type with values convertible to T + template ())), T>::value>> + any_container(const Container &c) : any_container(std::begin(c), std::end(c)) { } + + // initializer_list's aren't deducible, so don't get matched by the above template; we need this + // to explicitly allow implicit conversion from one: + template ::value>> + any_container(const std::initializer_list &c) : any_container(c.begin(), c.end()) { } + + // Avoid copying if given an rvalue vector of the correct type. + any_container(std::vector &&v) : v(std::move(v)) { } + + // Moves the vector out of an rvalue any_container + operator std::vector &&() && { return std::move(v); } + + // Dereferencing obtains a reference to the underlying vector + std::vector &operator*() { return v; } + const std::vector &operator*() const { return v; } + + // -> lets you call methods on the underlying vector + std::vector *operator->() { return &v; } + const std::vector *operator->() const { return &v; } +}; + +NAMESPACE_END(detail) + + + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/detail/descr.h b/plugins/python/pybind11/include/pybind11/detail/descr.h new file mode 100644 index 0000000..e3bf2ba --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/detail/descr.h @@ -0,0 +1,185 @@ +/* + pybind11/detail/descr.h: Helper type for concatenating type signatures + either at runtime (C++11) or compile time (C++14) + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "common.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/* Concatenate type signatures at compile time using C++14 */ +#if defined(PYBIND11_CPP14) && !defined(_MSC_VER) +#define PYBIND11_CONSTEXPR_DESCR + +template class descr { + template friend class descr; +public: + constexpr descr(char const (&text) [Size1+1], const std::type_info * const (&types)[Size2+1]) + : descr(text, types, + make_index_sequence(), + make_index_sequence()) { } + + constexpr const char *text() const { return m_text; } + constexpr const std::type_info * const * types() const { return m_types; } + + template + constexpr descr operator+(const descr &other) const { + return concat(other, + make_index_sequence(), + make_index_sequence(), + make_index_sequence(), + make_index_sequence()); + } + +protected: + template + constexpr descr( + char const (&text) [Size1+1], + const std::type_info * const (&types) [Size2+1], + index_sequence, index_sequence) + : m_text{text[Indices1]..., '\0'}, + m_types{types[Indices2]..., nullptr } {} + + template + constexpr descr + concat(const descr &other, + index_sequence, index_sequence, + index_sequence, index_sequence) const { + return descr( + { m_text[Indices1]..., other.m_text[OtherIndices1]..., '\0' }, + { m_types[Indices2]..., other.m_types[OtherIndices2]..., nullptr } + ); + } + +protected: + char m_text[Size1 + 1]; + const std::type_info * m_types[Size2 + 1]; +}; + +template constexpr descr _(char const(&text)[Size]) { + return descr(text, { nullptr }); +} + +template struct int_to_str : int_to_str { }; +template struct int_to_str<0, Digits...> { + static constexpr auto digits = descr({ ('0' + Digits)..., '\0' }, { nullptr }); +}; + +// Ternary description (like std::conditional) +template +constexpr enable_if_t> _(char const(&text1)[Size1], char const(&)[Size2]) { + return _(text1); +} +template +constexpr enable_if_t> _(char const(&)[Size1], char const(&text2)[Size2]) { + return _(text2); +} +template +constexpr enable_if_t> _(descr d, descr) { return d; } +template +constexpr enable_if_t> _(descr, descr d) { return d; } + +template auto constexpr _() -> decltype(int_to_str::digits) { + return int_to_str::digits; +} + +template constexpr descr<1, 1> _() { + return descr<1, 1>({ '%', '\0' }, { &typeid(Type), nullptr }); +} + +inline constexpr descr<0, 0> concat() { return _(""); } +template auto constexpr concat(descr descr) { return descr; } +template auto constexpr concat(descr descr, Args&&... args) { return descr + _(", ") + concat(args...); } +template auto constexpr type_descr(descr descr) { return _("{") + descr + _("}"); } + +#define PYBIND11_DESCR constexpr auto + +#else /* Simpler C++11 implementation based on run-time memory allocation and copying */ + +class descr { +public: + PYBIND11_NOINLINE descr(const char *text, const std::type_info * const * types) { + size_t nChars = len(text), nTypes = len(types); + m_text = new char[nChars]; + m_types = new const std::type_info *[nTypes]; + memcpy(m_text, text, nChars * sizeof(char)); + memcpy(m_types, types, nTypes * sizeof(const std::type_info *)); + } + + PYBIND11_NOINLINE descr operator+(descr &&d2) && { + descr r; + + size_t nChars1 = len(m_text), nTypes1 = len(m_types); + size_t nChars2 = len(d2.m_text), nTypes2 = len(d2.m_types); + + r.m_text = new char[nChars1 + nChars2 - 1]; + r.m_types = new const std::type_info *[nTypes1 + nTypes2 - 1]; + memcpy(r.m_text, m_text, (nChars1-1) * sizeof(char)); + memcpy(r.m_text + nChars1 - 1, d2.m_text, nChars2 * sizeof(char)); + memcpy(r.m_types, m_types, (nTypes1-1) * sizeof(std::type_info *)); + memcpy(r.m_types + nTypes1 - 1, d2.m_types, nTypes2 * sizeof(std::type_info *)); + + delete[] m_text; delete[] m_types; + delete[] d2.m_text; delete[] d2.m_types; + + return r; + } + + char *text() { return m_text; } + const std::type_info * * types() { return m_types; } + +protected: + PYBIND11_NOINLINE descr() { } + + template static size_t len(const T *ptr) { // return length including null termination + const T *it = ptr; + while (*it++ != (T) 0) + ; + return static_cast(it - ptr); + } + + const std::type_info **m_types = nullptr; + char *m_text = nullptr; +}; + +/* The 'PYBIND11_NOINLINE inline' combinations below are intentional to get the desired linkage while producing as little object code as possible */ + +PYBIND11_NOINLINE inline descr _(const char *text) { + const std::type_info *types[1] = { nullptr }; + return descr(text, types); +} + +template PYBIND11_NOINLINE enable_if_t _(const char *text1, const char *) { return _(text1); } +template PYBIND11_NOINLINE enable_if_t _(char const *, const char *text2) { return _(text2); } +template PYBIND11_NOINLINE enable_if_t _(descr d, descr) { return d; } +template PYBIND11_NOINLINE enable_if_t _(descr, descr d) { return d; } + +template PYBIND11_NOINLINE descr _() { + const std::type_info *types[2] = { &typeid(Type), nullptr }; + return descr("%", types); +} + +template PYBIND11_NOINLINE descr _() { + const std::type_info *types[1] = { nullptr }; + return descr(std::to_string(Size).c_str(), types); +} + +PYBIND11_NOINLINE inline descr concat() { return _(""); } +PYBIND11_NOINLINE inline descr concat(descr &&d) { return d; } +template PYBIND11_NOINLINE descr concat(descr &&d, Args&&... args) { return std::move(d) + _(", ") + concat(std::forward(args)...); } +PYBIND11_NOINLINE inline descr type_descr(descr&& d) { return _("{") + std::move(d) + _("}"); } + +#define PYBIND11_DESCR ::pybind11::detail::descr +#endif + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/detail/init.h b/plugins/python/pybind11/include/pybind11/detail/init.h new file mode 100644 index 0000000..82f7407 --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/detail/init.h @@ -0,0 +1,335 @@ +/* + pybind11/detail/init.h: init factory function implementation and support code. + + Copyright (c) 2017 Jason Rhinelander + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "class.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +template <> +class type_caster { +public: + bool load(handle h, bool) { + value = reinterpret_cast(h.ptr()); + return true; + } + + template using cast_op_type = value_and_holder &; + operator value_and_holder &() { return *value; } + static PYBIND11_DESCR name() { return type_descr(_()); } + +private: + value_and_holder *value = nullptr; +}; + +NAMESPACE_BEGIN(initimpl) + +inline void no_nullptr(void *ptr) { + if (!ptr) throw type_error("pybind11::init(): factory function returned nullptr"); +} + +// Implementing functions for all forms of py::init<...> and py::init(...) +template using Cpp = typename Class::type; +template using Alias = typename Class::type_alias; +template using Holder = typename Class::holder_type; + +template using is_alias_constructible = std::is_constructible, Cpp &&>; + +// Takes a Cpp pointer and returns true if it actually is a polymorphic Alias instance. +template = 0> +bool is_alias(Cpp *ptr) { + return dynamic_cast *>(ptr) != nullptr; +} +// Failing fallback version of the above for a no-alias class (always returns false) +template +constexpr bool is_alias(void *) { return false; } + +// Constructs and returns a new object; if the given arguments don't map to a constructor, we fall +// back to brace aggregate initiailization so that for aggregate initialization can be used with +// py::init, e.g. `py::init` to initialize a `struct T { int a; int b; }`. For +// non-aggregate types, we need to use an ordinary T(...) constructor (invoking as `T{...}` usually +// works, but will not do the expected thing when `T` has an `initializer_list` constructor). +template ::value, int> = 0> +inline Class *construct_or_initialize(Args &&...args) { return new Class(std::forward(args)...); } +template ::value, int> = 0> +inline Class *construct_or_initialize(Args &&...args) { return new Class{std::forward(args)...}; } + +// Attempts to constructs an alias using a `Alias(Cpp &&)` constructor. This allows types with +// an alias to provide only a single Cpp factory function as long as the Alias can be +// constructed from an rvalue reference of the base Cpp type. This means that Alias classes +// can, when appropriate, simply define a `Alias(Cpp &&)` constructor rather than needing to +// inherit all the base class constructors. +template +void construct_alias_from_cpp(std::true_type /*is_alias_constructible*/, + value_and_holder &v_h, Cpp &&base) { + v_h.value_ptr() = new Alias(std::move(base)); +} +template +[[noreturn]] void construct_alias_from_cpp(std::false_type /*!is_alias_constructible*/, + value_and_holder &, Cpp &&) { + throw type_error("pybind11::init(): unable to convert returned instance to required " + "alias class: no `Alias(Class &&)` constructor available"); +} + +// Error-generating fallback for factories that don't match one of the below construction +// mechanisms. +template +void construct(...) { + static_assert(!std::is_same::value /* always false */, + "pybind11::init(): init function must return a compatible pointer, " + "holder, or value"); +} + +// Pointer return v1: the factory function returns a class pointer for a registered class. +// If we don't need an alias (because this class doesn't have one, or because the final type is +// inherited on the Python side) we can simply take over ownership. Otherwise we need to try to +// construct an Alias from the returned base instance. +template +void construct(value_and_holder &v_h, Cpp *ptr, bool need_alias) { + no_nullptr(ptr); + if (Class::has_alias && need_alias && !is_alias(ptr)) { + // We're going to try to construct an alias by moving the cpp type. Whether or not + // that succeeds, we still need to destroy the original cpp pointer (either the + // moved away leftover, if the alias construction works, or the value itself if we + // throw an error), but we can't just call `delete ptr`: it might have a special + // deleter, or might be shared_from_this. So we construct a holder around it as if + // it was a normal instance, then steal the holder away into a local variable; thus + // the holder and destruction happens when we leave the C++ scope, and the holder + // class gets to handle the destruction however it likes. + v_h.value_ptr() = ptr; + v_h.set_instance_registered(true); // To prevent init_instance from registering it + v_h.type->init_instance(v_h.inst, nullptr); // Set up the holder + Holder temp_holder(std::move(v_h.holder>())); // Steal the holder + v_h.type->dealloc(v_h); // Destroys the moved-out holder remains, resets value ptr to null + v_h.set_instance_registered(false); + + construct_alias_from_cpp(is_alias_constructible{}, v_h, std::move(*ptr)); + } else { + // Otherwise the type isn't inherited, so we don't need an Alias + v_h.value_ptr() = ptr; + } +} + +// Pointer return v2: a factory that always returns an alias instance ptr. We simply take over +// ownership of the pointer. +template = 0> +void construct(value_and_holder &v_h, Alias *alias_ptr, bool) { + no_nullptr(alias_ptr); + v_h.value_ptr() = static_cast *>(alias_ptr); +} + +// Holder return: copy its pointer, and move or copy the returned holder into the new instance's +// holder. This also handles types like std::shared_ptr and std::unique_ptr where T is a +// derived type (through those holder's implicit conversion from derived class holder constructors). +template +void construct(value_and_holder &v_h, Holder holder, bool need_alias) { + auto *ptr = holder_helper>::get(holder); + // If we need an alias, check that the held pointer is actually an alias instance + if (Class::has_alias && need_alias && !is_alias(ptr)) + throw type_error("pybind11::init(): construction failed: returned holder-wrapped instance " + "is not an alias instance"); + + v_h.value_ptr() = ptr; + v_h.type->init_instance(v_h.inst, &holder); +} + +// return-by-value version 1: returning a cpp class by value. If the class has an alias and an +// alias is required the alias must have an `Alias(Cpp &&)` constructor so that we can construct +// the alias from the base when needed (i.e. because of Python-side inheritance). When we don't +// need it, we simply move-construct the cpp value into a new instance. +template +void construct(value_and_holder &v_h, Cpp &&result, bool need_alias) { + static_assert(std::is_move_constructible>::value, + "pybind11::init() return-by-value factory function requires a movable class"); + if (Class::has_alias && need_alias) + construct_alias_from_cpp(is_alias_constructible{}, v_h, std::move(result)); + else + v_h.value_ptr() = new Cpp(std::move(result)); +} + +// return-by-value version 2: returning a value of the alias type itself. We move-construct an +// Alias instance (even if no the python-side inheritance is involved). The is intended for +// cases where Alias initialization is always desired. +template +void construct(value_and_holder &v_h, Alias &&result, bool) { + static_assert(std::is_move_constructible>::value, + "pybind11::init() return-by-alias-value factory function requires a movable alias class"); + v_h.value_ptr() = new Alias(std::move(result)); +} + +// Implementing class for py::init<...>() +template +struct constructor { + template = 0> + static void execute(Class &cl, const Extra&... extra) { + cl.def("__init__", [](value_and_holder &v_h, Args... args) { + v_h.value_ptr() = construct_or_initialize>(std::forward(args)...); + }, is_new_style_constructor(), extra...); + } + + template , Args...>::value, int> = 0> + static void execute(Class &cl, const Extra&... extra) { + cl.def("__init__", [](value_and_holder &v_h, Args... args) { + if (Py_TYPE(v_h.inst) == v_h.type->type) + v_h.value_ptr() = construct_or_initialize>(std::forward(args)...); + else + v_h.value_ptr() = construct_or_initialize>(std::forward(args)...); + }, is_new_style_constructor(), extra...); + } + + template , Args...>::value, int> = 0> + static void execute(Class &cl, const Extra&... extra) { + cl.def("__init__", [](value_and_holder &v_h, Args... args) { + v_h.value_ptr() = construct_or_initialize>(std::forward(args)...); + }, is_new_style_constructor(), extra...); + } +}; + +// Implementing class for py::init_alias<...>() +template struct alias_constructor { + template , Args...>::value, int> = 0> + static void execute(Class &cl, const Extra&... extra) { + cl.def("__init__", [](value_and_holder &v_h, Args... args) { + v_h.value_ptr() = construct_or_initialize>(std::forward(args)...); + }, is_new_style_constructor(), extra...); + } +}; + +// Implementation class for py::init(Func) and py::init(Func, AliasFunc) +template , typename = function_signature_t> +struct factory; + +// Specialization for py::init(Func) +template +struct factory { + remove_reference_t class_factory; + + factory(Func &&f) : class_factory(std::forward(f)) { } + + // The given class either has no alias or has no separate alias factory; + // this always constructs the class itself. If the class is registered with an alias + // type and an alias instance is needed (i.e. because the final type is a Python class + // inheriting from the C++ type) the returned value needs to either already be an alias + // instance, or the alias needs to be constructible from a `Class &&` argument. + template + void execute(Class &cl, const Extra &...extra) && { + #if defined(PYBIND11_CPP14) + cl.def("__init__", [func = std::move(class_factory)] + #else + auto &func = class_factory; + cl.def("__init__", [func] + #endif + (value_and_holder &v_h, Args... args) { + construct(v_h, func(std::forward(args)...), + Py_TYPE(v_h.inst) != v_h.type->type); + }, is_new_style_constructor(), extra...); + } +}; + +// Specialization for py::init(Func, AliasFunc) +template +struct factory { + static_assert(sizeof...(CArgs) == sizeof...(AArgs), + "pybind11::init(class_factory, alias_factory): class and alias factories " + "must have identical argument signatures"); + static_assert(all_of...>::value, + "pybind11::init(class_factory, alias_factory): class and alias factories " + "must have identical argument signatures"); + + remove_reference_t class_factory; + remove_reference_t alias_factory; + + factory(CFunc &&c, AFunc &&a) + : class_factory(std::forward(c)), alias_factory(std::forward(a)) { } + + // The class factory is called when the `self` type passed to `__init__` is the direct + // class (i.e. not inherited), the alias factory when `self` is a Python-side subtype. + template + void execute(Class &cl, const Extra&... extra) && { + static_assert(Class::has_alias, "The two-argument version of `py::init()` can " + "only be used if the class has an alias"); + #if defined(PYBIND11_CPP14) + cl.def("__init__", [class_func = std::move(class_factory), alias_func = std::move(alias_factory)] + #else + auto &class_func = class_factory; + auto &alias_func = alias_factory; + cl.def("__init__", [class_func, alias_func] + #endif + (value_and_holder &v_h, CArgs... args) { + if (Py_TYPE(v_h.inst) == v_h.type->type) + // If the instance type equals the registered type we don't have inheritance, so + // don't need the alias and can construct using the class function: + construct(v_h, class_func(std::forward(args)...), false); + else + construct(v_h, alias_func(std::forward(args)...), true); + }, is_new_style_constructor(), extra...); + } +}; + +/// Set just the C++ state. Same as `__init__`. +template +void setstate(value_and_holder &v_h, T &&result, bool need_alias) { + construct(v_h, std::forward(result), need_alias); +} + +/// Set both the C++ and Python states +template ::value, int> = 0> +void setstate(value_and_holder &v_h, std::pair &&result, bool need_alias) { + construct(v_h, std::move(result.first), need_alias); + setattr((PyObject *) v_h.inst, "__dict__", result.second); +} + +/// Implementation for py::pickle(GetState, SetState) +template , typename = function_signature_t> +struct pickle_factory; + +template +struct pickle_factory { + static_assert(std::is_same, intrinsic_t>::value, + "The type returned by `__getstate__` must be the same " + "as the argument accepted by `__setstate__`"); + + remove_reference_t get; + remove_reference_t set; + + pickle_factory(Get get, Set set) + : get(std::forward(get)), set(std::forward(set)) { } + + template + void execute(Class &cl, const Extra &...extra) && { + cl.def("__getstate__", std::move(get)); + +#if defined(PYBIND11_CPP14) + cl.def("__setstate__", [func = std::move(set)] +#else + auto &func = set; + cl.def("__setstate__", [func] +#endif + (value_and_holder &v_h, ArgState state) { + setstate(v_h, func(std::forward(state)), + Py_TYPE(v_h.inst) != v_h.type->type); + }, is_new_style_constructor(), extra...); + } +}; + +NAMESPACE_END(initimpl) +NAMESPACE_END(detail) +NAMESPACE_END(pybind11) diff --git a/plugins/python/pybind11/include/pybind11/detail/internals.h b/plugins/python/pybind11/include/pybind11/detail/internals.h new file mode 100644 index 0000000..78d4afe --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/detail/internals.h @@ -0,0 +1,285 @@ +/* + pybind11/detail/internals.h: Internal data structure and related functions + + Copyright (c) 2017 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "../pytypes.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) +// Forward declarations +inline PyTypeObject *make_static_property_type(); +inline PyTypeObject *make_default_metaclass(); +inline PyObject *make_object_base_type(PyTypeObject *metaclass); + +// The old Python Thread Local Storage (TLS) API is deprecated in Python 3.7 in favor of the new +// Thread Specific Storage (TSS) API. +#if PY_VERSION_HEX >= 0x03070000 +# define PYBIND11_TLS_KEY_INIT(var) Py_tss_t *var = nullptr +# define PYBIND11_TLS_GET_VALUE(key) PyThread_tss_get((key)) +# define PYBIND11_TLS_REPLACE_VALUE(key, value) PyThread_tss_set((key), (tstate)) +# define PYBIND11_TLS_DELETE_VALUE(key) PyThread_tss_set((key), nullptr) +#else + // Usually an int but a long on Cygwin64 with Python 3.x +# define PYBIND11_TLS_KEY_INIT(var) decltype(PyThread_create_key()) var = 0 +# define PYBIND11_TLS_GET_VALUE(key) PyThread_get_key_value((key)) +# if PY_MAJOR_VERSION < 3 +# define PYBIND11_TLS_DELETE_VALUE(key) \ + PyThread_delete_key_value(key) +# define PYBIND11_TLS_REPLACE_VALUE(key, value) \ + do { \ + PyThread_delete_key_value((key)); \ + PyThread_set_key_value((key), (value)); \ + } while (false) +# else +# define PYBIND11_TLS_DELETE_VALUE(key) \ + PyThread_set_key_value((key), nullptr) +# define PYBIND11_TLS_REPLACE_VALUE(key, value) \ + PyThread_set_key_value((key), (value)) +# endif +#endif + +// Python loads modules by default with dlopen with the RTLD_LOCAL flag; under libc++ and possibly +// other STLs, this means `typeid(A)` from one module won't equal `typeid(A)` from another module +// even when `A` is the same, non-hidden-visibility type (e.g. from a common include). Under +// libstdc++, this doesn't happen: equality and the type_index hash are based on the type name, +// which works. If not under a known-good stl, provide our own name-based hash and equality +// functions that use the type name. +#if defined(__GLIBCXX__) +inline bool same_type(const std::type_info &lhs, const std::type_info &rhs) { return lhs == rhs; } +using type_hash = std::hash; +using type_equal_to = std::equal_to; +#else +inline bool same_type(const std::type_info &lhs, const std::type_info &rhs) { + return lhs.name() == rhs.name() || std::strcmp(lhs.name(), rhs.name()) == 0; +} + +struct type_hash { + size_t operator()(const std::type_index &t) const { + size_t hash = 5381; + const char *ptr = t.name(); + while (auto c = static_cast(*ptr++)) + hash = (hash * 33) ^ c; + return hash; + } +}; + +struct type_equal_to { + bool operator()(const std::type_index &lhs, const std::type_index &rhs) const { + return lhs.name() == rhs.name() || std::strcmp(lhs.name(), rhs.name()) == 0; + } +}; +#endif + +template +using type_map = std::unordered_map; + +struct overload_hash { + inline size_t operator()(const std::pair& v) const { + size_t value = std::hash()(v.first); + value ^= std::hash()(v.second) + 0x9e3779b9 + (value<<6) + (value>>2); + return value; + } +}; + +/// Internal data structure used to track registered instances and types. +/// Whenever binary incompatible changes are made to this structure, +/// `PYBIND11_INTERNALS_VERSION` must be incremented. +struct internals { + type_map registered_types_cpp; // std::type_index -> pybind11's type information + std::unordered_map> registered_types_py; // PyTypeObject* -> base type_info(s) + std::unordered_multimap registered_instances; // void * -> instance* + std::unordered_set, overload_hash> inactive_overload_cache; + type_map> direct_conversions; + std::unordered_map> patients; + std::forward_list registered_exception_translators; + std::unordered_map shared_data; // Custom data to be shared across extensions + std::vector loader_patient_stack; // Used by `loader_life_support` + std::forward_list static_strings; // Stores the std::strings backing detail::c_str() + PyTypeObject *static_property_type; + PyTypeObject *default_metaclass; + PyObject *instance_base; +#if defined(WITH_THREAD) + PYBIND11_TLS_KEY_INIT(tstate); + PyInterpreterState *istate = nullptr; +#endif +}; + +/// Additional type information which does not fit into the PyTypeObject. +/// Changes to this struct also require bumping `PYBIND11_INTERNALS_VERSION`. +struct type_info { + PyTypeObject *type; + const std::type_info *cpptype; + size_t type_size, holder_size_in_ptrs; + void *(*operator_new)(size_t); + void (*init_instance)(instance *, const void *); + void (*dealloc)(value_and_holder &v_h); + std::vector implicit_conversions; + std::vector> implicit_casts; + std::vector *direct_conversions; + buffer_info *(*get_buffer)(PyObject *, void *) = nullptr; + void *get_buffer_data = nullptr; + void *(*module_local_load)(PyObject *, const type_info *) = nullptr; + /* A simple type never occurs as a (direct or indirect) parent + * of a class that makes use of multiple inheritance */ + bool simple_type : 1; + /* True if there is no multiple inheritance in this type's inheritance tree */ + bool simple_ancestors : 1; + /* for base vs derived holder_type checks */ + bool default_holder : 1; + /* true if this is a type registered with py::module_local */ + bool module_local : 1; +}; + +/// Tracks the `internals` and `type_info` ABI version independent of the main library version +#define PYBIND11_INTERNALS_VERSION 2 + +#if defined(WITH_THREAD) +# define PYBIND11_INTERNALS_KIND "" +#else +# define PYBIND11_INTERNALS_KIND "_without_thread" +#endif + +#define PYBIND11_INTERNALS_ID "__pybind11_internals_v" \ + PYBIND11_TOSTRING(PYBIND11_INTERNALS_VERSION) PYBIND11_INTERNALS_KIND "__" + +#define PYBIND11_MODULE_LOCAL_ID "__pybind11_module_local_v" \ + PYBIND11_TOSTRING(PYBIND11_INTERNALS_VERSION) PYBIND11_INTERNALS_KIND "__" + +/// Each module locally stores a pointer to the `internals` data. The data +/// itself is shared among modules with the same `PYBIND11_INTERNALS_ID`. +inline internals **&get_internals_pp() { + static internals **internals_pp = nullptr; + return internals_pp; +} + +/// Return a reference to the current `internals` data +PYBIND11_NOINLINE inline internals &get_internals() { + auto **&internals_pp = get_internals_pp(); + if (internals_pp && *internals_pp) + return **internals_pp; + + constexpr auto *id = PYBIND11_INTERNALS_ID; + auto builtins = handle(PyEval_GetBuiltins()); + if (builtins.contains(id) && isinstance(builtins[id])) { + internals_pp = static_cast(capsule(builtins[id])); + + // We loaded builtins through python's builtins, which means that our `error_already_set` + // and `builtin_exception` may be different local classes than the ones set up in the + // initial exception translator, below, so add another for our local exception classes. + // + // libstdc++ doesn't require this (types there are identified only by name) +#if !defined(__GLIBCXX__) + (*internals_pp)->registered_exception_translators.push_front( + [](std::exception_ptr p) -> void { + try { + if (p) std::rethrow_exception(p); + } catch (error_already_set &e) { e.restore(); return; + } catch (const builtin_exception &e) { e.set_error(); return; + } + } + ); +#endif + } else { + if (!internals_pp) internals_pp = new internals*(); + auto *&internals_ptr = *internals_pp; + internals_ptr = new internals(); +#if defined(WITH_THREAD) + PyEval_InitThreads(); + PyThreadState *tstate = PyThreadState_Get(); + #if PY_VERSION_HEX >= 0x03070000 + internals_ptr->tstate = PyThread_tss_alloc(); + if (!internals_ptr->tstate || PyThread_tss_create(internals_ptr->tstate)) + pybind11_fail("get_internals: could not successfully initialize the TSS key!"); + PyThread_tss_set(internals_ptr->tstate, tstate); + #else + internals_ptr->tstate = PyThread_create_key(); + if (internals_ptr->tstate == -1) + pybind11_fail("get_internals: could not successfully initialize the TLS key!"); + PyThread_set_key_value(internals_ptr->tstate, tstate); + #endif + internals_ptr->istate = tstate->interp; +#endif + builtins[id] = capsule(internals_pp); + internals_ptr->registered_exception_translators.push_front( + [](std::exception_ptr p) -> void { + try { + if (p) std::rethrow_exception(p); + } catch (error_already_set &e) { e.restore(); return; + } catch (const builtin_exception &e) { e.set_error(); return; + } catch (const std::bad_alloc &e) { PyErr_SetString(PyExc_MemoryError, e.what()); return; + } catch (const std::domain_error &e) { PyErr_SetString(PyExc_ValueError, e.what()); return; + } catch (const std::invalid_argument &e) { PyErr_SetString(PyExc_ValueError, e.what()); return; + } catch (const std::length_error &e) { PyErr_SetString(PyExc_ValueError, e.what()); return; + } catch (const std::out_of_range &e) { PyErr_SetString(PyExc_IndexError, e.what()); return; + } catch (const std::range_error &e) { PyErr_SetString(PyExc_ValueError, e.what()); return; + } catch (const std::exception &e) { PyErr_SetString(PyExc_RuntimeError, e.what()); return; + } catch (...) { + PyErr_SetString(PyExc_RuntimeError, "Caught an unknown exception!"); + return; + } + } + ); + internals_ptr->static_property_type = make_static_property_type(); + internals_ptr->default_metaclass = make_default_metaclass(); + internals_ptr->instance_base = make_object_base_type(internals_ptr->default_metaclass); + } + return **internals_pp; +} + +/// Works like `internals.registered_types_cpp`, but for module-local registered types: +inline type_map ®istered_local_types_cpp() { + static type_map locals{}; + return locals; +} + +/// Constructs a std::string with the given arguments, stores it in `internals`, and returns its +/// `c_str()`. Such strings objects have a long storage duration -- the internal strings are only +/// cleared when the program exits or after interpreter shutdown (when embedding), and so are +/// suitable for c-style strings needed by Python internals (such as PyTypeObject's tp_name). +template +const char *c_str(Args &&...args) { + auto &strings = get_internals().static_strings; + strings.emplace_front(std::forward(args)...); + return strings.front().c_str(); +} + +NAMESPACE_END(detail) + +/// Returns a named pointer that is shared among all extension modules (using the same +/// pybind11 version) running in the current interpreter. Names starting with underscores +/// are reserved for internal usage. Returns `nullptr` if no matching entry was found. +inline PYBIND11_NOINLINE void *get_shared_data(const std::string &name) { + auto &internals = detail::get_internals(); + auto it = internals.shared_data.find(name); + return it != internals.shared_data.end() ? it->second : nullptr; +} + +/// Set the shared data that can be later recovered by `get_shared_data()`. +inline PYBIND11_NOINLINE void *set_shared_data(const std::string &name, void *data) { + detail::get_internals().shared_data[name] = data; + return data; +} + +/// Returns a typed reference to a shared data entry (by using `get_shared_data()`) if +/// such entry exists. Otherwise, a new object of default-constructible type `T` is +/// added to the shared data under the given name and a reference to it is returned. +template +T &get_or_create_shared_data(const std::string &name) { + auto &internals = detail::get_internals(); + auto it = internals.shared_data.find(name); + T *ptr = (T *) (it != internals.shared_data.end() ? it->second : nullptr); + if (!ptr) { + ptr = new T(); + internals.shared_data[name] = ptr; + } + return *ptr; +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/detail/typeid.h b/plugins/python/pybind11/include/pybind11/detail/typeid.h new file mode 100644 index 0000000..6f36aab --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/detail/typeid.h @@ -0,0 +1,53 @@ +/* + pybind11/detail/typeid.h: Compiler-independent access to type identifiers + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include +#include + +#if defined(__GNUG__) +#include +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) +/// Erase all occurrences of a substring +inline void erase_all(std::string &string, const std::string &search) { + for (size_t pos = 0;;) { + pos = string.find(search, pos); + if (pos == std::string::npos) break; + string.erase(pos, search.length()); + } +} + +PYBIND11_NOINLINE inline void clean_type_id(std::string &name) { +#if defined(__GNUG__) + int status = 0; + std::unique_ptr res { + abi::__cxa_demangle(name.c_str(), nullptr, nullptr, &status), std::free }; + if (status == 0) + name = res.get(); +#else + detail::erase_all(name, "class "); + detail::erase_all(name, "struct "); + detail::erase_all(name, "enum "); +#endif + detail::erase_all(name, "pybind11::"); +} +NAMESPACE_END(detail) + +/// Return a string representation of a C++ type +template static std::string type_id() { + std::string name(typeid(T).name()); + detail::clean_type_id(name); + return name; +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/eigen.h b/plugins/python/pybind11/include/pybind11/eigen.h new file mode 100644 index 0000000..0899ec7 --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/eigen.h @@ -0,0 +1,604 @@ +/* + pybind11/eigen.h: Transparent conversion for dense and sparse Eigen matrices + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "numpy.h" + +#if defined(__INTEL_COMPILER) +# pragma warning(disable: 1682) // implicit conversion of a 64-bit integral type to a smaller integral type (potential portability problem) +#elif defined(__GNUG__) || defined(__clang__) +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wconversion" +# pragma GCC diagnostic ignored "-Wdeprecated-declarations" +# if __GNUC__ >= 7 +# pragma GCC diagnostic ignored "-Wint-in-bool-context" +# endif +#endif + +#if defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable: 4127) // warning C4127: Conditional expression is constant +# pragma warning(disable: 4996) // warning C4996: std::unary_negate is deprecated in C++17 +#endif + +#include +#include + +// Eigen prior to 3.2.7 doesn't have proper move constructors--but worse, some classes get implicit +// move constructors that break things. We could detect this an explicitly copy, but an extra copy +// of matrices seems highly undesirable. +static_assert(EIGEN_VERSION_AT_LEAST(3,2,7), "Eigen support in pybind11 requires Eigen >= 3.2.7"); + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +// Provide a convenience alias for easier pass-by-ref usage with fully dynamic strides: +using EigenDStride = Eigen::Stride; +template using EigenDRef = Eigen::Ref; +template using EigenDMap = Eigen::Map; + +NAMESPACE_BEGIN(detail) + +#if EIGEN_VERSION_AT_LEAST(3,3,0) +using EigenIndex = Eigen::Index; +#else +using EigenIndex = EIGEN_DEFAULT_DENSE_INDEX_TYPE; +#endif + +// Matches Eigen::Map, Eigen::Ref, blocks, etc: +template using is_eigen_dense_map = all_of, std::is_base_of, T>>; +template using is_eigen_mutable_map = std::is_base_of, T>; +template using is_eigen_dense_plain = all_of>, is_template_base_of>; +template using is_eigen_sparse = is_template_base_of; +// Test for objects inheriting from EigenBase that aren't captured by the above. This +// basically covers anything that can be assigned to a dense matrix but that don't have a typical +// matrix data layout that can be copied from their .data(). For example, DiagonalMatrix and +// SelfAdjointView fall into this category. +template using is_eigen_other = all_of< + is_template_base_of, + negation, is_eigen_dense_plain, is_eigen_sparse>> +>; + +// Captures numpy/eigen conformability status (returned by EigenProps::conformable()): +template struct EigenConformable { + bool conformable = false; + EigenIndex rows = 0, cols = 0; + EigenDStride stride{0, 0}; // Only valid if negativestrides is false! + bool negativestrides = false; // If true, do not use stride! + + EigenConformable(bool fits = false) : conformable{fits} {} + // Matrix type: + EigenConformable(EigenIndex r, EigenIndex c, + EigenIndex rstride, EigenIndex cstride) : + conformable{true}, rows{r}, cols{c} { + // TODO: when Eigen bug #747 is fixed, remove the tests for non-negativity. http://eigen.tuxfamily.org/bz/show_bug.cgi?id=747 + if (rstride < 0 || cstride < 0) { + negativestrides = true; + } else { + stride = {EigenRowMajor ? rstride : cstride /* outer stride */, + EigenRowMajor ? cstride : rstride /* inner stride */ }; + } + } + // Vector type: + EigenConformable(EigenIndex r, EigenIndex c, EigenIndex stride) + : EigenConformable(r, c, r == 1 ? c*stride : stride, c == 1 ? r : r*stride) {} + + template bool stride_compatible() const { + // To have compatible strides, we need (on both dimensions) one of fully dynamic strides, + // matching strides, or a dimension size of 1 (in which case the stride value is irrelevant) + return + !negativestrides && + (props::inner_stride == Eigen::Dynamic || props::inner_stride == stride.inner() || + (EigenRowMajor ? cols : rows) == 1) && + (props::outer_stride == Eigen::Dynamic || props::outer_stride == stride.outer() || + (EigenRowMajor ? rows : cols) == 1); + } + operator bool() const { return conformable; } +}; + +template struct eigen_extract_stride { using type = Type; }; +template +struct eigen_extract_stride> { using type = StrideType; }; +template +struct eigen_extract_stride> { using type = StrideType; }; + +// Helper struct for extracting information from an Eigen type +template struct EigenProps { + using Type = Type_; + using Scalar = typename Type::Scalar; + using StrideType = typename eigen_extract_stride::type; + static constexpr EigenIndex + rows = Type::RowsAtCompileTime, + cols = Type::ColsAtCompileTime, + size = Type::SizeAtCompileTime; + static constexpr bool + row_major = Type::IsRowMajor, + vector = Type::IsVectorAtCompileTime, // At least one dimension has fixed size 1 + fixed_rows = rows != Eigen::Dynamic, + fixed_cols = cols != Eigen::Dynamic, + fixed = size != Eigen::Dynamic, // Fully-fixed size + dynamic = !fixed_rows && !fixed_cols; // Fully-dynamic size + + template using if_zero = std::integral_constant; + static constexpr EigenIndex inner_stride = if_zero::value, + outer_stride = if_zero::value; + static constexpr bool dynamic_stride = inner_stride == Eigen::Dynamic && outer_stride == Eigen::Dynamic; + static constexpr bool requires_row_major = !dynamic_stride && !vector && (row_major ? inner_stride : outer_stride) == 1; + static constexpr bool requires_col_major = !dynamic_stride && !vector && (row_major ? outer_stride : inner_stride) == 1; + + // Takes an input array and determines whether we can make it fit into the Eigen type. If + // the array is a vector, we attempt to fit it into either an Eigen 1xN or Nx1 vector + // (preferring the latter if it will fit in either, i.e. for a fully dynamic matrix type). + static EigenConformable conformable(const array &a) { + const auto dims = a.ndim(); + if (dims < 1 || dims > 2) + return false; + + if (dims == 2) { // Matrix type: require exact match (or dynamic) + + EigenIndex + np_rows = a.shape(0), + np_cols = a.shape(1), + np_rstride = a.strides(0) / static_cast(sizeof(Scalar)), + np_cstride = a.strides(1) / static_cast(sizeof(Scalar)); + if ((fixed_rows && np_rows != rows) || (fixed_cols && np_cols != cols)) + return false; + + return {np_rows, np_cols, np_rstride, np_cstride}; + } + + // Otherwise we're storing an n-vector. Only one of the strides will be used, but whichever + // is used, we want the (single) numpy stride value. + const EigenIndex n = a.shape(0), + stride = a.strides(0) / static_cast(sizeof(Scalar)); + + if (vector) { // Eigen type is a compile-time vector + if (fixed && size != n) + return false; // Vector size mismatch + return {rows == 1 ? 1 : n, cols == 1 ? 1 : n, stride}; + } + else if (fixed) { + // The type has a fixed size, but is not a vector: abort + return false; + } + else if (fixed_cols) { + // Since this isn't a vector, cols must be != 1. We allow this only if it exactly + // equals the number of elements (rows is Dynamic, and so 1 row is allowed). + if (cols != n) return false; + return {1, n, stride}; + } + else { + // Otherwise it's either fully dynamic, or column dynamic; both become a column vector + if (fixed_rows && rows != n) return false; + return {n, 1, stride}; + } + } + + static PYBIND11_DESCR descriptor() { + constexpr bool show_writeable = is_eigen_dense_map::value && is_eigen_mutable_map::value; + constexpr bool show_order = is_eigen_dense_map::value; + constexpr bool show_c_contiguous = show_order && requires_row_major; + constexpr bool show_f_contiguous = !show_c_contiguous && show_order && requires_col_major; + + return type_descr(_("numpy.ndarray[") + npy_format_descriptor::name() + + _("[") + _(_<(size_t) rows>(), _("m")) + + _(", ") + _(_<(size_t) cols>(), _("n")) + + _("]") + + // For a reference type (e.g. Ref) we have other constraints that might need to be + // satisfied: writeable=True (for a mutable reference), and, depending on the map's stride + // options, possibly f_contiguous or c_contiguous. We include them in the descriptor output + // to provide some hint as to why a TypeError is occurring (otherwise it can be confusing to + // see that a function accepts a 'numpy.ndarray[float64[3,2]]' and an error message that you + // *gave* a numpy.ndarray of the right type and dimensions. + _(", flags.writeable", "") + + _(", flags.c_contiguous", "") + + _(", flags.f_contiguous", "") + + _("]") + ); + } +}; + +// Casts an Eigen type to numpy array. If given a base, the numpy array references the src data, +// otherwise it'll make a copy. writeable lets you turn off the writeable flag for the array. +template handle eigen_array_cast(typename props::Type const &src, handle base = handle(), bool writeable = true) { + constexpr ssize_t elem_size = sizeof(typename props::Scalar); + array a; + if (props::vector) + a = array({ src.size() }, { elem_size * src.innerStride() }, src.data(), base); + else + a = array({ src.rows(), src.cols() }, { elem_size * src.rowStride(), elem_size * src.colStride() }, + src.data(), base); + + if (!writeable) + array_proxy(a.ptr())->flags &= ~detail::npy_api::NPY_ARRAY_WRITEABLE_; + + return a.release(); +} + +// Takes an lvalue ref to some Eigen type and a (python) base object, creating a numpy array that +// reference the Eigen object's data with `base` as the python-registered base class (if omitted, +// the base will be set to None, and lifetime management is up to the caller). The numpy array is +// non-writeable if the given type is const. +template +handle eigen_ref_array(Type &src, handle parent = none()) { + // none here is to get past array's should-we-copy detection, which currently always + // copies when there is no base. Setting the base to None should be harmless. + return eigen_array_cast(src, parent, !std::is_const::value); +} + +// Takes a pointer to some dense, plain Eigen type, builds a capsule around it, then returns a numpy +// array that references the encapsulated data with a python-side reference to the capsule to tie +// its destruction to that of any dependent python objects. Const-ness is determined by whether or +// not the Type of the pointer given is const. +template ::value>> +handle eigen_encapsulate(Type *src) { + capsule base(src, [](void *o) { delete static_cast(o); }); + return eigen_ref_array(*src, base); +} + +// Type caster for regular, dense matrix types (e.g. MatrixXd), but not maps/refs/etc. of dense +// types. +template +struct type_caster::value>> { + using Scalar = typename Type::Scalar; + using props = EigenProps; + + bool load(handle src, bool convert) { + // If we're in no-convert mode, only load if given an array of the correct type + if (!convert && !isinstance>(src)) + return false; + + // Coerce into an array, but don't do type conversion yet; the copy below handles it. + auto buf = array::ensure(src); + + if (!buf) + return false; + + auto dims = buf.ndim(); + if (dims < 1 || dims > 2) + return false; + + auto fits = props::conformable(buf); + if (!fits) + return false; + + // Allocate the new type, then build a numpy reference into it + value = Type(fits.rows, fits.cols); + auto ref = reinterpret_steal(eigen_ref_array(value)); + if (dims == 1) ref = ref.squeeze(); + else if (ref.ndim() == 1) buf = buf.squeeze(); + + int result = detail::npy_api::get().PyArray_CopyInto_(ref.ptr(), buf.ptr()); + + if (result < 0) { // Copy failed! + PyErr_Clear(); + return false; + } + + return true; + } + +private: + + // Cast implementation + template + static handle cast_impl(CType *src, return_value_policy policy, handle parent) { + switch (policy) { + case return_value_policy::take_ownership: + case return_value_policy::automatic: + return eigen_encapsulate(src); + case return_value_policy::move: + return eigen_encapsulate(new CType(std::move(*src))); + case return_value_policy::copy: + return eigen_array_cast(*src); + case return_value_policy::reference: + case return_value_policy::automatic_reference: + return eigen_ref_array(*src); + case return_value_policy::reference_internal: + return eigen_ref_array(*src, parent); + default: + throw cast_error("unhandled return_value_policy: should not happen!"); + }; + } + +public: + + // Normal returned non-reference, non-const value: + static handle cast(Type &&src, return_value_policy /* policy */, handle parent) { + return cast_impl(&src, return_value_policy::move, parent); + } + // If you return a non-reference const, we mark the numpy array readonly: + static handle cast(const Type &&src, return_value_policy /* policy */, handle parent) { + return cast_impl(&src, return_value_policy::move, parent); + } + // lvalue reference return; default (automatic) becomes copy + static handle cast(Type &src, return_value_policy policy, handle parent) { + if (policy == return_value_policy::automatic || policy == return_value_policy::automatic_reference) + policy = return_value_policy::copy; + return cast_impl(&src, policy, parent); + } + // const lvalue reference return; default (automatic) becomes copy + static handle cast(const Type &src, return_value_policy policy, handle parent) { + if (policy == return_value_policy::automatic || policy == return_value_policy::automatic_reference) + policy = return_value_policy::copy; + return cast(&src, policy, parent); + } + // non-const pointer return + static handle cast(Type *src, return_value_policy policy, handle parent) { + return cast_impl(src, policy, parent); + } + // const pointer return + static handle cast(const Type *src, return_value_policy policy, handle parent) { + return cast_impl(src, policy, parent); + } + + static PYBIND11_DESCR name() { return props::descriptor(); } + + operator Type*() { return &value; } + operator Type&() { return value; } + operator Type&&() && { return std::move(value); } + template using cast_op_type = movable_cast_op_type; + +private: + Type value; +}; + +// Base class for casting reference/map/block/etc. objects back to python. +template struct eigen_map_caster { +private: + using props = EigenProps; + +public: + + // Directly referencing a ref/map's data is a bit dangerous (whatever the map/ref points to has + // to stay around), but we'll allow it under the assumption that you know what you're doing (and + // have an appropriate keep_alive in place). We return a numpy array pointing directly at the + // ref's data (The numpy array ends up read-only if the ref was to a const matrix type.) Note + // that this means you need to ensure you don't destroy the object in some other way (e.g. with + // an appropriate keep_alive, or with a reference to a statically allocated matrix). + static handle cast(const MapType &src, return_value_policy policy, handle parent) { + switch (policy) { + case return_value_policy::copy: + return eigen_array_cast(src); + case return_value_policy::reference_internal: + return eigen_array_cast(src, parent, is_eigen_mutable_map::value); + case return_value_policy::reference: + case return_value_policy::automatic: + case return_value_policy::automatic_reference: + return eigen_array_cast(src, none(), is_eigen_mutable_map::value); + default: + // move, take_ownership don't make any sense for a ref/map: + pybind11_fail("Invalid return_value_policy for Eigen Map/Ref/Block type"); + } + } + + static PYBIND11_DESCR name() { return props::descriptor(); } + + // Explicitly delete these: support python -> C++ conversion on these (i.e. these can be return + // types but not bound arguments). We still provide them (with an explicitly delete) so that + // you end up here if you try anyway. + bool load(handle, bool) = delete; + operator MapType() = delete; + template using cast_op_type = MapType; +}; + +// We can return any map-like object (but can only load Refs, specialized next): +template struct type_caster::value>> + : eigen_map_caster {}; + +// Loader for Ref<...> arguments. See the documentation for info on how to make this work without +// copying (it requires some extra effort in many cases). +template +struct type_caster< + Eigen::Ref, + enable_if_t>::value> +> : public eigen_map_caster> { +private: + using Type = Eigen::Ref; + using props = EigenProps; + using Scalar = typename props::Scalar; + using MapType = Eigen::Map; + using Array = array_t; + static constexpr bool need_writeable = is_eigen_mutable_map::value; + // Delay construction (these have no default constructor) + std::unique_ptr map; + std::unique_ptr ref; + // Our array. When possible, this is just a numpy array pointing to the source data, but + // sometimes we can't avoid copying (e.g. input is not a numpy array at all, has an incompatible + // layout, or is an array of a type that needs to be converted). Using a numpy temporary + // (rather than an Eigen temporary) saves an extra copy when we need both type conversion and + // storage order conversion. (Note that we refuse to use this temporary copy when loading an + // argument for a Ref with M non-const, i.e. a read-write reference). + Array copy_or_ref; +public: + bool load(handle src, bool convert) { + // First check whether what we have is already an array of the right type. If not, we can't + // avoid a copy (because the copy is also going to do type conversion). + bool need_copy = !isinstance(src); + + EigenConformable fits; + if (!need_copy) { + // We don't need a converting copy, but we also need to check whether the strides are + // compatible with the Ref's stride requirements + Array aref = reinterpret_borrow(src); + + if (aref && (!need_writeable || aref.writeable())) { + fits = props::conformable(aref); + if (!fits) return false; // Incompatible dimensions + if (!fits.template stride_compatible()) + need_copy = true; + else + copy_or_ref = std::move(aref); + } + else { + need_copy = true; + } + } + + if (need_copy) { + // We need to copy: If we need a mutable reference, or we're not supposed to convert + // (either because we're in the no-convert overload pass, or because we're explicitly + // instructed not to copy (via `py::arg().noconvert()`) we have to fail loading. + if (!convert || need_writeable) return false; + + Array copy = Array::ensure(src); + if (!copy) return false; + fits = props::conformable(copy); + if (!fits || !fits.template stride_compatible()) + return false; + copy_or_ref = std::move(copy); + loader_life_support::add_patient(copy_or_ref); + } + + ref.reset(); + map.reset(new MapType(data(copy_or_ref), fits.rows, fits.cols, make_stride(fits.stride.outer(), fits.stride.inner()))); + ref.reset(new Type(*map)); + + return true; + } + + operator Type*() { return ref.get(); } + operator Type&() { return *ref; } + template using cast_op_type = pybind11::detail::cast_op_type<_T>; + +private: + template ::value, int> = 0> + Scalar *data(Array &a) { return a.mutable_data(); } + + template ::value, int> = 0> + const Scalar *data(Array &a) { return a.data(); } + + // Attempt to figure out a constructor of `Stride` that will work. + // If both strides are fixed, use a default constructor: + template using stride_ctor_default = bool_constant< + S::InnerStrideAtCompileTime != Eigen::Dynamic && S::OuterStrideAtCompileTime != Eigen::Dynamic && + std::is_default_constructible::value>; + // Otherwise, if there is a two-index constructor, assume it is (outer,inner) like + // Eigen::Stride, and use it: + template using stride_ctor_dual = bool_constant< + !stride_ctor_default::value && std::is_constructible::value>; + // Otherwise, if there is a one-index constructor, and just one of the strides is dynamic, use + // it (passing whichever stride is dynamic). + template using stride_ctor_outer = bool_constant< + !any_of, stride_ctor_dual>::value && + S::OuterStrideAtCompileTime == Eigen::Dynamic && S::InnerStrideAtCompileTime != Eigen::Dynamic && + std::is_constructible::value>; + template using stride_ctor_inner = bool_constant< + !any_of, stride_ctor_dual>::value && + S::InnerStrideAtCompileTime == Eigen::Dynamic && S::OuterStrideAtCompileTime != Eigen::Dynamic && + std::is_constructible::value>; + + template ::value, int> = 0> + static S make_stride(EigenIndex, EigenIndex) { return S(); } + template ::value, int> = 0> + static S make_stride(EigenIndex outer, EigenIndex inner) { return S(outer, inner); } + template ::value, int> = 0> + static S make_stride(EigenIndex outer, EigenIndex) { return S(outer); } + template ::value, int> = 0> + static S make_stride(EigenIndex, EigenIndex inner) { return S(inner); } + +}; + +// type_caster for special matrix types (e.g. DiagonalMatrix), which are EigenBase, but not +// EigenDense (i.e. they don't have a data(), at least not with the usual matrix layout). +// load() is not supported, but we can cast them into the python domain by first copying to a +// regular Eigen::Matrix, then casting that. +template +struct type_caster::value>> { +protected: + using Matrix = Eigen::Matrix; + using props = EigenProps; +public: + static handle cast(const Type &src, return_value_policy /* policy */, handle /* parent */) { + handle h = eigen_encapsulate(new Matrix(src)); + return h; + } + static handle cast(const Type *src, return_value_policy policy, handle parent) { return cast(*src, policy, parent); } + + static PYBIND11_DESCR name() { return props::descriptor(); } + + // Explicitly delete these: support python -> C++ conversion on these (i.e. these can be return + // types but not bound arguments). We still provide them (with an explicitly delete) so that + // you end up here if you try anyway. + bool load(handle, bool) = delete; + operator Type() = delete; + template using cast_op_type = Type; +}; + +template +struct type_caster::value>> { + typedef typename Type::Scalar Scalar; + typedef remove_reference_t().outerIndexPtr())> StorageIndex; + typedef typename Type::Index Index; + static constexpr bool rowMajor = Type::IsRowMajor; + + bool load(handle src, bool) { + if (!src) + return false; + + auto obj = reinterpret_borrow(src); + object sparse_module = module::import("scipy.sparse"); + object matrix_type = sparse_module.attr( + rowMajor ? "csr_matrix" : "csc_matrix"); + + if (!obj.get_type().is(matrix_type)) { + try { + obj = matrix_type(obj); + } catch (const error_already_set &) { + return false; + } + } + + auto values = array_t((object) obj.attr("data")); + auto innerIndices = array_t((object) obj.attr("indices")); + auto outerIndices = array_t((object) obj.attr("indptr")); + auto shape = pybind11::tuple((pybind11::object) obj.attr("shape")); + auto nnz = obj.attr("nnz").cast(); + + if (!values || !innerIndices || !outerIndices) + return false; + + value = Eigen::MappedSparseMatrix( + shape[0].cast(), shape[1].cast(), nnz, + outerIndices.mutable_data(), innerIndices.mutable_data(), values.mutable_data()); + + return true; + } + + static handle cast(const Type &src, return_value_policy /* policy */, handle /* parent */) { + const_cast(src).makeCompressed(); + + object matrix_type = module::import("scipy.sparse").attr( + rowMajor ? "csr_matrix" : "csc_matrix"); + + array data(src.nonZeros(), src.valuePtr()); + array outerIndices((rowMajor ? src.rows() : src.cols()) + 1, src.outerIndexPtr()); + array innerIndices(src.nonZeros(), src.innerIndexPtr()); + + return matrix_type( + std::make_tuple(data, innerIndices, outerIndices), + std::make_pair(src.rows(), src.cols()) + ).release(); + } + + PYBIND11_TYPE_CASTER(Type, _<(Type::IsRowMajor) != 0>("scipy.sparse.csr_matrix[", "scipy.sparse.csc_matrix[") + + npy_format_descriptor::name() + _("]")); +}; + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(__GNUG__) || defined(__clang__) +# pragma GCC diagnostic pop +#elif defined(_MSC_VER) +# pragma warning(pop) +#endif diff --git a/plugins/python/pybind11/include/pybind11/embed.h b/plugins/python/pybind11/include/pybind11/embed.h new file mode 100644 index 0000000..9abc61c --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/embed.h @@ -0,0 +1,194 @@ +/* + pybind11/embed.h: Support for embedding the interpreter + + Copyright (c) 2017 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include "eval.h" + +#if defined(PYPY_VERSION) +# error Embedding the interpreter is not supported with PyPy +#endif + +#if PY_MAJOR_VERSION >= 3 +# define PYBIND11_EMBEDDED_MODULE_IMPL(name) \ + extern "C" PyObject *pybind11_init_impl_##name() { \ + return pybind11_init_wrapper_##name(); \ + } +#else +# define PYBIND11_EMBEDDED_MODULE_IMPL(name) \ + extern "C" void pybind11_init_impl_##name() { \ + pybind11_init_wrapper_##name(); \ + } +#endif + +/** \rst + Add a new module to the table of builtins for the interpreter. Must be + defined in global scope. The first macro parameter is the name of the + module (without quotes). The second parameter is the variable which will + be used as the interface to add functions and classes to the module. + + .. code-block:: cpp + + PYBIND11_EMBEDDED_MODULE(example, m) { + // ... initialize functions and classes here + m.def("foo", []() { + return "Hello, World!"; + }); + } + \endrst */ +#define PYBIND11_EMBEDDED_MODULE(name, variable) \ + static void PYBIND11_CONCAT(pybind11_init_, name)(pybind11::module &); \ + static PyObject PYBIND11_CONCAT(*pybind11_init_wrapper_, name)() { \ + auto m = pybind11::module(PYBIND11_TOSTRING(name)); \ + try { \ + PYBIND11_CONCAT(pybind11_init_, name)(m); \ + return m.ptr(); \ + } catch (pybind11::error_already_set &e) { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } catch (const std::exception &e) { \ + PyErr_SetString(PyExc_ImportError, e.what()); \ + return nullptr; \ + } \ + } \ + PYBIND11_EMBEDDED_MODULE_IMPL(name) \ + pybind11::detail::embedded_module name(PYBIND11_TOSTRING(name), \ + PYBIND11_CONCAT(pybind11_init_impl_, name)); \ + void PYBIND11_CONCAT(pybind11_init_, name)(pybind11::module &variable) + + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/// Python 2.7/3.x compatible version of `PyImport_AppendInittab` and error checks. +struct embedded_module { +#if PY_MAJOR_VERSION >= 3 + using init_t = PyObject *(*)(); +#else + using init_t = void (*)(); +#endif + embedded_module(const char *name, init_t init) { + if (Py_IsInitialized()) + pybind11_fail("Can't add new modules after the interpreter has been initialized"); + + auto result = PyImport_AppendInittab(name, init); + if (result == -1) + pybind11_fail("Insufficient memory to add a new module"); + } +}; + +NAMESPACE_END(detail) + +/** \rst + Initialize the Python interpreter. No other pybind11 or CPython API functions can be + called before this is done; with the exception of `PYBIND11_EMBEDDED_MODULE`. The + optional parameter can be used to skip the registration of signal handlers (see the + Python documentation for details). Calling this function again after the interpreter + has already been initialized is a fatal error. + \endrst */ +inline void initialize_interpreter(bool init_signal_handlers = true) { + if (Py_IsInitialized()) + pybind11_fail("The interpreter is already running"); + + Py_InitializeEx(init_signal_handlers ? 1 : 0); + + // Make .py files in the working directory available by default + module::import("sys").attr("path").cast().append("."); +} + +/** \rst + Shut down the Python interpreter. No pybind11 or CPython API functions can be called + after this. In addition, pybind11 objects must not outlive the interpreter: + + .. code-block:: cpp + + { // BAD + py::initialize_interpreter(); + auto hello = py::str("Hello, World!"); + py::finalize_interpreter(); + } // <-- BOOM, hello's destructor is called after interpreter shutdown + + { // GOOD + py::initialize_interpreter(); + { // scoped + auto hello = py::str("Hello, World!"); + } // <-- OK, hello is cleaned up properly + py::finalize_interpreter(); + } + + { // BETTER + py::scoped_interpreter guard{}; + auto hello = py::str("Hello, World!"); + } + + .. warning:: + + The interpreter can be restarted by calling `initialize_interpreter` again. + Modules created using pybind11 can be safely re-initialized. However, Python + itself cannot completely unload binary extension modules and there are several + caveats with regard to interpreter restarting. All the details can be found + in the CPython documentation. In short, not all interpreter memory may be + freed, either due to reference cycles or user-created global data. + + \endrst */ +inline void finalize_interpreter() { + handle builtins(PyEval_GetBuiltins()); + const char *id = PYBIND11_INTERNALS_ID; + + // Get the internals pointer (without creating it if it doesn't exist). It's possible for the + // internals to be created during Py_Finalize() (e.g. if a py::capsule calls `get_internals()` + // during destruction), so we get the pointer-pointer here and check it after Py_Finalize(). + detail::internals **internals_ptr_ptr = detail::get_internals_pp(); + // It could also be stashed in builtins, so look there too: + if (builtins.contains(id) && isinstance(builtins[id])) + internals_ptr_ptr = capsule(builtins[id]); + + Py_Finalize(); + + if (internals_ptr_ptr) { + delete *internals_ptr_ptr; + *internals_ptr_ptr = nullptr; + } +} + +/** \rst + Scope guard version of `initialize_interpreter` and `finalize_interpreter`. + This a move-only guard and only a single instance can exist. + + .. code-block:: cpp + + #include + + int main() { + py::scoped_interpreter guard{}; + py::print(Hello, World!); + } // <-- interpreter shutdown + \endrst */ +class scoped_interpreter { +public: + scoped_interpreter(bool init_signal_handlers = true) { + initialize_interpreter(init_signal_handlers); + } + + scoped_interpreter(const scoped_interpreter &) = delete; + scoped_interpreter(scoped_interpreter &&other) noexcept { other.is_valid = false; } + scoped_interpreter &operator=(const scoped_interpreter &) = delete; + scoped_interpreter &operator=(scoped_interpreter &&) = delete; + + ~scoped_interpreter() { + if (is_valid) + finalize_interpreter(); + } + +private: + bool is_valid = true; +}; + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/eval.h b/plugins/python/pybind11/include/pybind11/eval.h new file mode 100644 index 0000000..ea85ba1 --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/eval.h @@ -0,0 +1,117 @@ +/* + pybind11/exec.h: Support for evaluating Python expressions and statements + from strings and files + + Copyright (c) 2016 Klemens Morgenstern and + Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +enum eval_mode { + /// Evaluate a string containing an isolated expression + eval_expr, + + /// Evaluate a string containing a single statement. Returns \c none + eval_single_statement, + + /// Evaluate a string containing a sequence of statement. Returns \c none + eval_statements +}; + +template +object eval(str expr, object global = globals(), object local = object()) { + if (!local) + local = global; + + /* PyRun_String does not accept a PyObject / encoding specifier, + this seems to be the only alternative */ + std::string buffer = "# -*- coding: utf-8 -*-\n" + (std::string) expr; + + int start; + switch (mode) { + case eval_expr: start = Py_eval_input; break; + case eval_single_statement: start = Py_single_input; break; + case eval_statements: start = Py_file_input; break; + default: pybind11_fail("invalid evaluation mode"); + } + + PyObject *result = PyRun_String(buffer.c_str(), start, global.ptr(), local.ptr()); + if (!result) + throw error_already_set(); + return reinterpret_steal(result); +} + +template +object eval(const char (&s)[N], object global = globals(), object local = object()) { + /* Support raw string literals by removing common leading whitespace */ + auto expr = (s[0] == '\n') ? str(module::import("textwrap").attr("dedent")(s)) + : str(s); + return eval(expr, global, local); +} + +inline void exec(str expr, object global = globals(), object local = object()) { + eval(expr, global, local); +} + +template +void exec(const char (&s)[N], object global = globals(), object local = object()) { + eval(s, global, local); +} + +template +object eval_file(str fname, object global = globals(), object local = object()) { + if (!local) + local = global; + + int start; + switch (mode) { + case eval_expr: start = Py_eval_input; break; + case eval_single_statement: start = Py_single_input; break; + case eval_statements: start = Py_file_input; break; + default: pybind11_fail("invalid evaluation mode"); + } + + int closeFile = 1; + std::string fname_str = (std::string) fname; +#if PY_VERSION_HEX >= 0x03040000 + FILE *f = _Py_fopen_obj(fname.ptr(), "r"); +#elif PY_VERSION_HEX >= 0x03000000 + FILE *f = _Py_fopen(fname.ptr(), "r"); +#else + /* No unicode support in open() :( */ + auto fobj = reinterpret_steal(PyFile_FromString( + const_cast(fname_str.c_str()), + const_cast("r"))); + FILE *f = nullptr; + if (fobj) + f = PyFile_AsFile(fobj.ptr()); + closeFile = 0; +#endif + if (!f) { + PyErr_Clear(); + pybind11_fail("File \"" + fname_str + "\" could not be opened!"); + } + +#if PY_VERSION_HEX < 0x03000000 && defined(PYPY_VERSION) + PyObject *result = PyRun_File(f, fname_str.c_str(), start, global.ptr(), + local.ptr()); + (void) closeFile; +#else + PyObject *result = PyRun_FileEx(f, fname_str.c_str(), start, global.ptr(), + local.ptr(), closeFile); +#endif + + if (!result) + throw error_already_set(); + return reinterpret_steal(result); +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/functional.h b/plugins/python/pybind11/include/pybind11/functional.h new file mode 100644 index 0000000..eda14ba --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/functional.h @@ -0,0 +1,85 @@ +/* + pybind11/functional.h: std::function<> support + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +template +struct type_caster> { + using type = std::function; + using retval_type = conditional_t::value, void_type, Return>; + using function_type = Return (*) (Args...); + +public: + bool load(handle src, bool convert) { + if (src.is_none()) { + // Defer accepting None to other overloads (if we aren't in convert mode): + if (!convert) return false; + return true; + } + + if (!isinstance(src)) + return false; + + auto func = reinterpret_borrow(src); + + /* + When passing a C++ function as an argument to another C++ + function via Python, every function call would normally involve + a full C++ -> Python -> C++ roundtrip, which can be prohibitive. + Here, we try to at least detect the case where the function is + stateless (i.e. function pointer or lambda function without + captured variables), in which case the roundtrip can be avoided. + */ + if (auto cfunc = func.cpp_function()) { + auto c = reinterpret_borrow(PyCFunction_GET_SELF(cfunc.ptr())); + auto rec = (function_record *) c; + + if (rec && rec->is_stateless && + same_type(typeid(function_type), *reinterpret_cast(rec->data[1]))) { + struct capture { function_type f; }; + value = ((capture *) &rec->data)->f; + return true; + } + } + + value = [func](Args... args) -> Return { + gil_scoped_acquire acq; + object retval(func(std::forward(args)...)); + /* Visual studio 2015 parser issue: need parentheses around this expression */ + return (retval.template cast()); + }; + return true; + } + + template + static handle cast(Func &&f_, return_value_policy policy, handle /* parent */) { + if (!f_) + return none().inc_ref(); + + auto result = f_.template target(); + if (result) + return cpp_function(*result, policy).release(); + else + return cpp_function(std::forward(f_), policy).release(); + } + + PYBIND11_TYPE_CASTER(type, _("Callable[[") + + argument_loader::arg_names() + _("], ") + + make_caster::name() + + _("]")); +}; + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/iostream.h b/plugins/python/pybind11/include/pybind11/iostream.h new file mode 100644 index 0000000..3caf556 --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/iostream.h @@ -0,0 +1,200 @@ +/* + pybind11/iostream.h -- Tools to assist with redirecting cout and cerr to Python + + Copyright (c) 2017 Henry F. Schreiner + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" + +#include +#include +#include +#include +#include + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +// Buffer that writes to Python instead of C++ +class pythonbuf : public std::streambuf { +private: + using traits_type = std::streambuf::traits_type; + + char d_buffer[1024]; + object pywrite; + object pyflush; + + int overflow(int c) { + if (!traits_type::eq_int_type(c, traits_type::eof())) { + *pptr() = traits_type::to_char_type(c); + pbump(1); + } + return sync() == 0 ? traits_type::not_eof(c) : traits_type::eof(); + } + + int sync() { + if (pbase() != pptr()) { + // This subtraction cannot be negative, so dropping the sign + str line(pbase(), static_cast(pptr() - pbase())); + + pywrite(line); + pyflush(); + + setp(pbase(), epptr()); + } + return 0; + } + +public: + pythonbuf(object pyostream) + : pywrite(pyostream.attr("write")), + pyflush(pyostream.attr("flush")) { + setp(d_buffer, d_buffer + sizeof(d_buffer) - 1); + } + + /// Sync before destroy + ~pythonbuf() { + sync(); + } +}; + +NAMESPACE_END(detail) + + +/** \rst + This a move-only guard that redirects output. + + .. code-block:: cpp + + #include + + ... + + { + py::scoped_ostream_redirect output; + std::cout << "Hello, World!"; // Python stdout + } // <-- return std::cout to normal + + You can explicitly pass the c++ stream and the python object, + for example to guard stderr instead. + + .. code-block:: cpp + + { + py::scoped_ostream_redirect output{std::cerr, py::module::import("sys").attr("stderr")}; + std::cerr << "Hello, World!"; + } + \endrst */ +class scoped_ostream_redirect { +protected: + std::streambuf *old; + std::ostream &costream; + detail::pythonbuf buffer; + +public: + scoped_ostream_redirect( + std::ostream &costream = std::cout, + object pyostream = module::import("sys").attr("stdout")) + : costream(costream), buffer(pyostream) { + old = costream.rdbuf(&buffer); + } + + ~scoped_ostream_redirect() { + costream.rdbuf(old); + } + + scoped_ostream_redirect(const scoped_ostream_redirect &) = delete; + scoped_ostream_redirect(scoped_ostream_redirect &&other) = default; + scoped_ostream_redirect &operator=(const scoped_ostream_redirect &) = delete; + scoped_ostream_redirect &operator=(scoped_ostream_redirect &&) = delete; +}; + + +/** \rst + Like `scoped_ostream_redirect`, but redirects cerr by default. This class + is provided primary to make ``py::call_guard`` easier to make. + + .. code-block:: cpp + + m.def("noisy_func", &noisy_func, + py::call_guard()); + +\endrst */ +class scoped_estream_redirect : public scoped_ostream_redirect { +public: + scoped_estream_redirect( + std::ostream &costream = std::cerr, + object pyostream = module::import("sys").attr("stderr")) + : scoped_ostream_redirect(costream,pyostream) {} +}; + + +NAMESPACE_BEGIN(detail) + +// Class to redirect output as a context manager. C++ backend. +class OstreamRedirect { + bool do_stdout_; + bool do_stderr_; + std::unique_ptr redirect_stdout; + std::unique_ptr redirect_stderr; + +public: + OstreamRedirect(bool do_stdout = true, bool do_stderr = true) + : do_stdout_(do_stdout), do_stderr_(do_stderr) {} + + void enter() { + if (do_stdout_) + redirect_stdout.reset(new scoped_ostream_redirect()); + if (do_stderr_) + redirect_stderr.reset(new scoped_estream_redirect()); + } + + void exit() { + redirect_stdout.reset(); + redirect_stderr.reset(); + } +}; + +NAMESPACE_END(detail) + +/** \rst + This is a helper function to add a C++ redirect context manager to Python + instead of using a C++ guard. To use it, add the following to your binding code: + + .. code-block:: cpp + + #include + + ... + + py::add_ostream_redirect(m, "ostream_redirect"); + + You now have a Python context manager that redirects your output: + + .. code-block:: python + + with m.ostream_redirect(): + m.print_to_cout_function() + + This manager can optionally be told which streams to operate on: + + .. code-block:: python + + with m.ostream_redirect(stdout=true, stderr=true): + m.noisy_function_with_error_printing() + + \endrst */ +inline class_ add_ostream_redirect(module m, std::string name = "ostream_redirect") { + return class_(m, name.c_str(), module_local()) + .def(init(), arg("stdout")=true, arg("stderr")=true) + .def("__enter__", &detail::OstreamRedirect::enter) + .def("__exit__", [](detail::OstreamRedirect &self, args) { self.exit(); }); +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/numpy.h b/plugins/python/pybind11/include/pybind11/numpy.h new file mode 100644 index 0000000..9df4934 --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/numpy.h @@ -0,0 +1,1601 @@ +/* + pybind11/numpy.h: Basic NumPy support, vectorize() wrapper + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include "complex.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#if defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable: 4127) // warning C4127: Conditional expression is constant +#endif + +/* This will be true on all flat address space platforms and allows us to reduce the + whole npy_intp / ssize_t / Py_intptr_t business down to just ssize_t for all size + and dimension types (e.g. shape, strides, indexing), instead of inflicting this + upon the library user. */ +static_assert(sizeof(ssize_t) == sizeof(Py_intptr_t), "ssize_t != Py_intptr_t"); + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +class array; // Forward declaration + +NAMESPACE_BEGIN(detail) +template struct npy_format_descriptor; + +struct PyArrayDescr_Proxy { + PyObject_HEAD + PyObject *typeobj; + char kind; + char type; + char byteorder; + char flags; + int type_num; + int elsize; + int alignment; + char *subarray; + PyObject *fields; + PyObject *names; +}; + +struct PyArray_Proxy { + PyObject_HEAD + char *data; + int nd; + ssize_t *dimensions; + ssize_t *strides; + PyObject *base; + PyObject *descr; + int flags; +}; + +struct PyVoidScalarObject_Proxy { + PyObject_VAR_HEAD + char *obval; + PyArrayDescr_Proxy *descr; + int flags; + PyObject *base; +}; + +struct numpy_type_info { + PyObject* dtype_ptr; + std::string format_str; +}; + +struct numpy_internals { + std::unordered_map registered_dtypes; + + numpy_type_info *get_type_info(const std::type_info& tinfo, bool throw_if_missing = true) { + auto it = registered_dtypes.find(std::type_index(tinfo)); + if (it != registered_dtypes.end()) + return &(it->second); + if (throw_if_missing) + pybind11_fail(std::string("NumPy type info missing for ") + tinfo.name()); + return nullptr; + } + + template numpy_type_info *get_type_info(bool throw_if_missing = true) { + return get_type_info(typeid(typename std::remove_cv::type), throw_if_missing); + } +}; + +inline PYBIND11_NOINLINE void load_numpy_internals(numpy_internals* &ptr) { + ptr = &get_or_create_shared_data("_numpy_internals"); +} + +inline numpy_internals& get_numpy_internals() { + static numpy_internals* ptr = nullptr; + if (!ptr) + load_numpy_internals(ptr); + return *ptr; +} + +struct npy_api { + enum constants { + NPY_ARRAY_C_CONTIGUOUS_ = 0x0001, + NPY_ARRAY_F_CONTIGUOUS_ = 0x0002, + NPY_ARRAY_OWNDATA_ = 0x0004, + NPY_ARRAY_FORCECAST_ = 0x0010, + NPY_ARRAY_ENSUREARRAY_ = 0x0040, + NPY_ARRAY_ALIGNED_ = 0x0100, + NPY_ARRAY_WRITEABLE_ = 0x0400, + NPY_BOOL_ = 0, + NPY_BYTE_, NPY_UBYTE_, + NPY_SHORT_, NPY_USHORT_, + NPY_INT_, NPY_UINT_, + NPY_LONG_, NPY_ULONG_, + NPY_LONGLONG_, NPY_ULONGLONG_, + NPY_FLOAT_, NPY_DOUBLE_, NPY_LONGDOUBLE_, + NPY_CFLOAT_, NPY_CDOUBLE_, NPY_CLONGDOUBLE_, + NPY_OBJECT_ = 17, + NPY_STRING_, NPY_UNICODE_, NPY_VOID_ + }; + + typedef struct { + Py_intptr_t *ptr; + int len; + } PyArray_Dims; + + static npy_api& get() { + static npy_api api = lookup(); + return api; + } + + bool PyArray_Check_(PyObject *obj) const { + return (bool) PyObject_TypeCheck(obj, PyArray_Type_); + } + bool PyArrayDescr_Check_(PyObject *obj) const { + return (bool) PyObject_TypeCheck(obj, PyArrayDescr_Type_); + } + + unsigned int (*PyArray_GetNDArrayCFeatureVersion_)(); + PyObject *(*PyArray_DescrFromType_)(int); + PyObject *(*PyArray_NewFromDescr_) + (PyTypeObject *, PyObject *, int, Py_intptr_t *, + Py_intptr_t *, void *, int, PyObject *); + PyObject *(*PyArray_DescrNewFromType_)(int); + int (*PyArray_CopyInto_)(PyObject *, PyObject *); + PyObject *(*PyArray_NewCopy_)(PyObject *, int); + PyTypeObject *PyArray_Type_; + PyTypeObject *PyVoidArrType_Type_; + PyTypeObject *PyArrayDescr_Type_; + PyObject *(*PyArray_DescrFromScalar_)(PyObject *); + PyObject *(*PyArray_FromAny_) (PyObject *, PyObject *, int, int, int, PyObject *); + int (*PyArray_DescrConverter_) (PyObject *, PyObject **); + bool (*PyArray_EquivTypes_) (PyObject *, PyObject *); + int (*PyArray_GetArrayParamsFromObject_)(PyObject *, PyObject *, char, PyObject **, int *, + Py_ssize_t *, PyObject **, PyObject *); + PyObject *(*PyArray_Squeeze_)(PyObject *); + int (*PyArray_SetBaseObject_)(PyObject *, PyObject *); + PyObject* (*PyArray_Resize_)(PyObject*, PyArray_Dims*, int, int); +private: + enum functions { + API_PyArray_GetNDArrayCFeatureVersion = 211, + API_PyArray_Type = 2, + API_PyArrayDescr_Type = 3, + API_PyVoidArrType_Type = 39, + API_PyArray_DescrFromType = 45, + API_PyArray_DescrFromScalar = 57, + API_PyArray_FromAny = 69, + API_PyArray_Resize = 80, + API_PyArray_CopyInto = 82, + API_PyArray_NewCopy = 85, + API_PyArray_NewFromDescr = 94, + API_PyArray_DescrNewFromType = 9, + API_PyArray_DescrConverter = 174, + API_PyArray_EquivTypes = 182, + API_PyArray_GetArrayParamsFromObject = 278, + API_PyArray_Squeeze = 136, + API_PyArray_SetBaseObject = 282 + }; + + static npy_api lookup() { + module m = module::import("numpy.core.multiarray"); + auto c = m.attr("_ARRAY_API"); +#if PY_MAJOR_VERSION >= 3 + void **api_ptr = (void **) PyCapsule_GetPointer(c.ptr(), NULL); +#else + void **api_ptr = (void **) PyCObject_AsVoidPtr(c.ptr()); +#endif + npy_api api; +#define DECL_NPY_API(Func) api.Func##_ = (decltype(api.Func##_)) api_ptr[API_##Func]; + DECL_NPY_API(PyArray_GetNDArrayCFeatureVersion); + if (api.PyArray_GetNDArrayCFeatureVersion_() < 0x7) + pybind11_fail("pybind11 numpy support requires numpy >= 1.7.0"); + DECL_NPY_API(PyArray_Type); + DECL_NPY_API(PyVoidArrType_Type); + DECL_NPY_API(PyArrayDescr_Type); + DECL_NPY_API(PyArray_DescrFromType); + DECL_NPY_API(PyArray_DescrFromScalar); + DECL_NPY_API(PyArray_FromAny); + DECL_NPY_API(PyArray_Resize); + DECL_NPY_API(PyArray_CopyInto); + DECL_NPY_API(PyArray_NewCopy); + DECL_NPY_API(PyArray_NewFromDescr); + DECL_NPY_API(PyArray_DescrNewFromType); + DECL_NPY_API(PyArray_DescrConverter); + DECL_NPY_API(PyArray_EquivTypes); + DECL_NPY_API(PyArray_GetArrayParamsFromObject); + DECL_NPY_API(PyArray_Squeeze); + DECL_NPY_API(PyArray_SetBaseObject); +#undef DECL_NPY_API + return api; + } +}; + +inline PyArray_Proxy* array_proxy(void* ptr) { + return reinterpret_cast(ptr); +} + +inline const PyArray_Proxy* array_proxy(const void* ptr) { + return reinterpret_cast(ptr); +} + +inline PyArrayDescr_Proxy* array_descriptor_proxy(PyObject* ptr) { + return reinterpret_cast(ptr); +} + +inline const PyArrayDescr_Proxy* array_descriptor_proxy(const PyObject* ptr) { + return reinterpret_cast(ptr); +} + +inline bool check_flags(const void* ptr, int flag) { + return (flag == (array_proxy(ptr)->flags & flag)); +} + +template struct is_std_array : std::false_type { }; +template struct is_std_array> : std::true_type { }; +template struct is_complex : std::false_type { }; +template struct is_complex> : std::true_type { }; + +template struct array_info_scalar { + typedef T type; + static constexpr bool is_array = false; + static constexpr bool is_empty = false; + static PYBIND11_DESCR extents() { return _(""); } + static void append_extents(list& /* shape */) { } +}; +// Computes underlying type and a comma-separated list of extents for array +// types (any mix of std::array and built-in arrays). An array of char is +// treated as scalar because it gets special handling. +template struct array_info : array_info_scalar { }; +template struct array_info> { + using type = typename array_info::type; + static constexpr bool is_array = true; + static constexpr bool is_empty = (N == 0) || array_info::is_empty; + static constexpr size_t extent = N; + + // appends the extents to shape + static void append_extents(list& shape) { + shape.append(N); + array_info::append_extents(shape); + } + + template::is_array, int> = 0> + static PYBIND11_DESCR extents() { + return _(); + } + + template::is_array, int> = 0> + static PYBIND11_DESCR extents() { + return concat(_(), array_info::extents()); + } +}; +// For numpy we have special handling for arrays of characters, so we don't include +// the size in the array extents. +template struct array_info : array_info_scalar { }; +template struct array_info> : array_info_scalar> { }; +template struct array_info : array_info> { }; +template using remove_all_extents_t = typename array_info::type; + +template using is_pod_struct = all_of< + std::is_standard_layout, // since we're accessing directly in memory we need a standard layout type +#if !defined(__GNUG__) || defined(_LIBCPP_VERSION) || defined(_GLIBCXX_USE_CXX11_ABI) + // _GLIBCXX_USE_CXX11_ABI indicates that we're using libstdc++ from GCC 5 or newer, independent + // of the actual compiler (Clang can also use libstdc++, but it always defines __GNUC__ == 4). + std::is_trivially_copyable, +#else + // GCC 4 doesn't implement is_trivially_copyable, so approximate it + std::is_trivially_destructible, + satisfies_any_of, +#endif + satisfies_none_of +>; + +template ssize_t byte_offset_unsafe(const Strides &) { return 0; } +template +ssize_t byte_offset_unsafe(const Strides &strides, ssize_t i, Ix... index) { + return i * strides[Dim] + byte_offset_unsafe(strides, index...); +} + +/** + * Proxy class providing unsafe, unchecked const access to array data. This is constructed through + * the `unchecked()` method of `array` or the `unchecked()` method of `array_t`. `Dims` + * will be -1 for dimensions determined at runtime. + */ +template +class unchecked_reference { +protected: + static constexpr bool Dynamic = Dims < 0; + const unsigned char *data_; + // Storing the shape & strides in local variables (i.e. these arrays) allows the compiler to + // make large performance gains on big, nested loops, but requires compile-time dimensions + conditional_t> + shape_, strides_; + const ssize_t dims_; + + friend class pybind11::array; + // Constructor for compile-time dimensions: + template + unchecked_reference(const void *data, const ssize_t *shape, const ssize_t *strides, enable_if_t) + : data_{reinterpret_cast(data)}, dims_{Dims} { + for (size_t i = 0; i < (size_t) dims_; i++) { + shape_[i] = shape[i]; + strides_[i] = strides[i]; + } + } + // Constructor for runtime dimensions: + template + unchecked_reference(const void *data, const ssize_t *shape, const ssize_t *strides, enable_if_t dims) + : data_{reinterpret_cast(data)}, shape_{shape}, strides_{strides}, dims_{dims} {} + +public: + /** + * Unchecked const reference access to data at the given indices. For a compile-time known + * number of dimensions, this requires the correct number of arguments; for run-time + * dimensionality, this is not checked (and so is up to the caller to use safely). + */ + template const T &operator()(Ix... index) const { + static_assert(ssize_t{sizeof...(Ix)} == Dims || Dynamic, + "Invalid number of indices for unchecked array reference"); + return *reinterpret_cast(data_ + byte_offset_unsafe(strides_, ssize_t(index)...)); + } + /** + * Unchecked const reference access to data; this operator only participates if the reference + * is to a 1-dimensional array. When present, this is exactly equivalent to `obj(index)`. + */ + template > + const T &operator[](ssize_t index) const { return operator()(index); } + + /// Pointer access to the data at the given indices. + template const T *data(Ix... ix) const { return &operator()(ssize_t(ix)...); } + + /// Returns the item size, i.e. sizeof(T) + constexpr static ssize_t itemsize() { return sizeof(T); } + + /// Returns the shape (i.e. size) of dimension `dim` + ssize_t shape(ssize_t dim) const { return shape_[(size_t) dim]; } + + /// Returns the number of dimensions of the array + ssize_t ndim() const { return dims_; } + + /// Returns the total number of elements in the referenced array, i.e. the product of the shapes + template + enable_if_t size() const { + return std::accumulate(shape_.begin(), shape_.end(), (ssize_t) 1, std::multiplies()); + } + template + enable_if_t size() const { + return std::accumulate(shape_, shape_ + ndim(), (ssize_t) 1, std::multiplies()); + } + + /// Returns the total number of bytes used by the referenced data. Note that the actual span in + /// memory may be larger if the referenced array has non-contiguous strides (e.g. for a slice). + ssize_t nbytes() const { + return size() * itemsize(); + } +}; + +template +class unchecked_mutable_reference : public unchecked_reference { + friend class pybind11::array; + using ConstBase = unchecked_reference; + using ConstBase::ConstBase; + using ConstBase::Dynamic; +public: + /// Mutable, unchecked access to data at the given indices. + template T& operator()(Ix... index) { + static_assert(ssize_t{sizeof...(Ix)} == Dims || Dynamic, + "Invalid number of indices for unchecked array reference"); + return const_cast(ConstBase::operator()(index...)); + } + /** + * Mutable, unchecked access data at the given index; this operator only participates if the + * reference is to a 1-dimensional array (or has runtime dimensions). When present, this is + * exactly equivalent to `obj(index)`. + */ + template > + T &operator[](ssize_t index) { return operator()(index); } + + /// Mutable pointer access to the data at the given indices. + template T *mutable_data(Ix... ix) { return &operator()(ssize_t(ix)...); } +}; + +template +struct type_caster> { + static_assert(Dim == 0 && Dim > 0 /* always fail */, "unchecked array proxy object is not castable"); +}; +template +struct type_caster> : type_caster> {}; + +NAMESPACE_END(detail) + +class dtype : public object { +public: + PYBIND11_OBJECT_DEFAULT(dtype, object, detail::npy_api::get().PyArrayDescr_Check_); + + explicit dtype(const buffer_info &info) { + dtype descr(_dtype_from_pep3118()(PYBIND11_STR_TYPE(info.format))); + // If info.itemsize == 0, use the value calculated from the format string + m_ptr = descr.strip_padding(info.itemsize ? info.itemsize : descr.itemsize()).release().ptr(); + } + + explicit dtype(const std::string &format) { + m_ptr = from_args(pybind11::str(format)).release().ptr(); + } + + dtype(const char *format) : dtype(std::string(format)) { } + + dtype(list names, list formats, list offsets, ssize_t itemsize) { + dict args; + args["names"] = names; + args["formats"] = formats; + args["offsets"] = offsets; + args["itemsize"] = pybind11::int_(itemsize); + m_ptr = from_args(args).release().ptr(); + } + + /// This is essentially the same as calling numpy.dtype(args) in Python. + static dtype from_args(object args) { + PyObject *ptr = nullptr; + if (!detail::npy_api::get().PyArray_DescrConverter_(args.release().ptr(), &ptr) || !ptr) + throw error_already_set(); + return reinterpret_steal(ptr); + } + + /// Return dtype associated with a C++ type. + template static dtype of() { + return detail::npy_format_descriptor::type>::dtype(); + } + + /// Size of the data type in bytes. + ssize_t itemsize() const { + return detail::array_descriptor_proxy(m_ptr)->elsize; + } + + /// Returns true for structured data types. + bool has_fields() const { + return detail::array_descriptor_proxy(m_ptr)->names != nullptr; + } + + /// Single-character type code. + char kind() const { + return detail::array_descriptor_proxy(m_ptr)->kind; + } + +private: + static object _dtype_from_pep3118() { + static PyObject *obj = module::import("numpy.core._internal") + .attr("_dtype_from_pep3118").cast().release().ptr(); + return reinterpret_borrow(obj); + } + + dtype strip_padding(ssize_t itemsize) { + // Recursively strip all void fields with empty names that are generated for + // padding fields (as of NumPy v1.11). + if (!has_fields()) + return *this; + + struct field_descr { PYBIND11_STR_TYPE name; object format; pybind11::int_ offset; }; + std::vector field_descriptors; + + for (auto field : attr("fields").attr("items")()) { + auto spec = field.cast(); + auto name = spec[0].cast(); + auto format = spec[1].cast()[0].cast(); + auto offset = spec[1].cast()[1].cast(); + if (!len(name) && format.kind() == 'V') + continue; + field_descriptors.push_back({(PYBIND11_STR_TYPE) name, format.strip_padding(format.itemsize()), offset}); + } + + std::sort(field_descriptors.begin(), field_descriptors.end(), + [](const field_descr& a, const field_descr& b) { + return a.offset.cast() < b.offset.cast(); + }); + + list names, formats, offsets; + for (auto& descr : field_descriptors) { + names.append(descr.name); + formats.append(descr.format); + offsets.append(descr.offset); + } + return dtype(names, formats, offsets, itemsize); + } +}; + +class array : public buffer { +public: + PYBIND11_OBJECT_CVT(array, buffer, detail::npy_api::get().PyArray_Check_, raw_array) + + enum { + c_style = detail::npy_api::NPY_ARRAY_C_CONTIGUOUS_, + f_style = detail::npy_api::NPY_ARRAY_F_CONTIGUOUS_, + forcecast = detail::npy_api::NPY_ARRAY_FORCECAST_ + }; + + array() : array({{0}}, static_cast(nullptr)) {} + + using ShapeContainer = detail::any_container; + using StridesContainer = detail::any_container; + + // Constructs an array taking shape/strides from arbitrary container types + array(const pybind11::dtype &dt, ShapeContainer shape, StridesContainer strides, + const void *ptr = nullptr, handle base = handle()) { + + if (strides->empty()) + *strides = c_strides(*shape, dt.itemsize()); + + auto ndim = shape->size(); + if (ndim != strides->size()) + pybind11_fail("NumPy: shape ndim doesn't match strides ndim"); + auto descr = dt; + + int flags = 0; + if (base && ptr) { + if (isinstance(base)) + /* Copy flags from base (except ownership bit) */ + flags = reinterpret_borrow(base).flags() & ~detail::npy_api::NPY_ARRAY_OWNDATA_; + else + /* Writable by default, easy to downgrade later on if needed */ + flags = detail::npy_api::NPY_ARRAY_WRITEABLE_; + } + + auto &api = detail::npy_api::get(); + auto tmp = reinterpret_steal(api.PyArray_NewFromDescr_( + api.PyArray_Type_, descr.release().ptr(), (int) ndim, shape->data(), strides->data(), + const_cast(ptr), flags, nullptr)); + if (!tmp) + throw error_already_set(); + if (ptr) { + if (base) { + api.PyArray_SetBaseObject_(tmp.ptr(), base.inc_ref().ptr()); + } else { + tmp = reinterpret_steal(api.PyArray_NewCopy_(tmp.ptr(), -1 /* any order */)); + } + } + m_ptr = tmp.release().ptr(); + } + + array(const pybind11::dtype &dt, ShapeContainer shape, const void *ptr = nullptr, handle base = handle()) + : array(dt, std::move(shape), {}, ptr, base) { } + + template ::value && !std::is_same::value>> + array(const pybind11::dtype &dt, T count, const void *ptr = nullptr, handle base = handle()) + : array(dt, {{count}}, ptr, base) { } + + template + array(ShapeContainer shape, StridesContainer strides, const T *ptr, handle base = handle()) + : array(pybind11::dtype::of(), std::move(shape), std::move(strides), ptr, base) { } + + template + array(ShapeContainer shape, const T *ptr, handle base = handle()) + : array(std::move(shape), {}, ptr, base) { } + + template + explicit array(ssize_t count, const T *ptr, handle base = handle()) : array({count}, {}, ptr, base) { } + + explicit array(const buffer_info &info) + : array(pybind11::dtype(info), info.shape, info.strides, info.ptr) { } + + /// Array descriptor (dtype) + pybind11::dtype dtype() const { + return reinterpret_borrow(detail::array_proxy(m_ptr)->descr); + } + + /// Total number of elements + ssize_t size() const { + return std::accumulate(shape(), shape() + ndim(), (ssize_t) 1, std::multiplies()); + } + + /// Byte size of a single element + ssize_t itemsize() const { + return detail::array_descriptor_proxy(detail::array_proxy(m_ptr)->descr)->elsize; + } + + /// Total number of bytes + ssize_t nbytes() const { + return size() * itemsize(); + } + + /// Number of dimensions + ssize_t ndim() const { + return detail::array_proxy(m_ptr)->nd; + } + + /// Base object + object base() const { + return reinterpret_borrow(detail::array_proxy(m_ptr)->base); + } + + /// Dimensions of the array + const ssize_t* shape() const { + return detail::array_proxy(m_ptr)->dimensions; + } + + /// Dimension along a given axis + ssize_t shape(ssize_t dim) const { + if (dim >= ndim()) + fail_dim_check(dim, "invalid axis"); + return shape()[dim]; + } + + /// Strides of the array + const ssize_t* strides() const { + return detail::array_proxy(m_ptr)->strides; + } + + /// Stride along a given axis + ssize_t strides(ssize_t dim) const { + if (dim >= ndim()) + fail_dim_check(dim, "invalid axis"); + return strides()[dim]; + } + + /// Return the NumPy array flags + int flags() const { + return detail::array_proxy(m_ptr)->flags; + } + + /// If set, the array is writeable (otherwise the buffer is read-only) + bool writeable() const { + return detail::check_flags(m_ptr, detail::npy_api::NPY_ARRAY_WRITEABLE_); + } + + /// If set, the array owns the data (will be freed when the array is deleted) + bool owndata() const { + return detail::check_flags(m_ptr, detail::npy_api::NPY_ARRAY_OWNDATA_); + } + + /// Pointer to the contained data. If index is not provided, points to the + /// beginning of the buffer. May throw if the index would lead to out of bounds access. + template const void* data(Ix... index) const { + return static_cast(detail::array_proxy(m_ptr)->data + offset_at(index...)); + } + + /// Mutable pointer to the contained data. If index is not provided, points to the + /// beginning of the buffer. May throw if the index would lead to out of bounds access. + /// May throw if the array is not writeable. + template void* mutable_data(Ix... index) { + check_writeable(); + return static_cast(detail::array_proxy(m_ptr)->data + offset_at(index...)); + } + + /// Byte offset from beginning of the array to a given index (full or partial). + /// May throw if the index would lead to out of bounds access. + template ssize_t offset_at(Ix... index) const { + if ((ssize_t) sizeof...(index) > ndim()) + fail_dim_check(sizeof...(index), "too many indices for an array"); + return byte_offset(ssize_t(index)...); + } + + ssize_t offset_at() const { return 0; } + + /// Item count from beginning of the array to a given index (full or partial). + /// May throw if the index would lead to out of bounds access. + template ssize_t index_at(Ix... index) const { + return offset_at(index...) / itemsize(); + } + + /** + * Returns a proxy object that provides access to the array's data without bounds or + * dimensionality checking. Will throw if the array is missing the `writeable` flag. Use with + * care: the array must not be destroyed or reshaped for the duration of the returned object, + * and the caller must take care not to access invalid dimensions or dimension indices. + */ + template detail::unchecked_mutable_reference mutable_unchecked() & { + if (Dims >= 0 && ndim() != Dims) + throw std::domain_error("array has incorrect number of dimensions: " + std::to_string(ndim()) + + "; expected " + std::to_string(Dims)); + return detail::unchecked_mutable_reference(mutable_data(), shape(), strides(), ndim()); + } + + /** + * Returns a proxy object that provides const access to the array's data without bounds or + * dimensionality checking. Unlike `mutable_unchecked()`, this does not require that the + * underlying array have the `writable` flag. Use with care: the array must not be destroyed or + * reshaped for the duration of the returned object, and the caller must take care not to access + * invalid dimensions or dimension indices. + */ + template detail::unchecked_reference unchecked() const & { + if (Dims >= 0 && ndim() != Dims) + throw std::domain_error("array has incorrect number of dimensions: " + std::to_string(ndim()) + + "; expected " + std::to_string(Dims)); + return detail::unchecked_reference(data(), shape(), strides(), ndim()); + } + + /// Return a new view with all of the dimensions of length 1 removed + array squeeze() { + auto& api = detail::npy_api::get(); + return reinterpret_steal(api.PyArray_Squeeze_(m_ptr)); + } + + /// Resize array to given shape + /// If refcheck is true and more that one reference exist to this array + /// then resize will succeed only if it makes a reshape, i.e. original size doesn't change + void resize(ShapeContainer new_shape, bool refcheck = true) { + detail::npy_api::PyArray_Dims d = { + new_shape->data(), int(new_shape->size()) + }; + // try to resize, set ordering param to -1 cause it's not used anyway + object new_array = reinterpret_steal( + detail::npy_api::get().PyArray_Resize_(m_ptr, &d, int(refcheck), -1) + ); + if (!new_array) throw error_already_set(); + if (isinstance(new_array)) { *this = std::move(new_array); } + } + + /// Ensure that the argument is a NumPy array + /// In case of an error, nullptr is returned and the Python error is cleared. + static array ensure(handle h, int ExtraFlags = 0) { + auto result = reinterpret_steal(raw_array(h.ptr(), ExtraFlags)); + if (!result) + PyErr_Clear(); + return result; + } + +protected: + template friend struct detail::npy_format_descriptor; + + void fail_dim_check(ssize_t dim, const std::string& msg) const { + throw index_error(msg + ": " + std::to_string(dim) + + " (ndim = " + std::to_string(ndim()) + ")"); + } + + template ssize_t byte_offset(Ix... index) const { + check_dimensions(index...); + return detail::byte_offset_unsafe(strides(), ssize_t(index)...); + } + + void check_writeable() const { + if (!writeable()) + throw std::domain_error("array is not writeable"); + } + + // Default, C-style strides + static std::vector c_strides(const std::vector &shape, ssize_t itemsize) { + auto ndim = shape.size(); + std::vector strides(ndim, itemsize); + if (ndim > 0) + for (size_t i = ndim - 1; i > 0; --i) + strides[i - 1] = strides[i] * shape[i]; + return strides; + } + + // F-style strides; default when constructing an array_t with `ExtraFlags & f_style` + static std::vector f_strides(const std::vector &shape, ssize_t itemsize) { + auto ndim = shape.size(); + std::vector strides(ndim, itemsize); + for (size_t i = 1; i < ndim; ++i) + strides[i] = strides[i - 1] * shape[i - 1]; + return strides; + } + + template void check_dimensions(Ix... index) const { + check_dimensions_impl(ssize_t(0), shape(), ssize_t(index)...); + } + + void check_dimensions_impl(ssize_t, const ssize_t*) const { } + + template void check_dimensions_impl(ssize_t axis, const ssize_t* shape, ssize_t i, Ix... index) const { + if (i >= *shape) { + throw index_error(std::string("index ") + std::to_string(i) + + " is out of bounds for axis " + std::to_string(axis) + + " with size " + std::to_string(*shape)); + } + check_dimensions_impl(axis + 1, shape + 1, index...); + } + + /// Create array from any object -- always returns a new reference + static PyObject *raw_array(PyObject *ptr, int ExtraFlags = 0) { + if (ptr == nullptr) { + PyErr_SetString(PyExc_ValueError, "cannot create a pybind11::array from a nullptr"); + return nullptr; + } + return detail::npy_api::get().PyArray_FromAny_( + ptr, nullptr, 0, 0, detail::npy_api::NPY_ARRAY_ENSUREARRAY_ | ExtraFlags, nullptr); + } +}; + +template class array_t : public array { +private: + struct private_ctor {}; + // Delegating constructor needed when both moving and accessing in the same constructor + array_t(private_ctor, ShapeContainer &&shape, StridesContainer &&strides, const T *ptr, handle base) + : array(std::move(shape), std::move(strides), ptr, base) {} +public: + static_assert(!detail::array_info::is_array, "Array types cannot be used with array_t"); + + using value_type = T; + + array_t() : array(0, static_cast(nullptr)) {} + array_t(handle h, borrowed_t) : array(h, borrowed_t{}) { } + array_t(handle h, stolen_t) : array(h, stolen_t{}) { } + + PYBIND11_DEPRECATED("Use array_t::ensure() instead") + array_t(handle h, bool is_borrowed) : array(raw_array_t(h.ptr()), stolen_t{}) { + if (!m_ptr) PyErr_Clear(); + if (!is_borrowed) Py_XDECREF(h.ptr()); + } + + array_t(const object &o) : array(raw_array_t(o.ptr()), stolen_t{}) { + if (!m_ptr) throw error_already_set(); + } + + explicit array_t(const buffer_info& info) : array(info) { } + + array_t(ShapeContainer shape, StridesContainer strides, const T *ptr = nullptr, handle base = handle()) + : array(std::move(shape), std::move(strides), ptr, base) { } + + explicit array_t(ShapeContainer shape, const T *ptr = nullptr, handle base = handle()) + : array_t(private_ctor{}, std::move(shape), + ExtraFlags & f_style ? f_strides(*shape, itemsize()) : c_strides(*shape, itemsize()), + ptr, base) { } + + explicit array_t(size_t count, const T *ptr = nullptr, handle base = handle()) + : array({count}, {}, ptr, base) { } + + constexpr ssize_t itemsize() const { + return sizeof(T); + } + + template ssize_t index_at(Ix... index) const { + return offset_at(index...) / itemsize(); + } + + template const T* data(Ix... index) const { + return static_cast(array::data(index...)); + } + + template T* mutable_data(Ix... index) { + return static_cast(array::mutable_data(index...)); + } + + // Reference to element at a given index + template const T& at(Ix... index) const { + if (sizeof...(index) != ndim()) + fail_dim_check(sizeof...(index), "index dimension mismatch"); + return *(static_cast(array::data()) + byte_offset(ssize_t(index)...) / itemsize()); + } + + // Mutable reference to element at a given index + template T& mutable_at(Ix... index) { + if (sizeof...(index) != ndim()) + fail_dim_check(sizeof...(index), "index dimension mismatch"); + return *(static_cast(array::mutable_data()) + byte_offset(ssize_t(index)...) / itemsize()); + } + + /** + * Returns a proxy object that provides access to the array's data without bounds or + * dimensionality checking. Will throw if the array is missing the `writeable` flag. Use with + * care: the array must not be destroyed or reshaped for the duration of the returned object, + * and the caller must take care not to access invalid dimensions or dimension indices. + */ + template detail::unchecked_mutable_reference mutable_unchecked() & { + return array::mutable_unchecked(); + } + + /** + * Returns a proxy object that provides const access to the array's data without bounds or + * dimensionality checking. Unlike `unchecked()`, this does not require that the underlying + * array have the `writable` flag. Use with care: the array must not be destroyed or reshaped + * for the duration of the returned object, and the caller must take care not to access invalid + * dimensions or dimension indices. + */ + template detail::unchecked_reference unchecked() const & { + return array::unchecked(); + } + + /// Ensure that the argument is a NumPy array of the correct dtype (and if not, try to convert + /// it). In case of an error, nullptr is returned and the Python error is cleared. + static array_t ensure(handle h) { + auto result = reinterpret_steal(raw_array_t(h.ptr())); + if (!result) + PyErr_Clear(); + return result; + } + + static bool check_(handle h) { + const auto &api = detail::npy_api::get(); + return api.PyArray_Check_(h.ptr()) + && api.PyArray_EquivTypes_(detail::array_proxy(h.ptr())->descr, dtype::of().ptr()); + } + +protected: + /// Create array from any object -- always returns a new reference + static PyObject *raw_array_t(PyObject *ptr) { + if (ptr == nullptr) { + PyErr_SetString(PyExc_ValueError, "cannot create a pybind11::array_t from a nullptr"); + return nullptr; + } + return detail::npy_api::get().PyArray_FromAny_( + ptr, dtype::of().release().ptr(), 0, 0, + detail::npy_api::NPY_ARRAY_ENSUREARRAY_ | ExtraFlags, nullptr); + } +}; + +template +struct format_descriptor::value>> { + static std::string format() { + return detail::npy_format_descriptor::type>::format(); + } +}; + +template struct format_descriptor { + static std::string format() { return std::to_string(N) + "s"; } +}; +template struct format_descriptor> { + static std::string format() { return std::to_string(N) + "s"; } +}; + +template +struct format_descriptor::value>> { + static std::string format() { + return format_descriptor< + typename std::remove_cv::type>::type>::format(); + } +}; + +template +struct format_descriptor::is_array>> { + static std::string format() { + using namespace detail; + PYBIND11_DESCR extents = _("(") + array_info::extents() + _(")"); + return extents.text() + format_descriptor>::format(); + } +}; + +NAMESPACE_BEGIN(detail) +template +struct pyobject_caster> { + using type = array_t; + + bool load(handle src, bool convert) { + if (!convert && !type::check_(src)) + return false; + value = type::ensure(src); + return static_cast(value); + } + + static handle cast(const handle &src, return_value_policy /* policy */, handle /* parent */) { + return src.inc_ref(); + } + PYBIND11_TYPE_CASTER(type, handle_type_name::name()); +}; + +template +struct compare_buffer_info::value>> { + static bool compare(const buffer_info& b) { + return npy_api::get().PyArray_EquivTypes_(dtype::of().ptr(), dtype(b).ptr()); + } +}; + +template struct npy_format_descriptor::value>> { +private: + // NB: the order here must match the one in common.h + constexpr static const int values[15] = { + npy_api::NPY_BOOL_, + npy_api::NPY_BYTE_, npy_api::NPY_UBYTE_, npy_api::NPY_SHORT_, npy_api::NPY_USHORT_, + npy_api::NPY_INT_, npy_api::NPY_UINT_, npy_api::NPY_LONGLONG_, npy_api::NPY_ULONGLONG_, + npy_api::NPY_FLOAT_, npy_api::NPY_DOUBLE_, npy_api::NPY_LONGDOUBLE_, + npy_api::NPY_CFLOAT_, npy_api::NPY_CDOUBLE_, npy_api::NPY_CLONGDOUBLE_ + }; + +public: + static constexpr int value = values[detail::is_fmt_numeric::index]; + + static pybind11::dtype dtype() { + if (auto ptr = npy_api::get().PyArray_DescrFromType_(value)) + return reinterpret_borrow(ptr); + pybind11_fail("Unsupported buffer format!"); + } + template ::value, int> = 0> + static PYBIND11_DESCR name() { + return _::value>(_("bool"), + _::value>("int", "uint") + _()); + } + template ::value, int> = 0> + static PYBIND11_DESCR name() { + return _::value || std::is_same::value>( + _("float") + _(), _("longdouble")); + } + template ::value, int> = 0> + static PYBIND11_DESCR name() { + return _::value || std::is_same::value>( + _("complex") + _(), _("longcomplex")); + } +}; + +#define PYBIND11_DECL_CHAR_FMT \ + static PYBIND11_DESCR name() { return _("S") + _(); } \ + static pybind11::dtype dtype() { return pybind11::dtype(std::string("S") + std::to_string(N)); } +template struct npy_format_descriptor { PYBIND11_DECL_CHAR_FMT }; +template struct npy_format_descriptor> { PYBIND11_DECL_CHAR_FMT }; +#undef PYBIND11_DECL_CHAR_FMT + +template struct npy_format_descriptor::is_array>> { +private: + using base_descr = npy_format_descriptor::type>; +public: + static_assert(!array_info::is_empty, "Zero-sized arrays are not supported"); + + static PYBIND11_DESCR name() { return _("(") + array_info::extents() + _(")") + base_descr::name(); } + static pybind11::dtype dtype() { + list shape; + array_info::append_extents(shape); + return pybind11::dtype::from_args(pybind11::make_tuple(base_descr::dtype(), shape)); + } +}; + +template struct npy_format_descriptor::value>> { +private: + using base_descr = npy_format_descriptor::type>; +public: + static PYBIND11_DESCR name() { return base_descr::name(); } + static pybind11::dtype dtype() { return base_descr::dtype(); } +}; + +struct field_descriptor { + const char *name; + ssize_t offset; + ssize_t size; + std::string format; + dtype descr; +}; + +inline PYBIND11_NOINLINE void register_structured_dtype( + const std::initializer_list& fields, + const std::type_info& tinfo, ssize_t itemsize, + bool (*direct_converter)(PyObject *, void *&)) { + + auto& numpy_internals = get_numpy_internals(); + if (numpy_internals.get_type_info(tinfo, false)) + pybind11_fail("NumPy: dtype is already registered"); + + list names, formats, offsets; + for (auto field : fields) { + if (!field.descr) + pybind11_fail(std::string("NumPy: unsupported field dtype: `") + + field.name + "` @ " + tinfo.name()); + names.append(PYBIND11_STR_TYPE(field.name)); + formats.append(field.descr); + offsets.append(pybind11::int_(field.offset)); + } + auto dtype_ptr = pybind11::dtype(names, formats, offsets, itemsize).release().ptr(); + + // There is an existing bug in NumPy (as of v1.11): trailing bytes are + // not encoded explicitly into the format string. This will supposedly + // get fixed in v1.12; for further details, see these: + // - https://github.com/numpy/numpy/issues/7797 + // - https://github.com/numpy/numpy/pull/7798 + // Because of this, we won't use numpy's logic to generate buffer format + // strings and will just do it ourselves. + std::vector ordered_fields(fields); + std::sort(ordered_fields.begin(), ordered_fields.end(), + [](const field_descriptor &a, const field_descriptor &b) { return a.offset < b.offset; }); + ssize_t offset = 0; + std::ostringstream oss; + // mark the structure as unaligned with '^', because numpy and C++ don't + // always agree about alignment (particularly for complex), and we're + // explicitly listing all our padding. This depends on none of the fields + // overriding the endianness. Putting the ^ in front of individual fields + // isn't guaranteed to work due to https://github.com/numpy/numpy/issues/9049 + oss << "^T{"; + for (auto& field : ordered_fields) { + if (field.offset > offset) + oss << (field.offset - offset) << 'x'; + oss << field.format << ':' << field.name << ':'; + offset = field.offset + field.size; + } + if (itemsize > offset) + oss << (itemsize - offset) << 'x'; + oss << '}'; + auto format_str = oss.str(); + + // Sanity check: verify that NumPy properly parses our buffer format string + auto& api = npy_api::get(); + auto arr = array(buffer_info(nullptr, itemsize, format_str, 1)); + if (!api.PyArray_EquivTypes_(dtype_ptr, arr.dtype().ptr())) + pybind11_fail("NumPy: invalid buffer descriptor!"); + + auto tindex = std::type_index(tinfo); + numpy_internals.registered_dtypes[tindex] = { dtype_ptr, format_str }; + get_internals().direct_conversions[tindex].push_back(direct_converter); +} + +template struct npy_format_descriptor { + static_assert(is_pod_struct::value, "Attempt to use a non-POD or unimplemented POD type as a numpy dtype"); + + static PYBIND11_DESCR name() { return make_caster::name(); } + + static pybind11::dtype dtype() { + return reinterpret_borrow(dtype_ptr()); + } + + static std::string format() { + static auto format_str = get_numpy_internals().get_type_info(true)->format_str; + return format_str; + } + + static void register_dtype(const std::initializer_list& fields) { + register_structured_dtype(fields, typeid(typename std::remove_cv::type), + sizeof(T), &direct_converter); + } + +private: + static PyObject* dtype_ptr() { + static PyObject* ptr = get_numpy_internals().get_type_info(true)->dtype_ptr; + return ptr; + } + + static bool direct_converter(PyObject *obj, void*& value) { + auto& api = npy_api::get(); + if (!PyObject_TypeCheck(obj, api.PyVoidArrType_Type_)) + return false; + if (auto descr = reinterpret_steal(api.PyArray_DescrFromScalar_(obj))) { + if (api.PyArray_EquivTypes_(dtype_ptr(), descr.ptr())) { + value = ((PyVoidScalarObject_Proxy *) obj)->obval; + return true; + } + } + return false; + } +}; + +#ifdef __CLION_IDE__ // replace heavy macro with dummy code for the IDE (doesn't affect code) +# define PYBIND11_NUMPY_DTYPE(Type, ...) ((void)0) +# define PYBIND11_NUMPY_DTYPE_EX(Type, ...) ((void)0) +#else + +#define PYBIND11_FIELD_DESCRIPTOR_EX(T, Field, Name) \ + ::pybind11::detail::field_descriptor { \ + Name, offsetof(T, Field), sizeof(decltype(std::declval().Field)), \ + ::pybind11::format_descriptor().Field)>::format(), \ + ::pybind11::detail::npy_format_descriptor().Field)>::dtype() \ + } + +// Extract name, offset and format descriptor for a struct field +#define PYBIND11_FIELD_DESCRIPTOR(T, Field) PYBIND11_FIELD_DESCRIPTOR_EX(T, Field, #Field) + +// The main idea of this macro is borrowed from https://github.com/swansontec/map-macro +// (C) William Swanson, Paul Fultz +#define PYBIND11_EVAL0(...) __VA_ARGS__ +#define PYBIND11_EVAL1(...) PYBIND11_EVAL0 (PYBIND11_EVAL0 (PYBIND11_EVAL0 (__VA_ARGS__))) +#define PYBIND11_EVAL2(...) PYBIND11_EVAL1 (PYBIND11_EVAL1 (PYBIND11_EVAL1 (__VA_ARGS__))) +#define PYBIND11_EVAL3(...) PYBIND11_EVAL2 (PYBIND11_EVAL2 (PYBIND11_EVAL2 (__VA_ARGS__))) +#define PYBIND11_EVAL4(...) PYBIND11_EVAL3 (PYBIND11_EVAL3 (PYBIND11_EVAL3 (__VA_ARGS__))) +#define PYBIND11_EVAL(...) PYBIND11_EVAL4 (PYBIND11_EVAL4 (PYBIND11_EVAL4 (__VA_ARGS__))) +#define PYBIND11_MAP_END(...) +#define PYBIND11_MAP_OUT +#define PYBIND11_MAP_COMMA , +#define PYBIND11_MAP_GET_END() 0, PYBIND11_MAP_END +#define PYBIND11_MAP_NEXT0(test, next, ...) next PYBIND11_MAP_OUT +#define PYBIND11_MAP_NEXT1(test, next) PYBIND11_MAP_NEXT0 (test, next, 0) +#define PYBIND11_MAP_NEXT(test, next) PYBIND11_MAP_NEXT1 (PYBIND11_MAP_GET_END test, next) +#ifdef _MSC_VER // MSVC is not as eager to expand macros, hence this workaround +#define PYBIND11_MAP_LIST_NEXT1(test, next) \ + PYBIND11_EVAL0 (PYBIND11_MAP_NEXT0 (test, PYBIND11_MAP_COMMA next, 0)) +#else +#define PYBIND11_MAP_LIST_NEXT1(test, next) \ + PYBIND11_MAP_NEXT0 (test, PYBIND11_MAP_COMMA next, 0) +#endif +#define PYBIND11_MAP_LIST_NEXT(test, next) \ + PYBIND11_MAP_LIST_NEXT1 (PYBIND11_MAP_GET_END test, next) +#define PYBIND11_MAP_LIST0(f, t, x, peek, ...) \ + f(t, x) PYBIND11_MAP_LIST_NEXT (peek, PYBIND11_MAP_LIST1) (f, t, peek, __VA_ARGS__) +#define PYBIND11_MAP_LIST1(f, t, x, peek, ...) \ + f(t, x) PYBIND11_MAP_LIST_NEXT (peek, PYBIND11_MAP_LIST0) (f, t, peek, __VA_ARGS__) +// PYBIND11_MAP_LIST(f, t, a1, a2, ...) expands to f(t, a1), f(t, a2), ... +#define PYBIND11_MAP_LIST(f, t, ...) \ + PYBIND11_EVAL (PYBIND11_MAP_LIST1 (f, t, __VA_ARGS__, (), 0)) + +#define PYBIND11_NUMPY_DTYPE(Type, ...) \ + ::pybind11::detail::npy_format_descriptor::register_dtype \ + ({PYBIND11_MAP_LIST (PYBIND11_FIELD_DESCRIPTOR, Type, __VA_ARGS__)}) + +#ifdef _MSC_VER +#define PYBIND11_MAP2_LIST_NEXT1(test, next) \ + PYBIND11_EVAL0 (PYBIND11_MAP_NEXT0 (test, PYBIND11_MAP_COMMA next, 0)) +#else +#define PYBIND11_MAP2_LIST_NEXT1(test, next) \ + PYBIND11_MAP_NEXT0 (test, PYBIND11_MAP_COMMA next, 0) +#endif +#define PYBIND11_MAP2_LIST_NEXT(test, next) \ + PYBIND11_MAP2_LIST_NEXT1 (PYBIND11_MAP_GET_END test, next) +#define PYBIND11_MAP2_LIST0(f, t, x1, x2, peek, ...) \ + f(t, x1, x2) PYBIND11_MAP2_LIST_NEXT (peek, PYBIND11_MAP2_LIST1) (f, t, peek, __VA_ARGS__) +#define PYBIND11_MAP2_LIST1(f, t, x1, x2, peek, ...) \ + f(t, x1, x2) PYBIND11_MAP2_LIST_NEXT (peek, PYBIND11_MAP2_LIST0) (f, t, peek, __VA_ARGS__) +// PYBIND11_MAP2_LIST(f, t, a1, a2, ...) expands to f(t, a1, a2), f(t, a3, a4), ... +#define PYBIND11_MAP2_LIST(f, t, ...) \ + PYBIND11_EVAL (PYBIND11_MAP2_LIST1 (f, t, __VA_ARGS__, (), 0)) + +#define PYBIND11_NUMPY_DTYPE_EX(Type, ...) \ + ::pybind11::detail::npy_format_descriptor::register_dtype \ + ({PYBIND11_MAP2_LIST (PYBIND11_FIELD_DESCRIPTOR_EX, Type, __VA_ARGS__)}) + +#endif // __CLION_IDE__ + +template +using array_iterator = typename std::add_pointer::type; + +template +array_iterator array_begin(const buffer_info& buffer) { + return array_iterator(reinterpret_cast(buffer.ptr)); +} + +template +array_iterator array_end(const buffer_info& buffer) { + return array_iterator(reinterpret_cast(buffer.ptr) + buffer.size); +} + +class common_iterator { +public: + using container_type = std::vector; + using value_type = container_type::value_type; + using size_type = container_type::size_type; + + common_iterator() : p_ptr(0), m_strides() {} + + common_iterator(void* ptr, const container_type& strides, const container_type& shape) + : p_ptr(reinterpret_cast(ptr)), m_strides(strides.size()) { + m_strides.back() = static_cast(strides.back()); + for (size_type i = m_strides.size() - 1; i != 0; --i) { + size_type j = i - 1; + value_type s = static_cast(shape[i]); + m_strides[j] = strides[j] + m_strides[i] - strides[i] * s; + } + } + + void increment(size_type dim) { + p_ptr += m_strides[dim]; + } + + void* data() const { + return p_ptr; + } + +private: + char* p_ptr; + container_type m_strides; +}; + +template class multi_array_iterator { +public: + using container_type = std::vector; + + multi_array_iterator(const std::array &buffers, + const container_type &shape) + : m_shape(shape.size()), m_index(shape.size(), 0), + m_common_iterator() { + + // Manual copy to avoid conversion warning if using std::copy + for (size_t i = 0; i < shape.size(); ++i) + m_shape[i] = shape[i]; + + container_type strides(shape.size()); + for (size_t i = 0; i < N; ++i) + init_common_iterator(buffers[i], shape, m_common_iterator[i], strides); + } + + multi_array_iterator& operator++() { + for (size_t j = m_index.size(); j != 0; --j) { + size_t i = j - 1; + if (++m_index[i] != m_shape[i]) { + increment_common_iterator(i); + break; + } else { + m_index[i] = 0; + } + } + return *this; + } + + template T* data() const { + return reinterpret_cast(m_common_iterator[K].data()); + } + +private: + + using common_iter = common_iterator; + + void init_common_iterator(const buffer_info &buffer, + const container_type &shape, + common_iter &iterator, + container_type &strides) { + auto buffer_shape_iter = buffer.shape.rbegin(); + auto buffer_strides_iter = buffer.strides.rbegin(); + auto shape_iter = shape.rbegin(); + auto strides_iter = strides.rbegin(); + + while (buffer_shape_iter != buffer.shape.rend()) { + if (*shape_iter == *buffer_shape_iter) + *strides_iter = *buffer_strides_iter; + else + *strides_iter = 0; + + ++buffer_shape_iter; + ++buffer_strides_iter; + ++shape_iter; + ++strides_iter; + } + + std::fill(strides_iter, strides.rend(), 0); + iterator = common_iter(buffer.ptr, strides, shape); + } + + void increment_common_iterator(size_t dim) { + for (auto &iter : m_common_iterator) + iter.increment(dim); + } + + container_type m_shape; + container_type m_index; + std::array m_common_iterator; +}; + +enum class broadcast_trivial { non_trivial, c_trivial, f_trivial }; + +// Populates the shape and number of dimensions for the set of buffers. Returns a broadcast_trivial +// enum value indicating whether the broadcast is "trivial"--that is, has each buffer being either a +// singleton or a full-size, C-contiguous (`c_trivial`) or Fortran-contiguous (`f_trivial`) storage +// buffer; returns `non_trivial` otherwise. +template +broadcast_trivial broadcast(const std::array &buffers, ssize_t &ndim, std::vector &shape) { + ndim = std::accumulate(buffers.begin(), buffers.end(), ssize_t(0), [](ssize_t res, const buffer_info &buf) { + return std::max(res, buf.ndim); + }); + + shape.clear(); + shape.resize((size_t) ndim, 1); + + // Figure out the output size, and make sure all input arrays conform (i.e. are either size 1 or + // the full size). + for (size_t i = 0; i < N; ++i) { + auto res_iter = shape.rbegin(); + auto end = buffers[i].shape.rend(); + for (auto shape_iter = buffers[i].shape.rbegin(); shape_iter != end; ++shape_iter, ++res_iter) { + const auto &dim_size_in = *shape_iter; + auto &dim_size_out = *res_iter; + + // Each input dimension can either be 1 or `n`, but `n` values must match across buffers + if (dim_size_out == 1) + dim_size_out = dim_size_in; + else if (dim_size_in != 1 && dim_size_in != dim_size_out) + pybind11_fail("pybind11::vectorize: incompatible size/dimension of inputs!"); + } + } + + bool trivial_broadcast_c = true; + bool trivial_broadcast_f = true; + for (size_t i = 0; i < N && (trivial_broadcast_c || trivial_broadcast_f); ++i) { + if (buffers[i].size == 1) + continue; + + // Require the same number of dimensions: + if (buffers[i].ndim != ndim) + return broadcast_trivial::non_trivial; + + // Require all dimensions be full-size: + if (!std::equal(buffers[i].shape.cbegin(), buffers[i].shape.cend(), shape.cbegin())) + return broadcast_trivial::non_trivial; + + // Check for C contiguity (but only if previous inputs were also C contiguous) + if (trivial_broadcast_c) { + ssize_t expect_stride = buffers[i].itemsize; + auto end = buffers[i].shape.crend(); + for (auto shape_iter = buffers[i].shape.crbegin(), stride_iter = buffers[i].strides.crbegin(); + trivial_broadcast_c && shape_iter != end; ++shape_iter, ++stride_iter) { + if (expect_stride == *stride_iter) + expect_stride *= *shape_iter; + else + trivial_broadcast_c = false; + } + } + + // Check for Fortran contiguity (if previous inputs were also F contiguous) + if (trivial_broadcast_f) { + ssize_t expect_stride = buffers[i].itemsize; + auto end = buffers[i].shape.cend(); + for (auto shape_iter = buffers[i].shape.cbegin(), stride_iter = buffers[i].strides.cbegin(); + trivial_broadcast_f && shape_iter != end; ++shape_iter, ++stride_iter) { + if (expect_stride == *stride_iter) + expect_stride *= *shape_iter; + else + trivial_broadcast_f = false; + } + } + } + + return + trivial_broadcast_c ? broadcast_trivial::c_trivial : + trivial_broadcast_f ? broadcast_trivial::f_trivial : + broadcast_trivial::non_trivial; +} + +template +struct vectorize_arg { + static_assert(!std::is_rvalue_reference::value, "Functions with rvalue reference arguments cannot be vectorized"); + // The wrapped function gets called with this type: + using call_type = remove_reference_t; + // Is this a vectorized argument? + static constexpr bool vectorize = + satisfies_any_of::value && + satisfies_none_of::value && + (!std::is_reference::value || + (std::is_lvalue_reference::value && std::is_const::value)); + // Accept this type: an array for vectorized types, otherwise the type as-is: + using type = conditional_t, array::forcecast>, T>; +}; + +template +struct vectorize_helper { +private: + static constexpr size_t N = sizeof...(Args); + static constexpr size_t NVectorized = constexpr_sum(vectorize_arg::vectorize...); + static_assert(NVectorized >= 1, + "pybind11::vectorize(...) requires a function with at least one vectorizable argument"); + +public: + template + explicit vectorize_helper(T &&f) : f(std::forward(f)) { } + + object operator()(typename vectorize_arg::type... args) { + return run(args..., + make_index_sequence(), + select_indices::vectorize...>(), + make_index_sequence()); + } + +private: + remove_reference_t f; + + template using param_n_t = typename pack_element::call_type...>::type; + + // Runs a vectorized function given arguments tuple and three index sequences: + // - Index is the full set of 0 ... (N-1) argument indices; + // - VIndex is the subset of argument indices with vectorized parameters, letting us access + // vectorized arguments (anything not in this sequence is passed through) + // - BIndex is a incremental sequence (beginning at 0) of the same size as VIndex, so that + // we can store vectorized buffer_infos in an array (argument VIndex has its buffer at + // index BIndex in the array). + template object run( + typename vectorize_arg::type &...args, + index_sequence i_seq, index_sequence vi_seq, index_sequence bi_seq) { + + // Pointers to values the function was called with; the vectorized ones set here will start + // out as array_t pointers, but they will be changed them to T pointers before we make + // call the wrapped function. Non-vectorized pointers are left as-is. + std::array params{{ &args... }}; + + // The array of `buffer_info`s of vectorized arguments: + std::array buffers{{ reinterpret_cast(params[VIndex])->request()... }}; + + /* Determine dimensions parameters of output array */ + ssize_t nd = 0; + std::vector shape(0); + auto trivial = broadcast(buffers, nd, shape); + size_t ndim = (size_t) nd; + + size_t size = std::accumulate(shape.begin(), shape.end(), (size_t) 1, std::multiplies()); + + // If all arguments are 0-dimension arrays (i.e. single values) return a plain value (i.e. + // not wrapped in an array). + if (size == 1 && ndim == 0) { + PYBIND11_EXPAND_SIDE_EFFECTS(params[VIndex] = buffers[BIndex].ptr); + return cast(f(*reinterpret_cast *>(params[Index])...)); + } + + array_t result; + if (trivial == broadcast_trivial::f_trivial) result = array_t(shape); + else result = array_t(shape); + + if (size == 0) return result; + + /* Call the function */ + if (trivial == broadcast_trivial::non_trivial) + apply_broadcast(buffers, params, result, i_seq, vi_seq, bi_seq); + else + apply_trivial(buffers, params, result.mutable_data(), size, i_seq, vi_seq, bi_seq); + + return result; + } + + template + void apply_trivial(std::array &buffers, + std::array ¶ms, + Return *out, + size_t size, + index_sequence, index_sequence, index_sequence) { + + // Initialize an array of mutable byte references and sizes with references set to the + // appropriate pointer in `params`; as we iterate, we'll increment each pointer by its size + // (except for singletons, which get an increment of 0). + std::array, NVectorized> vecparams{{ + std::pair( + reinterpret_cast(params[VIndex] = buffers[BIndex].ptr), + buffers[BIndex].size == 1 ? 0 : sizeof(param_n_t) + )... + }}; + + for (size_t i = 0; i < size; ++i) { + out[i] = f(*reinterpret_cast *>(params[Index])...); + for (auto &x : vecparams) x.first += x.second; + } + } + + template + void apply_broadcast(std::array &buffers, + std::array ¶ms, + array_t &output_array, + index_sequence, index_sequence, index_sequence) { + + buffer_info output = output_array.request(); + multi_array_iterator input_iter(buffers, output.shape); + + for (array_iterator iter = array_begin(output), end = array_end(output); + iter != end; + ++iter, ++input_iter) { + PYBIND11_EXPAND_SIDE_EFFECTS(( + params[VIndex] = input_iter.template data() + )); + *iter = f(*reinterpret_cast *>(std::get(params))...); + } + } +}; + +template +vectorize_helper +vectorize_extractor(const Func &f, Return (*) (Args ...)) { + return detail::vectorize_helper(f); +} + +template struct handle_type_name> { + static PYBIND11_DESCR name() { + return _("numpy.ndarray[") + npy_format_descriptor::name() + _("]"); + } +}; + +NAMESPACE_END(detail) + +// Vanilla pointer vectorizer: +template +detail::vectorize_helper +vectorize(Return (*f) (Args ...)) { + return detail::vectorize_helper(f); +} + +// lambda vectorizer: +template ::value, int> = 0> +auto vectorize(Func &&f) -> decltype( + detail::vectorize_extractor(std::forward(f), (detail::function_signature_t *) nullptr)) { + return detail::vectorize_extractor(std::forward(f), (detail::function_signature_t *) nullptr); +} + +// Vectorize a class method (non-const): +template ())), Return, Class *, Args...>> +Helper vectorize(Return (Class::*f)(Args...)) { + return Helper(std::mem_fn(f)); +} + +// Vectorize a class method (const): +template ())), Return, const Class *, Args...>> +Helper vectorize(Return (Class::*f)(Args...) const) { + return Helper(std::mem_fn(f)); +} + +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(_MSC_VER) +#pragma warning(pop) +#endif diff --git a/plugins/python/pybind11/include/pybind11/operators.h b/plugins/python/pybind11/include/pybind11/operators.h new file mode 100644 index 0000000..b3dd62c --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/operators.h @@ -0,0 +1,168 @@ +/* + pybind11/operator.h: Metatemplates for operator overloading + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" + +#if defined(__clang__) && !defined(__INTEL_COMPILER) +# pragma clang diagnostic ignored "-Wunsequenced" // multiple unsequenced modifications to 'self' (when using def(py::self OP Type())) +#elif defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable: 4127) // warning C4127: Conditional expression is constant +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/// Enumeration with all supported operator types +enum op_id : int { + op_add, op_sub, op_mul, op_div, op_mod, op_divmod, op_pow, op_lshift, + op_rshift, op_and, op_xor, op_or, op_neg, op_pos, op_abs, op_invert, + op_int, op_long, op_float, op_str, op_cmp, op_gt, op_ge, op_lt, op_le, + op_eq, op_ne, op_iadd, op_isub, op_imul, op_idiv, op_imod, op_ilshift, + op_irshift, op_iand, op_ixor, op_ior, op_complex, op_bool, op_nonzero, + op_repr, op_truediv, op_itruediv, op_hash +}; + +enum op_type : int { + op_l, /* base type on left */ + op_r, /* base type on right */ + op_u /* unary operator */ +}; + +struct self_t { }; +static const self_t self = self_t(); + +/// Type for an unused type slot +struct undefined_t { }; + +/// Don't warn about an unused variable +inline self_t __self() { return self; } + +/// base template of operator implementations +template struct op_impl { }; + +/// Operator implementation generator +template struct op_ { + template void execute(Class &cl, const Extra&... extra) const { + using Base = typename Class::type; + using L_type = conditional_t::value, Base, L>; + using R_type = conditional_t::value, Base, R>; + using op = op_impl; + cl.def(op::name(), &op::execute, is_operator(), extra...); + #if PY_MAJOR_VERSION < 3 + if (id == op_truediv || id == op_itruediv) + cl.def(id == op_itruediv ? "__idiv__" : ot == op_l ? "__div__" : "__rdiv__", + &op::execute, is_operator(), extra...); + #endif + } + template void execute_cast(Class &cl, const Extra&... extra) const { + using Base = typename Class::type; + using L_type = conditional_t::value, Base, L>; + using R_type = conditional_t::value, Base, R>; + using op = op_impl; + cl.def(op::name(), &op::execute_cast, is_operator(), extra...); + #if PY_MAJOR_VERSION < 3 + if (id == op_truediv || id == op_itruediv) + cl.def(id == op_itruediv ? "__idiv__" : ot == op_l ? "__div__" : "__rdiv__", + &op::execute, is_operator(), extra...); + #endif + } +}; + +#define PYBIND11_BINARY_OPERATOR(id, rid, op, expr) \ +template struct op_impl { \ + static char const* name() { return "__" #id "__"; } \ + static auto execute(const L &l, const R &r) -> decltype(expr) { return (expr); } \ + static B execute_cast(const L &l, const R &r) { return B(expr); } \ +}; \ +template struct op_impl { \ + static char const* name() { return "__" #rid "__"; } \ + static auto execute(const R &r, const L &l) -> decltype(expr) { return (expr); } \ + static B execute_cast(const R &r, const L &l) { return B(expr); } \ +}; \ +inline op_ op(const self_t &, const self_t &) { \ + return op_(); \ +} \ +template op_ op(const self_t &, const T &) { \ + return op_(); \ +} \ +template op_ op(const T &, const self_t &) { \ + return op_(); \ +} + +#define PYBIND11_INPLACE_OPERATOR(id, op, expr) \ +template struct op_impl { \ + static char const* name() { return "__" #id "__"; } \ + static auto execute(L &l, const R &r) -> decltype(expr) { return expr; } \ + static B execute_cast(L &l, const R &r) { return B(expr); } \ +}; \ +template op_ op(const self_t &, const T &) { \ + return op_(); \ +} + +#define PYBIND11_UNARY_OPERATOR(id, op, expr) \ +template struct op_impl { \ + static char const* name() { return "__" #id "__"; } \ + static auto execute(const L &l) -> decltype(expr) { return expr; } \ + static B execute_cast(const L &l) { return B(expr); } \ +}; \ +inline op_ op(const self_t &) { \ + return op_(); \ +} + +PYBIND11_BINARY_OPERATOR(sub, rsub, operator-, l - r) +PYBIND11_BINARY_OPERATOR(add, radd, operator+, l + r) +PYBIND11_BINARY_OPERATOR(mul, rmul, operator*, l * r) +PYBIND11_BINARY_OPERATOR(truediv, rtruediv, operator/, l / r) +PYBIND11_BINARY_OPERATOR(mod, rmod, operator%, l % r) +PYBIND11_BINARY_OPERATOR(lshift, rlshift, operator<<, l << r) +PYBIND11_BINARY_OPERATOR(rshift, rrshift, operator>>, l >> r) +PYBIND11_BINARY_OPERATOR(and, rand, operator&, l & r) +PYBIND11_BINARY_OPERATOR(xor, rxor, operator^, l ^ r) +PYBIND11_BINARY_OPERATOR(eq, eq, operator==, l == r) +PYBIND11_BINARY_OPERATOR(ne, ne, operator!=, l != r) +PYBIND11_BINARY_OPERATOR(or, ror, operator|, l | r) +PYBIND11_BINARY_OPERATOR(gt, lt, operator>, l > r) +PYBIND11_BINARY_OPERATOR(ge, le, operator>=, l >= r) +PYBIND11_BINARY_OPERATOR(lt, gt, operator<, l < r) +PYBIND11_BINARY_OPERATOR(le, ge, operator<=, l <= r) +//PYBIND11_BINARY_OPERATOR(pow, rpow, pow, std::pow(l, r)) +PYBIND11_INPLACE_OPERATOR(iadd, operator+=, l += r) +PYBIND11_INPLACE_OPERATOR(isub, operator-=, l -= r) +PYBIND11_INPLACE_OPERATOR(imul, operator*=, l *= r) +PYBIND11_INPLACE_OPERATOR(itruediv, operator/=, l /= r) +PYBIND11_INPLACE_OPERATOR(imod, operator%=, l %= r) +PYBIND11_INPLACE_OPERATOR(ilshift, operator<<=, l <<= r) +PYBIND11_INPLACE_OPERATOR(irshift, operator>>=, l >>= r) +PYBIND11_INPLACE_OPERATOR(iand, operator&=, l &= r) +PYBIND11_INPLACE_OPERATOR(ixor, operator^=, l ^= r) +PYBIND11_INPLACE_OPERATOR(ior, operator|=, l |= r) +PYBIND11_UNARY_OPERATOR(neg, operator-, -l) +PYBIND11_UNARY_OPERATOR(pos, operator+, +l) +PYBIND11_UNARY_OPERATOR(abs, abs, std::abs(l)) +PYBIND11_UNARY_OPERATOR(hash, hash, std::hash()(l)) +PYBIND11_UNARY_OPERATOR(invert, operator~, (~l)) +PYBIND11_UNARY_OPERATOR(bool, operator!, !!l) +PYBIND11_UNARY_OPERATOR(int, int_, (int) l) +PYBIND11_UNARY_OPERATOR(float, float_, (double) l) + +#undef PYBIND11_BINARY_OPERATOR +#undef PYBIND11_INPLACE_OPERATOR +#undef PYBIND11_UNARY_OPERATOR +NAMESPACE_END(detail) + +using detail::self; + +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(_MSC_VER) +# pragma warning(pop) +#endif diff --git a/plugins/python/pybind11/include/pybind11/options.h b/plugins/python/pybind11/include/pybind11/options.h new file mode 100644 index 0000000..cc1e1f6 --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/options.h @@ -0,0 +1,65 @@ +/* + pybind11/options.h: global settings that are configurable at runtime. + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "detail/common.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +class options { +public: + + // Default RAII constructor, which leaves settings as they currently are. + options() : previous_state(global_state()) {} + + // Class is non-copyable. + options(const options&) = delete; + options& operator=(const options&) = delete; + + // Destructor, which restores settings that were in effect before. + ~options() { + global_state() = previous_state; + } + + // Setter methods (affect the global state): + + options& disable_user_defined_docstrings() & { global_state().show_user_defined_docstrings = false; return *this; } + + options& enable_user_defined_docstrings() & { global_state().show_user_defined_docstrings = true; return *this; } + + options& disable_function_signatures() & { global_state().show_function_signatures = false; return *this; } + + options& enable_function_signatures() & { global_state().show_function_signatures = true; return *this; } + + // Getter methods (return the global state): + + static bool show_user_defined_docstrings() { return global_state().show_user_defined_docstrings; } + + static bool show_function_signatures() { return global_state().show_function_signatures; } + + // This type is not meant to be allocated on the heap. + void* operator new(size_t) = delete; + +private: + + struct state { + bool show_user_defined_docstrings = true; //< Include user-supplied texts in docstrings. + bool show_function_signatures = true; //< Include auto-generated function signatures in docstrings. + }; + + static state &global_state() { + static state instance; + return instance; + } + + state previous_state; +}; + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/pybind11.h b/plugins/python/pybind11/include/pybind11/pybind11.h new file mode 100644 index 0000000..9094fc4 --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/pybind11.h @@ -0,0 +1,1965 @@ +/* + pybind11/pybind11.h: Main header file of the C++11 python + binding generator library + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#if defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable: 4100) // warning C4100: Unreferenced formal parameter +# pragma warning(disable: 4127) // warning C4127: Conditional expression is constant +# pragma warning(disable: 4512) // warning C4512: Assignment operator was implicitly defined as deleted +# pragma warning(disable: 4800) // warning C4800: 'int': forcing value to bool 'true' or 'false' (performance warning) +# pragma warning(disable: 4996) // warning C4996: The POSIX name for this item is deprecated. Instead, use the ISO C and C++ conformant name +# pragma warning(disable: 4702) // warning C4702: unreachable code +# pragma warning(disable: 4522) // warning C4522: multiple assignment operators specified +#elif defined(__INTEL_COMPILER) +# pragma warning(push) +# pragma warning(disable: 68) // integer conversion resulted in a change of sign +# pragma warning(disable: 186) // pointless comparison of unsigned integer with zero +# pragma warning(disable: 878) // incompatible exception specifications +# pragma warning(disable: 1334) // the "template" keyword used for syntactic disambiguation may only be used within a template +# pragma warning(disable: 1682) // implicit conversion of a 64-bit integral type to a smaller integral type (potential portability problem) +# pragma warning(disable: 1875) // offsetof applied to non-POD (Plain Old Data) types is nonstandard +# pragma warning(disable: 2196) // warning #2196: routine is both "inline" and "noinline" +#elif defined(__GNUG__) && !defined(__clang__) +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wunused-but-set-parameter" +# pragma GCC diagnostic ignored "-Wunused-but-set-variable" +# pragma GCC diagnostic ignored "-Wmissing-field-initializers" +# pragma GCC diagnostic ignored "-Wstrict-aliasing" +# pragma GCC diagnostic ignored "-Wattributes" +# if __GNUC__ >= 7 +# pragma GCC diagnostic ignored "-Wnoexcept-type" +# endif +#endif + +#include "attr.h" +#include "options.h" +#include "detail/class.h" +#include "detail/init.h" + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +/// Wraps an arbitrary C++ function/method/lambda function/.. into a callable Python object +class cpp_function : public function { +public: + cpp_function() { } + + /// Construct a cpp_function from a vanilla function pointer + template + cpp_function(Return (*f)(Args...), const Extra&... extra) { + initialize(f, f, extra...); + } + + /// Construct a cpp_function from a lambda function (possibly with internal state) + template ::value>> + cpp_function(Func &&f, const Extra&... extra) { + initialize(std::forward(f), + (detail::function_signature_t *) nullptr, extra...); + } + + /// Construct a cpp_function from a class method (non-const) + template + cpp_function(Return (Class::*f)(Arg...), const Extra&... extra) { + initialize([f](Class *c, Arg... args) -> Return { return (c->*f)(args...); }, + (Return (*) (Class *, Arg...)) nullptr, extra...); + } + + /// Construct a cpp_function from a class method (const) + template + cpp_function(Return (Class::*f)(Arg...) const, const Extra&... extra) { + initialize([f](const Class *c, Arg... args) -> Return { return (c->*f)(args...); }, + (Return (*)(const Class *, Arg ...)) nullptr, extra...); + } + + /// Return the function name + object name() const { return attr("__name__"); } + +protected: + /// Space optimization: don't inline this frequently instantiated fragment + PYBIND11_NOINLINE detail::function_record *make_function_record() { + return new detail::function_record(); + } + + /// Special internal constructor for functors, lambda functions, etc. + template + void initialize(Func &&f, Return (*)(Args...), const Extra&... extra) { + using namespace detail; + + struct capture { remove_reference_t f; }; + + /* Store the function including any extra state it might have (e.g. a lambda capture object) */ + auto rec = make_function_record(); + + /* Store the capture object directly in the function record if there is enough space */ + if (sizeof(capture) <= sizeof(rec->data)) { + /* Without these pragmas, GCC warns that there might not be + enough space to use the placement new operator. However, the + 'if' statement above ensures that this is the case. */ +#if defined(__GNUG__) && !defined(__clang__) && __GNUC__ >= 6 +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Wplacement-new" +#endif + new ((capture *) &rec->data) capture { std::forward(f) }; +#if defined(__GNUG__) && !defined(__clang__) && __GNUC__ >= 6 +# pragma GCC diagnostic pop +#endif + if (!std::is_trivially_destructible::value) + rec->free_data = [](function_record *r) { ((capture *) &r->data)->~capture(); }; + } else { + rec->data[0] = new capture { std::forward(f) }; + rec->free_data = [](function_record *r) { delete ((capture *) r->data[0]); }; + } + + /* Type casters for the function arguments and return value */ + using cast_in = argument_loader; + using cast_out = make_caster< + conditional_t::value, void_type, Return> + >; + + static_assert(expected_num_args(sizeof...(Args), cast_in::has_args, cast_in::has_kwargs), + "The number of argument annotations does not match the number of function arguments"); + + /* Dispatch code which converts function arguments and performs the actual function call */ + rec->impl = [](function_call &call) -> handle { + cast_in args_converter; + + /* Try to cast the function arguments into the C++ domain */ + if (!args_converter.load_args(call)) + return PYBIND11_TRY_NEXT_OVERLOAD; + + /* Invoke call policy pre-call hook */ + process_attributes::precall(call); + + /* Get a pointer to the capture object */ + auto data = (sizeof(capture) <= sizeof(call.func.data) + ? &call.func.data : call.func.data[0]); + capture *cap = const_cast(reinterpret_cast(data)); + + /* Override policy for rvalues -- usually to enforce rvp::move on an rvalue */ + return_value_policy policy = return_value_policy_override::policy(call.func.policy); + + /* Function scope guard -- defaults to the compile-to-nothing `void_type` */ + using Guard = extract_guard_t; + + /* Perform the function call */ + handle result = cast_out::cast( + std::move(args_converter).template call(cap->f), policy, call.parent); + + /* Invoke call policy post-call hook */ + process_attributes::postcall(call, result); + + return result; + }; + + /* Process any user-provided function attributes */ + process_attributes::init(extra..., rec); + + /* Generate a readable signature describing the function's arguments and return value types */ + PYBIND11_DESCR signature = _("(") + cast_in::arg_names() + _(") -> ") + cast_out::name(); + + /* Register the function with Python from generic (non-templated) code */ + initialize_generic(rec, signature.text(), signature.types(), sizeof...(Args)); + + if (cast_in::has_args) rec->has_args = true; + if (cast_in::has_kwargs) rec->has_kwargs = true; + + /* Stash some additional information used by an important optimization in 'functional.h' */ + using FunctionType = Return (*)(Args...); + constexpr bool is_function_ptr = + std::is_convertible::value && + sizeof(capture) == sizeof(void *); + if (is_function_ptr) { + rec->is_stateless = true; + rec->data[1] = const_cast(reinterpret_cast(&typeid(FunctionType))); + } + } + + /// Register a function call with Python (generic non-templated code goes here) + void initialize_generic(detail::function_record *rec, const char *text, + const std::type_info *const *types, size_t args) { + + /* Create copies of all referenced C-style strings */ + rec->name = strdup(rec->name ? rec->name : ""); + if (rec->doc) rec->doc = strdup(rec->doc); + for (auto &a: rec->args) { + if (a.name) + a.name = strdup(a.name); + if (a.descr) + a.descr = strdup(a.descr); + else if (a.value) + a.descr = strdup(a.value.attr("__repr__")().cast().c_str()); + } + + rec->is_constructor = !strcmp(rec->name, "__init__") || !strcmp(rec->name, "__setstate__"); + +#if !defined(NDEBUG) && !defined(PYBIND11_DISABLE_NEW_STYLE_INIT_WARNING) + if (rec->is_constructor && !rec->is_new_style_constructor) { + const auto class_name = std::string(((PyTypeObject *) rec->scope.ptr())->tp_name); + const auto func_name = std::string(rec->name); + PyErr_WarnEx( + PyExc_FutureWarning, + ("pybind11-bound class '" + class_name + "' is using an old-style " + "placement-new '" + func_name + "' which has been deprecated. See " + "the upgrade guide in pybind11's docs. This message is only visible " + "when compiled in debug mode.").c_str(), 0 + ); + } +#endif + + /* Generate a proper function signature */ + std::string signature; + size_t type_depth = 0, char_index = 0, type_index = 0, arg_index = 0; + while (true) { + char c = text[char_index++]; + if (c == '\0') + break; + + if (c == '{') { + // Write arg name for everything except *args, **kwargs and return type. + if (type_depth == 0 && text[char_index] != '*' && arg_index < args) { + if (!rec->args.empty() && rec->args[arg_index].name) { + signature += rec->args[arg_index].name; + } else if (arg_index == 0 && rec->is_method) { + signature += "self"; + } else { + signature += "arg" + std::to_string(arg_index - (rec->is_method ? 1 : 0)); + } + signature += ": "; + } + ++type_depth; + } else if (c == '}') { + --type_depth; + if (type_depth == 0) { + if (arg_index < rec->args.size() && rec->args[arg_index].descr) { + signature += "="; + signature += rec->args[arg_index].descr; + } + arg_index++; + } + } else if (c == '%') { + const std::type_info *t = types[type_index++]; + if (!t) + pybind11_fail("Internal error while parsing type signature (1)"); + if (auto tinfo = detail::get_type_info(*t)) { + handle th((PyObject *) tinfo->type); + signature += + th.attr("__module__").cast() + "." + + th.attr("__qualname__").cast(); // Python 3.3+, but we backport it to earlier versions + } else if (rec->is_new_style_constructor && arg_index == 0) { + // A new-style `__init__` takes `self` as `value_and_holder`. + // Rewrite it to the proper class type. + signature += + rec->scope.attr("__module__").cast() + "." + + rec->scope.attr("__qualname__").cast(); + } else { + std::string tname(t->name()); + detail::clean_type_id(tname); + signature += tname; + } + } else { + signature += c; + } + } + if (type_depth != 0 || types[type_index] != nullptr) + pybind11_fail("Internal error while parsing type signature (2)"); + + #if !defined(PYBIND11_CONSTEXPR_DESCR) + delete[] types; + delete[] text; + #endif + +#if PY_MAJOR_VERSION < 3 + if (strcmp(rec->name, "__next__") == 0) { + std::free(rec->name); + rec->name = strdup("next"); + } else if (strcmp(rec->name, "__bool__") == 0) { + std::free(rec->name); + rec->name = strdup("__nonzero__"); + } +#endif + rec->signature = strdup(signature.c_str()); + rec->args.shrink_to_fit(); + rec->nargs = (std::uint16_t) args; + + if (rec->sibling && PYBIND11_INSTANCE_METHOD_CHECK(rec->sibling.ptr())) + rec->sibling = PYBIND11_INSTANCE_METHOD_GET_FUNCTION(rec->sibling.ptr()); + + detail::function_record *chain = nullptr, *chain_start = rec; + if (rec->sibling) { + if (PyCFunction_Check(rec->sibling.ptr())) { + auto rec_capsule = reinterpret_borrow(PyCFunction_GET_SELF(rec->sibling.ptr())); + chain = (detail::function_record *) rec_capsule; + /* Never append a method to an overload chain of a parent class; + instead, hide the parent's overloads in this case */ + if (!chain->scope.is(rec->scope)) + chain = nullptr; + } + // Don't trigger for things like the default __init__, which are wrapper_descriptors that we are intentionally replacing + else if (!rec->sibling.is_none() && rec->name[0] != '_') + pybind11_fail("Cannot overload existing non-function object \"" + std::string(rec->name) + + "\" with a function of the same name"); + } + + if (!chain) { + /* No existing overload was found, create a new function object */ + rec->def = new PyMethodDef(); + std::memset(rec->def, 0, sizeof(PyMethodDef)); + rec->def->ml_name = rec->name; + rec->def->ml_meth = reinterpret_cast(reinterpret_cast(*dispatcher)); + rec->def->ml_flags = METH_VARARGS | METH_KEYWORDS; + + capsule rec_capsule(rec, [](void *ptr) { + destruct((detail::function_record *) ptr); + }); + + object scope_module; + if (rec->scope) { + if (hasattr(rec->scope, "__module__")) { + scope_module = rec->scope.attr("__module__"); + } else if (hasattr(rec->scope, "__name__")) { + scope_module = rec->scope.attr("__name__"); + } + } + + m_ptr = PyCFunction_NewEx(rec->def, rec_capsule.ptr(), scope_module.ptr()); + if (!m_ptr) + pybind11_fail("cpp_function::cpp_function(): Could not allocate function object"); + } else { + /* Append at the end of the overload chain */ + m_ptr = rec->sibling.ptr(); + inc_ref(); + chain_start = chain; + if (chain->is_method != rec->is_method) + pybind11_fail("overloading a method with both static and instance methods is not supported; " + #if defined(NDEBUG) + "compile in debug mode for more details" + #else + "error while attempting to bind " + std::string(rec->is_method ? "instance" : "static") + " method " + + std::string(pybind11::str(rec->scope.attr("__name__"))) + "." + std::string(rec->name) + signature + #endif + ); + while (chain->next) + chain = chain->next; + chain->next = rec; + } + + std::string signatures; + int index = 0; + /* Create a nice pydoc rec including all signatures and + docstrings of the functions in the overload chain */ + if (chain && options::show_function_signatures()) { + // First a generic signature + signatures += rec->name; + signatures += "(*args, **kwargs)\n"; + signatures += "Overloaded function.\n\n"; + } + // Then specific overload signatures + bool first_user_def = true; + for (auto it = chain_start; it != nullptr; it = it->next) { + if (options::show_function_signatures()) { + if (index > 0) signatures += "\n"; + if (chain) + signatures += std::to_string(++index) + ". "; + signatures += rec->name; + signatures += it->signature; + signatures += "\n"; + } + if (it->doc && strlen(it->doc) > 0 && options::show_user_defined_docstrings()) { + // If we're appending another docstring, and aren't printing function signatures, we + // need to append a newline first: + if (!options::show_function_signatures()) { + if (first_user_def) first_user_def = false; + else signatures += "\n"; + } + if (options::show_function_signatures()) signatures += "\n"; + signatures += it->doc; + if (options::show_function_signatures()) signatures += "\n"; + } + } + + /* Install docstring */ + PyCFunctionObject *func = (PyCFunctionObject *) m_ptr; + if (func->m_ml->ml_doc) + std::free(const_cast(func->m_ml->ml_doc)); + func->m_ml->ml_doc = strdup(signatures.c_str()); + + if (rec->is_method) { + m_ptr = PYBIND11_INSTANCE_METHOD_NEW(m_ptr, rec->scope.ptr()); + if (!m_ptr) + pybind11_fail("cpp_function::cpp_function(): Could not allocate instance method object"); + Py_DECREF(func); + } + } + + /// When a cpp_function is GCed, release any memory allocated by pybind11 + static void destruct(detail::function_record *rec) { + while (rec) { + detail::function_record *next = rec->next; + if (rec->free_data) + rec->free_data(rec); + std::free((char *) rec->name); + std::free((char *) rec->doc); + std::free((char *) rec->signature); + for (auto &arg: rec->args) { + std::free(const_cast(arg.name)); + std::free(const_cast(arg.descr)); + arg.value.dec_ref(); + } + if (rec->def) { + std::free(const_cast(rec->def->ml_doc)); + delete rec->def; + } + delete rec; + rec = next; + } + } + + /// Main dispatch logic for calls to functions bound using pybind11 + static PyObject *dispatcher(PyObject *self, PyObject *args_in, PyObject *kwargs_in) { + using namespace detail; + + /* Iterator over the list of potentially admissible overloads */ + function_record *overloads = (function_record *) PyCapsule_GetPointer(self, nullptr), + *it = overloads; + + /* Need to know how many arguments + keyword arguments there are to pick the right overload */ + const size_t n_args_in = (size_t) PyTuple_GET_SIZE(args_in); + + handle parent = n_args_in > 0 ? PyTuple_GET_ITEM(args_in, 0) : nullptr, + result = PYBIND11_TRY_NEXT_OVERLOAD; + + auto self_value_and_holder = value_and_holder(); + if (overloads->is_constructor) { + const auto tinfo = get_type_info((PyTypeObject *) overloads->scope.ptr()); + const auto pi = reinterpret_cast(parent.ptr()); + self_value_and_holder = pi->get_value_and_holder(tinfo, false); + + if (!self_value_and_holder.type || !self_value_and_holder.inst) { + PyErr_SetString(PyExc_TypeError, "__init__(self, ...) called with invalid `self` argument"); + return nullptr; + } + + // If this value is already registered it must mean __init__ is invoked multiple times; + // we really can't support that in C++, so just ignore the second __init__. + if (self_value_and_holder.instance_registered()) + return none().release().ptr(); + } + + try { + // We do this in two passes: in the first pass, we load arguments with `convert=false`; + // in the second, we allow conversion (except for arguments with an explicit + // py::arg().noconvert()). This lets us prefer calls without conversion, with + // conversion as a fallback. + std::vector second_pass; + + // However, if there are no overloads, we can just skip the no-convert pass entirely + const bool overloaded = it != nullptr && it->next != nullptr; + + for (; it != nullptr; it = it->next) { + + /* For each overload: + 1. Copy all positional arguments we were given, also checking to make sure that + named positional arguments weren't *also* specified via kwarg. + 2. If we weren't given enough, try to make up the omitted ones by checking + whether they were provided by a kwarg matching the `py::arg("name")` name. If + so, use it (and remove it from kwargs; if not, see if the function binding + provided a default that we can use. + 3. Ensure that either all keyword arguments were "consumed", or that the function + takes a kwargs argument to accept unconsumed kwargs. + 4. Any positional arguments still left get put into a tuple (for args), and any + leftover kwargs get put into a dict. + 5. Pack everything into a vector; if we have py::args or py::kwargs, they are an + extra tuple or dict at the end of the positional arguments. + 6. Call the function call dispatcher (function_record::impl) + + If one of these fail, move on to the next overload and keep trying until we get a + result other than PYBIND11_TRY_NEXT_OVERLOAD. + */ + + function_record &func = *it; + size_t pos_args = func.nargs; // Number of positional arguments that we need + if (func.has_args) --pos_args; // (but don't count py::args + if (func.has_kwargs) --pos_args; // or py::kwargs) + + if (!func.has_args && n_args_in > pos_args) + continue; // Too many arguments for this overload + + if (n_args_in < pos_args && func.args.size() < pos_args) + continue; // Not enough arguments given, and not enough defaults to fill in the blanks + + function_call call(func, parent); + + size_t args_to_copy = std::min(pos_args, n_args_in); + size_t args_copied = 0; + + // 0. Inject new-style `self` argument + if (func.is_new_style_constructor) { + // The `value` may have been preallocated by an old-style `__init__` + // if it was a preceding candidate for overload resolution. + if (self_value_and_holder) + self_value_and_holder.type->dealloc(self_value_and_holder); + + call.init_self = PyTuple_GET_ITEM(args_in, 0); + call.args.push_back(reinterpret_cast(&self_value_and_holder)); + call.args_convert.push_back(false); + ++args_copied; + } + + // 1. Copy any position arguments given. + bool bad_arg = false; + for (; args_copied < args_to_copy; ++args_copied) { + argument_record *arg_rec = args_copied < func.args.size() ? &func.args[args_copied] : nullptr; + if (kwargs_in && arg_rec && arg_rec->name && PyDict_GetItemString(kwargs_in, arg_rec->name)) { + bad_arg = true; + break; + } + + handle arg(PyTuple_GET_ITEM(args_in, args_copied)); + if (arg_rec && !arg_rec->none && arg.is_none()) { + bad_arg = true; + break; + } + call.args.push_back(arg); + call.args_convert.push_back(arg_rec ? arg_rec->convert : true); + } + if (bad_arg) + continue; // Maybe it was meant for another overload (issue #688) + + // We'll need to copy this if we steal some kwargs for defaults + dict kwargs = reinterpret_borrow(kwargs_in); + + // 2. Check kwargs and, failing that, defaults that may help complete the list + if (args_copied < pos_args) { + bool copied_kwargs = false; + + for (; args_copied < pos_args; ++args_copied) { + const auto &arg = func.args[args_copied]; + + handle value; + if (kwargs_in && arg.name) + value = PyDict_GetItemString(kwargs.ptr(), arg.name); + + if (value) { + // Consume a kwargs value + if (!copied_kwargs) { + kwargs = reinterpret_steal(PyDict_Copy(kwargs.ptr())); + copied_kwargs = true; + } + PyDict_DelItemString(kwargs.ptr(), arg.name); + } else if (arg.value) { + value = arg.value; + } + + if (value) { + call.args.push_back(value); + call.args_convert.push_back(arg.convert); + } + else + break; + } + + if (args_copied < pos_args) + continue; // Not enough arguments, defaults, or kwargs to fill the positional arguments + } + + // 3. Check everything was consumed (unless we have a kwargs arg) + if (kwargs && kwargs.size() > 0 && !func.has_kwargs) + continue; // Unconsumed kwargs, but no py::kwargs argument to accept them + + // 4a. If we have a py::args argument, create a new tuple with leftovers + if (func.has_args) { + tuple extra_args; + if (args_to_copy == 0) { + // We didn't copy out any position arguments from the args_in tuple, so we + // can reuse it directly without copying: + extra_args = reinterpret_borrow(args_in); + } else if (args_copied >= n_args_in) { + extra_args = tuple(0); + } else { + size_t args_size = n_args_in - args_copied; + extra_args = tuple(args_size); + for (size_t i = 0; i < args_size; ++i) { + extra_args[i] = PyTuple_GET_ITEM(args_in, args_copied + i); + } + } + call.args.push_back(extra_args); + call.args_convert.push_back(false); + call.args_ref = std::move(extra_args); + } + + // 4b. If we have a py::kwargs, pass on any remaining kwargs + if (func.has_kwargs) { + if (!kwargs.ptr()) + kwargs = dict(); // If we didn't get one, send an empty one + call.args.push_back(kwargs); + call.args_convert.push_back(false); + call.kwargs_ref = std::move(kwargs); + } + + // 5. Put everything in a vector. Not technically step 5, we've been building it + // in `call.args` all along. + #if !defined(NDEBUG) + if (call.args.size() != func.nargs || call.args_convert.size() != func.nargs) + pybind11_fail("Internal error: function call dispatcher inserted wrong number of arguments!"); + #endif + + std::vector second_pass_convert; + if (overloaded) { + // We're in the first no-convert pass, so swap out the conversion flags for a + // set of all-false flags. If the call fails, we'll swap the flags back in for + // the conversion-allowed call below. + second_pass_convert.resize(func.nargs, false); + call.args_convert.swap(second_pass_convert); + } + + // 6. Call the function. + try { + loader_life_support guard{}; + result = func.impl(call); + } catch (reference_cast_error &) { + result = PYBIND11_TRY_NEXT_OVERLOAD; + } + + if (result.ptr() != PYBIND11_TRY_NEXT_OVERLOAD) + break; + + if (overloaded) { + // The (overloaded) call failed; if the call has at least one argument that + // permits conversion (i.e. it hasn't been explicitly specified `.noconvert()`) + // then add this call to the list of second pass overloads to try. + for (size_t i = func.is_method ? 1 : 0; i < pos_args; i++) { + if (second_pass_convert[i]) { + // Found one: swap the converting flags back in and store the call for + // the second pass. + call.args_convert.swap(second_pass_convert); + second_pass.push_back(std::move(call)); + break; + } + } + } + } + + if (overloaded && !second_pass.empty() && result.ptr() == PYBIND11_TRY_NEXT_OVERLOAD) { + // The no-conversion pass finished without success, try again with conversion allowed + for (auto &call : second_pass) { + try { + loader_life_support guard{}; + result = call.func.impl(call); + } catch (reference_cast_error &) { + result = PYBIND11_TRY_NEXT_OVERLOAD; + } + + if (result.ptr() != PYBIND11_TRY_NEXT_OVERLOAD) + break; + } + } + } catch (error_already_set &e) { + e.restore(); + return nullptr; + } catch (...) { + /* When an exception is caught, give each registered exception + translator a chance to translate it to a Python exception + in reverse order of registration. + + A translator may choose to do one of the following: + + - catch the exception and call PyErr_SetString or PyErr_SetObject + to set a standard (or custom) Python exception, or + - do nothing and let the exception fall through to the next translator, or + - delegate translation to the next translator by throwing a new type of exception. */ + + auto last_exception = std::current_exception(); + auto ®istered_exception_translators = get_internals().registered_exception_translators; + for (auto& translator : registered_exception_translators) { + try { + translator(last_exception); + } catch (...) { + last_exception = std::current_exception(); + continue; + } + return nullptr; + } + PyErr_SetString(PyExc_SystemError, "Exception escaped from default exception translator!"); + return nullptr; + } + + auto append_note_if_missing_header_is_suspected = [](std::string &msg) { + if (msg.find("std::") != std::string::npos) { + msg += "\n\n" + "Did you forget to `#include `? Or ,\n" + ", , etc. Some automatic\n" + "conversions are optional and require extra headers to be included\n" + "when compiling your pybind11 module."; + } + }; + + if (result.ptr() == PYBIND11_TRY_NEXT_OVERLOAD) { + if (overloads->is_operator) + return handle(Py_NotImplemented).inc_ref().ptr(); + + std::string msg = std::string(overloads->name) + "(): incompatible " + + std::string(overloads->is_constructor ? "constructor" : "function") + + " arguments. The following argument types are supported:\n"; + + int ctr = 0; + for (function_record *it2 = overloads; it2 != nullptr; it2 = it2->next) { + msg += " "+ std::to_string(++ctr) + ". "; + + bool wrote_sig = false; + if (overloads->is_constructor) { + // For a constructor, rewrite `(self: Object, arg0, ...) -> NoneType` as `Object(arg0, ...)` + std::string sig = it2->signature; + size_t start = sig.find('(') + 7; // skip "(self: " + if (start < sig.size()) { + // End at the , for the next argument + size_t end = sig.find(", "), next = end + 2; + size_t ret = sig.rfind(" -> "); + // Or the ), if there is no comma: + if (end >= sig.size()) next = end = sig.find(')'); + if (start < end && next < sig.size()) { + msg.append(sig, start, end - start); + msg += '('; + msg.append(sig, next, ret - next); + wrote_sig = true; + } + } + } + if (!wrote_sig) msg += it2->signature; + + msg += "\n"; + } + msg += "\nInvoked with: "; + auto args_ = reinterpret_borrow(args_in); + bool some_args = false; + for (size_t ti = overloads->is_constructor ? 1 : 0; ti < args_.size(); ++ti) { + if (!some_args) some_args = true; + else msg += ", "; + msg += pybind11::repr(args_[ti]); + } + if (kwargs_in) { + auto kwargs = reinterpret_borrow(kwargs_in); + if (kwargs.size() > 0) { + if (some_args) msg += "; "; + msg += "kwargs: "; + bool first = true; + for (auto kwarg : kwargs) { + if (first) first = false; + else msg += ", "; + msg += pybind11::str("{}={!r}").format(kwarg.first, kwarg.second); + } + } + } + + append_note_if_missing_header_is_suspected(msg); + PyErr_SetString(PyExc_TypeError, msg.c_str()); + return nullptr; + } else if (!result) { + std::string msg = "Unable to convert function return value to a " + "Python type! The signature was\n\t"; + msg += it->signature; + append_note_if_missing_header_is_suspected(msg); + PyErr_SetString(PyExc_TypeError, msg.c_str()); + return nullptr; + } else { + if (overloads->is_constructor && !self_value_and_holder.holder_constructed()) { + auto *pi = reinterpret_cast(parent.ptr()); + self_value_and_holder.type->init_instance(pi, nullptr); + } + return result.ptr(); + } + } +}; + +/// Wrapper for Python extension modules +class module : public object { +public: + PYBIND11_OBJECT_DEFAULT(module, object, PyModule_Check) + + /// Create a new top-level Python module with the given name and docstring + explicit module(const char *name, const char *doc = nullptr) { + if (!options::show_user_defined_docstrings()) doc = nullptr; +#if PY_MAJOR_VERSION >= 3 + PyModuleDef *def = new PyModuleDef(); + std::memset(def, 0, sizeof(PyModuleDef)); + def->m_name = name; + def->m_doc = doc; + def->m_size = -1; + Py_INCREF(def); + m_ptr = PyModule_Create(def); +#else + m_ptr = Py_InitModule3(name, nullptr, doc); +#endif + if (m_ptr == nullptr) + pybind11_fail("Internal error in module::module()"); + inc_ref(); + } + + /** \rst + Create Python binding for a new function within the module scope. ``Func`` + can be a plain C++ function, a function pointer, or a lambda function. For + details on the ``Extra&& ... extra`` argument, see section :ref:`extras`. + \endrst */ + template + module &def(const char *name_, Func &&f, const Extra& ... extra) { + cpp_function func(std::forward(f), name(name_), scope(*this), + sibling(getattr(*this, name_, none())), extra...); + // NB: allow overwriting here because cpp_function sets up a chain with the intention of + // overwriting (and has already checked internally that it isn't overwriting non-functions). + add_object(name_, func, true /* overwrite */); + return *this; + } + + /** \rst + Create and return a new Python submodule with the given name and docstring. + This also works recursively, i.e. + + .. code-block:: cpp + + py::module m("example", "pybind11 example plugin"); + py::module m2 = m.def_submodule("sub", "A submodule of 'example'"); + py::module m3 = m2.def_submodule("subsub", "A submodule of 'example.sub'"); + \endrst */ + module def_submodule(const char *name, const char *doc = nullptr) { + std::string full_name = std::string(PyModule_GetName(m_ptr)) + + std::string(".") + std::string(name); + auto result = reinterpret_borrow(PyImport_AddModule(full_name.c_str())); + if (doc && options::show_user_defined_docstrings()) + result.attr("__doc__") = pybind11::str(doc); + attr(name) = result; + return result; + } + + /// Import and return a module or throws `error_already_set`. + static module import(const char *name) { + PyObject *obj = PyImport_ImportModule(name); + if (!obj) + throw error_already_set(); + return reinterpret_steal(obj); + } + + /// Reload the module or throws `error_already_set`. + void reload() { + PyObject *obj = PyImport_ReloadModule(ptr()); + if (!obj) + throw error_already_set(); + *this = reinterpret_steal(obj); + } + + // Adds an object to the module using the given name. Throws if an object with the given name + // already exists. + // + // overwrite should almost always be false: attempting to overwrite objects that pybind11 has + // established will, in most cases, break things. + PYBIND11_NOINLINE void add_object(const char *name, handle obj, bool overwrite = false) { + if (!overwrite && hasattr(*this, name)) + pybind11_fail("Error during initialization: multiple incompatible definitions with name \"" + + std::string(name) + "\""); + + PyModule_AddObject(ptr(), name, obj.inc_ref().ptr() /* steals a reference */); + } +}; + +/// \ingroup python_builtins +/// Return a dictionary representing the global variables in the current execution frame, +/// or ``__main__.__dict__`` if there is no frame (usually when the interpreter is embedded). +inline dict globals() { + PyObject *p = PyEval_GetGlobals(); + return reinterpret_borrow(p ? p : module::import("__main__").attr("__dict__").ptr()); +} + +NAMESPACE_BEGIN(detail) +/// Generic support for creating new Python heap types +class generic_type : public object { + template friend class class_; +public: + PYBIND11_OBJECT_DEFAULT(generic_type, object, PyType_Check) +protected: + void initialize(const type_record &rec) { + if (rec.scope && hasattr(rec.scope, rec.name)) + pybind11_fail("generic_type: cannot initialize type \"" + std::string(rec.name) + + "\": an object with that name is already defined"); + + if (rec.module_local ? get_local_type_info(*rec.type) : get_global_type_info(*rec.type)) + pybind11_fail("generic_type: type \"" + std::string(rec.name) + + "\" is already registered!"); + + m_ptr = make_new_python_type(rec); + + /* Register supplemental type information in C++ dict */ + auto *tinfo = new detail::type_info(); + tinfo->type = (PyTypeObject *) m_ptr; + tinfo->cpptype = rec.type; + tinfo->type_size = rec.type_size; + tinfo->operator_new = rec.operator_new; + tinfo->holder_size_in_ptrs = size_in_ptrs(rec.holder_size); + tinfo->init_instance = rec.init_instance; + tinfo->dealloc = rec.dealloc; + tinfo->simple_type = true; + tinfo->simple_ancestors = true; + tinfo->default_holder = rec.default_holder; + tinfo->module_local = rec.module_local; + + auto &internals = get_internals(); + auto tindex = std::type_index(*rec.type); + tinfo->direct_conversions = &internals.direct_conversions[tindex]; + if (rec.module_local) + registered_local_types_cpp()[tindex] = tinfo; + else + internals.registered_types_cpp[tindex] = tinfo; + internals.registered_types_py[(PyTypeObject *) m_ptr] = { tinfo }; + + if (rec.bases.size() > 1 || rec.multiple_inheritance) { + mark_parents_nonsimple(tinfo->type); + tinfo->simple_ancestors = false; + } + else if (rec.bases.size() == 1) { + auto parent_tinfo = get_type_info((PyTypeObject *) rec.bases[0].ptr()); + tinfo->simple_ancestors = parent_tinfo->simple_ancestors; + } + + if (rec.module_local) { + // Stash the local typeinfo and loader so that external modules can access it. + tinfo->module_local_load = &type_caster_generic::local_load; + setattr(m_ptr, PYBIND11_MODULE_LOCAL_ID, capsule(tinfo)); + } + } + + /// Helper function which tags all parents of a type using mult. inheritance + void mark_parents_nonsimple(PyTypeObject *value) { + auto t = reinterpret_borrow(value->tp_bases); + for (handle h : t) { + auto tinfo2 = get_type_info((PyTypeObject *) h.ptr()); + if (tinfo2) + tinfo2->simple_type = false; + mark_parents_nonsimple((PyTypeObject *) h.ptr()); + } + } + + void install_buffer_funcs( + buffer_info *(*get_buffer)(PyObject *, void *), + void *get_buffer_data) { + PyHeapTypeObject *type = (PyHeapTypeObject*) m_ptr; + auto tinfo = detail::get_type_info(&type->ht_type); + + if (!type->ht_type.tp_as_buffer) + pybind11_fail( + "To be able to register buffer protocol support for the type '" + + std::string(tinfo->type->tp_name) + + "' the associated class<>(..) invocation must " + "include the pybind11::buffer_protocol() annotation!"); + + tinfo->get_buffer = get_buffer; + tinfo->get_buffer_data = get_buffer_data; + } + + void def_property_static_impl(const char *name, + handle fget, handle fset, + detail::function_record *rec_fget) { + const auto is_static = !(rec_fget->is_method && rec_fget->scope); + const auto has_doc = rec_fget->doc && pybind11::options::show_user_defined_docstrings(); + + auto property = handle((PyObject *) (is_static ? get_internals().static_property_type + : &PyProperty_Type)); + attr(name) = property(fget.ptr() ? fget : none(), + fset.ptr() ? fset : none(), + /*deleter*/none(), + pybind11::str(has_doc ? rec_fget->doc : "")); + } +}; + +/// Set the pointer to operator new if it exists. The cast is needed because it can be overloaded. +template (T::operator new))>> +void set_operator_new(type_record *r) { r->operator_new = &T::operator new; } + +template void set_operator_new(...) { } + +template struct has_operator_delete : std::false_type { }; +template struct has_operator_delete(T::operator delete))>> + : std::true_type { }; +template struct has_operator_delete_size : std::false_type { }; +template struct has_operator_delete_size(T::operator delete))>> + : std::true_type { }; +/// Call class-specific delete if it exists or global otherwise. Can also be an overload set. +template ::value, int> = 0> +void call_operator_delete(T *p, size_t) { T::operator delete(p); } +template ::value && has_operator_delete_size::value, int> = 0> +void call_operator_delete(T *p, size_t s) { T::operator delete(p, s); } + +inline void call_operator_delete(void *p, size_t) { ::operator delete(p); } + +NAMESPACE_END(detail) + +/// Given a pointer to a member function, cast it to its `Derived` version. +/// Forward everything else unchanged. +template +auto method_adaptor(F &&f) -> decltype(std::forward(f)) { return std::forward(f); } + +template +auto method_adaptor(Return (Class::*pmf)(Args...)) -> Return (Derived::*)(Args...) { return pmf; } + +template +auto method_adaptor(Return (Class::*pmf)(Args...) const) -> Return (Derived::*)(Args...) const { return pmf; } + +template +class class_ : public detail::generic_type { + template using is_holder = detail::is_holder_type; + template using is_subtype = detail::is_strict_base_of; + template using is_base = detail::is_strict_base_of; + // struct instead of using here to help MSVC: + template struct is_valid_class_option : + detail::any_of, is_subtype, is_base> {}; + +public: + using type = type_; + using type_alias = detail::exactly_one_t; + constexpr static bool has_alias = !std::is_void::value; + using holder_type = detail::exactly_one_t, options...>; + + static_assert(detail::all_of...>::value, + "Unknown/invalid class_ template parameters provided"); + + static_assert(!has_alias || std::is_polymorphic::value, + "Cannot use an alias class with a non-polymorphic type"); + + PYBIND11_OBJECT(class_, generic_type, PyType_Check) + + template + class_(handle scope, const char *name, const Extra &... extra) { + using namespace detail; + + // MI can only be specified via class_ template options, not constructor parameters + static_assert( + none_of...>::value || // no base class arguments, or: + ( constexpr_sum(is_pyobject::value...) == 1 && // Exactly one base + constexpr_sum(is_base::value...) == 0 && // no template option bases + none_of...>::value), // no multiple_inheritance attr + "Error: multiple inheritance bases must be specified via class_ template options"); + + type_record record; + record.scope = scope; + record.name = name; + record.type = &typeid(type); + record.type_size = sizeof(conditional_t); + record.holder_size = sizeof(holder_type); + record.init_instance = init_instance; + record.dealloc = dealloc; + record.default_holder = std::is_same>::value; + + set_operator_new(&record); + + /* Register base classes specified via template arguments to class_, if any */ + PYBIND11_EXPAND_SIDE_EFFECTS(add_base(record)); + + /* Process optional arguments, if any */ + process_attributes::init(extra..., &record); + + generic_type::initialize(record); + + if (has_alias) { + auto &instances = record.module_local ? registered_local_types_cpp() : get_internals().registered_types_cpp; + instances[std::type_index(typeid(type_alias))] = instances[std::type_index(typeid(type))]; + } + } + + template ::value, int> = 0> + static void add_base(detail::type_record &rec) { + rec.add_base(typeid(Base), [](void *src) -> void * { + return static_cast(reinterpret_cast(src)); + }); + } + + template ::value, int> = 0> + static void add_base(detail::type_record &) { } + + template + class_ &def(const char *name_, Func&& f, const Extra&... extra) { + cpp_function cf(method_adaptor(std::forward(f)), name(name_), is_method(*this), + sibling(getattr(*this, name_, none())), extra...); + attr(cf.name()) = cf; + return *this; + } + + template class_ & + def_static(const char *name_, Func &&f, const Extra&... extra) { + static_assert(!std::is_member_function_pointer::value, + "def_static(...) called with a non-static member function pointer"); + cpp_function cf(std::forward(f), name(name_), scope(*this), + sibling(getattr(*this, name_, none())), extra...); + attr(cf.name()) = cf; + return *this; + } + + template + class_ &def(const detail::op_ &op, const Extra&... extra) { + op.execute(*this, extra...); + return *this; + } + + template + class_ & def_cast(const detail::op_ &op, const Extra&... extra) { + op.execute_cast(*this, extra...); + return *this; + } + + template + class_ &def(const detail::initimpl::constructor &init, const Extra&... extra) { + init.execute(*this, extra...); + return *this; + } + + template + class_ &def(const detail::initimpl::alias_constructor &init, const Extra&... extra) { + init.execute(*this, extra...); + return *this; + } + + template + class_ &def(detail::initimpl::factory &&init, const Extra&... extra) { + std::move(init).execute(*this, extra...); + return *this; + } + + template + class_ &def(detail::initimpl::pickle_factory &&pf, const Extra &...extra) { + std::move(pf).execute(*this, extra...); + return *this; + } + + template class_& def_buffer(Func &&func) { + struct capture { Func func; }; + capture *ptr = new capture { std::forward(func) }; + install_buffer_funcs([](PyObject *obj, void *ptr) -> buffer_info* { + detail::make_caster caster; + if (!caster.load(obj, false)) + return nullptr; + return new buffer_info(((capture *) ptr)->func(caster)); + }, ptr); + return *this; + } + + template + class_ &def_buffer(Return (Class::*func)(Args...)) { + return def_buffer([func] (type &obj) { return (obj.*func)(); }); + } + + template + class_ &def_buffer(Return (Class::*func)(Args...) const) { + return def_buffer([func] (const type &obj) { return (obj.*func)(); }); + } + + template + class_ &def_readwrite(const char *name, D C::*pm, const Extra&... extra) { + static_assert(std::is_base_of::value, "def_readwrite() requires a class member (or base class member)"); + cpp_function fget([pm](const type &c) -> const D &{ return c.*pm; }, is_method(*this)), + fset([pm](type &c, const D &value) { c.*pm = value; }, is_method(*this)); + def_property(name, fget, fset, return_value_policy::reference_internal, extra...); + return *this; + } + + template + class_ &def_readonly(const char *name, const D C::*pm, const Extra& ...extra) { + static_assert(std::is_base_of::value, "def_readonly() requires a class member (or base class member)"); + cpp_function fget([pm](const type &c) -> const D &{ return c.*pm; }, is_method(*this)); + def_property_readonly(name, fget, return_value_policy::reference_internal, extra...); + return *this; + } + + template + class_ &def_readwrite_static(const char *name, D *pm, const Extra& ...extra) { + cpp_function fget([pm](object) -> const D &{ return *pm; }, scope(*this)), + fset([pm](object, const D &value) { *pm = value; }, scope(*this)); + def_property_static(name, fget, fset, return_value_policy::reference, extra...); + return *this; + } + + template + class_ &def_readonly_static(const char *name, const D *pm, const Extra& ...extra) { + cpp_function fget([pm](object) -> const D &{ return *pm; }, scope(*this)); + def_property_readonly_static(name, fget, return_value_policy::reference, extra...); + return *this; + } + + /// Uses return_value_policy::reference_internal by default + template + class_ &def_property_readonly(const char *name, const Getter &fget, const Extra& ...extra) { + return def_property_readonly(name, cpp_function(method_adaptor(fget)), + return_value_policy::reference_internal, extra...); + } + + /// Uses cpp_function's return_value_policy by default + template + class_ &def_property_readonly(const char *name, const cpp_function &fget, const Extra& ...extra) { + return def_property(name, fget, cpp_function(), extra...); + } + + /// Uses return_value_policy::reference by default + template + class_ &def_property_readonly_static(const char *name, const Getter &fget, const Extra& ...extra) { + return def_property_readonly_static(name, cpp_function(fget), return_value_policy::reference, extra...); + } + + /// Uses cpp_function's return_value_policy by default + template + class_ &def_property_readonly_static(const char *name, const cpp_function &fget, const Extra& ...extra) { + return def_property_static(name, fget, cpp_function(), extra...); + } + + /// Uses return_value_policy::reference_internal by default + template + class_ &def_property(const char *name, const Getter &fget, const Setter &fset, const Extra& ...extra) { + return def_property(name, fget, cpp_function(method_adaptor(fset)), extra...); + } + template + class_ &def_property(const char *name, const Getter &fget, const cpp_function &fset, const Extra& ...extra) { + return def_property(name, cpp_function(method_adaptor(fget)), fset, + return_value_policy::reference_internal, extra...); + } + + /// Uses cpp_function's return_value_policy by default + template + class_ &def_property(const char *name, const cpp_function &fget, const cpp_function &fset, const Extra& ...extra) { + return def_property_static(name, fget, fset, is_method(*this), extra...); + } + + /// Uses return_value_policy::reference by default + template + class_ &def_property_static(const char *name, const Getter &fget, const cpp_function &fset, const Extra& ...extra) { + return def_property_static(name, cpp_function(fget), fset, return_value_policy::reference, extra...); + } + + /// Uses cpp_function's return_value_policy by default + template + class_ &def_property_static(const char *name, const cpp_function &fget, const cpp_function &fset, const Extra& ...extra) { + auto rec_fget = get_function_record(fget), rec_fset = get_function_record(fset); + char *doc_prev = rec_fget->doc; /* 'extra' field may include a property-specific documentation string */ + detail::process_attributes::init(extra..., rec_fget); + if (rec_fget->doc && rec_fget->doc != doc_prev) { + free(doc_prev); + rec_fget->doc = strdup(rec_fget->doc); + } + if (rec_fset) { + doc_prev = rec_fset->doc; + detail::process_attributes::init(extra..., rec_fset); + if (rec_fset->doc && rec_fset->doc != doc_prev) { + free(doc_prev); + rec_fset->doc = strdup(rec_fset->doc); + } + } + def_property_static_impl(name, fget, fset, rec_fget); + return *this; + } + +private: + /// Initialize holder object, variant 1: object derives from enable_shared_from_this + template + static void init_holder(detail::instance *inst, detail::value_and_holder &v_h, + const holder_type * /* unused */, const std::enable_shared_from_this * /* dummy */) { + try { + auto sh = std::dynamic_pointer_cast( + v_h.value_ptr()->shared_from_this()); + if (sh) { + new (std::addressof(v_h.holder())) holder_type(std::move(sh)); + v_h.set_holder_constructed(); + } + } catch (const std::bad_weak_ptr &) {} + + if (!v_h.holder_constructed() && inst->owned) { + new (std::addressof(v_h.holder())) holder_type(v_h.value_ptr()); + v_h.set_holder_constructed(); + } + } + + static void init_holder_from_existing(const detail::value_and_holder &v_h, + const holder_type *holder_ptr, std::true_type /*is_copy_constructible*/) { + new (std::addressof(v_h.holder())) holder_type(*reinterpret_cast(holder_ptr)); + } + + static void init_holder_from_existing(const detail::value_and_holder &v_h, + const holder_type *holder_ptr, std::false_type /*is_copy_constructible*/) { + new (std::addressof(v_h.holder())) holder_type(std::move(*const_cast(holder_ptr))); + } + + /// Initialize holder object, variant 2: try to construct from existing holder object, if possible + static void init_holder(detail::instance *inst, detail::value_and_holder &v_h, + const holder_type *holder_ptr, const void * /* dummy -- not enable_shared_from_this) */) { + if (holder_ptr) { + init_holder_from_existing(v_h, holder_ptr, std::is_copy_constructible()); + v_h.set_holder_constructed(); + } else if (inst->owned || detail::always_construct_holder::value) { + new (std::addressof(v_h.holder())) holder_type(v_h.value_ptr()); + v_h.set_holder_constructed(); + } + } + + /// Performs instance initialization including constructing a holder and registering the known + /// instance. Should be called as soon as the `type` value_ptr is set for an instance. Takes an + /// optional pointer to an existing holder to use; if not specified and the instance is + /// `.owned`, a new holder will be constructed to manage the value pointer. + static void init_instance(detail::instance *inst, const void *holder_ptr) { + auto v_h = inst->get_value_and_holder(detail::get_type_info(typeid(type))); + if (!v_h.instance_registered()) { + register_instance(inst, v_h.value_ptr(), v_h.type); + v_h.set_instance_registered(); + } + init_holder(inst, v_h, (const holder_type *) holder_ptr, v_h.value_ptr()); + } + + /// Deallocates an instance; via holder, if constructed; otherwise via operator delete. + static void dealloc(detail::value_and_holder &v_h) { + if (v_h.holder_constructed()) { + v_h.holder().~holder_type(); + v_h.set_holder_constructed(false); + } + else { + detail::call_operator_delete(v_h.value_ptr(), v_h.type->type_size); + } + v_h.value_ptr() = nullptr; + } + + static detail::function_record *get_function_record(handle h) { + h = detail::get_function(h); + return h ? (detail::function_record *) reinterpret_borrow(PyCFunction_GET_SELF(h.ptr())) + : nullptr; + } +}; + +/// Binds an existing constructor taking arguments Args... +template detail::initimpl::constructor init() { return {}; } +/// Like `init()`, but the instance is always constructed through the alias class (even +/// when not inheriting on the Python side). +template detail::initimpl::alias_constructor init_alias() { return {}; } + +/// Binds a factory function as a constructor +template > +Ret init(Func &&f) { return {std::forward(f)}; } + +/// Dual-argument factory function: the first function is called when no alias is needed, the second +/// when an alias is needed (i.e. due to python-side inheritance). Arguments must be identical. +template > +Ret init(CFunc &&c, AFunc &&a) { + return {std::forward(c), std::forward(a)}; +} + +/// Binds pickling functions `__getstate__` and `__setstate__` and ensures that the type +/// returned by `__getstate__` is the same as the argument accepted by `__setstate__`. +template +detail::initimpl::pickle_factory pickle(GetState &&g, SetState &&s) { + return {std::forward(g), std::forward(s)}; +} + +/// Binds C++ enumerations and enumeration classes to Python +template class enum_ : public class_ { +public: + using class_::def; + using class_::def_property_readonly_static; + using Scalar = typename std::underlying_type::type; + + template + enum_(const handle &scope, const char *name, const Extra&... extra) + : class_(scope, name, extra...), m_entries(), m_parent(scope) { + + constexpr bool is_arithmetic = detail::any_of...>::value; + + auto m_entries_ptr = m_entries.inc_ref().ptr(); + def("__repr__", [name, m_entries_ptr](Type value) -> pybind11::str { + for (const auto &kv : reinterpret_borrow(m_entries_ptr)) { + if (pybind11::cast(kv.second) == value) + return pybind11::str("{}.{}").format(name, kv.first); + } + return pybind11::str("{}.???").format(name); + }); + def_property_readonly_static("__members__", [m_entries_ptr](object /* self */) { + dict m; + for (const auto &kv : reinterpret_borrow(m_entries_ptr)) + m[kv.first] = kv.second; + return m; + }, return_value_policy::copy); + def(init([](Scalar i) { return static_cast(i); })); + def("__int__", [](Type value) { return (Scalar) value; }); + #if PY_MAJOR_VERSION < 3 + def("__long__", [](Type value) { return (Scalar) value; }); + #endif + def("__eq__", [](const Type &value, Type *value2) { return value2 && value == *value2; }); + def("__ne__", [](const Type &value, Type *value2) { return !value2 || value != *value2; }); + if (is_arithmetic) { + def("__lt__", [](const Type &value, Type *value2) { return value2 && value < *value2; }); + def("__gt__", [](const Type &value, Type *value2) { return value2 && value > *value2; }); + def("__le__", [](const Type &value, Type *value2) { return value2 && value <= *value2; }); + def("__ge__", [](const Type &value, Type *value2) { return value2 && value >= *value2; }); + } + if (std::is_convertible::value) { + // Don't provide comparison with the underlying type if the enum isn't convertible, + // i.e. if Type is a scoped enum, mirroring the C++ behaviour. (NB: we explicitly + // convert Type to Scalar below anyway because this needs to compile). + def("__eq__", [](const Type &value, Scalar value2) { return (Scalar) value == value2; }); + def("__ne__", [](const Type &value, Scalar value2) { return (Scalar) value != value2; }); + if (is_arithmetic) { + def("__lt__", [](const Type &value, Scalar value2) { return (Scalar) value < value2; }); + def("__gt__", [](const Type &value, Scalar value2) { return (Scalar) value > value2; }); + def("__le__", [](const Type &value, Scalar value2) { return (Scalar) value <= value2; }); + def("__ge__", [](const Type &value, Scalar value2) { return (Scalar) value >= value2; }); + def("__invert__", [](const Type &value) { return ~((Scalar) value); }); + def("__and__", [](const Type &value, Scalar value2) { return (Scalar) value & value2; }); + def("__or__", [](const Type &value, Scalar value2) { return (Scalar) value | value2; }); + def("__xor__", [](const Type &value, Scalar value2) { return (Scalar) value ^ value2; }); + def("__rand__", [](const Type &value, Scalar value2) { return (Scalar) value & value2; }); + def("__ror__", [](const Type &value, Scalar value2) { return (Scalar) value | value2; }); + def("__rxor__", [](const Type &value, Scalar value2) { return (Scalar) value ^ value2; }); + def("__and__", [](const Type &value, const Type &value2) { return (Scalar) value & (Scalar) value2; }); + def("__or__", [](const Type &value, const Type &value2) { return (Scalar) value | (Scalar) value2; }); + def("__xor__", [](const Type &value, const Type &value2) { return (Scalar) value ^ (Scalar) value2; }); + } + } + def("__hash__", [](const Type &value) { return (Scalar) value; }); + // Pickling and unpickling -- needed for use with the 'multiprocessing' module + def(pickle([](const Type &value) { return pybind11::make_tuple((Scalar) value); }, + [](tuple t) { return static_cast(t[0].cast()); })); + } + + /// Export enumeration entries into the parent scope + enum_& export_values() { + for (const auto &kv : m_entries) + m_parent.attr(kv.first) = kv.second; + return *this; + } + + /// Add an enumeration entry + enum_& value(char const* name, Type value) { + auto v = pybind11::cast(value, return_value_policy::copy); + this->attr(name) = v; + m_entries[pybind11::str(name)] = v; + return *this; + } + +private: + dict m_entries; + handle m_parent; +}; + +NAMESPACE_BEGIN(detail) + + +inline void keep_alive_impl(handle nurse, handle patient) { + if (!nurse || !patient) + pybind11_fail("Could not activate keep_alive!"); + + if (patient.is_none() || nurse.is_none()) + return; /* Nothing to keep alive or nothing to be kept alive by */ + + auto tinfo = all_type_info(Py_TYPE(nurse.ptr())); + if (!tinfo.empty()) { + /* It's a pybind-registered type, so we can store the patient in the + * internal list. */ + add_patient(nurse.ptr(), patient.ptr()); + } + else { + /* Fall back to clever approach based on weak references taken from + * Boost.Python. This is not used for pybind-registered types because + * the objects can be destroyed out-of-order in a GC pass. */ + cpp_function disable_lifesupport( + [patient](handle weakref) { patient.dec_ref(); weakref.dec_ref(); }); + + weakref wr(nurse, disable_lifesupport); + + patient.inc_ref(); /* reference patient and leak the weak reference */ + (void) wr.release(); + } +} + +PYBIND11_NOINLINE inline void keep_alive_impl(size_t Nurse, size_t Patient, function_call &call, handle ret) { + auto get_arg = [&](size_t n) { + if (n == 0) + return ret; + else if (n == 1 && call.init_self) + return call.init_self; + else if (n <= call.args.size()) + return call.args[n - 1]; + return handle(); + }; + + keep_alive_impl(get_arg(Nurse), get_arg(Patient)); +} + +inline std::pair all_type_info_get_cache(PyTypeObject *type) { + auto res = get_internals().registered_types_py +#ifdef __cpp_lib_unordered_map_try_emplace + .try_emplace(type); +#else + .emplace(type, std::vector()); +#endif + if (res.second) { + // New cache entry created; set up a weak reference to automatically remove it if the type + // gets destroyed: + weakref((PyObject *) type, cpp_function([type](handle wr) { + get_internals().registered_types_py.erase(type); + wr.dec_ref(); + })).release(); + } + + return res; +} + +template +struct iterator_state { + Iterator it; + Sentinel end; + bool first_or_done; +}; + +NAMESPACE_END(detail) + +/// Makes a python iterator from a first and past-the-end C++ InputIterator. +template ()), + typename... Extra> +iterator make_iterator(Iterator first, Sentinel last, Extra &&... extra) { + typedef detail::iterator_state state; + + if (!detail::get_type_info(typeid(state), false)) { + class_(handle(), "iterator", pybind11::module_local()) + .def("__iter__", [](state &s) -> state& { return s; }) + .def("__next__", [](state &s) -> ValueType { + if (!s.first_or_done) + ++s.it; + else + s.first_or_done = false; + if (s.it == s.end) { + s.first_or_done = true; + throw stop_iteration(); + } + return *s.it; + }, std::forward(extra)..., Policy); + } + + return cast(state{first, last, true}); +} + +/// Makes an python iterator over the keys (`.first`) of a iterator over pairs from a +/// first and past-the-end InputIterator. +template ()).first), + typename... Extra> +iterator make_key_iterator(Iterator first, Sentinel last, Extra &&... extra) { + typedef detail::iterator_state state; + + if (!detail::get_type_info(typeid(state), false)) { + class_(handle(), "iterator", pybind11::module_local()) + .def("__iter__", [](state &s) -> state& { return s; }) + .def("__next__", [](state &s) -> KeyType { + if (!s.first_or_done) + ++s.it; + else + s.first_or_done = false; + if (s.it == s.end) { + s.first_or_done = true; + throw stop_iteration(); + } + return (*s.it).first; + }, std::forward(extra)..., Policy); + } + + return cast(state{first, last, true}); +} + +/// Makes an iterator over values of an stl container or other container supporting +/// `std::begin()`/`std::end()` +template iterator make_iterator(Type &value, Extra&&... extra) { + return make_iterator(std::begin(value), std::end(value), extra...); +} + +/// Makes an iterator over the keys (`.first`) of a stl map-like container supporting +/// `std::begin()`/`std::end()` +template iterator make_key_iterator(Type &value, Extra&&... extra) { + return make_key_iterator(std::begin(value), std::end(value), extra...); +} + +template void implicitly_convertible() { + struct set_flag { + bool &flag; + set_flag(bool &flag) : flag(flag) { flag = true; } + ~set_flag() { flag = false; } + }; + auto implicit_caster = [](PyObject *obj, PyTypeObject *type) -> PyObject * { + static bool currently_used = false; + if (currently_used) // implicit conversions are non-reentrant + return nullptr; + set_flag flag_helper(currently_used); + if (!detail::make_caster().load(obj, false)) + return nullptr; + tuple args(1); + args[0] = obj; + PyObject *result = PyObject_Call((PyObject *) type, args.ptr(), nullptr); + if (result == nullptr) + PyErr_Clear(); + return result; + }; + + if (auto tinfo = detail::get_type_info(typeid(OutputType))) + tinfo->implicit_conversions.push_back(implicit_caster); + else + pybind11_fail("implicitly_convertible: Unable to find type " + type_id()); +} + +template +void register_exception_translator(ExceptionTranslator&& translator) { + detail::get_internals().registered_exception_translators.push_front( + std::forward(translator)); +} + +/** + * Wrapper to generate a new Python exception type. + * + * This should only be used with PyErr_SetString for now. + * It is not (yet) possible to use as a py::base. + * Template type argument is reserved for future use. + */ +template +class exception : public object { +public: + exception() = default; + exception(handle scope, const char *name, PyObject *base = PyExc_Exception) { + std::string full_name = scope.attr("__name__").cast() + + std::string(".") + name; + m_ptr = PyErr_NewException(const_cast(full_name.c_str()), base, NULL); + if (hasattr(scope, name)) + pybind11_fail("Error during initialization: multiple incompatible " + "definitions with name \"" + std::string(name) + "\""); + scope.attr(name) = *this; + } + + // Sets the current python exception to this exception object with the given message + void operator()(const char *message) { + PyErr_SetString(m_ptr, message); + } +}; + +NAMESPACE_BEGIN(detail) +// Returns a reference to a function-local static exception object used in the simple +// register_exception approach below. (It would be simpler to have the static local variable +// directly in register_exception, but that makes clang <3.5 segfault - issue #1349). +template +exception &get_exception_object() { static exception ex; return ex; } +NAMESPACE_END(detail) + +/** + * Registers a Python exception in `m` of the given `name` and installs an exception translator to + * translate the C++ exception to the created Python exception using the exceptions what() method. + * This is intended for simple exception translations; for more complex translation, register the + * exception object and translator directly. + */ +template +exception ®ister_exception(handle scope, + const char *name, + PyObject *base = PyExc_Exception) { + auto &ex = detail::get_exception_object(); + if (!ex) ex = exception(scope, name, base); + + register_exception_translator([](std::exception_ptr p) { + if (!p) return; + try { + std::rethrow_exception(p); + } catch (const CppException &e) { + detail::get_exception_object()(e.what()); + } + }); + return ex; +} + +NAMESPACE_BEGIN(detail) +PYBIND11_NOINLINE inline void print(tuple args, dict kwargs) { + auto strings = tuple(args.size()); + for (size_t i = 0; i < args.size(); ++i) { + strings[i] = str(args[i]); + } + auto sep = kwargs.contains("sep") ? kwargs["sep"] : cast(" "); + auto line = sep.attr("join")(strings); + + object file; + if (kwargs.contains("file")) { + file = kwargs["file"].cast(); + } else { + try { + file = module::import("sys").attr("stdout"); + } catch (const error_already_set &) { + /* If print() is called from code that is executed as + part of garbage collection during interpreter shutdown, + importing 'sys' can fail. Give up rather than crashing the + interpreter in this case. */ + return; + } + } + + auto write = file.attr("write"); + write(line); + write(kwargs.contains("end") ? kwargs["end"] : cast("\n")); + + if (kwargs.contains("flush") && kwargs["flush"].cast()) + file.attr("flush")(); +} +NAMESPACE_END(detail) + +template +void print(Args &&...args) { + auto c = detail::collect_arguments(std::forward(args)...); + detail::print(c.args(), c.kwargs()); +} + +#if defined(WITH_THREAD) && !defined(PYPY_VERSION) + +/* The functions below essentially reproduce the PyGILState_* API using a RAII + * pattern, but there are a few important differences: + * + * 1. When acquiring the GIL from an non-main thread during the finalization + * phase, the GILState API blindly terminates the calling thread, which + * is often not what is wanted. This API does not do this. + * + * 2. The gil_scoped_release function can optionally cut the relationship + * of a PyThreadState and its associated thread, which allows moving it to + * another thread (this is a fairly rare/advanced use case). + * + * 3. The reference count of an acquired thread state can be controlled. This + * can be handy to prevent cases where callbacks issued from an external + * thread would otherwise constantly construct and destroy thread state data + * structures. + * + * See the Python bindings of NanoGUI (http://github.com/wjakob/nanogui) for an + * example which uses features 2 and 3 to migrate the Python thread of + * execution to another thread (to run the event loop on the original thread, + * in this case). + */ + +class gil_scoped_acquire { +public: + PYBIND11_NOINLINE gil_scoped_acquire() { + auto const &internals = detail::get_internals(); + tstate = (PyThreadState *) PYBIND11_TLS_GET_VALUE(internals.tstate); + + if (!tstate) { + tstate = PyThreadState_New(internals.istate); + #if !defined(NDEBUG) + if (!tstate) + pybind11_fail("scoped_acquire: could not create thread state!"); + #endif + tstate->gilstate_counter = 0; + PYBIND11_TLS_REPLACE_VALUE(internals.tstate, tstate); + } else { + release = detail::get_thread_state_unchecked() != tstate; + } + + if (release) { + /* Work around an annoying assertion in PyThreadState_Swap */ + #if defined(Py_DEBUG) + PyInterpreterState *interp = tstate->interp; + tstate->interp = nullptr; + #endif + PyEval_AcquireThread(tstate); + #if defined(Py_DEBUG) + tstate->interp = interp; + #endif + } + + inc_ref(); + } + + void inc_ref() { + ++tstate->gilstate_counter; + } + + PYBIND11_NOINLINE void dec_ref() { + --tstate->gilstate_counter; + #if !defined(NDEBUG) + if (detail::get_thread_state_unchecked() != tstate) + pybind11_fail("scoped_acquire::dec_ref(): thread state must be current!"); + if (tstate->gilstate_counter < 0) + pybind11_fail("scoped_acquire::dec_ref(): reference count underflow!"); + #endif + if (tstate->gilstate_counter == 0) { + #if !defined(NDEBUG) + if (!release) + pybind11_fail("scoped_acquire::dec_ref(): internal error!"); + #endif + PyThreadState_Clear(tstate); + PyThreadState_DeleteCurrent(); + PYBIND11_TLS_DELETE_VALUE(detail::get_internals().tstate); + release = false; + } + } + + PYBIND11_NOINLINE ~gil_scoped_acquire() { + dec_ref(); + if (release) + PyEval_SaveThread(); + } +private: + PyThreadState *tstate = nullptr; + bool release = true; +}; + +class gil_scoped_release { +public: + explicit gil_scoped_release(bool disassoc = false) : disassoc(disassoc) { + // `get_internals()` must be called here unconditionally in order to initialize + // `internals.tstate` for subsequent `gil_scoped_acquire` calls. Otherwise, an + // initialization race could occur as multiple threads try `gil_scoped_acquire`. + const auto &internals = detail::get_internals(); + tstate = PyEval_SaveThread(); + if (disassoc) { + auto key = internals.tstate; + PYBIND11_TLS_DELETE_VALUE(key); + } + } + ~gil_scoped_release() { + if (!tstate) + return; + PyEval_RestoreThread(tstate); + if (disassoc) { + auto key = detail::get_internals().tstate; + PYBIND11_TLS_REPLACE_VALUE(key, tstate); + } + } +private: + PyThreadState *tstate; + bool disassoc; +}; +#elif defined(PYPY_VERSION) +class gil_scoped_acquire { + PyGILState_STATE state; +public: + gil_scoped_acquire() { state = PyGILState_Ensure(); } + ~gil_scoped_acquire() { PyGILState_Release(state); } +}; + +class gil_scoped_release { + PyThreadState *state; +public: + gil_scoped_release() { state = PyEval_SaveThread(); } + ~gil_scoped_release() { PyEval_RestoreThread(state); } +}; +#else +class gil_scoped_acquire { }; +class gil_scoped_release { }; +#endif + +error_already_set::~error_already_set() { + if (type) { + error_scope scope; + gil_scoped_acquire gil; + type.release().dec_ref(); + value.release().dec_ref(); + trace.release().dec_ref(); + } +} + +inline function get_type_overload(const void *this_ptr, const detail::type_info *this_type, const char *name) { + handle self = detail::get_object_handle(this_ptr, this_type); + if (!self) + return function(); + handle type = self.get_type(); + auto key = std::make_pair(type.ptr(), name); + + /* Cache functions that aren't overloaded in Python to avoid + many costly Python dictionary lookups below */ + auto &cache = detail::get_internals().inactive_overload_cache; + if (cache.find(key) != cache.end()) + return function(); + + function overload = getattr(self, name, function()); + if (overload.is_cpp_function()) { + cache.insert(key); + return function(); + } + + /* Don't call dispatch code if invoked from overridden function. + Unfortunately this doesn't work on PyPy. */ +#if !defined(PYPY_VERSION) + PyFrameObject *frame = PyThreadState_Get()->frame; + if (frame && (std::string) str(frame->f_code->co_name) == name && + frame->f_code->co_argcount > 0) { + PyFrame_FastToLocals(frame); + PyObject *self_caller = PyDict_GetItem( + frame->f_locals, PyTuple_GET_ITEM(frame->f_code->co_varnames, 0)); + if (self_caller == self.ptr()) + return function(); + } +#else + /* PyPy currently doesn't provide a detailed cpyext emulation of + frame objects, so we have to emulate this using Python. This + is going to be slow..*/ + dict d; d["self"] = self; d["name"] = pybind11::str(name); + PyObject *result = PyRun_String( + "import inspect\n" + "frame = inspect.currentframe()\n" + "if frame is not None:\n" + " frame = frame.f_back\n" + " if frame is not None and str(frame.f_code.co_name) == name and " + "frame.f_code.co_argcount > 0:\n" + " self_caller = frame.f_locals[frame.f_code.co_varnames[0]]\n" + " if self_caller == self:\n" + " self = None\n", + Py_file_input, d.ptr(), d.ptr()); + if (result == nullptr) + throw error_already_set(); + if (d["self"].is_none()) + return function(); + Py_DECREF(result); +#endif + + return overload; +} + +template function get_overload(const T *this_ptr, const char *name) { + auto tinfo = detail::get_type_info(typeid(T)); + return tinfo ? get_type_overload(this_ptr, tinfo, name) : function(); +} + +#define PYBIND11_OVERLOAD_INT(ret_type, cname, name, ...) { \ + pybind11::gil_scoped_acquire gil; \ + pybind11::function overload = pybind11::get_overload(static_cast(this), name); \ + if (overload) { \ + auto o = overload(__VA_ARGS__); \ + if (pybind11::detail::cast_is_temporary_value_reference::value) { \ + static pybind11::detail::overload_caster_t caster; \ + return pybind11::detail::cast_ref(std::move(o), caster); \ + } \ + else return pybind11::detail::cast_safe(std::move(o)); \ + } \ + } + +#define PYBIND11_OVERLOAD_NAME(ret_type, cname, name, fn, ...) \ + PYBIND11_OVERLOAD_INT(ret_type, cname, name, __VA_ARGS__) \ + return cname::fn(__VA_ARGS__) + +#define PYBIND11_OVERLOAD_PURE_NAME(ret_type, cname, name, fn, ...) \ + PYBIND11_OVERLOAD_INT(ret_type, cname, name, __VA_ARGS__) \ + pybind11::pybind11_fail("Tried to call pure virtual function \"" #cname "::" name "\""); + +#define PYBIND11_OVERLOAD(ret_type, cname, fn, ...) \ + PYBIND11_OVERLOAD_NAME(ret_type, cname, #fn, fn, __VA_ARGS__) + +#define PYBIND11_OVERLOAD_PURE(ret_type, cname, fn, ...) \ + PYBIND11_OVERLOAD_PURE_NAME(ret_type, cname, #fn, fn, __VA_ARGS__) + +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(_MSC_VER) +# pragma warning(pop) +#elif defined(__INTEL_COMPILER) +/* Leave ignored warnings on */ +#elif defined(__GNUG__) && !defined(__clang__) +# pragma GCC diagnostic pop +#endif diff --git a/plugins/python/pybind11/include/pybind11/pytypes.h b/plugins/python/pybind11/include/pybind11/pytypes.h new file mode 100644 index 0000000..d7fa177 --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/pytypes.h @@ -0,0 +1,1332 @@ +/* + pybind11/pytypes.h: Convenience wrapper classes for basic Python types + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "detail/common.h" +#include "buffer_info.h" +#include +#include + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) + +/* A few forward declarations */ +class handle; class object; +class str; class iterator; +struct arg; struct arg_v; + +NAMESPACE_BEGIN(detail) +class args_proxy; +inline bool isinstance_generic(handle obj, const std::type_info &tp); + +// Accessor forward declarations +template class accessor; +namespace accessor_policies { + struct obj_attr; + struct str_attr; + struct generic_item; + struct sequence_item; + struct list_item; + struct tuple_item; +} +using obj_attr_accessor = accessor; +using str_attr_accessor = accessor; +using item_accessor = accessor; +using sequence_accessor = accessor; +using list_accessor = accessor; +using tuple_accessor = accessor; + +/// Tag and check to identify a class which implements the Python object API +class pyobject_tag { }; +template using is_pyobject = std::is_base_of>; + +/** \rst + A mixin class which adds common functions to `handle`, `object` and various accessors. + The only requirement for `Derived` is to implement ``PyObject *Derived::ptr() const``. +\endrst */ +template +class object_api : public pyobject_tag { + const Derived &derived() const { return static_cast(*this); } + +public: + /** \rst + Return an iterator equivalent to calling ``iter()`` in Python. The object + must be a collection which supports the iteration protocol. + \endrst */ + iterator begin() const; + /// Return a sentinel which ends iteration. + iterator end() const; + + /** \rst + Return an internal functor to invoke the object's sequence protocol. Casting + the returned ``detail::item_accessor`` instance to a `handle` or `object` + subclass causes a corresponding call to ``__getitem__``. Assigning a `handle` + or `object` subclass causes a call to ``__setitem__``. + \endrst */ + item_accessor operator[](handle key) const; + /// See above (the only difference is that they key is provided as a string literal) + item_accessor operator[](const char *key) const; + + /** \rst + Return an internal functor to access the object's attributes. Casting the + returned ``detail::obj_attr_accessor`` instance to a `handle` or `object` + subclass causes a corresponding call to ``getattr``. Assigning a `handle` + or `object` subclass causes a call to ``setattr``. + \endrst */ + obj_attr_accessor attr(handle key) const; + /// See above (the only difference is that they key is provided as a string literal) + str_attr_accessor attr(const char *key) const; + + /** \rst + Matches * unpacking in Python, e.g. to unpack arguments out of a ``tuple`` + or ``list`` for a function call. Applying another * to the result yields + ** unpacking, e.g. to unpack a dict as function keyword arguments. + See :ref:`calling_python_functions`. + \endrst */ + args_proxy operator*() const; + + /// Check if the given item is contained within this object, i.e. ``item in obj``. + template bool contains(T &&item) const; + + /** \rst + Assuming the Python object is a function or implements the ``__call__`` + protocol, ``operator()`` invokes the underlying function, passing an + arbitrary set of parameters. The result is returned as a `object` and + may need to be converted back into a Python object using `handle::cast()`. + + When some of the arguments cannot be converted to Python objects, the + function will throw a `cast_error` exception. When the Python function + call fails, a `error_already_set` exception is thrown. + \endrst */ + template + object operator()(Args &&...args) const; + template + PYBIND11_DEPRECATED("call(...) was deprecated in favor of operator()(...)") + object call(Args&&... args) const; + + /// Equivalent to ``obj is other`` in Python. + bool is(object_api const& other) const { return derived().ptr() == other.derived().ptr(); } + /// Equivalent to ``obj is None`` in Python. + bool is_none() const { return derived().ptr() == Py_None; } + PYBIND11_DEPRECATED("Use py::str(obj) instead") + pybind11::str str() const; + + /// Get or set the object's docstring, i.e. ``obj.__doc__``. + str_attr_accessor doc() const; + + /// Return the object's current reference count + int ref_count() const { return static_cast(Py_REFCNT(derived().ptr())); } + /// Return a handle to the Python type object underlying the instance + handle get_type() const; +}; + +NAMESPACE_END(detail) + +/** \rst + Holds a reference to a Python object (no reference counting) + + The `handle` class is a thin wrapper around an arbitrary Python object (i.e. a + ``PyObject *`` in Python's C API). It does not perform any automatic reference + counting and merely provides a basic C++ interface to various Python API functions. + + .. seealso:: + The `object` class inherits from `handle` and adds automatic reference + counting features. +\endrst */ +class handle : public detail::object_api { +public: + /// The default constructor creates a handle with a ``nullptr``-valued pointer + handle() = default; + /// Creates a ``handle`` from the given raw Python object pointer + handle(PyObject *ptr) : m_ptr(ptr) { } // Allow implicit conversion from PyObject* + + /// Return the underlying ``PyObject *`` pointer + PyObject *ptr() const { return m_ptr; } + PyObject *&ptr() { return m_ptr; } + + /** \rst + Manually increase the reference count of the Python object. Usually, it is + preferable to use the `object` class which derives from `handle` and calls + this function automatically. Returns a reference to itself. + \endrst */ + const handle& inc_ref() const & { Py_XINCREF(m_ptr); return *this; } + + /** \rst + Manually decrease the reference count of the Python object. Usually, it is + preferable to use the `object` class which derives from `handle` and calls + this function automatically. Returns a reference to itself. + \endrst */ + const handle& dec_ref() const & { Py_XDECREF(m_ptr); return *this; } + + /** \rst + Attempt to cast the Python object into the given C++ type. A `cast_error` + will be throw upon failure. + \endrst */ + template T cast() const; + /// Return ``true`` when the `handle` wraps a valid Python object + explicit operator bool() const { return m_ptr != nullptr; } + /** \rst + Deprecated: Check that the underlying pointers are the same. + Equivalent to ``obj1 is obj2`` in Python. + \endrst */ + PYBIND11_DEPRECATED("Use obj1.is(obj2) instead") + bool operator==(const handle &h) const { return m_ptr == h.m_ptr; } + PYBIND11_DEPRECATED("Use !obj1.is(obj2) instead") + bool operator!=(const handle &h) const { return m_ptr != h.m_ptr; } + PYBIND11_DEPRECATED("Use handle::operator bool() instead") + bool check() const { return m_ptr != nullptr; } +protected: + PyObject *m_ptr = nullptr; +}; + +/** \rst + Holds a reference to a Python object (with reference counting) + + Like `handle`, the `object` class is a thin wrapper around an arbitrary Python + object (i.e. a ``PyObject *`` in Python's C API). In contrast to `handle`, it + optionally increases the object's reference count upon construction, and it + *always* decreases the reference count when the `object` instance goes out of + scope and is destructed. When using `object` instances consistently, it is much + easier to get reference counting right at the first attempt. +\endrst */ +class object : public handle { +public: + object() = default; + PYBIND11_DEPRECATED("Use reinterpret_borrow() or reinterpret_steal()") + object(handle h, bool is_borrowed) : handle(h) { if (is_borrowed) inc_ref(); } + /// Copy constructor; always increases the reference count + object(const object &o) : handle(o) { inc_ref(); } + /// Move constructor; steals the object from ``other`` and preserves its reference count + object(object &&other) noexcept { m_ptr = other.m_ptr; other.m_ptr = nullptr; } + /// Destructor; automatically calls `handle::dec_ref()` + ~object() { dec_ref(); } + + /** \rst + Resets the internal pointer to ``nullptr`` without without decreasing the + object's reference count. The function returns a raw handle to the original + Python object. + \endrst */ + handle release() { + PyObject *tmp = m_ptr; + m_ptr = nullptr; + return handle(tmp); + } + + object& operator=(const object &other) { + other.inc_ref(); + dec_ref(); + m_ptr = other.m_ptr; + return *this; + } + + object& operator=(object &&other) noexcept { + if (this != &other) { + handle temp(m_ptr); + m_ptr = other.m_ptr; + other.m_ptr = nullptr; + temp.dec_ref(); + } + return *this; + } + + // Calling cast() on an object lvalue just copies (via handle::cast) + template T cast() const &; + // Calling on an object rvalue does a move, if needed and/or possible + template T cast() &&; + +protected: + // Tags for choosing constructors from raw PyObject * + struct borrowed_t { }; + struct stolen_t { }; + + template friend T reinterpret_borrow(handle); + template friend T reinterpret_steal(handle); + +public: + // Only accessible from derived classes and the reinterpret_* functions + object(handle h, borrowed_t) : handle(h) { inc_ref(); } + object(handle h, stolen_t) : handle(h) { } +}; + +/** \rst + Declare that a `handle` or ``PyObject *`` is a certain type and borrow the reference. + The target type ``T`` must be `object` or one of its derived classes. The function + doesn't do any conversions or checks. It's up to the user to make sure that the + target type is correct. + + .. code-block:: cpp + + PyObject *p = PyList_GetItem(obj, index); + py::object o = reinterpret_borrow(p); + // or + py::tuple t = reinterpret_borrow(p); // <-- `p` must be already be a `tuple` +\endrst */ +template T reinterpret_borrow(handle h) { return {h, object::borrowed_t{}}; } + +/** \rst + Like `reinterpret_borrow`, but steals the reference. + + .. code-block:: cpp + + PyObject *p = PyObject_Str(obj); + py::str s = reinterpret_steal(p); // <-- `p` must be already be a `str` +\endrst */ +template T reinterpret_steal(handle h) { return {h, object::stolen_t{}}; } + +NAMESPACE_BEGIN(detail) +inline std::string error_string(); +NAMESPACE_END(detail) + +/// Fetch and hold an error which was already set in Python. An instance of this is typically +/// thrown to propagate python-side errors back through C++ which can either be caught manually or +/// else falls back to the function dispatcher (which then raises the captured error back to +/// python). +class error_already_set : public std::runtime_error { +public: + /// Constructs a new exception from the current Python error indicator, if any. The current + /// Python error indicator will be cleared. + error_already_set() : std::runtime_error(detail::error_string()) { + PyErr_Fetch(&type.ptr(), &value.ptr(), &trace.ptr()); + } + + inline ~error_already_set(); + + /// Give the currently-held error back to Python, if any. If there is currently a Python error + /// already set it is cleared first. After this call, the current object no longer stores the + /// error variables (but the `.what()` string is still available). + void restore() { PyErr_Restore(type.release().ptr(), value.release().ptr(), trace.release().ptr()); } + + // Does nothing; provided for backwards compatibility. + PYBIND11_DEPRECATED("Use of error_already_set.clear() is deprecated") + void clear() {} + + /// Check if the currently trapped error type matches the given Python exception class (or a + /// subclass thereof). May also be passed a tuple to search for any exception class matches in + /// the given tuple. + bool matches(handle ex) const { return PyErr_GivenExceptionMatches(ex.ptr(), type.ptr()); } + +private: + object type, value, trace; +}; + +/** \defgroup python_builtins _ + Unless stated otherwise, the following C++ functions behave the same + as their Python counterparts. + */ + +/** \ingroup python_builtins + \rst + Return true if ``obj`` is an instance of ``T``. Type ``T`` must be a subclass of + `object` or a class which was exposed to Python as ``py::class_``. +\endrst */ +template ::value, int> = 0> +bool isinstance(handle obj) { return T::check_(obj); } + +template ::value, int> = 0> +bool isinstance(handle obj) { return detail::isinstance_generic(obj, typeid(T)); } + +template <> inline bool isinstance(handle obj) = delete; +template <> inline bool isinstance(handle obj) { return obj.ptr() != nullptr; } + +/// \ingroup python_builtins +/// Return true if ``obj`` is an instance of the ``type``. +inline bool isinstance(handle obj, handle type) { + const auto result = PyObject_IsInstance(obj.ptr(), type.ptr()); + if (result == -1) + throw error_already_set(); + return result != 0; +} + +/// \addtogroup python_builtins +/// @{ +inline bool hasattr(handle obj, handle name) { + return PyObject_HasAttr(obj.ptr(), name.ptr()) == 1; +} + +inline bool hasattr(handle obj, const char *name) { + return PyObject_HasAttrString(obj.ptr(), name) == 1; +} + +inline object getattr(handle obj, handle name) { + PyObject *result = PyObject_GetAttr(obj.ptr(), name.ptr()); + if (!result) { throw error_already_set(); } + return reinterpret_steal(result); +} + +inline object getattr(handle obj, const char *name) { + PyObject *result = PyObject_GetAttrString(obj.ptr(), name); + if (!result) { throw error_already_set(); } + return reinterpret_steal(result); +} + +inline object getattr(handle obj, handle name, handle default_) { + if (PyObject *result = PyObject_GetAttr(obj.ptr(), name.ptr())) { + return reinterpret_steal(result); + } else { + PyErr_Clear(); + return reinterpret_borrow(default_); + } +} + +inline object getattr(handle obj, const char *name, handle default_) { + if (PyObject *result = PyObject_GetAttrString(obj.ptr(), name)) { + return reinterpret_steal(result); + } else { + PyErr_Clear(); + return reinterpret_borrow(default_); + } +} + +inline void setattr(handle obj, handle name, handle value) { + if (PyObject_SetAttr(obj.ptr(), name.ptr(), value.ptr()) != 0) { throw error_already_set(); } +} + +inline void setattr(handle obj, const char *name, handle value) { + if (PyObject_SetAttrString(obj.ptr(), name, value.ptr()) != 0) { throw error_already_set(); } +} + +inline ssize_t hash(handle obj) { + auto h = PyObject_Hash(obj.ptr()); + if (h == -1) { throw error_already_set(); } + return h; +} + +/// @} python_builtins + +NAMESPACE_BEGIN(detail) +inline handle get_function(handle value) { + if (value) { +#if PY_MAJOR_VERSION >= 3 + if (PyInstanceMethod_Check(value.ptr())) + value = PyInstanceMethod_GET_FUNCTION(value.ptr()); + else +#endif + if (PyMethod_Check(value.ptr())) + value = PyMethod_GET_FUNCTION(value.ptr()); + } + return value; +} + +// Helper aliases/functions to support implicit casting of values given to python accessors/methods. +// When given a pyobject, this simply returns the pyobject as-is; for other C++ type, the value goes +// through pybind11::cast(obj) to convert it to an `object`. +template ::value, int> = 0> +auto object_or_cast(T &&o) -> decltype(std::forward(o)) { return std::forward(o); } +// The following casting version is implemented in cast.h: +template ::value, int> = 0> +object object_or_cast(T &&o); +// Match a PyObject*, which we want to convert directly to handle via its converting constructor +inline handle object_or_cast(PyObject *ptr) { return ptr; } + + +template +class accessor : public object_api> { + using key_type = typename Policy::key_type; + +public: + accessor(handle obj, key_type key) : obj(obj), key(std::move(key)) { } + accessor(const accessor &) = default; + accessor(accessor &&) = default; + + // accessor overload required to override default assignment operator (templates are not allowed + // to replace default compiler-generated assignments). + void operator=(const accessor &a) && { std::move(*this).operator=(handle(a)); } + void operator=(const accessor &a) & { operator=(handle(a)); } + + template void operator=(T &&value) && { + Policy::set(obj, key, object_or_cast(std::forward(value))); + } + template void operator=(T &&value) & { + get_cache() = reinterpret_borrow(object_or_cast(std::forward(value))); + } + + template + PYBIND11_DEPRECATED("Use of obj.attr(...) as bool is deprecated in favor of pybind11::hasattr(obj, ...)") + explicit operator enable_if_t::value || + std::is_same::value, bool>() const { + return hasattr(obj, key); + } + template + PYBIND11_DEPRECATED("Use of obj[key] as bool is deprecated in favor of obj.contains(key)") + explicit operator enable_if_t::value, bool>() const { + return obj.contains(key); + } + + operator object() const { return get_cache(); } + PyObject *ptr() const { return get_cache().ptr(); } + template T cast() const { return get_cache().template cast(); } + +private: + object &get_cache() const { + if (!cache) { cache = Policy::get(obj, key); } + return cache; + } + +private: + handle obj; + key_type key; + mutable object cache; +}; + +NAMESPACE_BEGIN(accessor_policies) +struct obj_attr { + using key_type = object; + static object get(handle obj, handle key) { return getattr(obj, key); } + static void set(handle obj, handle key, handle val) { setattr(obj, key, val); } +}; + +struct str_attr { + using key_type = const char *; + static object get(handle obj, const char *key) { return getattr(obj, key); } + static void set(handle obj, const char *key, handle val) { setattr(obj, key, val); } +}; + +struct generic_item { + using key_type = object; + + static object get(handle obj, handle key) { + PyObject *result = PyObject_GetItem(obj.ptr(), key.ptr()); + if (!result) { throw error_already_set(); } + return reinterpret_steal(result); + } + + static void set(handle obj, handle key, handle val) { + if (PyObject_SetItem(obj.ptr(), key.ptr(), val.ptr()) != 0) { throw error_already_set(); } + } +}; + +struct sequence_item { + using key_type = size_t; + + static object get(handle obj, size_t index) { + PyObject *result = PySequence_GetItem(obj.ptr(), static_cast(index)); + if (!result) { throw error_already_set(); } + return reinterpret_steal(result); + } + + static void set(handle obj, size_t index, handle val) { + // PySequence_SetItem does not steal a reference to 'val' + if (PySequence_SetItem(obj.ptr(), static_cast(index), val.ptr()) != 0) { + throw error_already_set(); + } + } +}; + +struct list_item { + using key_type = size_t; + + static object get(handle obj, size_t index) { + PyObject *result = PyList_GetItem(obj.ptr(), static_cast(index)); + if (!result) { throw error_already_set(); } + return reinterpret_borrow(result); + } + + static void set(handle obj, size_t index, handle val) { + // PyList_SetItem steals a reference to 'val' + if (PyList_SetItem(obj.ptr(), static_cast(index), val.inc_ref().ptr()) != 0) { + throw error_already_set(); + } + } +}; + +struct tuple_item { + using key_type = size_t; + + static object get(handle obj, size_t index) { + PyObject *result = PyTuple_GetItem(obj.ptr(), static_cast(index)); + if (!result) { throw error_already_set(); } + return reinterpret_borrow(result); + } + + static void set(handle obj, size_t index, handle val) { + // PyTuple_SetItem steals a reference to 'val' + if (PyTuple_SetItem(obj.ptr(), static_cast(index), val.inc_ref().ptr()) != 0) { + throw error_already_set(); + } + } +}; +NAMESPACE_END(accessor_policies) + +/// STL iterator template used for tuple, list, sequence and dict +template +class generic_iterator : public Policy { + using It = generic_iterator; + +public: + using difference_type = ssize_t; + using iterator_category = typename Policy::iterator_category; + using value_type = typename Policy::value_type; + using reference = typename Policy::reference; + using pointer = typename Policy::pointer; + + generic_iterator() = default; + generic_iterator(handle seq, ssize_t index) : Policy(seq, index) { } + + reference operator*() const { return Policy::dereference(); } + reference operator[](difference_type n) const { return *(*this + n); } + pointer operator->() const { return **this; } + + It &operator++() { Policy::increment(); return *this; } + It operator++(int) { auto copy = *this; Policy::increment(); return copy; } + It &operator--() { Policy::decrement(); return *this; } + It operator--(int) { auto copy = *this; Policy::decrement(); return copy; } + It &operator+=(difference_type n) { Policy::advance(n); return *this; } + It &operator-=(difference_type n) { Policy::advance(-n); return *this; } + + friend It operator+(const It &a, difference_type n) { auto copy = a; return copy += n; } + friend It operator+(difference_type n, const It &b) { return b + n; } + friend It operator-(const It &a, difference_type n) { auto copy = a; return copy -= n; } + friend difference_type operator-(const It &a, const It &b) { return a.distance_to(b); } + + friend bool operator==(const It &a, const It &b) { return a.equal(b); } + friend bool operator!=(const It &a, const It &b) { return !(a == b); } + friend bool operator< (const It &a, const It &b) { return b - a > 0; } + friend bool operator> (const It &a, const It &b) { return b < a; } + friend bool operator>=(const It &a, const It &b) { return !(a < b); } + friend bool operator<=(const It &a, const It &b) { return !(a > b); } +}; + +NAMESPACE_BEGIN(iterator_policies) +/// Quick proxy class needed to implement ``operator->`` for iterators which can't return pointers +template +struct arrow_proxy { + T value; + + arrow_proxy(T &&value) : value(std::move(value)) { } + T *operator->() const { return &value; } +}; + +/// Lightweight iterator policy using just a simple pointer: see ``PySequence_Fast_ITEMS`` +class sequence_fast_readonly { +protected: + using iterator_category = std::random_access_iterator_tag; + using value_type = handle; + using reference = const handle; + using pointer = arrow_proxy; + + sequence_fast_readonly(handle obj, ssize_t n) : ptr(PySequence_Fast_ITEMS(obj.ptr()) + n) { } + + reference dereference() const { return *ptr; } + void increment() { ++ptr; } + void decrement() { --ptr; } + void advance(ssize_t n) { ptr += n; } + bool equal(const sequence_fast_readonly &b) const { return ptr == b.ptr; } + ssize_t distance_to(const sequence_fast_readonly &b) const { return ptr - b.ptr; } + +private: + PyObject **ptr; +}; + +/// Full read and write access using the sequence protocol: see ``detail::sequence_accessor`` +class sequence_slow_readwrite { +protected: + using iterator_category = std::random_access_iterator_tag; + using value_type = object; + using reference = sequence_accessor; + using pointer = arrow_proxy; + + sequence_slow_readwrite(handle obj, ssize_t index) : obj(obj), index(index) { } + + reference dereference() const { return {obj, static_cast(index)}; } + void increment() { ++index; } + void decrement() { --index; } + void advance(ssize_t n) { index += n; } + bool equal(const sequence_slow_readwrite &b) const { return index == b.index; } + ssize_t distance_to(const sequence_slow_readwrite &b) const { return index - b.index; } + +private: + handle obj; + ssize_t index; +}; + +/// Python's dictionary protocol permits this to be a forward iterator +class dict_readonly { +protected: + using iterator_category = std::forward_iterator_tag; + using value_type = std::pair; + using reference = const value_type; + using pointer = arrow_proxy; + + dict_readonly() = default; + dict_readonly(handle obj, ssize_t pos) : obj(obj), pos(pos) { increment(); } + + reference dereference() const { return {key, value}; } + void increment() { if (!PyDict_Next(obj.ptr(), &pos, &key, &value)) { pos = -1; } } + bool equal(const dict_readonly &b) const { return pos == b.pos; } + +private: + handle obj; + PyObject *key, *value; + ssize_t pos = -1; +}; +NAMESPACE_END(iterator_policies) + +#if !defined(PYPY_VERSION) +using tuple_iterator = generic_iterator; +using list_iterator = generic_iterator; +#else +using tuple_iterator = generic_iterator; +using list_iterator = generic_iterator; +#endif + +using sequence_iterator = generic_iterator; +using dict_iterator = generic_iterator; + +inline bool PyIterable_Check(PyObject *obj) { + PyObject *iter = PyObject_GetIter(obj); + if (iter) { + Py_DECREF(iter); + return true; + } else { + PyErr_Clear(); + return false; + } +} + +inline bool PyNone_Check(PyObject *o) { return o == Py_None; } + +inline bool PyUnicode_Check_Permissive(PyObject *o) { return PyUnicode_Check(o) || PYBIND11_BYTES_CHECK(o); } + +class kwargs_proxy : public handle { +public: + explicit kwargs_proxy(handle h) : handle(h) { } +}; + +class args_proxy : public handle { +public: + explicit args_proxy(handle h) : handle(h) { } + kwargs_proxy operator*() const { return kwargs_proxy(*this); } +}; + +/// Python argument categories (using PEP 448 terms) +template using is_keyword = std::is_base_of; +template using is_s_unpacking = std::is_same; // * unpacking +template using is_ds_unpacking = std::is_same; // ** unpacking +template using is_positional = satisfies_none_of; +template using is_keyword_or_ds = satisfies_any_of; + +// Call argument collector forward declarations +template +class simple_collector; +template +class unpacking_collector; + +NAMESPACE_END(detail) + +// TODO: After the deprecated constructors are removed, this macro can be simplified by +// inheriting ctors: `using Parent::Parent`. It's not an option right now because +// the `using` statement triggers the parent deprecation warning even if the ctor +// isn't even used. +#define PYBIND11_OBJECT_COMMON(Name, Parent, CheckFun) \ + public: \ + PYBIND11_DEPRECATED("Use reinterpret_borrow<"#Name">() or reinterpret_steal<"#Name">()") \ + Name(handle h, bool is_borrowed) : Parent(is_borrowed ? Parent(h, borrowed_t{}) : Parent(h, stolen_t{})) { } \ + Name(handle h, borrowed_t) : Parent(h, borrowed_t{}) { } \ + Name(handle h, stolen_t) : Parent(h, stolen_t{}) { } \ + PYBIND11_DEPRECATED("Use py::isinstance(obj) instead") \ + bool check() const { return m_ptr != nullptr && (bool) CheckFun(m_ptr); } \ + static bool check_(handle h) { return h.ptr() != nullptr && CheckFun(h.ptr()); } + +#define PYBIND11_OBJECT_CVT(Name, Parent, CheckFun, ConvertFun) \ + PYBIND11_OBJECT_COMMON(Name, Parent, CheckFun) \ + /* This is deliberately not 'explicit' to allow implicit conversion from object: */ \ + Name(const object &o) \ + : Parent(check_(o) ? o.inc_ref().ptr() : ConvertFun(o.ptr()), stolen_t{}) \ + { if (!m_ptr) throw error_already_set(); } \ + Name(object &&o) \ + : Parent(check_(o) ? o.release().ptr() : ConvertFun(o.ptr()), stolen_t{}) \ + { if (!m_ptr) throw error_already_set(); } \ + template \ + Name(const ::pybind11::detail::accessor &a) : Name(object(a)) { } + +#define PYBIND11_OBJECT(Name, Parent, CheckFun) \ + PYBIND11_OBJECT_COMMON(Name, Parent, CheckFun) \ + /* This is deliberately not 'explicit' to allow implicit conversion from object: */ \ + Name(const object &o) : Parent(o) { } \ + Name(object &&o) : Parent(std::move(o)) { } + +#define PYBIND11_OBJECT_DEFAULT(Name, Parent, CheckFun) \ + PYBIND11_OBJECT(Name, Parent, CheckFun) \ + Name() : Parent() { } + +/// \addtogroup pytypes +/// @{ + +/** \rst + Wraps a Python iterator so that it can also be used as a C++ input iterator + + Caveat: copying an iterator does not (and cannot) clone the internal + state of the Python iterable. This also applies to the post-increment + operator. This iterator should only be used to retrieve the current + value using ``operator*()``. +\endrst */ +class iterator : public object { +public: + using iterator_category = std::input_iterator_tag; + using difference_type = ssize_t; + using value_type = handle; + using reference = const handle; + using pointer = const handle *; + + PYBIND11_OBJECT_DEFAULT(iterator, object, PyIter_Check) + + iterator& operator++() { + advance(); + return *this; + } + + iterator operator++(int) { + auto rv = *this; + advance(); + return rv; + } + + reference operator*() const { + if (m_ptr && !value.ptr()) { + auto& self = const_cast(*this); + self.advance(); + } + return value; + } + + pointer operator->() const { operator*(); return &value; } + + /** \rst + The value which marks the end of the iteration. ``it == iterator::sentinel()`` + is equivalent to catching ``StopIteration`` in Python. + + .. code-block:: cpp + + void foo(py::iterator it) { + while (it != py::iterator::sentinel()) { + // use `*it` + ++it; + } + } + \endrst */ + static iterator sentinel() { return {}; } + + friend bool operator==(const iterator &a, const iterator &b) { return a->ptr() == b->ptr(); } + friend bool operator!=(const iterator &a, const iterator &b) { return a->ptr() != b->ptr(); } + +private: + void advance() { + value = reinterpret_steal(PyIter_Next(m_ptr)); + if (PyErr_Occurred()) { throw error_already_set(); } + } + +private: + object value = {}; +}; + +class iterable : public object { +public: + PYBIND11_OBJECT_DEFAULT(iterable, object, detail::PyIterable_Check) +}; + +class bytes; + +class str : public object { +public: + PYBIND11_OBJECT_CVT(str, object, detail::PyUnicode_Check_Permissive, raw_str) + + str(const char *c, size_t n) + : object(PyUnicode_FromStringAndSize(c, (ssize_t) n), stolen_t{}) { + if (!m_ptr) pybind11_fail("Could not allocate string object!"); + } + + // 'explicit' is explicitly omitted from the following constructors to allow implicit conversion to py::str from C++ string-like objects + str(const char *c = "") + : object(PyUnicode_FromString(c), stolen_t{}) { + if (!m_ptr) pybind11_fail("Could not allocate string object!"); + } + + str(const std::string &s) : str(s.data(), s.size()) { } + + explicit str(const bytes &b); + + /** \rst + Return a string representation of the object. This is analogous to + the ``str()`` function in Python. + \endrst */ + explicit str(handle h) : object(raw_str(h.ptr()), stolen_t{}) { } + + operator std::string() const { + object temp = *this; + if (PyUnicode_Check(m_ptr)) { + temp = reinterpret_steal(PyUnicode_AsUTF8String(m_ptr)); + if (!temp) + pybind11_fail("Unable to extract string contents! (encoding issue)"); + } + char *buffer; + ssize_t length; + if (PYBIND11_BYTES_AS_STRING_AND_SIZE(temp.ptr(), &buffer, &length)) + pybind11_fail("Unable to extract string contents! (invalid type)"); + return std::string(buffer, (size_t) length); + } + + template + str format(Args &&...args) const { + return attr("format")(std::forward(args)...); + } + +private: + /// Return string representation -- always returns a new reference, even if already a str + static PyObject *raw_str(PyObject *op) { + PyObject *str_value = PyObject_Str(op); +#if PY_MAJOR_VERSION < 3 + if (!str_value) throw error_already_set(); + PyObject *unicode = PyUnicode_FromEncodedObject(str_value, "utf-8", nullptr); + Py_XDECREF(str_value); str_value = unicode; +#endif + return str_value; + } +}; +/// @} pytypes + +inline namespace literals { +/** \rst + String literal version of `str` + \endrst */ +inline str operator"" _s(const char *s, size_t size) { return {s, size}; } +} + +/// \addtogroup pytypes +/// @{ +class bytes : public object { +public: + PYBIND11_OBJECT(bytes, object, PYBIND11_BYTES_CHECK) + + // Allow implicit conversion: + bytes(const char *c = "") + : object(PYBIND11_BYTES_FROM_STRING(c), stolen_t{}) { + if (!m_ptr) pybind11_fail("Could not allocate bytes object!"); + } + + bytes(const char *c, size_t n) + : object(PYBIND11_BYTES_FROM_STRING_AND_SIZE(c, (ssize_t) n), stolen_t{}) { + if (!m_ptr) pybind11_fail("Could not allocate bytes object!"); + } + + // Allow implicit conversion: + bytes(const std::string &s) : bytes(s.data(), s.size()) { } + + explicit bytes(const pybind11::str &s); + + operator std::string() const { + char *buffer; + ssize_t length; + if (PYBIND11_BYTES_AS_STRING_AND_SIZE(m_ptr, &buffer, &length)) + pybind11_fail("Unable to extract bytes contents!"); + return std::string(buffer, (size_t) length); + } +}; + +inline bytes::bytes(const pybind11::str &s) { + object temp = s; + if (PyUnicode_Check(s.ptr())) { + temp = reinterpret_steal(PyUnicode_AsUTF8String(s.ptr())); + if (!temp) + pybind11_fail("Unable to extract string contents! (encoding issue)"); + } + char *buffer; + ssize_t length; + if (PYBIND11_BYTES_AS_STRING_AND_SIZE(temp.ptr(), &buffer, &length)) + pybind11_fail("Unable to extract string contents! (invalid type)"); + auto obj = reinterpret_steal(PYBIND11_BYTES_FROM_STRING_AND_SIZE(buffer, length)); + if (!obj) + pybind11_fail("Could not allocate bytes object!"); + m_ptr = obj.release().ptr(); +} + +inline str::str(const bytes& b) { + char *buffer; + ssize_t length; + if (PYBIND11_BYTES_AS_STRING_AND_SIZE(b.ptr(), &buffer, &length)) + pybind11_fail("Unable to extract bytes contents!"); + auto obj = reinterpret_steal(PyUnicode_FromStringAndSize(buffer, (ssize_t) length)); + if (!obj) + pybind11_fail("Could not allocate string object!"); + m_ptr = obj.release().ptr(); +} + +class none : public object { +public: + PYBIND11_OBJECT(none, object, detail::PyNone_Check) + none() : object(Py_None, borrowed_t{}) { } +}; + +class bool_ : public object { +public: + PYBIND11_OBJECT_CVT(bool_, object, PyBool_Check, raw_bool) + bool_() : object(Py_False, borrowed_t{}) { } + // Allow implicit conversion from and to `bool`: + bool_(bool value) : object(value ? Py_True : Py_False, borrowed_t{}) { } + operator bool() const { return m_ptr && PyLong_AsLong(m_ptr) != 0; } + +private: + /// Return the truth value of an object -- always returns a new reference + static PyObject *raw_bool(PyObject *op) { + const auto value = PyObject_IsTrue(op); + if (value == -1) return nullptr; + return handle(value ? Py_True : Py_False).inc_ref().ptr(); + } +}; + +NAMESPACE_BEGIN(detail) +// Converts a value to the given unsigned type. If an error occurs, you get back (Unsigned) -1; +// otherwise you get back the unsigned long or unsigned long long value cast to (Unsigned). +// (The distinction is critically important when casting a returned -1 error value to some other +// unsigned type: (A)-1 != (B)-1 when A and B are unsigned types of different sizes). +template +Unsigned as_unsigned(PyObject *o) { + if (sizeof(Unsigned) <= sizeof(unsigned long) +#if PY_VERSION_HEX < 0x03000000 + || PyInt_Check(o) +#endif + ) { + unsigned long v = PyLong_AsUnsignedLong(o); + return v == (unsigned long) -1 && PyErr_Occurred() ? (Unsigned) -1 : (Unsigned) v; + } + else { + unsigned long long v = PyLong_AsUnsignedLongLong(o); + return v == (unsigned long long) -1 && PyErr_Occurred() ? (Unsigned) -1 : (Unsigned) v; + } +} +NAMESPACE_END(detail) + +class int_ : public object { +public: + PYBIND11_OBJECT_CVT(int_, object, PYBIND11_LONG_CHECK, PyNumber_Long) + int_() : object(PyLong_FromLong(0), stolen_t{}) { } + // Allow implicit conversion from C++ integral types: + template ::value, int> = 0> + int_(T value) { + if (sizeof(T) <= sizeof(long)) { + if (std::is_signed::value) + m_ptr = PyLong_FromLong((long) value); + else + m_ptr = PyLong_FromUnsignedLong((unsigned long) value); + } else { + if (std::is_signed::value) + m_ptr = PyLong_FromLongLong((long long) value); + else + m_ptr = PyLong_FromUnsignedLongLong((unsigned long long) value); + } + if (!m_ptr) pybind11_fail("Could not allocate int object!"); + } + + template ::value, int> = 0> + operator T() const { + return std::is_unsigned::value + ? detail::as_unsigned(m_ptr) + : sizeof(T) <= sizeof(long) + ? (T) PyLong_AsLong(m_ptr) + : (T) PYBIND11_LONG_AS_LONGLONG(m_ptr); + } +}; + +class float_ : public object { +public: + PYBIND11_OBJECT_CVT(float_, object, PyFloat_Check, PyNumber_Float) + // Allow implicit conversion from float/double: + float_(float value) : object(PyFloat_FromDouble((double) value), stolen_t{}) { + if (!m_ptr) pybind11_fail("Could not allocate float object!"); + } + float_(double value = .0) : object(PyFloat_FromDouble((double) value), stolen_t{}) { + if (!m_ptr) pybind11_fail("Could not allocate float object!"); + } + operator float() const { return (float) PyFloat_AsDouble(m_ptr); } + operator double() const { return (double) PyFloat_AsDouble(m_ptr); } +}; + +class weakref : public object { +public: + PYBIND11_OBJECT_DEFAULT(weakref, object, PyWeakref_Check) + explicit weakref(handle obj, handle callback = {}) + : object(PyWeakref_NewRef(obj.ptr(), callback.ptr()), stolen_t{}) { + if (!m_ptr) pybind11_fail("Could not allocate weak reference!"); + } +}; + +class slice : public object { +public: + PYBIND11_OBJECT_DEFAULT(slice, object, PySlice_Check) + slice(ssize_t start_, ssize_t stop_, ssize_t step_) { + int_ start(start_), stop(stop_), step(step_); + m_ptr = PySlice_New(start.ptr(), stop.ptr(), step.ptr()); + if (!m_ptr) pybind11_fail("Could not allocate slice object!"); + } + bool compute(size_t length, size_t *start, size_t *stop, size_t *step, + size_t *slicelength) const { + return PySlice_GetIndicesEx((PYBIND11_SLICE_OBJECT *) m_ptr, + (ssize_t) length, (ssize_t *) start, + (ssize_t *) stop, (ssize_t *) step, + (ssize_t *) slicelength) == 0; + } +}; + +class capsule : public object { +public: + PYBIND11_OBJECT_DEFAULT(capsule, object, PyCapsule_CheckExact) + PYBIND11_DEPRECATED("Use reinterpret_borrow() or reinterpret_steal()") + capsule(PyObject *ptr, bool is_borrowed) : object(is_borrowed ? object(ptr, borrowed_t{}) : object(ptr, stolen_t{})) { } + + explicit capsule(const void *value, const char *name = nullptr, void (*destructor)(PyObject *) = nullptr) + : object(PyCapsule_New(const_cast(value), name, destructor), stolen_t{}) { + if (!m_ptr) + pybind11_fail("Could not allocate capsule object!"); + } + + PYBIND11_DEPRECATED("Please pass a destructor that takes a void pointer as input") + capsule(const void *value, void (*destruct)(PyObject *)) + : object(PyCapsule_New(const_cast(value), nullptr, destruct), stolen_t{}) { + if (!m_ptr) + pybind11_fail("Could not allocate capsule object!"); + } + + capsule(const void *value, void (*destructor)(void *)) { + m_ptr = PyCapsule_New(const_cast(value), nullptr, [](PyObject *o) { + auto destructor = reinterpret_cast(PyCapsule_GetContext(o)); + void *ptr = PyCapsule_GetPointer(o, nullptr); + destructor(ptr); + }); + + if (!m_ptr) + pybind11_fail("Could not allocate capsule object!"); + + if (PyCapsule_SetContext(m_ptr, (void *) destructor) != 0) + pybind11_fail("Could not set capsule context!"); + } + + capsule(void (*destructor)()) { + m_ptr = PyCapsule_New(reinterpret_cast(destructor), nullptr, [](PyObject *o) { + auto destructor = reinterpret_cast(PyCapsule_GetPointer(o, nullptr)); + destructor(); + }); + + if (!m_ptr) + pybind11_fail("Could not allocate capsule object!"); + } + + template operator T *() const { + auto name = this->name(); + T * result = static_cast(PyCapsule_GetPointer(m_ptr, name)); + if (!result) pybind11_fail("Unable to extract capsule contents!"); + return result; + } + + const char *name() const { return PyCapsule_GetName(m_ptr); } +}; + +class tuple : public object { +public: + PYBIND11_OBJECT_CVT(tuple, object, PyTuple_Check, PySequence_Tuple) + explicit tuple(size_t size = 0) : object(PyTuple_New((ssize_t) size), stolen_t{}) { + if (!m_ptr) pybind11_fail("Could not allocate tuple object!"); + } + size_t size() const { return (size_t) PyTuple_Size(m_ptr); } + detail::tuple_accessor operator[](size_t index) const { return {*this, index}; } + detail::tuple_iterator begin() const { return {*this, 0}; } + detail::tuple_iterator end() const { return {*this, PyTuple_GET_SIZE(m_ptr)}; } +}; + +class dict : public object { +public: + PYBIND11_OBJECT_CVT(dict, object, PyDict_Check, raw_dict) + dict() : object(PyDict_New(), stolen_t{}) { + if (!m_ptr) pybind11_fail("Could not allocate dict object!"); + } + template ...>::value>, + // MSVC workaround: it can't compile an out-of-line definition, so defer the collector + typename collector = detail::deferred_t, Args...>> + explicit dict(Args &&...args) : dict(collector(std::forward(args)...).kwargs()) { } + + size_t size() const { return (size_t) PyDict_Size(m_ptr); } + detail::dict_iterator begin() const { return {*this, 0}; } + detail::dict_iterator end() const { return {}; } + void clear() const { PyDict_Clear(ptr()); } + bool contains(handle key) const { return PyDict_Contains(ptr(), key.ptr()) == 1; } + bool contains(const char *key) const { return PyDict_Contains(ptr(), pybind11::str(key).ptr()) == 1; } + +private: + /// Call the `dict` Python type -- always returns a new reference + static PyObject *raw_dict(PyObject *op) { + if (PyDict_Check(op)) + return handle(op).inc_ref().ptr(); + return PyObject_CallFunctionObjArgs((PyObject *) &PyDict_Type, op, nullptr); + } +}; + +class sequence : public object { +public: + PYBIND11_OBJECT_DEFAULT(sequence, object, PySequence_Check) + size_t size() const { return (size_t) PySequence_Size(m_ptr); } + detail::sequence_accessor operator[](size_t index) const { return {*this, index}; } + detail::sequence_iterator begin() const { return {*this, 0}; } + detail::sequence_iterator end() const { return {*this, PySequence_Size(m_ptr)}; } +}; + +class list : public object { +public: + PYBIND11_OBJECT_CVT(list, object, PyList_Check, PySequence_List) + explicit list(size_t size = 0) : object(PyList_New((ssize_t) size), stolen_t{}) { + if (!m_ptr) pybind11_fail("Could not allocate list object!"); + } + size_t size() const { return (size_t) PyList_Size(m_ptr); } + detail::list_accessor operator[](size_t index) const { return {*this, index}; } + detail::list_iterator begin() const { return {*this, 0}; } + detail::list_iterator end() const { return {*this, PyList_GET_SIZE(m_ptr)}; } + template void append(T &&val) const { + PyList_Append(m_ptr, detail::object_or_cast(std::forward(val)).ptr()); + } +}; + +class args : public tuple { PYBIND11_OBJECT_DEFAULT(args, tuple, PyTuple_Check) }; +class kwargs : public dict { PYBIND11_OBJECT_DEFAULT(kwargs, dict, PyDict_Check) }; + +class set : public object { +public: + PYBIND11_OBJECT_CVT(set, object, PySet_Check, PySet_New) + set() : object(PySet_New(nullptr), stolen_t{}) { + if (!m_ptr) pybind11_fail("Could not allocate set object!"); + } + size_t size() const { return (size_t) PySet_Size(m_ptr); } + template bool add(T &&val) const { + return PySet_Add(m_ptr, detail::object_or_cast(std::forward(val)).ptr()) == 0; + } + void clear() const { PySet_Clear(m_ptr); } +}; + +class function : public object { +public: + PYBIND11_OBJECT_DEFAULT(function, object, PyCallable_Check) + handle cpp_function() const { + handle fun = detail::get_function(m_ptr); + if (fun && PyCFunction_Check(fun.ptr())) + return fun; + return handle(); + } + bool is_cpp_function() const { return (bool) cpp_function(); } +}; + +class buffer : public object { +public: + PYBIND11_OBJECT_DEFAULT(buffer, object, PyObject_CheckBuffer) + + buffer_info request(bool writable = false) { + int flags = PyBUF_STRIDES | PyBUF_FORMAT; + if (writable) flags |= PyBUF_WRITABLE; + Py_buffer *view = new Py_buffer(); + if (PyObject_GetBuffer(m_ptr, view, flags) != 0) { + delete view; + throw error_already_set(); + } + return buffer_info(view); + } +}; + +class memoryview : public object { +public: + explicit memoryview(const buffer_info& info) { + static Py_buffer buf { }; + // Py_buffer uses signed sizes, strides and shape!.. + static std::vector py_strides { }; + static std::vector py_shape { }; + buf.buf = info.ptr; + buf.itemsize = info.itemsize; + buf.format = const_cast(info.format.c_str()); + buf.ndim = (int) info.ndim; + buf.len = info.size; + py_strides.clear(); + py_shape.clear(); + for (size_t i = 0; i < (size_t) info.ndim; ++i) { + py_strides.push_back(info.strides[i]); + py_shape.push_back(info.shape[i]); + } + buf.strides = py_strides.data(); + buf.shape = py_shape.data(); + buf.suboffsets = nullptr; + buf.readonly = false; + buf.internal = nullptr; + + m_ptr = PyMemoryView_FromBuffer(&buf); + if (!m_ptr) + pybind11_fail("Unable to create memoryview from buffer descriptor"); + } + + PYBIND11_OBJECT_CVT(memoryview, object, PyMemoryView_Check, PyMemoryView_FromObject) +}; +/// @} pytypes + +/// \addtogroup python_builtins +/// @{ +inline size_t len(handle h) { + ssize_t result = PyObject_Length(h.ptr()); + if (result < 0) + pybind11_fail("Unable to compute length of object"); + return (size_t) result; +} + +inline str repr(handle h) { + PyObject *str_value = PyObject_Repr(h.ptr()); + if (!str_value) throw error_already_set(); +#if PY_MAJOR_VERSION < 3 + PyObject *unicode = PyUnicode_FromEncodedObject(str_value, "utf-8", nullptr); + Py_XDECREF(str_value); str_value = unicode; + if (!str_value) throw error_already_set(); +#endif + return reinterpret_steal(str_value); +} + +inline iterator iter(handle obj) { + PyObject *result = PyObject_GetIter(obj.ptr()); + if (!result) { throw error_already_set(); } + return reinterpret_steal(result); +} +/// @} python_builtins + +NAMESPACE_BEGIN(detail) +template iterator object_api::begin() const { return iter(derived()); } +template iterator object_api::end() const { return iterator::sentinel(); } +template item_accessor object_api::operator[](handle key) const { + return {derived(), reinterpret_borrow(key)}; +} +template item_accessor object_api::operator[](const char *key) const { + return {derived(), pybind11::str(key)}; +} +template obj_attr_accessor object_api::attr(handle key) const { + return {derived(), reinterpret_borrow(key)}; +} +template str_attr_accessor object_api::attr(const char *key) const { + return {derived(), key}; +} +template args_proxy object_api::operator*() const { + return args_proxy(derived().ptr()); +} +template template bool object_api::contains(T &&item) const { + return attr("__contains__")(std::forward(item)).template cast(); +} + +template +pybind11::str object_api::str() const { return pybind11::str(derived()); } + +template +str_attr_accessor object_api::doc() const { return attr("__doc__"); } + +template +handle object_api::get_type() const { return (PyObject *) Py_TYPE(derived().ptr()); } + +NAMESPACE_END(detail) +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/include/pybind11/stl.h b/plugins/python/pybind11/include/pybind11/stl.h new file mode 100644 index 0000000..1a4bbf0 --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/stl.h @@ -0,0 +1,376 @@ +/* + pybind11/stl.h: Transparent conversion for STL data types + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "pybind11.h" +#include +#include +#include +#include +#include +#include +#include + +#if defined(_MSC_VER) +#pragma warning(push) +#pragma warning(disable: 4127) // warning C4127: Conditional expression is constant +#endif + +#ifdef __has_include +// std::optional (but including it in c++14 mode isn't allowed) +# if defined(PYBIND11_CPP17) && __has_include() +# include +# define PYBIND11_HAS_OPTIONAL 1 +# endif +// std::experimental::optional (but not allowed in c++11 mode) +# if defined(PYBIND11_CPP14) && (__has_include() && \ + !__has_include()) +# include +# define PYBIND11_HAS_EXP_OPTIONAL 1 +# endif +// std::variant +# if defined(PYBIND11_CPP17) && __has_include() +# include +# define PYBIND11_HAS_VARIANT 1 +# endif +#elif defined(_MSC_VER) && defined(PYBIND11_CPP17) +# include +# include +# define PYBIND11_HAS_OPTIONAL 1 +# define PYBIND11_HAS_VARIANT 1 +#endif + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/// Extracts an const lvalue reference or rvalue reference for U based on the type of T (e.g. for +/// forwarding a container element). Typically used indirect via forwarded_type(), below. +template +using forwarded_type = conditional_t< + std::is_lvalue_reference::value, remove_reference_t &, remove_reference_t &&>; + +/// Forwards a value U as rvalue or lvalue according to whether T is rvalue or lvalue; typically +/// used for forwarding a container's elements. +template +forwarded_type forward_like(U &&u) { + return std::forward>(std::forward(u)); +} + +template struct set_caster { + using type = Type; + using key_conv = make_caster; + + bool load(handle src, bool convert) { + if (!isinstance(src)) + return false; + auto s = reinterpret_borrow(src); + value.clear(); + for (auto entry : s) { + key_conv conv; + if (!conv.load(entry, convert)) + return false; + value.insert(cast_op(std::move(conv))); + } + return true; + } + + template + static handle cast(T &&src, return_value_policy policy, handle parent) { + policy = return_value_policy_override::policy(policy); + pybind11::set s; + for (auto &&value : src) { + auto value_ = reinterpret_steal(key_conv::cast(forward_like(value), policy, parent)); + if (!value_ || !s.add(value_)) + return handle(); + } + return s.release(); + } + + PYBIND11_TYPE_CASTER(type, _("Set[") + key_conv::name() + _("]")); +}; + +template struct map_caster { + using key_conv = make_caster; + using value_conv = make_caster; + + bool load(handle src, bool convert) { + if (!isinstance(src)) + return false; + auto d = reinterpret_borrow(src); + value.clear(); + for (auto it : d) { + key_conv kconv; + value_conv vconv; + if (!kconv.load(it.first.ptr(), convert) || + !vconv.load(it.second.ptr(), convert)) + return false; + value.emplace(cast_op(std::move(kconv)), cast_op(std::move(vconv))); + } + return true; + } + + template + static handle cast(T &&src, return_value_policy policy, handle parent) { + dict d; + return_value_policy policy_key = return_value_policy_override::policy(policy); + return_value_policy policy_value = return_value_policy_override::policy(policy); + for (auto &&kv : src) { + auto key = reinterpret_steal(key_conv::cast(forward_like(kv.first), policy_key, parent)); + auto value = reinterpret_steal(value_conv::cast(forward_like(kv.second), policy_value, parent)); + if (!key || !value) + return handle(); + d[key] = value; + } + return d.release(); + } + + PYBIND11_TYPE_CASTER(Type, _("Dict[") + key_conv::name() + _(", ") + value_conv::name() + _("]")); +}; + +template struct list_caster { + using value_conv = make_caster; + + bool load(handle src, bool convert) { + if (!isinstance(src)) + return false; + auto s = reinterpret_borrow(src); + value.clear(); + reserve_maybe(s, &value); + for (auto it : s) { + value_conv conv; + if (!conv.load(it, convert)) + return false; + value.push_back(cast_op(std::move(conv))); + } + return true; + } + +private: + template ().reserve(0)), void>::value, int> = 0> + void reserve_maybe(sequence s, Type *) { value.reserve(s.size()); } + void reserve_maybe(sequence, void *) { } + +public: + template + static handle cast(T &&src, return_value_policy policy, handle parent) { + policy = return_value_policy_override::policy(policy); + list l(src.size()); + size_t index = 0; + for (auto &&value : src) { + auto value_ = reinterpret_steal(value_conv::cast(forward_like(value), policy, parent)); + if (!value_) + return handle(); + PyList_SET_ITEM(l.ptr(), (ssize_t) index++, value_.release().ptr()); // steals a reference + } + return l.release(); + } + + PYBIND11_TYPE_CASTER(Type, _("List[") + value_conv::name() + _("]")); +}; + +template struct type_caster> + : list_caster, Type> { }; + +template struct type_caster> + : list_caster, Type> { }; + +template struct array_caster { + using value_conv = make_caster; + +private: + template + bool require_size(enable_if_t size) { + if (value.size() != size) + value.resize(size); + return true; + } + template + bool require_size(enable_if_t size) { + return size == Size; + } + +public: + bool load(handle src, bool convert) { + if (!isinstance(src)) + return false; + auto l = reinterpret_borrow(src); + if (!require_size(l.size())) + return false; + size_t ctr = 0; + for (auto it : l) { + value_conv conv; + if (!conv.load(it, convert)) + return false; + value[ctr++] = cast_op(std::move(conv)); + } + return true; + } + + template + static handle cast(T &&src, return_value_policy policy, handle parent) { + list l(src.size()); + size_t index = 0; + for (auto &&value : src) { + auto value_ = reinterpret_steal(value_conv::cast(forward_like(value), policy, parent)); + if (!value_) + return handle(); + PyList_SET_ITEM(l.ptr(), (ssize_t) index++, value_.release().ptr()); // steals a reference + } + return l.release(); + } + + PYBIND11_TYPE_CASTER(ArrayType, _("List[") + value_conv::name() + _(_(""), _("[") + _() + _("]")) + _("]")); +}; + +template struct type_caster> + : array_caster, Type, false, Size> { }; + +template struct type_caster> + : array_caster, Type, true> { }; + +template struct type_caster> + : set_caster, Key> { }; + +template struct type_caster> + : set_caster, Key> { }; + +template struct type_caster> + : map_caster, Key, Value> { }; + +template struct type_caster> + : map_caster, Key, Value> { }; + +// This type caster is intended to be used for std::optional and std::experimental::optional +template struct optional_caster { + using value_conv = make_caster; + + template + static handle cast(T_ &&src, return_value_policy policy, handle parent) { + if (!src) + return none().inc_ref(); + policy = return_value_policy_override::policy(policy); + return value_conv::cast(*std::forward(src), policy, parent); + } + + bool load(handle src, bool convert) { + if (!src) { + return false; + } else if (src.is_none()) { + return true; // default-constructed value is already empty + } + value_conv inner_caster; + if (!inner_caster.load(src, convert)) + return false; + + value.emplace(cast_op(std::move(inner_caster))); + return true; + } + + PYBIND11_TYPE_CASTER(T, _("Optional[") + value_conv::name() + _("]")); +}; + +#if PYBIND11_HAS_OPTIONAL +template struct type_caster> + : public optional_caster> {}; + +template<> struct type_caster + : public void_caster {}; +#endif + +#if PYBIND11_HAS_EXP_OPTIONAL +template struct type_caster> + : public optional_caster> {}; + +template<> struct type_caster + : public void_caster {}; +#endif + +/// Visit a variant and cast any found type to Python +struct variant_caster_visitor { + return_value_policy policy; + handle parent; + + using result_type = handle; // required by boost::variant in C++11 + + template + result_type operator()(T &&src) const { + return make_caster::cast(std::forward(src), policy, parent); + } +}; + +/// Helper class which abstracts away variant's `visit` function. `std::variant` and similar +/// `namespace::variant` types which provide a `namespace::visit()` function are handled here +/// automatically using argument-dependent lookup. Users can provide specializations for other +/// variant-like classes, e.g. `boost::variant` and `boost::apply_visitor`. +template class Variant> +struct visit_helper { + template + static auto call(Args &&...args) -> decltype(visit(std::forward(args)...)) { + return visit(std::forward(args)...); + } +}; + +/// Generic variant caster +template struct variant_caster; + +template class V, typename... Ts> +struct variant_caster> { + static_assert(sizeof...(Ts) > 0, "Variant must consist of at least one alternative."); + + template + bool load_alternative(handle src, bool convert, type_list) { + auto caster = make_caster(); + if (caster.load(src, convert)) { + value = cast_op(caster); + return true; + } + return load_alternative(src, convert, type_list{}); + } + + bool load_alternative(handle, bool, type_list<>) { return false; } + + bool load(handle src, bool convert) { + // Do a first pass without conversions to improve constructor resolution. + // E.g. `py::int_(1).cast>()` needs to fill the `int` + // slot of the variant. Without two-pass loading `double` would be filled + // because it appears first and a conversion is possible. + if (convert && load_alternative(src, false, type_list{})) + return true; + return load_alternative(src, convert, type_list{}); + } + + template + static handle cast(Variant &&src, return_value_policy policy, handle parent) { + return visit_helper::call(variant_caster_visitor{policy, parent}, + std::forward(src)); + } + + using Type = V; + PYBIND11_TYPE_CASTER(Type, _("Union[") + detail::concat(make_caster::name()...) + _("]")); +}; + +#if PYBIND11_HAS_VARIANT +template +struct type_caster> : variant_caster> { }; +#endif + +NAMESPACE_END(detail) + +inline std::ostream &operator<<(std::ostream &os, const handle &obj) { + os << (std::string) str(obj); + return os; +} + +NAMESPACE_END(PYBIND11_NAMESPACE) + +#if defined(_MSC_VER) +#pragma warning(pop) +#endif diff --git a/plugins/python/pybind11/include/pybind11/stl_bind.h b/plugins/python/pybind11/include/pybind11/stl_bind.h new file mode 100644 index 0000000..38dd68f --- /dev/null +++ b/plugins/python/pybind11/include/pybind11/stl_bind.h @@ -0,0 +1,599 @@ +/* + pybind11/std_bind.h: Binding generators for STL data types + + Copyright (c) 2016 Sergey Lyskov and Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#pragma once + +#include "detail/common.h" +#include "operators.h" + +#include +#include + +NAMESPACE_BEGIN(PYBIND11_NAMESPACE) +NAMESPACE_BEGIN(detail) + +/* SFINAE helper class used by 'is_comparable */ +template struct container_traits { + template static std::true_type test_comparable(decltype(std::declval() == std::declval())*); + template static std::false_type test_comparable(...); + template static std::true_type test_value(typename T2::value_type *); + template static std::false_type test_value(...); + template static std::true_type test_pair(typename T2::first_type *, typename T2::second_type *); + template static std::false_type test_pair(...); + + static constexpr const bool is_comparable = std::is_same(nullptr))>::value; + static constexpr const bool is_pair = std::is_same(nullptr, nullptr))>::value; + static constexpr const bool is_vector = std::is_same(nullptr))>::value; + static constexpr const bool is_element = !is_pair && !is_vector; +}; + +/* Default: is_comparable -> std::false_type */ +template +struct is_comparable : std::false_type { }; + +/* For non-map data structures, check whether operator== can be instantiated */ +template +struct is_comparable< + T, enable_if_t::is_element && + container_traits::is_comparable>> + : std::true_type { }; + +/* For a vector/map data structure, recursively check the value type (which is std::pair for maps) */ +template +struct is_comparable::is_vector>> { + static constexpr const bool value = + is_comparable::value; +}; + +/* For pairs, recursively check the two data types */ +template +struct is_comparable::is_pair>> { + static constexpr const bool value = + is_comparable::value && + is_comparable::value; +}; + +/* Fallback functions */ +template void vector_if_copy_constructible(const Args &...) { } +template void vector_if_equal_operator(const Args &...) { } +template void vector_if_insertion_operator(const Args &...) { } +template void vector_modifiers(const Args &...) { } + +template +void vector_if_copy_constructible(enable_if_t::value, Class_> &cl) { + cl.def(init(), "Copy constructor"); +} + +template +void vector_if_equal_operator(enable_if_t::value, Class_> &cl) { + using T = typename Vector::value_type; + + cl.def(self == self); + cl.def(self != self); + + cl.def("count", + [](const Vector &v, const T &x) { + return std::count(v.begin(), v.end(), x); + }, + arg("x"), + "Return the number of times ``x`` appears in the list" + ); + + cl.def("remove", [](Vector &v, const T &x) { + auto p = std::find(v.begin(), v.end(), x); + if (p != v.end()) + v.erase(p); + else + throw value_error(); + }, + arg("x"), + "Remove the first item from the list whose value is x. " + "It is an error if there is no such item." + ); + + cl.def("__contains__", + [](const Vector &v, const T &x) { + return std::find(v.begin(), v.end(), x) != v.end(); + }, + arg("x"), + "Return true the container contains ``x``" + ); +} + +// Vector modifiers -- requires a copyable vector_type: +// (Technically, some of these (pop and __delitem__) don't actually require copyability, but it seems +// silly to allow deletion but not insertion, so include them here too.) +template +void vector_modifiers(enable_if_t::value, Class_> &cl) { + using T = typename Vector::value_type; + using SizeType = typename Vector::size_type; + using DiffType = typename Vector::difference_type; + + cl.def("append", + [](Vector &v, const T &value) { v.push_back(value); }, + arg("x"), + "Add an item to the end of the list"); + + cl.def(init([](iterable it) { + auto v = std::unique_ptr(new Vector()); + v->reserve(len(it)); + for (handle h : it) + v->push_back(h.cast()); + return v.release(); + })); + + cl.def("extend", + [](Vector &v, const Vector &src) { + v.insert(v.end(), src.begin(), src.end()); + }, + arg("L"), + "Extend the list by appending all the items in the given list" + ); + + cl.def("insert", + [](Vector &v, SizeType i, const T &x) { + if (i > v.size()) + throw index_error(); + v.insert(v.begin() + (DiffType) i, x); + }, + arg("i") , arg("x"), + "Insert an item at a given position." + ); + + cl.def("pop", + [](Vector &v) { + if (v.empty()) + throw index_error(); + T t = v.back(); + v.pop_back(); + return t; + }, + "Remove and return the last item" + ); + + cl.def("pop", + [](Vector &v, SizeType i) { + if (i >= v.size()) + throw index_error(); + T t = v[i]; + v.erase(v.begin() + (DiffType) i); + return t; + }, + arg("i"), + "Remove and return the item at index ``i``" + ); + + cl.def("__setitem__", + [](Vector &v, SizeType i, const T &t) { + if (i >= v.size()) + throw index_error(); + v[i] = t; + } + ); + + /// Slicing protocol + cl.def("__getitem__", + [](const Vector &v, slice slice) -> Vector * { + size_t start, stop, step, slicelength; + + if (!slice.compute(v.size(), &start, &stop, &step, &slicelength)) + throw error_already_set(); + + Vector *seq = new Vector(); + seq->reserve((size_t) slicelength); + + for (size_t i=0; ipush_back(v[start]); + start += step; + } + return seq; + }, + arg("s"), + "Retrieve list elements using a slice object" + ); + + cl.def("__setitem__", + [](Vector &v, slice slice, const Vector &value) { + size_t start, stop, step, slicelength; + if (!slice.compute(v.size(), &start, &stop, &step, &slicelength)) + throw error_already_set(); + + if (slicelength != value.size()) + throw std::runtime_error("Left and right hand size of slice assignment have different sizes!"); + + for (size_t i=0; i= v.size()) + throw index_error(); + v.erase(v.begin() + DiffType(i)); + }, + "Delete the list elements at index ``i``" + ); + + cl.def("__delitem__", + [](Vector &v, slice slice) { + size_t start, stop, step, slicelength; + + if (!slice.compute(v.size(), &start, &stop, &step, &slicelength)) + throw error_already_set(); + + if (step == 1 && false) { + v.erase(v.begin() + (DiffType) start, v.begin() + DiffType(start + slicelength)); + } else { + for (size_t i = 0; i < slicelength; ++i) { + v.erase(v.begin() + DiffType(start)); + start += step - 1; + } + } + }, + "Delete list elements using a slice object" + ); + +} + +// If the type has an operator[] that doesn't return a reference (most notably std::vector), +// we have to access by copying; otherwise we return by reference. +template using vector_needs_copy = negation< + std::is_same()[typename Vector::size_type()]), typename Vector::value_type &>>; + +// The usual case: access and iterate by reference +template +void vector_accessor(enable_if_t::value, Class_> &cl) { + using T = typename Vector::value_type; + using SizeType = typename Vector::size_type; + using ItType = typename Vector::iterator; + + cl.def("__getitem__", + [](Vector &v, SizeType i) -> T & { + if (i >= v.size()) + throw index_error(); + return v[i]; + }, + return_value_policy::reference_internal // ref + keepalive + ); + + cl.def("__iter__", + [](Vector &v) { + return make_iterator< + return_value_policy::reference_internal, ItType, ItType, T&>( + v.begin(), v.end()); + }, + keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ + ); +} + +// The case for special objects, like std::vector, that have to be returned-by-copy: +template +void vector_accessor(enable_if_t::value, Class_> &cl) { + using T = typename Vector::value_type; + using SizeType = typename Vector::size_type; + using ItType = typename Vector::iterator; + cl.def("__getitem__", + [](const Vector &v, SizeType i) -> T { + if (i >= v.size()) + throw index_error(); + return v[i]; + } + ); + + cl.def("__iter__", + [](Vector &v) { + return make_iterator< + return_value_policy::copy, ItType, ItType, T>( + v.begin(), v.end()); + }, + keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ + ); +} + +template auto vector_if_insertion_operator(Class_ &cl, std::string const &name) + -> decltype(std::declval() << std::declval(), void()) { + using size_type = typename Vector::size_type; + + cl.def("__repr__", + [name](Vector &v) { + std::ostringstream s; + s << name << '['; + for (size_type i=0; i < v.size(); ++i) { + s << v[i]; + if (i != v.size() - 1) + s << ", "; + } + s << ']'; + return s.str(); + }, + "Return the canonical string representation of this list." + ); +} + +// Provide the buffer interface for vectors if we have data() and we have a format for it +// GCC seems to have "void std::vector::data()" - doing SFINAE on the existence of data() is insufficient, we need to check it returns an appropriate pointer +template +struct vector_has_data_and_format : std::false_type {}; +template +struct vector_has_data_and_format::format(), std::declval().data()), typename Vector::value_type*>::value>> : std::true_type {}; + +// Add the buffer interface to a vector +template +enable_if_t...>::value> +vector_buffer(Class_& cl) { + using T = typename Vector::value_type; + + static_assert(vector_has_data_and_format::value, "There is not an appropriate format descriptor for this vector"); + + // numpy.h declares this for arbitrary types, but it may raise an exception and crash hard at runtime if PYBIND11_NUMPY_DTYPE hasn't been called, so check here + format_descriptor::format(); + + cl.def_buffer([](Vector& v) -> buffer_info { + return buffer_info(v.data(), static_cast(sizeof(T)), format_descriptor::format(), 1, {v.size()}, {sizeof(T)}); + }); + + cl.def(init([](buffer buf) { + auto info = buf.request(); + if (info.ndim != 1 || info.strides[0] % static_cast(sizeof(T))) + throw type_error("Only valid 1D buffers can be copied to a vector"); + if (!detail::compare_buffer_info::compare(info) || (ssize_t) sizeof(T) != info.itemsize) + throw type_error("Format mismatch (Python: " + info.format + " C++: " + format_descriptor::format() + ")"); + + auto vec = std::unique_ptr(new Vector()); + vec->reserve((size_t) info.shape[0]); + T *p = static_cast(info.ptr); + ssize_t step = info.strides[0] / static_cast(sizeof(T)); + T *end = p + info.shape[0] * step; + for (; p != end; p += step) + vec->push_back(*p); + return vec.release(); + })); + + return; +} + +template +enable_if_t...>::value> vector_buffer(Class_&) {} + +NAMESPACE_END(detail) + +// +// std::vector +// +template , typename... Args> +class_ bind_vector(handle scope, std::string const &name, Args&&... args) { + using Class_ = class_; + + // If the value_type is unregistered (e.g. a converting type) or is itself registered + // module-local then make the vector binding module-local as well: + using vtype = typename Vector::value_type; + auto vtype_info = detail::get_type_info(typeid(vtype)); + bool local = !vtype_info || vtype_info->module_local; + + Class_ cl(scope, name.c_str(), pybind11::module_local(local), std::forward(args)...); + + // Declare the buffer interface if a buffer_protocol() is passed in + detail::vector_buffer(cl); + + cl.def(init<>()); + + // Register copy constructor (if possible) + detail::vector_if_copy_constructible(cl); + + // Register comparison-related operators and functions (if possible) + detail::vector_if_equal_operator(cl); + + // Register stream insertion operator (if possible) + detail::vector_if_insertion_operator(cl, name); + + // Modifiers require copyable vector value type + detail::vector_modifiers(cl); + + // Accessor and iterator; return by value if copyable, otherwise we return by ref + keep-alive + detail::vector_accessor(cl); + + cl.def("__bool__", + [](const Vector &v) -> bool { + return !v.empty(); + }, + "Check whether the list is nonempty" + ); + + cl.def("__len__", &Vector::size); + + + + +#if 0 + // C++ style functions deprecated, leaving it here as an example + cl.def(init()); + + cl.def("resize", + (void (Vector::*) (size_type count)) & Vector::resize, + "changes the number of elements stored"); + + cl.def("erase", + [](Vector &v, SizeType i) { + if (i >= v.size()) + throw index_error(); + v.erase(v.begin() + i); + }, "erases element at index ``i``"); + + cl.def("empty", &Vector::empty, "checks whether the container is empty"); + cl.def("size", &Vector::size, "returns the number of elements"); + cl.def("push_back", (void (Vector::*)(const T&)) &Vector::push_back, "adds an element to the end"); + cl.def("pop_back", &Vector::pop_back, "removes the last element"); + + cl.def("max_size", &Vector::max_size, "returns the maximum possible number of elements"); + cl.def("reserve", &Vector::reserve, "reserves storage"); + cl.def("capacity", &Vector::capacity, "returns the number of elements that can be held in currently allocated storage"); + cl.def("shrink_to_fit", &Vector::shrink_to_fit, "reduces memory usage by freeing unused memory"); + + cl.def("clear", &Vector::clear, "clears the contents"); + cl.def("swap", &Vector::swap, "swaps the contents"); + + cl.def("front", [](Vector &v) { + if (v.size()) return v.front(); + else throw index_error(); + }, "access the first element"); + + cl.def("back", [](Vector &v) { + if (v.size()) return v.back(); + else throw index_error(); + }, "access the last element "); + +#endif + + return cl; +} + + + +// +// std::map, std::unordered_map +// + +NAMESPACE_BEGIN(detail) + +/* Fallback functions */ +template void map_if_insertion_operator(const Args &...) { } +template void map_assignment(const Args &...) { } + +// Map assignment when copy-assignable: just copy the value +template +void map_assignment(enable_if_t::value, Class_> &cl) { + using KeyType = typename Map::key_type; + using MappedType = typename Map::mapped_type; + + cl.def("__setitem__", + [](Map &m, const KeyType &k, const MappedType &v) { + auto it = m.find(k); + if (it != m.end()) it->second = v; + else m.emplace(k, v); + } + ); +} + +// Not copy-assignable, but still copy-constructible: we can update the value by erasing and reinserting +template +void map_assignment(enable_if_t< + !std::is_copy_assignable::value && + is_copy_constructible::value, + Class_> &cl) { + using KeyType = typename Map::key_type; + using MappedType = typename Map::mapped_type; + + cl.def("__setitem__", + [](Map &m, const KeyType &k, const MappedType &v) { + // We can't use m[k] = v; because value type might not be default constructable + auto r = m.emplace(k, v); + if (!r.second) { + // value type is not copy assignable so the only way to insert it is to erase it first... + m.erase(r.first); + m.emplace(k, v); + } + } + ); +} + + +template auto map_if_insertion_operator(Class_ &cl, std::string const &name) +-> decltype(std::declval() << std::declval() << std::declval(), void()) { + + cl.def("__repr__", + [name](Map &m) { + std::ostringstream s; + s << name << '{'; + bool f = false; + for (auto const &kv : m) { + if (f) + s << ", "; + s << kv.first << ": " << kv.second; + f = true; + } + s << '}'; + return s.str(); + }, + "Return the canonical string representation of this map." + ); +} + + +NAMESPACE_END(detail) + +template , typename... Args> +class_ bind_map(handle scope, const std::string &name, Args&&... args) { + using KeyType = typename Map::key_type; + using MappedType = typename Map::mapped_type; + using Class_ = class_; + + // If either type is a non-module-local bound type then make the map binding non-local as well; + // otherwise (e.g. both types are either module-local or converting) the map will be + // module-local. + auto tinfo = detail::get_type_info(typeid(MappedType)); + bool local = !tinfo || tinfo->module_local; + if (local) { + tinfo = detail::get_type_info(typeid(KeyType)); + local = !tinfo || tinfo->module_local; + } + + Class_ cl(scope, name.c_str(), pybind11::module_local(local), std::forward(args)...); + + cl.def(init<>()); + + // Register stream insertion operator (if possible) + detail::map_if_insertion_operator(cl, name); + + cl.def("__bool__", + [](const Map &m) -> bool { return !m.empty(); }, + "Check whether the map is nonempty" + ); + + cl.def("__iter__", + [](Map &m) { return make_key_iterator(m.begin(), m.end()); }, + keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ + ); + + cl.def("items", + [](Map &m) { return make_iterator(m.begin(), m.end()); }, + keep_alive<0, 1>() /* Essential: keep list alive while iterator exists */ + ); + + cl.def("__getitem__", + [](Map &m, const KeyType &k) -> MappedType & { + auto it = m.find(k); + if (it == m.end()) + throw key_error(); + return it->second; + }, + return_value_policy::reference_internal // ref + keepalive + ); + + // Assignment provided only if the type is copyable + detail::map_assignment(cl); + + cl.def("__delitem__", + [](Map &m, const KeyType &k) { + auto it = m.find(k); + if (it == m.end()) + throw key_error(); + m.erase(it); + } + ); + + cl.def("__len__", &Map::size); + + return cl; +} + +NAMESPACE_END(PYBIND11_NAMESPACE) diff --git a/plugins/python/pybind11/pybind11/__init__.py b/plugins/python/pybind11/pybind11/__init__.py new file mode 100644 index 0000000..5782ffe --- /dev/null +++ b/plugins/python/pybind11/pybind11/__init__.py @@ -0,0 +1,28 @@ +from ._version import version_info, __version__ # noqa: F401 imported but unused + + +def get_include(user=False): + from distutils.dist import Distribution + import os + import sys + + # Are we running in a virtual environment? + virtualenv = hasattr(sys, 'real_prefix') or \ + sys.prefix != getattr(sys, "base_prefix", sys.prefix) + + if virtualenv: + return os.path.join(sys.prefix, 'include', 'site', + 'python' + sys.version[:3]) + else: + dist = Distribution({'name': 'pybind11'}) + dist.parse_config_files() + + dist_cobj = dist.get_command_obj('install', create=True) + + # Search for packages in user's home directory? + if user: + dist_cobj.user = user + dist_cobj.prefix = "" + dist_cobj.finalize_options() + + return os.path.dirname(dist_cobj.install_headers) diff --git a/plugins/python/pybind11/pybind11/__main__.py b/plugins/python/pybind11/pybind11/__main__.py new file mode 100644 index 0000000..9ef8378 --- /dev/null +++ b/plugins/python/pybind11/pybind11/__main__.py @@ -0,0 +1,37 @@ +from __future__ import print_function + +import argparse +import sys +import sysconfig + +from . import get_include + + +def print_includes(): + dirs = [sysconfig.get_path('include'), + sysconfig.get_path('platinclude'), + get_include(), + get_include(True)] + + # Make unique but preserve order + unique_dirs = [] + for d in dirs: + if d not in unique_dirs: + unique_dirs.append(d) + + print(' '.join('-I' + d for d in unique_dirs)) + + +def main(): + parser = argparse.ArgumentParser(prog='python -m pybind11') + parser.add_argument('--includes', action='store_true', + help='Include flags for both pybind11 and Python headers.') + args = parser.parse_args() + if not sys.argv[1:]: + parser.print_help() + if args.includes: + print_includes() + + +if __name__ == '__main__': + main() diff --git a/plugins/python/pybind11/pybind11/_version.py b/plugins/python/pybind11/pybind11/_version.py new file mode 100644 index 0000000..54ebfb1 --- /dev/null +++ b/plugins/python/pybind11/pybind11/_version.py @@ -0,0 +1,2 @@ +version_info = (2, 2, 4) +__version__ = '.'.join(map(str, version_info)) diff --git a/plugins/python/pybind11/setup.cfg b/plugins/python/pybind11/setup.cfg new file mode 100644 index 0000000..369788b --- /dev/null +++ b/plugins/python/pybind11/setup.cfg @@ -0,0 +1,10 @@ +[bdist_wheel] +universal=1 + +[flake8] +max-line-length = 99 +show_source = True +exclude = .git, __pycache__, build, dist, docs, tools, venv +ignore = + # required for pretty matrix formatting: multiple spaces after `,` and `[` + E201, E241 diff --git a/plugins/python/pybind11/setup.py b/plugins/python/pybind11/setup.py new file mode 100644 index 0000000..f677f2a --- /dev/null +++ b/plugins/python/pybind11/setup.py @@ -0,0 +1,108 @@ +#!/usr/bin/env python + +# Setup script for PyPI; use CMakeFile.txt to build extension modules + +from setuptools import setup +from distutils.command.install_headers import install_headers +from pybind11 import __version__ +import os + +# Prevent installation of pybind11 headers by setting +# PYBIND11_USE_CMAKE. +if os.environ.get('PYBIND11_USE_CMAKE'): + headers = [] +else: + headers = [ + 'include/pybind11/detail/class.h', + 'include/pybind11/detail/common.h', + 'include/pybind11/detail/descr.h', + 'include/pybind11/detail/init.h', + 'include/pybind11/detail/internals.h', + 'include/pybind11/detail/typeid.h', + 'include/pybind11/attr.h', + 'include/pybind11/buffer_info.h', + 'include/pybind11/cast.h', + 'include/pybind11/chrono.h', + 'include/pybind11/common.h', + 'include/pybind11/complex.h', + 'include/pybind11/eigen.h', + 'include/pybind11/embed.h', + 'include/pybind11/eval.h', + 'include/pybind11/functional.h', + 'include/pybind11/iostream.h', + 'include/pybind11/numpy.h', + 'include/pybind11/operators.h', + 'include/pybind11/options.h', + 'include/pybind11/pybind11.h', + 'include/pybind11/pytypes.h', + 'include/pybind11/stl.h', + 'include/pybind11/stl_bind.h', + ] + + +class InstallHeaders(install_headers): + """Use custom header installer because the default one flattens subdirectories""" + def run(self): + if not self.distribution.headers: + return + + for header in self.distribution.headers: + subdir = os.path.dirname(os.path.relpath(header, 'include/pybind11')) + install_dir = os.path.join(self.install_dir, subdir) + self.mkpath(install_dir) + + (out, _) = self.copy_file(header, install_dir) + self.outfiles.append(out) + + +setup( + name='pybind11', + version=__version__, + description='Seamless operability between C++11 and Python', + author='Wenzel Jakob', + author_email='wenzel.jakob@epfl.ch', + url='https://github.com/pybind/pybind11', + download_url='https://github.com/pybind/pybind11/tarball/v' + __version__, + packages=['pybind11'], + license='BSD', + headers=headers, + cmdclass=dict(install_headers=InstallHeaders), + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Intended Audience :: Developers', + 'Topic :: Software Development :: Libraries :: Python Modules', + 'Topic :: Utilities', + 'Programming Language :: C++', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.2', + 'Programming Language :: Python :: 3.3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', + 'License :: OSI Approved :: BSD License' + ], + keywords='C++11, Python bindings', + long_description="""pybind11 is a lightweight header-only library that +exposes C++ types in Python and vice versa, mainly to create Python bindings of +existing C++ code. Its goals and syntax are similar to the excellent +Boost.Python by David Abrahams: to minimize boilerplate code in traditional +extension modules by inferring type information using compile-time +introspection. + +The main issue with Boost.Python-and the reason for creating such a similar +project-is Boost. Boost is an enormously large and complex suite of utility +libraries that works with almost every C++ compiler in existence. This +compatibility has its cost: arcane template tricks and workarounds are +necessary to support the oldest and buggiest of compiler specimens. Now that +C++11-compatible compilers are widely available, this heavy machinery has +become an excessively large and unnecessary dependency. + +Think of this library as a tiny self-contained version of Boost.Python with +everything stripped away that isn't relevant for binding generation. Without +comments, the core header files only require ~4K lines of code and depend on +Python (2.7 or 3.x, or PyPy2.7 >= 5.7) and the C++ standard library. This +compact implementation was possible thanks to some of the new C++11 language +features (specifically: tuples, lambda functions and variadic templates). Since +its creation, this library has grown beyond Boost.Python in many ways, leading +to dramatically simpler binding code in many common situations.""") diff --git a/plugins/python/pybind11/tests/CMakeLists.txt b/plugins/python/pybind11/tests/CMakeLists.txt new file mode 100644 index 0000000..25e0666 --- /dev/null +++ b/plugins/python/pybind11/tests/CMakeLists.txt @@ -0,0 +1,236 @@ +# CMakeLists.txt -- Build system for the pybind11 test suite +# +# Copyright (c) 2015 Wenzel Jakob +# +# All rights reserved. Use of this source code is governed by a +# BSD-style license that can be found in the LICENSE file. + +cmake_minimum_required(VERSION 2.8.12) + +option(PYBIND11_WERROR "Report all warnings as errors" OFF) + +if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) + # We're being loaded directly, i.e. not via add_subdirectory, so make this + # work as its own project and load the pybind11Config to get the tools we need + project(pybind11_tests CXX) + + find_package(pybind11 REQUIRED CONFIG) +endif() + +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + message(STATUS "Setting tests build type to MinSizeRel as none was specified") + set(CMAKE_BUILD_TYPE MinSizeRel CACHE STRING "Choose the type of build." FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" + "MinSizeRel" "RelWithDebInfo") +endif() + +# Full set of test files (you can override these; see below) +set(PYBIND11_TEST_FILES + test_buffers.cpp + test_builtin_casters.cpp + test_call_policies.cpp + test_callbacks.cpp + test_chrono.cpp + test_class.cpp + test_constants_and_functions.cpp + test_copy_move.cpp + test_docstring_options.cpp + test_eigen.cpp + test_enum.cpp + test_eval.cpp + test_exceptions.cpp + test_factory_constructors.cpp + test_iostream.cpp + test_kwargs_and_defaults.cpp + test_local_bindings.cpp + test_methods_and_attributes.cpp + test_modules.cpp + test_multiple_inheritance.cpp + test_numpy_array.cpp + test_numpy_dtypes.cpp + test_numpy_vectorize.cpp + test_opaque_types.cpp + test_operator_overloading.cpp + test_pickling.cpp + test_pytypes.cpp + test_sequences_and_iterators.cpp + test_smart_ptr.cpp + test_stl.cpp + test_stl_binders.cpp + test_virtual_functions.cpp +) + +# Invoking cmake with something like: +# cmake -DPYBIND11_TEST_OVERRIDE="test_callbacks.cpp;test_picking.cpp" .. +# lets you override the tests that get compiled and run. You can restore to all tests with: +# cmake -DPYBIND11_TEST_OVERRIDE= .. +if (PYBIND11_TEST_OVERRIDE) + set(PYBIND11_TEST_FILES ${PYBIND11_TEST_OVERRIDE}) +endif() + +string(REPLACE ".cpp" ".py" PYBIND11_PYTEST_FILES "${PYBIND11_TEST_FILES}") + +# Contains the set of test files that require pybind11_cross_module_tests to be +# built; if none of these are built (i.e. because TEST_OVERRIDE is used and +# doesn't include them) the second module doesn't get built. +set(PYBIND11_CROSS_MODULE_TESTS + test_exceptions.py + test_local_bindings.py + test_stl.py + test_stl_binders.py +) + +# Check if Eigen is available; if not, remove from PYBIND11_TEST_FILES (but +# keep it in PYBIND11_PYTEST_FILES, so that we get the "eigen is not installed" +# skip message). +list(FIND PYBIND11_TEST_FILES test_eigen.cpp PYBIND11_TEST_FILES_EIGEN_I) +if(PYBIND11_TEST_FILES_EIGEN_I GREATER -1) + # Try loading via newer Eigen's Eigen3Config first (bypassing tools/FindEigen3.cmake). + # Eigen 3.3.1+ exports a cmake 3.0+ target for handling dependency requirements, but also + # produces a fatal error if loaded from a pre-3.0 cmake. + if (NOT CMAKE_VERSION VERSION_LESS 3.0) + find_package(Eigen3 QUIET CONFIG) + if (EIGEN3_FOUND) + if (EIGEN3_VERSION_STRING AND NOT EIGEN3_VERSION_STRING VERSION_LESS 3.3.1) + set(PYBIND11_EIGEN_VIA_TARGET 1) + endif() + endif() + endif() + if (NOT EIGEN3_FOUND) + # Couldn't load via target, so fall back to allowing module mode finding, which will pick up + # tools/FindEigen3.cmake + find_package(Eigen3 QUIET) + endif() + + if(EIGEN3_FOUND) + # Eigen 3.3.1+ cmake sets EIGEN3_VERSION_STRING (and hard codes the version when installed + # rather than looking it up in the cmake script); older versions, and the + # tools/FindEigen3.cmake, set EIGEN3_VERSION instead. + if(NOT EIGEN3_VERSION AND EIGEN3_VERSION_STRING) + set(EIGEN3_VERSION ${EIGEN3_VERSION_STRING}) + endif() + message(STATUS "Building tests with Eigen v${EIGEN3_VERSION}") + else() + list(REMOVE_AT PYBIND11_TEST_FILES ${PYBIND11_TEST_FILES_EIGEN_I}) + message(STATUS "Building tests WITHOUT Eigen") + endif() +endif() + +# Optional dependency for some tests (boost::variant is only supported with version >= 1.56) +find_package(Boost 1.56) + +# Compile with compiler warnings turned on +function(pybind11_enable_warnings target_name) + if(MSVC) + target_compile_options(${target_name} PRIVATE /W4) + else() + target_compile_options(${target_name} PRIVATE -Wall -Wextra -Wconversion -Wcast-qual) + endif() + + if(PYBIND11_WERROR) + if(MSVC) + target_compile_options(${target_name} PRIVATE /WX) + else() + target_compile_options(${target_name} PRIVATE -Werror) + endif() + endif() +endfunction() + +set(test_targets pybind11_tests) + +# Build pybind11_cross_module_tests if any test_whatever.py are being built that require it +foreach(t ${PYBIND11_CROSS_MODULE_TESTS}) + list(FIND PYBIND11_PYTEST_FILES ${t} i) + if (i GREATER -1) + list(APPEND test_targets pybind11_cross_module_tests) + break() + endif() +endforeach() + +set(testdir ${CMAKE_CURRENT_SOURCE_DIR}) +foreach(target ${test_targets}) + set(test_files ${PYBIND11_TEST_FILES}) + if(NOT target STREQUAL "pybind11_tests") + set(test_files "") + endif() + + # Create the binding library + pybind11_add_module(${target} THIN_LTO ${target}.cpp ${test_files} ${PYBIND11_HEADERS}) + pybind11_enable_warnings(${target}) + + if(MSVC) + target_compile_options(${target} PRIVATE /utf-8) + endif() + + if(EIGEN3_FOUND) + if (PYBIND11_EIGEN_VIA_TARGET) + target_link_libraries(${target} PRIVATE Eigen3::Eigen) + else() + target_include_directories(${target} PRIVATE ${EIGEN3_INCLUDE_DIR}) + endif() + target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_EIGEN) + endif() + + if(Boost_FOUND) + target_include_directories(${target} PRIVATE ${Boost_INCLUDE_DIRS}) + target_compile_definitions(${target} PRIVATE -DPYBIND11_TEST_BOOST) + endif() + + # Always write the output file directly into the 'tests' directory (even on MSVC) + if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY) + set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${testdir}) + foreach(config ${CMAKE_CONFIGURATION_TYPES}) + string(TOUPPER ${config} config) + set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY_${config} ${testdir}) + endforeach() + endif() +endforeach() + +# Make sure pytest is found or produce a fatal error +if(NOT PYBIND11_PYTEST_FOUND) + execute_process(COMMAND ${PYTHON_EXECUTABLE} -c "import pytest; print(pytest.__version__)" + RESULT_VARIABLE pytest_not_found OUTPUT_VARIABLE pytest_version ERROR_QUIET) + if(pytest_not_found) + message(FATAL_ERROR "Running the tests requires pytest. Please install it manually" + " (try: ${PYTHON_EXECUTABLE} -m pip install pytest)") + elseif(pytest_version VERSION_LESS 3.0) + message(FATAL_ERROR "Running the tests requires pytest >= 3.0. Found: ${pytest_version}" + "Please update it (try: ${PYTHON_EXECUTABLE} -m pip install -U pytest)") + endif() + set(PYBIND11_PYTEST_FOUND TRUE CACHE INTERNAL "") +endif() + +if(CMAKE_VERSION VERSION_LESS 3.2) + set(PYBIND11_USES_TERMINAL "") +else() + set(PYBIND11_USES_TERMINAL "USES_TERMINAL") +endif() + +# A single command to compile and run the tests +add_custom_target(pytest COMMAND ${PYTHON_EXECUTABLE} -m pytest ${PYBIND11_PYTEST_FILES} + DEPENDS ${test_targets} WORKING_DIRECTORY ${testdir} ${PYBIND11_USES_TERMINAL}) + +if(PYBIND11_TEST_OVERRIDE) + add_custom_command(TARGET pytest POST_BUILD + COMMAND ${CMAKE_COMMAND} -E echo "Note: not all tests run: -DPYBIND11_TEST_OVERRIDE is in effect") +endif() + +# Add a check target to run all the tests, starting with pytest (we add dependencies to this below) +add_custom_target(check DEPENDS pytest) + +# The remaining tests only apply when being built as part of the pybind11 project, but not if the +# tests are being built independently. +if (NOT PROJECT_NAME STREQUAL "pybind11") + return() +endif() + +# Add a post-build comment to show the primary test suite .so size and, if a previous size, compare it: +add_custom_command(TARGET pybind11_tests POST_BUILD + COMMAND ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/tools/libsize.py + $ ${CMAKE_CURRENT_BINARY_DIR}/sosize-$.txt) + +# Test embedding the interpreter. Provides the `cpptest` target. +add_subdirectory(test_embed) + +# Test CMake build using functions and targets from subdirectory or installed location +add_subdirectory(test_cmake_build) diff --git a/plugins/python/pybind11/tests/conftest.py b/plugins/python/pybind11/tests/conftest.py new file mode 100644 index 0000000..f4c2282 --- /dev/null +++ b/plugins/python/pybind11/tests/conftest.py @@ -0,0 +1,241 @@ +"""pytest configuration + +Extends output capture as needed by pybind11: ignore constructors, optional unordered lines. +Adds docstring and exceptions message sanitizers: ignore Python 2 vs 3 differences. +""" + +import pytest +import textwrap +import difflib +import re +import sys +import contextlib +import platform +import gc + +_unicode_marker = re.compile(r'u(\'[^\']*\')') +_long_marker = re.compile(r'([0-9])L') +_hexadecimal = re.compile(r'0x[0-9a-fA-F]+') + + +def _strip_and_dedent(s): + """For triple-quote strings""" + return textwrap.dedent(s.lstrip('\n').rstrip()) + + +def _split_and_sort(s): + """For output which does not require specific line order""" + return sorted(_strip_and_dedent(s).splitlines()) + + +def _make_explanation(a, b): + """Explanation for a failed assert -- the a and b arguments are List[str]""" + return ["--- actual / +++ expected"] + [line.strip('\n') for line in difflib.ndiff(a, b)] + + +class Output(object): + """Basic output post-processing and comparison""" + def __init__(self, string): + self.string = string + self.explanation = [] + + def __str__(self): + return self.string + + def __eq__(self, other): + # Ignore constructor/destructor output which is prefixed with "###" + a = [line for line in self.string.strip().splitlines() if not line.startswith("###")] + b = _strip_and_dedent(other).splitlines() + if a == b: + return True + else: + self.explanation = _make_explanation(a, b) + return False + + +class Unordered(Output): + """Custom comparison for output without strict line ordering""" + def __eq__(self, other): + a = _split_and_sort(self.string) + b = _split_and_sort(other) + if a == b: + return True + else: + self.explanation = _make_explanation(a, b) + return False + + +class Capture(object): + def __init__(self, capfd): + self.capfd = capfd + self.out = "" + self.err = "" + + def __enter__(self): + self.capfd.readouterr() + return self + + def __exit__(self, *_): + self.out, self.err = self.capfd.readouterr() + + def __eq__(self, other): + a = Output(self.out) + b = other + if a == b: + return True + else: + self.explanation = a.explanation + return False + + def __str__(self): + return self.out + + def __contains__(self, item): + return item in self.out + + @property + def unordered(self): + return Unordered(self.out) + + @property + def stderr(self): + return Output(self.err) + + +@pytest.fixture +def capture(capsys): + """Extended `capsys` with context manager and custom equality operators""" + return Capture(capsys) + + +class SanitizedString(object): + def __init__(self, sanitizer): + self.sanitizer = sanitizer + self.string = "" + self.explanation = [] + + def __call__(self, thing): + self.string = self.sanitizer(thing) + return self + + def __eq__(self, other): + a = self.string + b = _strip_and_dedent(other) + if a == b: + return True + else: + self.explanation = _make_explanation(a.splitlines(), b.splitlines()) + return False + + +def _sanitize_general(s): + s = s.strip() + s = s.replace("pybind11_tests.", "m.") + s = s.replace("unicode", "str") + s = _long_marker.sub(r"\1", s) + s = _unicode_marker.sub(r"\1", s) + return s + + +def _sanitize_docstring(thing): + s = thing.__doc__ + s = _sanitize_general(s) + return s + + +@pytest.fixture +def doc(): + """Sanitize docstrings and add custom failure explanation""" + return SanitizedString(_sanitize_docstring) + + +def _sanitize_message(thing): + s = str(thing) + s = _sanitize_general(s) + s = _hexadecimal.sub("0", s) + return s + + +@pytest.fixture +def msg(): + """Sanitize messages and add custom failure explanation""" + return SanitizedString(_sanitize_message) + + +# noinspection PyUnusedLocal +def pytest_assertrepr_compare(op, left, right): + """Hook to insert custom failure explanation""" + if hasattr(left, 'explanation'): + return left.explanation + + +@contextlib.contextmanager +def suppress(exception): + """Suppress the desired exception""" + try: + yield + except exception: + pass + + +def gc_collect(): + ''' Run the garbage collector twice (needed when running + reference counting tests with PyPy) ''' + gc.collect() + gc.collect() + + +def pytest_namespace(): + """Add import suppression and test requirements to `pytest` namespace""" + try: + import numpy as np + except ImportError: + np = None + try: + import scipy + except ImportError: + scipy = None + try: + from pybind11_tests.eigen import have_eigen + except ImportError: + have_eigen = False + pypy = platform.python_implementation() == "PyPy" + + skipif = pytest.mark.skipif + return { + 'suppress': suppress, + 'requires_numpy': skipif(not np, reason="numpy is not installed"), + 'requires_scipy': skipif(not np, reason="scipy is not installed"), + 'requires_eigen_and_numpy': skipif(not have_eigen or not np, + reason="eigen and/or numpy are not installed"), + 'requires_eigen_and_scipy': skipif(not have_eigen or not scipy, + reason="eigen and/or scipy are not installed"), + 'unsupported_on_pypy': skipif(pypy, reason="unsupported on PyPy"), + 'unsupported_on_py2': skipif(sys.version_info.major < 3, + reason="unsupported on Python 2.x"), + 'gc_collect': gc_collect + } + + +def _test_import_pybind11(): + """Early diagnostic for test module initialization errors + + When there is an error during initialization, the first import will report the + real error while all subsequent imports will report nonsense. This import test + is done early (in the pytest configuration file, before any tests) in order to + avoid the noise of having all tests fail with identical error messages. + + Any possible exception is caught here and reported manually *without* the stack + trace. This further reduces noise since the trace would only show pytest internals + which are not useful for debugging pybind11 module issues. + """ + # noinspection PyBroadException + try: + import pybind11_tests # noqa: F401 imported but unused + except Exception as e: + print("Failed to import pybind11_tests from pytest:") + print(" {}: {}".format(type(e).__name__, e)) + sys.exit(1) + + +_test_import_pybind11() diff --git a/plugins/python/pybind11/tests/constructor_stats.h b/plugins/python/pybind11/tests/constructor_stats.h new file mode 100644 index 0000000..babded0 --- /dev/null +++ b/plugins/python/pybind11/tests/constructor_stats.h @@ -0,0 +1,276 @@ +#pragma once +/* + tests/constructor_stats.h -- framework for printing and tracking object + instance lifetimes in example/test code. + + Copyright (c) 2016 Jason Rhinelander + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. + +This header provides a few useful tools for writing examples or tests that want to check and/or +display object instance lifetimes. It requires that you include this header and add the following +function calls to constructors: + + class MyClass { + MyClass() { ...; print_default_created(this); } + ~MyClass() { ...; print_destroyed(this); } + MyClass(const MyClass &c) { ...; print_copy_created(this); } + MyClass(MyClass &&c) { ...; print_move_created(this); } + MyClass(int a, int b) { ...; print_created(this, a, b); } + MyClass &operator=(const MyClass &c) { ...; print_copy_assigned(this); } + MyClass &operator=(MyClass &&c) { ...; print_move_assigned(this); } + + ... + } + +You can find various examples of these in several of the existing testing .cpp files. (Of course +you don't need to add any of the above constructors/operators that you don't actually have, except +for the destructor). + +Each of these will print an appropriate message such as: + + ### MyClass @ 0x2801910 created via default constructor + ### MyClass @ 0x27fa780 created 100 200 + ### MyClass @ 0x2801910 destroyed + ### MyClass @ 0x27fa780 destroyed + +You can also include extra arguments (such as the 100, 200 in the output above, coming from the +value constructor) for all of the above methods which will be included in the output. + +For testing, each of these also keeps track the created instances and allows you to check how many +of the various constructors have been invoked from the Python side via code such as: + + from pybind11_tests import ConstructorStats + cstats = ConstructorStats.get(MyClass) + print(cstats.alive()) + print(cstats.default_constructions) + +Note that `.alive()` should usually be the first thing you call as it invokes Python's garbage +collector to actually destroy objects that aren't yet referenced. + +For everything except copy and move constructors and destructors, any extra values given to the +print_...() function is stored in a class-specific values list which you can retrieve and inspect +from the ConstructorStats instance `.values()` method. + +In some cases, when you need to track instances of a C++ class not registered with pybind11, you +need to add a function returning the ConstructorStats for the C++ class; this can be done with: + + m.def("get_special_cstats", &ConstructorStats::get, py::return_value_policy::reference) + +Finally, you can suppress the output messages, but keep the constructor tracking (for +inspection/testing in python) by using the functions with `print_` replaced with `track_` (e.g. +`track_copy_created(this)`). + +*/ + +#include "pybind11_tests.h" +#include +#include +#include +#include + +class ConstructorStats { +protected: + std::unordered_map _instances; // Need a map rather than set because members can shared address with parents + std::list _values; // Used to track values (e.g. of value constructors) +public: + int default_constructions = 0; + int copy_constructions = 0; + int move_constructions = 0; + int copy_assignments = 0; + int move_assignments = 0; + + void copy_created(void *inst) { + created(inst); + copy_constructions++; + } + + void move_created(void *inst) { + created(inst); + move_constructions++; + } + + void default_created(void *inst) { + created(inst); + default_constructions++; + } + + void created(void *inst) { + ++_instances[inst]; + } + + void destroyed(void *inst) { + if (--_instances[inst] < 0) + throw std::runtime_error("cstats.destroyed() called with unknown " + "instance; potential double-destruction " + "or a missing cstats.created()"); + } + + static void gc() { + // Force garbage collection to ensure any pending destructors are invoked: +#if defined(PYPY_VERSION) + PyObject *globals = PyEval_GetGlobals(); + PyObject *result = PyRun_String( + "import gc\n" + "for i in range(2):" + " gc.collect()\n", + Py_file_input, globals, globals); + if (result == nullptr) + throw py::error_already_set(); + Py_DECREF(result); +#else + py::module::import("gc").attr("collect")(); +#endif + } + + int alive() { + gc(); + int total = 0; + for (const auto &p : _instances) + if (p.second > 0) + total += p.second; + return total; + } + + void value() {} // Recursion terminator + // Takes one or more values, converts them to strings, then stores them. + template void value(const T &v, Tmore &&...args) { + std::ostringstream oss; + oss << v; + _values.push_back(oss.str()); + value(std::forward(args)...); + } + + // Move out stored values + py::list values() { + py::list l; + for (const auto &v : _values) l.append(py::cast(v)); + _values.clear(); + return l; + } + + // Gets constructor stats from a C++ type index + static ConstructorStats& get(std::type_index type) { + static std::unordered_map all_cstats; + return all_cstats[type]; + } + + // Gets constructor stats from a C++ type + template static ConstructorStats& get() { +#if defined(PYPY_VERSION) + gc(); +#endif + return get(typeid(T)); + } + + // Gets constructor stats from a Python class + static ConstructorStats& get(py::object class_) { + auto &internals = py::detail::get_internals(); + const std::type_index *t1 = nullptr, *t2 = nullptr; + try { + auto *type_info = internals.registered_types_py.at((PyTypeObject *) class_.ptr()).at(0); + for (auto &p : internals.registered_types_cpp) { + if (p.second == type_info) { + if (t1) { + t2 = &p.first; + break; + } + t1 = &p.first; + } + } + } + catch (std::out_of_range) {} + if (!t1) throw std::runtime_error("Unknown class passed to ConstructorStats::get()"); + auto &cs1 = get(*t1); + // If we have both a t1 and t2 match, one is probably the trampoline class; return whichever + // has more constructions (typically one or the other will be 0) + if (t2) { + auto &cs2 = get(*t2); + int cs1_total = cs1.default_constructions + cs1.copy_constructions + cs1.move_constructions + (int) cs1._values.size(); + int cs2_total = cs2.default_constructions + cs2.copy_constructions + cs2.move_constructions + (int) cs2._values.size(); + if (cs2_total > cs1_total) return cs2; + } + return cs1; + } +}; + +// To track construction/destruction, you need to call these methods from the various +// constructors/operators. The ones that take extra values record the given values in the +// constructor stats values for later inspection. +template void track_copy_created(T *inst) { ConstructorStats::get().copy_created(inst); } +template void track_move_created(T *inst) { ConstructorStats::get().move_created(inst); } +template void track_copy_assigned(T *, Values &&...values) { + auto &cst = ConstructorStats::get(); + cst.copy_assignments++; + cst.value(std::forward(values)...); +} +template void track_move_assigned(T *, Values &&...values) { + auto &cst = ConstructorStats::get(); + cst.move_assignments++; + cst.value(std::forward(values)...); +} +template void track_default_created(T *inst, Values &&...values) { + auto &cst = ConstructorStats::get(); + cst.default_created(inst); + cst.value(std::forward(values)...); +} +template void track_created(T *inst, Values &&...values) { + auto &cst = ConstructorStats::get(); + cst.created(inst); + cst.value(std::forward(values)...); +} +template void track_destroyed(T *inst) { + ConstructorStats::get().destroyed(inst); +} +template void track_values(T *, Values &&...values) { + ConstructorStats::get().value(std::forward(values)...); +} + +/// Don't cast pointers to Python, print them as strings +inline const char *format_ptrs(const char *p) { return p; } +template +py::str format_ptrs(T *p) { return "{:#x}"_s.format(reinterpret_cast(p)); } +template +auto format_ptrs(T &&x) -> decltype(std::forward(x)) { return std::forward(x); } + +template +void print_constr_details(T *inst, const std::string &action, Output &&...output) { + py::print("###", py::type_id(), "@", format_ptrs(inst), action, + format_ptrs(std::forward(output))...); +} + +// Verbose versions of the above: +template void print_copy_created(T *inst, Values &&...values) { // NB: this prints, but doesn't store, given values + print_constr_details(inst, "created via copy constructor", values...); + track_copy_created(inst); +} +template void print_move_created(T *inst, Values &&...values) { // NB: this prints, but doesn't store, given values + print_constr_details(inst, "created via move constructor", values...); + track_move_created(inst); +} +template void print_copy_assigned(T *inst, Values &&...values) { + print_constr_details(inst, "assigned via copy assignment", values...); + track_copy_assigned(inst, values...); +} +template void print_move_assigned(T *inst, Values &&...values) { + print_constr_details(inst, "assigned via move assignment", values...); + track_move_assigned(inst, values...); +} +template void print_default_created(T *inst, Values &&...values) { + print_constr_details(inst, "created via default constructor", values...); + track_default_created(inst, values...); +} +template void print_created(T *inst, Values &&...values) { + print_constr_details(inst, "created", values...); + track_created(inst, values...); +} +template void print_destroyed(T *inst, Values &&...values) { // Prints but doesn't store given values + print_constr_details(inst, "destroyed", values...); + track_destroyed(inst); +} +template void print_values(T *inst, Values &&...values) { + print_constr_details(inst, ":", values...); + track_values(inst, values...); +} + diff --git a/plugins/python/pybind11/tests/local_bindings.h b/plugins/python/pybind11/tests/local_bindings.h new file mode 100644 index 0000000..b6afb80 --- /dev/null +++ b/plugins/python/pybind11/tests/local_bindings.h @@ -0,0 +1,64 @@ +#pragma once +#include "pybind11_tests.h" + +/// Simple class used to test py::local: +template class LocalBase { +public: + LocalBase(int i) : i(i) { } + int i = -1; +}; + +/// Registered with py::module_local in both main and secondary modules: +using LocalType = LocalBase<0>; +/// Registered without py::module_local in both modules: +using NonLocalType = LocalBase<1>; +/// A second non-local type (for stl_bind tests): +using NonLocal2 = LocalBase<2>; +/// Tests within-module, different-compilation-unit local definition conflict: +using LocalExternal = LocalBase<3>; +/// Mixed: registered local first, then global +using MixedLocalGlobal = LocalBase<4>; +/// Mixed: global first, then local +using MixedGlobalLocal = LocalBase<5>; + +/// Registered with py::module_local only in the secondary module: +using ExternalType1 = LocalBase<6>; +using ExternalType2 = LocalBase<7>; + +using LocalVec = std::vector; +using LocalVec2 = std::vector; +using LocalMap = std::unordered_map; +using NonLocalVec = std::vector; +using NonLocalVec2 = std::vector; +using NonLocalMap = std::unordered_map; +using NonLocalMap2 = std::unordered_map; + +PYBIND11_MAKE_OPAQUE(LocalVec); +PYBIND11_MAKE_OPAQUE(LocalVec2); +PYBIND11_MAKE_OPAQUE(LocalMap); +PYBIND11_MAKE_OPAQUE(NonLocalVec); +//PYBIND11_MAKE_OPAQUE(NonLocalVec2); // same type as LocalVec2 +PYBIND11_MAKE_OPAQUE(NonLocalMap); +PYBIND11_MAKE_OPAQUE(NonLocalMap2); + + +// Simple bindings (used with the above): +template +py::class_ bind_local(Args && ...args) { + return py::class_(std::forward(args)...) + .def(py::init()) + .def("get", [](T &i) { return i.i + Adjust; }); +}; + +// Simulate a foreign library base class (to match the example in the docs): +namespace pets { +class Pet { +public: + Pet(std::string name) : name_(name) {} + std::string name_; + const std::string &name() { return name_; } +}; +} + +struct MixGL { int i; MixGL(int i) : i{i} {} }; +struct MixGL2 { int i; MixGL2(int i) : i{i} {} }; diff --git a/plugins/python/pybind11/tests/object.h b/plugins/python/pybind11/tests/object.h new file mode 100644 index 0000000..9235f19 --- /dev/null +++ b/plugins/python/pybind11/tests/object.h @@ -0,0 +1,175 @@ +#if !defined(__OBJECT_H) +#define __OBJECT_H + +#include +#include "constructor_stats.h" + +/// Reference counted object base class +class Object { +public: + /// Default constructor + Object() { print_default_created(this); } + + /// Copy constructor + Object(const Object &) : m_refCount(0) { print_copy_created(this); } + + /// Return the current reference count + int getRefCount() const { return m_refCount; }; + + /// Increase the object's reference count by one + void incRef() const { ++m_refCount; } + + /** \brief Decrease the reference count of + * the object and possibly deallocate it. + * + * The object will automatically be deallocated once + * the reference count reaches zero. + */ + void decRef(bool dealloc = true) const { + --m_refCount; + if (m_refCount == 0 && dealloc) + delete this; + else if (m_refCount < 0) + throw std::runtime_error("Internal error: reference count < 0!"); + } + + virtual std::string toString() const = 0; +protected: + /** \brief Virtual protected deconstructor. + * (Will only be called by \ref ref) + */ + virtual ~Object() { print_destroyed(this); } +private: + mutable std::atomic m_refCount { 0 }; +}; + +// Tag class used to track constructions of ref objects. When we track constructors, below, we +// track and print out the actual class (e.g. ref), and *also* add a fake tracker for +// ref_tag. This lets us check that the total number of ref constructors/destructors is +// correct without having to check each individual ref type individually. +class ref_tag {}; + +/** + * \brief Reference counting helper + * + * The \a ref refeference template is a simple wrapper to store a + * pointer to an object. It takes care of increasing and decreasing + * the reference count of the object. When the last reference goes + * out of scope, the associated object will be deallocated. + * + * \ingroup libcore + */ +template class ref { +public: + /// Create a nullptr reference + ref() : m_ptr(nullptr) { print_default_created(this); track_default_created((ref_tag*) this); } + + /// Construct a reference from a pointer + ref(T *ptr) : m_ptr(ptr) { + if (m_ptr) ((Object *) m_ptr)->incRef(); + + print_created(this, "from pointer", m_ptr); track_created((ref_tag*) this, "from pointer"); + + } + + /// Copy constructor + ref(const ref &r) : m_ptr(r.m_ptr) { + if (m_ptr) + ((Object *) m_ptr)->incRef(); + + print_copy_created(this, "with pointer", m_ptr); track_copy_created((ref_tag*) this); + } + + /// Move constructor + ref(ref &&r) : m_ptr(r.m_ptr) { + r.m_ptr = nullptr; + + print_move_created(this, "with pointer", m_ptr); track_move_created((ref_tag*) this); + } + + /// Destroy this reference + ~ref() { + if (m_ptr) + ((Object *) m_ptr)->decRef(); + + print_destroyed(this); track_destroyed((ref_tag*) this); + } + + /// Move another reference into the current one + ref& operator=(ref&& r) { + print_move_assigned(this, "pointer", r.m_ptr); track_move_assigned((ref_tag*) this); + + if (*this == r) + return *this; + if (m_ptr) + ((Object *) m_ptr)->decRef(); + m_ptr = r.m_ptr; + r.m_ptr = nullptr; + return *this; + } + + /// Overwrite this reference with another reference + ref& operator=(const ref& r) { + print_copy_assigned(this, "pointer", r.m_ptr); track_copy_assigned((ref_tag*) this); + + if (m_ptr == r.m_ptr) + return *this; + if (m_ptr) + ((Object *) m_ptr)->decRef(); + m_ptr = r.m_ptr; + if (m_ptr) + ((Object *) m_ptr)->incRef(); + return *this; + } + + /// Overwrite this reference with a pointer to another object + ref& operator=(T *ptr) { + print_values(this, "assigned pointer"); track_values((ref_tag*) this, "assigned pointer"); + + if (m_ptr == ptr) + return *this; + if (m_ptr) + ((Object *) m_ptr)->decRef(); + m_ptr = ptr; + if (m_ptr) + ((Object *) m_ptr)->incRef(); + return *this; + } + + /// Compare this reference with another reference + bool operator==(const ref &r) const { return m_ptr == r.m_ptr; } + + /// Compare this reference with another reference + bool operator!=(const ref &r) const { return m_ptr != r.m_ptr; } + + /// Compare this reference with a pointer + bool operator==(const T* ptr) const { return m_ptr == ptr; } + + /// Compare this reference with a pointer + bool operator!=(const T* ptr) const { return m_ptr != ptr; } + + /// Access the object referenced by this reference + T* operator->() { return m_ptr; } + + /// Access the object referenced by this reference + const T* operator->() const { return m_ptr; } + + /// Return a C++ reference to the referenced object + T& operator*() { return *m_ptr; } + + /// Return a const C++ reference to the referenced object + const T& operator*() const { return *m_ptr; } + + /// Return a pointer to the referenced object + operator T* () { return m_ptr; } + + /// Return a const pointer to the referenced object + T* get_ptr() { return m_ptr; } + + /// Return a pointer to the referenced object + const T* get_ptr() const { return m_ptr; } +private: + T *m_ptr; +}; + +#endif /* __OBJECT_H */ diff --git a/plugins/python/pybind11/tests/pybind11_cross_module_tests.cpp b/plugins/python/pybind11/tests/pybind11_cross_module_tests.cpp new file mode 100644 index 0000000..f705e31 --- /dev/null +++ b/plugins/python/pybind11/tests/pybind11_cross_module_tests.cpp @@ -0,0 +1,123 @@ +/* + tests/pybind11_cross_module_tests.cpp -- contains tests that require multiple modules + + Copyright (c) 2017 Jason Rhinelander + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "local_bindings.h" +#include +#include + +PYBIND11_MODULE(pybind11_cross_module_tests, m) { + m.doc() = "pybind11 cross-module test module"; + + // test_local_bindings.py tests: + // + // Definitions here are tested by importing both this module and the + // relevant pybind11_tests submodule from a test_whatever.py + + // test_load_external + bind_local(m, "ExternalType1", py::module_local()); + bind_local(m, "ExternalType2", py::module_local()); + + // test_exceptions.py + m.def("raise_runtime_error", []() { PyErr_SetString(PyExc_RuntimeError, "My runtime error"); throw py::error_already_set(); }); + m.def("raise_value_error", []() { PyErr_SetString(PyExc_ValueError, "My value error"); throw py::error_already_set(); }); + m.def("throw_pybind_value_error", []() { throw py::value_error("pybind11 value error"); }); + m.def("throw_pybind_type_error", []() { throw py::type_error("pybind11 type error"); }); + m.def("throw_stop_iteration", []() { throw py::stop_iteration(); }); + + // test_local_bindings.py + // Local to both: + bind_local(m, "LocalType", py::module_local()) + .def("get2", [](LocalType &t) { return t.i + 2; }) + ; + + // Can only be called with our python type: + m.def("local_value", [](LocalType &l) { return l.i; }); + + // test_nonlocal_failure + // This registration will fail (global registration when LocalFail is already registered + // globally in the main test module): + m.def("register_nonlocal", [m]() { + bind_local(m, "NonLocalType"); + }); + + // test_stl_bind_local + // stl_bind.h binders defaults to py::module_local if the types are local or converting: + py::bind_vector(m, "LocalVec"); + py::bind_map(m, "LocalMap"); + + // test_stl_bind_global + // and global if the type (or one of the types, for the map) is global (so these will fail, + // assuming pybind11_tests is already loaded): + m.def("register_nonlocal_vec", [m]() { + py::bind_vector(m, "NonLocalVec"); + }); + m.def("register_nonlocal_map", [m]() { + py::bind_map(m, "NonLocalMap"); + }); + // The default can, however, be overridden to global using `py::module_local()` or + // `py::module_local(false)`. + // Explicitly made local: + py::bind_vector(m, "NonLocalVec2", py::module_local()); + // Explicitly made global (and so will fail to bind): + m.def("register_nonlocal_map2", [m]() { + py::bind_map(m, "NonLocalMap2", py::module_local(false)); + }); + + // test_mixed_local_global + // We try this both with the global type registered first and vice versa (the order shouldn't + // matter). + m.def("register_mixed_global_local", [m]() { + bind_local(m, "MixedGlobalLocal", py::module_local()); + }); + m.def("register_mixed_local_global", [m]() { + bind_local(m, "MixedLocalGlobal", py::module_local(false)); + }); + m.def("get_mixed_gl", [](int i) { return MixedGlobalLocal(i); }); + m.def("get_mixed_lg", [](int i) { return MixedLocalGlobal(i); }); + + // test_internal_locals_differ + m.def("local_cpp_types_addr", []() { return (uintptr_t) &py::detail::registered_local_types_cpp(); }); + + // test_stl_caster_vs_stl_bind + py::bind_vector>(m, "VectorInt"); + + m.def("load_vector_via_binding", [](std::vector &v) { + return std::accumulate(v.begin(), v.end(), 0); + }); + + // test_cross_module_calls + m.def("return_self", [](LocalVec *v) { return v; }); + m.def("return_copy", [](const LocalVec &v) { return LocalVec(v); }); + + class Dog : public pets::Pet { public: Dog(std::string name) : Pet(name) {}; }; + py::class_(m, "Pet", py::module_local()) + .def("name", &pets::Pet::name); + // Binding for local extending class: + py::class_(m, "Dog") + .def(py::init()); + m.def("pet_name", [](pets::Pet &p) { return p.name(); }); + + py::class_(m, "MixGL", py::module_local()).def(py::init()); + m.def("get_gl_value", [](MixGL &o) { return o.i + 100; }); + + py::class_(m, "MixGL2", py::module_local()).def(py::init()); + + // test_vector_bool + // We can't test both stl.h and stl_bind.h conversions of `std::vector` within + // the same module (it would be an ODR violation). Therefore `bind_vector` of `bool` + // is defined here and tested in `test_stl_binders.py`. + py::bind_vector>(m, "VectorBool"); + + // test_missing_header_message + // The main module already includes stl.h, but we need to test the error message + // which appears when this header is missing. + m.def("missing_header_arg", [](std::vector) { }); + m.def("missing_header_return", []() { return std::vector(); }); +} diff --git a/plugins/python/pybind11/tests/pybind11_tests.cpp b/plugins/python/pybind11/tests/pybind11_tests.cpp new file mode 100644 index 0000000..bc7d2c3 --- /dev/null +++ b/plugins/python/pybind11/tests/pybind11_tests.cpp @@ -0,0 +1,93 @@ +/* + tests/pybind11_tests.cpp -- pybind example plugin + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" + +#include +#include + +/* +For testing purposes, we define a static global variable here in a function that each individual +test .cpp calls with its initialization lambda. It's convenient here because we can just not +compile some test files to disable/ignore some of the test code. + +It is NOT recommended as a way to use pybind11 in practice, however: the initialization order will +be essentially random, which is okay for our test scripts (there are no dependencies between the +individual pybind11 test .cpp files), but most likely not what you want when using pybind11 +productively. + +Instead, see the "How can I reduce the build time?" question in the "Frequently asked questions" +section of the documentation for good practice on splitting binding code over multiple files. +*/ +std::list> &initializers() { + static std::list> inits; + return inits; +} + +test_initializer::test_initializer(Initializer init) { + initializers().push_back(init); +} + +test_initializer::test_initializer(const char *submodule_name, Initializer init) { + initializers().push_back([=](py::module &parent) { + auto m = parent.def_submodule(submodule_name); + init(m); + }); +} + +void bind_ConstructorStats(py::module &m) { + py::class_(m, "ConstructorStats") + .def("alive", &ConstructorStats::alive) + .def("values", &ConstructorStats::values) + .def_readwrite("default_constructions", &ConstructorStats::default_constructions) + .def_readwrite("copy_assignments", &ConstructorStats::copy_assignments) + .def_readwrite("move_assignments", &ConstructorStats::move_assignments) + .def_readwrite("copy_constructions", &ConstructorStats::copy_constructions) + .def_readwrite("move_constructions", &ConstructorStats::move_constructions) + .def_static("get", (ConstructorStats &(*)(py::object)) &ConstructorStats::get, py::return_value_policy::reference_internal) + + // Not exactly ConstructorStats, but related: expose the internal pybind number of registered instances + // to allow instance cleanup checks (invokes a GC first) + .def_static("detail_reg_inst", []() { + ConstructorStats::gc(); + return py::detail::get_internals().registered_instances.size(); + }) + ; +} + +PYBIND11_MODULE(pybind11_tests, m) { + m.doc() = "pybind11 test module"; + + bind_ConstructorStats(m); + +#if !defined(NDEBUG) + m.attr("debug_enabled") = true; +#else + m.attr("debug_enabled") = false; +#endif + + py::class_(m, "UserType", "A `py::class_` type for testing") + .def(py::init<>()) + .def(py::init()) + .def("get_value", &UserType::value, "Get value using a method") + .def("set_value", &UserType::set, "Set value using a method") + .def_property("value", &UserType::value, &UserType::set, "Get/set value using a property") + .def("__repr__", [](const UserType& u) { return "UserType({})"_s.format(u.value()); }); + + py::class_(m, "IncType") + .def(py::init<>()) + .def(py::init()) + .def("__repr__", [](const IncType& u) { return "IncType({})"_s.format(u.value()); }); + + for (const auto &initializer : initializers()) + initializer(m); + + if (!py::hasattr(m, "have_eigen")) m.attr("have_eigen") = false; +} diff --git a/plugins/python/pybind11/tests/pybind11_tests.h b/plugins/python/pybind11/tests/pybind11_tests.h new file mode 100644 index 0000000..90963a5 --- /dev/null +++ b/plugins/python/pybind11/tests/pybind11_tests.h @@ -0,0 +1,65 @@ +#pragma once +#include + +#if defined(_MSC_VER) && _MSC_VER < 1910 +// We get some really long type names here which causes MSVC 2015 to emit warnings +# pragma warning(disable: 4503) // warning C4503: decorated name length exceeded, name was truncated +#endif + +namespace py = pybind11; +using namespace pybind11::literals; + +class test_initializer { + using Initializer = void (*)(py::module &); + +public: + test_initializer(Initializer init); + test_initializer(const char *submodule_name, Initializer init); +}; + +#define TEST_SUBMODULE(name, variable) \ + void test_submodule_##name(py::module &); \ + test_initializer name(#name, test_submodule_##name); \ + void test_submodule_##name(py::module &variable) + + +/// Dummy type which is not exported anywhere -- something to trigger a conversion error +struct UnregisteredType { }; + +/// A user-defined type which is exported and can be used by any test +class UserType { +public: + UserType() = default; + UserType(int i) : i(i) { } + + int value() const { return i; } + void set(int set) { i = set; } + +private: + int i = -1; +}; + +/// Like UserType, but increments `value` on copy for quick reference vs. copy tests +class IncType : public UserType { +public: + using UserType::UserType; + IncType() = default; + IncType(const IncType &other) : IncType(other.value() + 1) { } + IncType(IncType &&) = delete; + IncType &operator=(const IncType &) = delete; + IncType &operator=(IncType &&) = delete; +}; + +/// Custom cast-only type that casts to a string "rvalue" or "lvalue" depending on the cast context. +/// Used to test recursive casters (e.g. std::tuple, stl containers). +struct RValueCaster {}; +NAMESPACE_BEGIN(pybind11) +NAMESPACE_BEGIN(detail) +template<> class type_caster { +public: + PYBIND11_TYPE_CASTER(RValueCaster, _("RValueCaster")); + static handle cast(RValueCaster &&, return_value_policy, handle) { return py::str("rvalue").release(); } + static handle cast(const RValueCaster &, return_value_policy, handle) { return py::str("lvalue").release(); } +}; +NAMESPACE_END(detail) +NAMESPACE_END(pybind11) diff --git a/plugins/python/pybind11/tests/pytest.ini b/plugins/python/pybind11/tests/pytest.ini new file mode 100644 index 0000000..1e44f0a --- /dev/null +++ b/plugins/python/pybind11/tests/pytest.ini @@ -0,0 +1,15 @@ +[pytest] +minversion = 3.0 +norecursedirs = test_cmake_build test_embed +addopts = + # show summary of skipped tests + -rs + # capture only Python print and C++ py::print, but not C output (low-level Python errors) + --capture=sys +filterwarnings = + # make warnings into errors but ignore certain third-party extension issues + error + # importing scipy submodules on some version of Python + ignore::ImportWarning + # bogus numpy ABI warning (see numpy/#432) + ignore:.*numpy.dtype size changed.*:RuntimeWarning diff --git a/plugins/python/pybind11/tests/test_buffers.cpp b/plugins/python/pybind11/tests/test_buffers.cpp new file mode 100644 index 0000000..5be7177 --- /dev/null +++ b/plugins/python/pybind11/tests/test_buffers.cpp @@ -0,0 +1,169 @@ +/* + tests/test_buffers.cpp -- supporting Pythons' buffer protocol + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" + +TEST_SUBMODULE(buffers, m) { + // test_from_python / test_to_python: + class Matrix { + public: + Matrix(ssize_t rows, ssize_t cols) : m_rows(rows), m_cols(cols) { + print_created(this, std::to_string(m_rows) + "x" + std::to_string(m_cols) + " matrix"); + m_data = new float[(size_t) (rows*cols)]; + memset(m_data, 0, sizeof(float) * (size_t) (rows * cols)); + } + + Matrix(const Matrix &s) : m_rows(s.m_rows), m_cols(s.m_cols) { + print_copy_created(this, std::to_string(m_rows) + "x" + std::to_string(m_cols) + " matrix"); + m_data = new float[(size_t) (m_rows * m_cols)]; + memcpy(m_data, s.m_data, sizeof(float) * (size_t) (m_rows * m_cols)); + } + + Matrix(Matrix &&s) : m_rows(s.m_rows), m_cols(s.m_cols), m_data(s.m_data) { + print_move_created(this); + s.m_rows = 0; + s.m_cols = 0; + s.m_data = nullptr; + } + + ~Matrix() { + print_destroyed(this, std::to_string(m_rows) + "x" + std::to_string(m_cols) + " matrix"); + delete[] m_data; + } + + Matrix &operator=(const Matrix &s) { + print_copy_assigned(this, std::to_string(m_rows) + "x" + std::to_string(m_cols) + " matrix"); + delete[] m_data; + m_rows = s.m_rows; + m_cols = s.m_cols; + m_data = new float[(size_t) (m_rows * m_cols)]; + memcpy(m_data, s.m_data, sizeof(float) * (size_t) (m_rows * m_cols)); + return *this; + } + + Matrix &operator=(Matrix &&s) { + print_move_assigned(this, std::to_string(m_rows) + "x" + std::to_string(m_cols) + " matrix"); + if (&s != this) { + delete[] m_data; + m_rows = s.m_rows; m_cols = s.m_cols; m_data = s.m_data; + s.m_rows = 0; s.m_cols = 0; s.m_data = nullptr; + } + return *this; + } + + float operator()(ssize_t i, ssize_t j) const { + return m_data[(size_t) (i*m_cols + j)]; + } + + float &operator()(ssize_t i, ssize_t j) { + return m_data[(size_t) (i*m_cols + j)]; + } + + float *data() { return m_data; } + + ssize_t rows() const { return m_rows; } + ssize_t cols() const { return m_cols; } + private: + ssize_t m_rows; + ssize_t m_cols; + float *m_data; + }; + py::class_(m, "Matrix", py::buffer_protocol()) + .def(py::init()) + /// Construct from a buffer + .def(py::init([](py::buffer b) { + py::buffer_info info = b.request(); + if (info.format != py::format_descriptor::format() || info.ndim != 2) + throw std::runtime_error("Incompatible buffer format!"); + + auto v = new Matrix(info.shape[0], info.shape[1]); + memcpy(v->data(), info.ptr, sizeof(float) * (size_t) (v->rows() * v->cols())); + return v; + })) + + .def("rows", &Matrix::rows) + .def("cols", &Matrix::cols) + + /// Bare bones interface + .def("__getitem__", [](const Matrix &m, std::pair i) { + if (i.first >= m.rows() || i.second >= m.cols()) + throw py::index_error(); + return m(i.first, i.second); + }) + .def("__setitem__", [](Matrix &m, std::pair i, float v) { + if (i.first >= m.rows() || i.second >= m.cols()) + throw py::index_error(); + m(i.first, i.second) = v; + }) + /// Provide buffer access + .def_buffer([](Matrix &m) -> py::buffer_info { + return py::buffer_info( + m.data(), /* Pointer to buffer */ + { m.rows(), m.cols() }, /* Buffer dimensions */ + { sizeof(float) * size_t(m.rows()), /* Strides (in bytes) for each index */ + sizeof(float) } + ); + }) + ; + + + // test_inherited_protocol + class SquareMatrix : public Matrix { + public: + SquareMatrix(ssize_t n) : Matrix(n, n) { } + }; + // Derived classes inherit the buffer protocol and the buffer access function + py::class_(m, "SquareMatrix") + .def(py::init()); + + + // test_pointer_to_member_fn + // Tests that passing a pointer to member to the base class works in + // the derived class. + struct Buffer { + int32_t value = 0; + + py::buffer_info get_buffer_info() { + return py::buffer_info(&value, sizeof(value), + py::format_descriptor::format(), 1); + } + }; + py::class_(m, "Buffer", py::buffer_protocol()) + .def(py::init<>()) + .def_readwrite("value", &Buffer::value) + .def_buffer(&Buffer::get_buffer_info); + + + class ConstBuffer { + std::unique_ptr value; + + public: + int32_t get_value() const { return *value; } + void set_value(int32_t v) { *value = v; } + + py::buffer_info get_buffer_info() const { + return py::buffer_info(value.get(), sizeof(*value), + py::format_descriptor::format(), 1); + } + + ConstBuffer() : value(new int32_t{0}) { }; + }; + py::class_(m, "ConstBuffer", py::buffer_protocol()) + .def(py::init<>()) + .def_property("value", &ConstBuffer::get_value, &ConstBuffer::set_value) + .def_buffer(&ConstBuffer::get_buffer_info); + + struct DerivedBuffer : public Buffer { }; + py::class_(m, "DerivedBuffer", py::buffer_protocol()) + .def(py::init<>()) + .def_readwrite("value", (int32_t DerivedBuffer::*) &DerivedBuffer::value) + .def_buffer(&DerivedBuffer::get_buffer_info); + +} diff --git a/plugins/python/pybind11/tests/test_buffers.py b/plugins/python/pybind11/tests/test_buffers.py new file mode 100644 index 0000000..c348be5 --- /dev/null +++ b/plugins/python/pybind11/tests/test_buffers.py @@ -0,0 +1,83 @@ +import struct +import pytest +from pybind11_tests import buffers as m +from pybind11_tests import ConstructorStats + +pytestmark = pytest.requires_numpy + +with pytest.suppress(ImportError): + import numpy as np + + +def test_from_python(): + with pytest.raises(RuntimeError) as excinfo: + m.Matrix(np.array([1, 2, 3])) # trying to assign a 1D array + assert str(excinfo.value) == "Incompatible buffer format!" + + m3 = np.array([[1, 2, 3], [4, 5, 6]]).astype(np.float32) + m4 = m.Matrix(m3) + + for i in range(m4.rows()): + for j in range(m4.cols()): + assert m3[i, j] == m4[i, j] + + cstats = ConstructorStats.get(m.Matrix) + assert cstats.alive() == 1 + del m3, m4 + assert cstats.alive() == 0 + assert cstats.values() == ["2x3 matrix"] + assert cstats.copy_constructions == 0 + # assert cstats.move_constructions >= 0 # Don't invoke any + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + +# PyPy: Memory leak in the "np.array(m, copy=False)" call +# https://bitbucket.org/pypy/pypy/issues/2444 +@pytest.unsupported_on_pypy +def test_to_python(): + mat = m.Matrix(5, 5) + assert memoryview(mat).shape == (5, 5) + + assert mat[2, 3] == 0 + mat[2, 3] = 4 + assert mat[2, 3] == 4 + + mat2 = np.array(mat, copy=False) + assert mat2.shape == (5, 5) + assert abs(mat2).sum() == 4 + assert mat2[2, 3] == 4 + mat2[2, 3] = 5 + assert mat2[2, 3] == 5 + + cstats = ConstructorStats.get(m.Matrix) + assert cstats.alive() == 1 + del mat + pytest.gc_collect() + assert cstats.alive() == 1 + del mat2 # holds a mat reference + pytest.gc_collect() + assert cstats.alive() == 0 + assert cstats.values() == ["5x5 matrix"] + assert cstats.copy_constructions == 0 + # assert cstats.move_constructions >= 0 # Don't invoke any + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + +@pytest.unsupported_on_pypy +def test_inherited_protocol(): + """SquareMatrix is derived from Matrix and inherits the buffer protocol""" + + matrix = m.SquareMatrix(5) + assert memoryview(matrix).shape == (5, 5) + assert np.asarray(matrix).shape == (5, 5) + + +@pytest.unsupported_on_pypy +def test_pointer_to_member_fn(): + for cls in [m.Buffer, m.ConstBuffer, m.DerivedBuffer]: + buf = cls() + buf.value = 0x12345678 + value = struct.unpack('i', bytearray(buf))[0] + assert value == 0x12345678 diff --git a/plugins/python/pybind11/tests/test_builtin_casters.cpp b/plugins/python/pybind11/tests/test_builtin_casters.cpp new file mode 100644 index 0000000..e5413c2 --- /dev/null +++ b/plugins/python/pybind11/tests/test_builtin_casters.cpp @@ -0,0 +1,158 @@ +/* + tests/test_builtin_casters.cpp -- Casters available without any additional headers + + Copyright (c) 2017 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include + +#if defined(_MSC_VER) +# pragma warning(push) +# pragma warning(disable: 4127) // warning C4127: Conditional expression is constant +#endif + +TEST_SUBMODULE(builtin_casters, m) { + // test_simple_string + m.def("string_roundtrip", [](const char *s) { return s; }); + + // test_unicode_conversion + // Some test characters in utf16 and utf32 encodings. The last one (the 𝐀) contains a null byte + char32_t a32 = 0x61 /*a*/, z32 = 0x7a /*z*/, ib32 = 0x203d /*‽*/, cake32 = 0x1f382 /*🎂*/, mathbfA32 = 0x1d400 /*𝐀*/; + char16_t b16 = 0x62 /*b*/, z16 = 0x7a, ib16 = 0x203d, cake16_1 = 0xd83c, cake16_2 = 0xdf82, mathbfA16_1 = 0xd835, mathbfA16_2 = 0xdc00; + std::wstring wstr; + wstr.push_back(0x61); // a + wstr.push_back(0x2e18); // ⸘ + if (sizeof(wchar_t) == 2) { wstr.push_back(mathbfA16_1); wstr.push_back(mathbfA16_2); } // 𝐀, utf16 + else { wstr.push_back((wchar_t) mathbfA32); } // 𝐀, utf32 + wstr.push_back(0x7a); // z + + m.def("good_utf8_string", []() { return std::string(u8"Say utf8\u203d \U0001f382 \U0001d400"); }); // Say utf8‽ 🎂 𝐀 + m.def("good_utf16_string", [=]() { return std::u16string({ b16, ib16, cake16_1, cake16_2, mathbfA16_1, mathbfA16_2, z16 }); }); // b‽🎂𝐀z + m.def("good_utf32_string", [=]() { return std::u32string({ a32, mathbfA32, cake32, ib32, z32 }); }); // a𝐀🎂‽z + m.def("good_wchar_string", [=]() { return wstr; }); // a‽𝐀z + m.def("bad_utf8_string", []() { return std::string("abc\xd0" "def"); }); + m.def("bad_utf16_string", [=]() { return std::u16string({ b16, char16_t(0xd800), z16 }); }); + // Under Python 2.7, invalid unicode UTF-32 characters don't appear to trigger UnicodeDecodeError + if (PY_MAJOR_VERSION >= 3) + m.def("bad_utf32_string", [=]() { return std::u32string({ a32, char32_t(0xd800), z32 }); }); + if (PY_MAJOR_VERSION >= 3 || sizeof(wchar_t) == 2) + m.def("bad_wchar_string", [=]() { return std::wstring({ wchar_t(0x61), wchar_t(0xd800) }); }); + m.def("u8_Z", []() -> char { return 'Z'; }); + m.def("u8_eacute", []() -> char { return '\xe9'; }); + m.def("u16_ibang", [=]() -> char16_t { return ib16; }); + m.def("u32_mathbfA", [=]() -> char32_t { return mathbfA32; }); + m.def("wchar_heart", []() -> wchar_t { return 0x2665; }); + + // test_single_char_arguments + m.attr("wchar_size") = py::cast(sizeof(wchar_t)); + m.def("ord_char", [](char c) -> int { return static_cast(c); }); + m.def("ord_char_lv", [](char &c) -> int { return static_cast(c); }); + m.def("ord_char16", [](char16_t c) -> uint16_t { return c; }); + m.def("ord_char16_lv", [](char16_t &c) -> uint16_t { return c; }); + m.def("ord_char32", [](char32_t c) -> uint32_t { return c; }); + m.def("ord_wchar", [](wchar_t c) -> int { return c; }); + + // test_bytes_to_string + m.def("strlen", [](char *s) { return strlen(s); }); + m.def("string_length", [](std::string s) { return s.length(); }); + + // test_string_view +#ifdef PYBIND11_HAS_STRING_VIEW + m.attr("has_string_view") = true; + m.def("string_view_print", [](std::string_view s) { py::print(s, s.size()); }); + m.def("string_view16_print", [](std::u16string_view s) { py::print(s, s.size()); }); + m.def("string_view32_print", [](std::u32string_view s) { py::print(s, s.size()); }); + m.def("string_view_chars", [](std::string_view s) { py::list l; for (auto c : s) l.append((std::uint8_t) c); return l; }); + m.def("string_view16_chars", [](std::u16string_view s) { py::list l; for (auto c : s) l.append((int) c); return l; }); + m.def("string_view32_chars", [](std::u32string_view s) { py::list l; for (auto c : s) l.append((int) c); return l; }); + m.def("string_view_return", []() { return std::string_view(u8"utf8 secret \U0001f382"); }); + m.def("string_view16_return", []() { return std::u16string_view(u"utf16 secret \U0001f382"); }); + m.def("string_view32_return", []() { return std::u32string_view(U"utf32 secret \U0001f382"); }); +#endif + + // test_integer_casting + m.def("i32_str", [](std::int32_t v) { return std::to_string(v); }); + m.def("u32_str", [](std::uint32_t v) { return std::to_string(v); }); + m.def("i64_str", [](std::int64_t v) { return std::to_string(v); }); + m.def("u64_str", [](std::uint64_t v) { return std::to_string(v); }); + + // test_tuple + m.def("pair_passthrough", [](std::pair input) { + return std::make_pair(input.second, input.first); + }, "Return a pair in reversed order"); + m.def("tuple_passthrough", [](std::tuple input) { + return std::make_tuple(std::get<2>(input), std::get<1>(input), std::get<0>(input)); + }, "Return a triple in reversed order"); + m.def("empty_tuple", []() { return std::tuple<>(); }); + static std::pair lvpair; + static std::tuple lvtuple; + static std::pair>> lvnested; + m.def("rvalue_pair", []() { return std::make_pair(RValueCaster{}, RValueCaster{}); }); + m.def("lvalue_pair", []() -> const decltype(lvpair) & { return lvpair; }); + m.def("rvalue_tuple", []() { return std::make_tuple(RValueCaster{}, RValueCaster{}, RValueCaster{}); }); + m.def("lvalue_tuple", []() -> const decltype(lvtuple) & { return lvtuple; }); + m.def("rvalue_nested", []() { + return std::make_pair(RValueCaster{}, std::make_tuple(RValueCaster{}, std::make_pair(RValueCaster{}, RValueCaster{}))); }); + m.def("lvalue_nested", []() -> const decltype(lvnested) & { return lvnested; }); + + // test_builtins_cast_return_none + m.def("return_none_string", []() -> std::string * { return nullptr; }); + m.def("return_none_char", []() -> const char * { return nullptr; }); + m.def("return_none_bool", []() -> bool * { return nullptr; }); + m.def("return_none_int", []() -> int * { return nullptr; }); + m.def("return_none_float", []() -> float * { return nullptr; }); + + // test_none_deferred + m.def("defer_none_cstring", [](char *) { return false; }); + m.def("defer_none_cstring", [](py::none) { return true; }); + m.def("defer_none_custom", [](UserType *) { return false; }); + m.def("defer_none_custom", [](py::none) { return true; }); + m.def("nodefer_none_void", [](void *) { return true; }); + m.def("nodefer_none_void", [](py::none) { return false; }); + + // test_void_caster + m.def("load_nullptr_t", [](std::nullptr_t) {}); // not useful, but it should still compile + m.def("cast_nullptr_t", []() { return std::nullptr_t{}; }); + + // test_bool_caster + m.def("bool_passthrough", [](bool arg) { return arg; }); + m.def("bool_passthrough_noconvert", [](bool arg) { return arg; }, py::arg().noconvert()); + + // test_reference_wrapper + m.def("refwrap_builtin", [](std::reference_wrapper p) { return 10 * p.get(); }); + m.def("refwrap_usertype", [](std::reference_wrapper p) { return p.get().value(); }); + // Not currently supported (std::pair caster has return-by-value cast operator); + // triggers static_assert failure. + //m.def("refwrap_pair", [](std::reference_wrapper>) { }); + + m.def("refwrap_list", [](bool copy) { + static IncType x1(1), x2(2); + py::list l; + for (auto &f : {std::ref(x1), std::ref(x2)}) { + l.append(py::cast(f, copy ? py::return_value_policy::copy + : py::return_value_policy::reference)); + } + return l; + }, "copy"_a); + + m.def("refwrap_iiw", [](const IncType &w) { return w.value(); }); + m.def("refwrap_call_iiw", [](IncType &w, py::function f) { + py::list l; + l.append(f(std::ref(w))); + l.append(f(std::cref(w))); + IncType x(w.value()); + l.append(f(std::ref(x))); + IncType y(w.value()); + auto r3 = std::ref(y); + l.append(f(r3)); + return l; + }); + + // test_complex + m.def("complex_cast", [](float x) { return "{}"_s.format(x); }); + m.def("complex_cast", [](std::complex x) { return "({}, {})"_s.format(x.real(), x.imag()); }); +} diff --git a/plugins/python/pybind11/tests/test_builtin_casters.py b/plugins/python/pybind11/tests/test_builtin_casters.py new file mode 100644 index 0000000..2f311f1 --- /dev/null +++ b/plugins/python/pybind11/tests/test_builtin_casters.py @@ -0,0 +1,325 @@ +# Python < 3 needs this: coding=utf-8 +import pytest + +from pybind11_tests import builtin_casters as m +from pybind11_tests import UserType, IncType + + +def test_simple_string(): + assert m.string_roundtrip("const char *") == "const char *" + + +def test_unicode_conversion(): + """Tests unicode conversion and error reporting.""" + assert m.good_utf8_string() == u"Say utf8‽ 🎂 𝐀" + assert m.good_utf16_string() == u"b‽🎂𝐀z" + assert m.good_utf32_string() == u"a𝐀🎂‽z" + assert m.good_wchar_string() == u"a⸘𝐀z" + + with pytest.raises(UnicodeDecodeError): + m.bad_utf8_string() + + with pytest.raises(UnicodeDecodeError): + m.bad_utf16_string() + + # These are provided only if they actually fail (they don't when 32-bit and under Python 2.7) + if hasattr(m, "bad_utf32_string"): + with pytest.raises(UnicodeDecodeError): + m.bad_utf32_string() + if hasattr(m, "bad_wchar_string"): + with pytest.raises(UnicodeDecodeError): + m.bad_wchar_string() + + assert m.u8_Z() == 'Z' + assert m.u8_eacute() == u'é' + assert m.u16_ibang() == u'‽' + assert m.u32_mathbfA() == u'𝐀' + assert m.wchar_heart() == u'♥' + + +def test_single_char_arguments(): + """Tests failures for passing invalid inputs to char-accepting functions""" + def toobig_message(r): + return "Character code point not in range({0:#x})".format(r) + toolong_message = "Expected a character, but multi-character string found" + + assert m.ord_char(u'a') == 0x61 # simple ASCII + assert m.ord_char_lv(u'b') == 0x62 + assert m.ord_char(u'é') == 0xE9 # requires 2 bytes in utf-8, but can be stuffed in a char + with pytest.raises(ValueError) as excinfo: + assert m.ord_char(u'Ā') == 0x100 # requires 2 bytes, doesn't fit in a char + assert str(excinfo.value) == toobig_message(0x100) + with pytest.raises(ValueError) as excinfo: + assert m.ord_char(u'ab') + assert str(excinfo.value) == toolong_message + + assert m.ord_char16(u'a') == 0x61 + assert m.ord_char16(u'é') == 0xE9 + assert m.ord_char16_lv(u'ê') == 0xEA + assert m.ord_char16(u'Ā') == 0x100 + assert m.ord_char16(u'‽') == 0x203d + assert m.ord_char16(u'♥') == 0x2665 + assert m.ord_char16_lv(u'♡') == 0x2661 + with pytest.raises(ValueError) as excinfo: + assert m.ord_char16(u'🎂') == 0x1F382 # requires surrogate pair + assert str(excinfo.value) == toobig_message(0x10000) + with pytest.raises(ValueError) as excinfo: + assert m.ord_char16(u'aa') + assert str(excinfo.value) == toolong_message + + assert m.ord_char32(u'a') == 0x61 + assert m.ord_char32(u'é') == 0xE9 + assert m.ord_char32(u'Ā') == 0x100 + assert m.ord_char32(u'‽') == 0x203d + assert m.ord_char32(u'♥') == 0x2665 + assert m.ord_char32(u'🎂') == 0x1F382 + with pytest.raises(ValueError) as excinfo: + assert m.ord_char32(u'aa') + assert str(excinfo.value) == toolong_message + + assert m.ord_wchar(u'a') == 0x61 + assert m.ord_wchar(u'é') == 0xE9 + assert m.ord_wchar(u'Ā') == 0x100 + assert m.ord_wchar(u'‽') == 0x203d + assert m.ord_wchar(u'♥') == 0x2665 + if m.wchar_size == 2: + with pytest.raises(ValueError) as excinfo: + assert m.ord_wchar(u'🎂') == 0x1F382 # requires surrogate pair + assert str(excinfo.value) == toobig_message(0x10000) + else: + assert m.ord_wchar(u'🎂') == 0x1F382 + with pytest.raises(ValueError) as excinfo: + assert m.ord_wchar(u'aa') + assert str(excinfo.value) == toolong_message + + +def test_bytes_to_string(): + """Tests the ability to pass bytes to C++ string-accepting functions. Note that this is + one-way: the only way to return bytes to Python is via the pybind11::bytes class.""" + # Issue #816 + import sys + byte = bytes if sys.version_info[0] < 3 else str + + assert m.strlen(byte("hi")) == 2 + assert m.string_length(byte("world")) == 5 + assert m.string_length(byte("a\x00b")) == 3 + assert m.strlen(byte("a\x00b")) == 1 # C-string limitation + + # passing in a utf8 encoded string should work + assert m.string_length(u'💩'.encode("utf8")) == 4 + + +@pytest.mark.skipif(not hasattr(m, "has_string_view"), reason="no ") +def test_string_view(capture): + """Tests support for C++17 string_view arguments and return values""" + assert m.string_view_chars("Hi") == [72, 105] + assert m.string_view_chars("Hi 🎂") == [72, 105, 32, 0xf0, 0x9f, 0x8e, 0x82] + assert m.string_view16_chars("Hi 🎂") == [72, 105, 32, 0xd83c, 0xdf82] + assert m.string_view32_chars("Hi 🎂") == [72, 105, 32, 127874] + + assert m.string_view_return() == "utf8 secret 🎂" + assert m.string_view16_return() == "utf16 secret 🎂" + assert m.string_view32_return() == "utf32 secret 🎂" + + with capture: + m.string_view_print("Hi") + m.string_view_print("utf8 🎂") + m.string_view16_print("utf16 🎂") + m.string_view32_print("utf32 🎂") + assert capture == """ + Hi 2 + utf8 🎂 9 + utf16 🎂 8 + utf32 🎂 7 + """ + + with capture: + m.string_view_print("Hi, ascii") + m.string_view_print("Hi, utf8 🎂") + m.string_view16_print("Hi, utf16 🎂") + m.string_view32_print("Hi, utf32 🎂") + assert capture == """ + Hi, ascii 9 + Hi, utf8 🎂 13 + Hi, utf16 🎂 12 + Hi, utf32 🎂 11 + """ + + +def test_integer_casting(): + """Issue #929 - out-of-range integer values shouldn't be accepted""" + import sys + assert m.i32_str(-1) == "-1" + assert m.i64_str(-1) == "-1" + assert m.i32_str(2000000000) == "2000000000" + assert m.u32_str(2000000000) == "2000000000" + if sys.version_info < (3,): + assert m.i32_str(long(-1)) == "-1" # noqa: F821 undefined name 'long' + assert m.i64_str(long(-1)) == "-1" # noqa: F821 undefined name 'long' + assert m.i64_str(long(-999999999999)) == "-999999999999" # noqa: F821 undefined name + assert m.u64_str(long(999999999999)) == "999999999999" # noqa: F821 undefined name 'long' + else: + assert m.i64_str(-999999999999) == "-999999999999" + assert m.u64_str(999999999999) == "999999999999" + + with pytest.raises(TypeError) as excinfo: + m.u32_str(-1) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.u64_str(-1) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.i32_str(-3000000000) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.i32_str(3000000000) + assert "incompatible function arguments" in str(excinfo.value) + + if sys.version_info < (3,): + with pytest.raises(TypeError) as excinfo: + m.u32_str(long(-1)) # noqa: F821 undefined name 'long' + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.u64_str(long(-1)) # noqa: F821 undefined name 'long' + assert "incompatible function arguments" in str(excinfo.value) + + +def test_tuple(doc): + """std::pair <-> tuple & std::tuple <-> tuple""" + assert m.pair_passthrough((True, "test")) == ("test", True) + assert m.tuple_passthrough((True, "test", 5)) == (5, "test", True) + # Any sequence can be cast to a std::pair or std::tuple + assert m.pair_passthrough([True, "test"]) == ("test", True) + assert m.tuple_passthrough([True, "test", 5]) == (5, "test", True) + assert m.empty_tuple() == () + + assert doc(m.pair_passthrough) == """ + pair_passthrough(arg0: Tuple[bool, str]) -> Tuple[str, bool] + + Return a pair in reversed order + """ + assert doc(m.tuple_passthrough) == """ + tuple_passthrough(arg0: Tuple[bool, str, int]) -> Tuple[int, str, bool] + + Return a triple in reversed order + """ + + assert m.rvalue_pair() == ("rvalue", "rvalue") + assert m.lvalue_pair() == ("lvalue", "lvalue") + assert m.rvalue_tuple() == ("rvalue", "rvalue", "rvalue") + assert m.lvalue_tuple() == ("lvalue", "lvalue", "lvalue") + assert m.rvalue_nested() == ("rvalue", ("rvalue", ("rvalue", "rvalue"))) + assert m.lvalue_nested() == ("lvalue", ("lvalue", ("lvalue", "lvalue"))) + + +def test_builtins_cast_return_none(): + """Casters produced with PYBIND11_TYPE_CASTER() should convert nullptr to None""" + assert m.return_none_string() is None + assert m.return_none_char() is None + assert m.return_none_bool() is None + assert m.return_none_int() is None + assert m.return_none_float() is None + + +def test_none_deferred(): + """None passed as various argument types should defer to other overloads""" + assert not m.defer_none_cstring("abc") + assert m.defer_none_cstring(None) + assert not m.defer_none_custom(UserType()) + assert m.defer_none_custom(None) + assert m.nodefer_none_void(None) + + +def test_void_caster(): + assert m.load_nullptr_t(None) is None + assert m.cast_nullptr_t() is None + + +def test_reference_wrapper(): + """std::reference_wrapper for builtin and user types""" + assert m.refwrap_builtin(42) == 420 + assert m.refwrap_usertype(UserType(42)) == 42 + + with pytest.raises(TypeError) as excinfo: + m.refwrap_builtin(None) + assert "incompatible function arguments" in str(excinfo.value) + + with pytest.raises(TypeError) as excinfo: + m.refwrap_usertype(None) + assert "incompatible function arguments" in str(excinfo.value) + + a1 = m.refwrap_list(copy=True) + a2 = m.refwrap_list(copy=True) + assert [x.value for x in a1] == [2, 3] + assert [x.value for x in a2] == [2, 3] + assert not a1[0] is a2[0] and not a1[1] is a2[1] + + b1 = m.refwrap_list(copy=False) + b2 = m.refwrap_list(copy=False) + assert [x.value for x in b1] == [1, 2] + assert [x.value for x in b2] == [1, 2] + assert b1[0] is b2[0] and b1[1] is b2[1] + + assert m.refwrap_iiw(IncType(5)) == 5 + assert m.refwrap_call_iiw(IncType(10), m.refwrap_iiw) == [10, 10, 10, 10] + + +def test_complex_cast(): + """std::complex casts""" + assert m.complex_cast(1) == "1.0" + assert m.complex_cast(2j) == "(0.0, 2.0)" + + +def test_bool_caster(): + """Test bool caster implicit conversions.""" + convert, noconvert = m.bool_passthrough, m.bool_passthrough_noconvert + + def require_implicit(v): + pytest.raises(TypeError, noconvert, v) + + def cant_convert(v): + pytest.raises(TypeError, convert, v) + + # straight up bool + assert convert(True) is True + assert convert(False) is False + assert noconvert(True) is True + assert noconvert(False) is False + + # None requires implicit conversion + require_implicit(None) + assert convert(None) is False + + class A(object): + def __init__(self, x): + self.x = x + + def __nonzero__(self): + return self.x + + def __bool__(self): + return self.x + + class B(object): + pass + + # Arbitrary objects are not accepted + cant_convert(object()) + cant_convert(B()) + + # Objects with __nonzero__ / __bool__ defined can be converted + require_implicit(A(True)) + assert convert(A(True)) is True + assert convert(A(False)) is False + + +@pytest.requires_numpy +def test_numpy_bool(): + import numpy as np + convert, noconvert = m.bool_passthrough, m.bool_passthrough_noconvert + + # np.bool_ is not considered implicit + assert convert(np.bool_(True)) is True + assert convert(np.bool_(False)) is False + assert noconvert(np.bool_(True)) is True + assert noconvert(np.bool_(False)) is False diff --git a/plugins/python/pybind11/tests/test_call_policies.cpp b/plugins/python/pybind11/tests/test_call_policies.cpp new file mode 100644 index 0000000..81fb170 --- /dev/null +++ b/plugins/python/pybind11/tests/test_call_policies.cpp @@ -0,0 +1,114 @@ +/* + tests/test_call_policies.cpp -- keep_alive and call_guard + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" + +struct CustomGuard { + static bool enabled; + + CustomGuard() { enabled = true; } + ~CustomGuard() { enabled = false; } + + static const char *report_status() { return enabled ? "guarded" : "unguarded"; } +}; +bool CustomGuard::enabled = false; + +struct DependentGuard { + static bool enabled; + + DependentGuard() { enabled = CustomGuard::enabled; } + ~DependentGuard() { enabled = false; } + + static const char *report_status() { return enabled ? "guarded" : "unguarded"; } +}; +bool DependentGuard::enabled = false; + +TEST_SUBMODULE(call_policies, m) { + // Parent/Child are used in: + // test_keep_alive_argument, test_keep_alive_return_value, test_alive_gc_derived, + // test_alive_gc_multi_derived, test_return_none, test_keep_alive_constructor + class Child { + public: + Child() { py::print("Allocating child."); } + ~Child() { py::print("Releasing child."); } + }; + py::class_(m, "Child") + .def(py::init<>()); + + class Parent { + public: + Parent() { py::print("Allocating parent."); } + ~Parent() { py::print("Releasing parent."); } + void addChild(Child *) { } + Child *returnChild() { return new Child(); } + Child *returnNullChild() { return nullptr; } + }; + py::class_(m, "Parent") + .def(py::init<>()) + .def(py::init([](Child *) { return new Parent(); }), py::keep_alive<1, 2>()) + .def("addChild", &Parent::addChild) + .def("addChildKeepAlive", &Parent::addChild, py::keep_alive<1, 2>()) + .def("returnChild", &Parent::returnChild) + .def("returnChildKeepAlive", &Parent::returnChild, py::keep_alive<1, 0>()) + .def("returnNullChildKeepAliveChild", &Parent::returnNullChild, py::keep_alive<1, 0>()) + .def("returnNullChildKeepAliveParent", &Parent::returnNullChild, py::keep_alive<0, 1>()); + + // test_keep_alive_single + m.def("add_patient", [](py::object /*nurse*/, py::object /*patient*/) { }, py::keep_alive<1, 2>()); + m.def("get_patients", [](py::object nurse) { + py::list patients; + for (PyObject *p : pybind11::detail::get_internals().patients[nurse.ptr()]) + patients.append(py::reinterpret_borrow(p)); + return patients; + }); + m.def("refcount", [](py::handle h) { +#ifdef PYPY_VERSION + ConstructorStats::gc(); // PyPy doesn't update ref counts until GC occurs +#endif + return h.ref_count(); + }); + +#if !defined(PYPY_VERSION) + // test_alive_gc + class ParentGC : public Parent { + public: + using Parent::Parent; + }; + py::class_(m, "ParentGC", py::dynamic_attr()) + .def(py::init<>()); +#endif + + // test_call_guard + m.def("unguarded_call", &CustomGuard::report_status); + m.def("guarded_call", &CustomGuard::report_status, py::call_guard()); + + m.def("multiple_guards_correct_order", []() { + return CustomGuard::report_status() + std::string(" & ") + DependentGuard::report_status(); + }, py::call_guard()); + + m.def("multiple_guards_wrong_order", []() { + return DependentGuard::report_status() + std::string(" & ") + CustomGuard::report_status(); + }, py::call_guard()); + +#if defined(WITH_THREAD) && !defined(PYPY_VERSION) + // `py::call_guard()` should work in PyPy as well, + // but it's unclear how to test it without `PyGILState_GetThisThreadState`. + auto report_gil_status = []() { + auto is_gil_held = false; + if (auto tstate = py::detail::get_thread_state_unchecked()) + is_gil_held = (tstate == PyGILState_GetThisThreadState()); + + return is_gil_held ? "GIL held" : "GIL released"; + }; + + m.def("with_gil", report_gil_status); + m.def("without_gil", report_gil_status, py::call_guard()); +#endif +} diff --git a/plugins/python/pybind11/tests/test_call_policies.py b/plugins/python/pybind11/tests/test_call_policies.py new file mode 100644 index 0000000..8d64afd --- /dev/null +++ b/plugins/python/pybind11/tests/test_call_policies.py @@ -0,0 +1,216 @@ +import pytest +from pybind11_tests import call_policies as m +from pybind11_tests import ConstructorStats, UserType + + +def test_keep_alive_argument(capture): + n_inst = ConstructorStats.detail_reg_inst() + with capture: + p = m.Parent() + assert capture == "Allocating parent." + with capture: + p.addChild(m.Child()) + assert ConstructorStats.detail_reg_inst() == n_inst + 1 + assert capture == """ + Allocating child. + Releasing child. + """ + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == "Releasing parent." + + with capture: + p = m.Parent() + assert capture == "Allocating parent." + with capture: + p.addChildKeepAlive(m.Child()) + assert ConstructorStats.detail_reg_inst() == n_inst + 2 + assert capture == "Allocating child." + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == """ + Releasing parent. + Releasing child. + """ + + +def test_keep_alive_return_value(capture): + n_inst = ConstructorStats.detail_reg_inst() + with capture: + p = m.Parent() + assert capture == "Allocating parent." + with capture: + p.returnChild() + assert ConstructorStats.detail_reg_inst() == n_inst + 1 + assert capture == """ + Allocating child. + Releasing child. + """ + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == "Releasing parent." + + with capture: + p = m.Parent() + assert capture == "Allocating parent." + with capture: + p.returnChildKeepAlive() + assert ConstructorStats.detail_reg_inst() == n_inst + 2 + assert capture == "Allocating child." + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == """ + Releasing parent. + Releasing child. + """ + + +def test_keep_alive_single(): + """Issue #1251 - patients are stored multiple times when given to the same nurse""" + + nurse, p1, p2 = UserType(), UserType(), UserType() + b = m.refcount(nurse) + assert [m.refcount(nurse), m.refcount(p1), m.refcount(p2)] == [b, b, b] + m.add_patient(nurse, p1) + assert m.get_patients(nurse) == [p1, ] + assert [m.refcount(nurse), m.refcount(p1), m.refcount(p2)] == [b, b + 1, b] + m.add_patient(nurse, p1) + assert m.get_patients(nurse) == [p1, ] + assert [m.refcount(nurse), m.refcount(p1), m.refcount(p2)] == [b, b + 1, b] + m.add_patient(nurse, p1) + assert m.get_patients(nurse) == [p1, ] + assert [m.refcount(nurse), m.refcount(p1), m.refcount(p2)] == [b, b + 1, b] + m.add_patient(nurse, p2) + assert m.get_patients(nurse) == [p1, p2] + assert [m.refcount(nurse), m.refcount(p1), m.refcount(p2)] == [b, b + 1, b + 1] + m.add_patient(nurse, p2) + assert m.get_patients(nurse) == [p1, p2] + assert [m.refcount(nurse), m.refcount(p1), m.refcount(p2)] == [b, b + 1, b + 1] + m.add_patient(nurse, p2) + m.add_patient(nurse, p1) + assert m.get_patients(nurse) == [p1, p2] + assert [m.refcount(nurse), m.refcount(p1), m.refcount(p2)] == [b, b + 1, b + 1] + del nurse + assert [m.refcount(p1), m.refcount(p2)] == [b, b] + + +# https://bitbucket.org/pypy/pypy/issues/2447 +@pytest.unsupported_on_pypy +def test_alive_gc(capture): + n_inst = ConstructorStats.detail_reg_inst() + p = m.ParentGC() + p.addChildKeepAlive(m.Child()) + assert ConstructorStats.detail_reg_inst() == n_inst + 2 + lst = [p] + lst.append(lst) # creates a circular reference + with capture: + del p, lst + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == """ + Releasing parent. + Releasing child. + """ + + +def test_alive_gc_derived(capture): + class Derived(m.Parent): + pass + + n_inst = ConstructorStats.detail_reg_inst() + p = Derived() + p.addChildKeepAlive(m.Child()) + assert ConstructorStats.detail_reg_inst() == n_inst + 2 + lst = [p] + lst.append(lst) # creates a circular reference + with capture: + del p, lst + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == """ + Releasing parent. + Releasing child. + """ + + +def test_alive_gc_multi_derived(capture): + class Derived(m.Parent, m.Child): + def __init__(self): + m.Parent.__init__(self) + m.Child.__init__(self) + + n_inst = ConstructorStats.detail_reg_inst() + p = Derived() + p.addChildKeepAlive(m.Child()) + # +3 rather than +2 because Derived corresponds to two registered instances + assert ConstructorStats.detail_reg_inst() == n_inst + 3 + lst = [p] + lst.append(lst) # creates a circular reference + with capture: + del p, lst + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == """ + Releasing parent. + Releasing child. + Releasing child. + """ + + +def test_return_none(capture): + n_inst = ConstructorStats.detail_reg_inst() + with capture: + p = m.Parent() + assert capture == "Allocating parent." + with capture: + p.returnNullChildKeepAliveChild() + assert ConstructorStats.detail_reg_inst() == n_inst + 1 + assert capture == "" + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == "Releasing parent." + + with capture: + p = m.Parent() + assert capture == "Allocating parent." + with capture: + p.returnNullChildKeepAliveParent() + assert ConstructorStats.detail_reg_inst() == n_inst + 1 + assert capture == "" + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == "Releasing parent." + + +def test_keep_alive_constructor(capture): + n_inst = ConstructorStats.detail_reg_inst() + + with capture: + p = m.Parent(m.Child()) + assert ConstructorStats.detail_reg_inst() == n_inst + 2 + assert capture == """ + Allocating child. + Allocating parent. + """ + with capture: + del p + assert ConstructorStats.detail_reg_inst() == n_inst + assert capture == """ + Releasing parent. + Releasing child. + """ + + +def test_call_guard(): + assert m.unguarded_call() == "unguarded" + assert m.guarded_call() == "guarded" + + assert m.multiple_guards_correct_order() == "guarded & guarded" + assert m.multiple_guards_wrong_order() == "unguarded & guarded" + + if hasattr(m, "with_gil"): + assert m.with_gil() == "GIL held" + assert m.without_gil() == "GIL released" diff --git a/plugins/python/pybind11/tests/test_callbacks.cpp b/plugins/python/pybind11/tests/test_callbacks.cpp new file mode 100644 index 0000000..273eacc --- /dev/null +++ b/plugins/python/pybind11/tests/test_callbacks.cpp @@ -0,0 +1,149 @@ +/* + tests/test_callbacks.cpp -- callbacks + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include + + +int dummy_function(int i) { return i + 1; } + +TEST_SUBMODULE(callbacks, m) { + // test_callbacks, test_function_signatures + m.def("test_callback1", [](py::object func) { return func(); }); + m.def("test_callback2", [](py::object func) { return func("Hello", 'x', true, 5); }); + m.def("test_callback3", [](const std::function &func) { + return "func(43) = " + std::to_string(func(43)); }); + m.def("test_callback4", []() -> std::function { return [](int i) { return i+1; }; }); + m.def("test_callback5", []() { + return py::cpp_function([](int i) { return i+1; }, py::arg("number")); + }); + + // test_keyword_args_and_generalized_unpacking + m.def("test_tuple_unpacking", [](py::function f) { + auto t1 = py::make_tuple(2, 3); + auto t2 = py::make_tuple(5, 6); + return f("positional", 1, *t1, 4, *t2); + }); + + m.def("test_dict_unpacking", [](py::function f) { + auto d1 = py::dict("key"_a="value", "a"_a=1); + auto d2 = py::dict(); + auto d3 = py::dict("b"_a=2); + return f("positional", 1, **d1, **d2, **d3); + }); + + m.def("test_keyword_args", [](py::function f) { + return f("x"_a=10, "y"_a=20); + }); + + m.def("test_unpacking_and_keywords1", [](py::function f) { + auto args = py::make_tuple(2); + auto kwargs = py::dict("d"_a=4); + return f(1, *args, "c"_a=3, **kwargs); + }); + + m.def("test_unpacking_and_keywords2", [](py::function f) { + auto kwargs1 = py::dict("a"_a=1); + auto kwargs2 = py::dict("c"_a=3, "d"_a=4); + return f("positional", *py::make_tuple(1), 2, *py::make_tuple(3, 4), 5, + "key"_a="value", **kwargs1, "b"_a=2, **kwargs2, "e"_a=5); + }); + + m.def("test_unpacking_error1", [](py::function f) { + auto kwargs = py::dict("x"_a=3); + return f("x"_a=1, "y"_a=2, **kwargs); // duplicate ** after keyword + }); + + m.def("test_unpacking_error2", [](py::function f) { + auto kwargs = py::dict("x"_a=3); + return f(**kwargs, "x"_a=1); // duplicate keyword after ** + }); + + m.def("test_arg_conversion_error1", [](py::function f) { + f(234, UnregisteredType(), "kw"_a=567); + }); + + m.def("test_arg_conversion_error2", [](py::function f) { + f(234, "expected_name"_a=UnregisteredType(), "kw"_a=567); + }); + + // test_lambda_closure_cleanup + struct Payload { + Payload() { print_default_created(this); } + ~Payload() { print_destroyed(this); } + Payload(const Payload &) { print_copy_created(this); } + Payload(Payload &&) { print_move_created(this); } + }; + // Export the payload constructor statistics for testing purposes: + m.def("payload_cstats", &ConstructorStats::get); + /* Test cleanup of lambda closure */ + m.def("test_cleanup", []() -> std::function { + Payload p; + + return [p]() { + /* p should be cleaned up when the returned function is garbage collected */ + (void) p; + }; + }); + + // test_cpp_function_roundtrip + /* Test if passing a function pointer from C++ -> Python -> C++ yields the original pointer */ + m.def("dummy_function", &dummy_function); + m.def("dummy_function2", [](int i, int j) { return i + j; }); + m.def("roundtrip", [](std::function f, bool expect_none = false) { + if (expect_none && f) + throw std::runtime_error("Expected None to be converted to empty std::function"); + return f; + }, py::arg("f"), py::arg("expect_none")=false); + m.def("test_dummy_function", [](const std::function &f) -> std::string { + using fn_type = int (*)(int); + auto result = f.target(); + if (!result) { + auto r = f(1); + return "can't convert to function pointer: eval(1) = " + std::to_string(r); + } else if (*result == dummy_function) { + auto r = (*result)(1); + return "matches dummy_function: eval(1) = " + std::to_string(r); + } else { + return "argument does NOT match dummy_function. This should never happen!"; + } + }); + + class AbstractBase { public: virtual unsigned int func() = 0; }; + m.def("func_accepting_func_accepting_base", [](std::function) { }); + + struct MovableObject { + bool valid = true; + + MovableObject() = default; + MovableObject(const MovableObject &) = default; + MovableObject &operator=(const MovableObject &) = default; + MovableObject(MovableObject &&o) : valid(o.valid) { o.valid = false; } + MovableObject &operator=(MovableObject &&o) { + valid = o.valid; + o.valid = false; + return *this; + } + }; + py::class_(m, "MovableObject"); + + // test_movable_object + m.def("callback_with_movable", [](std::function f) { + auto x = MovableObject(); + f(x); // lvalue reference shouldn't move out object + return x.valid; // must still return `true` + }); + + // test_bound_method_callback + struct CppBoundMethodTest {}; + py::class_(m, "CppBoundMethodTest") + .def(py::init<>()) + .def("triple", [](CppBoundMethodTest &, int val) { return 3 * val; }); +} diff --git a/plugins/python/pybind11/tests/test_callbacks.py b/plugins/python/pybind11/tests/test_callbacks.py new file mode 100644 index 0000000..93c42c2 --- /dev/null +++ b/plugins/python/pybind11/tests/test_callbacks.py @@ -0,0 +1,107 @@ +import pytest +from pybind11_tests import callbacks as m + + +def test_callbacks(): + from functools import partial + + def func1(): + return "func1" + + def func2(a, b, c, d): + return "func2", a, b, c, d + + def func3(a): + return "func3({})".format(a) + + assert m.test_callback1(func1) == "func1" + assert m.test_callback2(func2) == ("func2", "Hello", "x", True, 5) + assert m.test_callback1(partial(func2, 1, 2, 3, 4)) == ("func2", 1, 2, 3, 4) + assert m.test_callback1(partial(func3, "partial")) == "func3(partial)" + assert m.test_callback3(lambda i: i + 1) == "func(43) = 44" + + f = m.test_callback4() + assert f(43) == 44 + f = m.test_callback5() + assert f(number=43) == 44 + + +def test_bound_method_callback(): + # Bound Python method: + class MyClass: + def double(self, val): + return 2 * val + + z = MyClass() + assert m.test_callback3(z.double) == "func(43) = 86" + + z = m.CppBoundMethodTest() + assert m.test_callback3(z.triple) == "func(43) = 129" + + +def test_keyword_args_and_generalized_unpacking(): + + def f(*args, **kwargs): + return args, kwargs + + assert m.test_tuple_unpacking(f) == (("positional", 1, 2, 3, 4, 5, 6), {}) + assert m.test_dict_unpacking(f) == (("positional", 1), {"key": "value", "a": 1, "b": 2}) + assert m.test_keyword_args(f) == ((), {"x": 10, "y": 20}) + assert m.test_unpacking_and_keywords1(f) == ((1, 2), {"c": 3, "d": 4}) + assert m.test_unpacking_and_keywords2(f) == ( + ("positional", 1, 2, 3, 4, 5), + {"key": "value", "a": 1, "b": 2, "c": 3, "d": 4, "e": 5} + ) + + with pytest.raises(TypeError) as excinfo: + m.test_unpacking_error1(f) + assert "Got multiple values for keyword argument" in str(excinfo.value) + + with pytest.raises(TypeError) as excinfo: + m.test_unpacking_error2(f) + assert "Got multiple values for keyword argument" in str(excinfo.value) + + with pytest.raises(RuntimeError) as excinfo: + m.test_arg_conversion_error1(f) + assert "Unable to convert call argument" in str(excinfo.value) + + with pytest.raises(RuntimeError) as excinfo: + m.test_arg_conversion_error2(f) + assert "Unable to convert call argument" in str(excinfo.value) + + +def test_lambda_closure_cleanup(): + m.test_cleanup() + cstats = m.payload_cstats() + assert cstats.alive() == 0 + assert cstats.copy_constructions == 1 + assert cstats.move_constructions >= 1 + + +def test_cpp_function_roundtrip(): + """Test if passing a function pointer from C++ -> Python -> C++ yields the original pointer""" + + assert m.test_dummy_function(m.dummy_function) == "matches dummy_function: eval(1) = 2" + assert (m.test_dummy_function(m.roundtrip(m.dummy_function)) == + "matches dummy_function: eval(1) = 2") + assert m.roundtrip(None, expect_none=True) is None + assert (m.test_dummy_function(lambda x: x + 2) == + "can't convert to function pointer: eval(1) = 3") + + with pytest.raises(TypeError) as excinfo: + m.test_dummy_function(m.dummy_function2) + assert "incompatible function arguments" in str(excinfo.value) + + with pytest.raises(TypeError) as excinfo: + m.test_dummy_function(lambda x, y: x + y) + assert any(s in str(excinfo.value) for s in ("missing 1 required positional argument", + "takes exactly 2 arguments")) + + +def test_function_signatures(doc): + assert doc(m.test_callback3) == "test_callback3(arg0: Callable[[int], int]) -> str" + assert doc(m.test_callback4) == "test_callback4() -> Callable[[int], int]" + + +def test_movable_object(): + assert m.callback_with_movable(lambda _: None) is True diff --git a/plugins/python/pybind11/tests/test_chrono.cpp b/plugins/python/pybind11/tests/test_chrono.cpp new file mode 100644 index 0000000..195a93b --- /dev/null +++ b/plugins/python/pybind11/tests/test_chrono.cpp @@ -0,0 +1,47 @@ +/* + tests/test_chrono.cpp -- test conversions to/from std::chrono types + + Copyright (c) 2016 Trent Houliston and + Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include + +TEST_SUBMODULE(chrono, m) { + using system_time = std::chrono::system_clock::time_point; + using steady_time = std::chrono::steady_clock::time_point; + // test_chrono_system_clock + // Return the current time off the wall clock + m.def("test_chrono1", []() { return std::chrono::system_clock::now(); }); + + // test_chrono_system_clock_roundtrip + // Round trip the passed in system clock time + m.def("test_chrono2", [](system_time t) { return t; }); + + // test_chrono_duration_roundtrip + // Round trip the passed in duration + m.def("test_chrono3", [](std::chrono::system_clock::duration d) { return d; }); + + // test_chrono_duration_subtraction_equivalence + // Difference between two passed in time_points + m.def("test_chrono4", [](system_time a, system_time b) { return a - b; }); + + // test_chrono_steady_clock + // Return the current time off the steady_clock + m.def("test_chrono5", []() { return std::chrono::steady_clock::now(); }); + + // test_chrono_steady_clock_roundtrip + // Round trip a steady clock timepoint + m.def("test_chrono6", [](steady_time t) { return t; }); + + // test_floating_point_duration + // Roundtrip a duration in microseconds from a float argument + m.def("test_chrono7", [](std::chrono::microseconds t) { return t; }); + // Float durations (issue #719) + m.def("test_chrono_float_diff", [](std::chrono::duration a, std::chrono::duration b) { + return a - b; }); +} diff --git a/plugins/python/pybind11/tests/test_chrono.py b/plugins/python/pybind11/tests/test_chrono.py new file mode 100644 index 0000000..2b75bd1 --- /dev/null +++ b/plugins/python/pybind11/tests/test_chrono.py @@ -0,0 +1,101 @@ +from pybind11_tests import chrono as m +import datetime + + +def test_chrono_system_clock(): + + # Get the time from both c++ and datetime + date1 = m.test_chrono1() + date2 = datetime.datetime.today() + + # The returned value should be a datetime + assert isinstance(date1, datetime.datetime) + + # The numbers should vary by a very small amount (time it took to execute) + diff = abs(date1 - date2) + + # There should never be a days/seconds difference + assert diff.days == 0 + assert diff.seconds == 0 + + # We test that no more than about 0.5 seconds passes here + # This makes sure that the dates created are very close to the same + # but if the testing system is incredibly overloaded this should still pass + assert diff.microseconds < 500000 + + +def test_chrono_system_clock_roundtrip(): + date1 = datetime.datetime.today() + + # Roundtrip the time + date2 = m.test_chrono2(date1) + + # The returned value should be a datetime + assert isinstance(date2, datetime.datetime) + + # They should be identical (no information lost on roundtrip) + diff = abs(date1 - date2) + assert diff.days == 0 + assert diff.seconds == 0 + assert diff.microseconds == 0 + + +def test_chrono_duration_roundtrip(): + + # Get the difference between two times (a timedelta) + date1 = datetime.datetime.today() + date2 = datetime.datetime.today() + diff = date2 - date1 + + # Make sure this is a timedelta + assert isinstance(diff, datetime.timedelta) + + cpp_diff = m.test_chrono3(diff) + + assert cpp_diff.days == diff.days + assert cpp_diff.seconds == diff.seconds + assert cpp_diff.microseconds == diff.microseconds + + +def test_chrono_duration_subtraction_equivalence(): + + date1 = datetime.datetime.today() + date2 = datetime.datetime.today() + + diff = date2 - date1 + cpp_diff = m.test_chrono4(date2, date1) + + assert cpp_diff.days == diff.days + assert cpp_diff.seconds == diff.seconds + assert cpp_diff.microseconds == diff.microseconds + + +def test_chrono_steady_clock(): + time1 = m.test_chrono5() + assert isinstance(time1, datetime.timedelta) + + +def test_chrono_steady_clock_roundtrip(): + time1 = datetime.timedelta(days=10, seconds=10, microseconds=100) + time2 = m.test_chrono6(time1) + + assert isinstance(time2, datetime.timedelta) + + # They should be identical (no information lost on roundtrip) + assert time1.days == time2.days + assert time1.seconds == time2.seconds + assert time1.microseconds == time2.microseconds + + +def test_floating_point_duration(): + # Test using a floating point number in seconds + time = m.test_chrono7(35.525123) + + assert isinstance(time, datetime.timedelta) + + assert time.seconds == 35 + assert 525122 <= time.microseconds <= 525123 + + diff = m.test_chrono_float_diff(43.789012, 1.123456) + assert diff.seconds == 42 + assert 665556 <= diff.microseconds <= 665557 diff --git a/plugins/python/pybind11/tests/test_class.cpp b/plugins/python/pybind11/tests/test_class.cpp new file mode 100644 index 0000000..f0b5873 --- /dev/null +++ b/plugins/python/pybind11/tests/test_class.cpp @@ -0,0 +1,388 @@ +/* + tests/test_class.cpp -- test py::class_ definitions and basic functionality + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include "local_bindings.h" +#include + +// test_brace_initialization +struct NoBraceInitialization { + NoBraceInitialization(std::vector v) : vec{std::move(v)} {} + template + NoBraceInitialization(std::initializer_list l) : vec(l) {} + + std::vector vec; +}; + +TEST_SUBMODULE(class_, m) { + // test_instance + struct NoConstructor { + static NoConstructor *new_instance() { + auto *ptr = new NoConstructor(); + print_created(ptr, "via new_instance"); + return ptr; + } + ~NoConstructor() { print_destroyed(this); } + }; + + py::class_(m, "NoConstructor") + .def_static("new_instance", &NoConstructor::new_instance, "Return an instance"); + + // test_inheritance + class Pet { + public: + Pet(const std::string &name, const std::string &species) + : m_name(name), m_species(species) {} + std::string name() const { return m_name; } + std::string species() const { return m_species; } + private: + std::string m_name; + std::string m_species; + }; + + class Dog : public Pet { + public: + Dog(const std::string &name) : Pet(name, "dog") {} + std::string bark() const { return "Woof!"; } + }; + + class Rabbit : public Pet { + public: + Rabbit(const std::string &name) : Pet(name, "parrot") {} + }; + + class Hamster : public Pet { + public: + Hamster(const std::string &name) : Pet(name, "rodent") {} + }; + + class Chimera : public Pet { + Chimera() : Pet("Kimmy", "chimera") {} + }; + + py::class_ pet_class(m, "Pet"); + pet_class + .def(py::init()) + .def("name", &Pet::name) + .def("species", &Pet::species); + + /* One way of declaring a subclass relationship: reference parent's class_ object */ + py::class_(m, "Dog", pet_class) + .def(py::init()); + + /* Another way of declaring a subclass relationship: reference parent's C++ type */ + py::class_(m, "Rabbit") + .def(py::init()); + + /* And another: list parent in class template arguments */ + py::class_(m, "Hamster") + .def(py::init()); + + /* Constructors are not inherited by default */ + py::class_(m, "Chimera"); + + m.def("pet_name_species", [](const Pet &pet) { return pet.name() + " is a " + pet.species(); }); + m.def("dog_bark", [](const Dog &dog) { return dog.bark(); }); + + // test_automatic_upcasting + struct BaseClass { virtual ~BaseClass() {} }; + struct DerivedClass1 : BaseClass { }; + struct DerivedClass2 : BaseClass { }; + + py::class_(m, "BaseClass").def(py::init<>()); + py::class_(m, "DerivedClass1").def(py::init<>()); + py::class_(m, "DerivedClass2").def(py::init<>()); + + m.def("return_class_1", []() -> BaseClass* { return new DerivedClass1(); }); + m.def("return_class_2", []() -> BaseClass* { return new DerivedClass2(); }); + m.def("return_class_n", [](int n) -> BaseClass* { + if (n == 1) return new DerivedClass1(); + if (n == 2) return new DerivedClass2(); + return new BaseClass(); + }); + m.def("return_none", []() -> BaseClass* { return nullptr; }); + + // test_isinstance + m.def("check_instances", [](py::list l) { + return py::make_tuple( + py::isinstance(l[0]), + py::isinstance(l[1]), + py::isinstance(l[2]), + py::isinstance(l[3]), + py::isinstance(l[4]), + py::isinstance(l[5]), + py::isinstance(l[6]) + ); + }); + + // test_mismatched_holder + struct MismatchBase1 { }; + struct MismatchDerived1 : MismatchBase1 { }; + + struct MismatchBase2 { }; + struct MismatchDerived2 : MismatchBase2 { }; + + m.def("mismatched_holder_1", []() { + auto mod = py::module::import("__main__"); + py::class_>(mod, "MismatchBase1"); + py::class_(mod, "MismatchDerived1"); + }); + m.def("mismatched_holder_2", []() { + auto mod = py::module::import("__main__"); + py::class_(mod, "MismatchBase2"); + py::class_, + MismatchBase2>(mod, "MismatchDerived2"); + }); + + // test_override_static + // #511: problem with inheritance + overwritten def_static + struct MyBase { + static std::unique_ptr make() { + return std::unique_ptr(new MyBase()); + } + }; + + struct MyDerived : MyBase { + static std::unique_ptr make() { + return std::unique_ptr(new MyDerived()); + } + }; + + py::class_(m, "MyBase") + .def_static("make", &MyBase::make); + + py::class_(m, "MyDerived") + .def_static("make", &MyDerived::make) + .def_static("make2", &MyDerived::make); + + // test_implicit_conversion_life_support + struct ConvertibleFromUserType { + int i; + + ConvertibleFromUserType(UserType u) : i(u.value()) { } + }; + + py::class_(m, "AcceptsUserType") + .def(py::init()); + py::implicitly_convertible(); + + m.def("implicitly_convert_argument", [](const ConvertibleFromUserType &r) { return r.i; }); + m.def("implicitly_convert_variable", [](py::object o) { + // `o` is `UserType` and `r` is a reference to a temporary created by implicit + // conversion. This is valid when called inside a bound function because the temp + // object is attached to the same life support system as the arguments. + const auto &r = o.cast(); + return r.i; + }); + m.add_object("implicitly_convert_variable_fail", [&] { + auto f = [](PyObject *, PyObject *args) -> PyObject * { + auto o = py::reinterpret_borrow(args)[0]; + try { // It should fail here because there is no life support. + o.cast(); + } catch (const py::cast_error &e) { + return py::str(e.what()).release().ptr(); + } + return py::str().release().ptr(); + }; + + auto def = new PyMethodDef{"f", f, METH_VARARGS, nullptr}; + return py::reinterpret_steal(PyCFunction_NewEx(def, nullptr, m.ptr())); + }()); + + // test_operator_new_delete + struct HasOpNewDel { + std::uint64_t i; + static void *operator new(size_t s) { py::print("A new", s); return ::operator new(s); } + static void *operator new(size_t s, void *ptr) { py::print("A placement-new", s); return ptr; } + static void operator delete(void *p) { py::print("A delete"); return ::operator delete(p); } + }; + struct HasOpNewDelSize { + std::uint32_t i; + static void *operator new(size_t s) { py::print("B new", s); return ::operator new(s); } + static void *operator new(size_t s, void *ptr) { py::print("B placement-new", s); return ptr; } + static void operator delete(void *p, size_t s) { py::print("B delete", s); return ::operator delete(p); } + }; + struct AliasedHasOpNewDelSize { + std::uint64_t i; + static void *operator new(size_t s) { py::print("C new", s); return ::operator new(s); } + static void *operator new(size_t s, void *ptr) { py::print("C placement-new", s); return ptr; } + static void operator delete(void *p, size_t s) { py::print("C delete", s); return ::operator delete(p); } + virtual ~AliasedHasOpNewDelSize() = default; + }; + struct PyAliasedHasOpNewDelSize : AliasedHasOpNewDelSize { + PyAliasedHasOpNewDelSize() = default; + PyAliasedHasOpNewDelSize(int) { } + std::uint64_t j; + }; + struct HasOpNewDelBoth { + std::uint32_t i[8]; + static void *operator new(size_t s) { py::print("D new", s); return ::operator new(s); } + static void *operator new(size_t s, void *ptr) { py::print("D placement-new", s); return ptr; } + static void operator delete(void *p) { py::print("D delete"); return ::operator delete(p); } + static void operator delete(void *p, size_t s) { py::print("D wrong delete", s); return ::operator delete(p); } + }; + py::class_(m, "HasOpNewDel").def(py::init<>()); + py::class_(m, "HasOpNewDelSize").def(py::init<>()); + py::class_(m, "HasOpNewDelBoth").def(py::init<>()); + py::class_ aliased(m, "AliasedHasOpNewDelSize"); + aliased.def(py::init<>()); + aliased.attr("size_noalias") = py::int_(sizeof(AliasedHasOpNewDelSize)); + aliased.attr("size_alias") = py::int_(sizeof(PyAliasedHasOpNewDelSize)); + + // This test is actually part of test_local_bindings (test_duplicate_local), but we need a + // definition in a different compilation unit within the same module: + bind_local(m, "LocalExternal", py::module_local()); + + // test_bind_protected_functions + class ProtectedA { + protected: + int foo() const { return value; } + + private: + int value = 42; + }; + + class PublicistA : public ProtectedA { + public: + using ProtectedA::foo; + }; + + py::class_(m, "ProtectedA") + .def(py::init<>()) +#if !defined(_MSC_VER) || _MSC_VER >= 1910 + .def("foo", &PublicistA::foo); +#else + .def("foo", static_cast(&PublicistA::foo)); +#endif + + class ProtectedB { + public: + virtual ~ProtectedB() = default; + + protected: + virtual int foo() const { return value; } + + private: + int value = 42; + }; + + class TrampolineB : public ProtectedB { + public: + int foo() const override { PYBIND11_OVERLOAD(int, ProtectedB, foo, ); } + }; + + class PublicistB : public ProtectedB { + public: + using ProtectedB::foo; + }; + + py::class_(m, "ProtectedB") + .def(py::init<>()) +#if !defined(_MSC_VER) || _MSC_VER >= 1910 + .def("foo", &PublicistB::foo); +#else + .def("foo", static_cast(&PublicistB::foo)); +#endif + + // test_brace_initialization + struct BraceInitialization { + int field1; + std::string field2; + }; + + py::class_(m, "BraceInitialization") + .def(py::init()) + .def_readwrite("field1", &BraceInitialization::field1) + .def_readwrite("field2", &BraceInitialization::field2); + // We *don't* want to construct using braces when the given constructor argument maps to a + // constructor, because brace initialization could go to the wrong place (in particular when + // there is also an `initializer_list`-accept constructor): + py::class_(m, "NoBraceInitialization") + .def(py::init>()) + .def_readonly("vec", &NoBraceInitialization::vec); + + // test_reentrant_implicit_conversion_failure + // #1035: issue with runaway reentrant implicit conversion + struct BogusImplicitConversion { + BogusImplicitConversion(const BogusImplicitConversion &) { } + }; + + py::class_(m, "BogusImplicitConversion") + .def(py::init()); + + py::implicitly_convertible(); + + // test_qualname + // #1166: nested class docstring doesn't show nested name + // Also related: tests that __qualname__ is set properly + struct NestBase {}; + struct Nested {}; + py::class_ base(m, "NestBase"); + base.def(py::init<>()); + py::class_(base, "Nested") + .def(py::init<>()) + .def("fn", [](Nested &, int, NestBase &, Nested &) {}) + .def("fa", [](Nested &, int, NestBase &, Nested &) {}, + "a"_a, "b"_a, "c"_a); + base.def("g", [](NestBase &, Nested &) {}); + base.def("h", []() { return NestBase(); }); +} + +template class BreaksBase { public: virtual ~BreaksBase() = default; }; +template class BreaksTramp : public BreaksBase {}; +// These should all compile just fine: +typedef py::class_, std::unique_ptr>, BreaksTramp<1>> DoesntBreak1; +typedef py::class_, BreaksTramp<2>, std::unique_ptr>> DoesntBreak2; +typedef py::class_, std::unique_ptr>> DoesntBreak3; +typedef py::class_, BreaksTramp<4>> DoesntBreak4; +typedef py::class_> DoesntBreak5; +typedef py::class_, std::shared_ptr>, BreaksTramp<6>> DoesntBreak6; +typedef py::class_, BreaksTramp<7>, std::shared_ptr>> DoesntBreak7; +typedef py::class_, std::shared_ptr>> DoesntBreak8; +#define CHECK_BASE(N) static_assert(std::is_same>::value, \ + "DoesntBreak" #N " has wrong type!") +CHECK_BASE(1); CHECK_BASE(2); CHECK_BASE(3); CHECK_BASE(4); CHECK_BASE(5); CHECK_BASE(6); CHECK_BASE(7); CHECK_BASE(8); +#define CHECK_ALIAS(N) static_assert(DoesntBreak##N::has_alias && std::is_same>::value, \ + "DoesntBreak" #N " has wrong type_alias!") +#define CHECK_NOALIAS(N) static_assert(!DoesntBreak##N::has_alias && std::is_void::value, \ + "DoesntBreak" #N " has type alias, but shouldn't!") +CHECK_ALIAS(1); CHECK_ALIAS(2); CHECK_NOALIAS(3); CHECK_ALIAS(4); CHECK_NOALIAS(5); CHECK_ALIAS(6); CHECK_ALIAS(7); CHECK_NOALIAS(8); +#define CHECK_HOLDER(N, TYPE) static_assert(std::is_same>>::value, \ + "DoesntBreak" #N " has wrong holder_type!") +CHECK_HOLDER(1, unique); CHECK_HOLDER(2, unique); CHECK_HOLDER(3, unique); CHECK_HOLDER(4, unique); CHECK_HOLDER(5, unique); +CHECK_HOLDER(6, shared); CHECK_HOLDER(7, shared); CHECK_HOLDER(8, shared); + +// There's no nice way to test that these fail because they fail to compile; leave them here, +// though, so that they can be manually tested by uncommenting them (and seeing that compilation +// failures occurs). + +// We have to actually look into the type: the typedef alone isn't enough to instantiate the type: +#define CHECK_BROKEN(N) static_assert(std::is_same>::value, \ + "Breaks1 has wrong type!"); + +//// Two holder classes: +//typedef py::class_, std::unique_ptr>, std::unique_ptr>> Breaks1; +//CHECK_BROKEN(1); +//// Two aliases: +//typedef py::class_, BreaksTramp<-2>, BreaksTramp<-2>> Breaks2; +//CHECK_BROKEN(2); +//// Holder + 2 aliases +//typedef py::class_, std::unique_ptr>, BreaksTramp<-3>, BreaksTramp<-3>> Breaks3; +//CHECK_BROKEN(3); +//// Alias + 2 holders +//typedef py::class_, std::unique_ptr>, BreaksTramp<-4>, std::shared_ptr>> Breaks4; +//CHECK_BROKEN(4); +//// Invalid option (not a subclass or holder) +//typedef py::class_, BreaksTramp<-4>> Breaks5; +//CHECK_BROKEN(5); +//// Invalid option: multiple inheritance not supported: +//template <> struct BreaksBase<-8> : BreaksBase<-6>, BreaksBase<-7> {}; +//typedef py::class_, BreaksBase<-6>, BreaksBase<-7>> Breaks8; +//CHECK_BROKEN(8); diff --git a/plugins/python/pybind11/tests/test_class.py b/plugins/python/pybind11/tests/test_class.py new file mode 100644 index 0000000..8cf4757 --- /dev/null +++ b/plugins/python/pybind11/tests/test_class.py @@ -0,0 +1,268 @@ +import pytest + +from pybind11_tests import class_ as m +from pybind11_tests import UserType, ConstructorStats + + +def test_repr(): + # In Python 3.3+, repr() accesses __qualname__ + assert "pybind11_type" in repr(type(UserType)) + assert "UserType" in repr(UserType) + + +def test_instance(msg): + with pytest.raises(TypeError) as excinfo: + m.NoConstructor() + assert msg(excinfo.value) == "m.class_.NoConstructor: No constructor defined!" + + instance = m.NoConstructor.new_instance() + + cstats = ConstructorStats.get(m.NoConstructor) + assert cstats.alive() == 1 + del instance + assert cstats.alive() == 0 + + +def test_docstrings(doc): + assert doc(UserType) == "A `py::class_` type for testing" + assert UserType.__name__ == "UserType" + assert UserType.__module__ == "pybind11_tests" + assert UserType.get_value.__name__ == "get_value" + assert UserType.get_value.__module__ == "pybind11_tests" + + assert doc(UserType.get_value) == """ + get_value(self: m.UserType) -> int + + Get value using a method + """ + assert doc(UserType.value) == "Get/set value using a property" + + assert doc(m.NoConstructor.new_instance) == """ + new_instance() -> m.class_.NoConstructor + + Return an instance + """ + + +def test_qualname(doc): + """Tests that a properly qualified name is set in __qualname__ (even in pre-3.3, where we + backport the attribute) and that generated docstrings properly use it and the module name""" + assert m.NestBase.__qualname__ == "NestBase" + assert m.NestBase.Nested.__qualname__ == "NestBase.Nested" + + assert doc(m.NestBase.__init__) == """ + __init__(self: m.class_.NestBase) -> None + """ + assert doc(m.NestBase.g) == """ + g(self: m.class_.NestBase, arg0: m.class_.NestBase.Nested) -> None + """ + assert doc(m.NestBase.Nested.__init__) == """ + __init__(self: m.class_.NestBase.Nested) -> None + """ + assert doc(m.NestBase.Nested.fn) == """ + fn(self: m.class_.NestBase.Nested, arg0: int, arg1: m.class_.NestBase, arg2: m.class_.NestBase.Nested) -> None + """ # noqa: E501 line too long + assert doc(m.NestBase.Nested.fa) == """ + fa(self: m.class_.NestBase.Nested, a: int, b: m.class_.NestBase, c: m.class_.NestBase.Nested) -> None + """ # noqa: E501 line too long + assert m.NestBase.__module__ == "pybind11_tests.class_" + assert m.NestBase.Nested.__module__ == "pybind11_tests.class_" + + +def test_inheritance(msg): + roger = m.Rabbit('Rabbit') + assert roger.name() + " is a " + roger.species() == "Rabbit is a parrot" + assert m.pet_name_species(roger) == "Rabbit is a parrot" + + polly = m.Pet('Polly', 'parrot') + assert polly.name() + " is a " + polly.species() == "Polly is a parrot" + assert m.pet_name_species(polly) == "Polly is a parrot" + + molly = m.Dog('Molly') + assert molly.name() + " is a " + molly.species() == "Molly is a dog" + assert m.pet_name_species(molly) == "Molly is a dog" + + fred = m.Hamster('Fred') + assert fred.name() + " is a " + fred.species() == "Fred is a rodent" + + assert m.dog_bark(molly) == "Woof!" + + with pytest.raises(TypeError) as excinfo: + m.dog_bark(polly) + assert msg(excinfo.value) == """ + dog_bark(): incompatible function arguments. The following argument types are supported: + 1. (arg0: m.class_.Dog) -> str + + Invoked with: + """ + + with pytest.raises(TypeError) as excinfo: + m.Chimera("lion", "goat") + assert "No constructor defined!" in str(excinfo.value) + + +def test_automatic_upcasting(): + assert type(m.return_class_1()).__name__ == "DerivedClass1" + assert type(m.return_class_2()).__name__ == "DerivedClass2" + assert type(m.return_none()).__name__ == "NoneType" + # Repeat these a few times in a random order to ensure no invalid caching is applied + assert type(m.return_class_n(1)).__name__ == "DerivedClass1" + assert type(m.return_class_n(2)).__name__ == "DerivedClass2" + assert type(m.return_class_n(0)).__name__ == "BaseClass" + assert type(m.return_class_n(2)).__name__ == "DerivedClass2" + assert type(m.return_class_n(2)).__name__ == "DerivedClass2" + assert type(m.return_class_n(0)).__name__ == "BaseClass" + assert type(m.return_class_n(1)).__name__ == "DerivedClass1" + + +def test_isinstance(): + objects = [tuple(), dict(), m.Pet("Polly", "parrot")] + [m.Dog("Molly")] * 4 + expected = (True, True, True, True, True, False, False) + assert m.check_instances(objects) == expected + + +def test_mismatched_holder(): + import re + + with pytest.raises(RuntimeError) as excinfo: + m.mismatched_holder_1() + assert re.match('generic_type: type ".*MismatchDerived1" does not have a non-default ' + 'holder type while its base ".*MismatchBase1" does', str(excinfo.value)) + + with pytest.raises(RuntimeError) as excinfo: + m.mismatched_holder_2() + assert re.match('generic_type: type ".*MismatchDerived2" has a non-default holder type ' + 'while its base ".*MismatchBase2" does not', str(excinfo.value)) + + +def test_override_static(): + """#511: problem with inheritance + overwritten def_static""" + b = m.MyBase.make() + d1 = m.MyDerived.make2() + d2 = m.MyDerived.make() + + assert isinstance(b, m.MyBase) + assert isinstance(d1, m.MyDerived) + assert isinstance(d2, m.MyDerived) + + +def test_implicit_conversion_life_support(): + """Ensure the lifetime of temporary objects created for implicit conversions""" + assert m.implicitly_convert_argument(UserType(5)) == 5 + assert m.implicitly_convert_variable(UserType(5)) == 5 + + assert "outside a bound function" in m.implicitly_convert_variable_fail(UserType(5)) + + +def test_operator_new_delete(capture): + """Tests that class-specific operator new/delete functions are invoked""" + + class SubAliased(m.AliasedHasOpNewDelSize): + pass + + with capture: + a = m.HasOpNewDel() + b = m.HasOpNewDelSize() + d = m.HasOpNewDelBoth() + assert capture == """ + A new 8 + B new 4 + D new 32 + """ + sz_alias = str(m.AliasedHasOpNewDelSize.size_alias) + sz_noalias = str(m.AliasedHasOpNewDelSize.size_noalias) + with capture: + c = m.AliasedHasOpNewDelSize() + c2 = SubAliased() + assert capture == ( + "C new " + sz_noalias + "\n" + + "C new " + sz_alias + "\n" + ) + + with capture: + del a + pytest.gc_collect() + del b + pytest.gc_collect() + del d + pytest.gc_collect() + assert capture == """ + A delete + B delete 4 + D delete + """ + + with capture: + del c + pytest.gc_collect() + del c2 + pytest.gc_collect() + assert capture == ( + "C delete " + sz_noalias + "\n" + + "C delete " + sz_alias + "\n" + ) + + +def test_bind_protected_functions(): + """Expose protected member functions to Python using a helper class""" + a = m.ProtectedA() + assert a.foo() == 42 + + b = m.ProtectedB() + assert b.foo() == 42 + + class C(m.ProtectedB): + def __init__(self): + m.ProtectedB.__init__(self) + + def foo(self): + return 0 + + c = C() + assert c.foo() == 0 + + +def test_brace_initialization(): + """ Tests that simple POD classes can be constructed using C++11 brace initialization """ + a = m.BraceInitialization(123, "test") + assert a.field1 == 123 + assert a.field2 == "test" + + # Tests that a non-simple class doesn't get brace initialization (if the + # class defines an initializer_list constructor, in particular, it would + # win over the expected constructor). + b = m.NoBraceInitialization([123, 456]) + assert b.vec == [123, 456] + + +@pytest.unsupported_on_pypy +def test_class_refcount(): + """Instances must correctly increase/decrease the reference count of their types (#1029)""" + from sys import getrefcount + + class PyDog(m.Dog): + pass + + for cls in m.Dog, PyDog: + refcount_1 = getrefcount(cls) + molly = [cls("Molly") for _ in range(10)] + refcount_2 = getrefcount(cls) + + del molly + pytest.gc_collect() + refcount_3 = getrefcount(cls) + + assert refcount_1 == refcount_3 + assert refcount_2 > refcount_1 + + +def test_reentrant_implicit_conversion_failure(msg): + # ensure that there is no runaway reentrant implicit conversion (#1035) + with pytest.raises(TypeError) as excinfo: + m.BogusImplicitConversion(0) + assert msg(excinfo.value) == ''' + __init__(): incompatible constructor arguments. The following argument types are supported: + 1. m.class_.BogusImplicitConversion(arg0: m.class_.BogusImplicitConversion) + + Invoked with: 0 + ''' diff --git a/plugins/python/pybind11/tests/test_cmake_build/CMakeLists.txt b/plugins/python/pybind11/tests/test_cmake_build/CMakeLists.txt new file mode 100644 index 0000000..c9b5fcb --- /dev/null +++ b/plugins/python/pybind11/tests/test_cmake_build/CMakeLists.txt @@ -0,0 +1,58 @@ +add_custom_target(test_cmake_build) + +if(CMAKE_VERSION VERSION_LESS 3.1) + # 3.0 needed for interface library for subdirectory_target/installed_target + # 3.1 needed for cmake -E env for testing + return() +endif() + +include(CMakeParseArguments) +function(pybind11_add_build_test name) + cmake_parse_arguments(ARG "INSTALL" "" "" ${ARGN}) + + set(build_options "-DCMAKE_PREFIX_PATH=${PROJECT_BINARY_DIR}/mock_install" + "-DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}" + "-DPYTHON_EXECUTABLE:FILEPATH=${PYTHON_EXECUTABLE}" + "-DPYBIND11_CPP_STANDARD=${PYBIND11_CPP_STANDARD}") + if(NOT ARG_INSTALL) + list(APPEND build_options "-DPYBIND11_PROJECT_DIR=${PROJECT_SOURCE_DIR}") + endif() + + add_custom_target(test_${name} ${CMAKE_CTEST_COMMAND} + --quiet --output-log ${name}.log + --build-and-test "${CMAKE_CURRENT_SOURCE_DIR}/${name}" + "${CMAKE_CURRENT_BINARY_DIR}/${name}" + --build-config Release + --build-noclean + --build-generator ${CMAKE_GENERATOR} + $<$:--build-generator-platform> ${CMAKE_GENERATOR_PLATFORM} + --build-makeprogram ${CMAKE_MAKE_PROGRAM} + --build-target check + --build-options ${build_options} + ) + if(ARG_INSTALL) + add_dependencies(test_${name} mock_install) + endif() + add_dependencies(test_cmake_build test_${name}) +endfunction() + +pybind11_add_build_test(subdirectory_function) +pybind11_add_build_test(subdirectory_target) +if(NOT ${PYTHON_MODULE_EXTENSION} MATCHES "pypy") + pybind11_add_build_test(subdirectory_embed) +endif() + +if(PYBIND11_INSTALL) + add_custom_target(mock_install ${CMAKE_COMMAND} + "-DCMAKE_INSTALL_PREFIX=${PROJECT_BINARY_DIR}/mock_install" + -P "${PROJECT_BINARY_DIR}/cmake_install.cmake" + ) + + pybind11_add_build_test(installed_function INSTALL) + pybind11_add_build_test(installed_target INSTALL) + if(NOT ${PYTHON_MODULE_EXTENSION} MATCHES "pypy") + pybind11_add_build_test(installed_embed INSTALL) + endif() +endif() + +add_dependencies(check test_cmake_build) diff --git a/plugins/python/pybind11/tests/test_cmake_build/embed.cpp b/plugins/python/pybind11/tests/test_cmake_build/embed.cpp new file mode 100644 index 0000000..b9581d2 --- /dev/null +++ b/plugins/python/pybind11/tests/test_cmake_build/embed.cpp @@ -0,0 +1,21 @@ +#include +namespace py = pybind11; + +PYBIND11_EMBEDDED_MODULE(test_cmake_build, m) { + m.def("add", [](int i, int j) { return i + j; }); +} + +int main(int argc, char *argv[]) { + if (argc != 2) + throw std::runtime_error("Expected test.py file as the first argument"); + auto test_py_file = argv[1]; + + py::scoped_interpreter guard{}; + + auto m = py::module::import("test_cmake_build"); + if (m.attr("add")(1, 2).cast() != 3) + throw std::runtime_error("embed.cpp failed"); + + py::module::import("sys").attr("argv") = py::make_tuple("test.py", "embed.cpp"); + py::eval_file(test_py_file, py::globals()); +} diff --git a/plugins/python/pybind11/tests/test_cmake_build/installed_embed/CMakeLists.txt b/plugins/python/pybind11/tests/test_cmake_build/installed_embed/CMakeLists.txt new file mode 100644 index 0000000..f7fc09c --- /dev/null +++ b/plugins/python/pybind11/tests/test_cmake_build/installed_embed/CMakeLists.txt @@ -0,0 +1,15 @@ +cmake_minimum_required(VERSION 3.0) +project(test_installed_embed CXX) + +set(CMAKE_MODULE_PATH "") +find_package(pybind11 CONFIG REQUIRED) +message(STATUS "Found pybind11 v${pybind11_VERSION}: ${pybind11_INCLUDE_DIRS}") + +add_executable(test_cmake_build ../embed.cpp) +target_link_libraries(test_cmake_build PRIVATE pybind11::embed) + +# Do not treat includes from IMPORTED target as SYSTEM (Python headers in pybind11::embed). +# This may be needed to resolve header conflicts, e.g. between Python release and debug headers. +set_target_properties(test_cmake_build PROPERTIES NO_SYSTEM_FROM_IMPORTED ON) + +add_custom_target(check $ ${PROJECT_SOURCE_DIR}/../test.py) diff --git a/plugins/python/pybind11/tests/test_cmake_build/installed_function/CMakeLists.txt b/plugins/python/pybind11/tests/test_cmake_build/installed_function/CMakeLists.txt new file mode 100644 index 0000000..e0c20a8 --- /dev/null +++ b/plugins/python/pybind11/tests/test_cmake_build/installed_function/CMakeLists.txt @@ -0,0 +1,12 @@ +cmake_minimum_required(VERSION 2.8.12) +project(test_installed_module CXX) + +set(CMAKE_MODULE_PATH "") + +find_package(pybind11 CONFIG REQUIRED) +message(STATUS "Found pybind11 v${pybind11_VERSION}: ${pybind11_INCLUDE_DIRS}") + +pybind11_add_module(test_cmake_build SHARED NO_EXTRAS ../main.cpp) + +add_custom_target(check ${CMAKE_COMMAND} -E env PYTHONPATH=$ + ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/../test.py ${PROJECT_NAME}) diff --git a/plugins/python/pybind11/tests/test_cmake_build/installed_target/CMakeLists.txt b/plugins/python/pybind11/tests/test_cmake_build/installed_target/CMakeLists.txt new file mode 100644 index 0000000..cd3ae6f --- /dev/null +++ b/plugins/python/pybind11/tests/test_cmake_build/installed_target/CMakeLists.txt @@ -0,0 +1,22 @@ +cmake_minimum_required(VERSION 3.0) +project(test_installed_target CXX) + +set(CMAKE_MODULE_PATH "") + +find_package(pybind11 CONFIG REQUIRED) +message(STATUS "Found pybind11 v${pybind11_VERSION}: ${pybind11_INCLUDE_DIRS}") + +add_library(test_cmake_build MODULE ../main.cpp) + +target_link_libraries(test_cmake_build PRIVATE pybind11::module) + +# make sure result is, for example, test_installed_target.so, not libtest_installed_target.dylib +set_target_properties(test_cmake_build PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}" + SUFFIX "${PYTHON_MODULE_EXTENSION}") + +# Do not treat includes from IMPORTED target as SYSTEM (Python headers in pybind11::module). +# This may be needed to resolve header conflicts, e.g. between Python release and debug headers. +set_target_properties(test_cmake_build PROPERTIES NO_SYSTEM_FROM_IMPORTED ON) + +add_custom_target(check ${CMAKE_COMMAND} -E env PYTHONPATH=$ + ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/../test.py ${PROJECT_NAME}) diff --git a/plugins/python/pybind11/tests/test_cmake_build/main.cpp b/plugins/python/pybind11/tests/test_cmake_build/main.cpp new file mode 100644 index 0000000..e30f2c4 --- /dev/null +++ b/plugins/python/pybind11/tests/test_cmake_build/main.cpp @@ -0,0 +1,6 @@ +#include +namespace py = pybind11; + +PYBIND11_MODULE(test_cmake_build, m) { + m.def("add", [](int i, int j) { return i + j; }); +} diff --git a/plugins/python/pybind11/tests/test_cmake_build/subdirectory_embed/CMakeLists.txt b/plugins/python/pybind11/tests/test_cmake_build/subdirectory_embed/CMakeLists.txt new file mode 100644 index 0000000..88ba60d --- /dev/null +++ b/plugins/python/pybind11/tests/test_cmake_build/subdirectory_embed/CMakeLists.txt @@ -0,0 +1,25 @@ +cmake_minimum_required(VERSION 3.0) +project(test_subdirectory_embed CXX) + +set(PYBIND11_INSTALL ON CACHE BOOL "") +set(PYBIND11_EXPORT_NAME test_export) + +add_subdirectory(${PYBIND11_PROJECT_DIR} pybind11) + +# Test basic target functionality +add_executable(test_cmake_build ../embed.cpp) +target_link_libraries(test_cmake_build PRIVATE pybind11::embed) + +add_custom_target(check $ ${PROJECT_SOURCE_DIR}/../test.py) + +# Test custom export group -- PYBIND11_EXPORT_NAME +add_library(test_embed_lib ../embed.cpp) +target_link_libraries(test_embed_lib PRIVATE pybind11::embed) + +install(TARGETS test_embed_lib + EXPORT test_export + ARCHIVE DESTINATION bin + LIBRARY DESTINATION lib + RUNTIME DESTINATION lib) +install(EXPORT test_export + DESTINATION lib/cmake/test_export/test_export-Targets.cmake) diff --git a/plugins/python/pybind11/tests/test_cmake_build/subdirectory_function/CMakeLists.txt b/plugins/python/pybind11/tests/test_cmake_build/subdirectory_function/CMakeLists.txt new file mode 100644 index 0000000..278007a --- /dev/null +++ b/plugins/python/pybind11/tests/test_cmake_build/subdirectory_function/CMakeLists.txt @@ -0,0 +1,8 @@ +cmake_minimum_required(VERSION 2.8.12) +project(test_subdirectory_module CXX) + +add_subdirectory(${PYBIND11_PROJECT_DIR} pybind11) +pybind11_add_module(test_cmake_build THIN_LTO ../main.cpp) + +add_custom_target(check ${CMAKE_COMMAND} -E env PYTHONPATH=$ + ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/../test.py ${PROJECT_NAME}) diff --git a/plugins/python/pybind11/tests/test_cmake_build/subdirectory_target/CMakeLists.txt b/plugins/python/pybind11/tests/test_cmake_build/subdirectory_target/CMakeLists.txt new file mode 100644 index 0000000..6b142d6 --- /dev/null +++ b/plugins/python/pybind11/tests/test_cmake_build/subdirectory_target/CMakeLists.txt @@ -0,0 +1,15 @@ +cmake_minimum_required(VERSION 3.0) +project(test_subdirectory_target CXX) + +add_subdirectory(${PYBIND11_PROJECT_DIR} pybind11) + +add_library(test_cmake_build MODULE ../main.cpp) + +target_link_libraries(test_cmake_build PRIVATE pybind11::module) + +# make sure result is, for example, test_installed_target.so, not libtest_installed_target.dylib +set_target_properties(test_cmake_build PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}" + SUFFIX "${PYTHON_MODULE_EXTENSION}") + +add_custom_target(check ${CMAKE_COMMAND} -E env PYTHONPATH=$ + ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/../test.py ${PROJECT_NAME}) diff --git a/plugins/python/pybind11/tests/test_cmake_build/test.py b/plugins/python/pybind11/tests/test_cmake_build/test.py new file mode 100644 index 0000000..1467a61 --- /dev/null +++ b/plugins/python/pybind11/tests/test_cmake_build/test.py @@ -0,0 +1,5 @@ +import sys +import test_cmake_build + +assert test_cmake_build.add(1, 2) == 3 +print("{} imports, runs, and adds: 1 + 2 = 3".format(sys.argv[1])) diff --git a/plugins/python/pybind11/tests/test_constants_and_functions.cpp b/plugins/python/pybind11/tests/test_constants_and_functions.cpp new file mode 100644 index 0000000..8c9ef7f --- /dev/null +++ b/plugins/python/pybind11/tests/test_constants_and_functions.cpp @@ -0,0 +1,113 @@ +/* + tests/test_constants_and_functions.cpp -- global constants and functions, enumerations, raw byte strings + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +enum MyEnum { EFirstEntry = 1, ESecondEntry }; + +std::string test_function1() { + return "test_function()"; +} + +std::string test_function2(MyEnum k) { + return "test_function(enum=" + std::to_string(k) + ")"; +} + +std::string test_function3(int i) { + return "test_function(" + std::to_string(i) + ")"; +} + +py::str test_function4() { return "test_function()"; } +py::str test_function4(char *) { return "test_function(char *)"; } +py::str test_function4(int, float) { return "test_function(int, float)"; } +py::str test_function4(float, int) { return "test_function(float, int)"; } + +py::bytes return_bytes() { + const char *data = "\x01\x00\x02\x00"; + return std::string(data, 4); +} + +std::string print_bytes(py::bytes bytes) { + std::string ret = "bytes["; + const auto value = static_cast(bytes); + for (size_t i = 0; i < value.length(); ++i) { + ret += std::to_string(static_cast(value[i])) + " "; + } + ret.back() = ']'; + return ret; +} + +// Test that we properly handle C++17 exception specifiers (which are part of the function signature +// in C++17). These should all still work before C++17, but don't affect the function signature. +namespace test_exc_sp { +int f1(int x) noexcept { return x+1; } +int f2(int x) noexcept(true) { return x+2; } +int f3(int x) noexcept(false) { return x+3; } +int f4(int x) throw() { return x+4; } // Deprecated equivalent to noexcept(true) +struct C { + int m1(int x) noexcept { return x-1; } + int m2(int x) const noexcept { return x-2; } + int m3(int x) noexcept(true) { return x-3; } + int m4(int x) const noexcept(true) { return x-4; } + int m5(int x) noexcept(false) { return x-5; } + int m6(int x) const noexcept(false) { return x-6; } + int m7(int x) throw() { return x-7; } + int m8(int x) const throw() { return x-8; } +}; +} + + +TEST_SUBMODULE(constants_and_functions, m) { + // test_constants + m.attr("some_constant") = py::int_(14); + + // test_function_overloading + m.def("test_function", &test_function1); + m.def("test_function", &test_function2); + m.def("test_function", &test_function3); + +#if defined(PYBIND11_OVERLOAD_CAST) + m.def("test_function", py::overload_cast<>(&test_function4)); + m.def("test_function", py::overload_cast(&test_function4)); + m.def("test_function", py::overload_cast(&test_function4)); + m.def("test_function", py::overload_cast(&test_function4)); +#else + m.def("test_function", static_cast(&test_function4)); + m.def("test_function", static_cast(&test_function4)); + m.def("test_function", static_cast(&test_function4)); + m.def("test_function", static_cast(&test_function4)); +#endif + + py::enum_(m, "MyEnum") + .value("EFirstEntry", EFirstEntry) + .value("ESecondEntry", ESecondEntry) + .export_values(); + + // test_bytes + m.def("return_bytes", &return_bytes); + m.def("print_bytes", &print_bytes); + + // test_exception_specifiers + using namespace test_exc_sp; + py::class_(m, "C") + .def(py::init<>()) + .def("m1", &C::m1) + .def("m2", &C::m2) + .def("m3", &C::m3) + .def("m4", &C::m4) + .def("m5", &C::m5) + .def("m6", &C::m6) + .def("m7", &C::m7) + .def("m8", &C::m8) + ; + m.def("f1", f1); + m.def("f2", f2); + m.def("f3", f3); + m.def("f4", f4); +} diff --git a/plugins/python/pybind11/tests/test_constants_and_functions.py b/plugins/python/pybind11/tests/test_constants_and_functions.py new file mode 100644 index 0000000..472682d --- /dev/null +++ b/plugins/python/pybind11/tests/test_constants_and_functions.py @@ -0,0 +1,39 @@ +from pybind11_tests import constants_and_functions as m + + +def test_constants(): + assert m.some_constant == 14 + + +def test_function_overloading(): + assert m.test_function() == "test_function()" + assert m.test_function(7) == "test_function(7)" + assert m.test_function(m.MyEnum.EFirstEntry) == "test_function(enum=1)" + assert m.test_function(m.MyEnum.ESecondEntry) == "test_function(enum=2)" + + assert m.test_function() == "test_function()" + assert m.test_function("abcd") == "test_function(char *)" + assert m.test_function(1, 1.0) == "test_function(int, float)" + assert m.test_function(1, 1.0) == "test_function(int, float)" + assert m.test_function(2.0, 2) == "test_function(float, int)" + + +def test_bytes(): + assert m.print_bytes(m.return_bytes()) == "bytes[1 0 2 0]" + + +def test_exception_specifiers(): + c = m.C() + assert c.m1(2) == 1 + assert c.m2(3) == 1 + assert c.m3(5) == 2 + assert c.m4(7) == 3 + assert c.m5(10) == 5 + assert c.m6(14) == 8 + assert c.m7(20) == 13 + assert c.m8(29) == 21 + + assert m.f1(33) == 34 + assert m.f2(53) == 55 + assert m.f3(86) == 89 + assert m.f4(140) == 144 diff --git a/plugins/python/pybind11/tests/test_copy_move.cpp b/plugins/python/pybind11/tests/test_copy_move.cpp new file mode 100644 index 0000000..94113e3 --- /dev/null +++ b/plugins/python/pybind11/tests/test_copy_move.cpp @@ -0,0 +1,213 @@ +/* + tests/test_copy_move_policies.cpp -- 'copy' and 'move' return value policies + and related tests + + Copyright (c) 2016 Ben North + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include + +template +struct empty { + static const derived& get_one() { return instance_; } + static derived instance_; +}; + +struct lacking_copy_ctor : public empty { + lacking_copy_ctor() {} + lacking_copy_ctor(const lacking_copy_ctor& other) = delete; +}; + +template <> lacking_copy_ctor empty::instance_ = {}; + +struct lacking_move_ctor : public empty { + lacking_move_ctor() {} + lacking_move_ctor(const lacking_move_ctor& other) = delete; + lacking_move_ctor(lacking_move_ctor&& other) = delete; +}; + +template <> lacking_move_ctor empty::instance_ = {}; + +/* Custom type caster move/copy test classes */ +class MoveOnlyInt { +public: + MoveOnlyInt() { print_default_created(this); } + MoveOnlyInt(int v) : value{std::move(v)} { print_created(this, value); } + MoveOnlyInt(MoveOnlyInt &&m) { print_move_created(this, m.value); std::swap(value, m.value); } + MoveOnlyInt &operator=(MoveOnlyInt &&m) { print_move_assigned(this, m.value); std::swap(value, m.value); return *this; } + MoveOnlyInt(const MoveOnlyInt &) = delete; + MoveOnlyInt &operator=(const MoveOnlyInt &) = delete; + ~MoveOnlyInt() { print_destroyed(this); } + + int value; +}; +class MoveOrCopyInt { +public: + MoveOrCopyInt() { print_default_created(this); } + MoveOrCopyInt(int v) : value{std::move(v)} { print_created(this, value); } + MoveOrCopyInt(MoveOrCopyInt &&m) { print_move_created(this, m.value); std::swap(value, m.value); } + MoveOrCopyInt &operator=(MoveOrCopyInt &&m) { print_move_assigned(this, m.value); std::swap(value, m.value); return *this; } + MoveOrCopyInt(const MoveOrCopyInt &c) { print_copy_created(this, c.value); value = c.value; } + MoveOrCopyInt &operator=(const MoveOrCopyInt &c) { print_copy_assigned(this, c.value); value = c.value; return *this; } + ~MoveOrCopyInt() { print_destroyed(this); } + + int value; +}; +class CopyOnlyInt { +public: + CopyOnlyInt() { print_default_created(this); } + CopyOnlyInt(int v) : value{std::move(v)} { print_created(this, value); } + CopyOnlyInt(const CopyOnlyInt &c) { print_copy_created(this, c.value); value = c.value; } + CopyOnlyInt &operator=(const CopyOnlyInt &c) { print_copy_assigned(this, c.value); value = c.value; return *this; } + ~CopyOnlyInt() { print_destroyed(this); } + + int value; +}; +NAMESPACE_BEGIN(pybind11) +NAMESPACE_BEGIN(detail) +template <> struct type_caster { + PYBIND11_TYPE_CASTER(MoveOnlyInt, _("MoveOnlyInt")); + bool load(handle src, bool) { value = MoveOnlyInt(src.cast()); return true; } + static handle cast(const MoveOnlyInt &m, return_value_policy r, handle p) { return pybind11::cast(m.value, r, p); } +}; + +template <> struct type_caster { + PYBIND11_TYPE_CASTER(MoveOrCopyInt, _("MoveOrCopyInt")); + bool load(handle src, bool) { value = MoveOrCopyInt(src.cast()); return true; } + static handle cast(const MoveOrCopyInt &m, return_value_policy r, handle p) { return pybind11::cast(m.value, r, p); } +}; + +template <> struct type_caster { +protected: + CopyOnlyInt value; +public: + static PYBIND11_DESCR name() { return _("CopyOnlyInt"); } + bool load(handle src, bool) { value = CopyOnlyInt(src.cast()); return true; } + static handle cast(const CopyOnlyInt &m, return_value_policy r, handle p) { return pybind11::cast(m.value, r, p); } + static handle cast(const CopyOnlyInt *src, return_value_policy policy, handle parent) { + if (!src) return none().release(); + return cast(*src, policy, parent); + } + operator CopyOnlyInt*() { return &value; } + operator CopyOnlyInt&() { return value; } + template using cast_op_type = pybind11::detail::cast_op_type; +}; +NAMESPACE_END(detail) +NAMESPACE_END(pybind11) + +TEST_SUBMODULE(copy_move_policies, m) { + // test_lacking_copy_ctor + py::class_(m, "lacking_copy_ctor") + .def_static("get_one", &lacking_copy_ctor::get_one, + py::return_value_policy::copy); + // test_lacking_move_ctor + py::class_(m, "lacking_move_ctor") + .def_static("get_one", &lacking_move_ctor::get_one, + py::return_value_policy::move); + + // test_move_and_copy_casts + m.def("move_and_copy_casts", [](py::object o) { + int r = 0; + r += py::cast(o).value; /* moves */ + r += py::cast(o).value; /* moves */ + r += py::cast(o).value; /* copies */ + MoveOrCopyInt m1(py::cast(o)); /* moves */ + MoveOnlyInt m2(py::cast(o)); /* moves */ + CopyOnlyInt m3(py::cast(o)); /* copies */ + r += m1.value + m2.value + m3.value; + + return r; + }); + + // test_move_and_copy_loads + m.def("move_only", [](MoveOnlyInt m) { return m.value; }); + m.def("move_or_copy", [](MoveOrCopyInt m) { return m.value; }); + m.def("copy_only", [](CopyOnlyInt m) { return m.value; }); + m.def("move_pair", [](std::pair p) { + return p.first.value + p.second.value; + }); + m.def("move_tuple", [](std::tuple t) { + return std::get<0>(t).value + std::get<1>(t).value + std::get<2>(t).value; + }); + m.def("copy_tuple", [](std::tuple t) { + return std::get<0>(t).value + std::get<1>(t).value; + }); + m.def("move_copy_nested", [](std::pair>, MoveOrCopyInt>> x) { + return x.first.value + std::get<0>(x.second.first).value + std::get<1>(x.second.first).value + + std::get<0>(std::get<2>(x.second.first)).value + x.second.second.value; + }); + m.def("move_and_copy_cstats", []() { + ConstructorStats::gc(); + // Reset counts to 0 so that previous tests don't affect later ones: + auto &mc = ConstructorStats::get(); + mc.move_assignments = mc.move_constructions = mc.copy_assignments = mc.copy_constructions = 0; + auto &mo = ConstructorStats::get(); + mo.move_assignments = mo.move_constructions = mo.copy_assignments = mo.copy_constructions = 0; + auto &co = ConstructorStats::get(); + co.move_assignments = co.move_constructions = co.copy_assignments = co.copy_constructions = 0; + py::dict d; + d["MoveOrCopyInt"] = py::cast(mc, py::return_value_policy::reference); + d["MoveOnlyInt"] = py::cast(mo, py::return_value_policy::reference); + d["CopyOnlyInt"] = py::cast(co, py::return_value_policy::reference); + return d; + }); +#ifdef PYBIND11_HAS_OPTIONAL + // test_move_and_copy_load_optional + m.attr("has_optional") = true; + m.def("move_optional", [](std::optional o) { + return o->value; + }); + m.def("move_or_copy_optional", [](std::optional o) { + return o->value; + }); + m.def("copy_optional", [](std::optional o) { + return o->value; + }); + m.def("move_optional_tuple", [](std::optional> x) { + return std::get<0>(*x).value + std::get<1>(*x).value + std::get<2>(*x).value; + }); +#else + m.attr("has_optional") = false; +#endif + + // #70 compilation issue if operator new is not public + struct PrivateOpNew { + int value = 1; + private: +#if defined(_MSC_VER) +# pragma warning(disable: 4822) // warning C4822: local class member function does not have a body +#endif + void *operator new(size_t bytes); + }; + py::class_(m, "PrivateOpNew").def_readonly("value", &PrivateOpNew::value); + m.def("private_op_new_value", []() { return PrivateOpNew(); }); + m.def("private_op_new_reference", []() -> const PrivateOpNew & { + static PrivateOpNew x{}; + return x; + }, py::return_value_policy::reference); + + // test_move_fallback + // #389: rvp::move should fall-through to copy on non-movable objects + struct MoveIssue1 { + int v; + MoveIssue1(int v) : v{v} {} + MoveIssue1(const MoveIssue1 &c) = default; + MoveIssue1(MoveIssue1 &&) = delete; + }; + py::class_(m, "MoveIssue1").def(py::init()).def_readwrite("value", &MoveIssue1::v); + + struct MoveIssue2 { + int v; + MoveIssue2(int v) : v{v} {} + MoveIssue2(MoveIssue2 &&) = default; + }; + py::class_(m, "MoveIssue2").def(py::init()).def_readwrite("value", &MoveIssue2::v); + + m.def("get_moveissue1", [](int i) { return new MoveIssue1(i); }, py::return_value_policy::move); + m.def("get_moveissue2", [](int i) { return MoveIssue2(i); }, py::return_value_policy::move); +} diff --git a/plugins/python/pybind11/tests/test_copy_move.py b/plugins/python/pybind11/tests/test_copy_move.py new file mode 100644 index 0000000..aff2d99 --- /dev/null +++ b/plugins/python/pybind11/tests/test_copy_move.py @@ -0,0 +1,112 @@ +import pytest +from pybind11_tests import copy_move_policies as m + + +def test_lacking_copy_ctor(): + with pytest.raises(RuntimeError) as excinfo: + m.lacking_copy_ctor.get_one() + assert "the object is non-copyable!" in str(excinfo.value) + + +def test_lacking_move_ctor(): + with pytest.raises(RuntimeError) as excinfo: + m.lacking_move_ctor.get_one() + assert "the object is neither movable nor copyable!" in str(excinfo.value) + + +def test_move_and_copy_casts(): + """Cast some values in C++ via custom type casters and count the number of moves/copies.""" + + cstats = m.move_and_copy_cstats() + c_m, c_mc, c_c = cstats["MoveOnlyInt"], cstats["MoveOrCopyInt"], cstats["CopyOnlyInt"] + + # The type move constructions/assignments below each get incremented: the move assignment comes + # from the type_caster load; the move construction happens when extracting that via a cast or + # loading into an argument. + assert m.move_and_copy_casts(3) == 18 + assert c_m.copy_assignments + c_m.copy_constructions == 0 + assert c_m.move_assignments == 2 + assert c_m.move_constructions >= 2 + assert c_mc.alive() == 0 + assert c_mc.copy_assignments + c_mc.copy_constructions == 0 + assert c_mc.move_assignments == 2 + assert c_mc.move_constructions >= 2 + assert c_c.alive() == 0 + assert c_c.copy_assignments == 2 + assert c_c.copy_constructions >= 2 + assert c_m.alive() + c_mc.alive() + c_c.alive() == 0 + + +def test_move_and_copy_loads(): + """Call some functions that load arguments via custom type casters and count the number of + moves/copies.""" + + cstats = m.move_and_copy_cstats() + c_m, c_mc, c_c = cstats["MoveOnlyInt"], cstats["MoveOrCopyInt"], cstats["CopyOnlyInt"] + + assert m.move_only(10) == 10 # 1 move, c_m + assert m.move_or_copy(11) == 11 # 1 move, c_mc + assert m.copy_only(12) == 12 # 1 copy, c_c + assert m.move_pair((13, 14)) == 27 # 1 c_m move, 1 c_mc move + assert m.move_tuple((15, 16, 17)) == 48 # 2 c_m moves, 1 c_mc move + assert m.copy_tuple((18, 19)) == 37 # 2 c_c copies + # Direct constructions: 2 c_m moves, 2 c_mc moves, 1 c_c copy + # Extra moves/copies when moving pairs/tuples: 3 c_m, 3 c_mc, 2 c_c + assert m.move_copy_nested((1, ((2, 3, (4,)), 5))) == 15 + + assert c_m.copy_assignments + c_m.copy_constructions == 0 + assert c_m.move_assignments == 6 + assert c_m.move_constructions == 9 + assert c_mc.copy_assignments + c_mc.copy_constructions == 0 + assert c_mc.move_assignments == 5 + assert c_mc.move_constructions == 8 + assert c_c.copy_assignments == 4 + assert c_c.copy_constructions == 6 + assert c_m.alive() + c_mc.alive() + c_c.alive() == 0 + + +@pytest.mark.skipif(not m.has_optional, reason='no ') +def test_move_and_copy_load_optional(): + """Tests move/copy loads of std::optional arguments""" + + cstats = m.move_and_copy_cstats() + c_m, c_mc, c_c = cstats["MoveOnlyInt"], cstats["MoveOrCopyInt"], cstats["CopyOnlyInt"] + + # The extra move/copy constructions below come from the std::optional move (which has to move + # its arguments): + assert m.move_optional(10) == 10 # c_m: 1 move assign, 2 move construct + assert m.move_or_copy_optional(11) == 11 # c_mc: 1 move assign, 2 move construct + assert m.copy_optional(12) == 12 # c_c: 1 copy assign, 2 copy construct + # 1 move assign + move construct moves each of c_m, c_mc, 1 c_c copy + # +1 move/copy construct each from moving the tuple + # +1 move/copy construct each from moving the optional (which moves the tuple again) + assert m.move_optional_tuple((3, 4, 5)) == 12 + + assert c_m.copy_assignments + c_m.copy_constructions == 0 + assert c_m.move_assignments == 2 + assert c_m.move_constructions == 5 + assert c_mc.copy_assignments + c_mc.copy_constructions == 0 + assert c_mc.move_assignments == 2 + assert c_mc.move_constructions == 5 + assert c_c.copy_assignments == 2 + assert c_c.copy_constructions == 5 + assert c_m.alive() + c_mc.alive() + c_c.alive() == 0 + + +def test_private_op_new(): + """An object with a private `operator new` cannot be returned by value""" + + with pytest.raises(RuntimeError) as excinfo: + m.private_op_new_value() + assert "the object is neither movable nor copyable" in str(excinfo.value) + + assert m.private_op_new_reference().value == 1 + + +def test_move_fallback(): + """#389: rvp::move should fall-through to copy on non-movable objects""" + + m2 = m.get_moveissue2(2) + assert m2.value == 2 + m1 = m.get_moveissue1(1) + assert m1.value == 1 diff --git a/plugins/python/pybind11/tests/test_docstring_options.cpp b/plugins/python/pybind11/tests/test_docstring_options.cpp new file mode 100644 index 0000000..8c8f79f --- /dev/null +++ b/plugins/python/pybind11/tests/test_docstring_options.cpp @@ -0,0 +1,61 @@ +/* + tests/test_docstring_options.cpp -- generation of docstrings and signatures + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +TEST_SUBMODULE(docstring_options, m) { + // test_docstring_options + { + py::options options; + options.disable_function_signatures(); + + m.def("test_function1", [](int, int) {}, py::arg("a"), py::arg("b")); + m.def("test_function2", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); + + m.def("test_overloaded1", [](int) {}, py::arg("i"), "Overload docstring"); + m.def("test_overloaded1", [](double) {}, py::arg("d")); + + m.def("test_overloaded2", [](int) {}, py::arg("i"), "overload docstring 1"); + m.def("test_overloaded2", [](double) {}, py::arg("d"), "overload docstring 2"); + + m.def("test_overloaded3", [](int) {}, py::arg("i")); + m.def("test_overloaded3", [](double) {}, py::arg("d"), "Overload docstr"); + + options.enable_function_signatures(); + + m.def("test_function3", [](int, int) {}, py::arg("a"), py::arg("b")); + m.def("test_function4", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); + + options.disable_function_signatures().disable_user_defined_docstrings(); + + m.def("test_function5", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); + + { + py::options nested_options; + nested_options.enable_user_defined_docstrings(); + m.def("test_function6", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); + } + } + + m.def("test_function7", [](int, int) {}, py::arg("a"), py::arg("b"), "A custom docstring"); + + { + py::options options; + options.disable_user_defined_docstrings(); + + struct DocstringTestFoo { + int value; + void setValue(int v) { value = v; } + int getValue() const { return value; } + }; + py::class_(m, "DocstringTestFoo", "This is a class docstring") + .def_property("value_prop", &DocstringTestFoo::getValue, &DocstringTestFoo::setValue, "This is a property docstring") + ; + } +} diff --git a/plugins/python/pybind11/tests/test_docstring_options.py b/plugins/python/pybind11/tests/test_docstring_options.py new file mode 100644 index 0000000..0dbca60 --- /dev/null +++ b/plugins/python/pybind11/tests/test_docstring_options.py @@ -0,0 +1,38 @@ +from pybind11_tests import docstring_options as m + + +def test_docstring_options(): + # options.disable_function_signatures() + assert not m.test_function1.__doc__ + + assert m.test_function2.__doc__ == "A custom docstring" + + # docstring specified on just the first overload definition: + assert m.test_overloaded1.__doc__ == "Overload docstring" + + # docstring on both overloads: + assert m.test_overloaded2.__doc__ == "overload docstring 1\noverload docstring 2" + + # docstring on only second overload: + assert m.test_overloaded3.__doc__ == "Overload docstr" + + # options.enable_function_signatures() + assert m.test_function3.__doc__ .startswith("test_function3(a: int, b: int) -> None") + + assert m.test_function4.__doc__ .startswith("test_function4(a: int, b: int) -> None") + assert m.test_function4.__doc__ .endswith("A custom docstring\n") + + # options.disable_function_signatures() + # options.disable_user_defined_docstrings() + assert not m.test_function5.__doc__ + + # nested options.enable_user_defined_docstrings() + assert m.test_function6.__doc__ == "A custom docstring" + + # RAII destructor + assert m.test_function7.__doc__ .startswith("test_function7(a: int, b: int) -> None") + assert m.test_function7.__doc__ .endswith("A custom docstring\n") + + # Suppression of user-defined docstrings for non-function objects + assert not m.DocstringTestFoo.__doc__ + assert not m.DocstringTestFoo.value_prop.__doc__ diff --git a/plugins/python/pybind11/tests/test_eigen.cpp b/plugins/python/pybind11/tests/test_eigen.cpp new file mode 100644 index 0000000..22141df --- /dev/null +++ b/plugins/python/pybind11/tests/test_eigen.cpp @@ -0,0 +1,329 @@ +/* + tests/eigen.cpp -- automatic conversion of Eigen types + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include +#include + +#if defined(_MSC_VER) +# pragma warning(disable: 4996) // C4996: std::unary_negation is deprecated +#endif + +#include + +using MatrixXdR = Eigen::Matrix; + + + +// Sets/resets a testing reference matrix to have values of 10*r + c, where r and c are the +// (1-based) row/column number. +template void reset_ref(M &x) { + for (int i = 0; i < x.rows(); i++) for (int j = 0; j < x.cols(); j++) + x(i, j) = 11 + 10*i + j; +} + +// Returns a static, column-major matrix +Eigen::MatrixXd &get_cm() { + static Eigen::MatrixXd *x; + if (!x) { + x = new Eigen::MatrixXd(3, 3); + reset_ref(*x); + } + return *x; +} +// Likewise, but row-major +MatrixXdR &get_rm() { + static MatrixXdR *x; + if (!x) { + x = new MatrixXdR(3, 3); + reset_ref(*x); + } + return *x; +} +// Resets the values of the static matrices returned by get_cm()/get_rm() +void reset_refs() { + reset_ref(get_cm()); + reset_ref(get_rm()); +} + +// Returns element 2,1 from a matrix (used to test copy/nocopy) +double get_elem(Eigen::Ref m) { return m(2, 1); }; + + +// Returns a matrix with 10*r + 100*c added to each matrix element (to help test that the matrix +// reference is referencing rows/columns correctly). +template Eigen::MatrixXd adjust_matrix(MatrixArgType m) { + Eigen::MatrixXd ret(m); + for (int c = 0; c < m.cols(); c++) for (int r = 0; r < m.rows(); r++) + ret(r, c) += 10*r + 100*c; + return ret; +} + +struct CustomOperatorNew { + CustomOperatorNew() = default; + + Eigen::Matrix4d a = Eigen::Matrix4d::Zero(); + Eigen::Matrix4d b = Eigen::Matrix4d::Identity(); + + EIGEN_MAKE_ALIGNED_OPERATOR_NEW; +}; + +TEST_SUBMODULE(eigen, m) { + using FixedMatrixR = Eigen::Matrix; + using FixedMatrixC = Eigen::Matrix; + using DenseMatrixR = Eigen::Matrix; + using DenseMatrixC = Eigen::Matrix; + using FourRowMatrixC = Eigen::Matrix; + using FourColMatrixC = Eigen::Matrix; + using FourRowMatrixR = Eigen::Matrix; + using FourColMatrixR = Eigen::Matrix; + using SparseMatrixR = Eigen::SparseMatrix; + using SparseMatrixC = Eigen::SparseMatrix; + + m.attr("have_eigen") = true; + + // various tests + m.def("double_col", [](const Eigen::VectorXf &x) -> Eigen::VectorXf { return 2.0f * x; }); + m.def("double_row", [](const Eigen::RowVectorXf &x) -> Eigen::RowVectorXf { return 2.0f * x; }); + m.def("double_complex", [](const Eigen::VectorXcf &x) -> Eigen::VectorXcf { return 2.0f * x; }); + m.def("double_threec", [](py::EigenDRef x) { x *= 2; }); + m.def("double_threer", [](py::EigenDRef x) { x *= 2; }); + m.def("double_mat_cm", [](Eigen::MatrixXf x) -> Eigen::MatrixXf { return 2.0f * x; }); + m.def("double_mat_rm", [](DenseMatrixR x) -> DenseMatrixR { return 2.0f * x; }); + + // test_eigen_ref_to_python + // Different ways of passing via Eigen::Ref; the first and second are the Eigen-recommended + m.def("cholesky1", [](Eigen::Ref x) -> Eigen::MatrixXd { return x.llt().matrixL(); }); + m.def("cholesky2", [](const Eigen::Ref &x) -> Eigen::MatrixXd { return x.llt().matrixL(); }); + m.def("cholesky3", [](const Eigen::Ref &x) -> Eigen::MatrixXd { return x.llt().matrixL(); }); + m.def("cholesky4", [](Eigen::Ref x) -> Eigen::MatrixXd { return x.llt().matrixL(); }); + + // test_eigen_ref_mutators + // Mutators: these add some value to the given element using Eigen, but Eigen should be mapping into + // the numpy array data and so the result should show up there. There are three versions: one that + // works on a contiguous-row matrix (numpy's default), one for a contiguous-column matrix, and one + // for any matrix. + auto add_rm = [](Eigen::Ref x, int r, int c, double v) { x(r,c) += v; }; + auto add_cm = [](Eigen::Ref x, int r, int c, double v) { x(r,c) += v; }; + + // Mutators (Eigen maps into numpy variables): + m.def("add_rm", add_rm); // Only takes row-contiguous + m.def("add_cm", add_cm); // Only takes column-contiguous + // Overloaded versions that will accept either row or column contiguous: + m.def("add1", add_rm); + m.def("add1", add_cm); + m.def("add2", add_cm); + m.def("add2", add_rm); + // This one accepts a matrix of any stride: + m.def("add_any", [](py::EigenDRef x, int r, int c, double v) { x(r,c) += v; }); + + // Return mutable references (numpy maps into eigen varibles) + m.def("get_cm_ref", []() { return Eigen::Ref(get_cm()); }); + m.def("get_rm_ref", []() { return Eigen::Ref(get_rm()); }); + // The same references, but non-mutable (numpy maps into eigen variables, but is !writeable) + m.def("get_cm_const_ref", []() { return Eigen::Ref(get_cm()); }); + m.def("get_rm_const_ref", []() { return Eigen::Ref(get_rm()); }); + + m.def("reset_refs", reset_refs); // Restores get_{cm,rm}_ref to original values + + // Increments and returns ref to (same) matrix + m.def("incr_matrix", [](Eigen::Ref m, double v) { + m += Eigen::MatrixXd::Constant(m.rows(), m.cols(), v); + return m; + }, py::return_value_policy::reference); + + // Same, but accepts a matrix of any strides + m.def("incr_matrix_any", [](py::EigenDRef m, double v) { + m += Eigen::MatrixXd::Constant(m.rows(), m.cols(), v); + return m; + }, py::return_value_policy::reference); + + // Returns an eigen slice of even rows + m.def("even_rows", [](py::EigenDRef m) { + return py::EigenDMap( + m.data(), (m.rows() + 1) / 2, m.cols(), + py::EigenDStride(m.outerStride(), 2 * m.innerStride())); + }, py::return_value_policy::reference); + + // Returns an eigen slice of even columns + m.def("even_cols", [](py::EigenDRef m) { + return py::EigenDMap( + m.data(), m.rows(), (m.cols() + 1) / 2, + py::EigenDStride(2 * m.outerStride(), m.innerStride())); + }, py::return_value_policy::reference); + + // Returns diagonals: a vector-like object with an inner stride != 1 + m.def("diagonal", [](const Eigen::Ref &x) { return x.diagonal(); }); + m.def("diagonal_1", [](const Eigen::Ref &x) { return x.diagonal<1>(); }); + m.def("diagonal_n", [](const Eigen::Ref &x, int index) { return x.diagonal(index); }); + + // Return a block of a matrix (gives non-standard strides) + m.def("block", [](const Eigen::Ref &x, int start_row, int start_col, int block_rows, int block_cols) { + return x.block(start_row, start_col, block_rows, block_cols); + }); + + // test_eigen_return_references, test_eigen_keepalive + // return value referencing/copying tests: + class ReturnTester { + Eigen::MatrixXd mat = create(); + public: + ReturnTester() { print_created(this); } + ~ReturnTester() { print_destroyed(this); } + static Eigen::MatrixXd create() { return Eigen::MatrixXd::Ones(10, 10); } + static const Eigen::MatrixXd createConst() { return Eigen::MatrixXd::Ones(10, 10); } + Eigen::MatrixXd &get() { return mat; } + Eigen::MatrixXd *getPtr() { return &mat; } + const Eigen::MatrixXd &view() { return mat; } + const Eigen::MatrixXd *viewPtr() { return &mat; } + Eigen::Ref ref() { return mat; } + Eigen::Ref refConst() { return mat; } + Eigen::Block block(int r, int c, int nrow, int ncol) { return mat.block(r, c, nrow, ncol); } + Eigen::Block blockConst(int r, int c, int nrow, int ncol) const { return mat.block(r, c, nrow, ncol); } + py::EigenDMap corners() { return py::EigenDMap(mat.data(), + py::EigenDStride(mat.outerStride() * (mat.outerSize()-1), mat.innerStride() * (mat.innerSize()-1))); } + py::EigenDMap cornersConst() const { return py::EigenDMap(mat.data(), + py::EigenDStride(mat.outerStride() * (mat.outerSize()-1), mat.innerStride() * (mat.innerSize()-1))); } + }; + using rvp = py::return_value_policy; + py::class_(m, "ReturnTester") + .def(py::init<>()) + .def_static("create", &ReturnTester::create) + .def_static("create_const", &ReturnTester::createConst) + .def("get", &ReturnTester::get, rvp::reference_internal) + .def("get_ptr", &ReturnTester::getPtr, rvp::reference_internal) + .def("view", &ReturnTester::view, rvp::reference_internal) + .def("view_ptr", &ReturnTester::view, rvp::reference_internal) + .def("copy_get", &ReturnTester::get) // Default rvp: copy + .def("copy_view", &ReturnTester::view) // " + .def("ref", &ReturnTester::ref) // Default for Ref is to reference + .def("ref_const", &ReturnTester::refConst) // Likewise, but const + .def("ref_safe", &ReturnTester::ref, rvp::reference_internal) + .def("ref_const_safe", &ReturnTester::refConst, rvp::reference_internal) + .def("copy_ref", &ReturnTester::ref, rvp::copy) + .def("copy_ref_const", &ReturnTester::refConst, rvp::copy) + .def("block", &ReturnTester::block) + .def("block_safe", &ReturnTester::block, rvp::reference_internal) + .def("block_const", &ReturnTester::blockConst, rvp::reference_internal) + .def("copy_block", &ReturnTester::block, rvp::copy) + .def("corners", &ReturnTester::corners, rvp::reference_internal) + .def("corners_const", &ReturnTester::cornersConst, rvp::reference_internal) + ; + + // test_special_matrix_objects + // Returns a DiagonalMatrix with diagonal (1,2,3,...) + m.def("incr_diag", [](int k) { + Eigen::DiagonalMatrix m(k); + for (int i = 0; i < k; i++) m.diagonal()[i] = i+1; + return m; + }); + + // Returns a SelfAdjointView referencing the lower triangle of m + m.def("symmetric_lower", [](const Eigen::MatrixXi &m) { + return m.selfadjointView(); + }); + // Returns a SelfAdjointView referencing the lower triangle of m + m.def("symmetric_upper", [](const Eigen::MatrixXi &m) { + return m.selfadjointView(); + }); + + // Test matrix for various functions below. + Eigen::MatrixXf mat(5, 6); + mat << 0, 3, 0, 0, 0, 11, + 22, 0, 0, 0, 17, 11, + 7, 5, 0, 1, 0, 11, + 0, 0, 0, 0, 0, 11, + 0, 0, 14, 0, 8, 11; + + // test_fixed, and various other tests + m.def("fixed_r", [mat]() -> FixedMatrixR { return FixedMatrixR(mat); }); + m.def("fixed_r_const", [mat]() -> const FixedMatrixR { return FixedMatrixR(mat); }); + m.def("fixed_c", [mat]() -> FixedMatrixC { return FixedMatrixC(mat); }); + m.def("fixed_copy_r", [](const FixedMatrixR &m) -> FixedMatrixR { return m; }); + m.def("fixed_copy_c", [](const FixedMatrixC &m) -> FixedMatrixC { return m; }); + // test_mutator_descriptors + m.def("fixed_mutator_r", [](Eigen::Ref) {}); + m.def("fixed_mutator_c", [](Eigen::Ref) {}); + m.def("fixed_mutator_a", [](py::EigenDRef) {}); + // test_dense + m.def("dense_r", [mat]() -> DenseMatrixR { return DenseMatrixR(mat); }); + m.def("dense_c", [mat]() -> DenseMatrixC { return DenseMatrixC(mat); }); + m.def("dense_copy_r", [](const DenseMatrixR &m) -> DenseMatrixR { return m; }); + m.def("dense_copy_c", [](const DenseMatrixC &m) -> DenseMatrixC { return m; }); + // test_sparse, test_sparse_signature + m.def("sparse_r", [mat]() -> SparseMatrixR { return Eigen::SparseView(mat); }); + m.def("sparse_c", [mat]() -> SparseMatrixC { return Eigen::SparseView(mat); }); + m.def("sparse_copy_r", [](const SparseMatrixR &m) -> SparseMatrixR { return m; }); + m.def("sparse_copy_c", [](const SparseMatrixC &m) -> SparseMatrixC { return m; }); + // test_partially_fixed + m.def("partial_copy_four_rm_r", [](const FourRowMatrixR &m) -> FourRowMatrixR { return m; }); + m.def("partial_copy_four_rm_c", [](const FourColMatrixR &m) -> FourColMatrixR { return m; }); + m.def("partial_copy_four_cm_r", [](const FourRowMatrixC &m) -> FourRowMatrixC { return m; }); + m.def("partial_copy_four_cm_c", [](const FourColMatrixC &m) -> FourColMatrixC { return m; }); + + // test_cpp_casting + // Test that we can cast a numpy object to a Eigen::MatrixXd explicitly + m.def("cpp_copy", [](py::handle m) { return m.cast()(1, 0); }); + m.def("cpp_ref_c", [](py::handle m) { return m.cast>()(1, 0); }); + m.def("cpp_ref_r", [](py::handle m) { return m.cast>()(1, 0); }); + m.def("cpp_ref_any", [](py::handle m) { return m.cast>()(1, 0); }); + + + // test_nocopy_wrapper + // Test that we can prevent copying into an argument that would normally copy: First a version + // that would allow copying (if types or strides don't match) for comparison: + m.def("get_elem", &get_elem); + // Now this alternative that calls the tells pybind to fail rather than copy: + m.def("get_elem_nocopy", [](Eigen::Ref m) -> double { return get_elem(m); }, + py::arg().noconvert()); + // Also test a row-major-only no-copy const ref: + m.def("get_elem_rm_nocopy", [](Eigen::Ref> &m) -> long { return m(2, 1); }, + py::arg().noconvert()); + + // test_issue738 + // Issue #738: 1xN or Nx1 2D matrices were neither accepted nor properly copied with an + // incompatible stride value on the length-1 dimension--but that should be allowed (without + // requiring a copy!) because the stride value can be safely ignored on a size-1 dimension. + m.def("iss738_f1", &adjust_matrix &>, py::arg().noconvert()); + m.def("iss738_f2", &adjust_matrix> &>, py::arg().noconvert()); + + // test_issue1105 + // Issue #1105: when converting from a numpy two-dimensional (Nx1) or (1xN) value into a dense + // eigen Vector or RowVector, the argument would fail to load because the numpy copy would fail: + // numpy won't broadcast a Nx1 into a 1-dimensional vector. + m.def("iss1105_col", [](Eigen::VectorXd) { return true; }); + m.def("iss1105_row", [](Eigen::RowVectorXd) { return true; }); + + // test_named_arguments + // Make sure named arguments are working properly: + m.def("matrix_multiply", [](const py::EigenDRef A, const py::EigenDRef B) + -> Eigen::MatrixXd { + if (A.cols() != B.rows()) throw std::domain_error("Nonconformable matrices!"); + return A * B; + }, py::arg("A"), py::arg("B")); + + // test_custom_operator_new + py::class_(m, "CustomOperatorNew") + .def(py::init<>()) + .def_readonly("a", &CustomOperatorNew::a) + .def_readonly("b", &CustomOperatorNew::b); + + // test_eigen_ref_life_support + // In case of a failure (the caster's temp array does not live long enough), creating + // a new array (np.ones(10)) increases the chances that the temp array will be garbage + // collected and/or that its memory will be overridden with different values. + m.def("get_elem_direct", [](Eigen::Ref v) { + py::module::import("numpy").attr("ones")(10); + return v(5); + }); + m.def("get_elem_indirect", [](std::vector> v) { + py::module::import("numpy").attr("ones")(10); + return v[0](5); + }); +} diff --git a/plugins/python/pybind11/tests/test_eigen.py b/plugins/python/pybind11/tests/test_eigen.py new file mode 100644 index 0000000..45f64ca --- /dev/null +++ b/plugins/python/pybind11/tests/test_eigen.py @@ -0,0 +1,694 @@ +import pytest +from pybind11_tests import ConstructorStats + +pytestmark = pytest.requires_eigen_and_numpy + +with pytest.suppress(ImportError): + from pybind11_tests import eigen as m + import numpy as np + + ref = np.array([[ 0., 3, 0, 0, 0, 11], + [22, 0, 0, 0, 17, 11], + [ 7, 5, 0, 1, 0, 11], + [ 0, 0, 0, 0, 0, 11], + [ 0, 0, 14, 0, 8, 11]]) + + +def assert_equal_ref(mat): + np.testing.assert_array_equal(mat, ref) + + +def assert_sparse_equal_ref(sparse_mat): + assert_equal_ref(sparse_mat.toarray()) + + +def test_fixed(): + assert_equal_ref(m.fixed_c()) + assert_equal_ref(m.fixed_r()) + assert_equal_ref(m.fixed_copy_r(m.fixed_r())) + assert_equal_ref(m.fixed_copy_c(m.fixed_c())) + assert_equal_ref(m.fixed_copy_r(m.fixed_c())) + assert_equal_ref(m.fixed_copy_c(m.fixed_r())) + + +def test_dense(): + assert_equal_ref(m.dense_r()) + assert_equal_ref(m.dense_c()) + assert_equal_ref(m.dense_copy_r(m.dense_r())) + assert_equal_ref(m.dense_copy_c(m.dense_c())) + assert_equal_ref(m.dense_copy_r(m.dense_c())) + assert_equal_ref(m.dense_copy_c(m.dense_r())) + + +def test_partially_fixed(): + ref2 = np.array([[0., 1, 2, 3], [4, 5, 6, 7], [8, 9, 10, 11], [12, 13, 14, 15]]) + np.testing.assert_array_equal(m.partial_copy_four_rm_r(ref2), ref2) + np.testing.assert_array_equal(m.partial_copy_four_rm_c(ref2), ref2) + np.testing.assert_array_equal(m.partial_copy_four_rm_r(ref2[:, 1]), ref2[:, [1]]) + np.testing.assert_array_equal(m.partial_copy_four_rm_c(ref2[0, :]), ref2[[0], :]) + np.testing.assert_array_equal(m.partial_copy_four_rm_r(ref2[:, (0, 2)]), ref2[:, (0, 2)]) + np.testing.assert_array_equal( + m.partial_copy_four_rm_c(ref2[(3, 1, 2), :]), ref2[(3, 1, 2), :]) + + np.testing.assert_array_equal(m.partial_copy_four_cm_r(ref2), ref2) + np.testing.assert_array_equal(m.partial_copy_four_cm_c(ref2), ref2) + np.testing.assert_array_equal(m.partial_copy_four_cm_r(ref2[:, 1]), ref2[:, [1]]) + np.testing.assert_array_equal(m.partial_copy_four_cm_c(ref2[0, :]), ref2[[0], :]) + np.testing.assert_array_equal(m.partial_copy_four_cm_r(ref2[:, (0, 2)]), ref2[:, (0, 2)]) + np.testing.assert_array_equal( + m.partial_copy_four_cm_c(ref2[(3, 1, 2), :]), ref2[(3, 1, 2), :]) + + # TypeError should be raise for a shape mismatch + functions = [m.partial_copy_four_rm_r, m.partial_copy_four_rm_c, + m.partial_copy_four_cm_r, m.partial_copy_four_cm_c] + matrix_with_wrong_shape = [[1, 2], + [3, 4]] + for f in functions: + with pytest.raises(TypeError) as excinfo: + f(matrix_with_wrong_shape) + assert "incompatible function arguments" in str(excinfo.value) + + +def test_mutator_descriptors(): + zr = np.arange(30, dtype='float32').reshape(5, 6) # row-major + zc = zr.reshape(6, 5).transpose() # column-major + + m.fixed_mutator_r(zr) + m.fixed_mutator_c(zc) + m.fixed_mutator_a(zr) + m.fixed_mutator_a(zc) + with pytest.raises(TypeError) as excinfo: + m.fixed_mutator_r(zc) + assert ('(arg0: numpy.ndarray[float32[5, 6], flags.writeable, flags.c_contiguous]) -> None' + in str(excinfo.value)) + with pytest.raises(TypeError) as excinfo: + m.fixed_mutator_c(zr) + assert ('(arg0: numpy.ndarray[float32[5, 6], flags.writeable, flags.f_contiguous]) -> None' + in str(excinfo.value)) + with pytest.raises(TypeError) as excinfo: + m.fixed_mutator_a(np.array([[1, 2], [3, 4]], dtype='float32')) + assert ('(arg0: numpy.ndarray[float32[5, 6], flags.writeable]) -> None' + in str(excinfo.value)) + zr.flags.writeable = False + with pytest.raises(TypeError): + m.fixed_mutator_r(zr) + with pytest.raises(TypeError): + m.fixed_mutator_a(zr) + + +def test_cpp_casting(): + assert m.cpp_copy(m.fixed_r()) == 22. + assert m.cpp_copy(m.fixed_c()) == 22. + z = np.array([[5., 6], [7, 8]]) + assert m.cpp_copy(z) == 7. + assert m.cpp_copy(m.get_cm_ref()) == 21. + assert m.cpp_copy(m.get_rm_ref()) == 21. + assert m.cpp_ref_c(m.get_cm_ref()) == 21. + assert m.cpp_ref_r(m.get_rm_ref()) == 21. + with pytest.raises(RuntimeError) as excinfo: + # Can't reference m.fixed_c: it contains floats, m.cpp_ref_any wants doubles + m.cpp_ref_any(m.fixed_c()) + assert 'Unable to cast Python instance' in str(excinfo.value) + with pytest.raises(RuntimeError) as excinfo: + # Can't reference m.fixed_r: it contains floats, m.cpp_ref_any wants doubles + m.cpp_ref_any(m.fixed_r()) + assert 'Unable to cast Python instance' in str(excinfo.value) + assert m.cpp_ref_any(m.ReturnTester.create()) == 1. + + assert m.cpp_ref_any(m.get_cm_ref()) == 21. + assert m.cpp_ref_any(m.get_cm_ref()) == 21. + + +def test_pass_readonly_array(): + z = np.full((5, 6), 42.0) + z.flags.writeable = False + np.testing.assert_array_equal(z, m.fixed_copy_r(z)) + np.testing.assert_array_equal(m.fixed_r_const(), m.fixed_r()) + assert not m.fixed_r_const().flags.writeable + np.testing.assert_array_equal(m.fixed_copy_r(m.fixed_r_const()), m.fixed_r_const()) + + +def test_nonunit_stride_from_python(): + counting_mat = np.arange(9.0, dtype=np.float32).reshape((3, 3)) + second_row = counting_mat[1, :] + second_col = counting_mat[:, 1] + np.testing.assert_array_equal(m.double_row(second_row), 2.0 * second_row) + np.testing.assert_array_equal(m.double_col(second_row), 2.0 * second_row) + np.testing.assert_array_equal(m.double_complex(second_row), 2.0 * second_row) + np.testing.assert_array_equal(m.double_row(second_col), 2.0 * second_col) + np.testing.assert_array_equal(m.double_col(second_col), 2.0 * second_col) + np.testing.assert_array_equal(m.double_complex(second_col), 2.0 * second_col) + + counting_3d = np.arange(27.0, dtype=np.float32).reshape((3, 3, 3)) + slices = [counting_3d[0, :, :], counting_3d[:, 0, :], counting_3d[:, :, 0]] + for slice_idx, ref_mat in enumerate(slices): + np.testing.assert_array_equal(m.double_mat_cm(ref_mat), 2.0 * ref_mat) + np.testing.assert_array_equal(m.double_mat_rm(ref_mat), 2.0 * ref_mat) + + # Mutator: + m.double_threer(second_row) + m.double_threec(second_col) + np.testing.assert_array_equal(counting_mat, [[0., 2, 2], [6, 16, 10], [6, 14, 8]]) + + +def test_negative_stride_from_python(msg): + """Eigen doesn't support (as of yet) negative strides. When a function takes an Eigen matrix by + copy or const reference, we can pass a numpy array that has negative strides. Otherwise, an + exception will be thrown as Eigen will not be able to map the numpy array.""" + + counting_mat = np.arange(9.0, dtype=np.float32).reshape((3, 3)) + counting_mat = counting_mat[::-1, ::-1] + second_row = counting_mat[1, :] + second_col = counting_mat[:, 1] + np.testing.assert_array_equal(m.double_row(second_row), 2.0 * second_row) + np.testing.assert_array_equal(m.double_col(second_row), 2.0 * second_row) + np.testing.assert_array_equal(m.double_complex(second_row), 2.0 * second_row) + np.testing.assert_array_equal(m.double_row(second_col), 2.0 * second_col) + np.testing.assert_array_equal(m.double_col(second_col), 2.0 * second_col) + np.testing.assert_array_equal(m.double_complex(second_col), 2.0 * second_col) + + counting_3d = np.arange(27.0, dtype=np.float32).reshape((3, 3, 3)) + counting_3d = counting_3d[::-1, ::-1, ::-1] + slices = [counting_3d[0, :, :], counting_3d[:, 0, :], counting_3d[:, :, 0]] + for slice_idx, ref_mat in enumerate(slices): + np.testing.assert_array_equal(m.double_mat_cm(ref_mat), 2.0 * ref_mat) + np.testing.assert_array_equal(m.double_mat_rm(ref_mat), 2.0 * ref_mat) + + # Mutator: + with pytest.raises(TypeError) as excinfo: + m.double_threer(second_row) + assert msg(excinfo.value) == """ + double_threer(): incompatible function arguments. The following argument types are supported: + 1. (arg0: numpy.ndarray[float32[1, 3], flags.writeable]) -> None + + Invoked with: """ + repr(np.array([ 5., 4., 3.], dtype='float32')) # noqa: E501 line too long + + with pytest.raises(TypeError) as excinfo: + m.double_threec(second_col) + assert msg(excinfo.value) == """ + double_threec(): incompatible function arguments. The following argument types are supported: + 1. (arg0: numpy.ndarray[float32[3, 1], flags.writeable]) -> None + + Invoked with: """ + repr(np.array([ 7., 4., 1.], dtype='float32')) # noqa: E501 line too long + + +def test_nonunit_stride_to_python(): + assert np.all(m.diagonal(ref) == ref.diagonal()) + assert np.all(m.diagonal_1(ref) == ref.diagonal(1)) + for i in range(-5, 7): + assert np.all(m.diagonal_n(ref, i) == ref.diagonal(i)), "m.diagonal_n({})".format(i) + + assert np.all(m.block(ref, 2, 1, 3, 3) == ref[2:5, 1:4]) + assert np.all(m.block(ref, 1, 4, 4, 2) == ref[1:, 4:]) + assert np.all(m.block(ref, 1, 4, 3, 2) == ref[1:4, 4:]) + + +def test_eigen_ref_to_python(): + chols = [m.cholesky1, m.cholesky2, m.cholesky3, m.cholesky4] + for i, chol in enumerate(chols, start=1): + mymat = chol(np.array([[1., 2, 4], [2, 13, 23], [4, 23, 77]])) + assert np.all(mymat == np.array([[1, 0, 0], [2, 3, 0], [4, 5, 6]])), "cholesky{}".format(i) + + +def assign_both(a1, a2, r, c, v): + a1[r, c] = v + a2[r, c] = v + + +def array_copy_but_one(a, r, c, v): + z = np.array(a, copy=True) + z[r, c] = v + return z + + +def test_eigen_return_references(): + """Tests various ways of returning references and non-referencing copies""" + + master = np.ones((10, 10)) + a = m.ReturnTester() + a_get1 = a.get() + assert not a_get1.flags.owndata and a_get1.flags.writeable + assign_both(a_get1, master, 3, 3, 5) + a_get2 = a.get_ptr() + assert not a_get2.flags.owndata and a_get2.flags.writeable + assign_both(a_get1, master, 2, 3, 6) + + a_view1 = a.view() + assert not a_view1.flags.owndata and not a_view1.flags.writeable + with pytest.raises(ValueError): + a_view1[2, 3] = 4 + a_view2 = a.view_ptr() + assert not a_view2.flags.owndata and not a_view2.flags.writeable + with pytest.raises(ValueError): + a_view2[2, 3] = 4 + + a_copy1 = a.copy_get() + assert a_copy1.flags.owndata and a_copy1.flags.writeable + np.testing.assert_array_equal(a_copy1, master) + a_copy1[7, 7] = -44 # Shouldn't affect anything else + c1want = array_copy_but_one(master, 7, 7, -44) + a_copy2 = a.copy_view() + assert a_copy2.flags.owndata and a_copy2.flags.writeable + np.testing.assert_array_equal(a_copy2, master) + a_copy2[4, 4] = -22 # Shouldn't affect anything else + c2want = array_copy_but_one(master, 4, 4, -22) + + a_ref1 = a.ref() + assert not a_ref1.flags.owndata and a_ref1.flags.writeable + assign_both(a_ref1, master, 1, 1, 15) + a_ref2 = a.ref_const() + assert not a_ref2.flags.owndata and not a_ref2.flags.writeable + with pytest.raises(ValueError): + a_ref2[5, 5] = 33 + a_ref3 = a.ref_safe() + assert not a_ref3.flags.owndata and a_ref3.flags.writeable + assign_both(a_ref3, master, 0, 7, 99) + a_ref4 = a.ref_const_safe() + assert not a_ref4.flags.owndata and not a_ref4.flags.writeable + with pytest.raises(ValueError): + a_ref4[7, 0] = 987654321 + + a_copy3 = a.copy_ref() + assert a_copy3.flags.owndata and a_copy3.flags.writeable + np.testing.assert_array_equal(a_copy3, master) + a_copy3[8, 1] = 11 + c3want = array_copy_but_one(master, 8, 1, 11) + a_copy4 = a.copy_ref_const() + assert a_copy4.flags.owndata and a_copy4.flags.writeable + np.testing.assert_array_equal(a_copy4, master) + a_copy4[8, 4] = 88 + c4want = array_copy_but_one(master, 8, 4, 88) + + a_block1 = a.block(3, 3, 2, 2) + assert not a_block1.flags.owndata and a_block1.flags.writeable + a_block1[0, 0] = 55 + master[3, 3] = 55 + a_block2 = a.block_safe(2, 2, 3, 2) + assert not a_block2.flags.owndata and a_block2.flags.writeable + a_block2[2, 1] = -123 + master[4, 3] = -123 + a_block3 = a.block_const(6, 7, 4, 3) + assert not a_block3.flags.owndata and not a_block3.flags.writeable + with pytest.raises(ValueError): + a_block3[2, 2] = -44444 + + a_copy5 = a.copy_block(2, 2, 2, 3) + assert a_copy5.flags.owndata and a_copy5.flags.writeable + np.testing.assert_array_equal(a_copy5, master[2:4, 2:5]) + a_copy5[1, 1] = 777 + c5want = array_copy_but_one(master[2:4, 2:5], 1, 1, 777) + + a_corn1 = a.corners() + assert not a_corn1.flags.owndata and a_corn1.flags.writeable + a_corn1 *= 50 + a_corn1[1, 1] = 999 + master[0, 0] = 50 + master[0, 9] = 50 + master[9, 0] = 50 + master[9, 9] = 999 + a_corn2 = a.corners_const() + assert not a_corn2.flags.owndata and not a_corn2.flags.writeable + with pytest.raises(ValueError): + a_corn2[1, 0] = 51 + + # All of the changes made all the way along should be visible everywhere + # now (except for the copies, of course) + np.testing.assert_array_equal(a_get1, master) + np.testing.assert_array_equal(a_get2, master) + np.testing.assert_array_equal(a_view1, master) + np.testing.assert_array_equal(a_view2, master) + np.testing.assert_array_equal(a_ref1, master) + np.testing.assert_array_equal(a_ref2, master) + np.testing.assert_array_equal(a_ref3, master) + np.testing.assert_array_equal(a_ref4, master) + np.testing.assert_array_equal(a_block1, master[3:5, 3:5]) + np.testing.assert_array_equal(a_block2, master[2:5, 2:4]) + np.testing.assert_array_equal(a_block3, master[6:10, 7:10]) + np.testing.assert_array_equal(a_corn1, master[0::master.shape[0] - 1, 0::master.shape[1] - 1]) + np.testing.assert_array_equal(a_corn2, master[0::master.shape[0] - 1, 0::master.shape[1] - 1]) + + np.testing.assert_array_equal(a_copy1, c1want) + np.testing.assert_array_equal(a_copy2, c2want) + np.testing.assert_array_equal(a_copy3, c3want) + np.testing.assert_array_equal(a_copy4, c4want) + np.testing.assert_array_equal(a_copy5, c5want) + + +def assert_keeps_alive(cl, method, *args): + cstats = ConstructorStats.get(cl) + start_with = cstats.alive() + a = cl() + assert cstats.alive() == start_with + 1 + z = method(a, *args) + assert cstats.alive() == start_with + 1 + del a + # Here's the keep alive in action: + assert cstats.alive() == start_with + 1 + del z + # Keep alive should have expired: + assert cstats.alive() == start_with + + +def test_eigen_keepalive(): + a = m.ReturnTester() + cstats = ConstructorStats.get(m.ReturnTester) + assert cstats.alive() == 1 + unsafe = [a.ref(), a.ref_const(), a.block(1, 2, 3, 4)] + copies = [a.copy_get(), a.copy_view(), a.copy_ref(), a.copy_ref_const(), + a.copy_block(4, 3, 2, 1)] + del a + assert cstats.alive() == 0 + del unsafe + del copies + + for meth in [m.ReturnTester.get, m.ReturnTester.get_ptr, m.ReturnTester.view, + m.ReturnTester.view_ptr, m.ReturnTester.ref_safe, m.ReturnTester.ref_const_safe, + m.ReturnTester.corners, m.ReturnTester.corners_const]: + assert_keeps_alive(m.ReturnTester, meth) + + for meth in [m.ReturnTester.block_safe, m.ReturnTester.block_const]: + assert_keeps_alive(m.ReturnTester, meth, 4, 3, 2, 1) + + +def test_eigen_ref_mutators(): + """Tests Eigen's ability to mutate numpy values""" + + orig = np.array([[1., 2, 3], [4, 5, 6], [7, 8, 9]]) + zr = np.array(orig) + zc = np.array(orig, order='F') + m.add_rm(zr, 1, 0, 100) + assert np.all(zr == np.array([[1., 2, 3], [104, 5, 6], [7, 8, 9]])) + m.add_cm(zc, 1, 0, 200) + assert np.all(zc == np.array([[1., 2, 3], [204, 5, 6], [7, 8, 9]])) + + m.add_any(zr, 1, 0, 20) + assert np.all(zr == np.array([[1., 2, 3], [124, 5, 6], [7, 8, 9]])) + m.add_any(zc, 1, 0, 10) + assert np.all(zc == np.array([[1., 2, 3], [214, 5, 6], [7, 8, 9]])) + + # Can't reference a col-major array with a row-major Ref, and vice versa: + with pytest.raises(TypeError): + m.add_rm(zc, 1, 0, 1) + with pytest.raises(TypeError): + m.add_cm(zr, 1, 0, 1) + + # Overloads: + m.add1(zr, 1, 0, -100) + m.add2(zr, 1, 0, -20) + assert np.all(zr == orig) + m.add1(zc, 1, 0, -200) + m.add2(zc, 1, 0, -10) + assert np.all(zc == orig) + + # a non-contiguous slice (this won't work on either the row- or + # column-contiguous refs, but should work for the any) + cornersr = zr[0::2, 0::2] + cornersc = zc[0::2, 0::2] + + assert np.all(cornersr == np.array([[1., 3], [7, 9]])) + assert np.all(cornersc == np.array([[1., 3], [7, 9]])) + + with pytest.raises(TypeError): + m.add_rm(cornersr, 0, 1, 25) + with pytest.raises(TypeError): + m.add_cm(cornersr, 0, 1, 25) + with pytest.raises(TypeError): + m.add_rm(cornersc, 0, 1, 25) + with pytest.raises(TypeError): + m.add_cm(cornersc, 0, 1, 25) + m.add_any(cornersr, 0, 1, 25) + m.add_any(cornersc, 0, 1, 44) + assert np.all(zr == np.array([[1., 2, 28], [4, 5, 6], [7, 8, 9]])) + assert np.all(zc == np.array([[1., 2, 47], [4, 5, 6], [7, 8, 9]])) + + # You shouldn't be allowed to pass a non-writeable array to a mutating Eigen method: + zro = zr[0:4, 0:4] + zro.flags.writeable = False + with pytest.raises(TypeError): + m.add_rm(zro, 0, 0, 0) + with pytest.raises(TypeError): + m.add_any(zro, 0, 0, 0) + with pytest.raises(TypeError): + m.add1(zro, 0, 0, 0) + with pytest.raises(TypeError): + m.add2(zro, 0, 0, 0) + + # integer array shouldn't be passable to a double-matrix-accepting mutating func: + zi = np.array([[1, 2], [3, 4]]) + with pytest.raises(TypeError): + m.add_rm(zi) + + +def test_numpy_ref_mutators(): + """Tests numpy mutating Eigen matrices (for returned Eigen::Ref<...>s)""" + + m.reset_refs() # In case another test already changed it + + zc = m.get_cm_ref() + zcro = m.get_cm_const_ref() + zr = m.get_rm_ref() + zrro = m.get_rm_const_ref() + + assert [zc[1, 2], zcro[1, 2], zr[1, 2], zrro[1, 2]] == [23] * 4 + + assert not zc.flags.owndata and zc.flags.writeable + assert not zr.flags.owndata and zr.flags.writeable + assert not zcro.flags.owndata and not zcro.flags.writeable + assert not zrro.flags.owndata and not zrro.flags.writeable + + zc[1, 2] = 99 + expect = np.array([[11., 12, 13], [21, 22, 99], [31, 32, 33]]) + # We should have just changed zc, of course, but also zcro and the original eigen matrix + assert np.all(zc == expect) + assert np.all(zcro == expect) + assert np.all(m.get_cm_ref() == expect) + + zr[1, 2] = 99 + assert np.all(zr == expect) + assert np.all(zrro == expect) + assert np.all(m.get_rm_ref() == expect) + + # Make sure the readonly ones are numpy-readonly: + with pytest.raises(ValueError): + zcro[1, 2] = 6 + with pytest.raises(ValueError): + zrro[1, 2] = 6 + + # We should be able to explicitly copy like this (and since we're copying, + # the const should drop away) + y1 = np.array(m.get_cm_const_ref()) + + assert y1.flags.owndata and y1.flags.writeable + # We should get copies of the eigen data, which was modified above: + assert y1[1, 2] == 99 + y1[1, 2] += 12 + assert y1[1, 2] == 111 + assert zc[1, 2] == 99 # Make sure we aren't referencing the original + + +def test_both_ref_mutators(): + """Tests a complex chain of nested eigen/numpy references""" + + m.reset_refs() # In case another test already changed it + + z = m.get_cm_ref() # numpy -> eigen + z[0, 2] -= 3 + z2 = m.incr_matrix(z, 1) # numpy -> eigen -> numpy -> eigen + z2[1, 1] += 6 + z3 = m.incr_matrix(z, 2) # (numpy -> eigen)^3 + z3[2, 2] += -5 + z4 = m.incr_matrix(z, 3) # (numpy -> eigen)^4 + z4[1, 1] -= 1 + z5 = m.incr_matrix(z, 4) # (numpy -> eigen)^5 + z5[0, 0] = 0 + assert np.all(z == z2) + assert np.all(z == z3) + assert np.all(z == z4) + assert np.all(z == z5) + expect = np.array([[0., 22, 20], [31, 37, 33], [41, 42, 38]]) + assert np.all(z == expect) + + y = np.array(range(100), dtype='float64').reshape(10, 10) + y2 = m.incr_matrix_any(y, 10) # np -> eigen -> np + y3 = m.incr_matrix_any(y2[0::2, 0::2], -33) # np -> eigen -> np slice -> np -> eigen -> np + y4 = m.even_rows(y3) # numpy -> eigen slice -> (... y3) + y5 = m.even_cols(y4) # numpy -> eigen slice -> (... y4) + y6 = m.incr_matrix_any(y5, 1000) # numpy -> eigen -> (... y5) + + # Apply same mutations using just numpy: + yexpect = np.array(range(100), dtype='float64').reshape(10, 10) + yexpect += 10 + yexpect[0::2, 0::2] -= 33 + yexpect[0::4, 0::4] += 1000 + assert np.all(y6 == yexpect[0::4, 0::4]) + assert np.all(y5 == yexpect[0::4, 0::4]) + assert np.all(y4 == yexpect[0::4, 0::2]) + assert np.all(y3 == yexpect[0::2, 0::2]) + assert np.all(y2 == yexpect) + assert np.all(y == yexpect) + + +def test_nocopy_wrapper(): + # get_elem requires a column-contiguous matrix reference, but should be + # callable with other types of matrix (via copying): + int_matrix_colmajor = np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]], order='F') + dbl_matrix_colmajor = np.array(int_matrix_colmajor, dtype='double', order='F', copy=True) + int_matrix_rowmajor = np.array(int_matrix_colmajor, order='C', copy=True) + dbl_matrix_rowmajor = np.array(int_matrix_rowmajor, dtype='double', order='C', copy=True) + + # All should be callable via get_elem: + assert m.get_elem(int_matrix_colmajor) == 8 + assert m.get_elem(dbl_matrix_colmajor) == 8 + assert m.get_elem(int_matrix_rowmajor) == 8 + assert m.get_elem(dbl_matrix_rowmajor) == 8 + + # All but the second should fail with m.get_elem_nocopy: + with pytest.raises(TypeError) as excinfo: + m.get_elem_nocopy(int_matrix_colmajor) + assert ('get_elem_nocopy(): incompatible function arguments.' in str(excinfo.value) and + ', flags.f_contiguous' in str(excinfo.value)) + assert m.get_elem_nocopy(dbl_matrix_colmajor) == 8 + with pytest.raises(TypeError) as excinfo: + m.get_elem_nocopy(int_matrix_rowmajor) + assert ('get_elem_nocopy(): incompatible function arguments.' in str(excinfo.value) and + ', flags.f_contiguous' in str(excinfo.value)) + with pytest.raises(TypeError) as excinfo: + m.get_elem_nocopy(dbl_matrix_rowmajor) + assert ('get_elem_nocopy(): incompatible function arguments.' in str(excinfo.value) and + ', flags.f_contiguous' in str(excinfo.value)) + + # For the row-major test, we take a long matrix in row-major, so only the third is allowed: + with pytest.raises(TypeError) as excinfo: + m.get_elem_rm_nocopy(int_matrix_colmajor) + assert ('get_elem_rm_nocopy(): incompatible function arguments.' in str(excinfo.value) and + ', flags.c_contiguous' in str(excinfo.value)) + with pytest.raises(TypeError) as excinfo: + m.get_elem_rm_nocopy(dbl_matrix_colmajor) + assert ('get_elem_rm_nocopy(): incompatible function arguments.' in str(excinfo.value) and + ', flags.c_contiguous' in str(excinfo.value)) + assert m.get_elem_rm_nocopy(int_matrix_rowmajor) == 8 + with pytest.raises(TypeError) as excinfo: + m.get_elem_rm_nocopy(dbl_matrix_rowmajor) + assert ('get_elem_rm_nocopy(): incompatible function arguments.' in str(excinfo.value) and + ', flags.c_contiguous' in str(excinfo.value)) + + +def test_eigen_ref_life_support(): + """Ensure the lifetime of temporary arrays created by the `Ref` caster + + The `Ref` caster sometimes creates a copy which needs to stay alive. This needs to + happen both for directs casts (just the array) or indirectly (e.g. list of arrays). + """ + + a = np.full(shape=10, fill_value=8, dtype=np.int8) + assert m.get_elem_direct(a) == 8 + + list_of_a = [a] + assert m.get_elem_indirect(list_of_a) == 8 + + +def test_special_matrix_objects(): + assert np.all(m.incr_diag(7) == np.diag([1., 2, 3, 4, 5, 6, 7])) + + asymm = np.array([[ 1., 2, 3, 4], + [ 5, 6, 7, 8], + [ 9, 10, 11, 12], + [13, 14, 15, 16]]) + symm_lower = np.array(asymm) + symm_upper = np.array(asymm) + for i in range(4): + for j in range(i + 1, 4): + symm_lower[i, j] = symm_lower[j, i] + symm_upper[j, i] = symm_upper[i, j] + + assert np.all(m.symmetric_lower(asymm) == symm_lower) + assert np.all(m.symmetric_upper(asymm) == symm_upper) + + +def test_dense_signature(doc): + assert doc(m.double_col) == """ + double_col(arg0: numpy.ndarray[float32[m, 1]]) -> numpy.ndarray[float32[m, 1]] + """ + assert doc(m.double_row) == """ + double_row(arg0: numpy.ndarray[float32[1, n]]) -> numpy.ndarray[float32[1, n]] + """ + assert doc(m.double_complex) == """ + double_complex(arg0: numpy.ndarray[complex64[m, 1]]) -> numpy.ndarray[complex64[m, 1]] + """ + assert doc(m.double_mat_rm) == """ + double_mat_rm(arg0: numpy.ndarray[float32[m, n]]) -> numpy.ndarray[float32[m, n]] + """ + + +def test_named_arguments(): + a = np.array([[1.0, 2], [3, 4], [5, 6]]) + b = np.ones((2, 1)) + + assert np.all(m.matrix_multiply(a, b) == np.array([[3.], [7], [11]])) + assert np.all(m.matrix_multiply(A=a, B=b) == np.array([[3.], [7], [11]])) + assert np.all(m.matrix_multiply(B=b, A=a) == np.array([[3.], [7], [11]])) + + with pytest.raises(ValueError) as excinfo: + m.matrix_multiply(b, a) + assert str(excinfo.value) == 'Nonconformable matrices!' + + with pytest.raises(ValueError) as excinfo: + m.matrix_multiply(A=b, B=a) + assert str(excinfo.value) == 'Nonconformable matrices!' + + with pytest.raises(ValueError) as excinfo: + m.matrix_multiply(B=a, A=b) + assert str(excinfo.value) == 'Nonconformable matrices!' + + +@pytest.requires_eigen_and_scipy +def test_sparse(): + assert_sparse_equal_ref(m.sparse_r()) + assert_sparse_equal_ref(m.sparse_c()) + assert_sparse_equal_ref(m.sparse_copy_r(m.sparse_r())) + assert_sparse_equal_ref(m.sparse_copy_c(m.sparse_c())) + assert_sparse_equal_ref(m.sparse_copy_r(m.sparse_c())) + assert_sparse_equal_ref(m.sparse_copy_c(m.sparse_r())) + + +@pytest.requires_eigen_and_scipy +def test_sparse_signature(doc): + assert doc(m.sparse_copy_r) == """ + sparse_copy_r(arg0: scipy.sparse.csr_matrix[float32]) -> scipy.sparse.csr_matrix[float32] + """ # noqa: E501 line too long + assert doc(m.sparse_copy_c) == """ + sparse_copy_c(arg0: scipy.sparse.csc_matrix[float32]) -> scipy.sparse.csc_matrix[float32] + """ # noqa: E501 line too long + + +def test_issue738(): + """Ignore strides on a length-1 dimension (even if they would be incompatible length > 1)""" + assert np.all(m.iss738_f1(np.array([[1., 2, 3]])) == np.array([[1., 102, 203]])) + assert np.all(m.iss738_f1(np.array([[1.], [2], [3]])) == np.array([[1.], [12], [23]])) + + assert np.all(m.iss738_f2(np.array([[1., 2, 3]])) == np.array([[1., 102, 203]])) + assert np.all(m.iss738_f2(np.array([[1.], [2], [3]])) == np.array([[1.], [12], [23]])) + + +def test_issue1105(): + """Issue 1105: 1xN or Nx1 input arrays weren't accepted for eigen + compile-time row vectors or column vector""" + assert m.iss1105_row(np.ones((1, 7))) + assert m.iss1105_col(np.ones((7, 1))) + + # These should still fail (incompatible dimensions): + with pytest.raises(TypeError) as excinfo: + m.iss1105_row(np.ones((7, 1))) + assert "incompatible function arguments" in str(excinfo) + with pytest.raises(TypeError) as excinfo: + m.iss1105_col(np.ones((1, 7))) + assert "incompatible function arguments" in str(excinfo) + + +def test_custom_operator_new(): + """Using Eigen types as member variables requires a class-specific + operator new with proper alignment""" + + o = m.CustomOperatorNew() + np.testing.assert_allclose(o.a, 0.0) + np.testing.assert_allclose(o.b.diagonal(), 1.0) diff --git a/plugins/python/pybind11/tests/test_embed/CMakeLists.txt b/plugins/python/pybind11/tests/test_embed/CMakeLists.txt new file mode 100644 index 0000000..8b4f1f8 --- /dev/null +++ b/plugins/python/pybind11/tests/test_embed/CMakeLists.txt @@ -0,0 +1,41 @@ +if(${PYTHON_MODULE_EXTENSION} MATCHES "pypy") + add_custom_target(cpptest) # Dummy target on PyPy. Embedding is not supported. + set(_suppress_unused_variable_warning "${DOWNLOAD_CATCH}") + return() +endif() + +find_package(Catch 1.9.3) +if(CATCH_FOUND) + message(STATUS "Building interpreter tests using Catch v${CATCH_VERSION}") +else() + message(STATUS "Catch not detected. Interpreter tests will be skipped. Install Catch headers" + " manually or use `cmake -DDOWNLOAD_CATCH=1` to fetch them automatically.") + return() +endif() + +add_executable(test_embed + catch.cpp + test_interpreter.cpp +) +target_include_directories(test_embed PRIVATE ${CATCH_INCLUDE_DIR}) +pybind11_enable_warnings(test_embed) + +if(NOT CMAKE_VERSION VERSION_LESS 3.0) + target_link_libraries(test_embed PRIVATE pybind11::embed) +else() + target_include_directories(test_embed PRIVATE ${PYBIND11_INCLUDE_DIR} ${PYTHON_INCLUDE_DIRS}) + target_compile_options(test_embed PRIVATE ${PYBIND11_CPP_STANDARD}) + target_link_libraries(test_embed PRIVATE ${PYTHON_LIBRARIES}) +endif() + +find_package(Threads REQUIRED) +target_link_libraries(test_embed PUBLIC ${CMAKE_THREAD_LIBS_INIT}) + +add_custom_target(cpptest COMMAND $ + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) + +pybind11_add_module(external_module THIN_LTO external_module.cpp) +set_target_properties(external_module PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}) +add_dependencies(cpptest external_module) + +add_dependencies(check cpptest) diff --git a/plugins/python/pybind11/tests/test_embed/catch.cpp b/plugins/python/pybind11/tests/test_embed/catch.cpp new file mode 100644 index 0000000..dd13738 --- /dev/null +++ b/plugins/python/pybind11/tests/test_embed/catch.cpp @@ -0,0 +1,22 @@ +// The Catch implementation is compiled here. This is a standalone +// translation unit to avoid recompiling it for every test change. + +#include + +#ifdef _MSC_VER +// Silence MSVC C++17 deprecation warning from Catch regarding std::uncaught_exceptions (up to catch +// 2.0.1; this should be fixed in the next catch release after 2.0.1). +# pragma warning(disable: 4996) +#endif + +#define CATCH_CONFIG_RUNNER +#include + +namespace py = pybind11; + +int main(int argc, char *argv[]) { + py::scoped_interpreter guard{}; + auto result = Catch::Session().run(argc, argv); + + return result < 0xff ? result : 0xff; +} diff --git a/plugins/python/pybind11/tests/test_embed/external_module.cpp b/plugins/python/pybind11/tests/test_embed/external_module.cpp new file mode 100644 index 0000000..e9a6058 --- /dev/null +++ b/plugins/python/pybind11/tests/test_embed/external_module.cpp @@ -0,0 +1,23 @@ +#include + +namespace py = pybind11; + +/* Simple test module/test class to check that the referenced internals data of external pybind11 + * modules aren't preserved over a finalize/initialize. + */ + +PYBIND11_MODULE(external_module, m) { + class A { + public: + A(int value) : v{value} {}; + int v; + }; + + py::class_(m, "A") + .def(py::init()) + .def_readwrite("value", &A::v); + + m.def("internals_at", []() { + return reinterpret_cast(&py::detail::get_internals()); + }); +} diff --git a/plugins/python/pybind11/tests/test_embed/test_interpreter.cpp b/plugins/python/pybind11/tests/test_embed/test_interpreter.cpp new file mode 100644 index 0000000..222bd56 --- /dev/null +++ b/plugins/python/pybind11/tests/test_embed/test_interpreter.cpp @@ -0,0 +1,284 @@ +#include + +#ifdef _MSC_VER +// Silence MSVC C++17 deprecation warning from Catch regarding std::uncaught_exceptions (up to catch +// 2.0.1; this should be fixed in the next catch release after 2.0.1). +# pragma warning(disable: 4996) +#endif + +#include + +#include +#include +#include + +namespace py = pybind11; +using namespace py::literals; + +class Widget { +public: + Widget(std::string message) : message(message) { } + virtual ~Widget() = default; + + std::string the_message() const { return message; } + virtual int the_answer() const = 0; + +private: + std::string message; +}; + +class PyWidget final : public Widget { + using Widget::Widget; + + int the_answer() const override { PYBIND11_OVERLOAD_PURE(int, Widget, the_answer); } +}; + +PYBIND11_EMBEDDED_MODULE(widget_module, m) { + py::class_(m, "Widget") + .def(py::init()) + .def_property_readonly("the_message", &Widget::the_message); + + m.def("add", [](int i, int j) { return i + j; }); +} + +PYBIND11_EMBEDDED_MODULE(throw_exception, ) { + throw std::runtime_error("C++ Error"); +} + +PYBIND11_EMBEDDED_MODULE(throw_error_already_set, ) { + auto d = py::dict(); + d["missing"].cast(); +} + +TEST_CASE("Pass classes and data between modules defined in C++ and Python") { + auto module = py::module::import("test_interpreter"); + REQUIRE(py::hasattr(module, "DerivedWidget")); + + auto locals = py::dict("hello"_a="Hello, World!", "x"_a=5, **module.attr("__dict__")); + py::exec(R"( + widget = DerivedWidget("{} - {}".format(hello, x)) + message = widget.the_message + )", py::globals(), locals); + REQUIRE(locals["message"].cast() == "Hello, World! - 5"); + + auto py_widget = module.attr("DerivedWidget")("The question"); + auto message = py_widget.attr("the_message"); + REQUIRE(message.cast() == "The question"); + + const auto &cpp_widget = py_widget.cast(); + REQUIRE(cpp_widget.the_answer() == 42); +} + +TEST_CASE("Import error handling") { + REQUIRE_NOTHROW(py::module::import("widget_module")); + REQUIRE_THROWS_WITH(py::module::import("throw_exception"), + "ImportError: C++ Error"); + REQUIRE_THROWS_WITH(py::module::import("throw_error_already_set"), + Catch::Contains("ImportError: KeyError")); +} + +TEST_CASE("There can be only one interpreter") { + static_assert(std::is_move_constructible::value, ""); + static_assert(!std::is_move_assignable::value, ""); + static_assert(!std::is_copy_constructible::value, ""); + static_assert(!std::is_copy_assignable::value, ""); + + REQUIRE_THROWS_WITH(py::initialize_interpreter(), "The interpreter is already running"); + REQUIRE_THROWS_WITH(py::scoped_interpreter(), "The interpreter is already running"); + + py::finalize_interpreter(); + REQUIRE_NOTHROW(py::scoped_interpreter()); + { + auto pyi1 = py::scoped_interpreter(); + auto pyi2 = std::move(pyi1); + } + py::initialize_interpreter(); +} + +bool has_pybind11_internals_builtin() { + auto builtins = py::handle(PyEval_GetBuiltins()); + return builtins.contains(PYBIND11_INTERNALS_ID); +}; + +bool has_pybind11_internals_static() { + auto **&ipp = py::detail::get_internals_pp(); + return ipp && *ipp; +} + +TEST_CASE("Restart the interpreter") { + // Verify pre-restart state. + REQUIRE(py::module::import("widget_module").attr("add")(1, 2).cast() == 3); + REQUIRE(has_pybind11_internals_builtin()); + REQUIRE(has_pybind11_internals_static()); + REQUIRE(py::module::import("external_module").attr("A")(123).attr("value").cast() == 123); + + // local and foreign module internals should point to the same internals: + REQUIRE(reinterpret_cast(*py::detail::get_internals_pp()) == + py::module::import("external_module").attr("internals_at")().cast()); + + // Restart the interpreter. + py::finalize_interpreter(); + REQUIRE(Py_IsInitialized() == 0); + + py::initialize_interpreter(); + REQUIRE(Py_IsInitialized() == 1); + + // Internals are deleted after a restart. + REQUIRE_FALSE(has_pybind11_internals_builtin()); + REQUIRE_FALSE(has_pybind11_internals_static()); + pybind11::detail::get_internals(); + REQUIRE(has_pybind11_internals_builtin()); + REQUIRE(has_pybind11_internals_static()); + REQUIRE(reinterpret_cast(*py::detail::get_internals_pp()) == + py::module::import("external_module").attr("internals_at")().cast()); + + // Make sure that an interpreter with no get_internals() created until finalize still gets the + // internals destroyed + py::finalize_interpreter(); + py::initialize_interpreter(); + bool ran = false; + py::module::import("__main__").attr("internals_destroy_test") = + py::capsule(&ran, [](void *ran) { py::detail::get_internals(); *static_cast(ran) = true; }); + REQUIRE_FALSE(has_pybind11_internals_builtin()); + REQUIRE_FALSE(has_pybind11_internals_static()); + REQUIRE_FALSE(ran); + py::finalize_interpreter(); + REQUIRE(ran); + py::initialize_interpreter(); + REQUIRE_FALSE(has_pybind11_internals_builtin()); + REQUIRE_FALSE(has_pybind11_internals_static()); + + // C++ modules can be reloaded. + auto cpp_module = py::module::import("widget_module"); + REQUIRE(cpp_module.attr("add")(1, 2).cast() == 3); + + // C++ type information is reloaded and can be used in python modules. + auto py_module = py::module::import("test_interpreter"); + auto py_widget = py_module.attr("DerivedWidget")("Hello after restart"); + REQUIRE(py_widget.attr("the_message").cast() == "Hello after restart"); +} + +TEST_CASE("Subinterpreter") { + // Add tags to the modules in the main interpreter and test the basics. + py::module::import("__main__").attr("main_tag") = "main interpreter"; + { + auto m = py::module::import("widget_module"); + m.attr("extension_module_tag") = "added to module in main interpreter"; + + REQUIRE(m.attr("add")(1, 2).cast() == 3); + } + REQUIRE(has_pybind11_internals_builtin()); + REQUIRE(has_pybind11_internals_static()); + + /// Create and switch to a subinterpreter. + auto main_tstate = PyThreadState_Get(); + auto sub_tstate = Py_NewInterpreter(); + + // Subinterpreters get their own copy of builtins. detail::get_internals() still + // works by returning from the static variable, i.e. all interpreters share a single + // global pybind11::internals; + REQUIRE_FALSE(has_pybind11_internals_builtin()); + REQUIRE(has_pybind11_internals_static()); + + // Modules tags should be gone. + REQUIRE_FALSE(py::hasattr(py::module::import("__main__"), "tag")); + { + auto m = py::module::import("widget_module"); + REQUIRE_FALSE(py::hasattr(m, "extension_module_tag")); + + // Function bindings should still work. + REQUIRE(m.attr("add")(1, 2).cast() == 3); + } + + // Restore main interpreter. + Py_EndInterpreter(sub_tstate); + PyThreadState_Swap(main_tstate); + + REQUIRE(py::hasattr(py::module::import("__main__"), "main_tag")); + REQUIRE(py::hasattr(py::module::import("widget_module"), "extension_module_tag")); +} + +TEST_CASE("Execution frame") { + // When the interpreter is embedded, there is no execution frame, but `py::exec` + // should still function by using reasonable globals: `__main__.__dict__`. + py::exec("var = dict(number=42)"); + REQUIRE(py::globals()["var"]["number"].cast() == 42); +} + +TEST_CASE("Threads") { + // Restart interpreter to ensure threads are not initialized + py::finalize_interpreter(); + py::initialize_interpreter(); + REQUIRE_FALSE(has_pybind11_internals_static()); + + constexpr auto num_threads = 10; + auto locals = py::dict("count"_a=0); + + { + py::gil_scoped_release gil_release{}; + REQUIRE(has_pybind11_internals_static()); + + auto threads = std::vector(); + for (auto i = 0; i < num_threads; ++i) { + threads.emplace_back([&]() { + py::gil_scoped_acquire gil{}; + locals["count"] = locals["count"].cast() + 1; + }); + } + + for (auto &thread : threads) { + thread.join(); + } + } + + REQUIRE(locals["count"].cast() == num_threads); +} + +// Scope exit utility https://stackoverflow.com/a/36644501/7255855 +struct scope_exit { + std::function f_; + explicit scope_exit(std::function f) noexcept : f_(std::move(f)) {} + ~scope_exit() { if (f_) f_(); } +}; + +TEST_CASE("Reload module from file") { + // Disable generation of cached bytecode (.pyc files) for this test, otherwise + // Python might pick up an old version from the cache instead of the new versions + // of the .py files generated below + auto sys = py::module::import("sys"); + bool dont_write_bytecode = sys.attr("dont_write_bytecode").cast(); + sys.attr("dont_write_bytecode") = true; + // Reset the value at scope exit + scope_exit reset_dont_write_bytecode([&]() { + sys.attr("dont_write_bytecode") = dont_write_bytecode; + }); + + std::string module_name = "test_module_reload"; + std::string module_file = module_name + ".py"; + + // Create the module .py file + std::ofstream test_module(module_file); + test_module << "def test():\n"; + test_module << " return 1\n"; + test_module.close(); + // Delete the file at scope exit + scope_exit delete_module_file([&]() { + std::remove(module_file.c_str()); + }); + + // Import the module from file + auto module = py::module::import(module_name.c_str()); + int result = module.attr("test")().cast(); + REQUIRE(result == 1); + + // Update the module .py file with a small change + test_module.open(module_file); + test_module << "def test():\n"; + test_module << " return 2\n"; + test_module.close(); + + // Reload the module + module.reload(); + result = module.attr("test")().cast(); + REQUIRE(result == 2); +} diff --git a/plugins/python/pybind11/tests/test_embed/test_interpreter.py b/plugins/python/pybind11/tests/test_embed/test_interpreter.py new file mode 100644 index 0000000..26a0479 --- /dev/null +++ b/plugins/python/pybind11/tests/test_embed/test_interpreter.py @@ -0,0 +1,9 @@ +from widget_module import Widget + + +class DerivedWidget(Widget): + def __init__(self, message): + super(DerivedWidget, self).__init__(message) + + def the_answer(self): + return 42 diff --git a/plugins/python/pybind11/tests/test_enum.cpp b/plugins/python/pybind11/tests/test_enum.cpp new file mode 100644 index 0000000..49f31ba --- /dev/null +++ b/plugins/python/pybind11/tests/test_enum.cpp @@ -0,0 +1,71 @@ +/* + tests/test_enums.cpp -- enumerations + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +TEST_SUBMODULE(enums, m) { + // test_unscoped_enum + enum UnscopedEnum { + EOne = 1, + ETwo + }; + py::enum_(m, "UnscopedEnum", py::arithmetic()) + .value("EOne", EOne) + .value("ETwo", ETwo) + .export_values(); + + // test_scoped_enum + enum class ScopedEnum { + Two = 2, + Three + }; + py::enum_(m, "ScopedEnum", py::arithmetic()) + .value("Two", ScopedEnum::Two) + .value("Three", ScopedEnum::Three); + + m.def("test_scoped_enum", [](ScopedEnum z) { + return "ScopedEnum::" + std::string(z == ScopedEnum::Two ? "Two" : "Three"); + }); + + // test_binary_operators + enum Flags { + Read = 4, + Write = 2, + Execute = 1 + }; + py::enum_(m, "Flags", py::arithmetic()) + .value("Read", Flags::Read) + .value("Write", Flags::Write) + .value("Execute", Flags::Execute) + .export_values(); + + // test_implicit_conversion + class ClassWithUnscopedEnum { + public: + enum EMode { + EFirstMode = 1, + ESecondMode + }; + + static EMode test_function(EMode mode) { + return mode; + } + }; + py::class_ exenum_class(m, "ClassWithUnscopedEnum"); + exenum_class.def_static("test_function", &ClassWithUnscopedEnum::test_function); + py::enum_(exenum_class, "EMode") + .value("EFirstMode", ClassWithUnscopedEnum::EFirstMode) + .value("ESecondMode", ClassWithUnscopedEnum::ESecondMode) + .export_values(); + + // test_enum_to_int + m.def("test_enum_to_int", [](int) { }); + m.def("test_enum_to_uint", [](uint32_t) { }); + m.def("test_enum_to_long_long", [](long long) { }); +} diff --git a/plugins/python/pybind11/tests/test_enum.py b/plugins/python/pybind11/tests/test_enum.py new file mode 100644 index 0000000..d8eff52 --- /dev/null +++ b/plugins/python/pybind11/tests/test_enum.py @@ -0,0 +1,121 @@ +import pytest +from pybind11_tests import enums as m + + +def test_unscoped_enum(): + assert str(m.UnscopedEnum.EOne) == "UnscopedEnum.EOne" + assert str(m.UnscopedEnum.ETwo) == "UnscopedEnum.ETwo" + assert str(m.EOne) == "UnscopedEnum.EOne" + # __members__ property + assert m.UnscopedEnum.__members__ == \ + {"EOne": m.UnscopedEnum.EOne, "ETwo": m.UnscopedEnum.ETwo} + # __members__ readonly + with pytest.raises(AttributeError): + m.UnscopedEnum.__members__ = {} + # __members__ returns a copy + foo = m.UnscopedEnum.__members__ + foo["bar"] = "baz" + assert m.UnscopedEnum.__members__ == \ + {"EOne": m.UnscopedEnum.EOne, "ETwo": m.UnscopedEnum.ETwo} + + # no TypeError exception for unscoped enum ==/!= int comparisons + y = m.UnscopedEnum.ETwo + assert y == 2 + assert y != 3 + + assert int(m.UnscopedEnum.ETwo) == 2 + assert str(m.UnscopedEnum(2)) == "UnscopedEnum.ETwo" + + # order + assert m.UnscopedEnum.EOne < m.UnscopedEnum.ETwo + assert m.UnscopedEnum.EOne < 2 + assert m.UnscopedEnum.ETwo > m.UnscopedEnum.EOne + assert m.UnscopedEnum.ETwo > 1 + assert m.UnscopedEnum.ETwo <= 2 + assert m.UnscopedEnum.ETwo >= 2 + assert m.UnscopedEnum.EOne <= m.UnscopedEnum.ETwo + assert m.UnscopedEnum.EOne <= 2 + assert m.UnscopedEnum.ETwo >= m.UnscopedEnum.EOne + assert m.UnscopedEnum.ETwo >= 1 + assert not (m.UnscopedEnum.ETwo < m.UnscopedEnum.EOne) + assert not (2 < m.UnscopedEnum.EOne) + + +def test_scoped_enum(): + assert m.test_scoped_enum(m.ScopedEnum.Three) == "ScopedEnum::Three" + z = m.ScopedEnum.Two + assert m.test_scoped_enum(z) == "ScopedEnum::Two" + + # expected TypeError exceptions for scoped enum ==/!= int comparisons + with pytest.raises(TypeError): + assert z == 2 + with pytest.raises(TypeError): + assert z != 3 + + # order + assert m.ScopedEnum.Two < m.ScopedEnum.Three + assert m.ScopedEnum.Three > m.ScopedEnum.Two + assert m.ScopedEnum.Two <= m.ScopedEnum.Three + assert m.ScopedEnum.Two <= m.ScopedEnum.Two + assert m.ScopedEnum.Two >= m.ScopedEnum.Two + assert m.ScopedEnum.Three >= m.ScopedEnum.Two + + +def test_implicit_conversion(): + assert str(m.ClassWithUnscopedEnum.EMode.EFirstMode) == "EMode.EFirstMode" + assert str(m.ClassWithUnscopedEnum.EFirstMode) == "EMode.EFirstMode" + + f = m.ClassWithUnscopedEnum.test_function + first = m.ClassWithUnscopedEnum.EFirstMode + second = m.ClassWithUnscopedEnum.ESecondMode + + assert f(first) == 1 + + assert f(first) == f(first) + assert not f(first) != f(first) + + assert f(first) != f(second) + assert not f(first) == f(second) + + assert f(first) == int(f(first)) + assert not f(first) != int(f(first)) + + assert f(first) != int(f(second)) + assert not f(first) == int(f(second)) + + # noinspection PyDictCreation + x = {f(first): 1, f(second): 2} + x[f(first)] = 3 + x[f(second)] = 4 + # Hashing test + assert str(x) == "{EMode.EFirstMode: 3, EMode.ESecondMode: 4}" + + +def test_binary_operators(): + assert int(m.Flags.Read) == 4 + assert int(m.Flags.Write) == 2 + assert int(m.Flags.Execute) == 1 + assert int(m.Flags.Read | m.Flags.Write | m.Flags.Execute) == 7 + assert int(m.Flags.Read | m.Flags.Write) == 6 + assert int(m.Flags.Read | m.Flags.Execute) == 5 + assert int(m.Flags.Write | m.Flags.Execute) == 3 + assert int(m.Flags.Write | 1) == 3 + + state = m.Flags.Read | m.Flags.Write + assert (state & m.Flags.Read) != 0 + assert (state & m.Flags.Write) != 0 + assert (state & m.Flags.Execute) == 0 + assert (state & 1) == 0 + + state2 = ~state + assert state2 == -7 + assert int(state ^ state2) == -1 + + +def test_enum_to_int(): + m.test_enum_to_int(m.Flags.Read) + m.test_enum_to_int(m.ClassWithUnscopedEnum.EMode.EFirstMode) + m.test_enum_to_uint(m.Flags.Read) + m.test_enum_to_uint(m.ClassWithUnscopedEnum.EMode.EFirstMode) + m.test_enum_to_long_long(m.Flags.Read) + m.test_enum_to_long_long(m.ClassWithUnscopedEnum.EMode.EFirstMode) diff --git a/plugins/python/pybind11/tests/test_eval.cpp b/plugins/python/pybind11/tests/test_eval.cpp new file mode 100644 index 0000000..e094821 --- /dev/null +++ b/plugins/python/pybind11/tests/test_eval.cpp @@ -0,0 +1,91 @@ +/* + tests/test_eval.cpp -- Usage of eval() and eval_file() + + Copyright (c) 2016 Klemens D. Morgenstern + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + + +#include +#include "pybind11_tests.h" + +TEST_SUBMODULE(eval_, m) { + // test_evals + + auto global = py::dict(py::module::import("__main__").attr("__dict__")); + + m.def("test_eval_statements", [global]() { + auto local = py::dict(); + local["call_test"] = py::cpp_function([&]() -> int { + return 42; + }); + + // Regular string literal + py::exec( + "message = 'Hello World!'\n" + "x = call_test()", + global, local + ); + + // Multi-line raw string literal + py::exec(R"( + if x == 42: + print(message) + else: + raise RuntimeError + )", global, local + ); + auto x = local["x"].cast(); + + return x == 42; + }); + + m.def("test_eval", [global]() { + auto local = py::dict(); + local["x"] = py::int_(42); + auto x = py::eval("x", global, local); + return x.cast() == 42; + }); + + m.def("test_eval_single_statement", []() { + auto local = py::dict(); + local["call_test"] = py::cpp_function([&]() -> int { + return 42; + }); + + auto result = py::eval("x = call_test()", py::dict(), local); + auto x = local["x"].cast(); + return result.is_none() && x == 42; + }); + + m.def("test_eval_file", [global](py::str filename) { + auto local = py::dict(); + local["y"] = py::int_(43); + + int val_out; + local["call_test2"] = py::cpp_function([&](int value) { val_out = value; }); + + auto result = py::eval_file(filename, global, local); + return val_out == 43 && result.is_none(); + }); + + m.def("test_eval_failure", []() { + try { + py::eval("nonsense code ..."); + } catch (py::error_already_set &) { + return true; + } + return false; + }); + + m.def("test_eval_file_failure", []() { + try { + py::eval_file("non-existing file"); + } catch (std::exception &) { + return true; + } + return false; + }); +} diff --git a/plugins/python/pybind11/tests/test_eval.py b/plugins/python/pybind11/tests/test_eval.py new file mode 100644 index 0000000..bda4ef6 --- /dev/null +++ b/plugins/python/pybind11/tests/test_eval.py @@ -0,0 +1,17 @@ +import os +from pybind11_tests import eval_ as m + + +def test_evals(capture): + with capture: + assert m.test_eval_statements() + assert capture == "Hello World!" + + assert m.test_eval() + assert m.test_eval_single_statement() + + filename = os.path.join(os.path.dirname(__file__), "test_eval_call.py") + assert m.test_eval_file(filename) + + assert m.test_eval_failure() + assert m.test_eval_file_failure() diff --git a/plugins/python/pybind11/tests/test_eval_call.py b/plugins/python/pybind11/tests/test_eval_call.py new file mode 100644 index 0000000..53c7e72 --- /dev/null +++ b/plugins/python/pybind11/tests/test_eval_call.py @@ -0,0 +1,4 @@ +# This file is called from 'test_eval.py' + +if 'call_test2' in locals(): + call_test2(y) # noqa: F821 undefined name diff --git a/plugins/python/pybind11/tests/test_exceptions.cpp b/plugins/python/pybind11/tests/test_exceptions.cpp new file mode 100644 index 0000000..cf20214 --- /dev/null +++ b/plugins/python/pybind11/tests/test_exceptions.cpp @@ -0,0 +1,168 @@ +/* + tests/test_custom-exceptions.cpp -- exception translation + + Copyright (c) 2016 Pim Schellart + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +// A type that should be raised as an exception in Python +class MyException : public std::exception { +public: + explicit MyException(const char * m) : message{m} {} + virtual const char * what() const noexcept override {return message.c_str();} +private: + std::string message = ""; +}; + +// A type that should be translated to a standard Python exception +class MyException2 : public std::exception { +public: + explicit MyException2(const char * m) : message{m} {} + virtual const char * what() const noexcept override {return message.c_str();} +private: + std::string message = ""; +}; + +// A type that is not derived from std::exception (and is thus unknown) +class MyException3 { +public: + explicit MyException3(const char * m) : message{m} {} + virtual const char * what() const noexcept {return message.c_str();} +private: + std::string message = ""; +}; + +// A type that should be translated to MyException +// and delegated to its exception translator +class MyException4 : public std::exception { +public: + explicit MyException4(const char * m) : message{m} {} + virtual const char * what() const noexcept override {return message.c_str();} +private: + std::string message = ""; +}; + + +// Like the above, but declared via the helper function +class MyException5 : public std::logic_error { +public: + explicit MyException5(const std::string &what) : std::logic_error(what) {} +}; + +// Inherits from MyException5 +class MyException5_1 : public MyException5 { + using MyException5::MyException5; +}; + +struct PythonCallInDestructor { + PythonCallInDestructor(const py::dict &d) : d(d) {} + ~PythonCallInDestructor() { d["good"] = true; } + + py::dict d; +}; + +TEST_SUBMODULE(exceptions, m) { + m.def("throw_std_exception", []() { + throw std::runtime_error("This exception was intentionally thrown."); + }); + + // make a new custom exception and use it as a translation target + static py::exception ex(m, "MyException"); + py::register_exception_translator([](std::exception_ptr p) { + try { + if (p) std::rethrow_exception(p); + } catch (const MyException &e) { + // Set MyException as the active python error + ex(e.what()); + } + }); + + // register new translator for MyException2 + // no need to store anything here because this type will + // never by visible from Python + py::register_exception_translator([](std::exception_ptr p) { + try { + if (p) std::rethrow_exception(p); + } catch (const MyException2 &e) { + // Translate this exception to a standard RuntimeError + PyErr_SetString(PyExc_RuntimeError, e.what()); + } + }); + + // register new translator for MyException4 + // which will catch it and delegate to the previously registered + // translator for MyException by throwing a new exception + py::register_exception_translator([](std::exception_ptr p) { + try { + if (p) std::rethrow_exception(p); + } catch (const MyException4 &e) { + throw MyException(e.what()); + } + }); + + // A simple exception translation: + auto ex5 = py::register_exception(m, "MyException5"); + // A slightly more complicated one that declares MyException5_1 as a subclass of MyException5 + py::register_exception(m, "MyException5_1", ex5.ptr()); + + m.def("throws1", []() { throw MyException("this error should go to a custom type"); }); + m.def("throws2", []() { throw MyException2("this error should go to a standard Python exception"); }); + m.def("throws3", []() { throw MyException3("this error cannot be translated"); }); + m.def("throws4", []() { throw MyException4("this error is rethrown"); }); + m.def("throws5", []() { throw MyException5("this is a helper-defined translated exception"); }); + m.def("throws5_1", []() { throw MyException5_1("MyException5 subclass"); }); + m.def("throws_logic_error", []() { throw std::logic_error("this error should fall through to the standard handler"); }); + m.def("exception_matches", []() { + py::dict foo; + try { foo["bar"]; } + catch (py::error_already_set& ex) { + if (!ex.matches(PyExc_KeyError)) throw; + } + }); + + m.def("throw_already_set", [](bool err) { + if (err) + PyErr_SetString(PyExc_ValueError, "foo"); + try { + throw py::error_already_set(); + } catch (const std::runtime_error& e) { + if ((err && e.what() != std::string("ValueError: foo")) || + (!err && e.what() != std::string("Unknown internal error occurred"))) + { + PyErr_Clear(); + throw std::runtime_error("error message mismatch"); + } + } + PyErr_Clear(); + if (err) + PyErr_SetString(PyExc_ValueError, "foo"); + throw py::error_already_set(); + }); + + m.def("python_call_in_destructor", [](py::dict d) { + try { + PythonCallInDestructor set_dict_in_destructor(d); + PyErr_SetString(PyExc_ValueError, "foo"); + throw py::error_already_set(); + } catch (const py::error_already_set&) { + return true; + } + return false; + }); + + // test_nested_throws + m.def("try_catch", [m](py::object exc_type, py::function f, py::args args) { + try { f(*args); } + catch (py::error_already_set &ex) { + if (ex.matches(exc_type)) + py::print(ex.what()); + else + throw; + } + }); + +} diff --git a/plugins/python/pybind11/tests/test_exceptions.py b/plugins/python/pybind11/tests/test_exceptions.py new file mode 100644 index 0000000..8d37c09 --- /dev/null +++ b/plugins/python/pybind11/tests/test_exceptions.py @@ -0,0 +1,144 @@ +import pytest + +from pybind11_tests import exceptions as m +import pybind11_cross_module_tests as cm + + +def test_std_exception(msg): + with pytest.raises(RuntimeError) as excinfo: + m.throw_std_exception() + assert msg(excinfo.value) == "This exception was intentionally thrown." + + +def test_error_already_set(msg): + with pytest.raises(RuntimeError) as excinfo: + m.throw_already_set(False) + assert msg(excinfo.value) == "Unknown internal error occurred" + + with pytest.raises(ValueError) as excinfo: + m.throw_already_set(True) + assert msg(excinfo.value) == "foo" + + +def test_cross_module_exceptions(): + with pytest.raises(RuntimeError) as excinfo: + cm.raise_runtime_error() + assert str(excinfo.value) == "My runtime error" + + with pytest.raises(ValueError) as excinfo: + cm.raise_value_error() + assert str(excinfo.value) == "My value error" + + with pytest.raises(ValueError) as excinfo: + cm.throw_pybind_value_error() + assert str(excinfo.value) == "pybind11 value error" + + with pytest.raises(TypeError) as excinfo: + cm.throw_pybind_type_error() + assert str(excinfo.value) == "pybind11 type error" + + with pytest.raises(StopIteration) as excinfo: + cm.throw_stop_iteration() + + +def test_python_call_in_catch(): + d = {} + assert m.python_call_in_destructor(d) is True + assert d["good"] is True + + +def test_exception_matches(): + m.exception_matches() + + +def test_custom(msg): + # Can we catch a MyException? + with pytest.raises(m.MyException) as excinfo: + m.throws1() + assert msg(excinfo.value) == "this error should go to a custom type" + + # Can we translate to standard Python exceptions? + with pytest.raises(RuntimeError) as excinfo: + m.throws2() + assert msg(excinfo.value) == "this error should go to a standard Python exception" + + # Can we handle unknown exceptions? + with pytest.raises(RuntimeError) as excinfo: + m.throws3() + assert msg(excinfo.value) == "Caught an unknown exception!" + + # Can we delegate to another handler by rethrowing? + with pytest.raises(m.MyException) as excinfo: + m.throws4() + assert msg(excinfo.value) == "this error is rethrown" + + # Can we fall-through to the default handler? + with pytest.raises(RuntimeError) as excinfo: + m.throws_logic_error() + assert msg(excinfo.value) == "this error should fall through to the standard handler" + + # Can we handle a helper-declared exception? + with pytest.raises(m.MyException5) as excinfo: + m.throws5() + assert msg(excinfo.value) == "this is a helper-defined translated exception" + + # Exception subclassing: + with pytest.raises(m.MyException5) as excinfo: + m.throws5_1() + assert msg(excinfo.value) == "MyException5 subclass" + assert isinstance(excinfo.value, m.MyException5_1) + + with pytest.raises(m.MyException5_1) as excinfo: + m.throws5_1() + assert msg(excinfo.value) == "MyException5 subclass" + + with pytest.raises(m.MyException5) as excinfo: + try: + m.throws5() + except m.MyException5_1: + raise RuntimeError("Exception error: caught child from parent") + assert msg(excinfo.value) == "this is a helper-defined translated exception" + + +def test_nested_throws(capture): + """Tests nested (e.g. C++ -> Python -> C++) exception handling""" + + def throw_myex(): + raise m.MyException("nested error") + + def throw_myex5(): + raise m.MyException5("nested error 5") + + # In the comments below, the exception is caught in the first step, thrown in the last step + + # C++ -> Python + with capture: + m.try_catch(m.MyException5, throw_myex5) + assert str(capture).startswith("MyException5: nested error 5") + + # Python -> C++ -> Python + with pytest.raises(m.MyException) as excinfo: + m.try_catch(m.MyException5, throw_myex) + assert str(excinfo.value) == "nested error" + + def pycatch(exctype, f, *args): + try: + f(*args) + except m.MyException as e: + print(e) + + # C++ -> Python -> C++ -> Python + with capture: + m.try_catch( + m.MyException5, pycatch, m.MyException, m.try_catch, m.MyException, throw_myex5) + assert str(capture).startswith("MyException5: nested error 5") + + # C++ -> Python -> C++ + with capture: + m.try_catch(m.MyException, pycatch, m.MyException5, m.throws4) + assert capture == "this error is rethrown" + + # Python -> C++ -> Python -> C++ + with pytest.raises(m.MyException5) as excinfo: + m.try_catch(m.MyException, pycatch, m.MyException, m.throws5) + assert str(excinfo.value) == "this is a helper-defined translated exception" diff --git a/plugins/python/pybind11/tests/test_factory_constructors.cpp b/plugins/python/pybind11/tests/test_factory_constructors.cpp new file mode 100644 index 0000000..687a5bf --- /dev/null +++ b/plugins/python/pybind11/tests/test_factory_constructors.cpp @@ -0,0 +1,337 @@ +/* + tests/test_factory_constructors.cpp -- tests construction from a factory function + via py::init_factory() + + Copyright (c) 2017 Jason Rhinelander + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include + +// Classes for testing python construction via C++ factory function: +// Not publicly constructible, copyable, or movable: +class TestFactory1 { + friend class TestFactoryHelper; + TestFactory1() : value("(empty)") { print_default_created(this); } + TestFactory1(int v) : value(std::to_string(v)) { print_created(this, value); } + TestFactory1(std::string v) : value(std::move(v)) { print_created(this, value); } + TestFactory1(TestFactory1 &&) = delete; + TestFactory1(const TestFactory1 &) = delete; + TestFactory1 &operator=(TestFactory1 &&) = delete; + TestFactory1 &operator=(const TestFactory1 &) = delete; +public: + std::string value; + ~TestFactory1() { print_destroyed(this); } +}; +// Non-public construction, but moveable: +class TestFactory2 { + friend class TestFactoryHelper; + TestFactory2() : value("(empty2)") { print_default_created(this); } + TestFactory2(int v) : value(std::to_string(v)) { print_created(this, value); } + TestFactory2(std::string v) : value(std::move(v)) { print_created(this, value); } +public: + TestFactory2(TestFactory2 &&m) { value = std::move(m.value); print_move_created(this); } + TestFactory2 &operator=(TestFactory2 &&m) { value = std::move(m.value); print_move_assigned(this); return *this; } + std::string value; + ~TestFactory2() { print_destroyed(this); } +}; +// Mixed direct/factory construction: +class TestFactory3 { +protected: + friend class TestFactoryHelper; + TestFactory3() : value("(empty3)") { print_default_created(this); } + TestFactory3(int v) : value(std::to_string(v)) { print_created(this, value); } +public: + TestFactory3(std::string v) : value(std::move(v)) { print_created(this, value); } + TestFactory3(TestFactory3 &&m) { value = std::move(m.value); print_move_created(this); } + TestFactory3 &operator=(TestFactory3 &&m) { value = std::move(m.value); print_move_assigned(this); return *this; } + std::string value; + virtual ~TestFactory3() { print_destroyed(this); } +}; +// Inheritance test +class TestFactory4 : public TestFactory3 { +public: + TestFactory4() : TestFactory3() { print_default_created(this); } + TestFactory4(int v) : TestFactory3(v) { print_created(this, v); } + virtual ~TestFactory4() { print_destroyed(this); } +}; +// Another class for an invalid downcast test +class TestFactory5 : public TestFactory3 { +public: + TestFactory5(int i) : TestFactory3(i) { print_created(this, i); } + virtual ~TestFactory5() { print_destroyed(this); } +}; + +class TestFactory6 { +protected: + int value; + bool alias = false; +public: + TestFactory6(int i) : value{i} { print_created(this, i); } + TestFactory6(TestFactory6 &&f) { print_move_created(this); value = f.value; alias = f.alias; } + TestFactory6(const TestFactory6 &f) { print_copy_created(this); value = f.value; alias = f.alias; } + virtual ~TestFactory6() { print_destroyed(this); } + virtual int get() { return value; } + bool has_alias() { return alias; } +}; +class PyTF6 : public TestFactory6 { +public: + // Special constructor that allows the factory to construct a PyTF6 from a TestFactory6 only + // when an alias is needed: + PyTF6(TestFactory6 &&base) : TestFactory6(std::move(base)) { alias = true; print_created(this, "move", value); } + PyTF6(int i) : TestFactory6(i) { alias = true; print_created(this, i); } + PyTF6(PyTF6 &&f) : TestFactory6(std::move(f)) { print_move_created(this); } + PyTF6(const PyTF6 &f) : TestFactory6(f) { print_copy_created(this); } + PyTF6(std::string s) : TestFactory6((int) s.size()) { alias = true; print_created(this, s); } + virtual ~PyTF6() { print_destroyed(this); } + int get() override { PYBIND11_OVERLOAD(int, TestFactory6, get, /*no args*/); } +}; + +class TestFactory7 { +protected: + int value; + bool alias = false; +public: + TestFactory7(int i) : value{i} { print_created(this, i); } + TestFactory7(TestFactory7 &&f) { print_move_created(this); value = f.value; alias = f.alias; } + TestFactory7(const TestFactory7 &f) { print_copy_created(this); value = f.value; alias = f.alias; } + virtual ~TestFactory7() { print_destroyed(this); } + virtual int get() { return value; } + bool has_alias() { return alias; } +}; +class PyTF7 : public TestFactory7 { +public: + PyTF7(int i) : TestFactory7(i) { alias = true; print_created(this, i); } + PyTF7(PyTF7 &&f) : TestFactory7(std::move(f)) { print_move_created(this); } + PyTF7(const PyTF7 &f) : TestFactory7(f) { print_copy_created(this); } + virtual ~PyTF7() { print_destroyed(this); } + int get() override { PYBIND11_OVERLOAD(int, TestFactory7, get, /*no args*/); } +}; + + +class TestFactoryHelper { +public: + // Non-movable, non-copyable type: + // Return via pointer: + static TestFactory1 *construct1() { return new TestFactory1(); } + // Holder: + static std::unique_ptr construct1(int a) { return std::unique_ptr(new TestFactory1(a)); } + // pointer again + static TestFactory1 *construct1_string(std::string a) { return new TestFactory1(a); } + + // Moveable type: + // pointer: + static TestFactory2 *construct2() { return new TestFactory2(); } + // holder: + static std::unique_ptr construct2(int a) { return std::unique_ptr(new TestFactory2(a)); } + // by value moving: + static TestFactory2 construct2(std::string a) { return TestFactory2(a); } + + // shared_ptr holder type: + // pointer: + static TestFactory3 *construct3() { return new TestFactory3(); } + // holder: + static std::shared_ptr construct3(int a) { return std::shared_ptr(new TestFactory3(a)); } +}; + +TEST_SUBMODULE(factory_constructors, m) { + + // Define various trivial types to allow simpler overload resolution: + py::module m_tag = m.def_submodule("tag"); +#define MAKE_TAG_TYPE(Name) \ + struct Name##_tag {}; \ + py::class_(m_tag, #Name "_tag").def(py::init<>()); \ + m_tag.attr(#Name) = py::cast(Name##_tag{}) + MAKE_TAG_TYPE(pointer); + MAKE_TAG_TYPE(unique_ptr); + MAKE_TAG_TYPE(move); + MAKE_TAG_TYPE(shared_ptr); + MAKE_TAG_TYPE(derived); + MAKE_TAG_TYPE(TF4); + MAKE_TAG_TYPE(TF5); + MAKE_TAG_TYPE(null_ptr); + MAKE_TAG_TYPE(base); + MAKE_TAG_TYPE(invalid_base); + MAKE_TAG_TYPE(alias); + MAKE_TAG_TYPE(unaliasable); + MAKE_TAG_TYPE(mixed); + + // test_init_factory_basic, test_bad_type + py::class_(m, "TestFactory1") + .def(py::init([](unique_ptr_tag, int v) { return TestFactoryHelper::construct1(v); })) + .def(py::init(&TestFactoryHelper::construct1_string)) // raw function pointer + .def(py::init([](pointer_tag) { return TestFactoryHelper::construct1(); })) + .def(py::init([](py::handle, int v, py::handle) { return TestFactoryHelper::construct1(v); })) + .def_readwrite("value", &TestFactory1::value) + ; + py::class_(m, "TestFactory2") + .def(py::init([](pointer_tag, int v) { return TestFactoryHelper::construct2(v); })) + .def(py::init([](unique_ptr_tag, std::string v) { return TestFactoryHelper::construct2(v); })) + .def(py::init([](move_tag) { return TestFactoryHelper::construct2(); })) + .def_readwrite("value", &TestFactory2::value) + ; + + // Stateful & reused: + int c = 1; + auto c4a = [c](pointer_tag, TF4_tag, int a) { (void) c; return new TestFactory4(a);}; + + // test_init_factory_basic, test_init_factory_casting + py::class_>(m, "TestFactory3") + .def(py::init([](pointer_tag, int v) { return TestFactoryHelper::construct3(v); })) + .def(py::init([](shared_ptr_tag) { return TestFactoryHelper::construct3(); })) + .def("__init__", [](TestFactory3 &self, std::string v) { new (&self) TestFactory3(v); }) // placement-new ctor + + // factories returning a derived type: + .def(py::init(c4a)) // derived ptr + .def(py::init([](pointer_tag, TF5_tag, int a) { return new TestFactory5(a); })) + // derived shared ptr: + .def(py::init([](shared_ptr_tag, TF4_tag, int a) { return std::make_shared(a); })) + .def(py::init([](shared_ptr_tag, TF5_tag, int a) { return std::make_shared(a); })) + + // Returns nullptr: + .def(py::init([](null_ptr_tag) { return (TestFactory3 *) nullptr; })) + + .def_readwrite("value", &TestFactory3::value) + ; + + // test_init_factory_casting + py::class_>(m, "TestFactory4") + .def(py::init(c4a)) // pointer + ; + + // Doesn't need to be registered, but registering makes getting ConstructorStats easier: + py::class_>(m, "TestFactory5"); + + // test_init_factory_alias + // Alias testing + py::class_(m, "TestFactory6") + .def(py::init([](base_tag, int i) { return TestFactory6(i); })) + .def(py::init([](alias_tag, int i) { return PyTF6(i); })) + .def(py::init([](alias_tag, std::string s) { return PyTF6(s); })) + .def(py::init([](alias_tag, pointer_tag, int i) { return new PyTF6(i); })) + .def(py::init([](base_tag, pointer_tag, int i) { return new TestFactory6(i); })) + .def(py::init([](base_tag, alias_tag, pointer_tag, int i) { return (TestFactory6 *) new PyTF6(i); })) + + .def("get", &TestFactory6::get) + .def("has_alias", &TestFactory6::has_alias) + + .def_static("get_cstats", &ConstructorStats::get, py::return_value_policy::reference) + .def_static("get_alias_cstats", &ConstructorStats::get, py::return_value_policy::reference) + ; + + // test_init_factory_dual + // Separate alias constructor testing + py::class_>(m, "TestFactory7") + .def(py::init( + [](int i) { return TestFactory7(i); }, + [](int i) { return PyTF7(i); })) + .def(py::init( + [](pointer_tag, int i) { return new TestFactory7(i); }, + [](pointer_tag, int i) { return new PyTF7(i); })) + .def(py::init( + [](mixed_tag, int i) { return new TestFactory7(i); }, + [](mixed_tag, int i) { return PyTF7(i); })) + .def(py::init( + [](mixed_tag, std::string s) { return TestFactory7((int) s.size()); }, + [](mixed_tag, std::string s) { return new PyTF7((int) s.size()); })) + .def(py::init( + [](base_tag, pointer_tag, int i) { return new TestFactory7(i); }, + [](base_tag, pointer_tag, int i) { return (TestFactory7 *) new PyTF7(i); })) + .def(py::init( + [](alias_tag, pointer_tag, int i) { return new PyTF7(i); }, + [](alias_tag, pointer_tag, int i) { return new PyTF7(10*i); })) + .def(py::init( + [](shared_ptr_tag, base_tag, int i) { return std::make_shared(i); }, + [](shared_ptr_tag, base_tag, int i) { auto *p = new PyTF7(i); return std::shared_ptr(p); })) + .def(py::init( + [](shared_ptr_tag, invalid_base_tag, int i) { return std::make_shared(i); }, + [](shared_ptr_tag, invalid_base_tag, int i) { return std::make_shared(i); })) // <-- invalid alias factory + + .def("get", &TestFactory7::get) + .def("has_alias", &TestFactory7::has_alias) + + .def_static("get_cstats", &ConstructorStats::get, py::return_value_policy::reference) + .def_static("get_alias_cstats", &ConstructorStats::get, py::return_value_policy::reference) + ; + + // test_placement_new_alternative + // Class with a custom new operator but *without* a placement new operator (issue #948) + class NoPlacementNew { + public: + NoPlacementNew(int i) : i(i) { } + static void *operator new(std::size_t s) { + auto *p = ::operator new(s); + py::print("operator new called, returning", reinterpret_cast(p)); + return p; + } + static void operator delete(void *p) { + py::print("operator delete called on", reinterpret_cast(p)); + ::operator delete(p); + } + int i; + }; + // As of 2.2, `py::init` no longer requires placement new + py::class_(m, "NoPlacementNew") + .def(py::init()) + .def(py::init([]() { return new NoPlacementNew(100); })) + .def_readwrite("i", &NoPlacementNew::i) + ; + + + // test_reallocations + // Class that has verbose operator_new/operator_delete calls + struct NoisyAlloc { + NoisyAlloc(int i) { py::print(py::str("NoisyAlloc(int {})").format(i)); } + NoisyAlloc(double d) { py::print(py::str("NoisyAlloc(double {})").format(d)); } + ~NoisyAlloc() { py::print("~NoisyAlloc()"); } + + static void *operator new(size_t s) { py::print("noisy new"); return ::operator new(s); } + static void *operator new(size_t, void *p) { py::print("noisy placement new"); return p; } + static void operator delete(void *p, size_t) { py::print("noisy delete"); ::operator delete(p); } + static void operator delete(void *, void *) { py::print("noisy placement delete"); } +#if defined(_MSC_VER) && _MSC_VER < 1910 + // MSVC 2015 bug: the above "noisy delete" isn't invoked (fixed in MSVC 2017) + static void operator delete(void *p) { py::print("noisy delete"); ::operator delete(p); } +#endif + }; + py::class_(m, "NoisyAlloc") + // Since these overloads have the same number of arguments, the dispatcher will try each of + // them until the arguments convert. Thus we can get a pre-allocation here when passing a + // single non-integer: + .def("__init__", [](NoisyAlloc *a, int i) { new (a) NoisyAlloc(i); }) // Regular constructor, runs first, requires preallocation + .def(py::init([](double d) { return new NoisyAlloc(d); })) + + // The two-argument version: first the factory pointer overload. + .def(py::init([](int i, int) { return new NoisyAlloc(i); })) + // Return-by-value: + .def(py::init([](double d, int) { return NoisyAlloc(d); })) + // Old-style placement new init; requires preallocation + .def("__init__", [](NoisyAlloc &a, double d, double) { new (&a) NoisyAlloc(d); }) + // Requires deallocation of previous overload preallocated value: + .def(py::init([](int i, double) { return new NoisyAlloc(i); })) + // Regular again: requires yet another preallocation + .def("__init__", [](NoisyAlloc &a, int i, std::string) { new (&a) NoisyAlloc(i); }) + ; + + + + + // static_assert testing (the following def's should all fail with appropriate compilation errors): +#if 0 + struct BadF1Base {}; + struct BadF1 : BadF1Base {}; + struct PyBadF1 : BadF1 {}; + py::class_> bf1(m, "BadF1"); + // wrapped factory function must return a compatible pointer, holder, or value + bf1.def(py::init([]() { return 3; })); + // incompatible factory function pointer return type + bf1.def(py::init([]() { static int three = 3; return &three; })); + // incompatible factory function std::shared_ptr return type: cannot convert shared_ptr to holder + // (non-polymorphic base) + bf1.def(py::init([]() { return std::shared_ptr(new BadF1()); })); +#endif +} diff --git a/plugins/python/pybind11/tests/test_factory_constructors.py b/plugins/python/pybind11/tests/test_factory_constructors.py new file mode 100644 index 0000000..78a3910 --- /dev/null +++ b/plugins/python/pybind11/tests/test_factory_constructors.py @@ -0,0 +1,459 @@ +import pytest +import re + +from pybind11_tests import factory_constructors as m +from pybind11_tests.factory_constructors import tag +from pybind11_tests import ConstructorStats + + +def test_init_factory_basic(): + """Tests py::init_factory() wrapper around various ways of returning the object""" + + cstats = [ConstructorStats.get(c) for c in [m.TestFactory1, m.TestFactory2, m.TestFactory3]] + cstats[0].alive() # force gc + n_inst = ConstructorStats.detail_reg_inst() + + x1 = m.TestFactory1(tag.unique_ptr, 3) + assert x1.value == "3" + y1 = m.TestFactory1(tag.pointer) + assert y1.value == "(empty)" + z1 = m.TestFactory1("hi!") + assert z1.value == "hi!" + + assert ConstructorStats.detail_reg_inst() == n_inst + 3 + + x2 = m.TestFactory2(tag.move) + assert x2.value == "(empty2)" + y2 = m.TestFactory2(tag.pointer, 7) + assert y2.value == "7" + z2 = m.TestFactory2(tag.unique_ptr, "hi again") + assert z2.value == "hi again" + + assert ConstructorStats.detail_reg_inst() == n_inst + 6 + + x3 = m.TestFactory3(tag.shared_ptr) + assert x3.value == "(empty3)" + y3 = m.TestFactory3(tag.pointer, 42) + assert y3.value == "42" + z3 = m.TestFactory3("bye") + assert z3.value == "bye" + + with pytest.raises(TypeError) as excinfo: + m.TestFactory3(tag.null_ptr) + assert str(excinfo.value) == "pybind11::init(): factory function returned nullptr" + + assert [i.alive() for i in cstats] == [3, 3, 3] + assert ConstructorStats.detail_reg_inst() == n_inst + 9 + + del x1, y2, y3, z3 + assert [i.alive() for i in cstats] == [2, 2, 1] + assert ConstructorStats.detail_reg_inst() == n_inst + 5 + del x2, x3, y1, z1, z2 + assert [i.alive() for i in cstats] == [0, 0, 0] + assert ConstructorStats.detail_reg_inst() == n_inst + + assert [i.values() for i in cstats] == [ + ["3", "hi!"], + ["7", "hi again"], + ["42", "bye"] + ] + assert [i.default_constructions for i in cstats] == [1, 1, 1] + + +def test_init_factory_signature(msg): + with pytest.raises(TypeError) as excinfo: + m.TestFactory1("invalid", "constructor", "arguments") + assert msg(excinfo.value) == """ + __init__(): incompatible constructor arguments. The following argument types are supported: + 1. m.factory_constructors.TestFactory1(arg0: m.factory_constructors.tag.unique_ptr_tag, arg1: int) + 2. m.factory_constructors.TestFactory1(arg0: str) + 3. m.factory_constructors.TestFactory1(arg0: m.factory_constructors.tag.pointer_tag) + 4. m.factory_constructors.TestFactory1(arg0: handle, arg1: int, arg2: handle) + + Invoked with: 'invalid', 'constructor', 'arguments' + """ # noqa: E501 line too long + + assert msg(m.TestFactory1.__init__.__doc__) == """ + __init__(*args, **kwargs) + Overloaded function. + + 1. __init__(self: m.factory_constructors.TestFactory1, arg0: m.factory_constructors.tag.unique_ptr_tag, arg1: int) -> None + + 2. __init__(self: m.factory_constructors.TestFactory1, arg0: str) -> None + + 3. __init__(self: m.factory_constructors.TestFactory1, arg0: m.factory_constructors.tag.pointer_tag) -> None + + 4. __init__(self: m.factory_constructors.TestFactory1, arg0: handle, arg1: int, arg2: handle) -> None + """ # noqa: E501 line too long + + +def test_init_factory_casting(): + """Tests py::init_factory() wrapper with various upcasting and downcasting returns""" + + cstats = [ConstructorStats.get(c) for c in [m.TestFactory3, m.TestFactory4, m.TestFactory5]] + cstats[0].alive() # force gc + n_inst = ConstructorStats.detail_reg_inst() + + # Construction from derived references: + a = m.TestFactory3(tag.pointer, tag.TF4, 4) + assert a.value == "4" + b = m.TestFactory3(tag.shared_ptr, tag.TF4, 5) + assert b.value == "5" + c = m.TestFactory3(tag.pointer, tag.TF5, 6) + assert c.value == "6" + d = m.TestFactory3(tag.shared_ptr, tag.TF5, 7) + assert d.value == "7" + + assert ConstructorStats.detail_reg_inst() == n_inst + 4 + + # Shared a lambda with TF3: + e = m.TestFactory4(tag.pointer, tag.TF4, 8) + assert e.value == "8" + + assert ConstructorStats.detail_reg_inst() == n_inst + 5 + assert [i.alive() for i in cstats] == [5, 3, 2] + + del a + assert [i.alive() for i in cstats] == [4, 2, 2] + assert ConstructorStats.detail_reg_inst() == n_inst + 4 + + del b, c, e + assert [i.alive() for i in cstats] == [1, 0, 1] + assert ConstructorStats.detail_reg_inst() == n_inst + 1 + + del d + assert [i.alive() for i in cstats] == [0, 0, 0] + assert ConstructorStats.detail_reg_inst() == n_inst + + assert [i.values() for i in cstats] == [ + ["4", "5", "6", "7", "8"], + ["4", "5", "8"], + ["6", "7"] + ] + + +def test_init_factory_alias(): + """Tests py::init_factory() wrapper with value conversions and alias types""" + + cstats = [m.TestFactory6.get_cstats(), m.TestFactory6.get_alias_cstats()] + cstats[0].alive() # force gc + n_inst = ConstructorStats.detail_reg_inst() + + a = m.TestFactory6(tag.base, 1) + assert a.get() == 1 + assert not a.has_alias() + b = m.TestFactory6(tag.alias, "hi there") + assert b.get() == 8 + assert b.has_alias() + c = m.TestFactory6(tag.alias, 3) + assert c.get() == 3 + assert c.has_alias() + d = m.TestFactory6(tag.alias, tag.pointer, 4) + assert d.get() == 4 + assert d.has_alias() + e = m.TestFactory6(tag.base, tag.pointer, 5) + assert e.get() == 5 + assert not e.has_alias() + f = m.TestFactory6(tag.base, tag.alias, tag.pointer, 6) + assert f.get() == 6 + assert f.has_alias() + + assert ConstructorStats.detail_reg_inst() == n_inst + 6 + assert [i.alive() for i in cstats] == [6, 4] + + del a, b, e + assert [i.alive() for i in cstats] == [3, 3] + assert ConstructorStats.detail_reg_inst() == n_inst + 3 + del f, c, d + assert [i.alive() for i in cstats] == [0, 0] + assert ConstructorStats.detail_reg_inst() == n_inst + + class MyTest(m.TestFactory6): + def __init__(self, *args): + m.TestFactory6.__init__(self, *args) + + def get(self): + return -5 + m.TestFactory6.get(self) + + # Return Class by value, moved into new alias: + z = MyTest(tag.base, 123) + assert z.get() == 118 + assert z.has_alias() + + # Return alias by value, moved into new alias: + y = MyTest(tag.alias, "why hello!") + assert y.get() == 5 + assert y.has_alias() + + # Return Class by pointer, moved into new alias then original destroyed: + x = MyTest(tag.base, tag.pointer, 47) + assert x.get() == 42 + assert x.has_alias() + + assert ConstructorStats.detail_reg_inst() == n_inst + 3 + assert [i.alive() for i in cstats] == [3, 3] + del x, y, z + assert [i.alive() for i in cstats] == [0, 0] + assert ConstructorStats.detail_reg_inst() == n_inst + + assert [i.values() for i in cstats] == [ + ["1", "8", "3", "4", "5", "6", "123", "10", "47"], + ["hi there", "3", "4", "6", "move", "123", "why hello!", "move", "47"] + ] + + +def test_init_factory_dual(): + """Tests init factory functions with dual main/alias factory functions""" + from pybind11_tests.factory_constructors import TestFactory7 + + cstats = [TestFactory7.get_cstats(), TestFactory7.get_alias_cstats()] + cstats[0].alive() # force gc + n_inst = ConstructorStats.detail_reg_inst() + + class PythFactory7(TestFactory7): + def get(self): + return 100 + TestFactory7.get(self) + + a1 = TestFactory7(1) + a2 = PythFactory7(2) + assert a1.get() == 1 + assert a2.get() == 102 + assert not a1.has_alias() + assert a2.has_alias() + + b1 = TestFactory7(tag.pointer, 3) + b2 = PythFactory7(tag.pointer, 4) + assert b1.get() == 3 + assert b2.get() == 104 + assert not b1.has_alias() + assert b2.has_alias() + + c1 = TestFactory7(tag.mixed, 5) + c2 = PythFactory7(tag.mixed, 6) + assert c1.get() == 5 + assert c2.get() == 106 + assert not c1.has_alias() + assert c2.has_alias() + + d1 = TestFactory7(tag.base, tag.pointer, 7) + d2 = PythFactory7(tag.base, tag.pointer, 8) + assert d1.get() == 7 + assert d2.get() == 108 + assert not d1.has_alias() + assert d2.has_alias() + + # Both return an alias; the second multiplies the value by 10: + e1 = TestFactory7(tag.alias, tag.pointer, 9) + e2 = PythFactory7(tag.alias, tag.pointer, 10) + assert e1.get() == 9 + assert e2.get() == 200 + assert e1.has_alias() + assert e2.has_alias() + + f1 = TestFactory7(tag.shared_ptr, tag.base, 11) + f2 = PythFactory7(tag.shared_ptr, tag.base, 12) + assert f1.get() == 11 + assert f2.get() == 112 + assert not f1.has_alias() + assert f2.has_alias() + + g1 = TestFactory7(tag.shared_ptr, tag.invalid_base, 13) + assert g1.get() == 13 + assert not g1.has_alias() + with pytest.raises(TypeError) as excinfo: + PythFactory7(tag.shared_ptr, tag.invalid_base, 14) + assert (str(excinfo.value) == + "pybind11::init(): construction failed: returned holder-wrapped instance is not an " + "alias instance") + + assert [i.alive() for i in cstats] == [13, 7] + assert ConstructorStats.detail_reg_inst() == n_inst + 13 + + del a1, a2, b1, d1, e1, e2 + assert [i.alive() for i in cstats] == [7, 4] + assert ConstructorStats.detail_reg_inst() == n_inst + 7 + del b2, c1, c2, d2, f1, f2, g1 + assert [i.alive() for i in cstats] == [0, 0] + assert ConstructorStats.detail_reg_inst() == n_inst + + assert [i.values() for i in cstats] == [ + ["1", "2", "3", "4", "5", "6", "7", "8", "9", "100", "11", "12", "13", "14"], + ["2", "4", "6", "8", "9", "100", "12"] + ] + + +def test_no_placement_new(capture): + """Prior to 2.2, `py::init<...>` relied on the type supporting placement + new; this tests a class without placement new support.""" + with capture: + a = m.NoPlacementNew(123) + + found = re.search(r'^operator new called, returning (\d+)\n$', str(capture)) + assert found + assert a.i == 123 + with capture: + del a + pytest.gc_collect() + assert capture == "operator delete called on " + found.group(1) + + with capture: + b = m.NoPlacementNew() + + found = re.search(r'^operator new called, returning (\d+)\n$', str(capture)) + assert found + assert b.i == 100 + with capture: + del b + pytest.gc_collect() + assert capture == "operator delete called on " + found.group(1) + + +def test_multiple_inheritance(): + class MITest(m.TestFactory1, m.TestFactory2): + def __init__(self): + m.TestFactory1.__init__(self, tag.unique_ptr, 33) + m.TestFactory2.__init__(self, tag.move) + + a = MITest() + assert m.TestFactory1.value.fget(a) == "33" + assert m.TestFactory2.value.fget(a) == "(empty2)" + + +def create_and_destroy(*args): + a = m.NoisyAlloc(*args) + print("---") + del a + pytest.gc_collect() + + +def strip_comments(s): + return re.sub(r'\s+#.*', '', s) + + +def test_reallocations(capture, msg): + """When the constructor is overloaded, previous overloads can require a preallocated value. + This test makes sure that such preallocated values only happen when they might be necessary, + and that they are deallocated properly""" + + pytest.gc_collect() + + with capture: + create_and_destroy(1) + assert msg(capture) == """ + noisy new + noisy placement new + NoisyAlloc(int 1) + --- + ~NoisyAlloc() + noisy delete + """ + with capture: + create_and_destroy(1.5) + assert msg(capture) == strip_comments(""" + noisy new # allocation required to attempt first overload + noisy delete # have to dealloc before considering factory init overload + noisy new # pointer factory calling "new", part 1: allocation + NoisyAlloc(double 1.5) # ... part two, invoking constructor + --- + ~NoisyAlloc() # Destructor + noisy delete # operator delete + """) + + with capture: + create_and_destroy(2, 3) + assert msg(capture) == strip_comments(""" + noisy new # pointer factory calling "new", allocation + NoisyAlloc(int 2) # constructor + --- + ~NoisyAlloc() # Destructor + noisy delete # operator delete + """) + + with capture: + create_and_destroy(2.5, 3) + assert msg(capture) == strip_comments(""" + NoisyAlloc(double 2.5) # construction (local func variable: operator_new not called) + noisy new # return-by-value "new" part 1: allocation + ~NoisyAlloc() # moved-away local func variable destruction + --- + ~NoisyAlloc() # Destructor + noisy delete # operator delete + """) + + with capture: + create_and_destroy(3.5, 4.5) + assert msg(capture) == strip_comments(""" + noisy new # preallocation needed before invoking placement-new overload + noisy placement new # Placement new + NoisyAlloc(double 3.5) # construction + --- + ~NoisyAlloc() # Destructor + noisy delete # operator delete + """) + + with capture: + create_and_destroy(4, 0.5) + assert msg(capture) == strip_comments(""" + noisy new # preallocation needed before invoking placement-new overload + noisy delete # deallocation of preallocated storage + noisy new # Factory pointer allocation + NoisyAlloc(int 4) # factory pointer construction + --- + ~NoisyAlloc() # Destructor + noisy delete # operator delete + """) + + with capture: + create_and_destroy(5, "hi") + assert msg(capture) == strip_comments(""" + noisy new # preallocation needed before invoking first placement new + noisy delete # delete before considering new-style constructor + noisy new # preallocation for second placement new + noisy placement new # Placement new in the second placement new overload + NoisyAlloc(int 5) # construction + --- + ~NoisyAlloc() # Destructor + noisy delete # operator delete + """) + + +@pytest.unsupported_on_py2 +def test_invalid_self(): + """Tests invocation of the pybind-registered base class with an invalid `self` argument. You + can only actually do this on Python 3: Python 2 raises an exception itself if you try.""" + class NotPybindDerived(object): + pass + + # Attempts to initialize with an invalid type passed as `self`: + class BrokenTF1(m.TestFactory1): + def __init__(self, bad): + if bad == 1: + a = m.TestFactory2(tag.pointer, 1) + m.TestFactory1.__init__(a, tag.pointer) + elif bad == 2: + a = NotPybindDerived() + m.TestFactory1.__init__(a, tag.pointer) + + # Same as above, but for a class with an alias: + class BrokenTF6(m.TestFactory6): + def __init__(self, bad): + if bad == 1: + a = m.TestFactory2(tag.pointer, 1) + m.TestFactory6.__init__(a, tag.base, 1) + elif bad == 2: + a = m.TestFactory2(tag.pointer, 1) + m.TestFactory6.__init__(a, tag.alias, 1) + elif bad == 3: + m.TestFactory6.__init__(NotPybindDerived.__new__(NotPybindDerived), tag.base, 1) + elif bad == 4: + m.TestFactory6.__init__(NotPybindDerived.__new__(NotPybindDerived), tag.alias, 1) + + for arg in (1, 2): + with pytest.raises(TypeError) as excinfo: + BrokenTF1(arg) + assert str(excinfo.value) == "__init__(self, ...) called with invalid `self` argument" + + for arg in (1, 2, 3, 4): + with pytest.raises(TypeError) as excinfo: + BrokenTF6(arg) + assert str(excinfo.value) == "__init__(self, ...) called with invalid `self` argument" diff --git a/plugins/python/pybind11/tests/test_iostream.cpp b/plugins/python/pybind11/tests/test_iostream.cpp new file mode 100644 index 0000000..e67f88a --- /dev/null +++ b/plugins/python/pybind11/tests/test_iostream.cpp @@ -0,0 +1,73 @@ +/* + tests/test_iostream.cpp -- Usage of scoped_output_redirect + + Copyright (c) 2017 Henry F. Schreiner + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + + +#include +#include "pybind11_tests.h" +#include + + +void noisy_function(std::string msg, bool flush) { + + std::cout << msg; + if (flush) + std::cout << std::flush; +} + +void noisy_funct_dual(std::string msg, std::string emsg) { + std::cout << msg; + std::cerr << emsg; +} + +TEST_SUBMODULE(iostream, m) { + + add_ostream_redirect(m); + + // test_evals + + m.def("captured_output_default", [](std::string msg) { + py::scoped_ostream_redirect redir; + std::cout << msg << std::flush; + }); + + m.def("captured_output", [](std::string msg) { + py::scoped_ostream_redirect redir(std::cout, py::module::import("sys").attr("stdout")); + std::cout << msg << std::flush; + }); + + m.def("guard_output", &noisy_function, + py::call_guard(), + py::arg("msg"), py::arg("flush")=true); + + m.def("captured_err", [](std::string msg) { + py::scoped_ostream_redirect redir(std::cerr, py::module::import("sys").attr("stderr")); + std::cerr << msg << std::flush; + }); + + m.def("noisy_function", &noisy_function, py::arg("msg"), py::arg("flush") = true); + + m.def("dual_guard", &noisy_funct_dual, + py::call_guard(), + py::arg("msg"), py::arg("emsg")); + + m.def("raw_output", [](std::string msg) { + std::cout << msg << std::flush; + }); + + m.def("raw_err", [](std::string msg) { + std::cerr << msg << std::flush; + }); + + m.def("captured_dual", [](std::string msg, std::string emsg) { + py::scoped_ostream_redirect redirout(std::cout, py::module::import("sys").attr("stdout")); + py::scoped_ostream_redirect redirerr(std::cerr, py::module::import("sys").attr("stderr")); + std::cout << msg << std::flush; + std::cerr << emsg << std::flush; + }); +} diff --git a/plugins/python/pybind11/tests/test_iostream.py b/plugins/python/pybind11/tests/test_iostream.py new file mode 100644 index 0000000..27095b2 --- /dev/null +++ b/plugins/python/pybind11/tests/test_iostream.py @@ -0,0 +1,214 @@ +from pybind11_tests import iostream as m +import sys + +from contextlib import contextmanager + +try: + # Python 3 + from io import StringIO +except ImportError: + # Python 2 + try: + from cStringIO import StringIO + except ImportError: + from StringIO import StringIO + +try: + # Python 3.4 + from contextlib import redirect_stdout +except ImportError: + @contextmanager + def redirect_stdout(target): + original = sys.stdout + sys.stdout = target + yield + sys.stdout = original + +try: + # Python 3.5 + from contextlib import redirect_stderr +except ImportError: + @contextmanager + def redirect_stderr(target): + original = sys.stderr + sys.stderr = target + yield + sys.stderr = original + + +def test_captured(capsys): + msg = "I've been redirected to Python, I hope!" + m.captured_output(msg) + stdout, stderr = capsys.readouterr() + assert stdout == msg + assert stderr == '' + + m.captured_output_default(msg) + stdout, stderr = capsys.readouterr() + assert stdout == msg + assert stderr == '' + + m.captured_err(msg) + stdout, stderr = capsys.readouterr() + assert stdout == '' + assert stderr == msg + + +def test_captured_large_string(capsys): + # Make this bigger than the buffer used on the C++ side: 1024 chars + msg = "I've been redirected to Python, I hope!" + msg = msg * (1024 // len(msg) + 1) + + m.captured_output_default(msg) + stdout, stderr = capsys.readouterr() + assert stdout == msg + assert stderr == '' + + +def test_guard_capture(capsys): + msg = "I've been redirected to Python, I hope!" + m.guard_output(msg) + stdout, stderr = capsys.readouterr() + assert stdout == msg + assert stderr == '' + + +def test_series_captured(capture): + with capture: + m.captured_output("a") + m.captured_output("b") + assert capture == "ab" + + +def test_flush(capfd): + msg = "(not flushed)" + msg2 = "(flushed)" + + with m.ostream_redirect(): + m.noisy_function(msg, flush=False) + stdout, stderr = capfd.readouterr() + assert stdout == '' + + m.noisy_function(msg2, flush=True) + stdout, stderr = capfd.readouterr() + assert stdout == msg + msg2 + + m.noisy_function(msg, flush=False) + + stdout, stderr = capfd.readouterr() + assert stdout == msg + + +def test_not_captured(capfd): + msg = "Something that should not show up in log" + stream = StringIO() + with redirect_stdout(stream): + m.raw_output(msg) + stdout, stderr = capfd.readouterr() + assert stdout == msg + assert stderr == '' + assert stream.getvalue() == '' + + stream = StringIO() + with redirect_stdout(stream): + m.captured_output(msg) + stdout, stderr = capfd.readouterr() + assert stdout == '' + assert stderr == '' + assert stream.getvalue() == msg + + +def test_err(capfd): + msg = "Something that should not show up in log" + stream = StringIO() + with redirect_stderr(stream): + m.raw_err(msg) + stdout, stderr = capfd.readouterr() + assert stdout == '' + assert stderr == msg + assert stream.getvalue() == '' + + stream = StringIO() + with redirect_stderr(stream): + m.captured_err(msg) + stdout, stderr = capfd.readouterr() + assert stdout == '' + assert stderr == '' + assert stream.getvalue() == msg + + +def test_multi_captured(capfd): + stream = StringIO() + with redirect_stdout(stream): + m.captured_output("a") + m.raw_output("b") + m.captured_output("c") + m.raw_output("d") + stdout, stderr = capfd.readouterr() + assert stdout == 'bd' + assert stream.getvalue() == 'ac' + + +def test_dual(capsys): + m.captured_dual("a", "b") + stdout, stderr = capsys.readouterr() + assert stdout == "a" + assert stderr == "b" + + +def test_redirect(capfd): + msg = "Should not be in log!" + stream = StringIO() + with redirect_stdout(stream): + m.raw_output(msg) + stdout, stderr = capfd.readouterr() + assert stdout == msg + assert stream.getvalue() == '' + + stream = StringIO() + with redirect_stdout(stream): + with m.ostream_redirect(): + m.raw_output(msg) + stdout, stderr = capfd.readouterr() + assert stdout == '' + assert stream.getvalue() == msg + + stream = StringIO() + with redirect_stdout(stream): + m.raw_output(msg) + stdout, stderr = capfd.readouterr() + assert stdout == msg + assert stream.getvalue() == '' + + +def test_redirect_err(capfd): + msg = "StdOut" + msg2 = "StdErr" + + stream = StringIO() + with redirect_stderr(stream): + with m.ostream_redirect(stdout=False): + m.raw_output(msg) + m.raw_err(msg2) + stdout, stderr = capfd.readouterr() + assert stdout == msg + assert stderr == '' + assert stream.getvalue() == msg2 + + +def test_redirect_both(capfd): + msg = "StdOut" + msg2 = "StdErr" + + stream = StringIO() + stream2 = StringIO() + with redirect_stdout(stream): + with redirect_stderr(stream2): + with m.ostream_redirect(): + m.raw_output(msg) + m.raw_err(msg2) + stdout, stderr = capfd.readouterr() + assert stdout == '' + assert stderr == '' + assert stream.getvalue() == msg + assert stream2.getvalue() == msg2 diff --git a/plugins/python/pybind11/tests/test_kwargs_and_defaults.cpp b/plugins/python/pybind11/tests/test_kwargs_and_defaults.cpp new file mode 100644 index 0000000..2263b6b --- /dev/null +++ b/plugins/python/pybind11/tests/test_kwargs_and_defaults.cpp @@ -0,0 +1,100 @@ +/* + tests/test_kwargs_and_defaults.cpp -- keyword arguments and default values + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include + +TEST_SUBMODULE(kwargs_and_defaults, m) { + auto kw_func = [](int x, int y) { return "x=" + std::to_string(x) + ", y=" + std::to_string(y); }; + + // test_named_arguments + m.def("kw_func0", kw_func); + m.def("kw_func1", kw_func, py::arg("x"), py::arg("y")); + m.def("kw_func2", kw_func, py::arg("x") = 100, py::arg("y") = 200); + m.def("kw_func3", [](const char *) { }, py::arg("data") = std::string("Hello world!")); + + /* A fancier default argument */ + std::vector list{{13, 17}}; + m.def("kw_func4", [](const std::vector &entries) { + std::string ret = "{"; + for (int i : entries) + ret += std::to_string(i) + " "; + ret.back() = '}'; + return ret; + }, py::arg("myList") = list); + + m.def("kw_func_udl", kw_func, "x"_a, "y"_a=300); + m.def("kw_func_udl_z", kw_func, "x"_a, "y"_a=0); + + // test_args_and_kwargs + m.def("args_function", [](py::args args) -> py::tuple { return args; }); + m.def("args_kwargs_function", [](py::args args, py::kwargs kwargs) { + return py::make_tuple(args, kwargs); + }); + + // test_mixed_args_and_kwargs + m.def("mixed_plus_args", [](int i, double j, py::args args) { + return py::make_tuple(i, j, args); + }); + m.def("mixed_plus_kwargs", [](int i, double j, py::kwargs kwargs) { + return py::make_tuple(i, j, kwargs); + }); + auto mixed_plus_both = [](int i, double j, py::args args, py::kwargs kwargs) { + return py::make_tuple(i, j, args, kwargs); + }; + m.def("mixed_plus_args_kwargs", mixed_plus_both); + + m.def("mixed_plus_args_kwargs_defaults", mixed_plus_both, + py::arg("i") = 1, py::arg("j") = 3.14159); + + // test_args_refcount + // PyPy needs a garbage collection to get the reference count values to match CPython's behaviour + #ifdef PYPY_VERSION + #define GC_IF_NEEDED ConstructorStats::gc() + #else + #define GC_IF_NEEDED + #endif + m.def("arg_refcount_h", [](py::handle h) { GC_IF_NEEDED; return h.ref_count(); }); + m.def("arg_refcount_h", [](py::handle h, py::handle, py::handle) { GC_IF_NEEDED; return h.ref_count(); }); + m.def("arg_refcount_o", [](py::object o) { GC_IF_NEEDED; return o.ref_count(); }); + m.def("args_refcount", [](py::args a) { + GC_IF_NEEDED; + py::tuple t(a.size()); + for (size_t i = 0; i < a.size(); i++) + // Use raw Python API here to avoid an extra, intermediate incref on the tuple item: + t[i] = (int) Py_REFCNT(PyTuple_GET_ITEM(a.ptr(), static_cast(i))); + return t; + }); + m.def("mixed_args_refcount", [](py::object o, py::args a) { + GC_IF_NEEDED; + py::tuple t(a.size() + 1); + t[0] = o.ref_count(); + for (size_t i = 0; i < a.size(); i++) + // Use raw Python API here to avoid an extra, intermediate incref on the tuple item: + t[i + 1] = (int) Py_REFCNT(PyTuple_GET_ITEM(a.ptr(), static_cast(i))); + return t; + }); + + // pybind11 won't allow these to be bound: args and kwargs, if present, must be at the end. + // Uncomment these to test that the static_assert is indeed working: +// m.def("bad_args1", [](py::args, int) {}); +// m.def("bad_args2", [](py::kwargs, int) {}); +// m.def("bad_args3", [](py::kwargs, py::args) {}); +// m.def("bad_args4", [](py::args, int, py::kwargs) {}); +// m.def("bad_args5", [](py::args, py::kwargs, int) {}); +// m.def("bad_args6", [](py::args, py::args) {}); +// m.def("bad_args7", [](py::kwargs, py::kwargs) {}); + + // test_function_signatures (along with most of the above) + struct KWClass { void foo(int, float) {} }; + py::class_(m, "KWClass") + .def("foo0", &KWClass::foo) + .def("foo1", &KWClass::foo, "x"_a, "y"_a); +} diff --git a/plugins/python/pybind11/tests/test_kwargs_and_defaults.py b/plugins/python/pybind11/tests/test_kwargs_and_defaults.py new file mode 100644 index 0000000..2695876 --- /dev/null +++ b/plugins/python/pybind11/tests/test_kwargs_and_defaults.py @@ -0,0 +1,147 @@ +import pytest +from pybind11_tests import kwargs_and_defaults as m + + +def test_function_signatures(doc): + assert doc(m.kw_func0) == "kw_func0(arg0: int, arg1: int) -> str" + assert doc(m.kw_func1) == "kw_func1(x: int, y: int) -> str" + assert doc(m.kw_func2) == "kw_func2(x: int=100, y: int=200) -> str" + assert doc(m.kw_func3) == "kw_func3(data: str='Hello world!') -> None" + assert doc(m.kw_func4) == "kw_func4(myList: List[int]=[13, 17]) -> str" + assert doc(m.kw_func_udl) == "kw_func_udl(x: int, y: int=300) -> str" + assert doc(m.kw_func_udl_z) == "kw_func_udl_z(x: int, y: int=0) -> str" + assert doc(m.args_function) == "args_function(*args) -> tuple" + assert doc(m.args_kwargs_function) == "args_kwargs_function(*args, **kwargs) -> tuple" + assert doc(m.KWClass.foo0) == \ + "foo0(self: m.kwargs_and_defaults.KWClass, arg0: int, arg1: float) -> None" + assert doc(m.KWClass.foo1) == \ + "foo1(self: m.kwargs_and_defaults.KWClass, x: int, y: float) -> None" + + +def test_named_arguments(msg): + assert m.kw_func0(5, 10) == "x=5, y=10" + + assert m.kw_func1(5, 10) == "x=5, y=10" + assert m.kw_func1(5, y=10) == "x=5, y=10" + assert m.kw_func1(y=10, x=5) == "x=5, y=10" + + assert m.kw_func2() == "x=100, y=200" + assert m.kw_func2(5) == "x=5, y=200" + assert m.kw_func2(x=5) == "x=5, y=200" + assert m.kw_func2(y=10) == "x=100, y=10" + assert m.kw_func2(5, 10) == "x=5, y=10" + assert m.kw_func2(x=5, y=10) == "x=5, y=10" + + with pytest.raises(TypeError) as excinfo: + # noinspection PyArgumentList + m.kw_func2(x=5, y=10, z=12) + assert excinfo.match( + r'(?s)^kw_func2\(\): incompatible.*Invoked with: kwargs: ((x=5|y=10|z=12)(, |$))' + '{3}$') + + assert m.kw_func4() == "{13 17}" + assert m.kw_func4(myList=[1, 2, 3]) == "{1 2 3}" + + assert m.kw_func_udl(x=5, y=10) == "x=5, y=10" + assert m.kw_func_udl_z(x=5) == "x=5, y=0" + + +def test_arg_and_kwargs(): + args = 'arg1_value', 'arg2_value', 3 + assert m.args_function(*args) == args + + args = 'a1', 'a2' + kwargs = dict(arg3='a3', arg4=4) + assert m.args_kwargs_function(*args, **kwargs) == (args, kwargs) + + +def test_mixed_args_and_kwargs(msg): + mpa = m.mixed_plus_args + mpk = m.mixed_plus_kwargs + mpak = m.mixed_plus_args_kwargs + mpakd = m.mixed_plus_args_kwargs_defaults + + assert mpa(1, 2.5, 4, 99.5, None) == (1, 2.5, (4, 99.5, None)) + assert mpa(1, 2.5) == (1, 2.5, ()) + with pytest.raises(TypeError) as excinfo: + assert mpa(1) + assert msg(excinfo.value) == """ + mixed_plus_args(): incompatible function arguments. The following argument types are supported: + 1. (arg0: int, arg1: float, *args) -> tuple + + Invoked with: 1 + """ # noqa: E501 line too long + with pytest.raises(TypeError) as excinfo: + assert mpa() + assert msg(excinfo.value) == """ + mixed_plus_args(): incompatible function arguments. The following argument types are supported: + 1. (arg0: int, arg1: float, *args) -> tuple + + Invoked with: + """ # noqa: E501 line too long + + assert mpk(-2, 3.5, pi=3.14159, e=2.71828) == (-2, 3.5, {'e': 2.71828, 'pi': 3.14159}) + assert mpak(7, 7.7, 7.77, 7.777, 7.7777, minusseven=-7) == ( + 7, 7.7, (7.77, 7.777, 7.7777), {'minusseven': -7}) + assert mpakd() == (1, 3.14159, (), {}) + assert mpakd(3) == (3, 3.14159, (), {}) + assert mpakd(j=2.71828) == (1, 2.71828, (), {}) + assert mpakd(k=42) == (1, 3.14159, (), {'k': 42}) + assert mpakd(1, 1, 2, 3, 5, 8, then=13, followedby=21) == ( + 1, 1, (2, 3, 5, 8), {'then': 13, 'followedby': 21}) + # Arguments specified both positionally and via kwargs should fail: + with pytest.raises(TypeError) as excinfo: + assert mpakd(1, i=1) + assert msg(excinfo.value) == """ + mixed_plus_args_kwargs_defaults(): incompatible function arguments. The following argument types are supported: + 1. (i: int=1, j: float=3.14159, *args, **kwargs) -> tuple + + Invoked with: 1; kwargs: i=1 + """ # noqa: E501 line too long + with pytest.raises(TypeError) as excinfo: + assert mpakd(1, 2, j=1) + assert msg(excinfo.value) == """ + mixed_plus_args_kwargs_defaults(): incompatible function arguments. The following argument types are supported: + 1. (i: int=1, j: float=3.14159, *args, **kwargs) -> tuple + + Invoked with: 1, 2; kwargs: j=1 + """ # noqa: E501 line too long + + +def test_args_refcount(): + """Issue/PR #1216 - py::args elements get double-inc_ref()ed when combined with regular + arguments""" + refcount = m.arg_refcount_h + + myval = 54321 + expected = refcount(myval) + assert m.arg_refcount_h(myval) == expected + assert m.arg_refcount_o(myval) == expected + 1 + assert m.arg_refcount_h(myval) == expected + assert refcount(myval) == expected + + assert m.mixed_plus_args(1, 2.0, "a", myval) == (1, 2.0, ("a", myval)) + assert refcount(myval) == expected + + assert m.mixed_plus_kwargs(3, 4.0, a=1, b=myval) == (3, 4.0, {"a": 1, "b": myval}) + assert refcount(myval) == expected + + assert m.args_function(-1, myval) == (-1, myval) + assert refcount(myval) == expected + + assert m.mixed_plus_args_kwargs(5, 6.0, myval, a=myval) == (5, 6.0, (myval,), {"a": myval}) + assert refcount(myval) == expected + + assert m.args_kwargs_function(7, 8, myval, a=1, b=myval) == \ + ((7, 8, myval), {"a": 1, "b": myval}) + assert refcount(myval) == expected + + exp3 = refcount(myval, myval, myval) + assert m.args_refcount(myval, myval, myval) == (exp3, exp3, exp3) + assert refcount(myval) == expected + + # This function takes the first arg as a `py::object` and the rest as a `py::args`. Unlike the + # previous case, when we have both positional and `py::args` we need to construct a new tuple + # for the `py::args`; in the previous case, we could simply inc_ref and pass on Python's input + # tuple without having to inc_ref the individual elements, but here we can't, hence the extra + # refs. + assert m.mixed_args_refcount(myval, myval, myval) == (exp3 + 3, exp3 + 3, exp3 + 3) diff --git a/plugins/python/pybind11/tests/test_local_bindings.cpp b/plugins/python/pybind11/tests/test_local_bindings.cpp new file mode 100644 index 0000000..97c02db --- /dev/null +++ b/plugins/python/pybind11/tests/test_local_bindings.cpp @@ -0,0 +1,101 @@ +/* + tests/test_local_bindings.cpp -- tests the py::module_local class feature which makes a class + binding local to the module in which it is defined. + + Copyright (c) 2017 Jason Rhinelander + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "local_bindings.h" +#include +#include +#include + +TEST_SUBMODULE(local_bindings, m) { + // test_load_external + m.def("load_external1", [](ExternalType1 &e) { return e.i; }); + m.def("load_external2", [](ExternalType2 &e) { return e.i; }); + + // test_local_bindings + // Register a class with py::module_local: + bind_local(m, "LocalType", py::module_local()) + .def("get3", [](LocalType &t) { return t.i + 3; }) + ; + + m.def("local_value", [](LocalType &l) { return l.i; }); + + // test_nonlocal_failure + // The main pybind11 test module is loaded first, so this registration will succeed (the second + // one, in pybind11_cross_module_tests.cpp, is designed to fail): + bind_local(m, "NonLocalType") + .def(py::init()) + .def("get", [](LocalType &i) { return i.i; }) + ; + + // test_duplicate_local + // py::module_local declarations should be visible across compilation units that get linked together; + // this tries to register a duplicate local. It depends on a definition in test_class.cpp and + // should raise a runtime error from the duplicate definition attempt. If test_class isn't + // available it *also* throws a runtime error (with "test_class not enabled" as value). + m.def("register_local_external", [m]() { + auto main = py::module::import("pybind11_tests"); + if (py::hasattr(main, "class_")) { + bind_local(m, "LocalExternal", py::module_local()); + } + else throw std::runtime_error("test_class not enabled"); + }); + + // test_stl_bind_local + // stl_bind.h binders defaults to py::module_local if the types are local or converting: + py::bind_vector(m, "LocalVec"); + py::bind_map(m, "LocalMap"); + // and global if the type (or one of the types, for the map) is global: + py::bind_vector(m, "NonLocalVec"); + py::bind_map(m, "NonLocalMap"); + + // test_stl_bind_global + // They can, however, be overridden to global using `py::module_local(false)`: + bind_local(m, "NonLocal2"); + py::bind_vector(m, "LocalVec2", py::module_local()); + py::bind_map(m, "NonLocalMap2", py::module_local(false)); + + // test_mixed_local_global + // We try this both with the global type registered first and vice versa (the order shouldn't + // matter). + m.def("register_mixed_global", [m]() { + bind_local(m, "MixedGlobalLocal", py::module_local(false)); + }); + m.def("register_mixed_local", [m]() { + bind_local(m, "MixedLocalGlobal", py::module_local()); + }); + m.def("get_mixed_gl", [](int i) { return MixedGlobalLocal(i); }); + m.def("get_mixed_lg", [](int i) { return MixedLocalGlobal(i); }); + + // test_internal_locals_differ + m.def("local_cpp_types_addr", []() { return (uintptr_t) &py::detail::registered_local_types_cpp(); }); + + // test_stl_caster_vs_stl_bind + m.def("load_vector_via_caster", [](std::vector v) { + return std::accumulate(v.begin(), v.end(), 0); + }); + + // test_cross_module_calls + m.def("return_self", [](LocalVec *v) { return v; }); + m.def("return_copy", [](const LocalVec &v) { return LocalVec(v); }); + + class Cat : public pets::Pet { public: Cat(std::string name) : Pet(name) {}; }; + py::class_(m, "Pet", py::module_local()) + .def("get_name", &pets::Pet::name); + // Binding for local extending class: + py::class_(m, "Cat") + .def(py::init()); + m.def("pet_name", [](pets::Pet &p) { return p.name(); }); + + py::class_(m, "MixGL").def(py::init()); + m.def("get_gl_value", [](MixGL &o) { return o.i + 10; }); + + py::class_(m, "MixGL2").def(py::init()); +} diff --git a/plugins/python/pybind11/tests/test_local_bindings.py b/plugins/python/pybind11/tests/test_local_bindings.py new file mode 100644 index 0000000..b3dc361 --- /dev/null +++ b/plugins/python/pybind11/tests/test_local_bindings.py @@ -0,0 +1,226 @@ +import pytest + +from pybind11_tests import local_bindings as m + + +def test_load_external(): + """Load a `py::module_local` type that's only registered in an external module""" + import pybind11_cross_module_tests as cm + + assert m.load_external1(cm.ExternalType1(11)) == 11 + assert m.load_external2(cm.ExternalType2(22)) == 22 + + with pytest.raises(TypeError) as excinfo: + assert m.load_external2(cm.ExternalType1(21)) == 21 + assert "incompatible function arguments" in str(excinfo.value) + + with pytest.raises(TypeError) as excinfo: + assert m.load_external1(cm.ExternalType2(12)) == 12 + assert "incompatible function arguments" in str(excinfo.value) + + +def test_local_bindings(): + """Tests that duplicate `py::module_local` class bindings work across modules""" + + # Make sure we can load the second module with the conflicting (but local) definition: + import pybind11_cross_module_tests as cm + + i1 = m.LocalType(5) + assert i1.get() == 4 + assert i1.get3() == 8 + + i2 = cm.LocalType(10) + assert i2.get() == 11 + assert i2.get2() == 12 + + assert not hasattr(i1, 'get2') + assert not hasattr(i2, 'get3') + + # Loading within the local module + assert m.local_value(i1) == 5 + assert cm.local_value(i2) == 10 + + # Cross-module loading works as well (on failure, the type loader looks for + # external module-local converters): + assert m.local_value(i2) == 10 + assert cm.local_value(i1) == 5 + + +def test_nonlocal_failure(): + """Tests that attempting to register a non-local type in multiple modules fails""" + import pybind11_cross_module_tests as cm + + with pytest.raises(RuntimeError) as excinfo: + cm.register_nonlocal() + assert str(excinfo.value) == 'generic_type: type "NonLocalType" is already registered!' + + +def test_duplicate_local(): + """Tests expected failure when registering a class twice with py::local in the same module""" + with pytest.raises(RuntimeError) as excinfo: + m.register_local_external() + import pybind11_tests + assert str(excinfo.value) == ( + 'generic_type: type "LocalExternal" is already registered!' + if hasattr(pybind11_tests, 'class_') else 'test_class not enabled') + + +def test_stl_bind_local(): + import pybind11_cross_module_tests as cm + + v1, v2 = m.LocalVec(), cm.LocalVec() + v1.append(m.LocalType(1)) + v1.append(m.LocalType(2)) + v2.append(cm.LocalType(1)) + v2.append(cm.LocalType(2)) + + # Cross module value loading: + v1.append(cm.LocalType(3)) + v2.append(m.LocalType(3)) + + assert [i.get() for i in v1] == [0, 1, 2] + assert [i.get() for i in v2] == [2, 3, 4] + + v3, v4 = m.NonLocalVec(), cm.NonLocalVec2() + v3.append(m.NonLocalType(1)) + v3.append(m.NonLocalType(2)) + v4.append(m.NonLocal2(3)) + v4.append(m.NonLocal2(4)) + + assert [i.get() for i in v3] == [1, 2] + assert [i.get() for i in v4] == [13, 14] + + d1, d2 = m.LocalMap(), cm.LocalMap() + d1["a"] = v1[0] + d1["b"] = v1[1] + d2["c"] = v2[0] + d2["d"] = v2[1] + assert {i: d1[i].get() for i in d1} == {'a': 0, 'b': 1} + assert {i: d2[i].get() for i in d2} == {'c': 2, 'd': 3} + + +def test_stl_bind_global(): + import pybind11_cross_module_tests as cm + + with pytest.raises(RuntimeError) as excinfo: + cm.register_nonlocal_map() + assert str(excinfo.value) == 'generic_type: type "NonLocalMap" is already registered!' + + with pytest.raises(RuntimeError) as excinfo: + cm.register_nonlocal_vec() + assert str(excinfo.value) == 'generic_type: type "NonLocalVec" is already registered!' + + with pytest.raises(RuntimeError) as excinfo: + cm.register_nonlocal_map2() + assert str(excinfo.value) == 'generic_type: type "NonLocalMap2" is already registered!' + + +def test_mixed_local_global(): + """Local types take precedence over globally registered types: a module with a `module_local` + type can be registered even if the type is already registered globally. With the module, + casting will go to the local type; outside the module casting goes to the global type.""" + import pybind11_cross_module_tests as cm + m.register_mixed_global() + m.register_mixed_local() + + a = [] + a.append(m.MixedGlobalLocal(1)) + a.append(m.MixedLocalGlobal(2)) + a.append(m.get_mixed_gl(3)) + a.append(m.get_mixed_lg(4)) + + assert [x.get() for x in a] == [101, 1002, 103, 1004] + + cm.register_mixed_global_local() + cm.register_mixed_local_global() + a.append(m.MixedGlobalLocal(5)) + a.append(m.MixedLocalGlobal(6)) + a.append(cm.MixedGlobalLocal(7)) + a.append(cm.MixedLocalGlobal(8)) + a.append(m.get_mixed_gl(9)) + a.append(m.get_mixed_lg(10)) + a.append(cm.get_mixed_gl(11)) + a.append(cm.get_mixed_lg(12)) + + assert [x.get() for x in a] == \ + [101, 1002, 103, 1004, 105, 1006, 207, 2008, 109, 1010, 211, 2012] + + +def test_internal_locals_differ(): + """Makes sure the internal local type map differs across the two modules""" + import pybind11_cross_module_tests as cm + assert m.local_cpp_types_addr() != cm.local_cpp_types_addr() + + +def test_stl_caster_vs_stl_bind(msg): + """One module uses a generic vector caster from `` while the other + exports `std::vector` via `py:bind_vector` and `py::module_local`""" + import pybind11_cross_module_tests as cm + + v1 = cm.VectorInt([1, 2, 3]) + assert m.load_vector_via_caster(v1) == 6 + assert cm.load_vector_via_binding(v1) == 6 + + v2 = [1, 2, 3] + assert m.load_vector_via_caster(v2) == 6 + with pytest.raises(TypeError) as excinfo: + cm.load_vector_via_binding(v2) == 6 + assert msg(excinfo.value) == """ + load_vector_via_binding(): incompatible function arguments. The following argument types are supported: + 1. (arg0: pybind11_cross_module_tests.VectorInt) -> int + + Invoked with: [1, 2, 3] + """ # noqa: E501 line too long + + +def test_cross_module_calls(): + import pybind11_cross_module_tests as cm + + v1 = m.LocalVec() + v1.append(m.LocalType(1)) + v2 = cm.LocalVec() + v2.append(cm.LocalType(2)) + + # Returning the self pointer should get picked up as returning an existing + # instance (even when that instance is of a foreign, non-local type). + assert m.return_self(v1) is v1 + assert cm.return_self(v2) is v2 + assert m.return_self(v2) is v2 + assert cm.return_self(v1) is v1 + + assert m.LocalVec is not cm.LocalVec + # Returning a copy, on the other hand, always goes to the local type, + # regardless of where the source type came from. + assert type(m.return_copy(v1)) is m.LocalVec + assert type(m.return_copy(v2)) is m.LocalVec + assert type(cm.return_copy(v1)) is cm.LocalVec + assert type(cm.return_copy(v2)) is cm.LocalVec + + # Test the example given in the documentation (which also tests inheritance casting): + mycat = m.Cat("Fluffy") + mydog = cm.Dog("Rover") + assert mycat.get_name() == "Fluffy" + assert mydog.name() == "Rover" + assert m.Cat.__base__.__name__ == "Pet" + assert cm.Dog.__base__.__name__ == "Pet" + assert m.Cat.__base__ is not cm.Dog.__base__ + assert m.pet_name(mycat) == "Fluffy" + assert m.pet_name(mydog) == "Rover" + assert cm.pet_name(mycat) == "Fluffy" + assert cm.pet_name(mydog) == "Rover" + + assert m.MixGL is not cm.MixGL + a = m.MixGL(1) + b = cm.MixGL(2) + assert m.get_gl_value(a) == 11 + assert m.get_gl_value(b) == 12 + assert cm.get_gl_value(a) == 101 + assert cm.get_gl_value(b) == 102 + + c, d = m.MixGL2(3), cm.MixGL2(4) + with pytest.raises(TypeError) as excinfo: + m.get_gl_value(c) + assert "incompatible function arguments" in str(excinfo) + with pytest.raises(TypeError) as excinfo: + m.get_gl_value(d) + assert "incompatible function arguments" in str(excinfo) diff --git a/plugins/python/pybind11/tests/test_methods_and_attributes.cpp b/plugins/python/pybind11/tests/test_methods_and_attributes.cpp new file mode 100644 index 0000000..cd15869 --- /dev/null +++ b/plugins/python/pybind11/tests/test_methods_and_attributes.cpp @@ -0,0 +1,446 @@ +/* + tests/test_methods_and_attributes.cpp -- constructors, deconstructors, attribute access, + __str__, argument and return value conventions + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" + +class ExampleMandA { +public: + ExampleMandA() { print_default_created(this); } + ExampleMandA(int value) : value(value) { print_created(this, value); } + ExampleMandA(const ExampleMandA &e) : value(e.value) { print_copy_created(this); } + ExampleMandA(ExampleMandA &&e) : value(e.value) { print_move_created(this); } + ~ExampleMandA() { print_destroyed(this); } + + std::string toString() { + return "ExampleMandA[value=" + std::to_string(value) + "]"; + } + + void operator=(const ExampleMandA &e) { print_copy_assigned(this); value = e.value; } + void operator=(ExampleMandA &&e) { print_move_assigned(this); value = e.value; } + + void add1(ExampleMandA other) { value += other.value; } // passing by value + void add2(ExampleMandA &other) { value += other.value; } // passing by reference + void add3(const ExampleMandA &other) { value += other.value; } // passing by const reference + void add4(ExampleMandA *other) { value += other->value; } // passing by pointer + void add5(const ExampleMandA *other) { value += other->value; } // passing by const pointer + + void add6(int other) { value += other; } // passing by value + void add7(int &other) { value += other; } // passing by reference + void add8(const int &other) { value += other; } // passing by const reference + void add9(int *other) { value += *other; } // passing by pointer + void add10(const int *other) { value += *other; } // passing by const pointer + + ExampleMandA self1() { return *this; } // return by value + ExampleMandA &self2() { return *this; } // return by reference + const ExampleMandA &self3() { return *this; } // return by const reference + ExampleMandA *self4() { return this; } // return by pointer + const ExampleMandA *self5() { return this; } // return by const pointer + + int internal1() { return value; } // return by value + int &internal2() { return value; } // return by reference + const int &internal3() { return value; } // return by const reference + int *internal4() { return &value; } // return by pointer + const int *internal5() { return &value; } // return by const pointer + + py::str overloaded() { return "()"; } + py::str overloaded(int) { return "(int)"; } + py::str overloaded(int, float) { return "(int, float)"; } + py::str overloaded(float, int) { return "(float, int)"; } + py::str overloaded(int, int) { return "(int, int)"; } + py::str overloaded(float, float) { return "(float, float)"; } + py::str overloaded(int) const { return "(int) const"; } + py::str overloaded(int, float) const { return "(int, float) const"; } + py::str overloaded(float, int) const { return "(float, int) const"; } + py::str overloaded(int, int) const { return "(int, int) const"; } + py::str overloaded(float, float) const { return "(float, float) const"; } + + static py::str overloaded(float) { return "static float"; } + + int value = 0; +}; + +struct TestProperties { + int value = 1; + static int static_value; + + int get() const { return value; } + void set(int v) { value = v; } + + static int static_get() { return static_value; } + static void static_set(int v) { static_value = v; } +}; +int TestProperties::static_value = 1; + +struct TestPropertiesOverride : TestProperties { + int value = 99; + static int static_value; +}; +int TestPropertiesOverride::static_value = 99; + +struct TestPropRVP { + UserType v1{1}; + UserType v2{1}; + static UserType sv1; + static UserType sv2; + + const UserType &get1() const { return v1; } + const UserType &get2() const { return v2; } + UserType get_rvalue() const { return v2; } + void set1(int v) { v1.set(v); } + void set2(int v) { v2.set(v); } +}; +UserType TestPropRVP::sv1(1); +UserType TestPropRVP::sv2(1); + +// py::arg/py::arg_v testing: these arguments just record their argument when invoked +class ArgInspector1 { public: std::string arg = "(default arg inspector 1)"; }; +class ArgInspector2 { public: std::string arg = "(default arg inspector 2)"; }; +class ArgAlwaysConverts { }; +namespace pybind11 { namespace detail { +template <> struct type_caster { +public: + PYBIND11_TYPE_CASTER(ArgInspector1, _("ArgInspector1")); + + bool load(handle src, bool convert) { + value.arg = "loading ArgInspector1 argument " + + std::string(convert ? "WITH" : "WITHOUT") + " conversion allowed. " + "Argument value = " + (std::string) str(src); + return true; + } + + static handle cast(const ArgInspector1 &src, return_value_policy, handle) { + return str(src.arg).release(); + } +}; +template <> struct type_caster { +public: + PYBIND11_TYPE_CASTER(ArgInspector2, _("ArgInspector2")); + + bool load(handle src, bool convert) { + value.arg = "loading ArgInspector2 argument " + + std::string(convert ? "WITH" : "WITHOUT") + " conversion allowed. " + "Argument value = " + (std::string) str(src); + return true; + } + + static handle cast(const ArgInspector2 &src, return_value_policy, handle) { + return str(src.arg).release(); + } +}; +template <> struct type_caster { +public: + PYBIND11_TYPE_CASTER(ArgAlwaysConverts, _("ArgAlwaysConverts")); + + bool load(handle, bool convert) { + return convert; + } + + static handle cast(const ArgAlwaysConverts &, return_value_policy, handle) { + return py::none().release(); + } +}; +}} + +// test_custom_caster_destruction +class DestructionTester { +public: + DestructionTester() { print_default_created(this); } + ~DestructionTester() { print_destroyed(this); } + DestructionTester(const DestructionTester &) { print_copy_created(this); } + DestructionTester(DestructionTester &&) { print_move_created(this); } + DestructionTester &operator=(const DestructionTester &) { print_copy_assigned(this); return *this; } + DestructionTester &operator=(DestructionTester &&) { print_move_assigned(this); return *this; } +}; +namespace pybind11 { namespace detail { +template <> struct type_caster { + PYBIND11_TYPE_CASTER(DestructionTester, _("DestructionTester")); + bool load(handle, bool) { return true; } + + static handle cast(const DestructionTester &, return_value_policy, handle) { + return py::bool_(true).release(); + } +}; +}} + +// Test None-allowed py::arg argument policy +class NoneTester { public: int answer = 42; }; +int none1(const NoneTester &obj) { return obj.answer; } +int none2(NoneTester *obj) { return obj ? obj->answer : -1; } +int none3(std::shared_ptr &obj) { return obj ? obj->answer : -1; } +int none4(std::shared_ptr *obj) { return obj && *obj ? (*obj)->answer : -1; } +int none5(std::shared_ptr obj) { return obj ? obj->answer : -1; } + +struct StrIssue { + int val = -1; + + StrIssue() = default; + StrIssue(int i) : val{i} {} +}; + +// Issues #854, #910: incompatible function args when member function/pointer is in unregistered base class +class UnregisteredBase { +public: + void do_nothing() const {} + void increase_value() { rw_value++; ro_value += 0.25; } + void set_int(int v) { rw_value = v; } + int get_int() const { return rw_value; } + double get_double() const { return ro_value; } + int rw_value = 42; + double ro_value = 1.25; +}; +class RegisteredDerived : public UnregisteredBase { +public: + using UnregisteredBase::UnregisteredBase; + double sum() const { return rw_value + ro_value; } +}; + +TEST_SUBMODULE(methods_and_attributes, m) { + // test_methods_and_attributes + py::class_ emna(m, "ExampleMandA"); + emna.def(py::init<>()) + .def(py::init()) + .def(py::init()) + .def("add1", &ExampleMandA::add1) + .def("add2", &ExampleMandA::add2) + .def("add3", &ExampleMandA::add3) + .def("add4", &ExampleMandA::add4) + .def("add5", &ExampleMandA::add5) + .def("add6", &ExampleMandA::add6) + .def("add7", &ExampleMandA::add7) + .def("add8", &ExampleMandA::add8) + .def("add9", &ExampleMandA::add9) + .def("add10", &ExampleMandA::add10) + .def("self1", &ExampleMandA::self1) + .def("self2", &ExampleMandA::self2) + .def("self3", &ExampleMandA::self3) + .def("self4", &ExampleMandA::self4) + .def("self5", &ExampleMandA::self5) + .def("internal1", &ExampleMandA::internal1) + .def("internal2", &ExampleMandA::internal2) + .def("internal3", &ExampleMandA::internal3) + .def("internal4", &ExampleMandA::internal4) + .def("internal5", &ExampleMandA::internal5) +#if defined(PYBIND11_OVERLOAD_CAST) + .def("overloaded", py::overload_cast<>(&ExampleMandA::overloaded)) + .def("overloaded", py::overload_cast(&ExampleMandA::overloaded)) + .def("overloaded", py::overload_cast(&ExampleMandA::overloaded)) + .def("overloaded", py::overload_cast(&ExampleMandA::overloaded)) + .def("overloaded", py::overload_cast(&ExampleMandA::overloaded)) + .def("overloaded", py::overload_cast(&ExampleMandA::overloaded)) + .def("overloaded_float", py::overload_cast(&ExampleMandA::overloaded)) + .def("overloaded_const", py::overload_cast(&ExampleMandA::overloaded, py::const_)) + .def("overloaded_const", py::overload_cast(&ExampleMandA::overloaded, py::const_)) + .def("overloaded_const", py::overload_cast(&ExampleMandA::overloaded, py::const_)) + .def("overloaded_const", py::overload_cast(&ExampleMandA::overloaded, py::const_)) + .def("overloaded_const", py::overload_cast(&ExampleMandA::overloaded, py::const_)) +#else + .def("overloaded", static_cast(&ExampleMandA::overloaded)) + .def("overloaded", static_cast(&ExampleMandA::overloaded)) + .def("overloaded", static_cast(&ExampleMandA::overloaded)) + .def("overloaded", static_cast(&ExampleMandA::overloaded)) + .def("overloaded", static_cast(&ExampleMandA::overloaded)) + .def("overloaded", static_cast(&ExampleMandA::overloaded)) + .def("overloaded_float", static_cast(&ExampleMandA::overloaded)) + .def("overloaded_const", static_cast(&ExampleMandA::overloaded)) + .def("overloaded_const", static_cast(&ExampleMandA::overloaded)) + .def("overloaded_const", static_cast(&ExampleMandA::overloaded)) + .def("overloaded_const", static_cast(&ExampleMandA::overloaded)) + .def("overloaded_const", static_cast(&ExampleMandA::overloaded)) +#endif + // test_no_mixed_overloads + // Raise error if trying to mix static/non-static overloads on the same name: + .def_static("add_mixed_overloads1", []() { + auto emna = py::reinterpret_borrow>(py::module::import("pybind11_tests.methods_and_attributes").attr("ExampleMandA")); + emna.def ("overload_mixed1", static_cast(&ExampleMandA::overloaded)) + .def_static("overload_mixed1", static_cast(&ExampleMandA::overloaded)); + }) + .def_static("add_mixed_overloads2", []() { + auto emna = py::reinterpret_borrow>(py::module::import("pybind11_tests.methods_and_attributes").attr("ExampleMandA")); + emna.def_static("overload_mixed2", static_cast(&ExampleMandA::overloaded)) + .def ("overload_mixed2", static_cast(&ExampleMandA::overloaded)); + }) + .def("__str__", &ExampleMandA::toString) + .def_readwrite("value", &ExampleMandA::value); + + // test_copy_method + // Issue #443: can't call copied methods in Python 3 + emna.attr("add2b") = emna.attr("add2"); + + // test_properties, test_static_properties, test_static_cls + py::class_(m, "TestProperties") + .def(py::init<>()) + .def_readonly("def_readonly", &TestProperties::value) + .def_readwrite("def_readwrite", &TestProperties::value) + .def_property_readonly("def_property_readonly", &TestProperties::get) + .def_property("def_property", &TestProperties::get, &TestProperties::set) + .def_readonly_static("def_readonly_static", &TestProperties::static_value) + .def_readwrite_static("def_readwrite_static", &TestProperties::static_value) + .def_property_readonly_static("def_property_readonly_static", + [](py::object) { return TestProperties::static_get(); }) + .def_property_static("def_property_static", + [](py::object) { return TestProperties::static_get(); }, + [](py::object, int v) { TestProperties::static_set(v); }) + .def_property_static("static_cls", + [](py::object cls) { return cls; }, + [](py::object cls, py::function f) { f(cls); }); + + py::class_(m, "TestPropertiesOverride") + .def(py::init<>()) + .def_readonly("def_readonly", &TestPropertiesOverride::value) + .def_readonly_static("def_readonly_static", &TestPropertiesOverride::static_value); + + auto static_get1 = [](py::object) -> const UserType & { return TestPropRVP::sv1; }; + auto static_get2 = [](py::object) -> const UserType & { return TestPropRVP::sv2; }; + auto static_set1 = [](py::object, int v) { TestPropRVP::sv1.set(v); }; + auto static_set2 = [](py::object, int v) { TestPropRVP::sv2.set(v); }; + auto rvp_copy = py::return_value_policy::copy; + + // test_property_return_value_policies + py::class_(m, "TestPropRVP") + .def(py::init<>()) + .def_property_readonly("ro_ref", &TestPropRVP::get1) + .def_property_readonly("ro_copy", &TestPropRVP::get2, rvp_copy) + .def_property_readonly("ro_func", py::cpp_function(&TestPropRVP::get2, rvp_copy)) + .def_property("rw_ref", &TestPropRVP::get1, &TestPropRVP::set1) + .def_property("rw_copy", &TestPropRVP::get2, &TestPropRVP::set2, rvp_copy) + .def_property("rw_func", py::cpp_function(&TestPropRVP::get2, rvp_copy), &TestPropRVP::set2) + .def_property_readonly_static("static_ro_ref", static_get1) + .def_property_readonly_static("static_ro_copy", static_get2, rvp_copy) + .def_property_readonly_static("static_ro_func", py::cpp_function(static_get2, rvp_copy)) + .def_property_static("static_rw_ref", static_get1, static_set1) + .def_property_static("static_rw_copy", static_get2, static_set2, rvp_copy) + .def_property_static("static_rw_func", py::cpp_function(static_get2, rvp_copy), static_set2) + // test_property_rvalue_policy + .def_property_readonly("rvalue", &TestPropRVP::get_rvalue) + .def_property_readonly_static("static_rvalue", [](py::object) { return UserType(1); }); + + // test_metaclass_override + struct MetaclassOverride { }; + py::class_(m, "MetaclassOverride", py::metaclass((PyObject *) &PyType_Type)) + .def_property_readonly_static("readonly", [](py::object) { return 1; }); + +#if !defined(PYPY_VERSION) + // test_dynamic_attributes + class DynamicClass { + public: + DynamicClass() { print_default_created(this); } + ~DynamicClass() { print_destroyed(this); } + }; + py::class_(m, "DynamicClass", py::dynamic_attr()) + .def(py::init()); + + class CppDerivedDynamicClass : public DynamicClass { }; + py::class_(m, "CppDerivedDynamicClass") + .def(py::init()); +#endif + + // test_noconvert_args + // + // Test converting. The ArgAlwaysConverts is just there to make the first no-conversion pass + // fail so that our call always ends up happening via the second dispatch (the one that allows + // some conversion). + class ArgInspector { + public: + ArgInspector1 f(ArgInspector1 a, ArgAlwaysConverts) { return a; } + std::string g(ArgInspector1 a, const ArgInspector1 &b, int c, ArgInspector2 *d, ArgAlwaysConverts) { + return a.arg + "\n" + b.arg + "\n" + std::to_string(c) + "\n" + d->arg; + } + static ArgInspector2 h(ArgInspector2 a, ArgAlwaysConverts) { return a; } + }; + py::class_(m, "ArgInspector") + .def(py::init<>()) + .def("f", &ArgInspector::f, py::arg(), py::arg() = ArgAlwaysConverts()) + .def("g", &ArgInspector::g, "a"_a.noconvert(), "b"_a, "c"_a.noconvert()=13, "d"_a=ArgInspector2(), py::arg() = ArgAlwaysConverts()) + .def_static("h", &ArgInspector::h, py::arg().noconvert(), py::arg() = ArgAlwaysConverts()) + ; + m.def("arg_inspect_func", [](ArgInspector2 a, ArgInspector1 b, ArgAlwaysConverts) { return a.arg + "\n" + b.arg; }, + py::arg().noconvert(false), py::arg_v(nullptr, ArgInspector1()).noconvert(true), py::arg() = ArgAlwaysConverts()); + + m.def("floats_preferred", [](double f) { return 0.5 * f; }, py::arg("f")); + m.def("floats_only", [](double f) { return 0.5 * f; }, py::arg("f").noconvert()); + m.def("ints_preferred", [](int i) { return i / 2; }, py::arg("i")); + m.def("ints_only", [](int i) { return i / 2; }, py::arg("i").noconvert()); + + // test_bad_arg_default + // Issue/PR #648: bad arg default debugging output +#if !defined(NDEBUG) + m.attr("debug_enabled") = true; +#else + m.attr("debug_enabled") = false; +#endif + m.def("bad_arg_def_named", []{ + auto m = py::module::import("pybind11_tests"); + m.def("should_fail", [](int, UnregisteredType) {}, py::arg(), py::arg("a") = UnregisteredType()); + }); + m.def("bad_arg_def_unnamed", []{ + auto m = py::module::import("pybind11_tests"); + m.def("should_fail", [](int, UnregisteredType) {}, py::arg(), py::arg() = UnregisteredType()); + }); + + // test_accepts_none + py::class_>(m, "NoneTester") + .def(py::init<>()); + m.def("no_none1", &none1, py::arg().none(false)); + m.def("no_none2", &none2, py::arg().none(false)); + m.def("no_none3", &none3, py::arg().none(false)); + m.def("no_none4", &none4, py::arg().none(false)); + m.def("no_none5", &none5, py::arg().none(false)); + m.def("ok_none1", &none1); + m.def("ok_none2", &none2, py::arg().none(true)); + m.def("ok_none3", &none3); + m.def("ok_none4", &none4, py::arg().none(true)); + m.def("ok_none5", &none5); + + // test_str_issue + // Issue #283: __str__ called on uninitialized instance when constructor arguments invalid + py::class_(m, "StrIssue") + .def(py::init()) + .def(py::init<>()) + .def("__str__", [](const StrIssue &si) { + return "StrIssue[" + std::to_string(si.val) + "]"; } + ); + + // test_unregistered_base_implementations + // + // Issues #854/910: incompatible function args when member function/pointer is in unregistered + // base class The methods and member pointers below actually resolve to members/pointers in + // UnregisteredBase; before this test/fix they would be registered via lambda with a first + // argument of an unregistered type, and thus uncallable. + py::class_(m, "RegisteredDerived") + .def(py::init<>()) + .def("do_nothing", &RegisteredDerived::do_nothing) + .def("increase_value", &RegisteredDerived::increase_value) + .def_readwrite("rw_value", &RegisteredDerived::rw_value) + .def_readonly("ro_value", &RegisteredDerived::ro_value) + // These should trigger a static_assert if uncommented + //.def_readwrite("fails", &UserType::value) // should trigger a static_assert if uncommented + //.def_readonly("fails", &UserType::value) // should trigger a static_assert if uncommented + .def_property("rw_value_prop", &RegisteredDerived::get_int, &RegisteredDerived::set_int) + .def_property_readonly("ro_value_prop", &RegisteredDerived::get_double) + // This one is in the registered class: + .def("sum", &RegisteredDerived::sum) + ; + + using Adapted = decltype(py::method_adaptor(&RegisteredDerived::do_nothing)); + static_assert(std::is_same::value, ""); + + // test_custom_caster_destruction + // Test that `take_ownership` works on types with a custom type caster when given a pointer + + // default policy: don't take ownership: + m.def("custom_caster_no_destroy", []() { static auto *dt = new DestructionTester(); return dt; }); + + m.def("custom_caster_destroy", []() { return new DestructionTester(); }, + py::return_value_policy::take_ownership); // Takes ownership: destroy when finished + m.def("custom_caster_destroy_const", []() -> const DestructionTester * { return new DestructionTester(); }, + py::return_value_policy::take_ownership); // Likewise (const doesn't inhibit destruction) + m.def("destruction_tester_cstats", &ConstructorStats::get, py::return_value_policy::reference); +} diff --git a/plugins/python/pybind11/tests/test_methods_and_attributes.py b/plugins/python/pybind11/tests/test_methods_and_attributes.py new file mode 100644 index 0000000..9fd9cb7 --- /dev/null +++ b/plugins/python/pybind11/tests/test_methods_and_attributes.py @@ -0,0 +1,476 @@ +import pytest +from pybind11_tests import methods_and_attributes as m +from pybind11_tests import ConstructorStats + + +def test_methods_and_attributes(): + instance1 = m.ExampleMandA() + instance2 = m.ExampleMandA(32) + + instance1.add1(instance2) + instance1.add2(instance2) + instance1.add3(instance2) + instance1.add4(instance2) + instance1.add5(instance2) + instance1.add6(32) + instance1.add7(32) + instance1.add8(32) + instance1.add9(32) + instance1.add10(32) + + assert str(instance1) == "ExampleMandA[value=320]" + assert str(instance2) == "ExampleMandA[value=32]" + assert str(instance1.self1()) == "ExampleMandA[value=320]" + assert str(instance1.self2()) == "ExampleMandA[value=320]" + assert str(instance1.self3()) == "ExampleMandA[value=320]" + assert str(instance1.self4()) == "ExampleMandA[value=320]" + assert str(instance1.self5()) == "ExampleMandA[value=320]" + + assert instance1.internal1() == 320 + assert instance1.internal2() == 320 + assert instance1.internal3() == 320 + assert instance1.internal4() == 320 + assert instance1.internal5() == 320 + + assert instance1.overloaded() == "()" + assert instance1.overloaded(0) == "(int)" + assert instance1.overloaded(1, 1.0) == "(int, float)" + assert instance1.overloaded(2.0, 2) == "(float, int)" + assert instance1.overloaded(3, 3) == "(int, int)" + assert instance1.overloaded(4., 4.) == "(float, float)" + assert instance1.overloaded_const(-3) == "(int) const" + assert instance1.overloaded_const(5, 5.0) == "(int, float) const" + assert instance1.overloaded_const(6.0, 6) == "(float, int) const" + assert instance1.overloaded_const(7, 7) == "(int, int) const" + assert instance1.overloaded_const(8., 8.) == "(float, float) const" + assert instance1.overloaded_float(1, 1) == "(float, float)" + assert instance1.overloaded_float(1, 1.) == "(float, float)" + assert instance1.overloaded_float(1., 1) == "(float, float)" + assert instance1.overloaded_float(1., 1.) == "(float, float)" + + assert instance1.value == 320 + instance1.value = 100 + assert str(instance1) == "ExampleMandA[value=100]" + + cstats = ConstructorStats.get(m.ExampleMandA) + assert cstats.alive() == 2 + del instance1, instance2 + assert cstats.alive() == 0 + assert cstats.values() == ["32"] + assert cstats.default_constructions == 1 + assert cstats.copy_constructions == 3 + assert cstats.move_constructions >= 1 + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + +def test_copy_method(): + """Issue #443: calling copied methods fails in Python 3""" + + m.ExampleMandA.add2c = m.ExampleMandA.add2 + m.ExampleMandA.add2d = m.ExampleMandA.add2b + a = m.ExampleMandA(123) + assert a.value == 123 + a.add2(m.ExampleMandA(-100)) + assert a.value == 23 + a.add2b(m.ExampleMandA(20)) + assert a.value == 43 + a.add2c(m.ExampleMandA(6)) + assert a.value == 49 + a.add2d(m.ExampleMandA(-7)) + assert a.value == 42 + + +def test_properties(): + instance = m.TestProperties() + + assert instance.def_readonly == 1 + with pytest.raises(AttributeError): + instance.def_readonly = 2 + + instance.def_readwrite = 2 + assert instance.def_readwrite == 2 + + assert instance.def_property_readonly == 2 + with pytest.raises(AttributeError): + instance.def_property_readonly = 3 + + instance.def_property = 3 + assert instance.def_property == 3 + + +def test_static_properties(): + assert m.TestProperties.def_readonly_static == 1 + with pytest.raises(AttributeError) as excinfo: + m.TestProperties.def_readonly_static = 2 + assert "can't set attribute" in str(excinfo) + + m.TestProperties.def_readwrite_static = 2 + assert m.TestProperties.def_readwrite_static == 2 + + assert m.TestProperties.def_property_readonly_static == 2 + with pytest.raises(AttributeError) as excinfo: + m.TestProperties.def_property_readonly_static = 3 + assert "can't set attribute" in str(excinfo) + + m.TestProperties.def_property_static = 3 + assert m.TestProperties.def_property_static == 3 + + # Static property read and write via instance + instance = m.TestProperties() + + m.TestProperties.def_readwrite_static = 0 + assert m.TestProperties.def_readwrite_static == 0 + assert instance.def_readwrite_static == 0 + + instance.def_readwrite_static = 2 + assert m.TestProperties.def_readwrite_static == 2 + assert instance.def_readwrite_static == 2 + + # It should be possible to override properties in derived classes + assert m.TestPropertiesOverride().def_readonly == 99 + assert m.TestPropertiesOverride.def_readonly_static == 99 + + +def test_static_cls(): + """Static property getter and setters expect the type object as the their only argument""" + + instance = m.TestProperties() + assert m.TestProperties.static_cls is m.TestProperties + assert instance.static_cls is m.TestProperties + + def check_self(self): + assert self is m.TestProperties + + m.TestProperties.static_cls = check_self + instance.static_cls = check_self + + +def test_metaclass_override(): + """Overriding pybind11's default metaclass changes the behavior of `static_property`""" + + assert type(m.ExampleMandA).__name__ == "pybind11_type" + assert type(m.MetaclassOverride).__name__ == "type" + + assert m.MetaclassOverride.readonly == 1 + assert type(m.MetaclassOverride.__dict__["readonly"]).__name__ == "pybind11_static_property" + + # Regular `type` replaces the property instead of calling `__set__()` + m.MetaclassOverride.readonly = 2 + assert m.MetaclassOverride.readonly == 2 + assert isinstance(m.MetaclassOverride.__dict__["readonly"], int) + + +def test_no_mixed_overloads(): + from pybind11_tests import debug_enabled + + with pytest.raises(RuntimeError) as excinfo: + m.ExampleMandA.add_mixed_overloads1() + assert (str(excinfo.value) == + "overloading a method with both static and instance methods is not supported; " + + ("compile in debug mode for more details" if not debug_enabled else + "error while attempting to bind static method ExampleMandA.overload_mixed1" + "(arg0: float) -> str") + ) + + with pytest.raises(RuntimeError) as excinfo: + m.ExampleMandA.add_mixed_overloads2() + assert (str(excinfo.value) == + "overloading a method with both static and instance methods is not supported; " + + ("compile in debug mode for more details" if not debug_enabled else + "error while attempting to bind instance method ExampleMandA.overload_mixed2" + "(self: pybind11_tests.methods_and_attributes.ExampleMandA, arg0: int, arg1: int)" + " -> str") + ) + + +@pytest.mark.parametrize("access", ["ro", "rw", "static_ro", "static_rw"]) +def test_property_return_value_policies(access): + if not access.startswith("static"): + obj = m.TestPropRVP() + else: + obj = m.TestPropRVP + + ref = getattr(obj, access + "_ref") + assert ref.value == 1 + ref.value = 2 + assert getattr(obj, access + "_ref").value == 2 + ref.value = 1 # restore original value for static properties + + copy = getattr(obj, access + "_copy") + assert copy.value == 1 + copy.value = 2 + assert getattr(obj, access + "_copy").value == 1 + + copy = getattr(obj, access + "_func") + assert copy.value == 1 + copy.value = 2 + assert getattr(obj, access + "_func").value == 1 + + +def test_property_rvalue_policy(): + """When returning an rvalue, the return value policy is automatically changed from + `reference(_internal)` to `move`. The following would not work otherwise.""" + + instance = m.TestPropRVP() + o = instance.rvalue + assert o.value == 1 + + os = m.TestPropRVP.static_rvalue + assert os.value == 1 + + +# https://bitbucket.org/pypy/pypy/issues/2447 +@pytest.unsupported_on_pypy +def test_dynamic_attributes(): + instance = m.DynamicClass() + assert not hasattr(instance, "foo") + assert "foo" not in dir(instance) + + # Dynamically add attribute + instance.foo = 42 + assert hasattr(instance, "foo") + assert instance.foo == 42 + assert "foo" in dir(instance) + + # __dict__ should be accessible and replaceable + assert "foo" in instance.__dict__ + instance.__dict__ = {"bar": True} + assert not hasattr(instance, "foo") + assert hasattr(instance, "bar") + + with pytest.raises(TypeError) as excinfo: + instance.__dict__ = [] + assert str(excinfo.value) == "__dict__ must be set to a dictionary, not a 'list'" + + cstats = ConstructorStats.get(m.DynamicClass) + assert cstats.alive() == 1 + del instance + assert cstats.alive() == 0 + + # Derived classes should work as well + class PythonDerivedDynamicClass(m.DynamicClass): + pass + + for cls in m.CppDerivedDynamicClass, PythonDerivedDynamicClass: + derived = cls() + derived.foobar = 100 + assert derived.foobar == 100 + + assert cstats.alive() == 1 + del derived + assert cstats.alive() == 0 + + +# https://bitbucket.org/pypy/pypy/issues/2447 +@pytest.unsupported_on_pypy +def test_cyclic_gc(): + # One object references itself + instance = m.DynamicClass() + instance.circular_reference = instance + + cstats = ConstructorStats.get(m.DynamicClass) + assert cstats.alive() == 1 + del instance + assert cstats.alive() == 0 + + # Two object reference each other + i1 = m.DynamicClass() + i2 = m.DynamicClass() + i1.cycle = i2 + i2.cycle = i1 + + assert cstats.alive() == 2 + del i1, i2 + assert cstats.alive() == 0 + + +def test_noconvert_args(msg): + a = m.ArgInspector() + assert msg(a.f("hi")) == """ + loading ArgInspector1 argument WITH conversion allowed. Argument value = hi + """ + assert msg(a.g("this is a", "this is b")) == """ + loading ArgInspector1 argument WITHOUT conversion allowed. Argument value = this is a + loading ArgInspector1 argument WITH conversion allowed. Argument value = this is b + 13 + loading ArgInspector2 argument WITH conversion allowed. Argument value = (default arg inspector 2) + """ # noqa: E501 line too long + assert msg(a.g("this is a", "this is b", 42)) == """ + loading ArgInspector1 argument WITHOUT conversion allowed. Argument value = this is a + loading ArgInspector1 argument WITH conversion allowed. Argument value = this is b + 42 + loading ArgInspector2 argument WITH conversion allowed. Argument value = (default arg inspector 2) + """ # noqa: E501 line too long + assert msg(a.g("this is a", "this is b", 42, "this is d")) == """ + loading ArgInspector1 argument WITHOUT conversion allowed. Argument value = this is a + loading ArgInspector1 argument WITH conversion allowed. Argument value = this is b + 42 + loading ArgInspector2 argument WITH conversion allowed. Argument value = this is d + """ + assert (a.h("arg 1") == + "loading ArgInspector2 argument WITHOUT conversion allowed. Argument value = arg 1") + assert msg(m.arg_inspect_func("A1", "A2")) == """ + loading ArgInspector2 argument WITH conversion allowed. Argument value = A1 + loading ArgInspector1 argument WITHOUT conversion allowed. Argument value = A2 + """ + + assert m.floats_preferred(4) == 2.0 + assert m.floats_only(4.0) == 2.0 + with pytest.raises(TypeError) as excinfo: + m.floats_only(4) + assert msg(excinfo.value) == """ + floats_only(): incompatible function arguments. The following argument types are supported: + 1. (f: float) -> float + + Invoked with: 4 + """ + + assert m.ints_preferred(4) == 2 + assert m.ints_preferred(True) == 0 + with pytest.raises(TypeError) as excinfo: + m.ints_preferred(4.0) + assert msg(excinfo.value) == """ + ints_preferred(): incompatible function arguments. The following argument types are supported: + 1. (i: int) -> int + + Invoked with: 4.0 + """ # noqa: E501 line too long + + assert m.ints_only(4) == 2 + with pytest.raises(TypeError) as excinfo: + m.ints_only(4.0) + assert msg(excinfo.value) == """ + ints_only(): incompatible function arguments. The following argument types are supported: + 1. (i: int) -> int + + Invoked with: 4.0 + """ + + +def test_bad_arg_default(msg): + from pybind11_tests import debug_enabled + + with pytest.raises(RuntimeError) as excinfo: + m.bad_arg_def_named() + assert msg(excinfo.value) == ( + "arg(): could not convert default argument 'a: UnregisteredType' in function " + "'should_fail' into a Python object (type not registered yet?)" + if debug_enabled else + "arg(): could not convert default argument into a Python object (type not registered " + "yet?). Compile in debug mode for more information." + ) + + with pytest.raises(RuntimeError) as excinfo: + m.bad_arg_def_unnamed() + assert msg(excinfo.value) == ( + "arg(): could not convert default argument 'UnregisteredType' in function " + "'should_fail' into a Python object (type not registered yet?)" + if debug_enabled else + "arg(): could not convert default argument into a Python object (type not registered " + "yet?). Compile in debug mode for more information." + ) + + +def test_accepts_none(msg): + a = m.NoneTester() + assert m.no_none1(a) == 42 + assert m.no_none2(a) == 42 + assert m.no_none3(a) == 42 + assert m.no_none4(a) == 42 + assert m.no_none5(a) == 42 + assert m.ok_none1(a) == 42 + assert m.ok_none2(a) == 42 + assert m.ok_none3(a) == 42 + assert m.ok_none4(a) == 42 + assert m.ok_none5(a) == 42 + + with pytest.raises(TypeError) as excinfo: + m.no_none1(None) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.no_none2(None) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.no_none3(None) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.no_none4(None) + assert "incompatible function arguments" in str(excinfo.value) + with pytest.raises(TypeError) as excinfo: + m.no_none5(None) + assert "incompatible function arguments" in str(excinfo.value) + + # The first one still raises because you can't pass None as a lvalue reference arg: + with pytest.raises(TypeError) as excinfo: + assert m.ok_none1(None) == -1 + assert msg(excinfo.value) == """ + ok_none1(): incompatible function arguments. The following argument types are supported: + 1. (arg0: m.methods_and_attributes.NoneTester) -> int + + Invoked with: None + """ + + # The rest take the argument as pointer or holder, and accept None: + assert m.ok_none2(None) == -1 + assert m.ok_none3(None) == -1 + assert m.ok_none4(None) == -1 + assert m.ok_none5(None) == -1 + + +def test_str_issue(msg): + """#283: __str__ called on uninitialized instance when constructor arguments invalid""" + + assert str(m.StrIssue(3)) == "StrIssue[3]" + + with pytest.raises(TypeError) as excinfo: + str(m.StrIssue("no", "such", "constructor")) + assert msg(excinfo.value) == """ + __init__(): incompatible constructor arguments. The following argument types are supported: + 1. m.methods_and_attributes.StrIssue(arg0: int) + 2. m.methods_and_attributes.StrIssue() + + Invoked with: 'no', 'such', 'constructor' + """ + + +def test_unregistered_base_implementations(): + a = m.RegisteredDerived() + a.do_nothing() + assert a.rw_value == 42 + assert a.ro_value == 1.25 + a.rw_value += 5 + assert a.sum() == 48.25 + a.increase_value() + assert a.rw_value == 48 + assert a.ro_value == 1.5 + assert a.sum() == 49.5 + assert a.rw_value_prop == 48 + a.rw_value_prop += 1 + assert a.rw_value_prop == 49 + a.increase_value() + assert a.ro_value_prop == 1.75 + + +def test_custom_caster_destruction(): + """Tests that returning a pointer to a type that gets converted with a custom type caster gets + destroyed when the function has py::return_value_policy::take_ownership policy applied.""" + + cstats = m.destruction_tester_cstats() + # This one *doesn't* have take_ownership: the pointer should be used but not destroyed: + z = m.custom_caster_no_destroy() + assert cstats.alive() == 1 and cstats.default_constructions == 1 + assert z + + # take_ownership applied: this constructs a new object, casts it, then destroys it: + z = m.custom_caster_destroy() + assert z + assert cstats.default_constructions == 2 + + # Same, but with a const pointer return (which should *not* inhibit destruction): + z = m.custom_caster_destroy_const() + assert z + assert cstats.default_constructions == 3 + + # Make sure we still only have the original object (from ..._no_destroy()) alive: + assert cstats.alive() == 1 diff --git a/plugins/python/pybind11/tests/test_modules.cpp b/plugins/python/pybind11/tests/test_modules.cpp new file mode 100644 index 0000000..c1475fa --- /dev/null +++ b/plugins/python/pybind11/tests/test_modules.cpp @@ -0,0 +1,98 @@ +/* + tests/test_modules.cpp -- nested modules, importing modules, and + internal references + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" + +TEST_SUBMODULE(modules, m) { + // test_nested_modules + py::module m_sub = m.def_submodule("subsubmodule"); + m_sub.def("submodule_func", []() { return "submodule_func()"; }); + + // test_reference_internal + class A { + public: + A(int v) : v(v) { print_created(this, v); } + ~A() { print_destroyed(this); } + A(const A&) { print_copy_created(this); } + A& operator=(const A ©) { print_copy_assigned(this); v = copy.v; return *this; } + std::string toString() { return "A[" + std::to_string(v) + "]"; } + private: + int v; + }; + py::class_(m_sub, "A") + .def(py::init()) + .def("__repr__", &A::toString); + + class B { + public: + B() { print_default_created(this); } + ~B() { print_destroyed(this); } + B(const B&) { print_copy_created(this); } + B& operator=(const B ©) { print_copy_assigned(this); a1 = copy.a1; a2 = copy.a2; return *this; } + A &get_a1() { return a1; } + A &get_a2() { return a2; } + + A a1{1}; + A a2{2}; + }; + py::class_(m_sub, "B") + .def(py::init<>()) + .def("get_a1", &B::get_a1, "Return the internal A 1", py::return_value_policy::reference_internal) + .def("get_a2", &B::get_a2, "Return the internal A 2", py::return_value_policy::reference_internal) + .def_readwrite("a1", &B::a1) // def_readonly uses an internal reference return policy by default + .def_readwrite("a2", &B::a2); + + m.attr("OD") = py::module::import("collections").attr("OrderedDict"); + + // test_duplicate_registration + // Registering two things with the same name + m.def("duplicate_registration", []() { + class Dupe1 { }; + class Dupe2 { }; + class Dupe3 { }; + class DupeException { }; + + auto dm = py::module("dummy"); + auto failures = py::list(); + + py::class_(dm, "Dupe1"); + py::class_(dm, "Dupe2"); + dm.def("dupe1_factory", []() { return Dupe1(); }); + py::exception(dm, "DupeException"); + + try { + py::class_(dm, "Dupe1"); + failures.append("Dupe1 class"); + } catch (std::runtime_error &) {} + try { + dm.def("Dupe1", []() { return Dupe1(); }); + failures.append("Dupe1 function"); + } catch (std::runtime_error &) {} + try { + py::class_(dm, "dupe1_factory"); + failures.append("dupe1_factory"); + } catch (std::runtime_error &) {} + try { + py::exception(dm, "Dupe2"); + failures.append("Dupe2"); + } catch (std::runtime_error &) {} + try { + dm.def("DupeException", []() { return 30; }); + failures.append("DupeException1"); + } catch (std::runtime_error &) {} + try { + py::class_(dm, "DupeException"); + failures.append("DupeException2"); + } catch (std::runtime_error &) {} + + return failures; + }); +} diff --git a/plugins/python/pybind11/tests/test_modules.py b/plugins/python/pybind11/tests/test_modules.py new file mode 100644 index 0000000..2552838 --- /dev/null +++ b/plugins/python/pybind11/tests/test_modules.py @@ -0,0 +1,72 @@ +from pybind11_tests import modules as m +from pybind11_tests.modules import subsubmodule as ms +from pybind11_tests import ConstructorStats + + +def test_nested_modules(): + import pybind11_tests + assert pybind11_tests.__name__ == "pybind11_tests" + assert pybind11_tests.modules.__name__ == "pybind11_tests.modules" + assert pybind11_tests.modules.subsubmodule.__name__ == "pybind11_tests.modules.subsubmodule" + assert m.__name__ == "pybind11_tests.modules" + assert ms.__name__ == "pybind11_tests.modules.subsubmodule" + + assert ms.submodule_func() == "submodule_func()" + + +def test_reference_internal(): + b = ms.B() + assert str(b.get_a1()) == "A[1]" + assert str(b.a1) == "A[1]" + assert str(b.get_a2()) == "A[2]" + assert str(b.a2) == "A[2]" + + b.a1 = ms.A(42) + b.a2 = ms.A(43) + assert str(b.get_a1()) == "A[42]" + assert str(b.a1) == "A[42]" + assert str(b.get_a2()) == "A[43]" + assert str(b.a2) == "A[43]" + + astats, bstats = ConstructorStats.get(ms.A), ConstructorStats.get(ms.B) + assert astats.alive() == 2 + assert bstats.alive() == 1 + del b + assert astats.alive() == 0 + assert bstats.alive() == 0 + assert astats.values() == ['1', '2', '42', '43'] + assert bstats.values() == [] + assert astats.default_constructions == 0 + assert bstats.default_constructions == 1 + assert astats.copy_constructions == 0 + assert bstats.copy_constructions == 0 + # assert astats.move_constructions >= 0 # Don't invoke any + # assert bstats.move_constructions >= 0 # Don't invoke any + assert astats.copy_assignments == 2 + assert bstats.copy_assignments == 0 + assert astats.move_assignments == 0 + assert bstats.move_assignments == 0 + + +def test_importing(): + from pybind11_tests.modules import OD + from collections import OrderedDict + + assert OD is OrderedDict + assert str(OD([(1, 'a'), (2, 'b')])) == "OrderedDict([(1, 'a'), (2, 'b')])" + + +def test_pydoc(): + """Pydoc needs to be able to provide help() for everything inside a pybind11 module""" + import pybind11_tests + import pydoc + + assert pybind11_tests.__name__ == "pybind11_tests" + assert pybind11_tests.__doc__ == "pybind11 test module" + assert pydoc.text.docmodule(pybind11_tests) + + +def test_duplicate_registration(): + """Registering two things with the same name""" + + assert m.duplicate_registration() == [] diff --git a/plugins/python/pybind11/tests/test_multiple_inheritance.cpp b/plugins/python/pybind11/tests/test_multiple_inheritance.cpp new file mode 100644 index 0000000..35f9d9c --- /dev/null +++ b/plugins/python/pybind11/tests/test_multiple_inheritance.cpp @@ -0,0 +1,220 @@ +/* + tests/test_multiple_inheritance.cpp -- multiple inheritance, + implicit MI casts + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" + +// Many bases for testing that multiple inheritance from many classes (i.e. requiring extra +// space for holder constructed flags) works. +template struct BaseN { + BaseN(int i) : i(i) { } + int i; +}; + +// test_mi_static_properties +struct Vanilla { + std::string vanilla() { return "Vanilla"; }; +}; +struct WithStatic1 { + static std::string static_func1() { return "WithStatic1"; }; + static int static_value1; +}; +struct WithStatic2 { + static std::string static_func2() { return "WithStatic2"; }; + static int static_value2; +}; +struct VanillaStaticMix1 : Vanilla, WithStatic1, WithStatic2 { + static std::string static_func() { return "VanillaStaticMix1"; } + static int static_value; +}; +struct VanillaStaticMix2 : WithStatic1, Vanilla, WithStatic2 { + static std::string static_func() { return "VanillaStaticMix2"; } + static int static_value; +}; +int WithStatic1::static_value1 = 1; +int WithStatic2::static_value2 = 2; +int VanillaStaticMix1::static_value = 12; +int VanillaStaticMix2::static_value = 12; + +TEST_SUBMODULE(multiple_inheritance, m) { + + // test_multiple_inheritance_mix1 + // test_multiple_inheritance_mix2 + struct Base1 { + Base1(int i) : i(i) { } + int foo() { return i; } + int i; + }; + py::class_ b1(m, "Base1"); + b1.def(py::init()) + .def("foo", &Base1::foo); + + struct Base2 { + Base2(int i) : i(i) { } + int bar() { return i; } + int i; + }; + py::class_ b2(m, "Base2"); + b2.def(py::init()) + .def("bar", &Base2::bar); + + + // test_multiple_inheritance_cpp + struct Base12 : Base1, Base2 { + Base12(int i, int j) : Base1(i), Base2(j) { } + }; + struct MIType : Base12 { + MIType(int i, int j) : Base12(i, j) { } + }; + py::class_(m, "Base12"); + py::class_(m, "MIType") + .def(py::init()); + + + // test_multiple_inheritance_python_many_bases + #define PYBIND11_BASEN(N) py::class_>(m, "BaseN" #N).def(py::init()).def("f" #N, [](BaseN &b) { return b.i + N; }) + PYBIND11_BASEN( 1); PYBIND11_BASEN( 2); PYBIND11_BASEN( 3); PYBIND11_BASEN( 4); + PYBIND11_BASEN( 5); PYBIND11_BASEN( 6); PYBIND11_BASEN( 7); PYBIND11_BASEN( 8); + PYBIND11_BASEN( 9); PYBIND11_BASEN(10); PYBIND11_BASEN(11); PYBIND11_BASEN(12); + PYBIND11_BASEN(13); PYBIND11_BASEN(14); PYBIND11_BASEN(15); PYBIND11_BASEN(16); + PYBIND11_BASEN(17); + + // Uncommenting this should result in a compile time failure (MI can only be specified via + // template parameters because pybind has to know the types involved; see discussion in #742 for + // details). +// struct Base12v2 : Base1, Base2 { +// Base12v2(int i, int j) : Base1(i), Base2(j) { } +// }; +// py::class_(m, "Base12v2", b1, b2) +// .def(py::init()); + + + // test_multiple_inheritance_virtbase + // Test the case where not all base classes are specified, and where pybind11 requires the + // py::multiple_inheritance flag to perform proper casting between types. + struct Base1a { + Base1a(int i) : i(i) { } + int foo() { return i; } + int i; + }; + py::class_>(m, "Base1a") + .def(py::init()) + .def("foo", &Base1a::foo); + + struct Base2a { + Base2a(int i) : i(i) { } + int bar() { return i; } + int i; + }; + py::class_>(m, "Base2a") + .def(py::init()) + .def("bar", &Base2a::bar); + + struct Base12a : Base1a, Base2a { + Base12a(int i, int j) : Base1a(i), Base2a(j) { } + }; + py::class_>(m, "Base12a", py::multiple_inheritance()) + .def(py::init()); + + m.def("bar_base2a", [](Base2a *b) { return b->bar(); }); + m.def("bar_base2a_sharedptr", [](std::shared_ptr b) { return b->bar(); }); + + // test_mi_unaligned_base + // test_mi_base_return + // Issue #801: invalid casting to derived type with MI bases + struct I801B1 { int a = 1; virtual ~I801B1() = default; }; + struct I801B2 { int b = 2; virtual ~I801B2() = default; }; + struct I801C : I801B1, I801B2 {}; + struct I801D : I801C {}; // Indirect MI + // Unregistered classes: + struct I801B3 { int c = 3; virtual ~I801B3() = default; }; + struct I801E : I801B3, I801D {}; + + py::class_>(m, "I801B1").def(py::init<>()).def_readonly("a", &I801B1::a); + py::class_>(m, "I801B2").def(py::init<>()).def_readonly("b", &I801B2::b); + py::class_>(m, "I801C").def(py::init<>()); + py::class_>(m, "I801D").def(py::init<>()); + + // Two separate issues here: first, we want to recognize a pointer to a base type as being a + // known instance even when the pointer value is unequal (i.e. due to a non-first + // multiple-inheritance base class): + m.def("i801b1_c", [](I801C *c) { return static_cast(c); }); + m.def("i801b2_c", [](I801C *c) { return static_cast(c); }); + m.def("i801b1_d", [](I801D *d) { return static_cast(d); }); + m.def("i801b2_d", [](I801D *d) { return static_cast(d); }); + + // Second, when returned a base class pointer to a derived instance, we cannot assume that the + // pointer is `reinterpret_cast`able to the derived pointer because, like above, the base class + // pointer could be offset. + m.def("i801c_b1", []() -> I801B1 * { return new I801C(); }); + m.def("i801c_b2", []() -> I801B2 * { return new I801C(); }); + m.def("i801d_b1", []() -> I801B1 * { return new I801D(); }); + m.def("i801d_b2", []() -> I801B2 * { return new I801D(); }); + + // Return a base class pointer to a pybind-registered type when the actual derived type + // isn't pybind-registered (and uses multiple-inheritance to offset the pybind base) + m.def("i801e_c", []() -> I801C * { return new I801E(); }); + m.def("i801e_b2", []() -> I801B2 * { return new I801E(); }); + + + // test_mi_static_properties + py::class_(m, "Vanilla") + .def(py::init<>()) + .def("vanilla", &Vanilla::vanilla); + + py::class_(m, "WithStatic1") + .def(py::init<>()) + .def_static("static_func1", &WithStatic1::static_func1) + .def_readwrite_static("static_value1", &WithStatic1::static_value1); + + py::class_(m, "WithStatic2") + .def(py::init<>()) + .def_static("static_func2", &WithStatic2::static_func2) + .def_readwrite_static("static_value2", &WithStatic2::static_value2); + + py::class_( + m, "VanillaStaticMix1") + .def(py::init<>()) + .def_static("static_func", &VanillaStaticMix1::static_func) + .def_readwrite_static("static_value", &VanillaStaticMix1::static_value); + + py::class_( + m, "VanillaStaticMix2") + .def(py::init<>()) + .def_static("static_func", &VanillaStaticMix2::static_func) + .def_readwrite_static("static_value", &VanillaStaticMix2::static_value); + + +#if !defined(PYPY_VERSION) + struct WithDict { }; + struct VanillaDictMix1 : Vanilla, WithDict { }; + struct VanillaDictMix2 : WithDict, Vanilla { }; + py::class_(m, "WithDict", py::dynamic_attr()).def(py::init<>()); + py::class_(m, "VanillaDictMix1").def(py::init<>()); + py::class_(m, "VanillaDictMix2").def(py::init<>()); +#endif + + // test_diamond_inheritance + // Issue #959: segfault when constructing diamond inheritance instance + // All of these have int members so that there will be various unequal pointers involved. + struct B { int b; virtual ~B() = default; }; + struct C0 : public virtual B { int c0; }; + struct C1 : public virtual B { int c1; }; + struct D : public C0, public C1 { int d; }; + py::class_(m, "B") + .def("b", [](B *self) { return self; }); + py::class_(m, "C0") + .def("c0", [](C0 *self) { return self; }); + py::class_(m, "C1") + .def("c1", [](C1 *self) { return self; }); + py::class_(m, "D") + .def(py::init<>()); +} diff --git a/plugins/python/pybind11/tests/test_multiple_inheritance.py b/plugins/python/pybind11/tests/test_multiple_inheritance.py new file mode 100644 index 0000000..475dd3b --- /dev/null +++ b/plugins/python/pybind11/tests/test_multiple_inheritance.py @@ -0,0 +1,349 @@ +import pytest +from pybind11_tests import ConstructorStats +from pybind11_tests import multiple_inheritance as m + + +def test_multiple_inheritance_cpp(): + mt = m.MIType(3, 4) + + assert mt.foo() == 3 + assert mt.bar() == 4 + + +def test_multiple_inheritance_mix1(): + class Base1: + def __init__(self, i): + self.i = i + + def foo(self): + return self.i + + class MITypePy(Base1, m.Base2): + def __init__(self, i, j): + Base1.__init__(self, i) + m.Base2.__init__(self, j) + + mt = MITypePy(3, 4) + + assert mt.foo() == 3 + assert mt.bar() == 4 + + +def test_multiple_inheritance_mix2(): + + class Base2: + def __init__(self, i): + self.i = i + + def bar(self): + return self.i + + class MITypePy(m.Base1, Base2): + def __init__(self, i, j): + m.Base1.__init__(self, i) + Base2.__init__(self, j) + + mt = MITypePy(3, 4) + + assert mt.foo() == 3 + assert mt.bar() == 4 + + +def test_multiple_inheritance_python(): + + class MI1(m.Base1, m.Base2): + def __init__(self, i, j): + m.Base1.__init__(self, i) + m.Base2.__init__(self, j) + + class B1(object): + def v(self): + return 1 + + class MI2(B1, m.Base1, m.Base2): + def __init__(self, i, j): + B1.__init__(self) + m.Base1.__init__(self, i) + m.Base2.__init__(self, j) + + class MI3(MI2): + def __init__(self, i, j): + MI2.__init__(self, i, j) + + class MI4(MI3, m.Base2): + def __init__(self, i, j): + MI3.__init__(self, i, j) + # This should be ignored (Base2 is already initialized via MI2): + m.Base2.__init__(self, i + 100) + + class MI5(m.Base2, B1, m.Base1): + def __init__(self, i, j): + B1.__init__(self) + m.Base1.__init__(self, i) + m.Base2.__init__(self, j) + + class MI6(m.Base2, B1): + def __init__(self, i): + m.Base2.__init__(self, i) + B1.__init__(self) + + class B2(B1): + def v(self): + return 2 + + class B3(object): + def v(self): + return 3 + + class B4(B3, B2): + def v(self): + return 4 + + class MI7(B4, MI6): + def __init__(self, i): + B4.__init__(self) + MI6.__init__(self, i) + + class MI8(MI6, B3): + def __init__(self, i): + MI6.__init__(self, i) + B3.__init__(self) + + class MI8b(B3, MI6): + def __init__(self, i): + B3.__init__(self) + MI6.__init__(self, i) + + mi1 = MI1(1, 2) + assert mi1.foo() == 1 + assert mi1.bar() == 2 + + mi2 = MI2(3, 4) + assert mi2.v() == 1 + assert mi2.foo() == 3 + assert mi2.bar() == 4 + + mi3 = MI3(5, 6) + assert mi3.v() == 1 + assert mi3.foo() == 5 + assert mi3.bar() == 6 + + mi4 = MI4(7, 8) + assert mi4.v() == 1 + assert mi4.foo() == 7 + assert mi4.bar() == 8 + + mi5 = MI5(10, 11) + assert mi5.v() == 1 + assert mi5.foo() == 10 + assert mi5.bar() == 11 + + mi6 = MI6(12) + assert mi6.v() == 1 + assert mi6.bar() == 12 + + mi7 = MI7(13) + assert mi7.v() == 4 + assert mi7.bar() == 13 + + mi8 = MI8(14) + assert mi8.v() == 1 + assert mi8.bar() == 14 + + mi8b = MI8b(15) + assert mi8b.v() == 3 + assert mi8b.bar() == 15 + + +def test_multiple_inheritance_python_many_bases(): + + class MIMany14(m.BaseN1, m.BaseN2, m.BaseN3, m.BaseN4): + def __init__(self): + m.BaseN1.__init__(self, 1) + m.BaseN2.__init__(self, 2) + m.BaseN3.__init__(self, 3) + m.BaseN4.__init__(self, 4) + + class MIMany58(m.BaseN5, m.BaseN6, m.BaseN7, m.BaseN8): + def __init__(self): + m.BaseN5.__init__(self, 5) + m.BaseN6.__init__(self, 6) + m.BaseN7.__init__(self, 7) + m.BaseN8.__init__(self, 8) + + class MIMany916(m.BaseN9, m.BaseN10, m.BaseN11, m.BaseN12, m.BaseN13, m.BaseN14, m.BaseN15, + m.BaseN16): + def __init__(self): + m.BaseN9.__init__(self, 9) + m.BaseN10.__init__(self, 10) + m.BaseN11.__init__(self, 11) + m.BaseN12.__init__(self, 12) + m.BaseN13.__init__(self, 13) + m.BaseN14.__init__(self, 14) + m.BaseN15.__init__(self, 15) + m.BaseN16.__init__(self, 16) + + class MIMany19(MIMany14, MIMany58, m.BaseN9): + def __init__(self): + MIMany14.__init__(self) + MIMany58.__init__(self) + m.BaseN9.__init__(self, 9) + + class MIMany117(MIMany14, MIMany58, MIMany916, m.BaseN17): + def __init__(self): + MIMany14.__init__(self) + MIMany58.__init__(self) + MIMany916.__init__(self) + m.BaseN17.__init__(self, 17) + + # Inherits from 4 registered C++ classes: can fit in one pointer on any modern arch: + a = MIMany14() + for i in range(1, 4): + assert getattr(a, "f" + str(i))() == 2 * i + + # Inherits from 8: requires 1/2 pointers worth of holder flags on 32/64-bit arch: + b = MIMany916() + for i in range(9, 16): + assert getattr(b, "f" + str(i))() == 2 * i + + # Inherits from 9: requires >= 2 pointers worth of holder flags + c = MIMany19() + for i in range(1, 9): + assert getattr(c, "f" + str(i))() == 2 * i + + # Inherits from 17: requires >= 3 pointers worth of holder flags + d = MIMany117() + for i in range(1, 17): + assert getattr(d, "f" + str(i))() == 2 * i + + +def test_multiple_inheritance_virtbase(): + + class MITypePy(m.Base12a): + def __init__(self, i, j): + m.Base12a.__init__(self, i, j) + + mt = MITypePy(3, 4) + assert mt.bar() == 4 + assert m.bar_base2a(mt) == 4 + assert m.bar_base2a_sharedptr(mt) == 4 + + +def test_mi_static_properties(): + """Mixing bases with and without static properties should be possible + and the result should be independent of base definition order""" + + for d in (m.VanillaStaticMix1(), m.VanillaStaticMix2()): + assert d.vanilla() == "Vanilla" + assert d.static_func1() == "WithStatic1" + assert d.static_func2() == "WithStatic2" + assert d.static_func() == d.__class__.__name__ + + m.WithStatic1.static_value1 = 1 + m.WithStatic2.static_value2 = 2 + assert d.static_value1 == 1 + assert d.static_value2 == 2 + assert d.static_value == 12 + + d.static_value1 = 0 + assert d.static_value1 == 0 + d.static_value2 = 0 + assert d.static_value2 == 0 + d.static_value = 0 + assert d.static_value == 0 + + +@pytest.unsupported_on_pypy +def test_mi_dynamic_attributes(): + """Mixing bases with and without dynamic attribute support""" + + for d in (m.VanillaDictMix1(), m.VanillaDictMix2()): + d.dynamic = 1 + assert d.dynamic == 1 + + +def test_mi_unaligned_base(): + """Returning an offset (non-first MI) base class pointer should recognize the instance""" + + n_inst = ConstructorStats.detail_reg_inst() + + c = m.I801C() + d = m.I801D() + # + 4 below because we have the two instances, and each instance has offset base I801B2 + assert ConstructorStats.detail_reg_inst() == n_inst + 4 + b1c = m.i801b1_c(c) + assert b1c is c + b2c = m.i801b2_c(c) + assert b2c is c + b1d = m.i801b1_d(d) + assert b1d is d + b2d = m.i801b2_d(d) + assert b2d is d + + assert ConstructorStats.detail_reg_inst() == n_inst + 4 # no extra instances + del c, b1c, b2c + assert ConstructorStats.detail_reg_inst() == n_inst + 2 + del d, b1d, b2d + assert ConstructorStats.detail_reg_inst() == n_inst + + +def test_mi_base_return(): + """Tests returning an offset (non-first MI) base class pointer to a derived instance""" + + n_inst = ConstructorStats.detail_reg_inst() + + c1 = m.i801c_b1() + assert type(c1) is m.I801C + assert c1.a == 1 + assert c1.b == 2 + + d1 = m.i801d_b1() + assert type(d1) is m.I801D + assert d1.a == 1 + assert d1.b == 2 + + assert ConstructorStats.detail_reg_inst() == n_inst + 4 + + c2 = m.i801c_b2() + assert type(c2) is m.I801C + assert c2.a == 1 + assert c2.b == 2 + + d2 = m.i801d_b2() + assert type(d2) is m.I801D + assert d2.a == 1 + assert d2.b == 2 + + assert ConstructorStats.detail_reg_inst() == n_inst + 8 + + del c2 + assert ConstructorStats.detail_reg_inst() == n_inst + 6 + del c1, d1, d2 + assert ConstructorStats.detail_reg_inst() == n_inst + + # Returning an unregistered derived type with a registered base; we won't + # pick up the derived type, obviously, but should still work (as an object + # of whatever type was returned). + e1 = m.i801e_c() + assert type(e1) is m.I801C + assert e1.a == 1 + assert e1.b == 2 + + e2 = m.i801e_b2() + assert type(e2) is m.I801B2 + assert e2.b == 2 + + +def test_diamond_inheritance(): + """Tests that diamond inheritance works as expected (issue #959)""" + + # Issue #959: this shouldn't segfault: + d = m.D() + + # Make sure all the various distinct pointers are all recognized as registered instances: + assert d is d.c0() + assert d is d.c1() + assert d is d.b() + assert d is d.c0().b() + assert d is d.c1().b() + assert d is d.c0().c1().b().c0().b() diff --git a/plugins/python/pybind11/tests/test_numpy_array.cpp b/plugins/python/pybind11/tests/test_numpy_array.cpp new file mode 100644 index 0000000..79a157e --- /dev/null +++ b/plugins/python/pybind11/tests/test_numpy_array.cpp @@ -0,0 +1,298 @@ +/* + tests/test_numpy_array.cpp -- test core array functionality + + Copyright (c) 2016 Ivan Smirnov + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +#include +#include + +#include + +using arr = py::array; +using arr_t = py::array_t; +static_assert(std::is_same::value, ""); + +template arr data(const arr& a, Ix... index) { + return arr(a.nbytes() - a.offset_at(index...), (const uint8_t *) a.data(index...)); +} + +template arr data_t(const arr_t& a, Ix... index) { + return arr(a.size() - a.index_at(index...), a.data(index...)); +} + +template arr& mutate_data(arr& a, Ix... index) { + auto ptr = (uint8_t *) a.mutable_data(index...); + for (ssize_t i = 0; i < a.nbytes() - a.offset_at(index...); i++) + ptr[i] = (uint8_t) (ptr[i] * 2); + return a; +} + +template arr_t& mutate_data_t(arr_t& a, Ix... index) { + auto ptr = a.mutable_data(index...); + for (ssize_t i = 0; i < a.size() - a.index_at(index...); i++) + ptr[i]++; + return a; +} + +template ssize_t index_at(const arr& a, Ix... idx) { return a.index_at(idx...); } +template ssize_t index_at_t(const arr_t& a, Ix... idx) { return a.index_at(idx...); } +template ssize_t offset_at(const arr& a, Ix... idx) { return a.offset_at(idx...); } +template ssize_t offset_at_t(const arr_t& a, Ix... idx) { return a.offset_at(idx...); } +template ssize_t at_t(const arr_t& a, Ix... idx) { return a.at(idx...); } +template arr_t& mutate_at_t(arr_t& a, Ix... idx) { a.mutable_at(idx...)++; return a; } + +#define def_index_fn(name, type) \ + sm.def(#name, [](type a) { return name(a); }); \ + sm.def(#name, [](type a, int i) { return name(a, i); }); \ + sm.def(#name, [](type a, int i, int j) { return name(a, i, j); }); \ + sm.def(#name, [](type a, int i, int j, int k) { return name(a, i, j, k); }); + +template py::handle auxiliaries(T &&r, T2 &&r2) { + if (r.ndim() != 2) throw std::domain_error("error: ndim != 2"); + py::list l; + l.append(*r.data(0, 0)); + l.append(*r2.mutable_data(0, 0)); + l.append(r.data(0, 1) == r2.mutable_data(0, 1)); + l.append(r.ndim()); + l.append(r.itemsize()); + l.append(r.shape(0)); + l.append(r.shape(1)); + l.append(r.size()); + l.append(r.nbytes()); + return l.release(); +} + +TEST_SUBMODULE(numpy_array, sm) { + try { py::module::import("numpy"); } + catch (...) { return; } + + // test_array_attributes + sm.def("ndim", [](const arr& a) { return a.ndim(); }); + sm.def("shape", [](const arr& a) { return arr(a.ndim(), a.shape()); }); + sm.def("shape", [](const arr& a, ssize_t dim) { return a.shape(dim); }); + sm.def("strides", [](const arr& a) { return arr(a.ndim(), a.strides()); }); + sm.def("strides", [](const arr& a, ssize_t dim) { return a.strides(dim); }); + sm.def("writeable", [](const arr& a) { return a.writeable(); }); + sm.def("size", [](const arr& a) { return a.size(); }); + sm.def("itemsize", [](const arr& a) { return a.itemsize(); }); + sm.def("nbytes", [](const arr& a) { return a.nbytes(); }); + sm.def("owndata", [](const arr& a) { return a.owndata(); }); + + // test_index_offset + def_index_fn(index_at, const arr&); + def_index_fn(index_at_t, const arr_t&); + def_index_fn(offset_at, const arr&); + def_index_fn(offset_at_t, const arr_t&); + // test_data + def_index_fn(data, const arr&); + def_index_fn(data_t, const arr_t&); + // test_mutate_data, test_mutate_readonly + def_index_fn(mutate_data, arr&); + def_index_fn(mutate_data_t, arr_t&); + def_index_fn(at_t, const arr_t&); + def_index_fn(mutate_at_t, arr_t&); + + // test_make_c_f_array + sm.def("make_f_array", [] { return py::array_t({ 2, 2 }, { 4, 8 }); }); + sm.def("make_c_array", [] { return py::array_t({ 2, 2 }, { 8, 4 }); }); + + // test_empty_shaped_array + sm.def("make_empty_shaped_array", [] { return py::array(py::dtype("f"), {}, {}); }); + + // test_wrap + sm.def("wrap", [](py::array a) { + return py::array( + a.dtype(), + {a.shape(), a.shape() + a.ndim()}, + {a.strides(), a.strides() + a.ndim()}, + a.data(), + a + ); + }); + + // test_numpy_view + struct ArrayClass { + int data[2] = { 1, 2 }; + ArrayClass() { py::print("ArrayClass()"); } + ~ArrayClass() { py::print("~ArrayClass()"); } + }; + py::class_(sm, "ArrayClass") + .def(py::init<>()) + .def("numpy_view", [](py::object &obj) { + py::print("ArrayClass::numpy_view()"); + ArrayClass &a = obj.cast(); + return py::array_t({2}, {4}, a.data, obj); + } + ); + + // test_cast_numpy_int64_to_uint64 + sm.def("function_taking_uint64", [](uint64_t) { }); + + // test_isinstance + sm.def("isinstance_untyped", [](py::object yes, py::object no) { + return py::isinstance(yes) && !py::isinstance(no); + }); + sm.def("isinstance_typed", [](py::object o) { + return py::isinstance>(o) && !py::isinstance>(o); + }); + + // test_constructors + sm.def("default_constructors", []() { + return py::dict( + "array"_a=py::array(), + "array_t"_a=py::array_t(), + "array_t"_a=py::array_t() + ); + }); + sm.def("converting_constructors", [](py::object o) { + return py::dict( + "array"_a=py::array(o), + "array_t"_a=py::array_t(o), + "array_t"_a=py::array_t(o) + ); + }); + + // test_overload_resolution + sm.def("overloaded", [](py::array_t) { return "double"; }); + sm.def("overloaded", [](py::array_t) { return "float"; }); + sm.def("overloaded", [](py::array_t) { return "int"; }); + sm.def("overloaded", [](py::array_t) { return "unsigned short"; }); + sm.def("overloaded", [](py::array_t) { return "long long"; }); + sm.def("overloaded", [](py::array_t>) { return "double complex"; }); + sm.def("overloaded", [](py::array_t>) { return "float complex"; }); + + sm.def("overloaded2", [](py::array_t>) { return "double complex"; }); + sm.def("overloaded2", [](py::array_t) { return "double"; }); + sm.def("overloaded2", [](py::array_t>) { return "float complex"; }); + sm.def("overloaded2", [](py::array_t) { return "float"; }); + + // Only accept the exact types: + sm.def("overloaded3", [](py::array_t) { return "int"; }, py::arg().noconvert()); + sm.def("overloaded3", [](py::array_t) { return "double"; }, py::arg().noconvert()); + + // Make sure we don't do unsafe coercion (e.g. float to int) when not using forcecast, but + // rather that float gets converted via the safe (conversion to double) overload: + sm.def("overloaded4", [](py::array_t) { return "long long"; }); + sm.def("overloaded4", [](py::array_t) { return "double"; }); + + // But we do allow conversion to int if forcecast is enabled (but only if no overload matches + // without conversion) + sm.def("overloaded5", [](py::array_t) { return "unsigned int"; }); + sm.def("overloaded5", [](py::array_t) { return "double"; }); + + // test_greedy_string_overload + // Issue 685: ndarray shouldn't go to std::string overload + sm.def("issue685", [](std::string) { return "string"; }); + sm.def("issue685", [](py::array) { return "array"; }); + sm.def("issue685", [](py::object) { return "other"; }); + + // test_array_unchecked_fixed_dims + sm.def("proxy_add2", [](py::array_t a, double v) { + auto r = a.mutable_unchecked<2>(); + for (ssize_t i = 0; i < r.shape(0); i++) + for (ssize_t j = 0; j < r.shape(1); j++) + r(i, j) += v; + }, py::arg().noconvert(), py::arg()); + + sm.def("proxy_init3", [](double start) { + py::array_t a({ 3, 3, 3 }); + auto r = a.mutable_unchecked<3>(); + for (ssize_t i = 0; i < r.shape(0); i++) + for (ssize_t j = 0; j < r.shape(1); j++) + for (ssize_t k = 0; k < r.shape(2); k++) + r(i, j, k) = start++; + return a; + }); + sm.def("proxy_init3F", [](double start) { + py::array_t a({ 3, 3, 3 }); + auto r = a.mutable_unchecked<3>(); + for (ssize_t k = 0; k < r.shape(2); k++) + for (ssize_t j = 0; j < r.shape(1); j++) + for (ssize_t i = 0; i < r.shape(0); i++) + r(i, j, k) = start++; + return a; + }); + sm.def("proxy_squared_L2_norm", [](py::array_t a) { + auto r = a.unchecked<1>(); + double sumsq = 0; + for (ssize_t i = 0; i < r.shape(0); i++) + sumsq += r[i] * r(i); // Either notation works for a 1D array + return sumsq; + }); + + sm.def("proxy_auxiliaries2", [](py::array_t a) { + auto r = a.unchecked<2>(); + auto r2 = a.mutable_unchecked<2>(); + return auxiliaries(r, r2); + }); + + // test_array_unchecked_dyn_dims + // Same as the above, but without a compile-time dimensions specification: + sm.def("proxy_add2_dyn", [](py::array_t a, double v) { + auto r = a.mutable_unchecked(); + if (r.ndim() != 2) throw std::domain_error("error: ndim != 2"); + for (ssize_t i = 0; i < r.shape(0); i++) + for (ssize_t j = 0; j < r.shape(1); j++) + r(i, j) += v; + }, py::arg().noconvert(), py::arg()); + sm.def("proxy_init3_dyn", [](double start) { + py::array_t a({ 3, 3, 3 }); + auto r = a.mutable_unchecked(); + if (r.ndim() != 3) throw std::domain_error("error: ndim != 3"); + for (ssize_t i = 0; i < r.shape(0); i++) + for (ssize_t j = 0; j < r.shape(1); j++) + for (ssize_t k = 0; k < r.shape(2); k++) + r(i, j, k) = start++; + return a; + }); + sm.def("proxy_auxiliaries2_dyn", [](py::array_t a) { + return auxiliaries(a.unchecked(), a.mutable_unchecked()); + }); + + sm.def("array_auxiliaries2", [](py::array_t a) { + return auxiliaries(a, a); + }); + + // test_array_failures + // Issue #785: Uninformative "Unknown internal error" exception when constructing array from empty object: + sm.def("array_fail_test", []() { return py::array(py::object()); }); + sm.def("array_t_fail_test", []() { return py::array_t(py::object()); }); + // Make sure the error from numpy is being passed through: + sm.def("array_fail_test_negative_size", []() { int c = 0; return py::array(-1, &c); }); + + // test_initializer_list + // Issue (unnumbered; reported in #788): regression: initializer lists can be ambiguous + sm.def("array_initializer_list1", []() { return py::array_t(1); }); // { 1 } also works, but clang warns about it + sm.def("array_initializer_list2", []() { return py::array_t({ 1, 2 }); }); + sm.def("array_initializer_list3", []() { return py::array_t({ 1, 2, 3 }); }); + sm.def("array_initializer_list4", []() { return py::array_t({ 1, 2, 3, 4 }); }); + + // test_array_resize + // reshape array to 2D without changing size + sm.def("array_reshape2", [](py::array_t a) { + const ssize_t dim_sz = (ssize_t)std::sqrt(a.size()); + if (dim_sz * dim_sz != a.size()) + throw std::domain_error("array_reshape2: input array total size is not a squared integer"); + a.resize({dim_sz, dim_sz}); + }); + + // resize to 3D array with each dimension = N + sm.def("array_resize3", [](py::array_t a, size_t N, bool refcheck) { + a.resize({N, N, N}, refcheck); + }); + + // test_array_create_and_resize + // return 2D array with Nrows = Ncols = N + sm.def("create_and_resize", [](size_t N) { + py::array_t a; + a.resize({N, N}); + std::fill(a.mutable_data(), a.mutable_data() + a.size(), 42.); + return a; + }); +} diff --git a/plugins/python/pybind11/tests/test_numpy_array.py b/plugins/python/pybind11/tests/test_numpy_array.py new file mode 100644 index 0000000..1e83135 --- /dev/null +++ b/plugins/python/pybind11/tests/test_numpy_array.py @@ -0,0 +1,410 @@ +import pytest +from pybind11_tests import numpy_array as m + +pytestmark = pytest.requires_numpy + +with pytest.suppress(ImportError): + import numpy as np + + +@pytest.fixture(scope='function') +def arr(): + return np.array([[1, 2, 3], [4, 5, 6]], '=u2') + + +def test_array_attributes(): + a = np.array(0, 'f8') + assert m.ndim(a) == 0 + assert all(m.shape(a) == []) + assert all(m.strides(a) == []) + with pytest.raises(IndexError) as excinfo: + m.shape(a, 0) + assert str(excinfo.value) == 'invalid axis: 0 (ndim = 0)' + with pytest.raises(IndexError) as excinfo: + m.strides(a, 0) + assert str(excinfo.value) == 'invalid axis: 0 (ndim = 0)' + assert m.writeable(a) + assert m.size(a) == 1 + assert m.itemsize(a) == 8 + assert m.nbytes(a) == 8 + assert m.owndata(a) + + a = np.array([[1, 2, 3], [4, 5, 6]], 'u2').view() + a.flags.writeable = False + assert m.ndim(a) == 2 + assert all(m.shape(a) == [2, 3]) + assert m.shape(a, 0) == 2 + assert m.shape(a, 1) == 3 + assert all(m.strides(a) == [6, 2]) + assert m.strides(a, 0) == 6 + assert m.strides(a, 1) == 2 + with pytest.raises(IndexError) as excinfo: + m.shape(a, 2) + assert str(excinfo.value) == 'invalid axis: 2 (ndim = 2)' + with pytest.raises(IndexError) as excinfo: + m.strides(a, 2) + assert str(excinfo.value) == 'invalid axis: 2 (ndim = 2)' + assert not m.writeable(a) + assert m.size(a) == 6 + assert m.itemsize(a) == 2 + assert m.nbytes(a) == 12 + assert not m.owndata(a) + + +@pytest.mark.parametrize('args, ret', [([], 0), ([0], 0), ([1], 3), ([0, 1], 1), ([1, 2], 5)]) +def test_index_offset(arr, args, ret): + assert m.index_at(arr, *args) == ret + assert m.index_at_t(arr, *args) == ret + assert m.offset_at(arr, *args) == ret * arr.dtype.itemsize + assert m.offset_at_t(arr, *args) == ret * arr.dtype.itemsize + + +def test_dim_check_fail(arr): + for func in (m.index_at, m.index_at_t, m.offset_at, m.offset_at_t, m.data, m.data_t, + m.mutate_data, m.mutate_data_t): + with pytest.raises(IndexError) as excinfo: + func(arr, 1, 2, 3) + assert str(excinfo.value) == 'too many indices for an array: 3 (ndim = 2)' + + +@pytest.mark.parametrize('args, ret', + [([], [1, 2, 3, 4, 5, 6]), + ([1], [4, 5, 6]), + ([0, 1], [2, 3, 4, 5, 6]), + ([1, 2], [6])]) +def test_data(arr, args, ret): + from sys import byteorder + assert all(m.data_t(arr, *args) == ret) + assert all(m.data(arr, *args)[(0 if byteorder == 'little' else 1)::2] == ret) + assert all(m.data(arr, *args)[(1 if byteorder == 'little' else 0)::2] == 0) + + +@pytest.mark.parametrize('dim', [0, 1, 3]) +def test_at_fail(arr, dim): + for func in m.at_t, m.mutate_at_t: + with pytest.raises(IndexError) as excinfo: + func(arr, *([0] * dim)) + assert str(excinfo.value) == 'index dimension mismatch: {} (ndim = 2)'.format(dim) + + +def test_at(arr): + assert m.at_t(arr, 0, 2) == 3 + assert m.at_t(arr, 1, 0) == 4 + + assert all(m.mutate_at_t(arr, 0, 2).ravel() == [1, 2, 4, 4, 5, 6]) + assert all(m.mutate_at_t(arr, 1, 0).ravel() == [1, 2, 4, 5, 5, 6]) + + +def test_mutate_readonly(arr): + arr.flags.writeable = False + for func, args in (m.mutate_data, ()), (m.mutate_data_t, ()), (m.mutate_at_t, (0, 0)): + with pytest.raises(ValueError) as excinfo: + func(arr, *args) + assert str(excinfo.value) == 'array is not writeable' + + +def test_mutate_data(arr): + assert all(m.mutate_data(arr).ravel() == [2, 4, 6, 8, 10, 12]) + assert all(m.mutate_data(arr).ravel() == [4, 8, 12, 16, 20, 24]) + assert all(m.mutate_data(arr, 1).ravel() == [4, 8, 12, 32, 40, 48]) + assert all(m.mutate_data(arr, 0, 1).ravel() == [4, 16, 24, 64, 80, 96]) + assert all(m.mutate_data(arr, 1, 2).ravel() == [4, 16, 24, 64, 80, 192]) + + assert all(m.mutate_data_t(arr).ravel() == [5, 17, 25, 65, 81, 193]) + assert all(m.mutate_data_t(arr).ravel() == [6, 18, 26, 66, 82, 194]) + assert all(m.mutate_data_t(arr, 1).ravel() == [6, 18, 26, 67, 83, 195]) + assert all(m.mutate_data_t(arr, 0, 1).ravel() == [6, 19, 27, 68, 84, 196]) + assert all(m.mutate_data_t(arr, 1, 2).ravel() == [6, 19, 27, 68, 84, 197]) + + +def test_bounds_check(arr): + for func in (m.index_at, m.index_at_t, m.data, m.data_t, + m.mutate_data, m.mutate_data_t, m.at_t, m.mutate_at_t): + with pytest.raises(IndexError) as excinfo: + func(arr, 2, 0) + assert str(excinfo.value) == 'index 2 is out of bounds for axis 0 with size 2' + with pytest.raises(IndexError) as excinfo: + func(arr, 0, 4) + assert str(excinfo.value) == 'index 4 is out of bounds for axis 1 with size 3' + + +def test_make_c_f_array(): + assert m.make_c_array().flags.c_contiguous + assert not m.make_c_array().flags.f_contiguous + assert m.make_f_array().flags.f_contiguous + assert not m.make_f_array().flags.c_contiguous + + +def test_make_empty_shaped_array(): + m.make_empty_shaped_array() + + +def test_wrap(): + def assert_references(a, b, base=None): + from distutils.version import LooseVersion + if base is None: + base = a + assert a is not b + assert a.__array_interface__['data'][0] == b.__array_interface__['data'][0] + assert a.shape == b.shape + assert a.strides == b.strides + assert a.flags.c_contiguous == b.flags.c_contiguous + assert a.flags.f_contiguous == b.flags.f_contiguous + assert a.flags.writeable == b.flags.writeable + assert a.flags.aligned == b.flags.aligned + if LooseVersion(np.__version__) >= LooseVersion("1.14.0"): + assert a.flags.writebackifcopy == b.flags.writebackifcopy + else: + assert a.flags.updateifcopy == b.flags.updateifcopy + assert np.all(a == b) + assert not b.flags.owndata + assert b.base is base + if a.flags.writeable and a.ndim == 2: + a[0, 0] = 1234 + assert b[0, 0] == 1234 + + a1 = np.array([1, 2], dtype=np.int16) + assert a1.flags.owndata and a1.base is None + a2 = m.wrap(a1) + assert_references(a1, a2) + + a1 = np.array([[1, 2], [3, 4]], dtype=np.float32, order='F') + assert a1.flags.owndata and a1.base is None + a2 = m.wrap(a1) + assert_references(a1, a2) + + a1 = np.array([[1, 2], [3, 4]], dtype=np.float32, order='C') + a1.flags.writeable = False + a2 = m.wrap(a1) + assert_references(a1, a2) + + a1 = np.random.random((4, 4, 4)) + a2 = m.wrap(a1) + assert_references(a1, a2) + + a1t = a1.transpose() + a2 = m.wrap(a1t) + assert_references(a1t, a2, a1) + + a1d = a1.diagonal() + a2 = m.wrap(a1d) + assert_references(a1d, a2, a1) + + a1m = a1[::-1, ::-1, ::-1] + a2 = m.wrap(a1m) + assert_references(a1m, a2, a1) + + +def test_numpy_view(capture): + with capture: + ac = m.ArrayClass() + ac_view_1 = ac.numpy_view() + ac_view_2 = ac.numpy_view() + assert np.all(ac_view_1 == np.array([1, 2], dtype=np.int32)) + del ac + pytest.gc_collect() + assert capture == """ + ArrayClass() + ArrayClass::numpy_view() + ArrayClass::numpy_view() + """ + ac_view_1[0] = 4 + ac_view_1[1] = 3 + assert ac_view_2[0] == 4 + assert ac_view_2[1] == 3 + with capture: + del ac_view_1 + del ac_view_2 + pytest.gc_collect() + pytest.gc_collect() + assert capture == """ + ~ArrayClass() + """ + + +@pytest.unsupported_on_pypy +def test_cast_numpy_int64_to_uint64(): + m.function_taking_uint64(123) + m.function_taking_uint64(np.uint64(123)) + + +def test_isinstance(): + assert m.isinstance_untyped(np.array([1, 2, 3]), "not an array") + assert m.isinstance_typed(np.array([1.0, 2.0, 3.0])) + + +def test_constructors(): + defaults = m.default_constructors() + for a in defaults.values(): + assert a.size == 0 + assert defaults["array"].dtype == np.array([]).dtype + assert defaults["array_t"].dtype == np.int32 + assert defaults["array_t"].dtype == np.float64 + + results = m.converting_constructors([1, 2, 3]) + for a in results.values(): + np.testing.assert_array_equal(a, [1, 2, 3]) + assert results["array"].dtype == np.int_ + assert results["array_t"].dtype == np.int32 + assert results["array_t"].dtype == np.float64 + + +def test_overload_resolution(msg): + # Exact overload matches: + assert m.overloaded(np.array([1], dtype='float64')) == 'double' + assert m.overloaded(np.array([1], dtype='float32')) == 'float' + assert m.overloaded(np.array([1], dtype='ushort')) == 'unsigned short' + assert m.overloaded(np.array([1], dtype='intc')) == 'int' + assert m.overloaded(np.array([1], dtype='longlong')) == 'long long' + assert m.overloaded(np.array([1], dtype='complex')) == 'double complex' + assert m.overloaded(np.array([1], dtype='csingle')) == 'float complex' + + # No exact match, should call first convertible version: + assert m.overloaded(np.array([1], dtype='uint8')) == 'double' + + with pytest.raises(TypeError) as excinfo: + m.overloaded("not an array") + assert msg(excinfo.value) == """ + overloaded(): incompatible function arguments. The following argument types are supported: + 1. (arg0: numpy.ndarray[float64]) -> str + 2. (arg0: numpy.ndarray[float32]) -> str + 3. (arg0: numpy.ndarray[int32]) -> str + 4. (arg0: numpy.ndarray[uint16]) -> str + 5. (arg0: numpy.ndarray[int64]) -> str + 6. (arg0: numpy.ndarray[complex128]) -> str + 7. (arg0: numpy.ndarray[complex64]) -> str + + Invoked with: 'not an array' + """ + + assert m.overloaded2(np.array([1], dtype='float64')) == 'double' + assert m.overloaded2(np.array([1], dtype='float32')) == 'float' + assert m.overloaded2(np.array([1], dtype='complex64')) == 'float complex' + assert m.overloaded2(np.array([1], dtype='complex128')) == 'double complex' + assert m.overloaded2(np.array([1], dtype='float32')) == 'float' + + assert m.overloaded3(np.array([1], dtype='float64')) == 'double' + assert m.overloaded3(np.array([1], dtype='intc')) == 'int' + expected_exc = """ + overloaded3(): incompatible function arguments. The following argument types are supported: + 1. (arg0: numpy.ndarray[int32]) -> str + 2. (arg0: numpy.ndarray[float64]) -> str + + Invoked with: """ + + with pytest.raises(TypeError) as excinfo: + m.overloaded3(np.array([1], dtype='uintc')) + assert msg(excinfo.value) == expected_exc + repr(np.array([1], dtype='uint32')) + with pytest.raises(TypeError) as excinfo: + m.overloaded3(np.array([1], dtype='float32')) + assert msg(excinfo.value) == expected_exc + repr(np.array([1.], dtype='float32')) + with pytest.raises(TypeError) as excinfo: + m.overloaded3(np.array([1], dtype='complex')) + assert msg(excinfo.value) == expected_exc + repr(np.array([1. + 0.j])) + + # Exact matches: + assert m.overloaded4(np.array([1], dtype='double')) == 'double' + assert m.overloaded4(np.array([1], dtype='longlong')) == 'long long' + # Non-exact matches requiring conversion. Since float to integer isn't a + # save conversion, it should go to the double overload, but short can go to + # either (and so should end up on the first-registered, the long long). + assert m.overloaded4(np.array([1], dtype='float32')) == 'double' + assert m.overloaded4(np.array([1], dtype='short')) == 'long long' + + assert m.overloaded5(np.array([1], dtype='double')) == 'double' + assert m.overloaded5(np.array([1], dtype='uintc')) == 'unsigned int' + assert m.overloaded5(np.array([1], dtype='float32')) == 'unsigned int' + + +def test_greedy_string_overload(): + """Tests fix for #685 - ndarray shouldn't go to std::string overload""" + + assert m.issue685("abc") == "string" + assert m.issue685(np.array([97, 98, 99], dtype='b')) == "array" + assert m.issue685(123) == "other" + + +def test_array_unchecked_fixed_dims(msg): + z1 = np.array([[1, 2], [3, 4]], dtype='float64') + m.proxy_add2(z1, 10) + assert np.all(z1 == [[11, 12], [13, 14]]) + + with pytest.raises(ValueError) as excinfo: + m.proxy_add2(np.array([1., 2, 3]), 5.0) + assert msg(excinfo.value) == "array has incorrect number of dimensions: 1; expected 2" + + expect_c = np.ndarray(shape=(3, 3, 3), buffer=np.array(range(3, 30)), dtype='int') + assert np.all(m.proxy_init3(3.0) == expect_c) + expect_f = np.transpose(expect_c) + assert np.all(m.proxy_init3F(3.0) == expect_f) + + assert m.proxy_squared_L2_norm(np.array(range(6))) == 55 + assert m.proxy_squared_L2_norm(np.array(range(6), dtype="float64")) == 55 + + assert m.proxy_auxiliaries2(z1) == [11, 11, True, 2, 8, 2, 2, 4, 32] + assert m.proxy_auxiliaries2(z1) == m.array_auxiliaries2(z1) + + +def test_array_unchecked_dyn_dims(msg): + z1 = np.array([[1, 2], [3, 4]], dtype='float64') + m.proxy_add2_dyn(z1, 10) + assert np.all(z1 == [[11, 12], [13, 14]]) + + expect_c = np.ndarray(shape=(3, 3, 3), buffer=np.array(range(3, 30)), dtype='int') + assert np.all(m.proxy_init3_dyn(3.0) == expect_c) + + assert m.proxy_auxiliaries2_dyn(z1) == [11, 11, True, 2, 8, 2, 2, 4, 32] + assert m.proxy_auxiliaries2_dyn(z1) == m.array_auxiliaries2(z1) + + +def test_array_failure(): + with pytest.raises(ValueError) as excinfo: + m.array_fail_test() + assert str(excinfo.value) == 'cannot create a pybind11::array from a nullptr' + + with pytest.raises(ValueError) as excinfo: + m.array_t_fail_test() + assert str(excinfo.value) == 'cannot create a pybind11::array_t from a nullptr' + + with pytest.raises(ValueError) as excinfo: + m.array_fail_test_negative_size() + assert str(excinfo.value) == 'negative dimensions are not allowed' + + +def test_initializer_list(): + assert m.array_initializer_list1().shape == (1,) + assert m.array_initializer_list2().shape == (1, 2) + assert m.array_initializer_list3().shape == (1, 2, 3) + assert m.array_initializer_list4().shape == (1, 2, 3, 4) + + +def test_array_resize(msg): + a = np.array([1, 2, 3, 4, 5, 6, 7, 8, 9], dtype='float64') + m.array_reshape2(a) + assert(a.size == 9) + assert(np.all(a == [[1, 2, 3], [4, 5, 6], [7, 8, 9]])) + + # total size change should succced with refcheck off + m.array_resize3(a, 4, False) + assert(a.size == 64) + # ... and fail with refcheck on + try: + m.array_resize3(a, 3, True) + except ValueError as e: + assert(str(e).startswith("cannot resize an array")) + # transposed array doesn't own data + b = a.transpose() + try: + m.array_resize3(b, 3, False) + except ValueError as e: + assert(str(e).startswith("cannot resize this array: it does not own its data")) + # ... but reshape should be fine + m.array_reshape2(b) + assert(b.shape == (8, 8)) + + +@pytest.unsupported_on_pypy +def test_array_create_and_resize(msg): + a = m.create_and_resize(2) + assert(a.size == 4) + assert(np.all(a == 42.)) diff --git a/plugins/python/pybind11/tests/test_numpy_dtypes.cpp b/plugins/python/pybind11/tests/test_numpy_dtypes.cpp new file mode 100644 index 0000000..ddec851 --- /dev/null +++ b/plugins/python/pybind11/tests/test_numpy_dtypes.cpp @@ -0,0 +1,451 @@ +/* + tests/test_numpy_dtypes.cpp -- Structured and compound NumPy dtypes + + Copyright (c) 2016 Ivan Smirnov + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include + +#ifdef __GNUC__ +#define PYBIND11_PACKED(cls) cls __attribute__((__packed__)) +#else +#define PYBIND11_PACKED(cls) __pragma(pack(push, 1)) cls __pragma(pack(pop)) +#endif + +namespace py = pybind11; + +struct SimpleStruct { + bool bool_; + uint32_t uint_; + float float_; + long double ldbl_; +}; + +std::ostream& operator<<(std::ostream& os, const SimpleStruct& v) { + return os << "s:" << v.bool_ << "," << v.uint_ << "," << v.float_ << "," << v.ldbl_; +} + +PYBIND11_PACKED(struct PackedStruct { + bool bool_; + uint32_t uint_; + float float_; + long double ldbl_; +}); + +std::ostream& operator<<(std::ostream& os, const PackedStruct& v) { + return os << "p:" << v.bool_ << "," << v.uint_ << "," << v.float_ << "," << v.ldbl_; +} + +PYBIND11_PACKED(struct NestedStruct { + SimpleStruct a; + PackedStruct b; +}); + +std::ostream& operator<<(std::ostream& os, const NestedStruct& v) { + return os << "n:a=" << v.a << ";b=" << v.b; +} + +struct PartialStruct { + bool bool_; + uint32_t uint_; + float float_; + uint64_t dummy2; + long double ldbl_; +}; + +struct PartialNestedStruct { + uint64_t dummy1; + PartialStruct a; + uint64_t dummy2; +}; + +struct UnboundStruct { }; + +struct StringStruct { + char a[3]; + std::array b; +}; + +struct ComplexStruct { + std::complex cflt; + std::complex cdbl; +}; + +std::ostream& operator<<(std::ostream& os, const ComplexStruct& v) { + return os << "c:" << v.cflt << "," << v.cdbl; +} + +struct ArrayStruct { + char a[3][4]; + int32_t b[2]; + std::array c; + std::array d[4]; +}; + +PYBIND11_PACKED(struct StructWithUglyNames { + int8_t __x__; + uint64_t __y__; +}); + +enum class E1 : int64_t { A = -1, B = 1 }; +enum E2 : uint8_t { X = 1, Y = 2 }; + +PYBIND11_PACKED(struct EnumStruct { + E1 e1; + E2 e2; +}); + +std::ostream& operator<<(std::ostream& os, const StringStruct& v) { + os << "a='"; + for (size_t i = 0; i < 3 && v.a[i]; i++) os << v.a[i]; + os << "',b='"; + for (size_t i = 0; i < 3 && v.b[i]; i++) os << v.b[i]; + return os << "'"; +} + +std::ostream& operator<<(std::ostream& os, const ArrayStruct& v) { + os << "a={"; + for (int i = 0; i < 3; i++) { + if (i > 0) + os << ','; + os << '{'; + for (int j = 0; j < 3; j++) + os << v.a[i][j] << ','; + os << v.a[i][3] << '}'; + } + os << "},b={" << v.b[0] << ',' << v.b[1]; + os << "},c={" << int(v.c[0]) << ',' << int(v.c[1]) << ',' << int(v.c[2]); + os << "},d={"; + for (int i = 0; i < 4; i++) { + if (i > 0) + os << ','; + os << '{' << v.d[i][0] << ',' << v.d[i][1] << '}'; + } + return os << '}'; +} + +std::ostream& operator<<(std::ostream& os, const EnumStruct& v) { + return os << "e1=" << (v.e1 == E1::A ? "A" : "B") << ",e2=" << (v.e2 == E2::X ? "X" : "Y"); +} + +template +py::array mkarray_via_buffer(size_t n) { + return py::array(py::buffer_info(nullptr, sizeof(T), + py::format_descriptor::format(), + 1, { n }, { sizeof(T) })); +} + +#define SET_TEST_VALS(s, i) do { \ + s.bool_ = (i) % 2 != 0; \ + s.uint_ = (uint32_t) (i); \ + s.float_ = (float) (i) * 1.5f; \ + s.ldbl_ = (long double) (i) * -2.5L; } while (0) + +template +py::array_t create_recarray(size_t n) { + auto arr = mkarray_via_buffer(n); + auto req = arr.request(); + auto ptr = static_cast(req.ptr); + for (size_t i = 0; i < n; i++) { + SET_TEST_VALS(ptr[i], i); + } + return arr; +} + +template +py::list print_recarray(py::array_t arr) { + const auto req = arr.request(); + const auto ptr = static_cast(req.ptr); + auto l = py::list(); + for (ssize_t i = 0; i < req.size; i++) { + std::stringstream ss; + ss << ptr[i]; + l.append(py::str(ss.str())); + } + return l; +} + +py::array_t test_array_ctors(int i) { + using arr_t = py::array_t; + + std::vector data { 1, 2, 3, 4, 5, 6 }; + std::vector shape { 3, 2 }; + std::vector strides { 8, 4 }; + + auto ptr = data.data(); + auto vptr = (void *) ptr; + auto dtype = py::dtype("int32"); + + py::buffer_info buf_ndim1(vptr, 4, "i", 6); + py::buffer_info buf_ndim1_null(nullptr, 4, "i", 6); + py::buffer_info buf_ndim2(vptr, 4, "i", 2, shape, strides); + py::buffer_info buf_ndim2_null(nullptr, 4, "i", 2, shape, strides); + + auto fill = [](py::array arr) { + auto req = arr.request(); + for (int i = 0; i < 6; i++) ((int32_t *) req.ptr)[i] = i + 1; + return arr; + }; + + switch (i) { + // shape: (3, 2) + case 10: return arr_t(shape, strides, ptr); + case 11: return py::array(shape, strides, ptr); + case 12: return py::array(dtype, shape, strides, vptr); + case 13: return arr_t(shape, ptr); + case 14: return py::array(shape, ptr); + case 15: return py::array(dtype, shape, vptr); + case 16: return arr_t(buf_ndim2); + case 17: return py::array(buf_ndim2); + // shape: (3, 2) - post-fill + case 20: return fill(arr_t(shape, strides)); + case 21: return py::array(shape, strides, ptr); // can't have nullptr due to templated ctor + case 22: return fill(py::array(dtype, shape, strides)); + case 23: return fill(arr_t(shape)); + case 24: return py::array(shape, ptr); // can't have nullptr due to templated ctor + case 25: return fill(py::array(dtype, shape)); + case 26: return fill(arr_t(buf_ndim2_null)); + case 27: return fill(py::array(buf_ndim2_null)); + // shape: (6, ) + case 30: return arr_t(6, ptr); + case 31: return py::array(6, ptr); + case 32: return py::array(dtype, 6, vptr); + case 33: return arr_t(buf_ndim1); + case 34: return py::array(buf_ndim1); + // shape: (6, ) + case 40: return fill(arr_t(6)); + case 41: return py::array(6, ptr); // can't have nullptr due to templated ctor + case 42: return fill(py::array(dtype, 6)); + case 43: return fill(arr_t(buf_ndim1_null)); + case 44: return fill(py::array(buf_ndim1_null)); + } + return arr_t(); +} + +py::list test_dtype_ctors() { + py::list list; + list.append(py::dtype("int32")); + list.append(py::dtype(std::string("float64"))); + list.append(py::dtype::from_args(py::str("bool"))); + py::list names, offsets, formats; + py::dict dict; + names.append(py::str("a")); names.append(py::str("b")); dict["names"] = names; + offsets.append(py::int_(1)); offsets.append(py::int_(10)); dict["offsets"] = offsets; + formats.append(py::dtype("int32")); formats.append(py::dtype("float64")); dict["formats"] = formats; + dict["itemsize"] = py::int_(20); + list.append(py::dtype::from_args(dict)); + list.append(py::dtype(names, formats, offsets, 20)); + list.append(py::dtype(py::buffer_info((void *) 0, sizeof(unsigned int), "I", 1))); + list.append(py::dtype(py::buffer_info((void *) 0, 0, "T{i:a:f:b:}", 1))); + return list; +} + +TEST_SUBMODULE(numpy_dtypes, m) { + try { py::module::import("numpy"); } + catch (...) { return; } + + // typeinfo may be registered before the dtype descriptor for scalar casts to work... + py::class_(m, "SimpleStruct"); + + PYBIND11_NUMPY_DTYPE(SimpleStruct, bool_, uint_, float_, ldbl_); + PYBIND11_NUMPY_DTYPE(PackedStruct, bool_, uint_, float_, ldbl_); + PYBIND11_NUMPY_DTYPE(NestedStruct, a, b); + PYBIND11_NUMPY_DTYPE(PartialStruct, bool_, uint_, float_, ldbl_); + PYBIND11_NUMPY_DTYPE(PartialNestedStruct, a); + PYBIND11_NUMPY_DTYPE(StringStruct, a, b); + PYBIND11_NUMPY_DTYPE(ArrayStruct, a, b, c, d); + PYBIND11_NUMPY_DTYPE(EnumStruct, e1, e2); + PYBIND11_NUMPY_DTYPE(ComplexStruct, cflt, cdbl); + + // ... or after + py::class_(m, "PackedStruct"); + + PYBIND11_NUMPY_DTYPE_EX(StructWithUglyNames, __x__, "x", __y__, "y"); + + // If uncommented, this should produce a static_assert failure telling the user that the struct + // is not a POD type +// struct NotPOD { std::string v; NotPOD() : v("hi") {}; }; +// PYBIND11_NUMPY_DTYPE(NotPOD, v); + + // test_recarray, test_scalar_conversion + m.def("create_rec_simple", &create_recarray); + m.def("create_rec_packed", &create_recarray); + m.def("create_rec_nested", [](size_t n) { // test_signature + py::array_t arr = mkarray_via_buffer(n); + auto req = arr.request(); + auto ptr = static_cast(req.ptr); + for (size_t i = 0; i < n; i++) { + SET_TEST_VALS(ptr[i].a, i); + SET_TEST_VALS(ptr[i].b, i + 1); + } + return arr; + }); + m.def("create_rec_partial", &create_recarray); + m.def("create_rec_partial_nested", [](size_t n) { + py::array_t arr = mkarray_via_buffer(n); + auto req = arr.request(); + auto ptr = static_cast(req.ptr); + for (size_t i = 0; i < n; i++) { + SET_TEST_VALS(ptr[i].a, i); + } + return arr; + }); + m.def("print_rec_simple", &print_recarray); + m.def("print_rec_packed", &print_recarray); + m.def("print_rec_nested", &print_recarray); + + // test_format_descriptors + m.def("get_format_unbound", []() { return py::format_descriptor::format(); }); + m.def("print_format_descriptors", []() { + py::list l; + for (const auto &fmt : { + py::format_descriptor::format(), + py::format_descriptor::format(), + py::format_descriptor::format(), + py::format_descriptor::format(), + py::format_descriptor::format(), + py::format_descriptor::format(), + py::format_descriptor::format(), + py::format_descriptor::format(), + py::format_descriptor::format() + }) { + l.append(py::cast(fmt)); + } + return l; + }); + + // test_dtype + m.def("print_dtypes", []() { + py::list l; + for (const py::handle &d : { + py::dtype::of(), + py::dtype::of(), + py::dtype::of(), + py::dtype::of(), + py::dtype::of(), + py::dtype::of(), + py::dtype::of(), + py::dtype::of(), + py::dtype::of(), + py::dtype::of() + }) + l.append(py::str(d)); + return l; + }); + m.def("test_dtype_ctors", &test_dtype_ctors); + m.def("test_dtype_methods", []() { + py::list list; + auto dt1 = py::dtype::of(); + auto dt2 = py::dtype::of(); + list.append(dt1); list.append(dt2); + list.append(py::bool_(dt1.has_fields())); list.append(py::bool_(dt2.has_fields())); + list.append(py::int_(dt1.itemsize())); list.append(py::int_(dt2.itemsize())); + return list; + }); + struct TrailingPaddingStruct { + int32_t a; + char b; + }; + PYBIND11_NUMPY_DTYPE(TrailingPaddingStruct, a, b); + m.def("trailing_padding_dtype", []() { return py::dtype::of(); }); + + // test_string_array + m.def("create_string_array", [](bool non_empty) { + py::array_t arr = mkarray_via_buffer(non_empty ? 4 : 0); + if (non_empty) { + auto req = arr.request(); + auto ptr = static_cast(req.ptr); + for (ssize_t i = 0; i < req.size * req.itemsize; i++) + static_cast(req.ptr)[i] = 0; + ptr[1].a[0] = 'a'; ptr[1].b[0] = 'a'; + ptr[2].a[0] = 'a'; ptr[2].b[0] = 'a'; + ptr[3].a[0] = 'a'; ptr[3].b[0] = 'a'; + + ptr[2].a[1] = 'b'; ptr[2].b[1] = 'b'; + ptr[3].a[1] = 'b'; ptr[3].b[1] = 'b'; + + ptr[3].a[2] = 'c'; ptr[3].b[2] = 'c'; + } + return arr; + }); + m.def("print_string_array", &print_recarray); + + // test_array_array + m.def("create_array_array", [](size_t n) { + py::array_t arr = mkarray_via_buffer(n); + auto ptr = (ArrayStruct *) arr.mutable_data(); + for (size_t i = 0; i < n; i++) { + for (size_t j = 0; j < 3; j++) + for (size_t k = 0; k < 4; k++) + ptr[i].a[j][k] = char('A' + (i * 100 + j * 10 + k) % 26); + for (size_t j = 0; j < 2; j++) + ptr[i].b[j] = int32_t(i * 1000 + j); + for (size_t j = 0; j < 3; j++) + ptr[i].c[j] = uint8_t(i * 10 + j); + for (size_t j = 0; j < 4; j++) + for (size_t k = 0; k < 2; k++) + ptr[i].d[j][k] = float(i) * 100.0f + float(j) * 10.0f + float(k); + } + return arr; + }); + m.def("print_array_array", &print_recarray); + + // test_enum_array + m.def("create_enum_array", [](size_t n) { + py::array_t arr = mkarray_via_buffer(n); + auto ptr = (EnumStruct *) arr.mutable_data(); + for (size_t i = 0; i < n; i++) { + ptr[i].e1 = static_cast(-1 + ((int) i % 2) * 2); + ptr[i].e2 = static_cast(1 + (i % 2)); + } + return arr; + }); + m.def("print_enum_array", &print_recarray); + + // test_complex_array + m.def("create_complex_array", [](size_t n) { + py::array_t arr = mkarray_via_buffer(n); + auto ptr = (ComplexStruct *) arr.mutable_data(); + for (size_t i = 0; i < n; i++) { + ptr[i].cflt.real(float(i)); + ptr[i].cflt.imag(float(i) + 0.25f); + ptr[i].cdbl.real(double(i) + 0.5); + ptr[i].cdbl.imag(double(i) + 0.75); + } + return arr; + }); + m.def("print_complex_array", &print_recarray); + + // test_array_constructors + m.def("test_array_ctors", &test_array_ctors); + + // test_compare_buffer_info + struct CompareStruct { + bool x; + uint32_t y; + float z; + }; + PYBIND11_NUMPY_DTYPE(CompareStruct, x, y, z); + m.def("compare_buffer_info", []() { + py::list list; + list.append(py::bool_(py::detail::compare_buffer_info::compare(py::buffer_info(nullptr, sizeof(float), "f", 1)))); + list.append(py::bool_(py::detail::compare_buffer_info::compare(py::buffer_info(nullptr, sizeof(int), "I", 1)))); + list.append(py::bool_(py::detail::compare_buffer_info::compare(py::buffer_info(nullptr, sizeof(long), "l", 1)))); + list.append(py::bool_(py::detail::compare_buffer_info::compare(py::buffer_info(nullptr, sizeof(long), sizeof(long) == sizeof(int) ? "i" : "q", 1)))); + list.append(py::bool_(py::detail::compare_buffer_info::compare(py::buffer_info(nullptr, sizeof(CompareStruct), "T{?:x:3xI:y:f:z:}", 1)))); + return list; + }); + m.def("buffer_to_dtype", [](py::buffer& buf) { return py::dtype(buf.request()); }); + + // test_scalar_conversion + m.def("f_simple", [](SimpleStruct s) { return s.uint_ * 10; }); + m.def("f_packed", [](PackedStruct s) { return s.uint_ * 10; }); + m.def("f_nested", [](NestedStruct s) { return s.a.uint_ * 10; }); + + // test_register_dtype + m.def("register_dtype", []() { PYBIND11_NUMPY_DTYPE(SimpleStruct, bool_, uint_, float_, ldbl_); }); +} diff --git a/plugins/python/pybind11/tests/test_numpy_dtypes.py b/plugins/python/pybind11/tests/test_numpy_dtypes.py new file mode 100644 index 0000000..a4f49a9 --- /dev/null +++ b/plugins/python/pybind11/tests/test_numpy_dtypes.py @@ -0,0 +1,298 @@ +import re +import pytest +from pybind11_tests import numpy_dtypes as m + +pytestmark = pytest.requires_numpy + +with pytest.suppress(ImportError): + import numpy as np + + +@pytest.fixture(scope='module') +def simple_dtype(): + ld = np.dtype('longdouble') + return np.dtype({'names': ['bool_', 'uint_', 'float_', 'ldbl_'], + 'formats': ['?', 'u4', 'f4', 'f{}'.format(ld.itemsize)], + 'offsets': [0, 4, 8, (16 if ld.alignment > 4 else 12)]}) + + +@pytest.fixture(scope='module') +def packed_dtype(): + return np.dtype([('bool_', '?'), ('uint_', 'u4'), ('float_', 'f4'), ('ldbl_', 'g')]) + + +def dt_fmt(): + from sys import byteorder + e = '<' if byteorder == 'little' else '>' + return ("{{'names':['bool_','uint_','float_','ldbl_']," + " 'formats':['?','" + e + "u4','" + e + "f4','" + e + "f{}']," + " 'offsets':[0,4,8,{}], 'itemsize':{}}}") + + +def simple_dtype_fmt(): + ld = np.dtype('longdouble') + simple_ld_off = 12 + 4 * (ld.alignment > 4) + return dt_fmt().format(ld.itemsize, simple_ld_off, simple_ld_off + ld.itemsize) + + +def packed_dtype_fmt(): + from sys import byteorder + return "[('bool_', '?'), ('uint_', '{e}u4'), ('float_', '{e}f4'), ('ldbl_', '{e}f{}')]".format( + np.dtype('longdouble').itemsize, e='<' if byteorder == 'little' else '>') + + +def partial_ld_offset(): + return 12 + 4 * (np.dtype('uint64').alignment > 4) + 8 + 8 * ( + np.dtype('longdouble').alignment > 8) + + +def partial_dtype_fmt(): + ld = np.dtype('longdouble') + partial_ld_off = partial_ld_offset() + return dt_fmt().format(ld.itemsize, partial_ld_off, partial_ld_off + ld.itemsize) + + +def partial_nested_fmt(): + ld = np.dtype('longdouble') + partial_nested_off = 8 + 8 * (ld.alignment > 8) + partial_ld_off = partial_ld_offset() + partial_nested_size = partial_nested_off * 2 + partial_ld_off + ld.itemsize + return "{{'names':['a'], 'formats':[{}], 'offsets':[{}], 'itemsize':{}}}".format( + partial_dtype_fmt(), partial_nested_off, partial_nested_size) + + +def assert_equal(actual, expected_data, expected_dtype): + np.testing.assert_equal(actual, np.array(expected_data, dtype=expected_dtype)) + + +def test_format_descriptors(): + with pytest.raises(RuntimeError) as excinfo: + m.get_format_unbound() + assert re.match('^NumPy type info missing for .*UnboundStruct.*$', str(excinfo.value)) + + ld = np.dtype('longdouble') + ldbl_fmt = ('4x' if ld.alignment > 4 else '') + ld.char + ss_fmt = "^T{?:bool_:3xI:uint_:f:float_:" + ldbl_fmt + ":ldbl_:}" + dbl = np.dtype('double') + partial_fmt = ("^T{?:bool_:3xI:uint_:f:float_:" + + str(4 * (dbl.alignment > 4) + dbl.itemsize + 8 * (ld.alignment > 8)) + + "xg:ldbl_:}") + nested_extra = str(max(8, ld.alignment)) + assert m.print_format_descriptors() == [ + ss_fmt, + "^T{?:bool_:I:uint_:f:float_:g:ldbl_:}", + "^T{" + ss_fmt + ":a:^T{?:bool_:I:uint_:f:float_:g:ldbl_:}:b:}", + partial_fmt, + "^T{" + nested_extra + "x" + partial_fmt + ":a:" + nested_extra + "x}", + "^T{3s:a:3s:b:}", + "^T{(3)4s:a:(2)i:b:(3)B:c:1x(4, 2)f:d:}", + '^T{q:e1:B:e2:}', + '^T{Zf:cflt:Zd:cdbl:}' + ] + + +def test_dtype(simple_dtype): + from sys import byteorder + e = '<' if byteorder == 'little' else '>' + + assert m.print_dtypes() == [ + simple_dtype_fmt(), + packed_dtype_fmt(), + "[('a', {}), ('b', {})]".format(simple_dtype_fmt(), packed_dtype_fmt()), + partial_dtype_fmt(), + partial_nested_fmt(), + "[('a', 'S3'), ('b', 'S3')]", + ("{{'names':['a','b','c','d'], " + + "'formats':[('S4', (3,)),('" + e + "i4', (2,)),('u1', (3,)),('" + e + "f4', (4, 2))], " + + "'offsets':[0,12,20,24], 'itemsize':56}}").format(e=e), + "[('e1', '" + e + "i8'), ('e2', 'u1')]", + "[('x', 'i1'), ('y', '" + e + "u8')]", + "[('cflt', '" + e + "c8'), ('cdbl', '" + e + "c16')]" + ] + + d1 = np.dtype({'names': ['a', 'b'], 'formats': ['int32', 'float64'], + 'offsets': [1, 10], 'itemsize': 20}) + d2 = np.dtype([('a', 'i4'), ('b', 'f4')]) + assert m.test_dtype_ctors() == [np.dtype('int32'), np.dtype('float64'), + np.dtype('bool'), d1, d1, np.dtype('uint32'), d2] + + assert m.test_dtype_methods() == [np.dtype('int32'), simple_dtype, False, True, + np.dtype('int32').itemsize, simple_dtype.itemsize] + + assert m.trailing_padding_dtype() == m.buffer_to_dtype(np.zeros(1, m.trailing_padding_dtype())) + + +def test_recarray(simple_dtype, packed_dtype): + elements = [(False, 0, 0.0, -0.0), (True, 1, 1.5, -2.5), (False, 2, 3.0, -5.0)] + + for func, dtype in [(m.create_rec_simple, simple_dtype), (m.create_rec_packed, packed_dtype)]: + arr = func(0) + assert arr.dtype == dtype + assert_equal(arr, [], simple_dtype) + assert_equal(arr, [], packed_dtype) + + arr = func(3) + assert arr.dtype == dtype + assert_equal(arr, elements, simple_dtype) + assert_equal(arr, elements, packed_dtype) + + if dtype == simple_dtype: + assert m.print_rec_simple(arr) == [ + "s:0,0,0,-0", + "s:1,1,1.5,-2.5", + "s:0,2,3,-5" + ] + else: + assert m.print_rec_packed(arr) == [ + "p:0,0,0,-0", + "p:1,1,1.5,-2.5", + "p:0,2,3,-5" + ] + + nested_dtype = np.dtype([('a', simple_dtype), ('b', packed_dtype)]) + + arr = m.create_rec_nested(0) + assert arr.dtype == nested_dtype + assert_equal(arr, [], nested_dtype) + + arr = m.create_rec_nested(3) + assert arr.dtype == nested_dtype + assert_equal(arr, [((False, 0, 0.0, -0.0), (True, 1, 1.5, -2.5)), + ((True, 1, 1.5, -2.5), (False, 2, 3.0, -5.0)), + ((False, 2, 3.0, -5.0), (True, 3, 4.5, -7.5))], nested_dtype) + assert m.print_rec_nested(arr) == [ + "n:a=s:0,0,0,-0;b=p:1,1,1.5,-2.5", + "n:a=s:1,1,1.5,-2.5;b=p:0,2,3,-5", + "n:a=s:0,2,3,-5;b=p:1,3,4.5,-7.5" + ] + + arr = m.create_rec_partial(3) + assert str(arr.dtype) == partial_dtype_fmt() + partial_dtype = arr.dtype + assert '' not in arr.dtype.fields + assert partial_dtype.itemsize > simple_dtype.itemsize + assert_equal(arr, elements, simple_dtype) + assert_equal(arr, elements, packed_dtype) + + arr = m.create_rec_partial_nested(3) + assert str(arr.dtype) == partial_nested_fmt() + assert '' not in arr.dtype.fields + assert '' not in arr.dtype.fields['a'][0].fields + assert arr.dtype.itemsize > partial_dtype.itemsize + np.testing.assert_equal(arr['a'], m.create_rec_partial(3)) + + +def test_array_constructors(): + data = np.arange(1, 7, dtype='int32') + for i in range(8): + np.testing.assert_array_equal(m.test_array_ctors(10 + i), data.reshape((3, 2))) + np.testing.assert_array_equal(m.test_array_ctors(20 + i), data.reshape((3, 2))) + for i in range(5): + np.testing.assert_array_equal(m.test_array_ctors(30 + i), data) + np.testing.assert_array_equal(m.test_array_ctors(40 + i), data) + + +def test_string_array(): + arr = m.create_string_array(True) + assert str(arr.dtype) == "[('a', 'S3'), ('b', 'S3')]" + assert m.print_string_array(arr) == [ + "a='',b=''", + "a='a',b='a'", + "a='ab',b='ab'", + "a='abc',b='abc'" + ] + dtype = arr.dtype + assert arr['a'].tolist() == [b'', b'a', b'ab', b'abc'] + assert arr['b'].tolist() == [b'', b'a', b'ab', b'abc'] + arr = m.create_string_array(False) + assert dtype == arr.dtype + + +def test_array_array(): + from sys import byteorder + e = '<' if byteorder == 'little' else '>' + + arr = m.create_array_array(3) + assert str(arr.dtype) == ( + "{{'names':['a','b','c','d'], " + + "'formats':[('S4', (3,)),('" + e + "i4', (2,)),('u1', (3,)),('{e}f4', (4, 2))], " + + "'offsets':[0,12,20,24], 'itemsize':56}}").format(e=e) + assert m.print_array_array(arr) == [ + "a={{A,B,C,D},{K,L,M,N},{U,V,W,X}},b={0,1}," + + "c={0,1,2},d={{0,1},{10,11},{20,21},{30,31}}", + "a={{W,X,Y,Z},{G,H,I,J},{Q,R,S,T}},b={1000,1001}," + + "c={10,11,12},d={{100,101},{110,111},{120,121},{130,131}}", + "a={{S,T,U,V},{C,D,E,F},{M,N,O,P}},b={2000,2001}," + + "c={20,21,22},d={{200,201},{210,211},{220,221},{230,231}}", + ] + assert arr['a'].tolist() == [[b'ABCD', b'KLMN', b'UVWX'], + [b'WXYZ', b'GHIJ', b'QRST'], + [b'STUV', b'CDEF', b'MNOP']] + assert arr['b'].tolist() == [[0, 1], [1000, 1001], [2000, 2001]] + assert m.create_array_array(0).dtype == arr.dtype + + +def test_enum_array(): + from sys import byteorder + e = '<' if byteorder == 'little' else '>' + + arr = m.create_enum_array(3) + dtype = arr.dtype + assert dtype == np.dtype([('e1', e + 'i8'), ('e2', 'u1')]) + assert m.print_enum_array(arr) == [ + "e1=A,e2=X", + "e1=B,e2=Y", + "e1=A,e2=X" + ] + assert arr['e1'].tolist() == [-1, 1, -1] + assert arr['e2'].tolist() == [1, 2, 1] + assert m.create_enum_array(0).dtype == dtype + + +def test_complex_array(): + from sys import byteorder + e = '<' if byteorder == 'little' else '>' + + arr = m.create_complex_array(3) + dtype = arr.dtype + assert dtype == np.dtype([('cflt', e + 'c8'), ('cdbl', e + 'c16')]) + assert m.print_complex_array(arr) == [ + "c:(0,0.25),(0.5,0.75)", + "c:(1,1.25),(1.5,1.75)", + "c:(2,2.25),(2.5,2.75)" + ] + assert arr['cflt'].tolist() == [0.0 + 0.25j, 1.0 + 1.25j, 2.0 + 2.25j] + assert arr['cdbl'].tolist() == [0.5 + 0.75j, 1.5 + 1.75j, 2.5 + 2.75j] + assert m.create_complex_array(0).dtype == dtype + + +def test_signature(doc): + assert doc(m.create_rec_nested) == \ + "create_rec_nested(arg0: int) -> numpy.ndarray[NestedStruct]" + + +def test_scalar_conversion(): + n = 3 + arrays = [m.create_rec_simple(n), m.create_rec_packed(n), + m.create_rec_nested(n), m.create_enum_array(n)] + funcs = [m.f_simple, m.f_packed, m.f_nested] + + for i, func in enumerate(funcs): + for j, arr in enumerate(arrays): + if i == j and i < 2: + assert [func(arr[k]) for k in range(n)] == [k * 10 for k in range(n)] + else: + with pytest.raises(TypeError) as excinfo: + func(arr[0]) + assert 'incompatible function arguments' in str(excinfo.value) + + +def test_register_dtype(): + with pytest.raises(RuntimeError) as excinfo: + m.register_dtype() + assert 'dtype is already registered' in str(excinfo.value) + + +@pytest.requires_numpy +def test_compare_buffer_info(): + assert all(m.compare_buffer_info()) diff --git a/plugins/python/pybind11/tests/test_numpy_vectorize.cpp b/plugins/python/pybind11/tests/test_numpy_vectorize.cpp new file mode 100644 index 0000000..a875a74 --- /dev/null +++ b/plugins/python/pybind11/tests/test_numpy_vectorize.cpp @@ -0,0 +1,89 @@ +/* + tests/test_numpy_vectorize.cpp -- auto-vectorize functions over NumPy array + arguments + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include + +double my_func(int x, float y, double z) { + py::print("my_func(x:int={}, y:float={:.0f}, z:float={:.0f})"_s.format(x, y, z)); + return (float) x*y*z; +} + +TEST_SUBMODULE(numpy_vectorize, m) { + try { py::module::import("numpy"); } + catch (...) { return; } + + // test_vectorize, test_docs, test_array_collapse + // Vectorize all arguments of a function (though non-vector arguments are also allowed) + m.def("vectorized_func", py::vectorize(my_func)); + + // Vectorize a lambda function with a capture object (e.g. to exclude some arguments from the vectorization) + m.def("vectorized_func2", + [](py::array_t x, py::array_t y, float z) { + return py::vectorize([z](int x, float y) { return my_func(x, y, z); })(x, y); + } + ); + + // Vectorize a complex-valued function + m.def("vectorized_func3", py::vectorize( + [](std::complex c) { return c * std::complex(2.f); } + )); + + // test_type_selection + // Numpy function which only accepts specific data types + m.def("selective_func", [](py::array_t) { return "Int branch taken."; }); + m.def("selective_func", [](py::array_t) { return "Float branch taken."; }); + m.def("selective_func", [](py::array_t, py::array::c_style>) { return "Complex float branch taken."; }); + + + // test_passthrough_arguments + // Passthrough test: references and non-pod types should be automatically passed through (in the + // function definition below, only `b`, `d`, and `g` are vectorized): + struct NonPODClass { + NonPODClass(int v) : value{v} {} + int value; + }; + py::class_(m, "NonPODClass").def(py::init()); + m.def("vec_passthrough", py::vectorize( + [](double *a, double b, py::array_t c, const int &d, int &e, NonPODClass f, const double g) { + return *a + b + c.at(0) + d + e + f.value + g; + } + )); + + // test_method_vectorization + struct VectorizeTestClass { + VectorizeTestClass(int v) : value{v} {}; + float method(int x, float y) { return y + (float) (x + value); } + int value = 0; + }; + py::class_ vtc(m, "VectorizeTestClass"); + vtc .def(py::init()) + .def_readwrite("value", &VectorizeTestClass::value); + + // Automatic vectorizing of methods + vtc.def("method", py::vectorize(&VectorizeTestClass::method)); + + // test_trivial_broadcasting + // Internal optimization test for whether the input is trivially broadcastable: + py::enum_(m, "trivial") + .value("f_trivial", py::detail::broadcast_trivial::f_trivial) + .value("c_trivial", py::detail::broadcast_trivial::c_trivial) + .value("non_trivial", py::detail::broadcast_trivial::non_trivial); + m.def("vectorized_is_trivial", []( + py::array_t arg1, + py::array_t arg2, + py::array_t arg3 + ) { + ssize_t ndim; + std::vector shape; + std::array buffers {{ arg1.request(), arg2.request(), arg3.request() }}; + return py::detail::broadcast(buffers, ndim, shape); + }); +} diff --git a/plugins/python/pybind11/tests/test_numpy_vectorize.py b/plugins/python/pybind11/tests/test_numpy_vectorize.py new file mode 100644 index 0000000..0e9c883 --- /dev/null +++ b/plugins/python/pybind11/tests/test_numpy_vectorize.py @@ -0,0 +1,196 @@ +import pytest +from pybind11_tests import numpy_vectorize as m + +pytestmark = pytest.requires_numpy + +with pytest.suppress(ImportError): + import numpy as np + + +def test_vectorize(capture): + assert np.isclose(m.vectorized_func3(np.array(3 + 7j)), [6 + 14j]) + + for f in [m.vectorized_func, m.vectorized_func2]: + with capture: + assert np.isclose(f(1, 2, 3), 6) + assert capture == "my_func(x:int=1, y:float=2, z:float=3)" + with capture: + assert np.isclose(f(np.array(1), np.array(2), 3), 6) + assert capture == "my_func(x:int=1, y:float=2, z:float=3)" + with capture: + assert np.allclose(f(np.array([1, 3]), np.array([2, 4]), 3), [6, 36]) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=3) + my_func(x:int=3, y:float=4, z:float=3) + """ + with capture: + a = np.array([[1, 2], [3, 4]], order='F') + b = np.array([[10, 20], [30, 40]], order='F') + c = 3 + result = f(a, b, c) + assert np.allclose(result, a * b * c) + assert result.flags.f_contiguous + # All inputs are F order and full or singletons, so we the result is in col-major order: + assert capture == """ + my_func(x:int=1, y:float=10, z:float=3) + my_func(x:int=3, y:float=30, z:float=3) + my_func(x:int=2, y:float=20, z:float=3) + my_func(x:int=4, y:float=40, z:float=3) + """ + with capture: + a, b, c = np.array([[1, 3, 5], [7, 9, 11]]), np.array([[2, 4, 6], [8, 10, 12]]), 3 + assert np.allclose(f(a, b, c), a * b * c) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=3) + my_func(x:int=3, y:float=4, z:float=3) + my_func(x:int=5, y:float=6, z:float=3) + my_func(x:int=7, y:float=8, z:float=3) + my_func(x:int=9, y:float=10, z:float=3) + my_func(x:int=11, y:float=12, z:float=3) + """ + with capture: + a, b, c = np.array([[1, 2, 3], [4, 5, 6]]), np.array([2, 3, 4]), 2 + assert np.allclose(f(a, b, c), a * b * c) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=2) + my_func(x:int=2, y:float=3, z:float=2) + my_func(x:int=3, y:float=4, z:float=2) + my_func(x:int=4, y:float=2, z:float=2) + my_func(x:int=5, y:float=3, z:float=2) + my_func(x:int=6, y:float=4, z:float=2) + """ + with capture: + a, b, c = np.array([[1, 2, 3], [4, 5, 6]]), np.array([[2], [3]]), 2 + assert np.allclose(f(a, b, c), a * b * c) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=2) + my_func(x:int=2, y:float=2, z:float=2) + my_func(x:int=3, y:float=2, z:float=2) + my_func(x:int=4, y:float=3, z:float=2) + my_func(x:int=5, y:float=3, z:float=2) + my_func(x:int=6, y:float=3, z:float=2) + """ + with capture: + a, b, c = np.array([[1, 2, 3], [4, 5, 6]], order='F'), np.array([[2], [3]]), 2 + assert np.allclose(f(a, b, c), a * b * c) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=2) + my_func(x:int=2, y:float=2, z:float=2) + my_func(x:int=3, y:float=2, z:float=2) + my_func(x:int=4, y:float=3, z:float=2) + my_func(x:int=5, y:float=3, z:float=2) + my_func(x:int=6, y:float=3, z:float=2) + """ + with capture: + a, b, c = np.array([[1, 2, 3], [4, 5, 6]])[::, ::2], np.array([[2], [3]]), 2 + assert np.allclose(f(a, b, c), a * b * c) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=2) + my_func(x:int=3, y:float=2, z:float=2) + my_func(x:int=4, y:float=3, z:float=2) + my_func(x:int=6, y:float=3, z:float=2) + """ + with capture: + a, b, c = np.array([[1, 2, 3], [4, 5, 6]], order='F')[::, ::2], np.array([[2], [3]]), 2 + assert np.allclose(f(a, b, c), a * b * c) + assert capture == """ + my_func(x:int=1, y:float=2, z:float=2) + my_func(x:int=3, y:float=2, z:float=2) + my_func(x:int=4, y:float=3, z:float=2) + my_func(x:int=6, y:float=3, z:float=2) + """ + + +def test_type_selection(): + assert m.selective_func(np.array([1], dtype=np.int32)) == "Int branch taken." + assert m.selective_func(np.array([1.0], dtype=np.float32)) == "Float branch taken." + assert m.selective_func(np.array([1.0j], dtype=np.complex64)) == "Complex float branch taken." + + +def test_docs(doc): + assert doc(m.vectorized_func) == """ + vectorized_func(arg0: numpy.ndarray[int32], arg1: numpy.ndarray[float32], arg2: numpy.ndarray[float64]) -> object + """ # noqa: E501 line too long + + +def test_trivial_broadcasting(): + trivial, vectorized_is_trivial = m.trivial, m.vectorized_is_trivial + + assert vectorized_is_trivial(1, 2, 3) == trivial.c_trivial + assert vectorized_is_trivial(np.array(1), np.array(2), 3) == trivial.c_trivial + assert vectorized_is_trivial(np.array([1, 3]), np.array([2, 4]), 3) == trivial.c_trivial + assert trivial.c_trivial == vectorized_is_trivial( + np.array([[1, 3, 5], [7, 9, 11]]), np.array([[2, 4, 6], [8, 10, 12]]), 3) + assert vectorized_is_trivial( + np.array([[1, 2, 3], [4, 5, 6]]), np.array([2, 3, 4]), 2) == trivial.non_trivial + assert vectorized_is_trivial( + np.array([[1, 2, 3], [4, 5, 6]]), np.array([[2], [3]]), 2) == trivial.non_trivial + z1 = np.array([[1, 2, 3, 4], [5, 6, 7, 8]], dtype='int32') + z2 = np.array(z1, dtype='float32') + z3 = np.array(z1, dtype='float64') + assert vectorized_is_trivial(z1, z2, z3) == trivial.c_trivial + assert vectorized_is_trivial(1, z2, z3) == trivial.c_trivial + assert vectorized_is_trivial(z1, 1, z3) == trivial.c_trivial + assert vectorized_is_trivial(z1, z2, 1) == trivial.c_trivial + assert vectorized_is_trivial(z1[::2, ::2], 1, 1) == trivial.non_trivial + assert vectorized_is_trivial(1, 1, z1[::2, ::2]) == trivial.c_trivial + assert vectorized_is_trivial(1, 1, z3[::2, ::2]) == trivial.non_trivial + assert vectorized_is_trivial(z1, 1, z3[1::4, 1::4]) == trivial.c_trivial + + y1 = np.array(z1, order='F') + y2 = np.array(y1) + y3 = np.array(y1) + assert vectorized_is_trivial(y1, y2, y3) == trivial.f_trivial + assert vectorized_is_trivial(y1, 1, 1) == trivial.f_trivial + assert vectorized_is_trivial(1, y2, 1) == trivial.f_trivial + assert vectorized_is_trivial(1, 1, y3) == trivial.f_trivial + assert vectorized_is_trivial(y1, z2, 1) == trivial.non_trivial + assert vectorized_is_trivial(z1[1::4, 1::4], y2, 1) == trivial.f_trivial + assert vectorized_is_trivial(y1[1::4, 1::4], z2, 1) == trivial.c_trivial + + assert m.vectorized_func(z1, z2, z3).flags.c_contiguous + assert m.vectorized_func(y1, y2, y3).flags.f_contiguous + assert m.vectorized_func(z1, 1, 1).flags.c_contiguous + assert m.vectorized_func(1, y2, 1).flags.f_contiguous + assert m.vectorized_func(z1[1::4, 1::4], y2, 1).flags.f_contiguous + assert m.vectorized_func(y1[1::4, 1::4], z2, 1).flags.c_contiguous + + +def test_passthrough_arguments(doc): + assert doc(m.vec_passthrough) == ( + "vec_passthrough(" + ", ".join([ + "arg0: float", + "arg1: numpy.ndarray[float64]", + "arg2: numpy.ndarray[float64]", + "arg3: numpy.ndarray[int32]", + "arg4: int", + "arg5: m.numpy_vectorize.NonPODClass", + "arg6: numpy.ndarray[float64]"]) + ") -> object") + + b = np.array([[10, 20, 30]], dtype='float64') + c = np.array([100, 200]) # NOT a vectorized argument + d = np.array([[1000], [2000], [3000]], dtype='int') + g = np.array([[1000000, 2000000, 3000000]], dtype='int') # requires casting + assert np.all( + m.vec_passthrough(1, b, c, d, 10000, m.NonPODClass(100000), g) == + np.array([[1111111, 2111121, 3111131], + [1112111, 2112121, 3112131], + [1113111, 2113121, 3113131]])) + + +def test_method_vectorization(): + o = m.VectorizeTestClass(3) + x = np.array([1, 2], dtype='int') + y = np.array([[10], [20]], dtype='float32') + assert np.all(o.method(x, y) == [[14, 15], [24, 25]]) + + +def test_array_collapse(): + assert not isinstance(m.vectorized_func(1, 2, 3), np.ndarray) + assert not isinstance(m.vectorized_func(np.array(1), 2, 3), np.ndarray) + z = m.vectorized_func([1], 2, 3) + assert isinstance(z, np.ndarray) + assert z.shape == (1, ) + z = m.vectorized_func(1, [[[2]]], 3) + assert isinstance(z, np.ndarray) + assert z.shape == (1, 1, 1) diff --git a/plugins/python/pybind11/tests/test_opaque_types.cpp b/plugins/python/pybind11/tests/test_opaque_types.cpp new file mode 100644 index 0000000..5e83df0 --- /dev/null +++ b/plugins/python/pybind11/tests/test_opaque_types.cpp @@ -0,0 +1,63 @@ +/* + tests/test_opaque_types.cpp -- opaque types, passing void pointers + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include +#include + +using StringList = std::vector; + +/* IMPORTANT: Disable internal pybind11 translation mechanisms for STL data structures */ +PYBIND11_MAKE_OPAQUE(StringList); + +TEST_SUBMODULE(opaque_types, m) { + // test_string_list + py::class_(m, "StringList") + .def(py::init<>()) + .def("pop_back", &StringList::pop_back) + /* There are multiple versions of push_back(), etc. Select the right ones. */ + .def("push_back", (void (StringList::*)(const std::string &)) &StringList::push_back) + .def("back", (std::string &(StringList::*)()) &StringList::back) + .def("__len__", [](const StringList &v) { return v.size(); }) + .def("__iter__", [](StringList &v) { + return py::make_iterator(v.begin(), v.end()); + }, py::keep_alive<0, 1>()); + + class ClassWithSTLVecProperty { + public: + StringList stringList; + }; + py::class_(m, "ClassWithSTLVecProperty") + .def(py::init<>()) + .def_readwrite("stringList", &ClassWithSTLVecProperty::stringList); + + m.def("print_opaque_list", [](const StringList &l) { + std::string ret = "Opaque list: ["; + bool first = true; + for (auto entry : l) { + if (!first) + ret += ", "; + ret += entry; + first = false; + } + return ret + "]"; + }); + + // test_pointers + m.def("return_void_ptr", []() { return (void *) 0x1234; }); + m.def("get_void_ptr_value", [](void *ptr) { return reinterpret_cast(ptr); }); + m.def("return_null_str", []() { return (char *) nullptr; }); + m.def("get_null_str_value", [](char *ptr) { return reinterpret_cast(ptr); }); + + m.def("return_unique_ptr", []() -> std::unique_ptr { + StringList *result = new StringList(); + result->push_back("some value"); + return std::unique_ptr(result); + }); +} diff --git a/plugins/python/pybind11/tests/test_opaque_types.py b/plugins/python/pybind11/tests/test_opaque_types.py new file mode 100644 index 0000000..6b3802f --- /dev/null +++ b/plugins/python/pybind11/tests/test_opaque_types.py @@ -0,0 +1,46 @@ +import pytest +from pybind11_tests import opaque_types as m +from pybind11_tests import ConstructorStats, UserType + + +def test_string_list(): + lst = m.StringList() + lst.push_back("Element 1") + lst.push_back("Element 2") + assert m.print_opaque_list(lst) == "Opaque list: [Element 1, Element 2]" + assert lst.back() == "Element 2" + + for i, k in enumerate(lst, start=1): + assert k == "Element {}".format(i) + lst.pop_back() + assert m.print_opaque_list(lst) == "Opaque list: [Element 1]" + + cvp = m.ClassWithSTLVecProperty() + assert m.print_opaque_list(cvp.stringList) == "Opaque list: []" + + cvp.stringList = lst + cvp.stringList.push_back("Element 3") + assert m.print_opaque_list(cvp.stringList) == "Opaque list: [Element 1, Element 3]" + + +def test_pointers(msg): + living_before = ConstructorStats.get(UserType).alive() + assert m.get_void_ptr_value(m.return_void_ptr()) == 0x1234 + assert m.get_void_ptr_value(UserType()) # Should also work for other C++ types + assert ConstructorStats.get(UserType).alive() == living_before + + with pytest.raises(TypeError) as excinfo: + m.get_void_ptr_value([1, 2, 3]) # This should not work + assert msg(excinfo.value) == """ + get_void_ptr_value(): incompatible function arguments. The following argument types are supported: + 1. (arg0: capsule) -> int + + Invoked with: [1, 2, 3] + """ # noqa: E501 line too long + + assert m.return_null_str() is None + assert m.get_null_str_value(m.return_null_str()) is not None + + ptr = m.return_unique_ptr() + assert "StringList" in repr(ptr) + assert m.print_opaque_list(ptr) == "Opaque list: [some value]" diff --git a/plugins/python/pybind11/tests/test_operator_overloading.cpp b/plugins/python/pybind11/tests/test_operator_overloading.cpp new file mode 100644 index 0000000..4ad34d1 --- /dev/null +++ b/plugins/python/pybind11/tests/test_operator_overloading.cpp @@ -0,0 +1,146 @@ +/* + tests/test_operator_overloading.cpp -- operator overloading + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include +#include + +class Vector2 { +public: + Vector2(float x, float y) : x(x), y(y) { print_created(this, toString()); } + Vector2(const Vector2 &v) : x(v.x), y(v.y) { print_copy_created(this); } + Vector2(Vector2 &&v) : x(v.x), y(v.y) { print_move_created(this); v.x = v.y = 0; } + Vector2 &operator=(const Vector2 &v) { x = v.x; y = v.y; print_copy_assigned(this); return *this; } + Vector2 &operator=(Vector2 &&v) { x = v.x; y = v.y; v.x = v.y = 0; print_move_assigned(this); return *this; } + ~Vector2() { print_destroyed(this); } + + std::string toString() const { return "[" + std::to_string(x) + ", " + std::to_string(y) + "]"; } + + Vector2 operator+(const Vector2 &v) const { return Vector2(x + v.x, y + v.y); } + Vector2 operator-(const Vector2 &v) const { return Vector2(x - v.x, y - v.y); } + Vector2 operator-(float value) const { return Vector2(x - value, y - value); } + Vector2 operator+(float value) const { return Vector2(x + value, y + value); } + Vector2 operator*(float value) const { return Vector2(x * value, y * value); } + Vector2 operator/(float value) const { return Vector2(x / value, y / value); } + Vector2 operator*(const Vector2 &v) const { return Vector2(x * v.x, y * v.y); } + Vector2 operator/(const Vector2 &v) const { return Vector2(x / v.x, y / v.y); } + Vector2& operator+=(const Vector2 &v) { x += v.x; y += v.y; return *this; } + Vector2& operator-=(const Vector2 &v) { x -= v.x; y -= v.y; return *this; } + Vector2& operator*=(float v) { x *= v; y *= v; return *this; } + Vector2& operator/=(float v) { x /= v; y /= v; return *this; } + Vector2& operator*=(const Vector2 &v) { x *= v.x; y *= v.y; return *this; } + Vector2& operator/=(const Vector2 &v) { x /= v.x; y /= v.y; return *this; } + + friend Vector2 operator+(float f, const Vector2 &v) { return Vector2(f + v.x, f + v.y); } + friend Vector2 operator-(float f, const Vector2 &v) { return Vector2(f - v.x, f - v.y); } + friend Vector2 operator*(float f, const Vector2 &v) { return Vector2(f * v.x, f * v.y); } + friend Vector2 operator/(float f, const Vector2 &v) { return Vector2(f / v.x, f / v.y); } +private: + float x, y; +}; + +class C1 { }; +class C2 { }; + +int operator+(const C1 &, const C1 &) { return 11; } +int operator+(const C2 &, const C2 &) { return 22; } +int operator+(const C2 &, const C1 &) { return 21; } +int operator+(const C1 &, const C2 &) { return 12; } + +namespace std { + template<> + struct hash { + // Not a good hash function, but easy to test + size_t operator()(const Vector2 &) { return 4; } + }; +} + +TEST_SUBMODULE(operators, m) { + + // test_operator_overloading + py::class_(m, "Vector2") + .def(py::init()) + .def(py::self + py::self) + .def(py::self + float()) + .def(py::self - py::self) + .def(py::self - float()) + .def(py::self * float()) + .def(py::self / float()) + .def(py::self * py::self) + .def(py::self / py::self) + .def(py::self += py::self) + .def(py::self -= py::self) + .def(py::self *= float()) + .def(py::self /= float()) + .def(py::self *= py::self) + .def(py::self /= py::self) + .def(float() + py::self) + .def(float() - py::self) + .def(float() * py::self) + .def(float() / py::self) + .def("__str__", &Vector2::toString) + .def(hash(py::self)) + ; + + m.attr("Vector") = m.attr("Vector2"); + + // test_operators_notimplemented + // #393: need to return NotSupported to ensure correct arithmetic operator behavior + py::class_(m, "C1") + .def(py::init<>()) + .def(py::self + py::self); + + py::class_(m, "C2") + .def(py::init<>()) + .def(py::self + py::self) + .def("__add__", [](const C2& c2, const C1& c1) { return c2 + c1; }) + .def("__radd__", [](const C2& c2, const C1& c1) { return c1 + c2; }); + + // test_nested + // #328: first member in a class can't be used in operators + struct NestABase { int value = -2; }; + py::class_(m, "NestABase") + .def(py::init<>()) + .def_readwrite("value", &NestABase::value); + + struct NestA : NestABase { + int value = 3; + NestA& operator+=(int i) { value += i; return *this; } + }; + py::class_(m, "NestA") + .def(py::init<>()) + .def(py::self += int()) + .def("as_base", [](NestA &a) -> NestABase& { + return (NestABase&) a; + }, py::return_value_policy::reference_internal); + m.def("get_NestA", [](const NestA &a) { return a.value; }); + + struct NestB { + NestA a; + int value = 4; + NestB& operator-=(int i) { value -= i; return *this; } + }; + py::class_(m, "NestB") + .def(py::init<>()) + .def(py::self -= int()) + .def_readwrite("a", &NestB::a); + m.def("get_NestB", [](const NestB &b) { return b.value; }); + + struct NestC { + NestB b; + int value = 5; + NestC& operator*=(int i) { value *= i; return *this; } + }; + py::class_(m, "NestC") + .def(py::init<>()) + .def(py::self *= int()) + .def_readwrite("b", &NestC::b); + m.def("get_NestC", [](const NestC &c) { return c.value; }); +} diff --git a/plugins/python/pybind11/tests/test_operator_overloading.py b/plugins/python/pybind11/tests/test_operator_overloading.py new file mode 100644 index 0000000..86827d2 --- /dev/null +++ b/plugins/python/pybind11/tests/test_operator_overloading.py @@ -0,0 +1,106 @@ +import pytest +from pybind11_tests import operators as m +from pybind11_tests import ConstructorStats + + +def test_operator_overloading(): + v1 = m.Vector2(1, 2) + v2 = m.Vector(3, -1) + assert str(v1) == "[1.000000, 2.000000]" + assert str(v2) == "[3.000000, -1.000000]" + + assert str(v1 + v2) == "[4.000000, 1.000000]" + assert str(v1 - v2) == "[-2.000000, 3.000000]" + assert str(v1 - 8) == "[-7.000000, -6.000000]" + assert str(v1 + 8) == "[9.000000, 10.000000]" + assert str(v1 * 8) == "[8.000000, 16.000000]" + assert str(v1 / 8) == "[0.125000, 0.250000]" + assert str(8 - v1) == "[7.000000, 6.000000]" + assert str(8 + v1) == "[9.000000, 10.000000]" + assert str(8 * v1) == "[8.000000, 16.000000]" + assert str(8 / v1) == "[8.000000, 4.000000]" + assert str(v1 * v2) == "[3.000000, -2.000000]" + assert str(v2 / v1) == "[3.000000, -0.500000]" + + v1 += 2 * v2 + assert str(v1) == "[7.000000, 0.000000]" + v1 -= v2 + assert str(v1) == "[4.000000, 1.000000]" + v1 *= 2 + assert str(v1) == "[8.000000, 2.000000]" + v1 /= 16 + assert str(v1) == "[0.500000, 0.125000]" + v1 *= v2 + assert str(v1) == "[1.500000, -0.125000]" + v2 /= v1 + assert str(v2) == "[2.000000, 8.000000]" + + assert hash(v1) == 4 + + cstats = ConstructorStats.get(m.Vector2) + assert cstats.alive() == 2 + del v1 + assert cstats.alive() == 1 + del v2 + assert cstats.alive() == 0 + assert cstats.values() == ['[1.000000, 2.000000]', '[3.000000, -1.000000]', + '[4.000000, 1.000000]', '[-2.000000, 3.000000]', + '[-7.000000, -6.000000]', '[9.000000, 10.000000]', + '[8.000000, 16.000000]', '[0.125000, 0.250000]', + '[7.000000, 6.000000]', '[9.000000, 10.000000]', + '[8.000000, 16.000000]', '[8.000000, 4.000000]', + '[3.000000, -2.000000]', '[3.000000, -0.500000]', + '[6.000000, -2.000000]'] + assert cstats.default_constructions == 0 + assert cstats.copy_constructions == 0 + assert cstats.move_constructions >= 10 + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + +def test_operators_notimplemented(): + """#393: need to return NotSupported to ensure correct arithmetic operator behavior""" + + c1, c2 = m.C1(), m.C2() + assert c1 + c1 == 11 + assert c2 + c2 == 22 + assert c2 + c1 == 21 + assert c1 + c2 == 12 + + +def test_nested(): + """#328: first member in a class can't be used in operators""" + + a = m.NestA() + b = m.NestB() + c = m.NestC() + + a += 10 + assert m.get_NestA(a) == 13 + b.a += 100 + assert m.get_NestA(b.a) == 103 + c.b.a += 1000 + assert m.get_NestA(c.b.a) == 1003 + b -= 1 + assert m.get_NestB(b) == 3 + c.b -= 3 + assert m.get_NestB(c.b) == 1 + c *= 7 + assert m.get_NestC(c) == 35 + + abase = a.as_base() + assert abase.value == -2 + a.as_base().value += 44 + assert abase.value == 42 + assert c.b.a.as_base().value == -2 + c.b.a.as_base().value += 44 + assert c.b.a.as_base().value == 42 + + del c + pytest.gc_collect() + del a # Shouldn't delete while abase is still alive + pytest.gc_collect() + + assert abase.value == 42 + del abase, b + pytest.gc_collect() diff --git a/plugins/python/pybind11/tests/test_pickling.cpp b/plugins/python/pybind11/tests/test_pickling.cpp new file mode 100644 index 0000000..9dc63bd --- /dev/null +++ b/plugins/python/pybind11/tests/test_pickling.cpp @@ -0,0 +1,130 @@ +/* + tests/test_pickling.cpp -- pickle support + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +TEST_SUBMODULE(pickling, m) { + // test_roundtrip + class Pickleable { + public: + Pickleable(const std::string &value) : m_value(value) { } + const std::string &value() const { return m_value; } + + void setExtra1(int extra1) { m_extra1 = extra1; } + void setExtra2(int extra2) { m_extra2 = extra2; } + int extra1() const { return m_extra1; } + int extra2() const { return m_extra2; } + private: + std::string m_value; + int m_extra1 = 0; + int m_extra2 = 0; + }; + + class PickleableNew : public Pickleable { + public: + using Pickleable::Pickleable; + }; + + py::class_(m, "Pickleable") + .def(py::init()) + .def("value", &Pickleable::value) + .def("extra1", &Pickleable::extra1) + .def("extra2", &Pickleable::extra2) + .def("setExtra1", &Pickleable::setExtra1) + .def("setExtra2", &Pickleable::setExtra2) + // For details on the methods below, refer to + // http://docs.python.org/3/library/pickle.html#pickling-class-instances + .def("__getstate__", [](const Pickleable &p) { + /* Return a tuple that fully encodes the state of the object */ + return py::make_tuple(p.value(), p.extra1(), p.extra2()); + }) + .def("__setstate__", [](Pickleable &p, py::tuple t) { + if (t.size() != 3) + throw std::runtime_error("Invalid state!"); + /* Invoke the constructor (need to use in-place version) */ + new (&p) Pickleable(t[0].cast()); + + /* Assign any additional state */ + p.setExtra1(t[1].cast()); + p.setExtra2(t[2].cast()); + }); + + py::class_(m, "PickleableNew") + .def(py::init()) + .def(py::pickle( + [](const PickleableNew &p) { + return py::make_tuple(p.value(), p.extra1(), p.extra2()); + }, + [](py::tuple t) { + if (t.size() != 3) + throw std::runtime_error("Invalid state!"); + auto p = PickleableNew(t[0].cast()); + + p.setExtra1(t[1].cast()); + p.setExtra2(t[2].cast()); + return p; + } + )); + +#if !defined(PYPY_VERSION) + // test_roundtrip_with_dict + class PickleableWithDict { + public: + PickleableWithDict(const std::string &value) : value(value) { } + + std::string value; + int extra; + }; + + class PickleableWithDictNew : public PickleableWithDict { + public: + using PickleableWithDict::PickleableWithDict; + }; + + py::class_(m, "PickleableWithDict", py::dynamic_attr()) + .def(py::init()) + .def_readwrite("value", &PickleableWithDict::value) + .def_readwrite("extra", &PickleableWithDict::extra) + .def("__getstate__", [](py::object self) { + /* Also include __dict__ in state */ + return py::make_tuple(self.attr("value"), self.attr("extra"), self.attr("__dict__")); + }) + .def("__setstate__", [](py::object self, py::tuple t) { + if (t.size() != 3) + throw std::runtime_error("Invalid state!"); + /* Cast and construct */ + auto& p = self.cast(); + new (&p) PickleableWithDict(t[0].cast()); + + /* Assign C++ state */ + p.extra = t[1].cast(); + + /* Assign Python state */ + self.attr("__dict__") = t[2]; + }); + + py::class_(m, "PickleableWithDictNew") + .def(py::init()) + .def(py::pickle( + [](py::object self) { + return py::make_tuple(self.attr("value"), self.attr("extra"), self.attr("__dict__")); + }, + [](const py::tuple &t) { + if (t.size() != 3) + throw std::runtime_error("Invalid state!"); + + auto cpp_state = PickleableWithDictNew(t[0].cast()); + cpp_state.extra = t[1].cast(); + + auto py_state = t[2].cast(); + return std::make_pair(cpp_state, py_state); + } + )); +#endif +} diff --git a/plugins/python/pybind11/tests/test_pickling.py b/plugins/python/pybind11/tests/test_pickling.py new file mode 100644 index 0000000..707d347 --- /dev/null +++ b/plugins/python/pybind11/tests/test_pickling.py @@ -0,0 +1,36 @@ +import pytest +from pybind11_tests import pickling as m + +try: + import cPickle as pickle # Use cPickle on Python 2.7 +except ImportError: + import pickle + + +@pytest.mark.parametrize("cls_name", ["Pickleable", "PickleableNew"]) +def test_roundtrip(cls_name): + cls = getattr(m, cls_name) + p = cls("test_value") + p.setExtra1(15) + p.setExtra2(48) + + data = pickle.dumps(p, 2) # Must use pickle protocol >= 2 + p2 = pickle.loads(data) + assert p2.value() == p.value() + assert p2.extra1() == p.extra1() + assert p2.extra2() == p.extra2() + + +@pytest.unsupported_on_pypy +@pytest.mark.parametrize("cls_name", ["PickleableWithDict", "PickleableWithDictNew"]) +def test_roundtrip_with_dict(cls_name): + cls = getattr(m, cls_name) + p = cls("test_value") + p.extra = 15 + p.dynamic = "Attribute" + + data = pickle.dumps(p, pickle.HIGHEST_PROTOCOL) + p2 = pickle.loads(data) + assert p2.value == p.value + assert p2.extra == p.extra + assert p2.dynamic == p.dynamic diff --git a/plugins/python/pybind11/tests/test_pytypes.cpp b/plugins/python/pybind11/tests/test_pytypes.cpp new file mode 100644 index 0000000..a962f0c --- /dev/null +++ b/plugins/python/pybind11/tests/test_pytypes.cpp @@ -0,0 +1,272 @@ +/* + tests/test_pytypes.cpp -- Python type casters + + Copyright (c) 2017 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + + +TEST_SUBMODULE(pytypes, m) { + // test_list + m.def("get_list", []() { + py::list list; + list.append("value"); + py::print("Entry at position 0:", list[0]); + list[0] = py::str("overwritten"); + return list; + }); + m.def("print_list", [](py::list list) { + int index = 0; + for (auto item : list) + py::print("list item {}: {}"_s.format(index++, item)); + }); + + // test_set + m.def("get_set", []() { + py::set set; + set.add(py::str("key1")); + set.add("key2"); + set.add(std::string("key3")); + return set; + }); + m.def("print_set", [](py::set set) { + for (auto item : set) + py::print("key:", item); + }); + + // test_dict + m.def("get_dict", []() { return py::dict("key"_a="value"); }); + m.def("print_dict", [](py::dict dict) { + for (auto item : dict) + py::print("key: {}, value={}"_s.format(item.first, item.second)); + }); + m.def("dict_keyword_constructor", []() { + auto d1 = py::dict("x"_a=1, "y"_a=2); + auto d2 = py::dict("z"_a=3, **d1); + return d2; + }); + + // test_str + m.def("str_from_string", []() { return py::str(std::string("baz")); }); + m.def("str_from_bytes", []() { return py::str(py::bytes("boo", 3)); }); + m.def("str_from_object", [](const py::object& obj) { return py::str(obj); }); + m.def("repr_from_object", [](const py::object& obj) { return py::repr(obj); }); + + m.def("str_format", []() { + auto s1 = "{} + {} = {}"_s.format(1, 2, 3); + auto s2 = "{a} + {b} = {c}"_s.format("a"_a=1, "b"_a=2, "c"_a=3); + return py::make_tuple(s1, s2); + }); + + // test_bytes + m.def("bytes_from_string", []() { return py::bytes(std::string("foo")); }); + m.def("bytes_from_str", []() { return py::bytes(py::str("bar", 3)); }); + + // test_capsule + m.def("return_capsule_with_destructor", []() { + py::print("creating capsule"); + return py::capsule([]() { + py::print("destructing capsule"); + }); + }); + + m.def("return_capsule_with_destructor_2", []() { + py::print("creating capsule"); + return py::capsule((void *) 1234, [](void *ptr) { + py::print("destructing capsule: {}"_s.format((size_t) ptr)); + }); + }); + + m.def("return_capsule_with_name_and_destructor", []() { + auto capsule = py::capsule((void *) 1234, "pointer type description", [](PyObject *ptr) { + if (ptr) { + auto name = PyCapsule_GetName(ptr); + py::print("destructing capsule ({}, '{}')"_s.format( + (size_t) PyCapsule_GetPointer(ptr, name), name + )); + } + }); + void *contents = capsule; + py::print("created capsule ({}, '{}')"_s.format((size_t) contents, capsule.name())); + return capsule; + }); + + // test_accessors + m.def("accessor_api", [](py::object o) { + auto d = py::dict(); + + d["basic_attr"] = o.attr("basic_attr"); + + auto l = py::list(); + for (const auto &item : o.attr("begin_end")) { + l.append(item); + } + d["begin_end"] = l; + + d["operator[object]"] = o.attr("d")["operator[object]"_s]; + d["operator[char *]"] = o.attr("d")["operator[char *]"]; + + d["attr(object)"] = o.attr("sub").attr("attr_obj"); + d["attr(char *)"] = o.attr("sub").attr("attr_char"); + try { + o.attr("sub").attr("missing").ptr(); + } catch (const py::error_already_set &) { + d["missing_attr_ptr"] = "raised"_s; + } + try { + o.attr("missing").attr("doesn't matter"); + } catch (const py::error_already_set &) { + d["missing_attr_chain"] = "raised"_s; + } + + d["is_none"] = o.attr("basic_attr").is_none(); + + d["operator()"] = o.attr("func")(1); + d["operator*"] = o.attr("func")(*o.attr("begin_end")); + + // Test implicit conversion + py::list implicit_list = o.attr("begin_end"); + d["implicit_list"] = implicit_list; + py::dict implicit_dict = o.attr("__dict__"); + d["implicit_dict"] = implicit_dict; + + return d; + }); + + m.def("tuple_accessor", [](py::tuple existing_t) { + try { + existing_t[0] = 1; + } catch (const py::error_already_set &) { + // --> Python system error + // Only new tuples (refcount == 1) are mutable + auto new_t = py::tuple(3); + for (size_t i = 0; i < new_t.size(); ++i) { + new_t[i] = i; + } + return new_t; + } + return py::tuple(); + }); + + m.def("accessor_assignment", []() { + auto l = py::list(1); + l[0] = 0; + + auto d = py::dict(); + d["get"] = l[0]; + auto var = l[0]; + d["deferred_get"] = var; + l[0] = 1; + d["set"] = l[0]; + var = 99; // this assignment should not overwrite l[0] + d["deferred_set"] = l[0]; + d["var"] = var; + + return d; + }); + + // test_constructors + m.def("default_constructors", []() { + return py::dict( + "str"_a=py::str(), + "bool"_a=py::bool_(), + "int"_a=py::int_(), + "float"_a=py::float_(), + "tuple"_a=py::tuple(), + "list"_a=py::list(), + "dict"_a=py::dict(), + "set"_a=py::set() + ); + }); + + m.def("converting_constructors", [](py::dict d) { + return py::dict( + "str"_a=py::str(d["str"]), + "bool"_a=py::bool_(d["bool"]), + "int"_a=py::int_(d["int"]), + "float"_a=py::float_(d["float"]), + "tuple"_a=py::tuple(d["tuple"]), + "list"_a=py::list(d["list"]), + "dict"_a=py::dict(d["dict"]), + "set"_a=py::set(d["set"]), + "memoryview"_a=py::memoryview(d["memoryview"]) + ); + }); + + m.def("cast_functions", [](py::dict d) { + // When converting between Python types, obj.cast() should be the same as T(obj) + return py::dict( + "str"_a=d["str"].cast(), + "bool"_a=d["bool"].cast(), + "int"_a=d["int"].cast(), + "float"_a=d["float"].cast(), + "tuple"_a=d["tuple"].cast(), + "list"_a=d["list"].cast(), + "dict"_a=d["dict"].cast(), + "set"_a=d["set"].cast(), + "memoryview"_a=d["memoryview"].cast() + ); + }); + + m.def("get_implicit_casting", []() { + py::dict d; + d["char*_i1"] = "abc"; + const char *c2 = "abc"; + d["char*_i2"] = c2; + d["char*_e"] = py::cast(c2); + d["char*_p"] = py::str(c2); + + d["int_i1"] = 42; + int i = 42; + d["int_i2"] = i; + i++; + d["int_e"] = py::cast(i); + i++; + d["int_p"] = py::int_(i); + + d["str_i1"] = std::string("str"); + std::string s2("str1"); + d["str_i2"] = s2; + s2[3] = '2'; + d["str_e"] = py::cast(s2); + s2[3] = '3'; + d["str_p"] = py::str(s2); + + py::list l(2); + l[0] = 3; + l[1] = py::cast(6); + l.append(9); + l.append(py::cast(12)); + l.append(py::int_(15)); + + return py::dict( + "d"_a=d, + "l"_a=l + ); + }); + + // test_print + m.def("print_function", []() { + py::print("Hello, World!"); + py::print(1, 2.0, "three", true, std::string("-- multiple args")); + auto args = py::make_tuple("and", "a", "custom", "separator"); + py::print("*args", *args, "sep"_a="-"); + py::print("no new line here", "end"_a=" -- "); + py::print("next print"); + + auto py_stderr = py::module::import("sys").attr("stderr"); + py::print("this goes to stderr", "file"_a=py_stderr); + + py::print("flush", "flush"_a=true); + + py::print("{a} + {b} = {c}"_s.format("a"_a="py::print", "b"_a="str.format", "c"_a="this")); + }); + + m.def("print_failure", []() { py::print(42, UnregisteredType()); }); + + m.def("hash_function", [](py::object obj) { return py::hash(obj); }); +} diff --git a/plugins/python/pybind11/tests/test_pytypes.py b/plugins/python/pybind11/tests/test_pytypes.py new file mode 100644 index 0000000..992e7fc --- /dev/null +++ b/plugins/python/pybind11/tests/test_pytypes.py @@ -0,0 +1,240 @@ +import pytest +import sys + +from pybind11_tests import pytypes as m +from pybind11_tests import debug_enabled + + +def test_list(capture, doc): + with capture: + lst = m.get_list() + assert lst == ["overwritten"] + + lst.append("value2") + m.print_list(lst) + assert capture.unordered == """ + Entry at position 0: value + list item 0: overwritten + list item 1: value2 + """ + + assert doc(m.get_list) == "get_list() -> list" + assert doc(m.print_list) == "print_list(arg0: list) -> None" + + +def test_set(capture, doc): + s = m.get_set() + assert s == {"key1", "key2", "key3"} + + with capture: + s.add("key4") + m.print_set(s) + assert capture.unordered == """ + key: key1 + key: key2 + key: key3 + key: key4 + """ + + assert doc(m.get_list) == "get_list() -> list" + assert doc(m.print_list) == "print_list(arg0: list) -> None" + + +def test_dict(capture, doc): + d = m.get_dict() + assert d == {"key": "value"} + + with capture: + d["key2"] = "value2" + m.print_dict(d) + assert capture.unordered == """ + key: key, value=value + key: key2, value=value2 + """ + + assert doc(m.get_dict) == "get_dict() -> dict" + assert doc(m.print_dict) == "print_dict(arg0: dict) -> None" + + assert m.dict_keyword_constructor() == {"x": 1, "y": 2, "z": 3} + + +def test_str(doc): + assert m.str_from_string().encode().decode() == "baz" + assert m.str_from_bytes().encode().decode() == "boo" + + assert doc(m.str_from_bytes) == "str_from_bytes() -> str" + + class A(object): + def __str__(self): + return "this is a str" + + def __repr__(self): + return "this is a repr" + + assert m.str_from_object(A()) == "this is a str" + assert m.repr_from_object(A()) == "this is a repr" + + s1, s2 = m.str_format() + assert s1 == "1 + 2 = 3" + assert s1 == s2 + + +def test_bytes(doc): + assert m.bytes_from_string().decode() == "foo" + assert m.bytes_from_str().decode() == "bar" + + assert doc(m.bytes_from_str) == "bytes_from_str() -> {}".format( + "bytes" if sys.version_info[0] == 3 else "str" + ) + + +def test_capsule(capture): + pytest.gc_collect() + with capture: + a = m.return_capsule_with_destructor() + del a + pytest.gc_collect() + assert capture.unordered == """ + creating capsule + destructing capsule + """ + + with capture: + a = m.return_capsule_with_destructor_2() + del a + pytest.gc_collect() + assert capture.unordered == """ + creating capsule + destructing capsule: 1234 + """ + + with capture: + a = m.return_capsule_with_name_and_destructor() + del a + pytest.gc_collect() + assert capture.unordered == """ + created capsule (1234, 'pointer type description') + destructing capsule (1234, 'pointer type description') + """ + + +def test_accessors(): + class SubTestObject: + attr_obj = 1 + attr_char = 2 + + class TestObject: + basic_attr = 1 + begin_end = [1, 2, 3] + d = {"operator[object]": 1, "operator[char *]": 2} + sub = SubTestObject() + + def func(self, x, *args): + return self.basic_attr + x + sum(args) + + d = m.accessor_api(TestObject()) + assert d["basic_attr"] == 1 + assert d["begin_end"] == [1, 2, 3] + assert d["operator[object]"] == 1 + assert d["operator[char *]"] == 2 + assert d["attr(object)"] == 1 + assert d["attr(char *)"] == 2 + assert d["missing_attr_ptr"] == "raised" + assert d["missing_attr_chain"] == "raised" + assert d["is_none"] is False + assert d["operator()"] == 2 + assert d["operator*"] == 7 + assert d["implicit_list"] == [1, 2, 3] + assert all(x in TestObject.__dict__ for x in d["implicit_dict"]) + + assert m.tuple_accessor(tuple()) == (0, 1, 2) + + d = m.accessor_assignment() + assert d["get"] == 0 + assert d["deferred_get"] == 0 + assert d["set"] == 1 + assert d["deferred_set"] == 1 + assert d["var"] == 99 + + +def test_constructors(): + """C++ default and converting constructors are equivalent to type calls in Python""" + types = [str, bool, int, float, tuple, list, dict, set] + expected = {t.__name__: t() for t in types} + assert m.default_constructors() == expected + + data = { + str: 42, + bool: "Not empty", + int: "42", + float: "+1e3", + tuple: range(3), + list: range(3), + dict: [("two", 2), ("one", 1), ("three", 3)], + set: [4, 4, 5, 6, 6, 6], + memoryview: b'abc' + } + inputs = {k.__name__: v for k, v in data.items()} + expected = {k.__name__: k(v) for k, v in data.items()} + + assert m.converting_constructors(inputs) == expected + assert m.cast_functions(inputs) == expected + + # Converting constructors and cast functions should just reference rather + # than copy when no conversion is needed: + noconv1 = m.converting_constructors(expected) + for k in noconv1: + assert noconv1[k] is expected[k] + + noconv2 = m.cast_functions(expected) + for k in noconv2: + assert noconv2[k] is expected[k] + + +def test_implicit_casting(): + """Tests implicit casting when assigning or appending to dicts and lists.""" + z = m.get_implicit_casting() + assert z['d'] == { + 'char*_i1': 'abc', 'char*_i2': 'abc', 'char*_e': 'abc', 'char*_p': 'abc', + 'str_i1': 'str', 'str_i2': 'str1', 'str_e': 'str2', 'str_p': 'str3', + 'int_i1': 42, 'int_i2': 42, 'int_e': 43, 'int_p': 44 + } + assert z['l'] == [3, 6, 9, 12, 15] + + +def test_print(capture): + with capture: + m.print_function() + assert capture == """ + Hello, World! + 1 2.0 three True -- multiple args + *args-and-a-custom-separator + no new line here -- next print + flush + py::print + str.format = this + """ + assert capture.stderr == "this goes to stderr" + + with pytest.raises(RuntimeError) as excinfo: + m.print_failure() + assert str(excinfo.value) == "make_tuple(): unable to convert " + ( + "argument of type 'UnregisteredType' to Python object" + if debug_enabled else + "arguments to Python object (compile in debug mode for details)" + ) + + +def test_hash(): + class Hashable(object): + def __init__(self, value): + self.value = value + + def __hash__(self): + return self.value + + class Unhashable(object): + __hash__ = None + + assert m.hash_function(Hashable(42)) == 42 + with pytest.raises(TypeError): + m.hash_function(Unhashable()) diff --git a/plugins/python/pybind11/tests/test_sequences_and_iterators.cpp b/plugins/python/pybind11/tests/test_sequences_and_iterators.cpp new file mode 100644 index 0000000..a455212 --- /dev/null +++ b/plugins/python/pybind11/tests/test_sequences_and_iterators.cpp @@ -0,0 +1,334 @@ +/* + tests/test_sequences_and_iterators.cpp -- supporting Pythons' sequence protocol, iterators, + etc. + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include +#include + +template +class NonZeroIterator { + const T* ptr_; +public: + NonZeroIterator(const T* ptr) : ptr_(ptr) {} + const T& operator*() const { return *ptr_; } + NonZeroIterator& operator++() { ++ptr_; return *this; } +}; + +class NonZeroSentinel {}; + +template +bool operator==(const NonZeroIterator>& it, const NonZeroSentinel&) { + return !(*it).first || !(*it).second; +} + +template +py::list test_random_access_iterator(PythonType x) { + if (x.size() < 5) + throw py::value_error("Please provide at least 5 elements for testing."); + + auto checks = py::list(); + auto assert_equal = [&checks](py::handle a, py::handle b) { + auto result = PyObject_RichCompareBool(a.ptr(), b.ptr(), Py_EQ); + if (result == -1) { throw py::error_already_set(); } + checks.append(result != 0); + }; + + auto it = x.begin(); + assert_equal(x[0], *it); + assert_equal(x[0], it[0]); + assert_equal(x[1], it[1]); + + assert_equal(x[1], *(++it)); + assert_equal(x[1], *(it++)); + assert_equal(x[2], *it); + assert_equal(x[3], *(it += 1)); + assert_equal(x[2], *(--it)); + assert_equal(x[2], *(it--)); + assert_equal(x[1], *it); + assert_equal(x[0], *(it -= 1)); + + assert_equal(it->attr("real"), x[0].attr("real")); + assert_equal((it + 1)->attr("real"), x[1].attr("real")); + + assert_equal(x[1], *(it + 1)); + assert_equal(x[1], *(1 + it)); + it += 3; + assert_equal(x[1], *(it - 2)); + + checks.append(static_cast(x.end() - x.begin()) == x.size()); + checks.append((x.begin() + static_cast(x.size())) == x.end()); + checks.append(x.begin() < x.end()); + + return checks; +} + +TEST_SUBMODULE(sequences_and_iterators, m) { + + // test_sequence + class Sequence { + public: + Sequence(size_t size) : m_size(size) { + print_created(this, "of size", m_size); + m_data = new float[size]; + memset(m_data, 0, sizeof(float) * size); + } + Sequence(const std::vector &value) : m_size(value.size()) { + print_created(this, "of size", m_size, "from std::vector"); + m_data = new float[m_size]; + memcpy(m_data, &value[0], sizeof(float) * m_size); + } + Sequence(const Sequence &s) : m_size(s.m_size) { + print_copy_created(this); + m_data = new float[m_size]; + memcpy(m_data, s.m_data, sizeof(float)*m_size); + } + Sequence(Sequence &&s) : m_size(s.m_size), m_data(s.m_data) { + print_move_created(this); + s.m_size = 0; + s.m_data = nullptr; + } + + ~Sequence() { print_destroyed(this); delete[] m_data; } + + Sequence &operator=(const Sequence &s) { + if (&s != this) { + delete[] m_data; + m_size = s.m_size; + m_data = new float[m_size]; + memcpy(m_data, s.m_data, sizeof(float)*m_size); + } + print_copy_assigned(this); + return *this; + } + + Sequence &operator=(Sequence &&s) { + if (&s != this) { + delete[] m_data; + m_size = s.m_size; + m_data = s.m_data; + s.m_size = 0; + s.m_data = nullptr; + } + print_move_assigned(this); + return *this; + } + + bool operator==(const Sequence &s) const { + if (m_size != s.size()) return false; + for (size_t i = 0; i < m_size; ++i) + if (m_data[i] != s[i]) + return false; + return true; + } + bool operator!=(const Sequence &s) const { return !operator==(s); } + + float operator[](size_t index) const { return m_data[index]; } + float &operator[](size_t index) { return m_data[index]; } + + bool contains(float v) const { + for (size_t i = 0; i < m_size; ++i) + if (v == m_data[i]) + return true; + return false; + } + + Sequence reversed() const { + Sequence result(m_size); + for (size_t i = 0; i < m_size; ++i) + result[m_size - i - 1] = m_data[i]; + return result; + } + + size_t size() const { return m_size; } + + const float *begin() const { return m_data; } + const float *end() const { return m_data+m_size; } + + private: + size_t m_size; + float *m_data; + }; + py::class_(m, "Sequence") + .def(py::init()) + .def(py::init&>()) + /// Bare bones interface + .def("__getitem__", [](const Sequence &s, size_t i) { + if (i >= s.size()) throw py::index_error(); + return s[i]; + }) + .def("__setitem__", [](Sequence &s, size_t i, float v) { + if (i >= s.size()) throw py::index_error(); + s[i] = v; + }) + .def("__len__", &Sequence::size) + /// Optional sequence protocol operations + .def("__iter__", [](const Sequence &s) { return py::make_iterator(s.begin(), s.end()); }, + py::keep_alive<0, 1>() /* Essential: keep object alive while iterator exists */) + .def("__contains__", [](const Sequence &s, float v) { return s.contains(v); }) + .def("__reversed__", [](const Sequence &s) -> Sequence { return s.reversed(); }) + /// Slicing protocol (optional) + .def("__getitem__", [](const Sequence &s, py::slice slice) -> Sequence* { + size_t start, stop, step, slicelength; + if (!slice.compute(s.size(), &start, &stop, &step, &slicelength)) + throw py::error_already_set(); + Sequence *seq = new Sequence(slicelength); + for (size_t i = 0; i < slicelength; ++i) { + (*seq)[i] = s[start]; start += step; + } + return seq; + }) + .def("__setitem__", [](Sequence &s, py::slice slice, const Sequence &value) { + size_t start, stop, step, slicelength; + if (!slice.compute(s.size(), &start, &stop, &step, &slicelength)) + throw py::error_already_set(); + if (slicelength != value.size()) + throw std::runtime_error("Left and right hand size of slice assignment have different sizes!"); + for (size_t i = 0; i < slicelength; ++i) { + s[start] = value[i]; start += step; + } + }) + /// Comparisons + .def(py::self == py::self) + .def(py::self != py::self) + // Could also define py::self + py::self for concatenation, etc. + ; + + // test_map_iterator + // Interface of a map-like object that isn't (directly) an unordered_map, but provides some basic + // map-like functionality. + class StringMap { + public: + StringMap() = default; + StringMap(std::unordered_map init) + : map(std::move(init)) {} + + void set(std::string key, std::string val) { map[key] = val; } + std::string get(std::string key) const { return map.at(key); } + size_t size() const { return map.size(); } + private: + std::unordered_map map; + public: + decltype(map.cbegin()) begin() const { return map.cbegin(); } + decltype(map.cend()) end() const { return map.cend(); } + }; + py::class_(m, "StringMap") + .def(py::init<>()) + .def(py::init>()) + .def("__getitem__", [](const StringMap &map, std::string key) { + try { return map.get(key); } + catch (const std::out_of_range&) { + throw py::key_error("key '" + key + "' does not exist"); + } + }) + .def("__setitem__", &StringMap::set) + .def("__len__", &StringMap::size) + .def("__iter__", [](const StringMap &map) { return py::make_key_iterator(map.begin(), map.end()); }, + py::keep_alive<0, 1>()) + .def("items", [](const StringMap &map) { return py::make_iterator(map.begin(), map.end()); }, + py::keep_alive<0, 1>()) + ; + + // test_generalized_iterators + class IntPairs { + public: + IntPairs(std::vector> data) : data_(std::move(data)) {} + const std::pair* begin() const { return data_.data(); } + private: + std::vector> data_; + }; + py::class_(m, "IntPairs") + .def(py::init>>()) + .def("nonzero", [](const IntPairs& s) { + return py::make_iterator(NonZeroIterator>(s.begin()), NonZeroSentinel()); + }, py::keep_alive<0, 1>()) + .def("nonzero_keys", [](const IntPairs& s) { + return py::make_key_iterator(NonZeroIterator>(s.begin()), NonZeroSentinel()); + }, py::keep_alive<0, 1>()) + ; + + +#if 0 + // Obsolete: special data structure for exposing custom iterator types to python + // kept here for illustrative purposes because there might be some use cases which + // are not covered by the much simpler py::make_iterator + + struct PySequenceIterator { + PySequenceIterator(const Sequence &seq, py::object ref) : seq(seq), ref(ref) { } + + float next() { + if (index == seq.size()) + throw py::stop_iteration(); + return seq[index++]; + } + + const Sequence &seq; + py::object ref; // keep a reference + size_t index = 0; + }; + + py::class_(seq, "Iterator") + .def("__iter__", [](PySequenceIterator &it) -> PySequenceIterator& { return it; }) + .def("__next__", &PySequenceIterator::next); + + On the actual Sequence object, the iterator would be constructed as follows: + .def("__iter__", [](py::object s) { return PySequenceIterator(s.cast(), s); }) +#endif + + // test_python_iterator_in_cpp + m.def("object_to_list", [](py::object o) { + auto l = py::list(); + for (auto item : o) { + l.append(item); + } + return l; + }); + + m.def("iterator_to_list", [](py::iterator it) { + auto l = py::list(); + while (it != py::iterator::sentinel()) { + l.append(*it); + ++it; + } + return l; + }); + + // Make sure that py::iterator works with std algorithms + m.def("count_none", [](py::object o) { + return std::count_if(o.begin(), o.end(), [](py::handle h) { return h.is_none(); }); + }); + + m.def("find_none", [](py::object o) { + auto it = std::find_if(o.begin(), o.end(), [](py::handle h) { return h.is_none(); }); + return it->is_none(); + }); + + m.def("count_nonzeros", [](py::dict d) { + return std::count_if(d.begin(), d.end(), [](std::pair p) { + return p.second.cast() != 0; + }); + }); + + m.def("tuple_iterator", &test_random_access_iterator); + m.def("list_iterator", &test_random_access_iterator); + m.def("sequence_iterator", &test_random_access_iterator); + + // test_iterator_passthrough + // #181: iterator passthrough did not compile + m.def("iterator_passthrough", [](py::iterator s) -> py::iterator { + return py::make_iterator(std::begin(s), std::end(s)); + }); + + // test_iterator_rvp + // #388: Can't make iterators via make_iterator() with different r/v policies + static std::vector list = { 1, 2, 3 }; + m.def("make_iterator_1", []() { return py::make_iterator(list); }); + m.def("make_iterator_2", []() { return py::make_iterator(list); }); +} diff --git a/plugins/python/pybind11/tests/test_sequences_and_iterators.py b/plugins/python/pybind11/tests/test_sequences_and_iterators.py new file mode 100644 index 0000000..f6c0620 --- /dev/null +++ b/plugins/python/pybind11/tests/test_sequences_and_iterators.py @@ -0,0 +1,158 @@ +import pytest +from pybind11_tests import sequences_and_iterators as m +from pybind11_tests import ConstructorStats + + +def isclose(a, b, rel_tol=1e-05, abs_tol=0.0): + """Like math.isclose() from Python 3.5""" + return abs(a - b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol) + + +def allclose(a_list, b_list, rel_tol=1e-05, abs_tol=0.0): + return all(isclose(a, b, rel_tol=rel_tol, abs_tol=abs_tol) for a, b in zip(a_list, b_list)) + + +def test_generalized_iterators(): + assert list(m.IntPairs([(1, 2), (3, 4), (0, 5)]).nonzero()) == [(1, 2), (3, 4)] + assert list(m.IntPairs([(1, 2), (2, 0), (0, 3), (4, 5)]).nonzero()) == [(1, 2)] + assert list(m.IntPairs([(0, 3), (1, 2), (3, 4)]).nonzero()) == [] + + assert list(m.IntPairs([(1, 2), (3, 4), (0, 5)]).nonzero_keys()) == [1, 3] + assert list(m.IntPairs([(1, 2), (2, 0), (0, 3), (4, 5)]).nonzero_keys()) == [1] + assert list(m.IntPairs([(0, 3), (1, 2), (3, 4)]).nonzero_keys()) == [] + + # __next__ must continue to raise StopIteration + it = m.IntPairs([(0, 0)]).nonzero() + for _ in range(3): + with pytest.raises(StopIteration): + next(it) + + it = m.IntPairs([(0, 0)]).nonzero_keys() + for _ in range(3): + with pytest.raises(StopIteration): + next(it) + + +def test_sequence(): + cstats = ConstructorStats.get(m.Sequence) + + s = m.Sequence(5) + assert cstats.values() == ['of size', '5'] + + assert "Sequence" in repr(s) + assert len(s) == 5 + assert s[0] == 0 and s[3] == 0 + assert 12.34 not in s + s[0], s[3] = 12.34, 56.78 + assert 12.34 in s + assert isclose(s[0], 12.34) and isclose(s[3], 56.78) + + rev = reversed(s) + assert cstats.values() == ['of size', '5'] + + rev2 = s[::-1] + assert cstats.values() == ['of size', '5'] + + it = iter(m.Sequence(0)) + for _ in range(3): # __next__ must continue to raise StopIteration + with pytest.raises(StopIteration): + next(it) + assert cstats.values() == ['of size', '0'] + + expected = [0, 56.78, 0, 0, 12.34] + assert allclose(rev, expected) + assert allclose(rev2, expected) + assert rev == rev2 + + rev[0::2] = m.Sequence([2.0, 2.0, 2.0]) + assert cstats.values() == ['of size', '3', 'from std::vector'] + + assert allclose(rev, [2, 56.78, 2, 0, 2]) + + assert cstats.alive() == 4 + del it + assert cstats.alive() == 3 + del s + assert cstats.alive() == 2 + del rev + assert cstats.alive() == 1 + del rev2 + assert cstats.alive() == 0 + + assert cstats.values() == [] + assert cstats.default_constructions == 0 + assert cstats.copy_constructions == 0 + assert cstats.move_constructions >= 1 + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + +def test_map_iterator(): + sm = m.StringMap({'hi': 'bye', 'black': 'white'}) + assert sm['hi'] == 'bye' + assert len(sm) == 2 + assert sm['black'] == 'white' + + with pytest.raises(KeyError): + assert sm['orange'] + sm['orange'] = 'banana' + assert sm['orange'] == 'banana' + + expected = {'hi': 'bye', 'black': 'white', 'orange': 'banana'} + for k in sm: + assert sm[k] == expected[k] + for k, v in sm.items(): + assert v == expected[k] + + it = iter(m.StringMap({})) + for _ in range(3): # __next__ must continue to raise StopIteration + with pytest.raises(StopIteration): + next(it) + + +def test_python_iterator_in_cpp(): + t = (1, 2, 3) + assert m.object_to_list(t) == [1, 2, 3] + assert m.object_to_list(iter(t)) == [1, 2, 3] + assert m.iterator_to_list(iter(t)) == [1, 2, 3] + + with pytest.raises(TypeError) as excinfo: + m.object_to_list(1) + assert "object is not iterable" in str(excinfo.value) + + with pytest.raises(TypeError) as excinfo: + m.iterator_to_list(1) + assert "incompatible function arguments" in str(excinfo.value) + + def bad_next_call(): + raise RuntimeError("py::iterator::advance() should propagate errors") + + with pytest.raises(RuntimeError) as excinfo: + m.iterator_to_list(iter(bad_next_call, None)) + assert str(excinfo.value) == "py::iterator::advance() should propagate errors" + + lst = [1, None, 0, None] + assert m.count_none(lst) == 2 + assert m.find_none(lst) is True + assert m.count_nonzeros({"a": 0, "b": 1, "c": 2}) == 2 + + r = range(5) + assert all(m.tuple_iterator(tuple(r))) + assert all(m.list_iterator(list(r))) + assert all(m.sequence_iterator(r)) + + +def test_iterator_passthrough(): + """#181: iterator passthrough did not compile""" + from pybind11_tests.sequences_and_iterators import iterator_passthrough + + assert list(iterator_passthrough(iter([3, 5, 7, 9, 11, 13, 15]))) == [3, 5, 7, 9, 11, 13, 15] + + +def test_iterator_rvp(): + """#388: Can't make iterators via make_iterator() with different r/v policies """ + import pybind11_tests.sequences_and_iterators as m + + assert list(m.make_iterator_1()) == [1, 2, 3] + assert list(m.make_iterator_2()) == [1, 2, 3] + assert not isinstance(m.make_iterator_1(), type(m.make_iterator_2())) diff --git a/plugins/python/pybind11/tests/test_smart_ptr.cpp b/plugins/python/pybind11/tests/test_smart_ptr.cpp new file mode 100644 index 0000000..204e85f --- /dev/null +++ b/plugins/python/pybind11/tests/test_smart_ptr.cpp @@ -0,0 +1,334 @@ +/* + tests/test_smart_ptr.cpp -- binding classes with custom reference counting, + implicit conversions between types + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#if defined(_MSC_VER) && _MSC_VER < 1910 +# pragma warning(disable: 4702) // unreachable code in system header +#endif + +#include "pybind11_tests.h" +#include "object.h" + +// Make pybind aware of the ref-counted wrapper type (s): + +// ref is a wrapper for 'Object' which uses intrusive reference counting +// It is always possible to construct a ref from an Object* pointer without +// possible inconsistencies, hence the 'true' argument at the end. +PYBIND11_DECLARE_HOLDER_TYPE(T, ref, true); +// Make pybind11 aware of the non-standard getter member function +namespace pybind11 { namespace detail { + template + struct holder_helper> { + static const T *get(const ref &p) { return p.get_ptr(); } + }; +}} + +// The following is not required anymore for std::shared_ptr, but it should compile without error: +PYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr); + +// This is just a wrapper around unique_ptr, but with extra fields to deliberately bloat up the +// holder size to trigger the non-simple-layout internal instance layout for single inheritance with +// large holder type: +template class huge_unique_ptr { + std::unique_ptr ptr; + uint64_t padding[10]; +public: + huge_unique_ptr(T *p) : ptr(p) {}; + T *get() { return ptr.get(); } +}; +PYBIND11_DECLARE_HOLDER_TYPE(T, huge_unique_ptr); + +// Simple custom holder that works like unique_ptr +template +class custom_unique_ptr { + std::unique_ptr impl; +public: + custom_unique_ptr(T* p) : impl(p) { } + T* get() const { return impl.get(); } + T* release_ptr() { return impl.release(); } +}; +PYBIND11_DECLARE_HOLDER_TYPE(T, custom_unique_ptr); + +// Simple custom holder that works like shared_ptr and has operator& overload +// To obtain address of an instance of this holder pybind should use std::addressof +// Attempt to get address via operator& may leads to segmentation fault +template +class shared_ptr_with_addressof_operator { + std::shared_ptr impl; +public: + shared_ptr_with_addressof_operator( ) = default; + shared_ptr_with_addressof_operator(T* p) : impl(p) { } + T* get() const { return impl.get(); } + T** operator&() { throw std::logic_error("Call of overloaded operator& is not expected"); } +}; +PYBIND11_DECLARE_HOLDER_TYPE(T, shared_ptr_with_addressof_operator); + +// Simple custom holder that works like unique_ptr and has operator& overload +// To obtain address of an instance of this holder pybind should use std::addressof +// Attempt to get address via operator& may leads to segmentation fault +template +class unique_ptr_with_addressof_operator { + std::unique_ptr impl; +public: + unique_ptr_with_addressof_operator() = default; + unique_ptr_with_addressof_operator(T* p) : impl(p) { } + T* get() const { return impl.get(); } + T* release_ptr() { return impl.release(); } + T** operator&() { throw std::logic_error("Call of overloaded operator& is not expected"); } +}; +PYBIND11_DECLARE_HOLDER_TYPE(T, unique_ptr_with_addressof_operator); + + +TEST_SUBMODULE(smart_ptr, m) { + + // test_smart_ptr + + // Object implementation in `object.h` + py::class_> obj(m, "Object"); + obj.def("getRefCount", &Object::getRefCount); + + // Custom object with builtin reference counting (see 'object.h' for the implementation) + class MyObject1 : public Object { + public: + MyObject1(int value) : value(value) { print_created(this, toString()); } + std::string toString() const { return "MyObject1[" + std::to_string(value) + "]"; } + protected: + virtual ~MyObject1() { print_destroyed(this); } + private: + int value; + }; + py::class_>(m, "MyObject1", obj) + .def(py::init()); + py::implicitly_convertible(); + + m.def("make_object_1", []() -> Object * { return new MyObject1(1); }); + m.def("make_object_2", []() -> ref { return new MyObject1(2); }); + m.def("make_myobject1_1", []() -> MyObject1 * { return new MyObject1(4); }); + m.def("make_myobject1_2", []() -> ref { return new MyObject1(5); }); + m.def("print_object_1", [](const Object *obj) { py::print(obj->toString()); }); + m.def("print_object_2", [](ref obj) { py::print(obj->toString()); }); + m.def("print_object_3", [](const ref &obj) { py::print(obj->toString()); }); + m.def("print_object_4", [](const ref *obj) { py::print((*obj)->toString()); }); + m.def("print_myobject1_1", [](const MyObject1 *obj) { py::print(obj->toString()); }); + m.def("print_myobject1_2", [](ref obj) { py::print(obj->toString()); }); + m.def("print_myobject1_3", [](const ref &obj) { py::print(obj->toString()); }); + m.def("print_myobject1_4", [](const ref *obj) { py::print((*obj)->toString()); }); + + // Expose constructor stats for the ref type + m.def("cstats_ref", &ConstructorStats::get); + + + // Object managed by a std::shared_ptr<> + class MyObject2 { + public: + MyObject2(int value) : value(value) { print_created(this, toString()); } + std::string toString() const { return "MyObject2[" + std::to_string(value) + "]"; } + virtual ~MyObject2() { print_destroyed(this); } + private: + int value; + }; + py::class_>(m, "MyObject2") + .def(py::init()); + m.def("make_myobject2_1", []() { return new MyObject2(6); }); + m.def("make_myobject2_2", []() { return std::make_shared(7); }); + m.def("print_myobject2_1", [](const MyObject2 *obj) { py::print(obj->toString()); }); + m.def("print_myobject2_2", [](std::shared_ptr obj) { py::print(obj->toString()); }); + m.def("print_myobject2_3", [](const std::shared_ptr &obj) { py::print(obj->toString()); }); + m.def("print_myobject2_4", [](const std::shared_ptr *obj) { py::print((*obj)->toString()); }); + + // Object managed by a std::shared_ptr<>, additionally derives from std::enable_shared_from_this<> + class MyObject3 : public std::enable_shared_from_this { + public: + MyObject3(int value) : value(value) { print_created(this, toString()); } + std::string toString() const { return "MyObject3[" + std::to_string(value) + "]"; } + virtual ~MyObject3() { print_destroyed(this); } + private: + int value; + }; + py::class_>(m, "MyObject3") + .def(py::init()); + m.def("make_myobject3_1", []() { return new MyObject3(8); }); + m.def("make_myobject3_2", []() { return std::make_shared(9); }); + m.def("print_myobject3_1", [](const MyObject3 *obj) { py::print(obj->toString()); }); + m.def("print_myobject3_2", [](std::shared_ptr obj) { py::print(obj->toString()); }); + m.def("print_myobject3_3", [](const std::shared_ptr &obj) { py::print(obj->toString()); }); + m.def("print_myobject3_4", [](const std::shared_ptr *obj) { py::print((*obj)->toString()); }); + + // test_smart_ptr_refcounting + m.def("test_object1_refcounting", []() { + ref o = new MyObject1(0); + bool good = o->getRefCount() == 1; + py::object o2 = py::cast(o, py::return_value_policy::reference); + // always request (partial) ownership for objects with intrusive + // reference counting even when using the 'reference' RVP + good &= o->getRefCount() == 2; + return good; + }); + + // test_unique_nodelete + // Object with a private destructor + class MyObject4 { + public: + MyObject4(int value) : value{value} { print_created(this); } + int value; + private: + ~MyObject4() { print_destroyed(this); } + }; + py::class_>(m, "MyObject4") + .def(py::init()) + .def_readwrite("value", &MyObject4::value); + + // test_large_holder + class MyObject5 { // managed by huge_unique_ptr + public: + MyObject5(int value) : value{value} { print_created(this); } + ~MyObject5() { print_destroyed(this); } + int value; + }; + py::class_>(m, "MyObject5") + .def(py::init()) + .def_readwrite("value", &MyObject5::value); + + // test_shared_ptr_and_references + struct SharedPtrRef { + struct A { + A() { print_created(this); } + A(const A &) { print_copy_created(this); } + A(A &&) { print_move_created(this); } + ~A() { print_destroyed(this); } + }; + + A value = {}; + std::shared_ptr shared = std::make_shared(); + }; + using A = SharedPtrRef::A; + py::class_>(m, "A"); + py::class_(m, "SharedPtrRef") + .def(py::init<>()) + .def_readonly("ref", &SharedPtrRef::value) + .def_property_readonly("copy", [](const SharedPtrRef &s) { return s.value; }, + py::return_value_policy::copy) + .def_readonly("holder_ref", &SharedPtrRef::shared) + .def_property_readonly("holder_copy", [](const SharedPtrRef &s) { return s.shared; }, + py::return_value_policy::copy) + .def("set_ref", [](SharedPtrRef &, const A &) { return true; }) + .def("set_holder", [](SharedPtrRef &, std::shared_ptr) { return true; }); + + // test_shared_ptr_from_this_and_references + struct SharedFromThisRef { + struct B : std::enable_shared_from_this { + B() { print_created(this); } + B(const B &) : std::enable_shared_from_this() { print_copy_created(this); } + B(B &&) : std::enable_shared_from_this() { print_move_created(this); } + ~B() { print_destroyed(this); } + }; + + B value = {}; + std::shared_ptr shared = std::make_shared(); + }; + using B = SharedFromThisRef::B; + py::class_>(m, "B"); + py::class_(m, "SharedFromThisRef") + .def(py::init<>()) + .def_readonly("bad_wp", &SharedFromThisRef::value) + .def_property_readonly("ref", [](const SharedFromThisRef &s) -> const B & { return *s.shared; }) + .def_property_readonly("copy", [](const SharedFromThisRef &s) { return s.value; }, + py::return_value_policy::copy) + .def_readonly("holder_ref", &SharedFromThisRef::shared) + .def_property_readonly("holder_copy", [](const SharedFromThisRef &s) { return s.shared; }, + py::return_value_policy::copy) + .def("set_ref", [](SharedFromThisRef &, const B &) { return true; }) + .def("set_holder", [](SharedFromThisRef &, std::shared_ptr) { return true; }); + + // Issue #865: shared_from_this doesn't work with virtual inheritance + struct SharedFromThisVBase : std::enable_shared_from_this { + virtual ~SharedFromThisVBase() = default; + }; + struct SharedFromThisVirt : virtual SharedFromThisVBase {}; + static std::shared_ptr sft(new SharedFromThisVirt()); + py::class_>(m, "SharedFromThisVirt") + .def_static("get", []() { return sft.get(); }); + + // test_move_only_holder + struct C { + C() { print_created(this); } + ~C() { print_destroyed(this); } + }; + py::class_>(m, "TypeWithMoveOnlyHolder") + .def_static("make", []() { return custom_unique_ptr(new C); }); + + // test_holder_with_addressof_operator + struct TypeForHolderWithAddressOf { + TypeForHolderWithAddressOf() { print_created(this); } + TypeForHolderWithAddressOf(const TypeForHolderWithAddressOf &) { print_copy_created(this); } + TypeForHolderWithAddressOf(TypeForHolderWithAddressOf &&) { print_move_created(this); } + ~TypeForHolderWithAddressOf() { print_destroyed(this); } + std::string toString() const { + return "TypeForHolderWithAddressOf[" + std::to_string(value) + "]"; + } + int value = 42; + }; + using HolderWithAddressOf = shared_ptr_with_addressof_operator; + py::class_(m, "TypeForHolderWithAddressOf") + .def_static("make", []() { return HolderWithAddressOf(new TypeForHolderWithAddressOf); }) + .def("get", [](const HolderWithAddressOf &self) { return self.get(); }) + .def("print_object_1", [](const TypeForHolderWithAddressOf *obj) { py::print(obj->toString()); }) + .def("print_object_2", [](HolderWithAddressOf obj) { py::print(obj.get()->toString()); }) + .def("print_object_3", [](const HolderWithAddressOf &obj) { py::print(obj.get()->toString()); }) + .def("print_object_4", [](const HolderWithAddressOf *obj) { py::print((*obj).get()->toString()); }); + + // test_move_only_holder_with_addressof_operator + struct TypeForMoveOnlyHolderWithAddressOf { + TypeForMoveOnlyHolderWithAddressOf(int value) : value{value} { print_created(this); } + ~TypeForMoveOnlyHolderWithAddressOf() { print_destroyed(this); } + std::string toString() const { + return "MoveOnlyHolderWithAddressOf[" + std::to_string(value) + "]"; + } + int value; + }; + using MoveOnlyHolderWithAddressOf = unique_ptr_with_addressof_operator; + py::class_(m, "TypeForMoveOnlyHolderWithAddressOf") + .def_static("make", []() { return MoveOnlyHolderWithAddressOf(new TypeForMoveOnlyHolderWithAddressOf(0)); }) + .def_readwrite("value", &TypeForMoveOnlyHolderWithAddressOf::value) + .def("print_object", [](const TypeForMoveOnlyHolderWithAddressOf *obj) { py::print(obj->toString()); }); + + // test_smart_ptr_from_default + struct HeldByDefaultHolder { }; + py::class_(m, "HeldByDefaultHolder") + .def(py::init<>()) + .def_static("load_shared_ptr", [](std::shared_ptr) {}); + + // test_shared_ptr_gc + // #187: issue involving std::shared_ptr<> return value policy & garbage collection + struct ElementBase { virtual void foo() { } /* Force creation of virtual table */ }; + py::class_>(m, "ElementBase"); + + struct ElementA : ElementBase { + ElementA(int v) : v(v) { } + int value() { return v; } + int v; + }; + py::class_>(m, "ElementA") + .def(py::init()) + .def("value", &ElementA::value); + + struct ElementList { + void add(std::shared_ptr e) { l.push_back(e); } + std::vector> l; + }; + py::class_>(m, "ElementList") + .def(py::init<>()) + .def("add", &ElementList::add) + .def("get", [](ElementList &el) { + py::list list; + for (auto &e : el.l) + list.append(py::cast(e)); + return list; + }); +} diff --git a/plugins/python/pybind11/tests/test_smart_ptr.py b/plugins/python/pybind11/tests/test_smart_ptr.py new file mode 100644 index 0000000..60f48b3 --- /dev/null +++ b/plugins/python/pybind11/tests/test_smart_ptr.py @@ -0,0 +1,264 @@ +import pytest +from pybind11_tests import smart_ptr as m +from pybind11_tests import ConstructorStats + + +def test_smart_ptr(capture): + # Object1 + for i, o in enumerate([m.make_object_1(), m.make_object_2(), m.MyObject1(3)], start=1): + assert o.getRefCount() == 1 + with capture: + m.print_object_1(o) + m.print_object_2(o) + m.print_object_3(o) + m.print_object_4(o) + assert capture == "MyObject1[{i}]\n".format(i=i) * 4 + + for i, o in enumerate([m.make_myobject1_1(), m.make_myobject1_2(), m.MyObject1(6), 7], + start=4): + print(o) + with capture: + if not isinstance(o, int): + m.print_object_1(o) + m.print_object_2(o) + m.print_object_3(o) + m.print_object_4(o) + m.print_myobject1_1(o) + m.print_myobject1_2(o) + m.print_myobject1_3(o) + m.print_myobject1_4(o) + assert capture == "MyObject1[{i}]\n".format(i=i) * (4 if isinstance(o, int) else 8) + + cstats = ConstructorStats.get(m.MyObject1) + assert cstats.alive() == 0 + expected_values = ['MyObject1[{}]'.format(i) for i in range(1, 7)] + ['MyObject1[7]'] * 4 + assert cstats.values() == expected_values + assert cstats.default_constructions == 0 + assert cstats.copy_constructions == 0 + # assert cstats.move_constructions >= 0 # Doesn't invoke any + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + # Object2 + for i, o in zip([8, 6, 7], [m.MyObject2(8), m.make_myobject2_1(), m.make_myobject2_2()]): + print(o) + with capture: + m.print_myobject2_1(o) + m.print_myobject2_2(o) + m.print_myobject2_3(o) + m.print_myobject2_4(o) + assert capture == "MyObject2[{i}]\n".format(i=i) * 4 + + cstats = ConstructorStats.get(m.MyObject2) + assert cstats.alive() == 1 + o = None + assert cstats.alive() == 0 + assert cstats.values() == ['MyObject2[8]', 'MyObject2[6]', 'MyObject2[7]'] + assert cstats.default_constructions == 0 + assert cstats.copy_constructions == 0 + # assert cstats.move_constructions >= 0 # Doesn't invoke any + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + # Object3 + for i, o in zip([9, 8, 9], [m.MyObject3(9), m.make_myobject3_1(), m.make_myobject3_2()]): + print(o) + with capture: + m.print_myobject3_1(o) + m.print_myobject3_2(o) + m.print_myobject3_3(o) + m.print_myobject3_4(o) + assert capture == "MyObject3[{i}]\n".format(i=i) * 4 + + cstats = ConstructorStats.get(m.MyObject3) + assert cstats.alive() == 1 + o = None + assert cstats.alive() == 0 + assert cstats.values() == ['MyObject3[9]', 'MyObject3[8]', 'MyObject3[9]'] + assert cstats.default_constructions == 0 + assert cstats.copy_constructions == 0 + # assert cstats.move_constructions >= 0 # Doesn't invoke any + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + # Object + cstats = ConstructorStats.get(m.Object) + assert cstats.alive() == 0 + assert cstats.values() == [] + assert cstats.default_constructions == 10 + assert cstats.copy_constructions == 0 + # assert cstats.move_constructions >= 0 # Doesn't invoke any + assert cstats.copy_assignments == 0 + assert cstats.move_assignments == 0 + + # ref<> + cstats = m.cstats_ref() + assert cstats.alive() == 0 + assert cstats.values() == ['from pointer'] * 10 + assert cstats.default_constructions == 30 + assert cstats.copy_constructions == 12 + # assert cstats.move_constructions >= 0 # Doesn't invoke any + assert cstats.copy_assignments == 30 + assert cstats.move_assignments == 0 + + +def test_smart_ptr_refcounting(): + assert m.test_object1_refcounting() + + +def test_unique_nodelete(): + o = m.MyObject4(23) + assert o.value == 23 + cstats = ConstructorStats.get(m.MyObject4) + assert cstats.alive() == 1 + del o + assert cstats.alive() == 1 # Leak, but that's intentional + + +def test_large_holder(): + o = m.MyObject5(5) + assert o.value == 5 + cstats = ConstructorStats.get(m.MyObject5) + assert cstats.alive() == 1 + del o + assert cstats.alive() == 0 + + +def test_shared_ptr_and_references(): + s = m.SharedPtrRef() + stats = ConstructorStats.get(m.A) + assert stats.alive() == 2 + + ref = s.ref # init_holder_helper(holder_ptr=false, owned=false) + assert stats.alive() == 2 + assert s.set_ref(ref) + with pytest.raises(RuntimeError) as excinfo: + assert s.set_holder(ref) + assert "Unable to cast from non-held to held instance" in str(excinfo.value) + + copy = s.copy # init_holder_helper(holder_ptr=false, owned=true) + assert stats.alive() == 3 + assert s.set_ref(copy) + assert s.set_holder(copy) + + holder_ref = s.holder_ref # init_holder_helper(holder_ptr=true, owned=false) + assert stats.alive() == 3 + assert s.set_ref(holder_ref) + assert s.set_holder(holder_ref) + + holder_copy = s.holder_copy # init_holder_helper(holder_ptr=true, owned=true) + assert stats.alive() == 3 + assert s.set_ref(holder_copy) + assert s.set_holder(holder_copy) + + del ref, copy, holder_ref, holder_copy, s + assert stats.alive() == 0 + + +def test_shared_ptr_from_this_and_references(): + s = m.SharedFromThisRef() + stats = ConstructorStats.get(m.B) + assert stats.alive() == 2 + + ref = s.ref # init_holder_helper(holder_ptr=false, owned=false, bad_wp=false) + assert stats.alive() == 2 + assert s.set_ref(ref) + assert s.set_holder(ref) # std::enable_shared_from_this can create a holder from a reference + + bad_wp = s.bad_wp # init_holder_helper(holder_ptr=false, owned=false, bad_wp=true) + assert stats.alive() == 2 + assert s.set_ref(bad_wp) + with pytest.raises(RuntimeError) as excinfo: + assert s.set_holder(bad_wp) + assert "Unable to cast from non-held to held instance" in str(excinfo.value) + + copy = s.copy # init_holder_helper(holder_ptr=false, owned=true, bad_wp=false) + assert stats.alive() == 3 + assert s.set_ref(copy) + assert s.set_holder(copy) + + holder_ref = s.holder_ref # init_holder_helper(holder_ptr=true, owned=false, bad_wp=false) + assert stats.alive() == 3 + assert s.set_ref(holder_ref) + assert s.set_holder(holder_ref) + + holder_copy = s.holder_copy # init_holder_helper(holder_ptr=true, owned=true, bad_wp=false) + assert stats.alive() == 3 + assert s.set_ref(holder_copy) + assert s.set_holder(holder_copy) + + del ref, bad_wp, copy, holder_ref, holder_copy, s + assert stats.alive() == 0 + + z = m.SharedFromThisVirt.get() + y = m.SharedFromThisVirt.get() + assert y is z + + +def test_move_only_holder(): + a = m.TypeWithMoveOnlyHolder.make() + stats = ConstructorStats.get(m.TypeWithMoveOnlyHolder) + assert stats.alive() == 1 + del a + assert stats.alive() == 0 + + +def test_holder_with_addressof_operator(): + # this test must not throw exception from c++ + a = m.TypeForHolderWithAddressOf.make() + a.print_object_1() + a.print_object_2() + a.print_object_3() + a.print_object_4() + + stats = ConstructorStats.get(m.TypeForHolderWithAddressOf) + assert stats.alive() == 1 + + np = m.TypeForHolderWithAddressOf.make() + assert stats.alive() == 2 + del a + assert stats.alive() == 1 + del np + assert stats.alive() == 0 + + b = m.TypeForHolderWithAddressOf.make() + c = b + assert b.get() is c.get() + assert stats.alive() == 1 + + del b + assert stats.alive() == 1 + + del c + assert stats.alive() == 0 + + +def test_move_only_holder_with_addressof_operator(): + a = m.TypeForMoveOnlyHolderWithAddressOf.make() + a.print_object() + + stats = ConstructorStats.get(m.TypeForMoveOnlyHolderWithAddressOf) + assert stats.alive() == 1 + + a.value = 42 + assert a.value == 42 + + del a + assert stats.alive() == 0 + + +def test_smart_ptr_from_default(): + instance = m.HeldByDefaultHolder() + with pytest.raises(RuntimeError) as excinfo: + m.HeldByDefaultHolder.load_shared_ptr(instance) + assert "Unable to load a custom holder type from a default-holder instance" in str(excinfo) + + +def test_shared_ptr_gc(): + """#187: issue involving std::shared_ptr<> return value policy & garbage collection""" + el = m.ElementList() + for i in range(10): + el.add(m.ElementA(i)) + pytest.gc_collect() + for i, v in enumerate(el.get()): + assert i == v.value() diff --git a/plugins/python/pybind11/tests/test_stl.cpp b/plugins/python/pybind11/tests/test_stl.cpp new file mode 100644 index 0000000..cd0985d --- /dev/null +++ b/plugins/python/pybind11/tests/test_stl.cpp @@ -0,0 +1,256 @@ +/* + tests/test_stl.cpp -- STL type casters + + Copyright (c) 2017 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include + +// Test with `std::variant` in C++17 mode, or with `boost::variant` in C++11/14 +#if PYBIND11_HAS_VARIANT +using std::variant; +#elif defined(PYBIND11_TEST_BOOST) && (!defined(_MSC_VER) || _MSC_VER >= 1910) +# include +# define PYBIND11_HAS_VARIANT 1 +using boost::variant; + +namespace pybind11 { namespace detail { +template +struct type_caster> : variant_caster> {}; + +template <> +struct visit_helper { + template + static auto call(Args &&...args) -> decltype(boost::apply_visitor(args...)) { + return boost::apply_visitor(args...); + } +}; +}} // namespace pybind11::detail +#endif + +/// Issue #528: templated constructor +struct TplCtorClass { + template TplCtorClass(const T &) { } + bool operator==(const TplCtorClass &) const { return true; } +}; + +namespace std { + template <> + struct hash { size_t operator()(const TplCtorClass &) const { return 0; } }; +} + + +TEST_SUBMODULE(stl, m) { + // test_vector + m.def("cast_vector", []() { return std::vector{1}; }); + m.def("load_vector", [](const std::vector &v) { return v.at(0) == 1 && v.at(1) == 2; }); + // `std::vector` is special because it returns proxy objects instead of references + m.def("cast_bool_vector", []() { return std::vector{true, false}; }); + m.def("load_bool_vector", [](const std::vector &v) { + return v.at(0) == true && v.at(1) == false; + }); + // Unnumbered regression (caused by #936): pointers to stl containers aren't castable + static std::vector lvv{2}; + m.def("cast_ptr_vector", []() { return &lvv; }); + + // test_array + m.def("cast_array", []() { return std::array {{1 , 2}}; }); + m.def("load_array", [](const std::array &a) { return a[0] == 1 && a[1] == 2; }); + + // test_valarray + m.def("cast_valarray", []() { return std::valarray{1, 4, 9}; }); + m.def("load_valarray", [](const std::valarray& v) { + return v.size() == 3 && v[0] == 1 && v[1] == 4 && v[2] == 9; + }); + + // test_map + m.def("cast_map", []() { return std::map{{"key", "value"}}; }); + m.def("load_map", [](const std::map &map) { + return map.at("key") == "value" && map.at("key2") == "value2"; + }); + + // test_set + m.def("cast_set", []() { return std::set{"key1", "key2"}; }); + m.def("load_set", [](const std::set &set) { + return set.count("key1") && set.count("key2") && set.count("key3"); + }); + + // test_recursive_casting + m.def("cast_rv_vector", []() { return std::vector{2}; }); + m.def("cast_rv_array", []() { return std::array(); }); + // NB: map and set keys are `const`, so while we technically do move them (as `const Type &&`), + // casters don't typically do anything with that, which means they fall to the `const Type &` + // caster. + m.def("cast_rv_map", []() { return std::unordered_map{{"a", RValueCaster{}}}; }); + m.def("cast_rv_nested", []() { + std::vector>, 2>> v; + v.emplace_back(); // add an array + v.back()[0].emplace_back(); // add a map to the array + v.back()[0].back().emplace("b", RValueCaster{}); + v.back()[0].back().emplace("c", RValueCaster{}); + v.back()[1].emplace_back(); // add a map to the array + v.back()[1].back().emplace("a", RValueCaster{}); + return v; + }); + static std::array lva; + static std::unordered_map lvm{{"a", RValueCaster{}}, {"b", RValueCaster{}}}; + static std::unordered_map>>> lvn; + lvn["a"].emplace_back(); // add a list + lvn["a"].back().emplace_back(); // add an array + lvn["a"].emplace_back(); // another list + lvn["a"].back().emplace_back(); // add an array + lvn["b"].emplace_back(); // add a list + lvn["b"].back().emplace_back(); // add an array + lvn["b"].back().emplace_back(); // add another array + m.def("cast_lv_vector", []() -> const decltype(lvv) & { return lvv; }); + m.def("cast_lv_array", []() -> const decltype(lva) & { return lva; }); + m.def("cast_lv_map", []() -> const decltype(lvm) & { return lvm; }); + m.def("cast_lv_nested", []() -> const decltype(lvn) & { return lvn; }); + // #853: + m.def("cast_unique_ptr_vector", []() { + std::vector> v; + v.emplace_back(new UserType{7}); + v.emplace_back(new UserType{42}); + return v; + }); + + // test_move_out_container + struct MoveOutContainer { + struct Value { int value; }; + std::list move_list() const { return {{0}, {1}, {2}}; } + }; + py::class_(m, "MoveOutContainerValue") + .def_readonly("value", &MoveOutContainer::Value::value); + py::class_(m, "MoveOutContainer") + .def(py::init<>()) + .def_property_readonly("move_list", &MoveOutContainer::move_list); + + // Class that can be move- and copy-constructed, but not assigned + struct NoAssign { + int value; + + explicit NoAssign(int value = 0) : value(value) { } + NoAssign(const NoAssign &) = default; + NoAssign(NoAssign &&) = default; + + NoAssign &operator=(const NoAssign &) = delete; + NoAssign &operator=(NoAssign &&) = delete; + }; + py::class_(m, "NoAssign", "Class with no C++ assignment operators") + .def(py::init<>()) + .def(py::init()); + +#ifdef PYBIND11_HAS_OPTIONAL + // test_optional + m.attr("has_optional") = true; + + using opt_int = std::optional; + using opt_no_assign = std::optional; + m.def("double_or_zero", [](const opt_int& x) -> int { + return x.value_or(0) * 2; + }); + m.def("half_or_none", [](int x) -> opt_int { + return x ? opt_int(x / 2) : opt_int(); + }); + m.def("test_nullopt", [](opt_int x) { + return x.value_or(42); + }, py::arg_v("x", std::nullopt, "None")); + m.def("test_no_assign", [](const opt_no_assign &x) { + return x ? x->value : 42; + }, py::arg_v("x", std::nullopt, "None")); + + m.def("nodefer_none_optional", [](std::optional) { return true; }); + m.def("nodefer_none_optional", [](py::none) { return false; }); +#endif + +#ifdef PYBIND11_HAS_EXP_OPTIONAL + // test_exp_optional + m.attr("has_exp_optional") = true; + + using exp_opt_int = std::experimental::optional; + using exp_opt_no_assign = std::experimental::optional; + m.def("double_or_zero_exp", [](const exp_opt_int& x) -> int { + return x.value_or(0) * 2; + }); + m.def("half_or_none_exp", [](int x) -> exp_opt_int { + return x ? exp_opt_int(x / 2) : exp_opt_int(); + }); + m.def("test_nullopt_exp", [](exp_opt_int x) { + return x.value_or(42); + }, py::arg_v("x", std::experimental::nullopt, "None")); + m.def("test_no_assign_exp", [](const exp_opt_no_assign &x) { + return x ? x->value : 42; + }, py::arg_v("x", std::experimental::nullopt, "None")); +#endif + +#ifdef PYBIND11_HAS_VARIANT + static_assert(std::is_same::value, + "visitor::result_type is required by boost::variant in C++11 mode"); + + struct visitor { + using result_type = const char *; + + result_type operator()(int) { return "int"; } + result_type operator()(std::string) { return "std::string"; } + result_type operator()(double) { return "double"; } + result_type operator()(std::nullptr_t) { return "std::nullptr_t"; } + }; + + // test_variant + m.def("load_variant", [](variant v) { + return py::detail::visit_helper::call(visitor(), v); + }); + m.def("load_variant_2pass", [](variant v) { + return py::detail::visit_helper::call(visitor(), v); + }); + m.def("cast_variant", []() { + using V = variant; + return py::make_tuple(V(5), V("Hello")); + }); +#endif + + // #528: templated constructor + // (no python tests: the test here is that this compiles) + m.def("tpl_ctor_vector", [](std::vector &) {}); + m.def("tpl_ctor_map", [](std::unordered_map &) {}); + m.def("tpl_ctor_set", [](std::unordered_set &) {}); +#if defined(PYBIND11_HAS_OPTIONAL) + m.def("tpl_constr_optional", [](std::optional &) {}); +#elif defined(PYBIND11_HAS_EXP_OPTIONAL) + m.def("tpl_constr_optional", [](std::experimental::optional &) {}); +#endif + + // test_vec_of_reference_wrapper + // #171: Can't return STL structures containing reference wrapper + m.def("return_vec_of_reference_wrapper", [](std::reference_wrapper p4) { + static UserType p1{1}, p2{2}, p3{3}; + return std::vector> { + std::ref(p1), std::ref(p2), std::ref(p3), p4 + }; + }); + + // test_stl_pass_by_pointer + m.def("stl_pass_by_pointer", [](std::vector* v) { return *v; }, "v"_a=nullptr); + + class Placeholder { + public: + Placeholder() { print_created(this); } + Placeholder(const Placeholder &) = delete; + ~Placeholder() { print_destroyed(this); } + }; + py::class_(m, "Placeholder"); + + /// test_stl_vector_ownership + m.def("test_stl_ownership", + []() { + std::vector result; + result.push_back(new Placeholder()); + return result; + }, + py::return_value_policy::take_ownership); +} diff --git a/plugins/python/pybind11/tests/test_stl.py b/plugins/python/pybind11/tests/test_stl.py new file mode 100644 index 0000000..99df689 --- /dev/null +++ b/plugins/python/pybind11/tests/test_stl.py @@ -0,0 +1,210 @@ +import pytest + +from pybind11_tests import stl as m +from pybind11_tests import UserType +from pybind11_tests import ConstructorStats + + +def test_vector(doc): + """std::vector <-> list""" + lst = m.cast_vector() + assert lst == [1] + lst.append(2) + assert m.load_vector(lst) + assert m.load_vector(tuple(lst)) + + assert m.cast_bool_vector() == [True, False] + assert m.load_bool_vector([True, False]) + + assert doc(m.cast_vector) == "cast_vector() -> List[int]" + assert doc(m.load_vector) == "load_vector(arg0: List[int]) -> bool" + + # Test regression caused by 936: pointers to stl containers weren't castable + assert m.cast_ptr_vector() == ["lvalue", "lvalue"] + + +def test_array(doc): + """std::array <-> list""" + lst = m.cast_array() + assert lst == [1, 2] + assert m.load_array(lst) + + assert doc(m.cast_array) == "cast_array() -> List[int[2]]" + assert doc(m.load_array) == "load_array(arg0: List[int[2]]) -> bool" + + +def test_valarray(doc): + """std::valarray <-> list""" + lst = m.cast_valarray() + assert lst == [1, 4, 9] + assert m.load_valarray(lst) + + assert doc(m.cast_valarray) == "cast_valarray() -> List[int]" + assert doc(m.load_valarray) == "load_valarray(arg0: List[int]) -> bool" + + +def test_map(doc): + """std::map <-> dict""" + d = m.cast_map() + assert d == {"key": "value"} + d["key2"] = "value2" + assert m.load_map(d) + + assert doc(m.cast_map) == "cast_map() -> Dict[str, str]" + assert doc(m.load_map) == "load_map(arg0: Dict[str, str]) -> bool" + + +def test_set(doc): + """std::set <-> set""" + s = m.cast_set() + assert s == {"key1", "key2"} + s.add("key3") + assert m.load_set(s) + + assert doc(m.cast_set) == "cast_set() -> Set[str]" + assert doc(m.load_set) == "load_set(arg0: Set[str]) -> bool" + + +def test_recursive_casting(): + """Tests that stl casters preserve lvalue/rvalue context for container values""" + assert m.cast_rv_vector() == ["rvalue", "rvalue"] + assert m.cast_lv_vector() == ["lvalue", "lvalue"] + assert m.cast_rv_array() == ["rvalue", "rvalue", "rvalue"] + assert m.cast_lv_array() == ["lvalue", "lvalue"] + assert m.cast_rv_map() == {"a": "rvalue"} + assert m.cast_lv_map() == {"a": "lvalue", "b": "lvalue"} + assert m.cast_rv_nested() == [[[{"b": "rvalue", "c": "rvalue"}], [{"a": "rvalue"}]]] + assert m.cast_lv_nested() == { + "a": [[["lvalue", "lvalue"]], [["lvalue", "lvalue"]]], + "b": [[["lvalue", "lvalue"], ["lvalue", "lvalue"]]] + } + + # Issue #853 test case: + z = m.cast_unique_ptr_vector() + assert z[0].value == 7 and z[1].value == 42 + + +def test_move_out_container(): + """Properties use the `reference_internal` policy by default. If the underlying function + returns an rvalue, the policy is automatically changed to `move` to avoid referencing + a temporary. In case the return value is a container of user-defined types, the policy + also needs to be applied to the elements, not just the container.""" + c = m.MoveOutContainer() + moved_out_list = c.move_list + assert [x.value for x in moved_out_list] == [0, 1, 2] + + +@pytest.mark.skipif(not hasattr(m, "has_optional"), reason='no ') +def test_optional(): + assert m.double_or_zero(None) == 0 + assert m.double_or_zero(42) == 84 + pytest.raises(TypeError, m.double_or_zero, 'foo') + + assert m.half_or_none(0) is None + assert m.half_or_none(42) == 21 + pytest.raises(TypeError, m.half_or_none, 'foo') + + assert m.test_nullopt() == 42 + assert m.test_nullopt(None) == 42 + assert m.test_nullopt(42) == 42 + assert m.test_nullopt(43) == 43 + + assert m.test_no_assign() == 42 + assert m.test_no_assign(None) == 42 + assert m.test_no_assign(m.NoAssign(43)) == 43 + pytest.raises(TypeError, m.test_no_assign, 43) + + assert m.nodefer_none_optional(None) + + +@pytest.mark.skipif(not hasattr(m, "has_exp_optional"), reason='no ') +def test_exp_optional(): + assert m.double_or_zero_exp(None) == 0 + assert m.double_or_zero_exp(42) == 84 + pytest.raises(TypeError, m.double_or_zero_exp, 'foo') + + assert m.half_or_none_exp(0) is None + assert m.half_or_none_exp(42) == 21 + pytest.raises(TypeError, m.half_or_none_exp, 'foo') + + assert m.test_nullopt_exp() == 42 + assert m.test_nullopt_exp(None) == 42 + assert m.test_nullopt_exp(42) == 42 + assert m.test_nullopt_exp(43) == 43 + + assert m.test_no_assign_exp() == 42 + assert m.test_no_assign_exp(None) == 42 + assert m.test_no_assign_exp(m.NoAssign(43)) == 43 + pytest.raises(TypeError, m.test_no_assign_exp, 43) + + +@pytest.mark.skipif(not hasattr(m, "load_variant"), reason='no ') +def test_variant(doc): + assert m.load_variant(1) == "int" + assert m.load_variant("1") == "std::string" + assert m.load_variant(1.0) == "double" + assert m.load_variant(None) == "std::nullptr_t" + + assert m.load_variant_2pass(1) == "int" + assert m.load_variant_2pass(1.0) == "double" + + assert m.cast_variant() == (5, "Hello") + + assert doc(m.load_variant) == "load_variant(arg0: Union[int, str, float, None]) -> str" + + +def test_vec_of_reference_wrapper(): + """#171: Can't return reference wrappers (or STL structures containing them)""" + assert str(m.return_vec_of_reference_wrapper(UserType(4))) == \ + "[UserType(1), UserType(2), UserType(3), UserType(4)]" + + +def test_stl_pass_by_pointer(msg): + """Passing nullptr or None to an STL container pointer is not expected to work""" + with pytest.raises(TypeError) as excinfo: + m.stl_pass_by_pointer() # default value is `nullptr` + assert msg(excinfo.value) == """ + stl_pass_by_pointer(): incompatible function arguments. The following argument types are supported: + 1. (v: List[int]=None) -> List[int] + + Invoked with: + """ # noqa: E501 line too long + + with pytest.raises(TypeError) as excinfo: + m.stl_pass_by_pointer(None) + assert msg(excinfo.value) == """ + stl_pass_by_pointer(): incompatible function arguments. The following argument types are supported: + 1. (v: List[int]=None) -> List[int] + + Invoked with: None + """ # noqa: E501 line too long + + assert m.stl_pass_by_pointer([1, 2, 3]) == [1, 2, 3] + + +def test_missing_header_message(): + """Trying convert `list` to a `std::vector`, or vice versa, without including + should result in a helpful suggestion in the error message""" + import pybind11_cross_module_tests as cm + + expected_message = ("Did you forget to `#include `? Or ,\n" + ", , etc. Some automatic\n" + "conversions are optional and require extra headers to be included\n" + "when compiling your pybind11 module.") + + with pytest.raises(TypeError) as excinfo: + cm.missing_header_arg([1.0, 2.0, 3.0]) + assert expected_message in str(excinfo.value) + + with pytest.raises(TypeError) as excinfo: + cm.missing_header_return() + assert expected_message in str(excinfo.value) + + +def test_stl_ownership(): + cstats = ConstructorStats.get(m.Placeholder) + assert cstats.alive() == 0 + r = m.test_stl_ownership() + assert len(r) == 1 + del r + assert cstats.alive() == 0 diff --git a/plugins/python/pybind11/tests/test_stl_binders.cpp b/plugins/python/pybind11/tests/test_stl_binders.cpp new file mode 100644 index 0000000..a88b589 --- /dev/null +++ b/plugins/python/pybind11/tests/test_stl_binders.cpp @@ -0,0 +1,107 @@ +/* + tests/test_stl_binders.cpp -- Usage of stl_binders functions + + Copyright (c) 2016 Sergey Lyskov + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" + +#include +#include +#include +#include +#include + +class El { +public: + El() = delete; + El(int v) : a(v) { } + + int a; +}; + +std::ostream & operator<<(std::ostream &s, El const&v) { + s << "El{" << v.a << '}'; + return s; +} + +/// Issue #487: binding std::vector with E non-copyable +class E_nc { +public: + explicit E_nc(int i) : value{i} {} + E_nc(const E_nc &) = delete; + E_nc &operator=(const E_nc &) = delete; + E_nc(E_nc &&) = default; + E_nc &operator=(E_nc &&) = default; + + int value; +}; + +template Container *one_to_n(int n) { + auto v = new Container(); + for (int i = 1; i <= n; i++) + v->emplace_back(i); + return v; +} + +template Map *times_ten(int n) { + auto m = new Map(); + for (int i = 1; i <= n; i++) + m->emplace(int(i), E_nc(10*i)); + return m; +} + +TEST_SUBMODULE(stl_binders, m) { + // test_vector_int + py::bind_vector>(m, "VectorInt", py::buffer_protocol()); + + // test_vector_custom + py::class_(m, "El") + .def(py::init()); + py::bind_vector>(m, "VectorEl"); + py::bind_vector>>(m, "VectorVectorEl"); + + // test_map_string_double + py::bind_map>(m, "MapStringDouble"); + py::bind_map>(m, "UnorderedMapStringDouble"); + + // test_map_string_double_const + py::bind_map>(m, "MapStringDoubleConst"); + py::bind_map>(m, "UnorderedMapStringDoubleConst"); + + py::class_(m, "ENC") + .def(py::init()) + .def_readwrite("value", &E_nc::value); + + // test_noncopyable_containers + py::bind_vector>(m, "VectorENC"); + m.def("get_vnc", &one_to_n>, py::return_value_policy::reference); + py::bind_vector>(m, "DequeENC"); + m.def("get_dnc", &one_to_n>, py::return_value_policy::reference); + py::bind_map>(m, "MapENC"); + m.def("get_mnc", ×_ten>, py::return_value_policy::reference); + py::bind_map>(m, "UmapENC"); + m.def("get_umnc", ×_ten>, py::return_value_policy::reference); + + // test_vector_buffer + py::bind_vector>(m, "VectorUChar", py::buffer_protocol()); + // no dtype declared for this version: + struct VUndeclStruct { bool w; uint32_t x; double y; bool z; }; + m.def("create_undeclstruct", [m] () mutable { + py::bind_vector>(m, "VectorUndeclStruct", py::buffer_protocol()); + }); + + // The rest depends on numpy: + try { py::module::import("numpy"); } + catch (...) { return; } + + // test_vector_buffer_numpy + struct VStruct { bool w; uint32_t x; double y; bool z; }; + PYBIND11_NUMPY_DTYPE(VStruct, w, x, y, z); + py::class_(m, "VStruct").def_readwrite("x", &VStruct::x); + py::bind_vector>(m, "VectorStruct", py::buffer_protocol()); + m.def("get_vectorstruct", [] {return std::vector {{0, 5, 3.0, 1}, {1, 30, -1e4, 0}};}); +} diff --git a/plugins/python/pybind11/tests/test_stl_binders.py b/plugins/python/pybind11/tests/test_stl_binders.py new file mode 100644 index 0000000..0030924 --- /dev/null +++ b/plugins/python/pybind11/tests/test_stl_binders.py @@ -0,0 +1,205 @@ +import pytest +import sys +from pybind11_tests import stl_binders as m + +with pytest.suppress(ImportError): + import numpy as np + + +def test_vector_int(): + v_int = m.VectorInt([0, 0]) + assert len(v_int) == 2 + assert bool(v_int) is True + + v_int2 = m.VectorInt([0, 0]) + assert v_int == v_int2 + v_int2[1] = 1 + assert v_int != v_int2 + + v_int2.append(2) + v_int2.insert(0, 1) + v_int2.insert(0, 2) + v_int2.insert(0, 3) + v_int2.insert(6, 3) + assert str(v_int2) == "VectorInt[3, 2, 1, 0, 1, 2, 3]" + with pytest.raises(IndexError): + v_int2.insert(8, 4) + + v_int.append(99) + v_int2[2:-2] = v_int + assert v_int2 == m.VectorInt([3, 2, 0, 0, 99, 2, 3]) + del v_int2[1:3] + assert v_int2 == m.VectorInt([3, 0, 99, 2, 3]) + del v_int2[0] + assert v_int2 == m.VectorInt([0, 99, 2, 3]) + + +# related to the PyPy's buffer protocol. +@pytest.unsupported_on_pypy +def test_vector_buffer(): + b = bytearray([1, 2, 3, 4]) + v = m.VectorUChar(b) + assert v[1] == 2 + v[2] = 5 + mv = memoryview(v) # We expose the buffer interface + if sys.version_info.major > 2: + assert mv[2] == 5 + mv[2] = 6 + else: + assert mv[2] == '\x05' + mv[2] = '\x06' + assert v[2] == 6 + + with pytest.raises(RuntimeError) as excinfo: + m.create_undeclstruct() # Undeclared struct contents, no buffer interface + assert "NumPy type info missing for " in str(excinfo.value) + + +@pytest.unsupported_on_pypy +@pytest.requires_numpy +def test_vector_buffer_numpy(): + a = np.array([1, 2, 3, 4], dtype=np.int32) + with pytest.raises(TypeError): + m.VectorInt(a) + + a = np.array([[1, 2, 3, 4], [5, 6, 7, 8], [9, 10, 11, 12]], dtype=np.uintc) + v = m.VectorInt(a[0, :]) + assert len(v) == 4 + assert v[2] == 3 + ma = np.asarray(v) + ma[2] = 5 + assert v[2] == 5 + + v = m.VectorInt(a[:, 1]) + assert len(v) == 3 + assert v[2] == 10 + + v = m.get_vectorstruct() + assert v[0].x == 5 + ma = np.asarray(v) + ma[1]['x'] = 99 + assert v[1].x == 99 + + v = m.VectorStruct(np.zeros(3, dtype=np.dtype([('w', 'bool'), ('x', 'I'), + ('y', 'float64'), ('z', 'bool')], align=True))) + assert len(v) == 3 + + +def test_vector_bool(): + import pybind11_cross_module_tests as cm + + vv_c = cm.VectorBool() + for i in range(10): + vv_c.append(i % 2 == 0) + for i in range(10): + assert vv_c[i] == (i % 2 == 0) + assert str(vv_c) == "VectorBool[1, 0, 1, 0, 1, 0, 1, 0, 1, 0]" + + +def test_vector_custom(): + v_a = m.VectorEl() + v_a.append(m.El(1)) + v_a.append(m.El(2)) + assert str(v_a) == "VectorEl[El{1}, El{2}]" + + vv_a = m.VectorVectorEl() + vv_a.append(v_a) + vv_b = vv_a[0] + assert str(vv_b) == "VectorEl[El{1}, El{2}]" + + +def test_map_string_double(): + mm = m.MapStringDouble() + mm['a'] = 1 + mm['b'] = 2.5 + + assert list(mm) == ['a', 'b'] + assert list(mm.items()) == [('a', 1), ('b', 2.5)] + assert str(mm) == "MapStringDouble{a: 1, b: 2.5}" + + um = m.UnorderedMapStringDouble() + um['ua'] = 1.1 + um['ub'] = 2.6 + + assert sorted(list(um)) == ['ua', 'ub'] + assert sorted(list(um.items())) == [('ua', 1.1), ('ub', 2.6)] + assert "UnorderedMapStringDouble" in str(um) + + +def test_map_string_double_const(): + mc = m.MapStringDoubleConst() + mc['a'] = 10 + mc['b'] = 20.5 + assert str(mc) == "MapStringDoubleConst{a: 10, b: 20.5}" + + umc = m.UnorderedMapStringDoubleConst() + umc['a'] = 11 + umc['b'] = 21.5 + + str(umc) + + +def test_noncopyable_containers(): + # std::vector + vnc = m.get_vnc(5) + for i in range(0, 5): + assert vnc[i].value == i + 1 + + for i, j in enumerate(vnc, start=1): + assert j.value == i + + # std::deque + dnc = m.get_dnc(5) + for i in range(0, 5): + assert dnc[i].value == i + 1 + + i = 1 + for j in dnc: + assert(j.value == i) + i += 1 + + # std::map + mnc = m.get_mnc(5) + for i in range(1, 6): + assert mnc[i].value == 10 * i + + vsum = 0 + for k, v in mnc.items(): + assert v.value == 10 * k + vsum += v.value + + assert vsum == 150 + + # std::unordered_map + mnc = m.get_umnc(5) + for i in range(1, 6): + assert mnc[i].value == 10 * i + + vsum = 0 + for k, v in mnc.items(): + assert v.value == 10 * k + vsum += v.value + + assert vsum == 150 + + +def test_map_delitem(): + mm = m.MapStringDouble() + mm['a'] = 1 + mm['b'] = 2.5 + + assert list(mm) == ['a', 'b'] + assert list(mm.items()) == [('a', 1), ('b', 2.5)] + del mm['a'] + assert list(mm) == ['b'] + assert list(mm.items()) == [('b', 2.5)] + + um = m.UnorderedMapStringDouble() + um['ua'] = 1.1 + um['ub'] = 2.6 + + assert sorted(list(um)) == ['ua', 'ub'] + assert sorted(list(um.items())) == [('ua', 1.1), ('ub', 2.6)] + del um['ua'] + assert sorted(list(um)) == ['ub'] + assert sorted(list(um.items())) == [('ub', 2.6)] diff --git a/plugins/python/pybind11/tests/test_virtual_functions.cpp b/plugins/python/pybind11/tests/test_virtual_functions.cpp new file mode 100644 index 0000000..043912e --- /dev/null +++ b/plugins/python/pybind11/tests/test_virtual_functions.cpp @@ -0,0 +1,476 @@ +/* + tests/test_virtual_functions.cpp -- overriding virtual functions from Python + + Copyright (c) 2016 Wenzel Jakob + + All rights reserved. Use of this source code is governed by a + BSD-style license that can be found in the LICENSE file. +*/ + +#include "pybind11_tests.h" +#include "constructor_stats.h" +#include +#include + +/* This is an example class that we'll want to be able to extend from Python */ +class ExampleVirt { +public: + ExampleVirt(int state) : state(state) { print_created(this, state); } + ExampleVirt(const ExampleVirt &e) : state(e.state) { print_copy_created(this); } + ExampleVirt(ExampleVirt &&e) : state(e.state) { print_move_created(this); e.state = 0; } + virtual ~ExampleVirt() { print_destroyed(this); } + + virtual int run(int value) { + py::print("Original implementation of " + "ExampleVirt::run(state={}, value={}, str1={}, str2={})"_s.format(state, value, get_string1(), *get_string2())); + return state + value; + } + + virtual bool run_bool() = 0; + virtual void pure_virtual() = 0; + + // Returning a reference/pointer to a type converted from python (numbers, strings, etc.) is a + // bit trickier, because the actual int& or std::string& or whatever only exists temporarily, so + // we have to handle it specially in the trampoline class (see below). + virtual const std::string &get_string1() { return str1; } + virtual const std::string *get_string2() { return &str2; } + +private: + int state; + const std::string str1{"default1"}, str2{"default2"}; +}; + +/* This is a wrapper class that must be generated */ +class PyExampleVirt : public ExampleVirt { +public: + using ExampleVirt::ExampleVirt; /* Inherit constructors */ + + int run(int value) override { + /* Generate wrapping code that enables native function overloading */ + PYBIND11_OVERLOAD( + int, /* Return type */ + ExampleVirt, /* Parent class */ + run, /* Name of function */ + value /* Argument(s) */ + ); + } + + bool run_bool() override { + PYBIND11_OVERLOAD_PURE( + bool, /* Return type */ + ExampleVirt, /* Parent class */ + run_bool, /* Name of function */ + /* This function has no arguments. The trailing comma + in the previous line is needed for some compilers */ + ); + } + + void pure_virtual() override { + PYBIND11_OVERLOAD_PURE( + void, /* Return type */ + ExampleVirt, /* Parent class */ + pure_virtual, /* Name of function */ + /* This function has no arguments. The trailing comma + in the previous line is needed for some compilers */ + ); + } + + // We can return reference types for compatibility with C++ virtual interfaces that do so, but + // note they have some significant limitations (see the documentation). + const std::string &get_string1() override { + PYBIND11_OVERLOAD( + const std::string &, /* Return type */ + ExampleVirt, /* Parent class */ + get_string1, /* Name of function */ + /* (no arguments) */ + ); + } + + const std::string *get_string2() override { + PYBIND11_OVERLOAD( + const std::string *, /* Return type */ + ExampleVirt, /* Parent class */ + get_string2, /* Name of function */ + /* (no arguments) */ + ); + } + +}; + +class NonCopyable { +public: + NonCopyable(int a, int b) : value{new int(a*b)} { print_created(this, a, b); } + NonCopyable(NonCopyable &&o) { value = std::move(o.value); print_move_created(this); } + NonCopyable(const NonCopyable &) = delete; + NonCopyable() = delete; + void operator=(const NonCopyable &) = delete; + void operator=(NonCopyable &&) = delete; + std::string get_value() const { + if (value) return std::to_string(*value); else return "(null)"; + } + ~NonCopyable() { print_destroyed(this); } + +private: + std::unique_ptr value; +}; + +// This is like the above, but is both copy and movable. In effect this means it should get moved +// when it is not referenced elsewhere, but copied if it is still referenced. +class Movable { +public: + Movable(int a, int b) : value{a+b} { print_created(this, a, b); } + Movable(const Movable &m) { value = m.value; print_copy_created(this); } + Movable(Movable &&m) { value = std::move(m.value); print_move_created(this); } + std::string get_value() const { return std::to_string(value); } + ~Movable() { print_destroyed(this); } +private: + int value; +}; + +class NCVirt { +public: + virtual NonCopyable get_noncopyable(int a, int b) { return NonCopyable(a, b); } + virtual Movable get_movable(int a, int b) = 0; + + std::string print_nc(int a, int b) { return get_noncopyable(a, b).get_value(); } + std::string print_movable(int a, int b) { return get_movable(a, b).get_value(); } +}; +class NCVirtTrampoline : public NCVirt { +#if !defined(__INTEL_COMPILER) + NonCopyable get_noncopyable(int a, int b) override { + PYBIND11_OVERLOAD(NonCopyable, NCVirt, get_noncopyable, a, b); + } +#endif + Movable get_movable(int a, int b) override { + PYBIND11_OVERLOAD_PURE(Movable, NCVirt, get_movable, a, b); + } +}; + +struct Base { + /* for some reason MSVC2015 can't compile this if the function is pure virtual */ + virtual std::string dispatch() const { return {}; }; + virtual ~Base() = default; +}; + +struct DispatchIssue : Base { + virtual std::string dispatch() const { + PYBIND11_OVERLOAD_PURE(std::string, Base, dispatch, /* no arguments */); + } +}; + +static void test_gil() { + { + py::gil_scoped_acquire lock; + py::print("1st lock acquired"); + + } + + { + py::gil_scoped_acquire lock; + py::print("2nd lock acquired"); + } + +} + +static void test_gil_from_thread() { + py::gil_scoped_release release; + + std::thread t(test_gil); + t.join(); +} + + +// Forward declaration (so that we can put the main tests here; the inherited virtual approaches are +// rather long). +void initialize_inherited_virtuals(py::module &m); + +TEST_SUBMODULE(virtual_functions, m) { + // test_override + py::class_(m, "ExampleVirt") + .def(py::init()) + /* Reference original class in function definitions */ + .def("run", &ExampleVirt::run) + .def("run_bool", &ExampleVirt::run_bool) + .def("pure_virtual", &ExampleVirt::pure_virtual); + + py::class_(m, "NonCopyable") + .def(py::init()); + + py::class_(m, "Movable") + .def(py::init()); + + // test_move_support +#if !defined(__INTEL_COMPILER) + py::class_(m, "NCVirt") + .def(py::init<>()) + .def("get_noncopyable", &NCVirt::get_noncopyable) + .def("get_movable", &NCVirt::get_movable) + .def("print_nc", &NCVirt::print_nc) + .def("print_movable", &NCVirt::print_movable); +#endif + + m.def("runExampleVirt", [](ExampleVirt *ex, int value) { return ex->run(value); }); + m.def("runExampleVirtBool", [](ExampleVirt* ex) { return ex->run_bool(); }); + m.def("runExampleVirtVirtual", [](ExampleVirt *ex) { ex->pure_virtual(); }); + + m.def("cstats_debug", &ConstructorStats::get); + initialize_inherited_virtuals(m); + + // test_alias_delay_initialization1 + // don't invoke Python dispatch classes by default when instantiating C++ classes + // that were not extended on the Python side + struct A { + virtual ~A() {} + virtual void f() { py::print("A.f()"); } + }; + + struct PyA : A { + PyA() { py::print("PyA.PyA()"); } + ~PyA() { py::print("PyA.~PyA()"); } + + void f() override { + py::print("PyA.f()"); + PYBIND11_OVERLOAD(void, A, f); + } + }; + + py::class_(m, "A") + .def(py::init<>()) + .def("f", &A::f); + + m.def("call_f", [](A *a) { a->f(); }); + + // test_alias_delay_initialization2 + // ... unless we explicitly request it, as in this example: + struct A2 { + virtual ~A2() {} + virtual void f() { py::print("A2.f()"); } + }; + + struct PyA2 : A2 { + PyA2() { py::print("PyA2.PyA2()"); } + ~PyA2() { py::print("PyA2.~PyA2()"); } + void f() override { + py::print("PyA2.f()"); + PYBIND11_OVERLOAD(void, A2, f); + } + }; + + py::class_(m, "A2") + .def(py::init_alias<>()) + .def(py::init([](int) { return new PyA2(); })) + .def("f", &A2::f); + + m.def("call_f", [](A2 *a2) { a2->f(); }); + + // test_dispatch_issue + // #159: virtual function dispatch has problems with similar-named functions + py::class_(m, "DispatchIssue") + .def(py::init<>()) + .def("dispatch", &Base::dispatch); + + m.def("dispatch_issue_go", [](const Base * b) { return b->dispatch(); }); + + // test_override_ref + // #392/397: overriding reference-returning functions + class OverrideTest { + public: + struct A { std::string value = "hi"; }; + std::string v; + A a; + explicit OverrideTest(const std::string &v) : v{v} {} + virtual std::string str_value() { return v; } + virtual std::string &str_ref() { return v; } + virtual A A_value() { return a; } + virtual A &A_ref() { return a; } + virtual ~OverrideTest() = default; + }; + + class PyOverrideTest : public OverrideTest { + public: + using OverrideTest::OverrideTest; + std::string str_value() override { PYBIND11_OVERLOAD(std::string, OverrideTest, str_value); } + // Not allowed (uncommenting should hit a static_assert failure): we can't get a reference + // to a python numeric value, since we only copy values in the numeric type caster: +// std::string &str_ref() override { PYBIND11_OVERLOAD(std::string &, OverrideTest, str_ref); } + // But we can work around it like this: + private: + std::string _tmp; + std::string str_ref_helper() { PYBIND11_OVERLOAD(std::string, OverrideTest, str_ref); } + public: + std::string &str_ref() override { return _tmp = str_ref_helper(); } + + A A_value() override { PYBIND11_OVERLOAD(A, OverrideTest, A_value); } + A &A_ref() override { PYBIND11_OVERLOAD(A &, OverrideTest, A_ref); } + }; + + py::class_(m, "OverrideTest_A") + .def_readwrite("value", &OverrideTest::A::value); + py::class_(m, "OverrideTest") + .def(py::init()) + .def("str_value", &OverrideTest::str_value) +// .def("str_ref", &OverrideTest::str_ref) + .def("A_value", &OverrideTest::A_value) + .def("A_ref", &OverrideTest::A_ref); +} + + +// Inheriting virtual methods. We do two versions here: the repeat-everything version and the +// templated trampoline versions mentioned in docs/advanced.rst. +// +// These base classes are exactly the same, but we technically need distinct +// classes for this example code because we need to be able to bind them +// properly (pybind11, sensibly, doesn't allow us to bind the same C++ class to +// multiple python classes). +class A_Repeat { +#define A_METHODS \ +public: \ + virtual int unlucky_number() = 0; \ + virtual std::string say_something(unsigned times) { \ + std::string s = ""; \ + for (unsigned i = 0; i < times; ++i) \ + s += "hi"; \ + return s; \ + } \ + std::string say_everything() { \ + return say_something(1) + " " + std::to_string(unlucky_number()); \ + } +A_METHODS + virtual ~A_Repeat() = default; +}; +class B_Repeat : public A_Repeat { +#define B_METHODS \ +public: \ + int unlucky_number() override { return 13; } \ + std::string say_something(unsigned times) override { \ + return "B says hi " + std::to_string(times) + " times"; \ + } \ + virtual double lucky_number() { return 7.0; } +B_METHODS +}; +class C_Repeat : public B_Repeat { +#define C_METHODS \ +public: \ + int unlucky_number() override { return 4444; } \ + double lucky_number() override { return 888; } +C_METHODS +}; +class D_Repeat : public C_Repeat { +#define D_METHODS // Nothing overridden. +D_METHODS +}; + +// Base classes for templated inheritance trampolines. Identical to the repeat-everything version: +class A_Tpl { A_METHODS; virtual ~A_Tpl() = default; }; +class B_Tpl : public A_Tpl { B_METHODS }; +class C_Tpl : public B_Tpl { C_METHODS }; +class D_Tpl : public C_Tpl { D_METHODS }; + + +// Inheritance approach 1: each trampoline gets every virtual method (11 in total) +class PyA_Repeat : public A_Repeat { +public: + using A_Repeat::A_Repeat; + int unlucky_number() override { PYBIND11_OVERLOAD_PURE(int, A_Repeat, unlucky_number, ); } + std::string say_something(unsigned times) override { PYBIND11_OVERLOAD(std::string, A_Repeat, say_something, times); } +}; +class PyB_Repeat : public B_Repeat { +public: + using B_Repeat::B_Repeat; + int unlucky_number() override { PYBIND11_OVERLOAD(int, B_Repeat, unlucky_number, ); } + std::string say_something(unsigned times) override { PYBIND11_OVERLOAD(std::string, B_Repeat, say_something, times); } + double lucky_number() override { PYBIND11_OVERLOAD(double, B_Repeat, lucky_number, ); } +}; +class PyC_Repeat : public C_Repeat { +public: + using C_Repeat::C_Repeat; + int unlucky_number() override { PYBIND11_OVERLOAD(int, C_Repeat, unlucky_number, ); } + std::string say_something(unsigned times) override { PYBIND11_OVERLOAD(std::string, C_Repeat, say_something, times); } + double lucky_number() override { PYBIND11_OVERLOAD(double, C_Repeat, lucky_number, ); } +}; +class PyD_Repeat : public D_Repeat { +public: + using D_Repeat::D_Repeat; + int unlucky_number() override { PYBIND11_OVERLOAD(int, D_Repeat, unlucky_number, ); } + std::string say_something(unsigned times) override { PYBIND11_OVERLOAD(std::string, D_Repeat, say_something, times); } + double lucky_number() override { PYBIND11_OVERLOAD(double, D_Repeat, lucky_number, ); } +}; + +// Inheritance approach 2: templated trampoline classes. +// +// Advantages: +// - we have only 2 (template) class and 4 method declarations (one per virtual method, plus one for +// any override of a pure virtual method), versus 4 classes and 6 methods (MI) or 4 classes and 11 +// methods (repeat). +// - Compared to MI, we also don't have to change the non-trampoline inheritance to virtual, and can +// properly inherit constructors. +// +// Disadvantage: +// - the compiler must still generate and compile 14 different methods (more, even, than the 11 +// required for the repeat approach) instead of the 6 required for MI. (If there was no pure +// method (or no pure method override), the number would drop down to the same 11 as the repeat +// approach). +template +class PyA_Tpl : public Base { +public: + using Base::Base; // Inherit constructors + int unlucky_number() override { PYBIND11_OVERLOAD_PURE(int, Base, unlucky_number, ); } + std::string say_something(unsigned times) override { PYBIND11_OVERLOAD(std::string, Base, say_something, times); } +}; +template +class PyB_Tpl : public PyA_Tpl { +public: + using PyA_Tpl::PyA_Tpl; // Inherit constructors (via PyA_Tpl's inherited constructors) + int unlucky_number() override { PYBIND11_OVERLOAD(int, Base, unlucky_number, ); } + double lucky_number() override { PYBIND11_OVERLOAD(double, Base, lucky_number, ); } +}; +// Since C_Tpl and D_Tpl don't declare any new virtual methods, we don't actually need these (we can +// use PyB_Tpl and PyB_Tpl for the trampoline classes instead): +/* +template class PyC_Tpl : public PyB_Tpl { +public: + using PyB_Tpl::PyB_Tpl; +}; +template class PyD_Tpl : public PyC_Tpl { +public: + using PyC_Tpl::PyC_Tpl; +}; +*/ + +void initialize_inherited_virtuals(py::module &m) { + // test_inherited_virtuals + + // Method 1: repeat + py::class_(m, "A_Repeat") + .def(py::init<>()) + .def("unlucky_number", &A_Repeat::unlucky_number) + .def("say_something", &A_Repeat::say_something) + .def("say_everything", &A_Repeat::say_everything); + py::class_(m, "B_Repeat") + .def(py::init<>()) + .def("lucky_number", &B_Repeat::lucky_number); + py::class_(m, "C_Repeat") + .def(py::init<>()); + py::class_(m, "D_Repeat") + .def(py::init<>()); + + // test_ + // Method 2: Templated trampolines + py::class_>(m, "A_Tpl") + .def(py::init<>()) + .def("unlucky_number", &A_Tpl::unlucky_number) + .def("say_something", &A_Tpl::say_something) + .def("say_everything", &A_Tpl::say_everything); + py::class_>(m, "B_Tpl") + .def(py::init<>()) + .def("lucky_number", &B_Tpl::lucky_number); + py::class_>(m, "C_Tpl") + .def(py::init<>()); + py::class_>(m, "D_Tpl") + .def(py::init<>()); + + + // Fix issue #1454 (crash when acquiring/releasing GIL on another thread in Python 2.7) + m.def("test_gil", &test_gil); + m.def("test_gil_from_thread", &test_gil_from_thread); +}; diff --git a/plugins/python/pybind11/tests/test_virtual_functions.py b/plugins/python/pybind11/tests/test_virtual_functions.py new file mode 100644 index 0000000..5ce9abd --- /dev/null +++ b/plugins/python/pybind11/tests/test_virtual_functions.py @@ -0,0 +1,377 @@ +import pytest + +from pybind11_tests import virtual_functions as m +from pybind11_tests import ConstructorStats + + +def test_override(capture, msg): + class ExtendedExampleVirt(m.ExampleVirt): + def __init__(self, state): + super(ExtendedExampleVirt, self).__init__(state + 1) + self.data = "Hello world" + + def run(self, value): + print('ExtendedExampleVirt::run(%i), calling parent..' % value) + return super(ExtendedExampleVirt, self).run(value + 1) + + def run_bool(self): + print('ExtendedExampleVirt::run_bool()') + return False + + def get_string1(self): + return "override1" + + def pure_virtual(self): + print('ExtendedExampleVirt::pure_virtual(): %s' % self.data) + + class ExtendedExampleVirt2(ExtendedExampleVirt): + def __init__(self, state): + super(ExtendedExampleVirt2, self).__init__(state + 1) + + def get_string2(self): + return "override2" + + ex12 = m.ExampleVirt(10) + with capture: + assert m.runExampleVirt(ex12, 20) == 30 + assert capture == """ + Original implementation of ExampleVirt::run(state=10, value=20, str1=default1, str2=default2) + """ # noqa: E501 line too long + + with pytest.raises(RuntimeError) as excinfo: + m.runExampleVirtVirtual(ex12) + assert msg(excinfo.value) == 'Tried to call pure virtual function "ExampleVirt::pure_virtual"' + + ex12p = ExtendedExampleVirt(10) + with capture: + assert m.runExampleVirt(ex12p, 20) == 32 + assert capture == """ + ExtendedExampleVirt::run(20), calling parent.. + Original implementation of ExampleVirt::run(state=11, value=21, str1=override1, str2=default2) + """ # noqa: E501 line too long + with capture: + assert m.runExampleVirtBool(ex12p) is False + assert capture == "ExtendedExampleVirt::run_bool()" + with capture: + m.runExampleVirtVirtual(ex12p) + assert capture == "ExtendedExampleVirt::pure_virtual(): Hello world" + + ex12p2 = ExtendedExampleVirt2(15) + with capture: + assert m.runExampleVirt(ex12p2, 50) == 68 + assert capture == """ + ExtendedExampleVirt::run(50), calling parent.. + Original implementation of ExampleVirt::run(state=17, value=51, str1=override1, str2=override2) + """ # noqa: E501 line too long + + cstats = ConstructorStats.get(m.ExampleVirt) + assert cstats.alive() == 3 + del ex12, ex12p, ex12p2 + assert cstats.alive() == 0 + assert cstats.values() == ['10', '11', '17'] + assert cstats.copy_constructions == 0 + assert cstats.move_constructions >= 0 + + +def test_alias_delay_initialization1(capture): + """`A` only initializes its trampoline class when we inherit from it + + If we just create and use an A instance directly, the trampoline initialization is + bypassed and we only initialize an A() instead (for performance reasons). + """ + class B(m.A): + def __init__(self): + super(B, self).__init__() + + def f(self): + print("In python f()") + + # C++ version + with capture: + a = m.A() + m.call_f(a) + del a + pytest.gc_collect() + assert capture == "A.f()" + + # Python version + with capture: + b = B() + m.call_f(b) + del b + pytest.gc_collect() + assert capture == """ + PyA.PyA() + PyA.f() + In python f() + PyA.~PyA() + """ + + +def test_alias_delay_initialization2(capture): + """`A2`, unlike the above, is configured to always initialize the alias + + While the extra initialization and extra class layer has small virtual dispatch + performance penalty, it also allows us to do more things with the trampoline + class such as defining local variables and performing construction/destruction. + """ + class B2(m.A2): + def __init__(self): + super(B2, self).__init__() + + def f(self): + print("In python B2.f()") + + # No python subclass version + with capture: + a2 = m.A2() + m.call_f(a2) + del a2 + pytest.gc_collect() + a3 = m.A2(1) + m.call_f(a3) + del a3 + pytest.gc_collect() + assert capture == """ + PyA2.PyA2() + PyA2.f() + A2.f() + PyA2.~PyA2() + PyA2.PyA2() + PyA2.f() + A2.f() + PyA2.~PyA2() + """ + + # Python subclass version + with capture: + b2 = B2() + m.call_f(b2) + del b2 + pytest.gc_collect() + assert capture == """ + PyA2.PyA2() + PyA2.f() + In python B2.f() + PyA2.~PyA2() + """ + + +# PyPy: Reference count > 1 causes call with noncopyable instance +# to fail in ncv1.print_nc() +@pytest.unsupported_on_pypy +@pytest.mark.skipif(not hasattr(m, "NCVirt"), reason="NCVirt test broken on ICPC") +def test_move_support(): + class NCVirtExt(m.NCVirt): + def get_noncopyable(self, a, b): + # Constructs and returns a new instance: + nc = m.NonCopyable(a * a, b * b) + return nc + + def get_movable(self, a, b): + # Return a referenced copy + self.movable = m.Movable(a, b) + return self.movable + + class NCVirtExt2(m.NCVirt): + def get_noncopyable(self, a, b): + # Keep a reference: this is going to throw an exception + self.nc = m.NonCopyable(a, b) + return self.nc + + def get_movable(self, a, b): + # Return a new instance without storing it + return m.Movable(a, b) + + ncv1 = NCVirtExt() + assert ncv1.print_nc(2, 3) == "36" + assert ncv1.print_movable(4, 5) == "9" + ncv2 = NCVirtExt2() + assert ncv2.print_movable(7, 7) == "14" + # Don't check the exception message here because it differs under debug/non-debug mode + with pytest.raises(RuntimeError): + ncv2.print_nc(9, 9) + + nc_stats = ConstructorStats.get(m.NonCopyable) + mv_stats = ConstructorStats.get(m.Movable) + assert nc_stats.alive() == 1 + assert mv_stats.alive() == 1 + del ncv1, ncv2 + assert nc_stats.alive() == 0 + assert mv_stats.alive() == 0 + assert nc_stats.values() == ['4', '9', '9', '9'] + assert mv_stats.values() == ['4', '5', '7', '7'] + assert nc_stats.copy_constructions == 0 + assert mv_stats.copy_constructions == 1 + assert nc_stats.move_constructions >= 0 + assert mv_stats.move_constructions >= 0 + + +def test_dispatch_issue(msg): + """#159: virtual function dispatch has problems with similar-named functions""" + class PyClass1(m.DispatchIssue): + def dispatch(self): + return "Yay.." + + class PyClass2(m.DispatchIssue): + def dispatch(self): + with pytest.raises(RuntimeError) as excinfo: + super(PyClass2, self).dispatch() + assert msg(excinfo.value) == 'Tried to call pure virtual function "Base::dispatch"' + + p = PyClass1() + return m.dispatch_issue_go(p) + + b = PyClass2() + assert m.dispatch_issue_go(b) == "Yay.." + + +def test_override_ref(): + """#392/397: overriding reference-returning functions""" + o = m.OverrideTest("asdf") + + # Not allowed (see associated .cpp comment) + # i = o.str_ref() + # assert o.str_ref() == "asdf" + assert o.str_value() == "asdf" + + assert o.A_value().value == "hi" + a = o.A_ref() + assert a.value == "hi" + a.value = "bye" + assert a.value == "bye" + + +def test_inherited_virtuals(): + class AR(m.A_Repeat): + def unlucky_number(self): + return 99 + + class AT(m.A_Tpl): + def unlucky_number(self): + return 999 + + obj = AR() + assert obj.say_something(3) == "hihihi" + assert obj.unlucky_number() == 99 + assert obj.say_everything() == "hi 99" + + obj = AT() + assert obj.say_something(3) == "hihihi" + assert obj.unlucky_number() == 999 + assert obj.say_everything() == "hi 999" + + for obj in [m.B_Repeat(), m.B_Tpl()]: + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 13 + assert obj.lucky_number() == 7.0 + assert obj.say_everything() == "B says hi 1 times 13" + + for obj in [m.C_Repeat(), m.C_Tpl()]: + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 4444 + assert obj.lucky_number() == 888.0 + assert obj.say_everything() == "B says hi 1 times 4444" + + class CR(m.C_Repeat): + def lucky_number(self): + return m.C_Repeat.lucky_number(self) + 1.25 + + obj = CR() + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 4444 + assert obj.lucky_number() == 889.25 + assert obj.say_everything() == "B says hi 1 times 4444" + + class CT(m.C_Tpl): + pass + + obj = CT() + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 4444 + assert obj.lucky_number() == 888.0 + assert obj.say_everything() == "B says hi 1 times 4444" + + class CCR(CR): + def lucky_number(self): + return CR.lucky_number(self) * 10 + + obj = CCR() + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 4444 + assert obj.lucky_number() == 8892.5 + assert obj.say_everything() == "B says hi 1 times 4444" + + class CCT(CT): + def lucky_number(self): + return CT.lucky_number(self) * 1000 + + obj = CCT() + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 4444 + assert obj.lucky_number() == 888000.0 + assert obj.say_everything() == "B says hi 1 times 4444" + + class DR(m.D_Repeat): + def unlucky_number(self): + return 123 + + def lucky_number(self): + return 42.0 + + for obj in [m.D_Repeat(), m.D_Tpl()]: + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 4444 + assert obj.lucky_number() == 888.0 + assert obj.say_everything() == "B says hi 1 times 4444" + + obj = DR() + assert obj.say_something(3) == "B says hi 3 times" + assert obj.unlucky_number() == 123 + assert obj.lucky_number() == 42.0 + assert obj.say_everything() == "B says hi 1 times 123" + + class DT(m.D_Tpl): + def say_something(self, times): + return "DT says:" + (' quack' * times) + + def unlucky_number(self): + return 1234 + + def lucky_number(self): + return -4.25 + + obj = DT() + assert obj.say_something(3) == "DT says: quack quack quack" + assert obj.unlucky_number() == 1234 + assert obj.lucky_number() == -4.25 + assert obj.say_everything() == "DT says: quack 1234" + + class DT2(DT): + def say_something(self, times): + return "DT2: " + ('QUACK' * times) + + def unlucky_number(self): + return -3 + + class BT(m.B_Tpl): + def say_something(self, times): + return "BT" * times + + def unlucky_number(self): + return -7 + + def lucky_number(self): + return -1.375 + + obj = BT() + assert obj.say_something(3) == "BTBTBT" + assert obj.unlucky_number() == -7 + assert obj.lucky_number() == -1.375 + assert obj.say_everything() == "BT -7" + + +def test_issue_1454(): + # Fix issue #1454 (crash when acquiring/releasing GIL on another thread in Python 2.7) + m.test_gil() + m.test_gil_from_thread() diff --git a/plugins/python/pybind11/tools/FindCatch.cmake b/plugins/python/pybind11/tools/FindCatch.cmake new file mode 100644 index 0000000..9d490c5 --- /dev/null +++ b/plugins/python/pybind11/tools/FindCatch.cmake @@ -0,0 +1,57 @@ +# - Find the Catch test framework or download it (single header) +# +# This is a quick module for internal use. It assumes that Catch is +# REQUIRED and that a minimum version is provided (not EXACT). If +# a suitable version isn't found locally, the single header file +# will be downloaded and placed in the build dir: PROJECT_BINARY_DIR. +# +# This code sets the following variables: +# CATCH_INCLUDE_DIR - path to catch.hpp +# CATCH_VERSION - version number + +if(NOT Catch_FIND_VERSION) + message(FATAL_ERROR "A version number must be specified.") +elseif(Catch_FIND_REQUIRED) + message(FATAL_ERROR "This module assumes Catch is not required.") +elseif(Catch_FIND_VERSION_EXACT) + message(FATAL_ERROR "Exact version numbers are not supported, only minimum.") +endif() + +# Extract the version number from catch.hpp +function(_get_catch_version) + file(STRINGS "${CATCH_INCLUDE_DIR}/catch.hpp" version_line REGEX "Catch v.*" LIMIT_COUNT 1) + if(version_line MATCHES "Catch v([0-9]+)\\.([0-9]+)\\.([0-9]+)") + set(CATCH_VERSION "${CMAKE_MATCH_1}.${CMAKE_MATCH_2}.${CMAKE_MATCH_3}" PARENT_SCOPE) + endif() +endfunction() + +# Download the single-header version of Catch +function(_download_catch version destination_dir) + message(STATUS "Downloading catch v${version}...") + set(url https://github.com/philsquared/Catch/releases/download/v${version}/catch.hpp) + file(DOWNLOAD ${url} "${destination_dir}/catch.hpp" STATUS status) + list(GET status 0 error) + if(error) + message(FATAL_ERROR "Could not download ${url}") + endif() + set(CATCH_INCLUDE_DIR "${destination_dir}" CACHE INTERNAL "") +endfunction() + +# Look for catch locally +find_path(CATCH_INCLUDE_DIR NAMES catch.hpp PATH_SUFFIXES catch) +if(CATCH_INCLUDE_DIR) + _get_catch_version() +endif() + +# Download the header if it wasn't found or if it's outdated +if(NOT CATCH_VERSION OR CATCH_VERSION VERSION_LESS ${Catch_FIND_VERSION}) + if(DOWNLOAD_CATCH) + _download_catch(${Catch_FIND_VERSION} "${PROJECT_BINARY_DIR}/catch/") + _get_catch_version() + else() + set(CATCH_FOUND FALSE) + return() + endif() +endif() + +set(CATCH_FOUND TRUE) diff --git a/plugins/python/pybind11/tools/FindEigen3.cmake b/plugins/python/pybind11/tools/FindEigen3.cmake new file mode 100644 index 0000000..9c546a0 --- /dev/null +++ b/plugins/python/pybind11/tools/FindEigen3.cmake @@ -0,0 +1,81 @@ +# - Try to find Eigen3 lib +# +# This module supports requiring a minimum version, e.g. you can do +# find_package(Eigen3 3.1.2) +# to require version 3.1.2 or newer of Eigen3. +# +# Once done this will define +# +# EIGEN3_FOUND - system has eigen lib with correct version +# EIGEN3_INCLUDE_DIR - the eigen include directory +# EIGEN3_VERSION - eigen version + +# Copyright (c) 2006, 2007 Montel Laurent, +# Copyright (c) 2008, 2009 Gael Guennebaud, +# Copyright (c) 2009 Benoit Jacob +# Redistribution and use is allowed according to the terms of the 2-clause BSD license. + +if(NOT Eigen3_FIND_VERSION) + if(NOT Eigen3_FIND_VERSION_MAJOR) + set(Eigen3_FIND_VERSION_MAJOR 2) + endif(NOT Eigen3_FIND_VERSION_MAJOR) + if(NOT Eigen3_FIND_VERSION_MINOR) + set(Eigen3_FIND_VERSION_MINOR 91) + endif(NOT Eigen3_FIND_VERSION_MINOR) + if(NOT Eigen3_FIND_VERSION_PATCH) + set(Eigen3_FIND_VERSION_PATCH 0) + endif(NOT Eigen3_FIND_VERSION_PATCH) + + set(Eigen3_FIND_VERSION "${Eigen3_FIND_VERSION_MAJOR}.${Eigen3_FIND_VERSION_MINOR}.${Eigen3_FIND_VERSION_PATCH}") +endif(NOT Eigen3_FIND_VERSION) + +macro(_eigen3_check_version) + file(READ "${EIGEN3_INCLUDE_DIR}/Eigen/src/Core/util/Macros.h" _eigen3_version_header) + + string(REGEX MATCH "define[ \t]+EIGEN_WORLD_VERSION[ \t]+([0-9]+)" _eigen3_world_version_match "${_eigen3_version_header}") + set(EIGEN3_WORLD_VERSION "${CMAKE_MATCH_1}") + string(REGEX MATCH "define[ \t]+EIGEN_MAJOR_VERSION[ \t]+([0-9]+)" _eigen3_major_version_match "${_eigen3_version_header}") + set(EIGEN3_MAJOR_VERSION "${CMAKE_MATCH_1}") + string(REGEX MATCH "define[ \t]+EIGEN_MINOR_VERSION[ \t]+([0-9]+)" _eigen3_minor_version_match "${_eigen3_version_header}") + set(EIGEN3_MINOR_VERSION "${CMAKE_MATCH_1}") + + set(EIGEN3_VERSION ${EIGEN3_WORLD_VERSION}.${EIGEN3_MAJOR_VERSION}.${EIGEN3_MINOR_VERSION}) + if(${EIGEN3_VERSION} VERSION_LESS ${Eigen3_FIND_VERSION}) + set(EIGEN3_VERSION_OK FALSE) + else(${EIGEN3_VERSION} VERSION_LESS ${Eigen3_FIND_VERSION}) + set(EIGEN3_VERSION_OK TRUE) + endif(${EIGEN3_VERSION} VERSION_LESS ${Eigen3_FIND_VERSION}) + + if(NOT EIGEN3_VERSION_OK) + + message(STATUS "Eigen3 version ${EIGEN3_VERSION} found in ${EIGEN3_INCLUDE_DIR}, " + "but at least version ${Eigen3_FIND_VERSION} is required") + endif(NOT EIGEN3_VERSION_OK) +endmacro(_eigen3_check_version) + +if (EIGEN3_INCLUDE_DIR) + + # in cache already + _eigen3_check_version() + set(EIGEN3_FOUND ${EIGEN3_VERSION_OK}) + +else (EIGEN3_INCLUDE_DIR) + + find_path(EIGEN3_INCLUDE_DIR NAMES signature_of_eigen3_matrix_library + PATHS + ${CMAKE_INSTALL_PREFIX}/include + ${KDE4_INCLUDE_DIR} + PATH_SUFFIXES eigen3 eigen + ) + + if(EIGEN3_INCLUDE_DIR) + _eigen3_check_version() + endif(EIGEN3_INCLUDE_DIR) + + include(FindPackageHandleStandardArgs) + find_package_handle_standard_args(Eigen3 DEFAULT_MSG EIGEN3_INCLUDE_DIR EIGEN3_VERSION_OK) + + mark_as_advanced(EIGEN3_INCLUDE_DIR) + +endif(EIGEN3_INCLUDE_DIR) + diff --git a/plugins/python/pybind11/tools/FindPythonLibsNew.cmake b/plugins/python/pybind11/tools/FindPythonLibsNew.cmake new file mode 100644 index 0000000..b29b287 --- /dev/null +++ b/plugins/python/pybind11/tools/FindPythonLibsNew.cmake @@ -0,0 +1,195 @@ +# - Find python libraries +# This module finds the libraries corresponding to the Python interpreter +# FindPythonInterp provides. +# This code sets the following variables: +# +# PYTHONLIBS_FOUND - have the Python libs been found +# PYTHON_PREFIX - path to the Python installation +# PYTHON_LIBRARIES - path to the python library +# PYTHON_INCLUDE_DIRS - path to where Python.h is found +# PYTHON_MODULE_EXTENSION - lib extension, e.g. '.so' or '.pyd' +# PYTHON_MODULE_PREFIX - lib name prefix: usually an empty string +# PYTHON_SITE_PACKAGES - path to installation site-packages +# PYTHON_IS_DEBUG - whether the Python interpreter is a debug build +# +# Thanks to talljimbo for the patch adding the 'LDVERSION' config +# variable usage. + +#============================================================================= +# Copyright 2001-2009 Kitware, Inc. +# Copyright 2012 Continuum Analytics, Inc. +# +# 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 names of Kitware, Inc., the Insight Software Consortium, +# nor the names of their 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. +#============================================================================= + +# Checking for the extension makes sure that `LibsNew` was found and not just `Libs`. +if(PYTHONLIBS_FOUND AND PYTHON_MODULE_EXTENSION) + return() +endif() + +# Use the Python interpreter to find the libs. +if(PythonLibsNew_FIND_REQUIRED) + find_package(PythonInterp ${PythonLibsNew_FIND_VERSION} REQUIRED) +else() + find_package(PythonInterp ${PythonLibsNew_FIND_VERSION}) +endif() + +if(NOT PYTHONINTERP_FOUND) + set(PYTHONLIBS_FOUND FALSE) + return() +endif() + +# According to http://stackoverflow.com/questions/646518/python-how-to-detect-debug-interpreter +# testing whether sys has the gettotalrefcount function is a reliable, cross-platform +# way to detect a CPython debug interpreter. +# +# The library suffix is from the config var LDVERSION sometimes, otherwise +# VERSION. VERSION will typically be like "2.7" on unix, and "27" on windows. +execute_process(COMMAND "${PYTHON_EXECUTABLE}" "-c" + "from distutils import sysconfig as s;import sys;import struct; +print('.'.join(str(v) for v in sys.version_info)); +print(sys.prefix); +print(s.get_python_inc(plat_specific=True)); +print(s.get_python_lib(plat_specific=True)); +print(s.get_config_var('SO')); +print(hasattr(sys, 'gettotalrefcount')+0); +print(struct.calcsize('@P')); +print(s.get_config_var('LDVERSION') or s.get_config_var('VERSION')); +print(s.get_config_var('LIBDIR') or ''); +print(s.get_config_var('MULTIARCH') or ''); +" + RESULT_VARIABLE _PYTHON_SUCCESS + OUTPUT_VARIABLE _PYTHON_VALUES + ERROR_VARIABLE _PYTHON_ERROR_VALUE) + +if(NOT _PYTHON_SUCCESS MATCHES 0) + if(PythonLibsNew_FIND_REQUIRED) + message(FATAL_ERROR + "Python config failure:\n${_PYTHON_ERROR_VALUE}") + endif() + set(PYTHONLIBS_FOUND FALSE) + return() +endif() + +# Convert the process output into a list +string(REGEX REPLACE ";" "\\\\;" _PYTHON_VALUES ${_PYTHON_VALUES}) +string(REGEX REPLACE "\n" ";" _PYTHON_VALUES ${_PYTHON_VALUES}) +list(GET _PYTHON_VALUES 0 _PYTHON_VERSION_LIST) +list(GET _PYTHON_VALUES 1 PYTHON_PREFIX) +list(GET _PYTHON_VALUES 2 PYTHON_INCLUDE_DIR) +list(GET _PYTHON_VALUES 3 PYTHON_SITE_PACKAGES) +list(GET _PYTHON_VALUES 4 PYTHON_MODULE_EXTENSION) +list(GET _PYTHON_VALUES 5 PYTHON_IS_DEBUG) +list(GET _PYTHON_VALUES 6 PYTHON_SIZEOF_VOID_P) +list(GET _PYTHON_VALUES 7 PYTHON_LIBRARY_SUFFIX) +list(GET _PYTHON_VALUES 8 PYTHON_LIBDIR) +list(GET _PYTHON_VALUES 9 PYTHON_MULTIARCH) + +# Make sure the Python has the same pointer-size as the chosen compiler +# Skip if CMAKE_SIZEOF_VOID_P is not defined +if(CMAKE_SIZEOF_VOID_P AND (NOT "${PYTHON_SIZEOF_VOID_P}" STREQUAL "${CMAKE_SIZEOF_VOID_P}")) + if(PythonLibsNew_FIND_REQUIRED) + math(EXPR _PYTHON_BITS "${PYTHON_SIZEOF_VOID_P} * 8") + math(EXPR _CMAKE_BITS "${CMAKE_SIZEOF_VOID_P} * 8") + message(FATAL_ERROR + "Python config failure: Python is ${_PYTHON_BITS}-bit, " + "chosen compiler is ${_CMAKE_BITS}-bit") + endif() + set(PYTHONLIBS_FOUND FALSE) + return() +endif() + +# The built-in FindPython didn't always give the version numbers +string(REGEX REPLACE "\\." ";" _PYTHON_VERSION_LIST ${_PYTHON_VERSION_LIST}) +list(GET _PYTHON_VERSION_LIST 0 PYTHON_VERSION_MAJOR) +list(GET _PYTHON_VERSION_LIST 1 PYTHON_VERSION_MINOR) +list(GET _PYTHON_VERSION_LIST 2 PYTHON_VERSION_PATCH) + +# Make sure all directory separators are '/' +string(REGEX REPLACE "\\\\" "/" PYTHON_PREFIX ${PYTHON_PREFIX}) +string(REGEX REPLACE "\\\\" "/" PYTHON_INCLUDE_DIR ${PYTHON_INCLUDE_DIR}) +string(REGEX REPLACE "\\\\" "/" PYTHON_SITE_PACKAGES ${PYTHON_SITE_PACKAGES}) + +if(CMAKE_HOST_WIN32) + set(PYTHON_LIBRARY + "${PYTHON_PREFIX}/libs/Python${PYTHON_LIBRARY_SUFFIX}.lib") + + # when run in a venv, PYTHON_PREFIX points to it. But the libraries remain in the + # original python installation. They may be found relative to PYTHON_INCLUDE_DIR. + if(NOT EXISTS "${PYTHON_LIBRARY}") + get_filename_component(_PYTHON_ROOT ${PYTHON_INCLUDE_DIR} DIRECTORY) + set(PYTHON_LIBRARY + "${_PYTHON_ROOT}/libs/Python${PYTHON_LIBRARY_SUFFIX}.lib") + endif() + + # raise an error if the python libs are still not found. + if(NOT EXISTS "${PYTHON_LIBRARY}") + message(FATAL_ERROR "Python libraries not found") + endif() + +else() + if(PYTHON_MULTIARCH) + set(_PYTHON_LIBS_SEARCH "${PYTHON_LIBDIR}/${PYTHON_MULTIARCH}" "${PYTHON_LIBDIR}") + else() + set(_PYTHON_LIBS_SEARCH "${PYTHON_LIBDIR}") + endif() + #message(STATUS "Searching for Python libs in ${_PYTHON_LIBS_SEARCH}") + # Probably this needs to be more involved. It would be nice if the config + # information the python interpreter itself gave us were more complete. + find_library(PYTHON_LIBRARY + NAMES "python${PYTHON_LIBRARY_SUFFIX}" + PATHS ${_PYTHON_LIBS_SEARCH} + NO_DEFAULT_PATH) + + # If all else fails, just set the name/version and let the linker figure out the path. + if(NOT PYTHON_LIBRARY) + set(PYTHON_LIBRARY python${PYTHON_LIBRARY_SUFFIX}) + endif() +endif() + +MARK_AS_ADVANCED( + PYTHON_LIBRARY + PYTHON_INCLUDE_DIR +) + +# We use PYTHON_INCLUDE_DIR, PYTHON_LIBRARY and PYTHON_DEBUG_LIBRARY for the +# cache entries because they are meant to specify the location of a single +# library. We now set the variables listed by the documentation for this +# module. +SET(PYTHON_INCLUDE_DIRS "${PYTHON_INCLUDE_DIR}") +SET(PYTHON_LIBRARIES "${PYTHON_LIBRARY}") +SET(PYTHON_DEBUG_LIBRARIES "${PYTHON_DEBUG_LIBRARY}") + +find_package_message(PYTHON + "Found PythonLibs: ${PYTHON_LIBRARY}" + "${PYTHON_EXECUTABLE}${PYTHON_VERSION}") + +set(PYTHONLIBS_FOUND TRUE) diff --git a/plugins/python/pybind11/tools/check-style.sh b/plugins/python/pybind11/tools/check-style.sh new file mode 100755 index 0000000..0a9f7d2 --- /dev/null +++ b/plugins/python/pybind11/tools/check-style.sh @@ -0,0 +1,70 @@ +#!/bin/bash +# +# Script to check include/test code for common pybind11 code style errors. +# +# This script currently checks for +# +# 1. use of tabs instead of spaces +# 2. MSDOS-style CRLF endings +# 3. trailing spaces +# 4. missing space between keyword and parenthesis, e.g.: for(, if(, while( +# 5. Missing space between right parenthesis and brace, e.g. 'for (...){' +# 6. opening brace on its own line. It should always be on the same line as the +# if/while/for/do statement. +# +# Invoke as: tools/check-style.sh +# + +check_style_errors=0 +IFS=$'\n' + +found="$( GREP_COLORS='mt=41' GREP_COLOR='41' grep $'\t' include tests/*.{cpp,py,h} docs/*.rst -rn --color=always )" +if [ -n "$found" ]; then + # The mt=41 sets a red background for matched tabs: + echo -e '\033[31;01mError: found tab characters in the following files:\033[0m' + check_style_errors=1 + echo "$found" | sed -e 's/^/ /' +fi + + +found="$( grep -IUlr $'\r' include tests/*.{cpp,py,h} docs/*.rst --color=always )" +if [ -n "$found" ]; then + echo -e '\033[31;01mError: found CRLF characters in the following files:\033[0m' + check_style_errors=1 + echo "$found" | sed -e 's/^/ /' +fi + +found="$(GREP_COLORS='mt=41' GREP_COLOR='41' grep '[[:blank:]]\+$' include tests/*.{cpp,py,h} docs/*.rst -rn --color=always )" +if [ -n "$found" ]; then + # The mt=41 sets a red background for matched trailing spaces + echo -e '\033[31;01mError: found trailing spaces in the following files:\033[0m' + check_style_errors=1 + echo "$found" | sed -e 's/^/ /' +fi + +found="$(grep '\<\(if\|for\|while\|catch\)(\|){' include tests/*.{cpp,h} -rn --color=always)" +if [ -n "$found" ]; then + echo -e '\033[31;01mError: found the following coding style problems:\033[0m' + check_style_errors=1 + echo "$found" | sed -e 's/^/ /' +fi + +found="$(awk ' +function prefix(filename, lineno) { + return " \033[35m" filename "\033[36m:\033[32m" lineno "\033[36m:\033[0m" +} +function mark(pattern, string) { sub(pattern, "\033[01;31m&\033[0m", string); return string } +last && /^\s*{/ { + print prefix(FILENAME, FNR-1) mark("\\)\\s*$", last) + print prefix(FILENAME, FNR) mark("^\\s*{", $0) + last="" +} +{ last = /(if|for|while|catch|switch)\s*\(.*\)\s*$/ ? $0 : "" } +' $(find include -type f) tests/*.{cpp,h} docs/*.rst)" +if [ -n "$found" ]; then + check_style_errors=1 + echo -e '\033[31;01mError: braces should occur on the same line as the if/while/.. statement. Found issues in the following files:\033[0m' + echo "$found" +fi + +exit $check_style_errors diff --git a/plugins/python/pybind11/tools/clang/LICENSE.TXT b/plugins/python/pybind11/tools/clang/LICENSE.TXT new file mode 100644 index 0000000..6c224f8 --- /dev/null +++ b/plugins/python/pybind11/tools/clang/LICENSE.TXT @@ -0,0 +1,63 @@ +============================================================================== +LLVM Release License +============================================================================== +University of Illinois/NCSA +Open Source License + +Copyright (c) 2007-2012 University of Illinois at Urbana-Champaign. +All rights reserved. + +Developed by: + + LLVM Team + + University of Illinois at Urbana-Champaign + + http://llvm.org + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal with +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimers. + + * Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimers in the + documentation and/or other materials provided with the distribution. + + * Neither the names of the LLVM Team, University of Illinois at + Urbana-Champaign, nor the names of its contributors may be used to + endorse or promote products derived from this Software without specific + prior written permission. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE +SOFTWARE. + +============================================================================== +The LLVM software contains code written by third parties. Such software will +have its own individual LICENSE.TXT file in the directory in which it appears. +This file will describe the copyrights, license, and restrictions which apply +to that code. + +The disclaimer of warranty in the University of Illinois Open Source License +applies to all code in the LLVM Distribution, and nothing in any of the +other licenses gives permission to use the names of the LLVM Team or the +University of Illinois to endorse or promote products derived from this +Software. + +The following pieces of software have additional or alternate copyrights, +licenses, and/or restrictions: + +Program Directory +------- --------- + + diff --git a/plugins/python/pybind11/tools/clang/README.md b/plugins/python/pybind11/tools/clang/README.md new file mode 100644 index 0000000..efb8921 --- /dev/null +++ b/plugins/python/pybind11/tools/clang/README.md @@ -0,0 +1,2 @@ +This is simply clang's Python bindings (clang.cindex) ported to Python 3. Please see http://llvm.org/svn/llvm-project/cfe/trunk/bindings/python/ for the original project. + diff --git a/plugins/python/pybind11/tools/clang/__init__.py b/plugins/python/pybind11/tools/clang/__init__.py new file mode 100644 index 0000000..88f3081 --- /dev/null +++ b/plugins/python/pybind11/tools/clang/__init__.py @@ -0,0 +1,24 @@ +#===- __init__.py - Clang Python Bindings --------------------*- python -*--===# +# +# The LLVM Compiler Infrastructure +# +# This file is distributed under the University of Illinois Open Source +# License. See LICENSE.TXT for details. +# +#===------------------------------------------------------------------------===# + +r""" +Clang Library Bindings +====================== + +This package provides access to the Clang compiler and libraries. + +The available modules are: + + cindex + + Bindings for the Clang indexing library. +""" + +__all__ = ['cindex'] + diff --git a/plugins/python/pybind11/tools/clang/cindex.py b/plugins/python/pybind11/tools/clang/cindex.py new file mode 100644 index 0000000..3a083de --- /dev/null +++ b/plugins/python/pybind11/tools/clang/cindex.py @@ -0,0 +1,3884 @@ +#===- cindex.py - Python Indexing Library Bindings -----------*- python -*--===# +# +# The LLVM Compiler Infrastructure +# +# This file is distributed under the University of Illinois Open Source +# License. See LICENSE.TXT for details. +# +#===------------------------------------------------------------------------===# + +r""" +Clang Indexing Library Bindings +=============================== + +This module provides an interface to the Clang indexing library. It is a +low-level interface to the indexing library which attempts to match the Clang +API directly while also being "pythonic". Notable differences from the C API +are: + + * string results are returned as Python strings, not CXString objects. + + * null cursors are translated to None. + + * access to child cursors is done via iteration, not visitation. + +The major indexing objects are: + + Index + + The top-level object which manages some global library state. + + TranslationUnit + + High-level object encapsulating the AST for a single translation unit. These + can be loaded from .ast files or parsed on the fly. + + Cursor + + Generic object for representing a node in the AST. + + SourceRange, SourceLocation, and File + + Objects representing information about the input source. + +Most object information is exposed using properties, when the underlying API +call is efficient. +""" + +# TODO +# ==== +# +# o API support for invalid translation units. Currently we can't even get the +# diagnostics on failure because they refer to locations in an object that +# will have been invalidated. +# +# o fix memory management issues (currently client must hold on to index and +# translation unit, or risk crashes). +# +# o expose code completion APIs. +# +# o cleanup ctypes wrapping, would be nice to separate the ctypes details more +# clearly, and hide from the external interface (i.e., help(cindex)). +# +# o implement additional SourceLocation, SourceRange, and File methods. + +from ctypes import * +import collections + +import clang.enumerations + +# ctypes doesn't implicitly convert c_void_p to the appropriate wrapper +# object. This is a problem, because it means that from_parameter will see an +# integer and pass the wrong value on platforms where int != void*. Work around +# this by marshalling object arguments as void**. +c_object_p = POINTER(c_void_p) + +callbacks = {} + +### Exception Classes ### + +class TranslationUnitLoadError(Exception): + """Represents an error that occurred when loading a TranslationUnit. + + This is raised in the case where a TranslationUnit could not be + instantiated due to failure in the libclang library. + + FIXME: Make libclang expose additional error information in this scenario. + """ + pass + +class TranslationUnitSaveError(Exception): + """Represents an error that occurred when saving a TranslationUnit. + + Each error has associated with it an enumerated value, accessible under + e.save_error. Consumers can compare the value with one of the ERROR_ + constants in this class. + """ + + # Indicates that an unknown error occurred. This typically indicates that + # I/O failed during save. + ERROR_UNKNOWN = 1 + + # Indicates that errors during translation prevented saving. The errors + # should be available via the TranslationUnit's diagnostics. + ERROR_TRANSLATION_ERRORS = 2 + + # Indicates that the translation unit was somehow invalid. + ERROR_INVALID_TU = 3 + + def __init__(self, enumeration, message): + assert isinstance(enumeration, int) + + if enumeration < 1 or enumeration > 3: + raise Exception("Encountered undefined TranslationUnit save error " + "constant: %d. Please file a bug to have this " + "value supported." % enumeration) + + self.save_error = enumeration + Exception.__init__(self, 'Error %d: %s' % (enumeration, message)) + +### Structures and Utility Classes ### + +class CachedProperty(object): + """Decorator that lazy-loads the value of a property. + + The first time the property is accessed, the original property function is + executed. The value it returns is set as the new value of that instance's + property, replacing the original method. + """ + + def __init__(self, wrapped): + self.wrapped = wrapped + try: + self.__doc__ = wrapped.__doc__ + except: + pass + + def __get__(self, instance, instance_type=None): + if instance is None: + return self + + value = self.wrapped(instance) + setattr(instance, self.wrapped.__name__, value) + + return value + + +class _CXString(Structure): + """Helper for transforming CXString results.""" + + _fields_ = [("spelling", c_char_p), ("free", c_int)] + + def __del__(self): + conf.lib.clang_disposeString(self) + + @staticmethod + def from_result(res, fn, args): + assert isinstance(res, _CXString) + return conf.lib.clang_getCString(res) + +class SourceLocation(Structure): + """ + A SourceLocation represents a particular location within a source file. + """ + _fields_ = [("ptr_data", c_void_p * 2), ("int_data", c_uint)] + _data = None + + def _get_instantiation(self): + if self._data is None: + f, l, c, o = c_object_p(), c_uint(), c_uint(), c_uint() + conf.lib.clang_getInstantiationLocation(self, byref(f), byref(l), + byref(c), byref(o)) + if f: + f = File(f) + else: + f = None + self._data = (f, int(l.value), int(c.value), int(o.value)) + return self._data + + @staticmethod + def from_position(tu, file, line, column): + """ + Retrieve the source location associated with a given file/line/column in + a particular translation unit. + """ + return conf.lib.clang_getLocation(tu, file, line, column) + + @staticmethod + def from_offset(tu, file, offset): + """Retrieve a SourceLocation from a given character offset. + + tu -- TranslationUnit file belongs to + file -- File instance to obtain offset from + offset -- Integer character offset within file + """ + return conf.lib.clang_getLocationForOffset(tu, file, offset) + + @property + def file(self): + """Get the file represented by this source location.""" + return self._get_instantiation()[0] + + @property + def line(self): + """Get the line represented by this source location.""" + return self._get_instantiation()[1] + + @property + def column(self): + """Get the column represented by this source location.""" + return self._get_instantiation()[2] + + @property + def offset(self): + """Get the file offset represented by this source location.""" + return self._get_instantiation()[3] + + def __eq__(self, other): + return conf.lib.clang_equalLocations(self, other) + + def __ne__(self, other): + return not self.__eq__(other) + + def __repr__(self): + if self.file: + filename = self.file.name + else: + filename = None + return "" % ( + filename, self.line, self.column) + +class SourceRange(Structure): + """ + A SourceRange describes a range of source locations within the source + code. + """ + _fields_ = [ + ("ptr_data", c_void_p * 2), + ("begin_int_data", c_uint), + ("end_int_data", c_uint)] + + # FIXME: Eliminate this and make normal constructor? Requires hiding ctypes + # object. + @staticmethod + def from_locations(start, end): + return conf.lib.clang_getRange(start, end) + + @property + def start(self): + """ + Return a SourceLocation representing the first character within a + source range. + """ + return conf.lib.clang_getRangeStart(self) + + @property + def end(self): + """ + Return a SourceLocation representing the last character within a + source range. + """ + return conf.lib.clang_getRangeEnd(self) + + def __eq__(self, other): + return conf.lib.clang_equalRanges(self, other) + + def __ne__(self, other): + return not self.__eq__(other) + + def __contains__(self, other): + """Useful to detect the Token/Lexer bug""" + if not isinstance(other, SourceLocation): + return False + if other.file is None and self.start.file is None: + pass + elif ( self.start.file.name != other.file.name or + other.file.name != self.end.file.name): + # same file name + return False + # same file, in between lines + if self.start.line < other.line < self.end.line: + return True + elif self.start.line == other.line: + # same file first line + if self.start.column <= other.column: + return True + elif other.line == self.end.line: + # same file last line + if other.column <= self.end.column: + return True + return False + + def __repr__(self): + return "" % (self.start, self.end) + +class Diagnostic(object): + """ + A Diagnostic is a single instance of a Clang diagnostic. It includes the + diagnostic severity, the message, the location the diagnostic occurred, as + well as additional source ranges and associated fix-it hints. + """ + + Ignored = 0 + Note = 1 + Warning = 2 + Error = 3 + Fatal = 4 + + def __init__(self, ptr): + self.ptr = ptr + + def __del__(self): + conf.lib.clang_disposeDiagnostic(self) + + @property + def severity(self): + return conf.lib.clang_getDiagnosticSeverity(self) + + @property + def location(self): + return conf.lib.clang_getDiagnosticLocation(self) + + @property + def spelling(self): + return conf.lib.clang_getDiagnosticSpelling(self) + + @property + def ranges(self): + class RangeIterator: + def __init__(self, diag): + self.diag = diag + + def __len__(self): + return int(conf.lib.clang_getDiagnosticNumRanges(self.diag)) + + def __getitem__(self, key): + if (key >= len(self)): + raise IndexError + return conf.lib.clang_getDiagnosticRange(self.diag, key) + + return RangeIterator(self) + + @property + def fixits(self): + class FixItIterator: + def __init__(self, diag): + self.diag = diag + + def __len__(self): + return int(conf.lib.clang_getDiagnosticNumFixIts(self.diag)) + + def __getitem__(self, key): + range = SourceRange() + value = conf.lib.clang_getDiagnosticFixIt(self.diag, key, + byref(range)) + if len(value) == 0: + raise IndexError + + return FixIt(range, value) + + return FixItIterator(self) + + @property + def children(self): + class ChildDiagnosticsIterator: + def __init__(self, diag): + self.diag_set = conf.lib.clang_getChildDiagnostics(diag) + + def __len__(self): + return int(conf.lib.clang_getNumDiagnosticsInSet(self.diag_set)) + + def __getitem__(self, key): + diag = conf.lib.clang_getDiagnosticInSet(self.diag_set, key) + if not diag: + raise IndexError + return Diagnostic(diag) + + return ChildDiagnosticsIterator(self) + + @property + def category_number(self): + """The category number for this diagnostic or 0 if unavailable.""" + return conf.lib.clang_getDiagnosticCategory(self) + + @property + def category_name(self): + """The string name of the category for this diagnostic.""" + return conf.lib.clang_getDiagnosticCategoryText(self) + + @property + def option(self): + """The command-line option that enables this diagnostic.""" + return conf.lib.clang_getDiagnosticOption(self, None) + + @property + def disable_option(self): + """The command-line option that disables this diagnostic.""" + disable = _CXString() + conf.lib.clang_getDiagnosticOption(self, byref(disable)) + + return conf.lib.clang_getCString(disable) + + def __repr__(self): + return "" % ( + self.severity, self.location, self.spelling) + + def from_param(self): + return self.ptr + +class FixIt(object): + """ + A FixIt represents a transformation to be applied to the source to + "fix-it". The fix-it shouldbe applied by replacing the given source range + with the given value. + """ + + def __init__(self, range, value): + self.range = range + self.value = value + + def __repr__(self): + return "" % (self.range, self.value) + +class TokenGroup(object): + """Helper class to facilitate token management. + + Tokens are allocated from libclang in chunks. They must be disposed of as a + collective group. + + One purpose of this class is for instances to represent groups of allocated + tokens. Each token in a group contains a reference back to an instance of + this class. When all tokens from a group are garbage collected, it allows + this class to be garbage collected. When this class is garbage collected, + it calls the libclang destructor which invalidates all tokens in the group. + + You should not instantiate this class outside of this module. + """ + def __init__(self, tu, memory, count): + self._tu = tu + self._memory = memory + self._count = count + + def __del__(self): + conf.lib.clang_disposeTokens(self._tu, self._memory, self._count) + + @staticmethod + def get_tokens(tu, extent): + """Helper method to return all tokens in an extent. + + This functionality is needed multiple places in this module. We define + it here because it seems like a logical place. + """ + tokens_memory = POINTER(Token)() + tokens_count = c_uint() + + conf.lib.clang_tokenize(tu, extent, byref(tokens_memory), + byref(tokens_count)) + + count = int(tokens_count.value) + + # If we get no tokens, no memory was allocated. Be sure not to return + # anything and potentially call a destructor on nothing. + if count < 1: + return + + tokens_array = cast(tokens_memory, POINTER(Token * count)).contents + + token_group = TokenGroup(tu, tokens_memory, tokens_count) + + for i in range(0, count): + token = Token() + token.int_data = tokens_array[i].int_data + token.ptr_data = tokens_array[i].ptr_data + token._tu = tu + token._group = token_group + + yield token + +class TokenKind(object): + """Describes a specific type of a Token.""" + + _value_map = {} # int -> TokenKind + + def __init__(self, value, name): + """Create a new TokenKind instance from a numeric value and a name.""" + self.value = value + self.name = name + + def __repr__(self): + return 'TokenKind.%s' % (self.name,) + + @staticmethod + def from_value(value): + """Obtain a registered TokenKind instance from its value.""" + result = TokenKind._value_map.get(value, None) + + if result is None: + raise ValueError('Unknown TokenKind: %d' % value) + + return result + + @staticmethod + def register(value, name): + """Register a new TokenKind enumeration. + + This should only be called at module load time by code within this + package. + """ + if value in TokenKind._value_map: + raise ValueError('TokenKind already registered: %d' % value) + + kind = TokenKind(value, name) + TokenKind._value_map[value] = kind + setattr(TokenKind, name, kind) + +### Cursor Kinds ### +class BaseEnumeration(object): + """ + Common base class for named enumerations held in sync with Index.h values. + + Subclasses must define their own _kinds and _name_map members, as: + _kinds = [] + _name_map = None + These values hold the per-subclass instances and value-to-name mappings, + respectively. + + """ + + def __init__(self, value): + if value >= len(self.__class__._kinds): + self.__class__._kinds += [None] * (value - len(self.__class__._kinds) + 1) + if self.__class__._kinds[value] is not None: + raise ValueError('{0} value {1} already loaded'.format( + str(self.__class__), value)) + self.value = value + self.__class__._kinds[value] = self + self.__class__._name_map = None + + + def from_param(self): + return self.value + + @property + def name(self): + """Get the enumeration name of this cursor kind.""" + if self._name_map is None: + self._name_map = {} + for key, value in list(self.__class__.__dict__.items()): + if isinstance(value, self.__class__): + self._name_map[value] = key + return self._name_map[self] + + @classmethod + def from_id(cls, id): + if id >= len(cls._kinds) or cls._kinds[id] is None: + raise ValueError('Unknown template argument kind %d' % id) + return cls._kinds[id] + + def __repr__(self): + return '%s.%s' % (self.__class__, self.name,) + + +class CursorKind(BaseEnumeration): + """ + A CursorKind describes the kind of entity that a cursor points to. + """ + + # The required BaseEnumeration declarations. + _kinds = [] + _name_map = None + + @staticmethod + def get_all_kinds(): + """Return all CursorKind enumeration instances.""" + return [_f for _f in CursorKind._kinds if _f] + + def is_declaration(self): + """Test if this is a declaration kind.""" + return conf.lib.clang_isDeclaration(self) + + def is_reference(self): + """Test if this is a reference kind.""" + return conf.lib.clang_isReference(self) + + def is_expression(self): + """Test if this is an expression kind.""" + return conf.lib.clang_isExpression(self) + + def is_statement(self): + """Test if this is a statement kind.""" + return conf.lib.clang_isStatement(self) + + def is_attribute(self): + """Test if this is an attribute kind.""" + return conf.lib.clang_isAttribute(self) + + def is_invalid(self): + """Test if this is an invalid kind.""" + return conf.lib.clang_isInvalid(self) + + def is_translation_unit(self): + """Test if this is a translation unit kind.""" + return conf.lib.clang_isTranslationUnit(self) + + def is_preprocessing(self): + """Test if this is a preprocessing kind.""" + return conf.lib.clang_isPreprocessing(self) + + def is_unexposed(self): + """Test if this is an unexposed kind.""" + return conf.lib.clang_isUnexposed(self) + + def __repr__(self): + return 'CursorKind.%s' % (self.name,) + +### +# Declaration Kinds + +# A declaration whose specific kind is not exposed via this interface. +# +# Unexposed declarations have the same operations as any other kind of +# declaration; one can extract their location information, spelling, find their +# definitions, etc. However, the specific kind of the declaration is not +# reported. +CursorKind.UNEXPOSED_DECL = CursorKind(1) + +# A C or C++ struct. +CursorKind.STRUCT_DECL = CursorKind(2) + +# A C or C++ union. +CursorKind.UNION_DECL = CursorKind(3) + +# A C++ class. +CursorKind.CLASS_DECL = CursorKind(4) + +# An enumeration. +CursorKind.ENUM_DECL = CursorKind(5) + +# A field (in C) or non-static data member (in C++) in a struct, union, or C++ +# class. +CursorKind.FIELD_DECL = CursorKind(6) + +# An enumerator constant. +CursorKind.ENUM_CONSTANT_DECL = CursorKind(7) + +# A function. +CursorKind.FUNCTION_DECL = CursorKind(8) + +# A variable. +CursorKind.VAR_DECL = CursorKind(9) + +# A function or method parameter. +CursorKind.PARM_DECL = CursorKind(10) + +# An Objective-C @interface. +CursorKind.OBJC_INTERFACE_DECL = CursorKind(11) + +# An Objective-C @interface for a category. +CursorKind.OBJC_CATEGORY_DECL = CursorKind(12) + +# An Objective-C @protocol declaration. +CursorKind.OBJC_PROTOCOL_DECL = CursorKind(13) + +# An Objective-C @property declaration. +CursorKind.OBJC_PROPERTY_DECL = CursorKind(14) + +# An Objective-C instance variable. +CursorKind.OBJC_IVAR_DECL = CursorKind(15) + +# An Objective-C instance method. +CursorKind.OBJC_INSTANCE_METHOD_DECL = CursorKind(16) + +# An Objective-C class method. +CursorKind.OBJC_CLASS_METHOD_DECL = CursorKind(17) + +# An Objective-C @implementation. +CursorKind.OBJC_IMPLEMENTATION_DECL = CursorKind(18) + +# An Objective-C @implementation for a category. +CursorKind.OBJC_CATEGORY_IMPL_DECL = CursorKind(19) + +# A typedef. +CursorKind.TYPEDEF_DECL = CursorKind(20) + +# A C++ class method. +CursorKind.CXX_METHOD = CursorKind(21) + +# A C++ namespace. +CursorKind.NAMESPACE = CursorKind(22) + +# A linkage specification, e.g. 'extern "C"'. +CursorKind.LINKAGE_SPEC = CursorKind(23) + +# A C++ constructor. +CursorKind.CONSTRUCTOR = CursorKind(24) + +# A C++ destructor. +CursorKind.DESTRUCTOR = CursorKind(25) + +# A C++ conversion function. +CursorKind.CONVERSION_FUNCTION = CursorKind(26) + +# A C++ template type parameter +CursorKind.TEMPLATE_TYPE_PARAMETER = CursorKind(27) + +# A C++ non-type template paramater. +CursorKind.TEMPLATE_NON_TYPE_PARAMETER = CursorKind(28) + +# A C++ template template parameter. +CursorKind.TEMPLATE_TEMPLATE_PARAMETER = CursorKind(29) + +# A C++ function template. +CursorKind.FUNCTION_TEMPLATE = CursorKind(30) + +# A C++ class template. +CursorKind.CLASS_TEMPLATE = CursorKind(31) + +# A C++ class template partial specialization. +CursorKind.CLASS_TEMPLATE_PARTIAL_SPECIALIZATION = CursorKind(32) + +# A C++ namespace alias declaration. +CursorKind.NAMESPACE_ALIAS = CursorKind(33) + +# A C++ using directive +CursorKind.USING_DIRECTIVE = CursorKind(34) + +# A C++ using declaration +CursorKind.USING_DECLARATION = CursorKind(35) + +# A Type alias decl. +CursorKind.TYPE_ALIAS_DECL = CursorKind(36) + +# A Objective-C synthesize decl +CursorKind.OBJC_SYNTHESIZE_DECL = CursorKind(37) + +# A Objective-C dynamic decl +CursorKind.OBJC_DYNAMIC_DECL = CursorKind(38) + +# A C++ access specifier decl. +CursorKind.CXX_ACCESS_SPEC_DECL = CursorKind(39) + + +### +# Reference Kinds + +CursorKind.OBJC_SUPER_CLASS_REF = CursorKind(40) +CursorKind.OBJC_PROTOCOL_REF = CursorKind(41) +CursorKind.OBJC_CLASS_REF = CursorKind(42) + +# A reference to a type declaration. +# +# A type reference occurs anywhere where a type is named but not +# declared. For example, given: +# typedef unsigned size_type; +# size_type size; +# +# The typedef is a declaration of size_type (CXCursor_TypedefDecl), +# while the type of the variable "size" is referenced. The cursor +# referenced by the type of size is the typedef for size_type. +CursorKind.TYPE_REF = CursorKind(43) +CursorKind.CXX_BASE_SPECIFIER = CursorKind(44) + +# A reference to a class template, function template, template +# template parameter, or class template partial specialization. +CursorKind.TEMPLATE_REF = CursorKind(45) + +# A reference to a namespace or namepsace alias. +CursorKind.NAMESPACE_REF = CursorKind(46) + +# A reference to a member of a struct, union, or class that occurs in +# some non-expression context, e.g., a designated initializer. +CursorKind.MEMBER_REF = CursorKind(47) + +# A reference to a labeled statement. +CursorKind.LABEL_REF = CursorKind(48) + +# A reference to a set of overloaded functions or function templates +# that has not yet been resolved to a specific function or function template. +CursorKind.OVERLOADED_DECL_REF = CursorKind(49) + +# A reference to a variable that occurs in some non-expression +# context, e.g., a C++ lambda capture list. +CursorKind.VARIABLE_REF = CursorKind(50) + +### +# Invalid/Error Kinds + +CursorKind.INVALID_FILE = CursorKind(70) +CursorKind.NO_DECL_FOUND = CursorKind(71) +CursorKind.NOT_IMPLEMENTED = CursorKind(72) +CursorKind.INVALID_CODE = CursorKind(73) + +### +# Expression Kinds + +# An expression whose specific kind is not exposed via this interface. +# +# Unexposed expressions have the same operations as any other kind of +# expression; one can extract their location information, spelling, children, +# etc. However, the specific kind of the expression is not reported. +CursorKind.UNEXPOSED_EXPR = CursorKind(100) + +# An expression that refers to some value declaration, such as a function, +# varible, or enumerator. +CursorKind.DECL_REF_EXPR = CursorKind(101) + +# An expression that refers to a member of a struct, union, class, Objective-C +# class, etc. +CursorKind.MEMBER_REF_EXPR = CursorKind(102) + +# An expression that calls a function. +CursorKind.CALL_EXPR = CursorKind(103) + +# An expression that sends a message to an Objective-C object or class. +CursorKind.OBJC_MESSAGE_EXPR = CursorKind(104) + +# An expression that represents a block literal. +CursorKind.BLOCK_EXPR = CursorKind(105) + +# An integer literal. +CursorKind.INTEGER_LITERAL = CursorKind(106) + +# A floating point number literal. +CursorKind.FLOATING_LITERAL = CursorKind(107) + +# An imaginary number literal. +CursorKind.IMAGINARY_LITERAL = CursorKind(108) + +# A string literal. +CursorKind.STRING_LITERAL = CursorKind(109) + +# A character literal. +CursorKind.CHARACTER_LITERAL = CursorKind(110) + +# A parenthesized expression, e.g. "(1)". +# +# This AST node is only formed if full location information is requested. +CursorKind.PAREN_EXPR = CursorKind(111) + +# This represents the unary-expression's (except sizeof and +# alignof). +CursorKind.UNARY_OPERATOR = CursorKind(112) + +# [C99 6.5.2.1] Array Subscripting. +CursorKind.ARRAY_SUBSCRIPT_EXPR = CursorKind(113) + +# A builtin binary operation expression such as "x + y" or +# "x <= y". +CursorKind.BINARY_OPERATOR = CursorKind(114) + +# Compound assignment such as "+=". +CursorKind.COMPOUND_ASSIGNMENT_OPERATOR = CursorKind(115) + +# The ?: ternary operator. +CursorKind.CONDITIONAL_OPERATOR = CursorKind(116) + +# An explicit cast in C (C99 6.5.4) or a C-style cast in C++ +# (C++ [expr.cast]), which uses the syntax (Type)expr. +# +# For example: (int)f. +CursorKind.CSTYLE_CAST_EXPR = CursorKind(117) + +# [C99 6.5.2.5] +CursorKind.COMPOUND_LITERAL_EXPR = CursorKind(118) + +# Describes an C or C++ initializer list. +CursorKind.INIT_LIST_EXPR = CursorKind(119) + +# The GNU address of label extension, representing &&label. +CursorKind.ADDR_LABEL_EXPR = CursorKind(120) + +# This is the GNU Statement Expression extension: ({int X=4; X;}) +CursorKind.StmtExpr = CursorKind(121) + +# Represents a C11 generic selection. +CursorKind.GENERIC_SELECTION_EXPR = CursorKind(122) + +# Implements the GNU __null extension, which is a name for a null +# pointer constant that has integral type (e.g., int or long) and is the same +# size and alignment as a pointer. +# +# The __null extension is typically only used by system headers, which define +# NULL as __null in C++ rather than using 0 (which is an integer that may not +# match the size of a pointer). +CursorKind.GNU_NULL_EXPR = CursorKind(123) + +# C++'s static_cast<> expression. +CursorKind.CXX_STATIC_CAST_EXPR = CursorKind(124) + +# C++'s dynamic_cast<> expression. +CursorKind.CXX_DYNAMIC_CAST_EXPR = CursorKind(125) + +# C++'s reinterpret_cast<> expression. +CursorKind.CXX_REINTERPRET_CAST_EXPR = CursorKind(126) + +# C++'s const_cast<> expression. +CursorKind.CXX_CONST_CAST_EXPR = CursorKind(127) + +# Represents an explicit C++ type conversion that uses "functional" +# notion (C++ [expr.type.conv]). +# +# Example: +# \code +# x = int(0.5); +# \endcode +CursorKind.CXX_FUNCTIONAL_CAST_EXPR = CursorKind(128) + +# A C++ typeid expression (C++ [expr.typeid]). +CursorKind.CXX_TYPEID_EXPR = CursorKind(129) + +# [C++ 2.13.5] C++ Boolean Literal. +CursorKind.CXX_BOOL_LITERAL_EXPR = CursorKind(130) + +# [C++0x 2.14.7] C++ Pointer Literal. +CursorKind.CXX_NULL_PTR_LITERAL_EXPR = CursorKind(131) + +# Represents the "this" expression in C++ +CursorKind.CXX_THIS_EXPR = CursorKind(132) + +# [C++ 15] C++ Throw Expression. +# +# This handles 'throw' and 'throw' assignment-expression. When +# assignment-expression isn't present, Op will be null. +CursorKind.CXX_THROW_EXPR = CursorKind(133) + +# A new expression for memory allocation and constructor calls, e.g: +# "new CXXNewExpr(foo)". +CursorKind.CXX_NEW_EXPR = CursorKind(134) + +# A delete expression for memory deallocation and destructor calls, +# e.g. "delete[] pArray". +CursorKind.CXX_DELETE_EXPR = CursorKind(135) + +# Represents a unary expression. +CursorKind.CXX_UNARY_EXPR = CursorKind(136) + +# ObjCStringLiteral, used for Objective-C string literals i.e. "foo". +CursorKind.OBJC_STRING_LITERAL = CursorKind(137) + +# ObjCEncodeExpr, used for in Objective-C. +CursorKind.OBJC_ENCODE_EXPR = CursorKind(138) + +# ObjCSelectorExpr used for in Objective-C. +CursorKind.OBJC_SELECTOR_EXPR = CursorKind(139) + +# Objective-C's protocol expression. +CursorKind.OBJC_PROTOCOL_EXPR = CursorKind(140) + +# An Objective-C "bridged" cast expression, which casts between +# Objective-C pointers and C pointers, transferring ownership in the process. +# +# \code +# NSString *str = (__bridge_transfer NSString *)CFCreateString(); +# \endcode +CursorKind.OBJC_BRIDGE_CAST_EXPR = CursorKind(141) + +# Represents a C++0x pack expansion that produces a sequence of +# expressions. +# +# A pack expansion expression contains a pattern (which itself is an +# expression) followed by an ellipsis. For example: +CursorKind.PACK_EXPANSION_EXPR = CursorKind(142) + +# Represents an expression that computes the length of a parameter +# pack. +CursorKind.SIZE_OF_PACK_EXPR = CursorKind(143) + +# Represents a C++ lambda expression that produces a local function +# object. +# +# \code +# void abssort(float *x, unsigned N) { +# std::sort(x, x + N, +# [](float a, float b) { +# return std::abs(a) < std::abs(b); +# }); +# } +# \endcode +CursorKind.LAMBDA_EXPR = CursorKind(144) + +# Objective-c Boolean Literal. +CursorKind.OBJ_BOOL_LITERAL_EXPR = CursorKind(145) + +# Represents the "self" expression in a ObjC method. +CursorKind.OBJ_SELF_EXPR = CursorKind(146) + + +# A statement whose specific kind is not exposed via this interface. +# +# Unexposed statements have the same operations as any other kind of statement; +# one can extract their location information, spelling, children, etc. However, +# the specific kind of the statement is not reported. +CursorKind.UNEXPOSED_STMT = CursorKind(200) + +# A labelled statement in a function. +CursorKind.LABEL_STMT = CursorKind(201) + +# A compound statement +CursorKind.COMPOUND_STMT = CursorKind(202) + +# A case statement. +CursorKind.CASE_STMT = CursorKind(203) + +# A default statement. +CursorKind.DEFAULT_STMT = CursorKind(204) + +# An if statement. +CursorKind.IF_STMT = CursorKind(205) + +# A switch statement. +CursorKind.SWITCH_STMT = CursorKind(206) + +# A while statement. +CursorKind.WHILE_STMT = CursorKind(207) + +# A do statement. +CursorKind.DO_STMT = CursorKind(208) + +# A for statement. +CursorKind.FOR_STMT = CursorKind(209) + +# A goto statement. +CursorKind.GOTO_STMT = CursorKind(210) + +# An indirect goto statement. +CursorKind.INDIRECT_GOTO_STMT = CursorKind(211) + +# A continue statement. +CursorKind.CONTINUE_STMT = CursorKind(212) + +# A break statement. +CursorKind.BREAK_STMT = CursorKind(213) + +# A return statement. +CursorKind.RETURN_STMT = CursorKind(214) + +# A GNU-style inline assembler statement. +CursorKind.ASM_STMT = CursorKind(215) + +# Objective-C's overall @try-@catch-@finally statement. +CursorKind.OBJC_AT_TRY_STMT = CursorKind(216) + +# Objective-C's @catch statement. +CursorKind.OBJC_AT_CATCH_STMT = CursorKind(217) + +# Objective-C's @finally statement. +CursorKind.OBJC_AT_FINALLY_STMT = CursorKind(218) + +# Objective-C's @throw statement. +CursorKind.OBJC_AT_THROW_STMT = CursorKind(219) + +# Objective-C's @synchronized statement. +CursorKind.OBJC_AT_SYNCHRONIZED_STMT = CursorKind(220) + +# Objective-C's autorealease pool statement. +CursorKind.OBJC_AUTORELEASE_POOL_STMT = CursorKind(221) + +# Objective-C's for collection statement. +CursorKind.OBJC_FOR_COLLECTION_STMT = CursorKind(222) + +# C++'s catch statement. +CursorKind.CXX_CATCH_STMT = CursorKind(223) + +# C++'s try statement. +CursorKind.CXX_TRY_STMT = CursorKind(224) + +# C++'s for (* : *) statement. +CursorKind.CXX_FOR_RANGE_STMT = CursorKind(225) + +# Windows Structured Exception Handling's try statement. +CursorKind.SEH_TRY_STMT = CursorKind(226) + +# Windows Structured Exception Handling's except statement. +CursorKind.SEH_EXCEPT_STMT = CursorKind(227) + +# Windows Structured Exception Handling's finally statement. +CursorKind.SEH_FINALLY_STMT = CursorKind(228) + +# A MS inline assembly statement extension. +CursorKind.MS_ASM_STMT = CursorKind(229) + +# The null statement. +CursorKind.NULL_STMT = CursorKind(230) + +# Adaptor class for mixing declarations with statements and expressions. +CursorKind.DECL_STMT = CursorKind(231) + +# OpenMP parallel directive. +CursorKind.OMP_PARALLEL_DIRECTIVE = CursorKind(232) + +# OpenMP SIMD directive. +CursorKind.OMP_SIMD_DIRECTIVE = CursorKind(233) + +# OpenMP for directive. +CursorKind.OMP_FOR_DIRECTIVE = CursorKind(234) + +# OpenMP sections directive. +CursorKind.OMP_SECTIONS_DIRECTIVE = CursorKind(235) + +# OpenMP section directive. +CursorKind.OMP_SECTION_DIRECTIVE = CursorKind(236) + +# OpenMP single directive. +CursorKind.OMP_SINGLE_DIRECTIVE = CursorKind(237) + +# OpenMP parallel for directive. +CursorKind.OMP_PARALLEL_FOR_DIRECTIVE = CursorKind(238) + +# OpenMP parallel sections directive. +CursorKind.OMP_PARALLEL_SECTIONS_DIRECTIVE = CursorKind(239) + +# OpenMP task directive. +CursorKind.OMP_TASK_DIRECTIVE = CursorKind(240) + +# OpenMP master directive. +CursorKind.OMP_MASTER_DIRECTIVE = CursorKind(241) + +# OpenMP critical directive. +CursorKind.OMP_CRITICAL_DIRECTIVE = CursorKind(242) + +# OpenMP taskyield directive. +CursorKind.OMP_TASKYIELD_DIRECTIVE = CursorKind(243) + +# OpenMP barrier directive. +CursorKind.OMP_BARRIER_DIRECTIVE = CursorKind(244) + +# OpenMP taskwait directive. +CursorKind.OMP_TASKWAIT_DIRECTIVE = CursorKind(245) + +# OpenMP flush directive. +CursorKind.OMP_FLUSH_DIRECTIVE = CursorKind(246) + +# Windows Structured Exception Handling's leave statement. +CursorKind.SEH_LEAVE_STMT = CursorKind(247) + +# OpenMP ordered directive. +CursorKind.OMP_ORDERED_DIRECTIVE = CursorKind(248) + +# OpenMP atomic directive. +CursorKind.OMP_ATOMIC_DIRECTIVE = CursorKind(249) + +# OpenMP for SIMD directive. +CursorKind.OMP_FOR_SIMD_DIRECTIVE = CursorKind(250) + +# OpenMP parallel for SIMD directive. +CursorKind.OMP_PARALLELFORSIMD_DIRECTIVE = CursorKind(251) + +# OpenMP target directive. +CursorKind.OMP_TARGET_DIRECTIVE = CursorKind(252) + +# OpenMP teams directive. +CursorKind.OMP_TEAMS_DIRECTIVE = CursorKind(253) + +# OpenMP taskgroup directive. +CursorKind.OMP_TASKGROUP_DIRECTIVE = CursorKind(254) + +# OpenMP cancellation point directive. +CursorKind.OMP_CANCELLATION_POINT_DIRECTIVE = CursorKind(255) + +# OpenMP cancel directive. +CursorKind.OMP_CANCEL_DIRECTIVE = CursorKind(256) + +# OpenMP target data directive. +CursorKind.OMP_TARGET_DATA_DIRECTIVE = CursorKind(257) + +# OpenMP taskloop directive. +CursorKind.OMP_TASK_LOOP_DIRECTIVE = CursorKind(258) + +# OpenMP taskloop simd directive. +CursorKind.OMP_TASK_LOOP_SIMD_DIRECTIVE = CursorKind(259) + +# OpenMP distribute directive. +CursorKind.OMP_DISTRIBUTE_DIRECTIVE = CursorKind(260) + +# OpenMP target enter data directive. +CursorKind.OMP_TARGET_ENTER_DATA_DIRECTIVE = CursorKind(261) + +# OpenMP target exit data directive. +CursorKind.OMP_TARGET_EXIT_DATA_DIRECTIVE = CursorKind(262) + +# OpenMP target parallel directive. +CursorKind.OMP_TARGET_PARALLEL_DIRECTIVE = CursorKind(263) + +# OpenMP target parallel for directive. +CursorKind.OMP_TARGET_PARALLELFOR_DIRECTIVE = CursorKind(264) + +# OpenMP target update directive. +CursorKind.OMP_TARGET_UPDATE_DIRECTIVE = CursorKind(265) + +# OpenMP distribute parallel for directive. +CursorKind.OMP_DISTRIBUTE_PARALLELFOR_DIRECTIVE = CursorKind(266) + +# OpenMP distribute parallel for simd directive. +CursorKind.OMP_DISTRIBUTE_PARALLEL_FOR_SIMD_DIRECTIVE = CursorKind(267) + +# OpenMP distribute simd directive. +CursorKind.OMP_DISTRIBUTE_SIMD_DIRECTIVE = CursorKind(268) + +# OpenMP target parallel for simd directive. +CursorKind.OMP_TARGET_PARALLEL_FOR_SIMD_DIRECTIVE = CursorKind(269) + +# OpenMP target simd directive. +CursorKind.OMP_TARGET_SIMD_DIRECTIVE = CursorKind(270) + +# OpenMP teams distribute directive. +CursorKind.OMP_TEAMS_DISTRIBUTE_DIRECTIVE = CursorKind(271) + +### +# Other Kinds + +# Cursor that represents the translation unit itself. +# +# The translation unit cursor exists primarily to act as the root cursor for +# traversing the contents of a translation unit. +CursorKind.TRANSLATION_UNIT = CursorKind(300) + +### +# Attributes + +# An attribute whoe specific kind is note exposed via this interface +CursorKind.UNEXPOSED_ATTR = CursorKind(400) + +CursorKind.IB_ACTION_ATTR = CursorKind(401) +CursorKind.IB_OUTLET_ATTR = CursorKind(402) +CursorKind.IB_OUTLET_COLLECTION_ATTR = CursorKind(403) + +CursorKind.CXX_FINAL_ATTR = CursorKind(404) +CursorKind.CXX_OVERRIDE_ATTR = CursorKind(405) +CursorKind.ANNOTATE_ATTR = CursorKind(406) +CursorKind.ASM_LABEL_ATTR = CursorKind(407) +CursorKind.PACKED_ATTR = CursorKind(408) +CursorKind.PURE_ATTR = CursorKind(409) +CursorKind.CONST_ATTR = CursorKind(410) +CursorKind.NODUPLICATE_ATTR = CursorKind(411) +CursorKind.CUDACONSTANT_ATTR = CursorKind(412) +CursorKind.CUDADEVICE_ATTR = CursorKind(413) +CursorKind.CUDAGLOBAL_ATTR = CursorKind(414) +CursorKind.CUDAHOST_ATTR = CursorKind(415) +CursorKind.CUDASHARED_ATTR = CursorKind(416) + +CursorKind.VISIBILITY_ATTR = CursorKind(417) + +CursorKind.DLLEXPORT_ATTR = CursorKind(418) +CursorKind.DLLIMPORT_ATTR = CursorKind(419) + +### +# Preprocessing +CursorKind.PREPROCESSING_DIRECTIVE = CursorKind(500) +CursorKind.MACRO_DEFINITION = CursorKind(501) +CursorKind.MACRO_INSTANTIATION = CursorKind(502) +CursorKind.INCLUSION_DIRECTIVE = CursorKind(503) + +### +# Extra declaration + +# A module import declaration. +CursorKind.MODULE_IMPORT_DECL = CursorKind(600) +# A type alias template declaration +CursorKind.TYPE_ALIAS_TEMPLATE_DECL = CursorKind(601) +# A static_assert or _Static_assert node +CursorKind.STATIC_ASSERT = CursorKind(602) +# A friend declaration +CursorKind.FRIEND_DECL = CursorKind(603) + +# A code completion overload candidate. +CursorKind.OVERLOAD_CANDIDATE = CursorKind(700) + +### Template Argument Kinds ### +class TemplateArgumentKind(BaseEnumeration): + """ + A TemplateArgumentKind describes the kind of entity that a template argument + represents. + """ + + # The required BaseEnumeration declarations. + _kinds = [] + _name_map = None + +TemplateArgumentKind.NULL = TemplateArgumentKind(0) +TemplateArgumentKind.TYPE = TemplateArgumentKind(1) +TemplateArgumentKind.DECLARATION = TemplateArgumentKind(2) +TemplateArgumentKind.NULLPTR = TemplateArgumentKind(3) +TemplateArgumentKind.INTEGRAL = TemplateArgumentKind(4) + +### Cursors ### + +class Cursor(Structure): + """ + The Cursor class represents a reference to an element within the AST. It + acts as a kind of iterator. + """ + _fields_ = [("_kind_id", c_int), ("xdata", c_int), ("data", c_void_p * 3)] + + @staticmethod + def from_location(tu, location): + # We store a reference to the TU in the instance so the TU won't get + # collected before the cursor. + cursor = conf.lib.clang_getCursor(tu, location) + cursor._tu = tu + + return cursor + + def __eq__(self, other): + return conf.lib.clang_equalCursors(self, other) + + def __ne__(self, other): + return not self.__eq__(other) + + def is_definition(self): + """ + Returns true if the declaration pointed at by the cursor is also a + definition of that entity. + """ + return conf.lib.clang_isCursorDefinition(self) + + def is_const_method(self): + """Returns True if the cursor refers to a C++ member function or member + function template that is declared 'const'. + """ + return conf.lib.clang_CXXMethod_isConst(self) + + def is_converting_constructor(self): + """Returns True if the cursor refers to a C++ converting constructor. + """ + return conf.lib.clang_CXXConstructor_isConvertingConstructor(self) + + def is_copy_constructor(self): + """Returns True if the cursor refers to a C++ copy constructor. + """ + return conf.lib.clang_CXXConstructor_isCopyConstructor(self) + + def is_default_constructor(self): + """Returns True if the cursor refers to a C++ default constructor. + """ + return conf.lib.clang_CXXConstructor_isDefaultConstructor(self) + + def is_move_constructor(self): + """Returns True if the cursor refers to a C++ move constructor. + """ + return conf.lib.clang_CXXConstructor_isMoveConstructor(self) + + def is_default_method(self): + """Returns True if the cursor refers to a C++ member function or member + function template that is declared '= default'. + """ + return conf.lib.clang_CXXMethod_isDefaulted(self) + + def is_mutable_field(self): + """Returns True if the cursor refers to a C++ field that is declared + 'mutable'. + """ + return conf.lib.clang_CXXField_isMutable(self) + + def is_pure_virtual_method(self): + """Returns True if the cursor refers to a C++ member function or member + function template that is declared pure virtual. + """ + return conf.lib.clang_CXXMethod_isPureVirtual(self) + + def is_static_method(self): + """Returns True if the cursor refers to a C++ member function or member + function template that is declared 'static'. + """ + return conf.lib.clang_CXXMethod_isStatic(self) + + def is_virtual_method(self): + """Returns True if the cursor refers to a C++ member function or member + function template that is declared 'virtual'. + """ + return conf.lib.clang_CXXMethod_isVirtual(self) + + def get_definition(self): + """ + If the cursor is a reference to a declaration or a declaration of + some entity, return a cursor that points to the definition of that + entity. + """ + # TODO: Should probably check that this is either a reference or + # declaration prior to issuing the lookup. + return conf.lib.clang_getCursorDefinition(self) + + def get_usr(self): + """Return the Unified Symbol Resultion (USR) for the entity referenced + by the given cursor (or None). + + A Unified Symbol Resolution (USR) is a string that identifies a + particular entity (function, class, variable, etc.) within a + program. USRs can be compared across translation units to determine, + e.g., when references in one translation refer to an entity defined in + another translation unit.""" + return conf.lib.clang_getCursorUSR(self) + + @property + def kind(self): + """Return the kind of this cursor.""" + return CursorKind.from_id(self._kind_id) + + @property + def spelling(self): + """Return the spelling of the entity pointed at by the cursor.""" + if not hasattr(self, '_spelling'): + self._spelling = conf.lib.clang_getCursorSpelling(self) + + return self._spelling + + @property + def displayname(self): + """ + Return the display name for the entity referenced by this cursor. + + The display name contains extra information that helps identify the + cursor, such as the parameters of a function or template or the + arguments of a class template specialization. + """ + if not hasattr(self, '_displayname'): + self._displayname = conf.lib.clang_getCursorDisplayName(self) + + return self._displayname + + @property + def mangled_name(self): + """Return the mangled name for the entity referenced by this cursor.""" + if not hasattr(self, '_mangled_name'): + self._mangled_name = conf.lib.clang_Cursor_getMangling(self) + + return self._mangled_name + + @property + def location(self): + """ + Return the source location (the starting character) of the entity + pointed at by the cursor. + """ + if not hasattr(self, '_loc'): + self._loc = conf.lib.clang_getCursorLocation(self) + + return self._loc + + @property + def extent(self): + """ + Return the source range (the range of text) occupied by the entity + pointed at by the cursor. + """ + if not hasattr(self, '_extent'): + self._extent = conf.lib.clang_getCursorExtent(self) + + return self._extent + + @property + def storage_class(self): + """ + Retrieves the storage class (if any) of the entity pointed at by the + cursor. + """ + if not hasattr(self, '_storage_class'): + self._storage_class = conf.lib.clang_Cursor_getStorageClass(self) + + return StorageClass.from_id(self._storage_class) + + @property + def access_specifier(self): + """ + Retrieves the access specifier (if any) of the entity pointed at by the + cursor. + """ + if not hasattr(self, '_access_specifier'): + self._access_specifier = conf.lib.clang_getCXXAccessSpecifier(self) + + return AccessSpecifier.from_id(self._access_specifier) + + @property + def type(self): + """ + Retrieve the Type (if any) of the entity pointed at by the cursor. + """ + if not hasattr(self, '_type'): + self._type = conf.lib.clang_getCursorType(self) + + return self._type + + @property + def canonical(self): + """Return the canonical Cursor corresponding to this Cursor. + + The canonical cursor is the cursor which is representative for the + underlying entity. For example, if you have multiple forward + declarations for the same class, the canonical cursor for the forward + declarations will be identical. + """ + if not hasattr(self, '_canonical'): + self._canonical = conf.lib.clang_getCanonicalCursor(self) + + return self._canonical + + @property + def result_type(self): + """Retrieve the Type of the result for this Cursor.""" + if not hasattr(self, '_result_type'): + self._result_type = conf.lib.clang_getResultType(self.type) + + return self._result_type + + @property + def underlying_typedef_type(self): + """Return the underlying type of a typedef declaration. + + Returns a Type for the typedef this cursor is a declaration for. If + the current cursor is not a typedef, this raises. + """ + if not hasattr(self, '_underlying_type'): + assert self.kind.is_declaration() + self._underlying_type = \ + conf.lib.clang_getTypedefDeclUnderlyingType(self) + + return self._underlying_type + + @property + def enum_type(self): + """Return the integer type of an enum declaration. + + Returns a Type corresponding to an integer. If the cursor is not for an + enum, this raises. + """ + if not hasattr(self, '_enum_type'): + assert self.kind == CursorKind.ENUM_DECL + self._enum_type = conf.lib.clang_getEnumDeclIntegerType(self) + + return self._enum_type + + @property + def enum_value(self): + """Return the value of an enum constant.""" + if not hasattr(self, '_enum_value'): + assert self.kind == CursorKind.ENUM_CONSTANT_DECL + # Figure out the underlying type of the enum to know if it + # is a signed or unsigned quantity. + underlying_type = self.type + if underlying_type.kind == TypeKind.ENUM: + underlying_type = underlying_type.get_declaration().enum_type + if underlying_type.kind in (TypeKind.CHAR_U, + TypeKind.UCHAR, + TypeKind.CHAR16, + TypeKind.CHAR32, + TypeKind.USHORT, + TypeKind.UINT, + TypeKind.ULONG, + TypeKind.ULONGLONG, + TypeKind.UINT128): + self._enum_value = \ + conf.lib.clang_getEnumConstantDeclUnsignedValue(self) + else: + self._enum_value = conf.lib.clang_getEnumConstantDeclValue(self) + return self._enum_value + + @property + def objc_type_encoding(self): + """Return the Objective-C type encoding as a str.""" + if not hasattr(self, '_objc_type_encoding'): + self._objc_type_encoding = \ + conf.lib.clang_getDeclObjCTypeEncoding(self) + + return self._objc_type_encoding + + @property + def hash(self): + """Returns a hash of the cursor as an int.""" + if not hasattr(self, '_hash'): + self._hash = conf.lib.clang_hashCursor(self) + + return self._hash + + @property + def semantic_parent(self): + """Return the semantic parent for this cursor.""" + if not hasattr(self, '_semantic_parent'): + self._semantic_parent = conf.lib.clang_getCursorSemanticParent(self) + + return self._semantic_parent + + @property + def lexical_parent(self): + """Return the lexical parent for this cursor.""" + if not hasattr(self, '_lexical_parent'): + self._lexical_parent = conf.lib.clang_getCursorLexicalParent(self) + + return self._lexical_parent + + @property + def translation_unit(self): + """Returns the TranslationUnit to which this Cursor belongs.""" + # If this triggers an AttributeError, the instance was not properly + # created. + return self._tu + + @property + def referenced(self): + """ + For a cursor that is a reference, returns a cursor + representing the entity that it references. + """ + if not hasattr(self, '_referenced'): + self._referenced = conf.lib.clang_getCursorReferenced(self) + + return self._referenced + + @property + def brief_comment(self): + """Returns the brief comment text associated with that Cursor""" + return conf.lib.clang_Cursor_getBriefCommentText(self) + + @property + def raw_comment(self): + """Returns the raw comment text associated with that Cursor""" + return conf.lib.clang_Cursor_getRawCommentText(self) + + def get_arguments(self): + """Return an iterator for accessing the arguments of this cursor.""" + num_args = conf.lib.clang_Cursor_getNumArguments(self) + for i in range(0, num_args): + yield conf.lib.clang_Cursor_getArgument(self, i) + + def get_num_template_arguments(self): + """Returns the number of template args associated with this cursor.""" + return conf.lib.clang_Cursor_getNumTemplateArguments(self) + + def get_template_argument_kind(self, num): + """Returns the TemplateArgumentKind for the indicated template + argument.""" + return conf.lib.clang_Cursor_getTemplateArgumentKind(self, num) + + def get_template_argument_type(self, num): + """Returns the CXType for the indicated template argument.""" + return conf.lib.clang_Cursor_getTemplateArgumentType(self, num) + + def get_template_argument_value(self, num): + """Returns the value of the indicated arg as a signed 64b integer.""" + return conf.lib.clang_Cursor_getTemplateArgumentValue(self, num) + + def get_template_argument_unsigned_value(self, num): + """Returns the value of the indicated arg as an unsigned 64b integer.""" + return conf.lib.clang_Cursor_getTemplateArgumentUnsignedValue(self, num) + + def get_children(self): + """Return an iterator for accessing the children of this cursor.""" + + # FIXME: Expose iteration from CIndex, PR6125. + def visitor(child, parent, children): + # FIXME: Document this assertion in API. + # FIXME: There should just be an isNull method. + assert child != conf.lib.clang_getNullCursor() + + # Create reference to TU so it isn't GC'd before Cursor. + child._tu = self._tu + children.append(child) + return 1 # continue + children = [] + conf.lib.clang_visitChildren(self, callbacks['cursor_visit'](visitor), + children) + return iter(children) + + def walk_preorder(self): + """Depth-first preorder walk over the cursor and its descendants. + + Yields cursors. + """ + yield self + for child in self.get_children(): + for descendant in child.walk_preorder(): + yield descendant + + def get_tokens(self): + """Obtain Token instances formulating that compose this Cursor. + + This is a generator for Token instances. It returns all tokens which + occupy the extent this cursor occupies. + """ + return TokenGroup.get_tokens(self._tu, self.extent) + + def get_field_offsetof(self): + """Returns the offsetof the FIELD_DECL pointed by this Cursor.""" + return conf.lib.clang_Cursor_getOffsetOfField(self) + + def is_anonymous(self): + """ + Check if the record is anonymous. + """ + if self.kind == CursorKind.FIELD_DECL: + return self.type.get_declaration().is_anonymous() + return conf.lib.clang_Cursor_isAnonymous(self) + + def is_bitfield(self): + """ + Check if the field is a bitfield. + """ + return conf.lib.clang_Cursor_isBitField(self) + + def get_bitfield_width(self): + """ + Retrieve the width of a bitfield. + """ + return conf.lib.clang_getFieldDeclBitWidth(self) + + @staticmethod + def from_result(res, fn, args): + assert isinstance(res, Cursor) + # FIXME: There should just be an isNull method. + if res == conf.lib.clang_getNullCursor(): + return None + + # Store a reference to the TU in the Python object so it won't get GC'd + # before the Cursor. + tu = None + for arg in args: + if isinstance(arg, TranslationUnit): + tu = arg + break + + if hasattr(arg, 'translation_unit'): + tu = arg.translation_unit + break + + assert tu is not None + + res._tu = tu + return res + + @staticmethod + def from_cursor_result(res, fn, args): + assert isinstance(res, Cursor) + if res == conf.lib.clang_getNullCursor(): + return None + + res._tu = args[0]._tu + return res + +class StorageClass(object): + """ + Describes the storage class of a declaration + """ + + # The unique kind objects, index by id. + _kinds = [] + _name_map = None + + def __init__(self, value): + if value >= len(StorageClass._kinds): + StorageClass._kinds += [None] * (value - len(StorageClass._kinds) + 1) + if StorageClass._kinds[value] is not None: + raise ValueError('StorageClass already loaded') + self.value = value + StorageClass._kinds[value] = self + StorageClass._name_map = None + + def from_param(self): + return self.value + + @property + def name(self): + """Get the enumeration name of this storage class.""" + if self._name_map is None: + self._name_map = {} + for key,value in list(StorageClass.__dict__.items()): + if isinstance(value,StorageClass): + self._name_map[value] = key + return self._name_map[self] + + @staticmethod + def from_id(id): + if id >= len(StorageClass._kinds) or not StorageClass._kinds[id]: + raise ValueError('Unknown storage class %d' % id) + return StorageClass._kinds[id] + + def __repr__(self): + return 'StorageClass.%s' % (self.name,) + +StorageClass.INVALID = StorageClass(0) +StorageClass.NONE = StorageClass(1) +StorageClass.EXTERN = StorageClass(2) +StorageClass.STATIC = StorageClass(3) +StorageClass.PRIVATEEXTERN = StorageClass(4) +StorageClass.OPENCLWORKGROUPLOCAL = StorageClass(5) +StorageClass.AUTO = StorageClass(6) +StorageClass.REGISTER = StorageClass(7) + + +### C++ access specifiers ### + +class AccessSpecifier(BaseEnumeration): + """ + Describes the access of a C++ class member + """ + + # The unique kind objects, index by id. + _kinds = [] + _name_map = None + + def from_param(self): + return self.value + + def __repr__(self): + return 'AccessSpecifier.%s' % (self.name,) + +AccessSpecifier.INVALID = AccessSpecifier(0) +AccessSpecifier.PUBLIC = AccessSpecifier(1) +AccessSpecifier.PROTECTED = AccessSpecifier(2) +AccessSpecifier.PRIVATE = AccessSpecifier(3) +AccessSpecifier.NONE = AccessSpecifier(4) + +### Type Kinds ### + +class TypeKind(BaseEnumeration): + """ + Describes the kind of type. + """ + + # The unique kind objects, indexed by id. + _kinds = [] + _name_map = None + + @property + def spelling(self): + """Retrieve the spelling of this TypeKind.""" + return conf.lib.clang_getTypeKindSpelling(self.value) + + def __repr__(self): + return 'TypeKind.%s' % (self.name,) + +TypeKind.INVALID = TypeKind(0) +TypeKind.UNEXPOSED = TypeKind(1) +TypeKind.VOID = TypeKind(2) +TypeKind.BOOL = TypeKind(3) +TypeKind.CHAR_U = TypeKind(4) +TypeKind.UCHAR = TypeKind(5) +TypeKind.CHAR16 = TypeKind(6) +TypeKind.CHAR32 = TypeKind(7) +TypeKind.USHORT = TypeKind(8) +TypeKind.UINT = TypeKind(9) +TypeKind.ULONG = TypeKind(10) +TypeKind.ULONGLONG = TypeKind(11) +TypeKind.UINT128 = TypeKind(12) +TypeKind.CHAR_S = TypeKind(13) +TypeKind.SCHAR = TypeKind(14) +TypeKind.WCHAR = TypeKind(15) +TypeKind.SHORT = TypeKind(16) +TypeKind.INT = TypeKind(17) +TypeKind.LONG = TypeKind(18) +TypeKind.LONGLONG = TypeKind(19) +TypeKind.INT128 = TypeKind(20) +TypeKind.FLOAT = TypeKind(21) +TypeKind.DOUBLE = TypeKind(22) +TypeKind.LONGDOUBLE = TypeKind(23) +TypeKind.NULLPTR = TypeKind(24) +TypeKind.OVERLOAD = TypeKind(25) +TypeKind.DEPENDENT = TypeKind(26) +TypeKind.OBJCID = TypeKind(27) +TypeKind.OBJCCLASS = TypeKind(28) +TypeKind.OBJCSEL = TypeKind(29) +TypeKind.FLOAT128 = TypeKind(30) +TypeKind.HALF = TypeKind(31) +TypeKind.COMPLEX = TypeKind(100) +TypeKind.POINTER = TypeKind(101) +TypeKind.BLOCKPOINTER = TypeKind(102) +TypeKind.LVALUEREFERENCE = TypeKind(103) +TypeKind.RVALUEREFERENCE = TypeKind(104) +TypeKind.RECORD = TypeKind(105) +TypeKind.ENUM = TypeKind(106) +TypeKind.TYPEDEF = TypeKind(107) +TypeKind.OBJCINTERFACE = TypeKind(108) +TypeKind.OBJCOBJECTPOINTER = TypeKind(109) +TypeKind.FUNCTIONNOPROTO = TypeKind(110) +TypeKind.FUNCTIONPROTO = TypeKind(111) +TypeKind.CONSTANTARRAY = TypeKind(112) +TypeKind.VECTOR = TypeKind(113) +TypeKind.INCOMPLETEARRAY = TypeKind(114) +TypeKind.VARIABLEARRAY = TypeKind(115) +TypeKind.DEPENDENTSIZEDARRAY = TypeKind(116) +TypeKind.MEMBERPOINTER = TypeKind(117) +TypeKind.AUTO = TypeKind(118) +TypeKind.ELABORATED = TypeKind(119) + +class RefQualifierKind(BaseEnumeration): + """Describes a specific ref-qualifier of a type.""" + + # The unique kind objects, indexed by id. + _kinds = [] + _name_map = None + + def from_param(self): + return self.value + + def __repr__(self): + return 'RefQualifierKind.%s' % (self.name,) + +RefQualifierKind.NONE = RefQualifierKind(0) +RefQualifierKind.LVALUE = RefQualifierKind(1) +RefQualifierKind.RVALUE = RefQualifierKind(2) + +class Type(Structure): + """ + The type of an element in the abstract syntax tree. + """ + _fields_ = [("_kind_id", c_int), ("data", c_void_p * 2)] + + @property + def kind(self): + """Return the kind of this type.""" + return TypeKind.from_id(self._kind_id) + + def argument_types(self): + """Retrieve a container for the non-variadic arguments for this type. + + The returned object is iterable and indexable. Each item in the + container is a Type instance. + """ + class ArgumentsIterator(collections.Sequence): + def __init__(self, parent): + self.parent = parent + self.length = None + + def __len__(self): + if self.length is None: + self.length = conf.lib.clang_getNumArgTypes(self.parent) + + return self.length + + def __getitem__(self, key): + # FIXME Support slice objects. + if not isinstance(key, int): + raise TypeError("Must supply a non-negative int.") + + if key < 0: + raise IndexError("Only non-negative indexes are accepted.") + + if key >= len(self): + raise IndexError("Index greater than container length: " + "%d > %d" % ( key, len(self) )) + + result = conf.lib.clang_getArgType(self.parent, key) + if result.kind == TypeKind.INVALID: + raise IndexError("Argument could not be retrieved.") + + return result + + assert self.kind == TypeKind.FUNCTIONPROTO + return ArgumentsIterator(self) + + @property + def element_type(self): + """Retrieve the Type of elements within this Type. + + If accessed on a type that is not an array, complex, or vector type, an + exception will be raised. + """ + result = conf.lib.clang_getElementType(self) + if result.kind == TypeKind.INVALID: + raise Exception('Element type not available on this type.') + + return result + + @property + def element_count(self): + """Retrieve the number of elements in this type. + + Returns an int. + + If the Type is not an array or vector, this raises. + """ + result = conf.lib.clang_getNumElements(self) + if result < 0: + raise Exception('Type does not have elements.') + + return result + + @property + def translation_unit(self): + """The TranslationUnit to which this Type is associated.""" + # If this triggers an AttributeError, the instance was not properly + # instantiated. + return self._tu + + @staticmethod + def from_result(res, fn, args): + assert isinstance(res, Type) + + tu = None + for arg in args: + if hasattr(arg, 'translation_unit'): + tu = arg.translation_unit + break + + assert tu is not None + res._tu = tu + + return res + + def get_canonical(self): + """ + Return the canonical type for a Type. + + Clang's type system explicitly models typedefs and all the + ways a specific type can be represented. The canonical type + is the underlying type with all the "sugar" removed. For + example, if 'T' is a typedef for 'int', the canonical type for + 'T' would be 'int'. + """ + return conf.lib.clang_getCanonicalType(self) + + def is_const_qualified(self): + """Determine whether a Type has the "const" qualifier set. + + This does not look through typedefs that may have added "const" + at a different level. + """ + return conf.lib.clang_isConstQualifiedType(self) + + def is_volatile_qualified(self): + """Determine whether a Type has the "volatile" qualifier set. + + This does not look through typedefs that may have added "volatile" + at a different level. + """ + return conf.lib.clang_isVolatileQualifiedType(self) + + def is_restrict_qualified(self): + """Determine whether a Type has the "restrict" qualifier set. + + This does not look through typedefs that may have added "restrict" at + a different level. + """ + return conf.lib.clang_isRestrictQualifiedType(self) + + def is_function_variadic(self): + """Determine whether this function Type is a variadic function type.""" + assert self.kind == TypeKind.FUNCTIONPROTO + + return conf.lib.clang_isFunctionTypeVariadic(self) + + def is_pod(self): + """Determine whether this Type represents plain old data (POD).""" + return conf.lib.clang_isPODType(self) + + def get_pointee(self): + """ + For pointer types, returns the type of the pointee. + """ + return conf.lib.clang_getPointeeType(self) + + def get_declaration(self): + """ + Return the cursor for the declaration of the given type. + """ + return conf.lib.clang_getTypeDeclaration(self) + + def get_result(self): + """ + Retrieve the result type associated with a function type. + """ + return conf.lib.clang_getResultType(self) + + def get_array_element_type(self): + """ + Retrieve the type of the elements of the array type. + """ + return conf.lib.clang_getArrayElementType(self) + + def get_array_size(self): + """ + Retrieve the size of the constant array. + """ + return conf.lib.clang_getArraySize(self) + + def get_class_type(self): + """ + Retrieve the class type of the member pointer type. + """ + return conf.lib.clang_Type_getClassType(self) + + def get_named_type(self): + """ + Retrieve the type named by the qualified-id. + """ + return conf.lib.clang_Type_getNamedType(self) + def get_align(self): + """ + Retrieve the alignment of the record. + """ + return conf.lib.clang_Type_getAlignOf(self) + + def get_size(self): + """ + Retrieve the size of the record. + """ + return conf.lib.clang_Type_getSizeOf(self) + + def get_offset(self, fieldname): + """ + Retrieve the offset of a field in the record. + """ + return conf.lib.clang_Type_getOffsetOf(self, c_char_p(fieldname)) + + def get_ref_qualifier(self): + """ + Retrieve the ref-qualifier of the type. + """ + return RefQualifierKind.from_id( + conf.lib.clang_Type_getCXXRefQualifier(self)) + + def get_fields(self): + """Return an iterator for accessing the fields of this type.""" + + def visitor(field, children): + assert field != conf.lib.clang_getNullCursor() + + # Create reference to TU so it isn't GC'd before Cursor. + field._tu = self._tu + fields.append(field) + return 1 # continue + fields = [] + conf.lib.clang_Type_visitFields(self, + callbacks['fields_visit'](visitor), fields) + return iter(fields) + + @property + def spelling(self): + """Retrieve the spelling of this Type.""" + return conf.lib.clang_getTypeSpelling(self) + + def __eq__(self, other): + if type(other) != type(self): + return False + + return conf.lib.clang_equalTypes(self, other) + + def __ne__(self, other): + return not self.__eq__(other) + +## CIndex Objects ## + +# CIndex objects (derived from ClangObject) are essentially lightweight +# wrappers attached to some underlying object, which is exposed via CIndex as +# a void*. + +class ClangObject(object): + """ + A helper for Clang objects. This class helps act as an intermediary for + the ctypes library and the Clang CIndex library. + """ + def __init__(self, obj): + assert isinstance(obj, c_object_p) and obj + self.obj = self._as_parameter_ = obj + + def from_param(self): + return self._as_parameter_ + + +class _CXUnsavedFile(Structure): + """Helper for passing unsaved file arguments.""" + _fields_ = [("name", c_char_p), ("contents", c_char_p), ('length', c_ulong)] + +# Functions calls through the python interface are rather slow. Fortunately, +# for most symboles, we do not need to perform a function call. Their spelling +# never changes and is consequently provided by this spelling cache. +SpellingCache = { + # 0: CompletionChunk.Kind("Optional"), + # 1: CompletionChunk.Kind("TypedText"), + # 2: CompletionChunk.Kind("Text"), + # 3: CompletionChunk.Kind("Placeholder"), + # 4: CompletionChunk.Kind("Informative"), + # 5 : CompletionChunk.Kind("CurrentParameter"), + 6: '(', # CompletionChunk.Kind("LeftParen"), + 7: ')', # CompletionChunk.Kind("RightParen"), + 8: '[', # CompletionChunk.Kind("LeftBracket"), + 9: ']', # CompletionChunk.Kind("RightBracket"), + 10: '{', # CompletionChunk.Kind("LeftBrace"), + 11: '}', # CompletionChunk.Kind("RightBrace"), + 12: '<', # CompletionChunk.Kind("LeftAngle"), + 13: '>', # CompletionChunk.Kind("RightAngle"), + 14: ', ', # CompletionChunk.Kind("Comma"), + # 15: CompletionChunk.Kind("ResultType"), + 16: ':', # CompletionChunk.Kind("Colon"), + 17: ';', # CompletionChunk.Kind("SemiColon"), + 18: '=', # CompletionChunk.Kind("Equal"), + 19: ' ', # CompletionChunk.Kind("HorizontalSpace"), + # 20: CompletionChunk.Kind("VerticalSpace") +} + +class CompletionChunk: + class Kind: + def __init__(self, name): + self.name = name + + def __str__(self): + return self.name + + def __repr__(self): + return "" % self + + def __init__(self, completionString, key): + self.cs = completionString + self.key = key + self.__kindNumberCache = -1 + + def __repr__(self): + return "{'" + self.spelling + "', " + str(self.kind) + "}" + + @CachedProperty + def spelling(self): + if self.__kindNumber in SpellingCache: + return SpellingCache[self.__kindNumber] + return conf.lib.clang_getCompletionChunkText(self.cs, self.key).spelling + + # We do not use @CachedProperty here, as the manual implementation is + # apparently still significantly faster. Please profile carefully if you + # would like to add CachedProperty back. + @property + def __kindNumber(self): + if self.__kindNumberCache == -1: + self.__kindNumberCache = \ + conf.lib.clang_getCompletionChunkKind(self.cs, self.key) + return self.__kindNumberCache + + @CachedProperty + def kind(self): + return completionChunkKindMap[self.__kindNumber] + + @CachedProperty + def string(self): + res = conf.lib.clang_getCompletionChunkCompletionString(self.cs, + self.key) + + if (res): + return CompletionString(res) + else: + None + + def isKindOptional(self): + return self.__kindNumber == 0 + + def isKindTypedText(self): + return self.__kindNumber == 1 + + def isKindPlaceHolder(self): + return self.__kindNumber == 3 + + def isKindInformative(self): + return self.__kindNumber == 4 + + def isKindResultType(self): + return self.__kindNumber == 15 + +completionChunkKindMap = { + 0: CompletionChunk.Kind("Optional"), + 1: CompletionChunk.Kind("TypedText"), + 2: CompletionChunk.Kind("Text"), + 3: CompletionChunk.Kind("Placeholder"), + 4: CompletionChunk.Kind("Informative"), + 5: CompletionChunk.Kind("CurrentParameter"), + 6: CompletionChunk.Kind("LeftParen"), + 7: CompletionChunk.Kind("RightParen"), + 8: CompletionChunk.Kind("LeftBracket"), + 9: CompletionChunk.Kind("RightBracket"), + 10: CompletionChunk.Kind("LeftBrace"), + 11: CompletionChunk.Kind("RightBrace"), + 12: CompletionChunk.Kind("LeftAngle"), + 13: CompletionChunk.Kind("RightAngle"), + 14: CompletionChunk.Kind("Comma"), + 15: CompletionChunk.Kind("ResultType"), + 16: CompletionChunk.Kind("Colon"), + 17: CompletionChunk.Kind("SemiColon"), + 18: CompletionChunk.Kind("Equal"), + 19: CompletionChunk.Kind("HorizontalSpace"), + 20: CompletionChunk.Kind("VerticalSpace")} + +class CompletionString(ClangObject): + class Availability: + def __init__(self, name): + self.name = name + + def __str__(self): + return self.name + + def __repr__(self): + return "" % self + + def __len__(self): + return self.num_chunks + + @CachedProperty + def num_chunks(self): + return conf.lib.clang_getNumCompletionChunks(self.obj) + + def __getitem__(self, key): + if self.num_chunks <= key: + raise IndexError + return CompletionChunk(self.obj, key) + + @property + def priority(self): + return conf.lib.clang_getCompletionPriority(self.obj) + + @property + def availability(self): + res = conf.lib.clang_getCompletionAvailability(self.obj) + return availabilityKinds[res] + + @property + def briefComment(self): + if conf.function_exists("clang_getCompletionBriefComment"): + return conf.lib.clang_getCompletionBriefComment(self.obj) + return _CXString() + + def __repr__(self): + return " | ".join([str(a) for a in self]) \ + + " || Priority: " + str(self.priority) \ + + " || Availability: " + str(self.availability) \ + + " || Brief comment: " + str(self.briefComment.spelling) + +availabilityKinds = { + 0: CompletionChunk.Kind("Available"), + 1: CompletionChunk.Kind("Deprecated"), + 2: CompletionChunk.Kind("NotAvailable"), + 3: CompletionChunk.Kind("NotAccessible")} + +class CodeCompletionResult(Structure): + _fields_ = [('cursorKind', c_int), ('completionString', c_object_p)] + + def __repr__(self): + return str(CompletionString(self.completionString)) + + @property + def kind(self): + return CursorKind.from_id(self.cursorKind) + + @property + def string(self): + return CompletionString(self.completionString) + +class CCRStructure(Structure): + _fields_ = [('results', POINTER(CodeCompletionResult)), + ('numResults', c_int)] + + def __len__(self): + return self.numResults + + def __getitem__(self, key): + if len(self) <= key: + raise IndexError + + return self.results[key] + +class CodeCompletionResults(ClangObject): + def __init__(self, ptr): + assert isinstance(ptr, POINTER(CCRStructure)) and ptr + self.ptr = self._as_parameter_ = ptr + + def from_param(self): + return self._as_parameter_ + + def __del__(self): + conf.lib.clang_disposeCodeCompleteResults(self) + + @property + def results(self): + return self.ptr.contents + + @property + def diagnostics(self): + class DiagnosticsItr: + def __init__(self, ccr): + self.ccr= ccr + + def __len__(self): + return int(\ + conf.lib.clang_codeCompleteGetNumDiagnostics(self.ccr)) + + def __getitem__(self, key): + return conf.lib.clang_codeCompleteGetDiagnostic(self.ccr, key) + + return DiagnosticsItr(self) + + +class Index(ClangObject): + """ + The Index type provides the primary interface to the Clang CIndex library, + primarily by providing an interface for reading and parsing translation + units. + """ + + @staticmethod + def create(excludeDecls=False): + """ + Create a new Index. + Parameters: + excludeDecls -- Exclude local declarations from translation units. + """ + return Index(conf.lib.clang_createIndex(excludeDecls, 0)) + + def __del__(self): + conf.lib.clang_disposeIndex(self) + + def read(self, path): + """Load a TranslationUnit from the given AST file.""" + return TranslationUnit.from_ast_file(path, self) + + def parse(self, path, args=None, unsaved_files=None, options = 0): + """Load the translation unit from the given source code file by running + clang and generating the AST before loading. Additional command line + parameters can be passed to clang via the args parameter. + + In-memory contents for files can be provided by passing a list of pairs + to as unsaved_files, the first item should be the filenames to be mapped + and the second should be the contents to be substituted for the + file. The contents may be passed as strings or file objects. + + If an error was encountered during parsing, a TranslationUnitLoadError + will be raised. + """ + return TranslationUnit.from_source(path, args, unsaved_files, options, + self) + +class TranslationUnit(ClangObject): + """Represents a source code translation unit. + + This is one of the main types in the API. Any time you wish to interact + with Clang's representation of a source file, you typically start with a + translation unit. + """ + + # Default parsing mode. + PARSE_NONE = 0 + + # Instruct the parser to create a detailed processing record containing + # metadata not normally retained. + PARSE_DETAILED_PROCESSING_RECORD = 1 + + # Indicates that the translation unit is incomplete. This is typically used + # when parsing headers. + PARSE_INCOMPLETE = 2 + + # Instruct the parser to create a pre-compiled preamble for the translation + # unit. This caches the preamble (included files at top of source file). + # This is useful if the translation unit will be reparsed and you don't + # want to incur the overhead of reparsing the preamble. + PARSE_PRECOMPILED_PREAMBLE = 4 + + # Cache code completion information on parse. This adds time to parsing but + # speeds up code completion. + PARSE_CACHE_COMPLETION_RESULTS = 8 + + # Flags with values 16 and 32 are deprecated and intentionally omitted. + + # Do not parse function bodies. This is useful if you only care about + # searching for declarations/definitions. + PARSE_SKIP_FUNCTION_BODIES = 64 + + # Used to indicate that brief documentation comments should be included + # into the set of code completions returned from this translation unit. + PARSE_INCLUDE_BRIEF_COMMENTS_IN_CODE_COMPLETION = 128 + + @classmethod + def from_source(cls, filename, args=None, unsaved_files=None, options=0, + index=None): + """Create a TranslationUnit by parsing source. + + This is capable of processing source code both from files on the + filesystem as well as in-memory contents. + + Command-line arguments that would be passed to clang are specified as + a list via args. These can be used to specify include paths, warnings, + etc. e.g. ["-Wall", "-I/path/to/include"]. + + In-memory file content can be provided via unsaved_files. This is an + iterable of 2-tuples. The first element is the str filename. The + second element defines the content. Content can be provided as str + source code or as file objects (anything with a read() method). If + a file object is being used, content will be read until EOF and the + read cursor will not be reset to its original position. + + options is a bitwise or of TranslationUnit.PARSE_XXX flags which will + control parsing behavior. + + index is an Index instance to utilize. If not provided, a new Index + will be created for this TranslationUnit. + + To parse source from the filesystem, the filename of the file to parse + is specified by the filename argument. Or, filename could be None and + the args list would contain the filename(s) to parse. + + To parse source from an in-memory buffer, set filename to the virtual + filename you wish to associate with this source (e.g. "test.c"). The + contents of that file are then provided in unsaved_files. + + If an error occurs, a TranslationUnitLoadError is raised. + + Please note that a TranslationUnit with parser errors may be returned. + It is the caller's responsibility to check tu.diagnostics for errors. + + Also note that Clang infers the source language from the extension of + the input filename. If you pass in source code containing a C++ class + declaration with the filename "test.c" parsing will fail. + """ + if args is None: + args = [] + + if unsaved_files is None: + unsaved_files = [] + + if index is None: + index = Index.create() + + if isinstance(filename, str): + filename = filename.encode('utf8') + + args_length = len(args) + if args_length > 0: + args = (arg.encode('utf8') if isinstance(arg, str) else arg + for arg in args) + args_array = (c_char_p * args_length)(* args) + + unsaved_array = None + if len(unsaved_files) > 0: + unsaved_array = (_CXUnsavedFile * len(unsaved_files))() + for i, (name, contents) in enumerate(unsaved_files): + if hasattr(contents, "read"): + contents = contents.read() + + unsaved_array[i].name = name + unsaved_array[i].contents = contents + unsaved_array[i].length = len(contents) + + ptr = conf.lib.clang_parseTranslationUnit(index, filename, args_array, + args_length, unsaved_array, + len(unsaved_files), options) + + if not ptr: + raise TranslationUnitLoadError("Error parsing translation unit.") + + return cls(ptr, index=index) + + @classmethod + def from_ast_file(cls, filename, index=None): + """Create a TranslationUnit instance from a saved AST file. + + A previously-saved AST file (provided with -emit-ast or + TranslationUnit.save()) is loaded from the filename specified. + + If the file cannot be loaded, a TranslationUnitLoadError will be + raised. + + index is optional and is the Index instance to use. If not provided, + a default Index will be created. + """ + if index is None: + index = Index.create() + + ptr = conf.lib.clang_createTranslationUnit(index, filename) + if not ptr: + raise TranslationUnitLoadError(filename) + + return cls(ptr=ptr, index=index) + + def __init__(self, ptr, index): + """Create a TranslationUnit instance. + + TranslationUnits should be created using one of the from_* @classmethod + functions above. __init__ is only called internally. + """ + assert isinstance(index, Index) + self.index = index + ClangObject.__init__(self, ptr) + + def __del__(self): + conf.lib.clang_disposeTranslationUnit(self) + + @property + def cursor(self): + """Retrieve the cursor that represents the given translation unit.""" + return conf.lib.clang_getTranslationUnitCursor(self) + + @property + def spelling(self): + """Get the original translation unit source file name.""" + return conf.lib.clang_getTranslationUnitSpelling(self) + + def get_includes(self): + """ + Return an iterable sequence of FileInclusion objects that describe the + sequence of inclusions in a translation unit. The first object in + this sequence is always the input file. Note that this method will not + recursively iterate over header files included through precompiled + headers. + """ + def visitor(fobj, lptr, depth, includes): + if depth > 0: + loc = lptr.contents + includes.append(FileInclusion(loc.file, File(fobj), loc, depth)) + + # Automatically adapt CIndex/ctype pointers to python objects + includes = [] + conf.lib.clang_getInclusions(self, + callbacks['translation_unit_includes'](visitor), includes) + + return iter(includes) + + def get_file(self, filename): + """Obtain a File from this translation unit.""" + + return File.from_name(self, filename) + + def get_location(self, filename, position): + """Obtain a SourceLocation for a file in this translation unit. + + The position can be specified by passing: + + - Integer file offset. Initial file offset is 0. + - 2-tuple of (line number, column number). Initial file position is + (0, 0) + """ + f = self.get_file(filename) + + if isinstance(position, int): + return SourceLocation.from_offset(self, f, position) + + return SourceLocation.from_position(self, f, position[0], position[1]) + + def get_extent(self, filename, locations): + """Obtain a SourceRange from this translation unit. + + The bounds of the SourceRange must ultimately be defined by a start and + end SourceLocation. For the locations argument, you can pass: + + - 2 SourceLocation instances in a 2-tuple or list. + - 2 int file offsets via a 2-tuple or list. + - 2 2-tuple or lists of (line, column) pairs in a 2-tuple or list. + + e.g. + + get_extent('foo.c', (5, 10)) + get_extent('foo.c', ((1, 1), (1, 15))) + """ + f = self.get_file(filename) + + if len(locations) < 2: + raise Exception('Must pass object with at least 2 elements') + + start_location, end_location = locations + + if hasattr(start_location, '__len__'): + start_location = SourceLocation.from_position(self, f, + start_location[0], start_location[1]) + elif isinstance(start_location, int): + start_location = SourceLocation.from_offset(self, f, + start_location) + + if hasattr(end_location, '__len__'): + end_location = SourceLocation.from_position(self, f, + end_location[0], end_location[1]) + elif isinstance(end_location, int): + end_location = SourceLocation.from_offset(self, f, end_location) + + assert isinstance(start_location, SourceLocation) + assert isinstance(end_location, SourceLocation) + + return SourceRange.from_locations(start_location, end_location) + + @property + def diagnostics(self): + """ + Return an iterable (and indexable) object containing the diagnostics. + """ + class DiagIterator: + def __init__(self, tu): + self.tu = tu + + def __len__(self): + return int(conf.lib.clang_getNumDiagnostics(self.tu)) + + def __getitem__(self, key): + diag = conf.lib.clang_getDiagnostic(self.tu, key) + if not diag: + raise IndexError + return Diagnostic(diag) + + return DiagIterator(self) + + def reparse(self, unsaved_files=None, options=0): + """ + Reparse an already parsed translation unit. + + In-memory contents for files can be provided by passing a list of pairs + as unsaved_files, the first items should be the filenames to be mapped + and the second should be the contents to be substituted for the + file. The contents may be passed as strings or file objects. + """ + if unsaved_files is None: + unsaved_files = [] + + unsaved_files_array = 0 + if len(unsaved_files): + unsaved_files_array = (_CXUnsavedFile * len(unsaved_files))() + for i,(name,value) in enumerate(unsaved_files): + if not isinstance(value, str): + # FIXME: It would be great to support an efficient version + # of this, one day. + value = value.read() + print(value) + if not isinstance(value, str): + raise TypeError('Unexpected unsaved file contents.') + unsaved_files_array[i].name = name + unsaved_files_array[i].contents = value + unsaved_files_array[i].length = len(value) + ptr = conf.lib.clang_reparseTranslationUnit(self, len(unsaved_files), + unsaved_files_array, options) + + def save(self, filename): + """Saves the TranslationUnit to a file. + + This is equivalent to passing -emit-ast to the clang frontend. The + saved file can be loaded back into a TranslationUnit. Or, if it + corresponds to a header, it can be used as a pre-compiled header file. + + If an error occurs while saving, a TranslationUnitSaveError is raised. + If the error was TranslationUnitSaveError.ERROR_INVALID_TU, this means + the constructed TranslationUnit was not valid at time of save. In this + case, the reason(s) why should be available via + TranslationUnit.diagnostics(). + + filename -- The path to save the translation unit to. + """ + options = conf.lib.clang_defaultSaveOptions(self) + result = int(conf.lib.clang_saveTranslationUnit(self, filename, + options)) + if result != 0: + raise TranslationUnitSaveError(result, + 'Error saving TranslationUnit.') + + def codeComplete(self, path, line, column, unsaved_files=None, + include_macros=False, include_code_patterns=False, + include_brief_comments=False): + """ + Code complete in this translation unit. + + In-memory contents for files can be provided by passing a list of pairs + as unsaved_files, the first items should be the filenames to be mapped + and the second should be the contents to be substituted for the + file. The contents may be passed as strings or file objects. + """ + options = 0 + + if include_macros: + options += 1 + + if include_code_patterns: + options += 2 + + if include_brief_comments: + options += 4 + + if unsaved_files is None: + unsaved_files = [] + + unsaved_files_array = 0 + if len(unsaved_files): + unsaved_files_array = (_CXUnsavedFile * len(unsaved_files))() + for i,(name,value) in enumerate(unsaved_files): + if not isinstance(value, str): + # FIXME: It would be great to support an efficient version + # of this, one day. + value = value.read() + print(value) + if not isinstance(value, str): + raise TypeError('Unexpected unsaved file contents.') + unsaved_files_array[i].name = name + unsaved_files_array[i].contents = value + unsaved_files_array[i].length = len(value) + ptr = conf.lib.clang_codeCompleteAt(self, path, line, column, + unsaved_files_array, len(unsaved_files), options) + if ptr: + return CodeCompletionResults(ptr) + return None + + def get_tokens(self, locations=None, extent=None): + """Obtain tokens in this translation unit. + + This is a generator for Token instances. The caller specifies a range + of source code to obtain tokens for. The range can be specified as a + 2-tuple of SourceLocation or as a SourceRange. If both are defined, + behavior is undefined. + """ + if locations is not None: + extent = SourceRange(start=locations[0], end=locations[1]) + + return TokenGroup.get_tokens(self, extent) + +class File(ClangObject): + """ + The File class represents a particular source file that is part of a + translation unit. + """ + + @staticmethod + def from_name(translation_unit, file_name): + """Retrieve a file handle within the given translation unit.""" + return File(conf.lib.clang_getFile(translation_unit, file_name)) + + @property + def name(self): + """Return the complete file and path name of the file.""" + return conf.lib.clang_getCString(conf.lib.clang_getFileName(self)) + + @property + def time(self): + """Return the last modification time of the file.""" + return conf.lib.clang_getFileTime(self) + + def __bytes__(self): + return self.name + + def __repr__(self): + return "" % (self.name) + + @staticmethod + def from_cursor_result(res, fn, args): + assert isinstance(res, File) + + # Copy a reference to the TranslationUnit to prevent premature GC. + res._tu = args[0]._tu + return res + +class FileInclusion(object): + """ + The FileInclusion class represents the inclusion of one source file by + another via a '#include' directive or as the input file for the translation + unit. This class provides information about the included file, the including + file, the location of the '#include' directive and the depth of the included + file in the stack. Note that the input file has depth 0. + """ + + def __init__(self, src, tgt, loc, depth): + self.source = src + self.include = tgt + self.location = loc + self.depth = depth + + @property + def is_input_file(self): + """True if the included file is the input file.""" + return self.depth == 0 + +class CompilationDatabaseError(Exception): + """Represents an error that occurred when working with a CompilationDatabase + + Each error is associated to an enumerated value, accessible under + e.cdb_error. Consumers can compare the value with one of the ERROR_ + constants in this class. + """ + + # An unknown error occurred + ERROR_UNKNOWN = 0 + + # The database could not be loaded + ERROR_CANNOTLOADDATABASE = 1 + + def __init__(self, enumeration, message): + assert isinstance(enumeration, int) + + if enumeration > 1: + raise Exception("Encountered undefined CompilationDatabase error " + "constant: %d. Please file a bug to have this " + "value supported." % enumeration) + + self.cdb_error = enumeration + Exception.__init__(self, 'Error %d: %s' % (enumeration, message)) + +class CompileCommand(object): + """Represents the compile command used to build a file""" + def __init__(self, cmd, ccmds): + self.cmd = cmd + # Keep a reference to the originating CompileCommands + # to prevent garbage collection + self.ccmds = ccmds + + @property + def directory(self): + """Get the working directory for this CompileCommand""" + return conf.lib.clang_CompileCommand_getDirectory(self.cmd) + + @property + def filename(self): + """Get the working filename for this CompileCommand""" + return conf.lib.clang_CompileCommand_getFilename(self.cmd) + + @property + def arguments(self): + """ + Get an iterable object providing each argument in the + command line for the compiler invocation as a _CXString. + + Invariant : the first argument is the compiler executable + """ + length = conf.lib.clang_CompileCommand_getNumArgs(self.cmd) + for i in range(length): + yield conf.lib.clang_CompileCommand_getArg(self.cmd, i) + +class CompileCommands(object): + """ + CompileCommands is an iterable object containing all CompileCommand + that can be used for building a specific file. + """ + def __init__(self, ccmds): + self.ccmds = ccmds + + def __del__(self): + conf.lib.clang_CompileCommands_dispose(self.ccmds) + + def __len__(self): + return int(conf.lib.clang_CompileCommands_getSize(self.ccmds)) + + def __getitem__(self, i): + cc = conf.lib.clang_CompileCommands_getCommand(self.ccmds, i) + if not cc: + raise IndexError + return CompileCommand(cc, self) + + @staticmethod + def from_result(res, fn, args): + if not res: + return None + return CompileCommands(res) + +class CompilationDatabase(ClangObject): + """ + The CompilationDatabase is a wrapper class around + clang::tooling::CompilationDatabase + + It enables querying how a specific source file can be built. + """ + + def __del__(self): + conf.lib.clang_CompilationDatabase_dispose(self) + + @staticmethod + def from_result(res, fn, args): + if not res: + raise CompilationDatabaseError(0, + "CompilationDatabase loading failed") + return CompilationDatabase(res) + + @staticmethod + def fromDirectory(buildDir): + """Builds a CompilationDatabase from the database found in buildDir""" + errorCode = c_uint() + try: + cdb = conf.lib.clang_CompilationDatabase_fromDirectory(buildDir, + byref(errorCode)) + except CompilationDatabaseError as e: + raise CompilationDatabaseError(int(errorCode.value), + "CompilationDatabase loading failed") + return cdb + + def getCompileCommands(self, filename): + """ + Get an iterable object providing all the CompileCommands available to + build filename. Returns None if filename is not found in the database. + """ + return conf.lib.clang_CompilationDatabase_getCompileCommands(self, + filename) + + def getAllCompileCommands(self): + """ + Get an iterable object providing all the CompileCommands available from + the database. + """ + return conf.lib.clang_CompilationDatabase_getAllCompileCommands(self) + + +class Token(Structure): + """Represents a single token from the preprocessor. + + Tokens are effectively segments of source code. Source code is first parsed + into tokens before being converted into the AST and Cursors. + + Tokens are obtained from parsed TranslationUnit instances. You currently + can't create tokens manually. + """ + _fields_ = [ + ('int_data', c_uint * 4), + ('ptr_data', c_void_p) + ] + + @property + def spelling(self): + """The spelling of this token. + + This is the textual representation of the token in source. + """ + return conf.lib.clang_getTokenSpelling(self._tu, self) + + @property + def kind(self): + """Obtain the TokenKind of the current token.""" + return TokenKind.from_value(conf.lib.clang_getTokenKind(self)) + + @property + def location(self): + """The SourceLocation this Token occurs at.""" + return conf.lib.clang_getTokenLocation(self._tu, self) + + @property + def extent(self): + """The SourceRange this Token occupies.""" + return conf.lib.clang_getTokenExtent(self._tu, self) + + @property + def cursor(self): + """The Cursor this Token corresponds to.""" + cursor = Cursor() + + conf.lib.clang_annotateTokens(self._tu, byref(self), 1, byref(cursor)) + + return cursor + +# Now comes the plumbing to hook up the C library. + +# Register callback types in common container. +callbacks['translation_unit_includes'] = CFUNCTYPE(None, c_object_p, + POINTER(SourceLocation), c_uint, py_object) +callbacks['cursor_visit'] = CFUNCTYPE(c_int, Cursor, Cursor, py_object) +callbacks['fields_visit'] = CFUNCTYPE(c_int, Cursor, py_object) + +# Functions strictly alphabetical order. +functionList = [ + ("clang_annotateTokens", + [TranslationUnit, POINTER(Token), c_uint, POINTER(Cursor)]), + + ("clang_CompilationDatabase_dispose", + [c_object_p]), + + ("clang_CompilationDatabase_fromDirectory", + [c_char_p, POINTER(c_uint)], + c_object_p, + CompilationDatabase.from_result), + + ("clang_CompilationDatabase_getAllCompileCommands", + [c_object_p], + c_object_p, + CompileCommands.from_result), + + ("clang_CompilationDatabase_getCompileCommands", + [c_object_p, c_char_p], + c_object_p, + CompileCommands.from_result), + + ("clang_CompileCommands_dispose", + [c_object_p]), + + ("clang_CompileCommands_getCommand", + [c_object_p, c_uint], + c_object_p), + + ("clang_CompileCommands_getSize", + [c_object_p], + c_uint), + + ("clang_CompileCommand_getArg", + [c_object_p, c_uint], + _CXString, + _CXString.from_result), + + ("clang_CompileCommand_getDirectory", + [c_object_p], + _CXString, + _CXString.from_result), + + ("clang_CompileCommand_getFilename", + [c_object_p], + _CXString, + _CXString.from_result), + + ("clang_CompileCommand_getNumArgs", + [c_object_p], + c_uint), + + ("clang_codeCompleteAt", + [TranslationUnit, c_char_p, c_int, c_int, c_void_p, c_int, c_int], + POINTER(CCRStructure)), + + ("clang_codeCompleteGetDiagnostic", + [CodeCompletionResults, c_int], + Diagnostic), + + ("clang_codeCompleteGetNumDiagnostics", + [CodeCompletionResults], + c_int), + + ("clang_createIndex", + [c_int, c_int], + c_object_p), + + ("clang_createTranslationUnit", + [Index, c_char_p], + c_object_p), + + ("clang_CXXConstructor_isConvertingConstructor", + [Cursor], + bool), + + ("clang_CXXConstructor_isCopyConstructor", + [Cursor], + bool), + + ("clang_CXXConstructor_isDefaultConstructor", + [Cursor], + bool), + + ("clang_CXXConstructor_isMoveConstructor", + [Cursor], + bool), + + ("clang_CXXField_isMutable", + [Cursor], + bool), + + ("clang_CXXMethod_isConst", + [Cursor], + bool), + + ("clang_CXXMethod_isDefaulted", + [Cursor], + bool), + + ("clang_CXXMethod_isPureVirtual", + [Cursor], + bool), + + ("clang_CXXMethod_isStatic", + [Cursor], + bool), + + ("clang_CXXMethod_isVirtual", + [Cursor], + bool), + + ("clang_defaultDiagnosticDisplayOptions", + [], + c_uint), + + ("clang_defaultSaveOptions", + [TranslationUnit], + c_uint), + + ("clang_disposeCodeCompleteResults", + [CodeCompletionResults]), + +# ("clang_disposeCXTUResourceUsage", +# [CXTUResourceUsage]), + + ("clang_disposeDiagnostic", + [Diagnostic]), + + ("clang_disposeIndex", + [Index]), + + ("clang_disposeString", + [_CXString]), + + ("clang_disposeTokens", + [TranslationUnit, POINTER(Token), c_uint]), + + ("clang_disposeTranslationUnit", + [TranslationUnit]), + + ("clang_equalCursors", + [Cursor, Cursor], + bool), + + ("clang_equalLocations", + [SourceLocation, SourceLocation], + bool), + + ("clang_equalRanges", + [SourceRange, SourceRange], + bool), + + ("clang_equalTypes", + [Type, Type], + bool), + + ("clang_formatDiagnostic", + [Diagnostic, c_uint], + _CXString), + + ("clang_getArgType", + [Type, c_uint], + Type, + Type.from_result), + + ("clang_getArrayElementType", + [Type], + Type, + Type.from_result), + + ("clang_getArraySize", + [Type], + c_longlong), + + ("clang_getFieldDeclBitWidth", + [Cursor], + c_int), + + ("clang_getCanonicalCursor", + [Cursor], + Cursor, + Cursor.from_cursor_result), + + ("clang_getCanonicalType", + [Type], + Type, + Type.from_result), + + ("clang_getChildDiagnostics", + [Diagnostic], + c_object_p), + + ("clang_getCompletionAvailability", + [c_void_p], + c_int), + + ("clang_getCompletionBriefComment", + [c_void_p], + _CXString), + + ("clang_getCompletionChunkCompletionString", + [c_void_p, c_int], + c_object_p), + + ("clang_getCompletionChunkKind", + [c_void_p, c_int], + c_int), + + ("clang_getCompletionChunkText", + [c_void_p, c_int], + _CXString), + + ("clang_getCompletionPriority", + [c_void_p], + c_int), + + ("clang_getCString", + [_CXString], + c_char_p), + + ("clang_getCursor", + [TranslationUnit, SourceLocation], + Cursor), + + ("clang_getCursorDefinition", + [Cursor], + Cursor, + Cursor.from_result), + + ("clang_getCursorDisplayName", + [Cursor], + _CXString, + _CXString.from_result), + + ("clang_getCursorExtent", + [Cursor], + SourceRange), + + ("clang_getCursorLexicalParent", + [Cursor], + Cursor, + Cursor.from_cursor_result), + + ("clang_getCursorLocation", + [Cursor], + SourceLocation), + + ("clang_getCursorReferenced", + [Cursor], + Cursor, + Cursor.from_result), + + ("clang_getCursorReferenceNameRange", + [Cursor, c_uint, c_uint], + SourceRange), + + ("clang_getCursorSemanticParent", + [Cursor], + Cursor, + Cursor.from_cursor_result), + + ("clang_getCursorSpelling", + [Cursor], + _CXString, + _CXString.from_result), + + ("clang_getCursorType", + [Cursor], + Type, + Type.from_result), + + ("clang_getCursorUSR", + [Cursor], + _CXString, + _CXString.from_result), + + ("clang_Cursor_getMangling", + [Cursor], + _CXString, + _CXString.from_result), + +# ("clang_getCXTUResourceUsage", +# [TranslationUnit], +# CXTUResourceUsage), + + ("clang_getCXXAccessSpecifier", + [Cursor], + c_uint), + + ("clang_getDeclObjCTypeEncoding", + [Cursor], + _CXString, + _CXString.from_result), + + ("clang_getDiagnostic", + [c_object_p, c_uint], + c_object_p), + + ("clang_getDiagnosticCategory", + [Diagnostic], + c_uint), + + ("clang_getDiagnosticCategoryText", + [Diagnostic], + _CXString, + _CXString.from_result), + + ("clang_getDiagnosticFixIt", + [Diagnostic, c_uint, POINTER(SourceRange)], + _CXString, + _CXString.from_result), + + ("clang_getDiagnosticInSet", + [c_object_p, c_uint], + c_object_p), + + ("clang_getDiagnosticLocation", + [Diagnostic], + SourceLocation), + + ("clang_getDiagnosticNumFixIts", + [Diagnostic], + c_uint), + + ("clang_getDiagnosticNumRanges", + [Diagnostic], + c_uint), + + ("clang_getDiagnosticOption", + [Diagnostic, POINTER(_CXString)], + _CXString, + _CXString.from_result), + + ("clang_getDiagnosticRange", + [Diagnostic, c_uint], + SourceRange), + + ("clang_getDiagnosticSeverity", + [Diagnostic], + c_int), + + ("clang_getDiagnosticSpelling", + [Diagnostic], + _CXString, + _CXString.from_result), + + ("clang_getElementType", + [Type], + Type, + Type.from_result), + + ("clang_getEnumConstantDeclUnsignedValue", + [Cursor], + c_ulonglong), + + ("clang_getEnumConstantDeclValue", + [Cursor], + c_longlong), + + ("clang_getEnumDeclIntegerType", + [Cursor], + Type, + Type.from_result), + + ("clang_getFile", + [TranslationUnit, c_char_p], + c_object_p), + + ("clang_getFileName", + [File], + _CXString), # TODO go through _CXString.from_result? + + ("clang_getFileTime", + [File], + c_uint), + + ("clang_getIBOutletCollectionType", + [Cursor], + Type, + Type.from_result), + + ("clang_getIncludedFile", + [Cursor], + File, + File.from_cursor_result), + + ("clang_getInclusions", + [TranslationUnit, callbacks['translation_unit_includes'], py_object]), + + ("clang_getInstantiationLocation", + [SourceLocation, POINTER(c_object_p), POINTER(c_uint), POINTER(c_uint), + POINTER(c_uint)]), + + ("clang_getLocation", + [TranslationUnit, File, c_uint, c_uint], + SourceLocation), + + ("clang_getLocationForOffset", + [TranslationUnit, File, c_uint], + SourceLocation), + + ("clang_getNullCursor", + None, + Cursor), + + ("clang_getNumArgTypes", + [Type], + c_uint), + + ("clang_getNumCompletionChunks", + [c_void_p], + c_int), + + ("clang_getNumDiagnostics", + [c_object_p], + c_uint), + + ("clang_getNumDiagnosticsInSet", + [c_object_p], + c_uint), + + ("clang_getNumElements", + [Type], + c_longlong), + + ("clang_getNumOverloadedDecls", + [Cursor], + c_uint), + + ("clang_getOverloadedDecl", + [Cursor, c_uint], + Cursor, + Cursor.from_cursor_result), + + ("clang_getPointeeType", + [Type], + Type, + Type.from_result), + + ("clang_getRange", + [SourceLocation, SourceLocation], + SourceRange), + + ("clang_getRangeEnd", + [SourceRange], + SourceLocation), + + ("clang_getRangeStart", + [SourceRange], + SourceLocation), + + ("clang_getResultType", + [Type], + Type, + Type.from_result), + + ("clang_getSpecializedCursorTemplate", + [Cursor], + Cursor, + Cursor.from_cursor_result), + + ("clang_getTemplateCursorKind", + [Cursor], + c_uint), + + ("clang_getTokenExtent", + [TranslationUnit, Token], + SourceRange), + + ("clang_getTokenKind", + [Token], + c_uint), + + ("clang_getTokenLocation", + [TranslationUnit, Token], + SourceLocation), + + ("clang_getTokenSpelling", + [TranslationUnit, Token], + _CXString, + _CXString.from_result), + + ("clang_getTranslationUnitCursor", + [TranslationUnit], + Cursor, + Cursor.from_result), + + ("clang_getTranslationUnitSpelling", + [TranslationUnit], + _CXString, + _CXString.from_result), + + ("clang_getTUResourceUsageName", + [c_uint], + c_char_p), + + ("clang_getTypeDeclaration", + [Type], + Cursor, + Cursor.from_result), + + ("clang_getTypedefDeclUnderlyingType", + [Cursor], + Type, + Type.from_result), + + ("clang_getTypeKindSpelling", + [c_uint], + _CXString, + _CXString.from_result), + + ("clang_getTypeSpelling", + [Type], + _CXString, + _CXString.from_result), + + ("clang_hashCursor", + [Cursor], + c_uint), + + ("clang_isAttribute", + [CursorKind], + bool), + + ("clang_isConstQualifiedType", + [Type], + bool), + + ("clang_isCursorDefinition", + [Cursor], + bool), + + ("clang_isDeclaration", + [CursorKind], + bool), + + ("clang_isExpression", + [CursorKind], + bool), + + ("clang_isFileMultipleIncludeGuarded", + [TranslationUnit, File], + bool), + + ("clang_isFunctionTypeVariadic", + [Type], + bool), + + ("clang_isInvalid", + [CursorKind], + bool), + + ("clang_isPODType", + [Type], + bool), + + ("clang_isPreprocessing", + [CursorKind], + bool), + + ("clang_isReference", + [CursorKind], + bool), + + ("clang_isRestrictQualifiedType", + [Type], + bool), + + ("clang_isStatement", + [CursorKind], + bool), + + ("clang_isTranslationUnit", + [CursorKind], + bool), + + ("clang_isUnexposed", + [CursorKind], + bool), + + ("clang_isVirtualBase", + [Cursor], + bool), + + ("clang_isVolatileQualifiedType", + [Type], + bool), + + ("clang_parseTranslationUnit", + [Index, c_char_p, c_void_p, c_int, c_void_p, c_int, c_int], + c_object_p), + + ("clang_reparseTranslationUnit", + [TranslationUnit, c_int, c_void_p, c_int], + c_int), + + ("clang_saveTranslationUnit", + [TranslationUnit, c_char_p, c_uint], + c_int), + + ("clang_tokenize", + [TranslationUnit, SourceRange, POINTER(POINTER(Token)), POINTER(c_uint)]), + + ("clang_visitChildren", + [Cursor, callbacks['cursor_visit'], py_object], + c_uint), + + ("clang_Cursor_getNumArguments", + [Cursor], + c_int), + + ("clang_Cursor_getArgument", + [Cursor, c_uint], + Cursor, + Cursor.from_result), + + ("clang_Cursor_getNumTemplateArguments", + [Cursor], + c_int), + + ("clang_Cursor_getTemplateArgumentKind", + [Cursor, c_uint], + TemplateArgumentKind.from_id), + + ("clang_Cursor_getTemplateArgumentType", + [Cursor, c_uint], + Type, + Type.from_result), + + ("clang_Cursor_getTemplateArgumentValue", + [Cursor, c_uint], + c_longlong), + + ("clang_Cursor_getTemplateArgumentUnsignedValue", + [Cursor, c_uint], + c_ulonglong), + + ("clang_Cursor_isAnonymous", + [Cursor], + bool), + + ("clang_Cursor_isBitField", + [Cursor], + bool), + + ("clang_Cursor_getBriefCommentText", + [Cursor], + _CXString, + _CXString.from_result), + + ("clang_Cursor_getRawCommentText", + [Cursor], + _CXString, + _CXString.from_result), + + ("clang_Cursor_getOffsetOfField", + [Cursor], + c_longlong), + + ("clang_Type_getAlignOf", + [Type], + c_longlong), + + ("clang_Type_getClassType", + [Type], + Type, + Type.from_result), + + ("clang_Type_getOffsetOf", + [Type, c_char_p], + c_longlong), + + ("clang_Type_getSizeOf", + [Type], + c_longlong), + + ("clang_Type_getCXXRefQualifier", + [Type], + c_uint), + + ("clang_Type_getNamedType", + [Type], + Type, + Type.from_result), + + ("clang_Type_visitFields", + [Type, callbacks['fields_visit'], py_object], + c_uint), +] + +class LibclangError(Exception): + def __init__(self, message): + self.m = message + + def __str__(self): + return self.m + +def register_function(lib, item, ignore_errors): + # A function may not exist, if these bindings are used with an older or + # incompatible version of libclang.so. + try: + func = getattr(lib, item[0]) + except AttributeError as e: + msg = str(e) + ". Please ensure that your python bindings are "\ + "compatible with your libclang.so version." + if ignore_errors: + return + raise LibclangError(msg) + + if len(item) >= 2: + func.argtypes = item[1] + + if len(item) >= 3: + func.restype = item[2] + + if len(item) == 4: + func.errcheck = item[3] + +def register_functions(lib, ignore_errors): + """Register function prototypes with a libclang library instance. + + This must be called as part of library instantiation so Python knows how + to call out to the shared library. + """ + + def register(item): + return register_function(lib, item, ignore_errors) + + for f in functionList: + register(f) + +class Config: + library_path = None + library_file = None + compatibility_check = False + loaded = False + + @staticmethod + def set_library_path(path): + """Set the path in which to search for libclang""" + if Config.loaded: + raise Exception("library path must be set before before using " \ + "any other functionalities in libclang.") + + Config.library_path = path + + @staticmethod + def set_library_file(filename): + """Set the exact location of libclang""" + if Config.loaded: + raise Exception("library file must be set before before using " \ + "any other functionalities in libclang.") + + Config.library_file = filename + + @staticmethod + def set_compatibility_check(check_status): + """ Perform compatibility check when loading libclang + + The python bindings are only tested and evaluated with the version of + libclang they are provided with. To ensure correct behavior a (limited) + compatibility check is performed when loading the bindings. This check + will throw an exception, as soon as it fails. + + In case these bindings are used with an older version of libclang, parts + that have been stable between releases may still work. Users of the + python bindings can disable the compatibility check. This will cause + the python bindings to load, even though they are written for a newer + version of libclang. Failures now arise if unsupported or incompatible + features are accessed. The user is required to test themselves if the + features they are using are available and compatible between different + libclang versions. + """ + if Config.loaded: + raise Exception("compatibility_check must be set before before " \ + "using any other functionalities in libclang.") + + Config.compatibility_check = check_status + + @CachedProperty + def lib(self): + lib = self.get_cindex_library() + register_functions(lib, not Config.compatibility_check) + Config.loaded = True + return lib + + def get_filename(self): + if Config.library_file: + return Config.library_file + + import platform + name = platform.system() + + if name == 'Darwin': + file = 'libclang.dylib' + elif name == 'Windows': + file = 'libclang.dll' + else: + file = 'libclang.so' + + if Config.library_path: + file = Config.library_path + '/' + file + + return file + + def get_cindex_library(self): + try: + library = cdll.LoadLibrary(self.get_filename()) + except OSError as e: + msg = str(e) + ". To provide a path to libclang use " \ + "Config.set_library_path() or " \ + "Config.set_library_file()." + raise LibclangError(msg) + + return library + + def function_exists(self, name): + try: + getattr(self.lib, name) + except AttributeError: + return False + + return True + +def register_enumerations(): + for name, value in clang.enumerations.TokenKinds: + TokenKind.register(value, name) + +conf = Config() +register_enumerations() + +__all__ = [ + 'Config', + 'CodeCompletionResults', + 'CompilationDatabase', + 'CompileCommands', + 'CompileCommand', + 'CursorKind', + 'Cursor', + 'Diagnostic', + 'File', + 'FixIt', + 'Index', + 'SourceLocation', + 'SourceRange', + 'TokenKind', + 'Token', + 'TranslationUnitLoadError', + 'TranslationUnit', + 'TypeKind', + 'Type', +] diff --git a/plugins/python/pybind11/tools/clang/enumerations.py b/plugins/python/pybind11/tools/clang/enumerations.py new file mode 100644 index 0000000..a86a48a --- /dev/null +++ b/plugins/python/pybind11/tools/clang/enumerations.py @@ -0,0 +1,34 @@ +#===- enumerations.py - Python Enumerations ------------------*- python -*--===# +# +# The LLVM Compiler Infrastructure +# +# This file is distributed under the University of Illinois Open Source +# License. See LICENSE.TXT for details. +# +#===------------------------------------------------------------------------===# + +""" +Clang Enumerations +================== + +This module provides static definitions of enumerations that exist in libclang. + +Enumerations are typically defined as a list of tuples. The exported values are +typically munged into other types or classes at module load time. + +All enumerations are centrally defined in this file so they are all grouped +together and easier to audit. And, maybe even one day this file will be +automatically generated by scanning the libclang headers! +""" + +# Maps to CXTokenKind. Note that libclang maintains a separate set of token +# enumerations from the C++ API. +TokenKinds = [ + ('PUNCTUATION', 0), + ('KEYWORD', 1), + ('IDENTIFIER', 2), + ('LITERAL', 3), + ('COMMENT', 4), +] + +__all__ = ['TokenKinds'] diff --git a/plugins/python/pybind11/tools/libsize.py b/plugins/python/pybind11/tools/libsize.py new file mode 100644 index 0000000..5dcb8b0 --- /dev/null +++ b/plugins/python/pybind11/tools/libsize.py @@ -0,0 +1,38 @@ +from __future__ import print_function, division +import os +import sys + +# Internal build script for generating debugging test .so size. +# Usage: +# python libsize.py file.so save.txt -- displays the size of file.so and, if save.txt exists, compares it to the +# size in it, then overwrites save.txt with the new size for future runs. + +if len(sys.argv) != 3: + sys.exit("Invalid arguments: usage: python libsize.py file.so save.txt") + +lib = sys.argv[1] +save = sys.argv[2] + +if not os.path.exists(lib): + sys.exit("Error: requested file ({}) does not exist".format(lib)) + +libsize = os.path.getsize(lib) + +print("------", os.path.basename(lib), "file size:", libsize, end='') + +if os.path.exists(save): + with open(save) as sf: + oldsize = int(sf.readline()) + + if oldsize > 0: + change = libsize - oldsize + if change == 0: + print(" (no change)") + else: + print(" (change of {:+} bytes = {:+.2%})".format(change, change / oldsize)) +else: + print() + +with open(save, 'w') as sf: + sf.write(str(libsize)) + diff --git a/plugins/python/pybind11/tools/mkdoc.py b/plugins/python/pybind11/tools/mkdoc.py new file mode 100644 index 0000000..1fd8cce --- /dev/null +++ b/plugins/python/pybind11/tools/mkdoc.py @@ -0,0 +1,304 @@ +#!/usr/bin/env python3 +# +# Syntax: mkdoc.py [-I ..] [.. a list of header files ..] +# +# Extract documentation from C++ header files to use it in Python bindings +# + +import os +import sys +import platform +import re +import textwrap + +from clang import cindex +from clang.cindex import CursorKind +from collections import OrderedDict +from threading import Thread, Semaphore +from multiprocessing import cpu_count + +RECURSE_LIST = [ + CursorKind.TRANSLATION_UNIT, + CursorKind.NAMESPACE, + CursorKind.CLASS_DECL, + CursorKind.STRUCT_DECL, + CursorKind.ENUM_DECL, + CursorKind.CLASS_TEMPLATE +] + +PRINT_LIST = [ + CursorKind.CLASS_DECL, + CursorKind.STRUCT_DECL, + CursorKind.ENUM_DECL, + CursorKind.ENUM_CONSTANT_DECL, + CursorKind.CLASS_TEMPLATE, + CursorKind.FUNCTION_DECL, + CursorKind.FUNCTION_TEMPLATE, + CursorKind.CONVERSION_FUNCTION, + CursorKind.CXX_METHOD, + CursorKind.CONSTRUCTOR, + CursorKind.FIELD_DECL +] + +CPP_OPERATORS = { + '<=': 'le', '>=': 'ge', '==': 'eq', '!=': 'ne', '[]': 'array', + '+=': 'iadd', '-=': 'isub', '*=': 'imul', '/=': 'idiv', '%=': + 'imod', '&=': 'iand', '|=': 'ior', '^=': 'ixor', '<<=': 'ilshift', + '>>=': 'irshift', '++': 'inc', '--': 'dec', '<<': 'lshift', '>>': + 'rshift', '&&': 'land', '||': 'lor', '!': 'lnot', '~': 'bnot', + '&': 'band', '|': 'bor', '+': 'add', '-': 'sub', '*': 'mul', '/': + 'div', '%': 'mod', '<': 'lt', '>': 'gt', '=': 'assign', '()': 'call' +} + +CPP_OPERATORS = OrderedDict( + sorted(CPP_OPERATORS.items(), key=lambda t: -len(t[0]))) + +job_count = cpu_count() +job_semaphore = Semaphore(job_count) + +output = [] + +def d(s): + return s.decode('utf8') + + +def sanitize_name(name): + name = re.sub(r'type-parameter-0-([0-9]+)', r'T\1', name) + for k, v in CPP_OPERATORS.items(): + name = name.replace('operator%s' % k, 'operator_%s' % v) + name = re.sub('<.*>', '', name) + name = ''.join([ch if ch.isalnum() else '_' for ch in name]) + name = re.sub('_$', '', re.sub('_+', '_', name)) + return '__doc_' + name + + +def process_comment(comment): + result = '' + + # Remove C++ comment syntax + leading_spaces = float('inf') + for s in comment.expandtabs(tabsize=4).splitlines(): + s = s.strip() + if s.startswith('/*'): + s = s[2:].lstrip('*') + elif s.endswith('*/'): + s = s[:-2].rstrip('*') + elif s.startswith('///'): + s = s[3:] + if s.startswith('*'): + s = s[1:] + if len(s) > 0: + leading_spaces = min(leading_spaces, len(s) - len(s.lstrip())) + result += s + '\n' + + if leading_spaces != float('inf'): + result2 = "" + for s in result.splitlines(): + result2 += s[leading_spaces:] + '\n' + result = result2 + + # Doxygen tags + cpp_group = '([\w:]+)' + param_group = '([\[\w:\]]+)' + + s = result + s = re.sub(r'\\c\s+%s' % cpp_group, r'``\1``', s) + s = re.sub(r'\\a\s+%s' % cpp_group, r'*\1*', s) + s = re.sub(r'\\e\s+%s' % cpp_group, r'*\1*', s) + s = re.sub(r'\\em\s+%s' % cpp_group, r'*\1*', s) + s = re.sub(r'\\b\s+%s' % cpp_group, r'**\1**', s) + s = re.sub(r'\\ingroup\s+%s' % cpp_group, r'', s) + s = re.sub(r'\\param%s?\s+%s' % (param_group, cpp_group), + r'\n\n$Parameter ``\2``:\n\n', s) + s = re.sub(r'\\tparam%s?\s+%s' % (param_group, cpp_group), + r'\n\n$Template parameter ``\2``:\n\n', s) + + for in_, out_ in { + 'return': 'Returns', + 'author': 'Author', + 'authors': 'Authors', + 'copyright': 'Copyright', + 'date': 'Date', + 'remark': 'Remark', + 'sa': 'See also', + 'see': 'See also', + 'extends': 'Extends', + 'throw': 'Throws', + 'throws': 'Throws' + }.items(): + s = re.sub(r'\\%s\s*' % in_, r'\n\n$%s:\n\n' % out_, s) + + s = re.sub(r'\\details\s*', r'\n\n', s) + s = re.sub(r'\\brief\s*', r'', s) + s = re.sub(r'\\short\s*', r'', s) + s = re.sub(r'\\ref\s*', r'', s) + + s = re.sub(r'\\code\s?(.*?)\s?\\endcode', + r"```\n\1\n```\n", s, flags=re.DOTALL) + + # HTML/TeX tags + s = re.sub(r'(.*?)', r'``\1``', s, flags=re.DOTALL) + s = re.sub(r'
(.*?)
', r"```\n\1\n```\n", s, flags=re.DOTALL) + s = re.sub(r'(.*?)', r'*\1*', s, flags=re.DOTALL) + s = re.sub(r'(.*?)', r'**\1**', s, flags=re.DOTALL) + s = re.sub(r'\\f\$(.*?)\\f\$', r'$\1$', s, flags=re.DOTALL) + s = re.sub(r'
  • ', r'\n\n* ', s) + s = re.sub(r'', r'', s) + s = re.sub(r'
    • ', r'\n\n', s) + + s = s.replace('``true``', '``True``') + s = s.replace('``false``', '``False``') + + # Re-flow text + wrapper = textwrap.TextWrapper() + wrapper.expand_tabs = True + wrapper.replace_whitespace = True + wrapper.drop_whitespace = True + wrapper.width = 70 + wrapper.initial_indent = wrapper.subsequent_indent = '' + + result = '' + in_code_segment = False + for x in re.split(r'(```)', s): + if x == '```': + if not in_code_segment: + result += '```\n' + else: + result += '\n```\n\n' + in_code_segment = not in_code_segment + elif in_code_segment: + result += x.strip() + else: + for y in re.split(r'(?: *\n *){2,}', x): + wrapped = wrapper.fill(re.sub(r'\s+', ' ', y).strip()) + if len(wrapped) > 0 and wrapped[0] == '$': + result += wrapped[1:] + '\n' + wrapper.initial_indent = \ + wrapper.subsequent_indent = ' ' * 4 + else: + if len(wrapped) > 0: + result += wrapped + '\n\n' + wrapper.initial_indent = wrapper.subsequent_indent = '' + return result.rstrip().lstrip('\n') + + +def extract(filename, node, prefix): + if not (node.location.file is None or + os.path.samefile(d(node.location.file.name), filename)): + return 0 + if node.kind in RECURSE_LIST: + sub_prefix = prefix + if node.kind != CursorKind.TRANSLATION_UNIT: + if len(sub_prefix) > 0: + sub_prefix += '_' + sub_prefix += d(node.spelling) + for i in node.get_children(): + extract(filename, i, sub_prefix) + if node.kind in PRINT_LIST: + comment = d(node.raw_comment) if node.raw_comment is not None else '' + comment = process_comment(comment) + sub_prefix = prefix + if len(sub_prefix) > 0: + sub_prefix += '_' + if len(node.spelling) > 0: + name = sanitize_name(sub_prefix + d(node.spelling)) + global output + output.append((name, filename, comment)) + + +class ExtractionThread(Thread): + def __init__(self, filename, parameters): + Thread.__init__(self) + self.filename = filename + self.parameters = parameters + job_semaphore.acquire() + + def run(self): + print('Processing "%s" ..' % self.filename, file=sys.stderr) + try: + index = cindex.Index( + cindex.conf.lib.clang_createIndex(False, True)) + tu = index.parse(self.filename, self.parameters) + extract(self.filename, tu.cursor, '') + finally: + job_semaphore.release() + +if __name__ == '__main__': + parameters = ['-x', 'c++', '-std=c++11'] + filenames = [] + + if platform.system() == 'Darwin': + dev_path = '/Applications/Xcode.app/Contents/Developer/' + lib_dir = dev_path + 'Toolchains/XcodeDefault.xctoolchain/usr/lib/' + sdk_dir = dev_path + 'Platforms/MacOSX.platform/Developer/SDKs' + libclang = lib_dir + 'libclang.dylib' + + if os.path.exists(libclang): + cindex.Config.set_library_path(os.path.dirname(libclang)) + + if os.path.exists(sdk_dir): + sysroot_dir = os.path.join(sdk_dir, next(os.walk(sdk_dir))[1][0]) + parameters.append('-isysroot') + parameters.append(sysroot_dir) + + for item in sys.argv[1:]: + if item.startswith('-'): + parameters.append(item) + else: + filenames.append(item) + + if len(filenames) == 0: + print('Syntax: %s [.. a list of header files ..]' % sys.argv[0]) + exit(-1) + + print('''/* + This file contains docstrings for the Python bindings. + Do not edit! These were automatically extracted by mkdoc.py + */ + +#define __EXPAND(x) x +#define __COUNT(_1, _2, _3, _4, _5, _6, _7, COUNT, ...) COUNT +#define __VA_SIZE(...) __EXPAND(__COUNT(__VA_ARGS__, 7, 6, 5, 4, 3, 2, 1)) +#define __CAT1(a, b) a ## b +#define __CAT2(a, b) __CAT1(a, b) +#define __DOC1(n1) __doc_##n1 +#define __DOC2(n1, n2) __doc_##n1##_##n2 +#define __DOC3(n1, n2, n3) __doc_##n1##_##n2##_##n3 +#define __DOC4(n1, n2, n3, n4) __doc_##n1##_##n2##_##n3##_##n4 +#define __DOC5(n1, n2, n3, n4, n5) __doc_##n1##_##n2##_##n3##_##n4##_##n5 +#define __DOC6(n1, n2, n3, n4, n5, n6) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6 +#define __DOC7(n1, n2, n3, n4, n5, n6, n7) __doc_##n1##_##n2##_##n3##_##n4##_##n5##_##n6##_##n7 +#define DOC(...) __EXPAND(__EXPAND(__CAT2(__DOC, __VA_SIZE(__VA_ARGS__)))(__VA_ARGS__)) + +#if defined(__GNUG__) +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wunused-variable" +#endif +''') + + output.clear() + for filename in filenames: + thr = ExtractionThread(filename, parameters) + thr.start() + + print('Waiting for jobs to finish ..', file=sys.stderr) + for i in range(job_count): + job_semaphore.acquire() + + name_ctr = 1 + name_prev = None + for name, _, comment in list(sorted(output, key=lambda x: (x[0], x[1]))): + if name == name_prev: + name_ctr += 1 + name = name + "_%i" % name_ctr + else: + name_prev = name + name_ctr = 1 + print('\nstatic const char *%s =%sR"doc(%s)doc";' % + (name, '\n' if '\n' in comment else ' ', comment)) + + print(''' +#if defined(__GNUG__) +#pragma GCC diagnostic pop +#endif +''') diff --git a/plugins/python/pybind11/tools/pybind11Config.cmake.in b/plugins/python/pybind11/tools/pybind11Config.cmake.in new file mode 100644 index 0000000..3dd1b2c --- /dev/null +++ b/plugins/python/pybind11/tools/pybind11Config.cmake.in @@ -0,0 +1,100 @@ +# pybind11Config.cmake +# -------------------- +# +# PYBIND11 cmake module. +# This module sets the following variables in your project:: +# +# pybind11_FOUND - true if pybind11 and all required components found on the system +# pybind11_VERSION - pybind11 version in format Major.Minor.Release +# pybind11_INCLUDE_DIRS - Directories where pybind11 and python headers are located. +# pybind11_INCLUDE_DIR - Directory where pybind11 headers are located. +# pybind11_DEFINITIONS - Definitions necessary to use pybind11, namely USING_pybind11. +# pybind11_LIBRARIES - compile flags and python libraries (as needed) to link against. +# pybind11_LIBRARY - empty. +# CMAKE_MODULE_PATH - appends location of accompanying FindPythonLibsNew.cmake and +# pybind11Tools.cmake modules. +# +# +# Available components: None +# +# +# Exported targets:: +# +# If pybind11 is found, this module defines the following :prop_tgt:`IMPORTED` +# interface library targets:: +# +# pybind11::module - for extension modules +# pybind11::embed - for embedding the Python interpreter +# +# Python headers, libraries (as needed by platform), and the C++ standard +# are attached to the target. Set PythonLibsNew variables to influence +# python detection and PYBIND11_CPP_STANDARD (-std=c++11 or -std=c++14) to +# influence standard setting. :: +# +# find_package(pybind11 CONFIG REQUIRED) +# message(STATUS "Found pybind11 v${pybind11_VERSION}: ${pybind11_INCLUDE_DIRS}") +# +# # Create an extension module +# add_library(mylib MODULE main.cpp) +# target_link_libraries(mylib pybind11::module) +# +# # Or embed the Python interpreter into an executable +# add_executable(myexe main.cpp) +# target_link_libraries(myexe pybind11::embed) +# +# Suggested usage:: +# +# find_package with version info is not recommended except for release versions. :: +# +# find_package(pybind11 CONFIG) +# find_package(pybind11 2.0 EXACT CONFIG REQUIRED) +# +# +# The following variables can be set to guide the search for this package:: +# +# pybind11_DIR - CMake variable, set to directory containing this Config file +# CMAKE_PREFIX_PATH - CMake variable, set to root directory of this package +# PATH - environment variable, set to bin directory of this package +# CMAKE_DISABLE_FIND_PACKAGE_pybind11 - CMake variable, disables +# find_package(pybind11) when not REQUIRED, perhaps to force internal build + +@PACKAGE_INIT@ + +set(PN pybind11) + +# location of pybind11/pybind11.h +set(${PN}_INCLUDE_DIR "${PACKAGE_PREFIX_DIR}/@CMAKE_INSTALL_INCLUDEDIR@") + +set(${PN}_LIBRARY "") +set(${PN}_DEFINITIONS USING_${PN}) + +check_required_components(${PN}) + +# make detectable the FindPythonLibsNew.cmake module +list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}) + +include(pybind11Tools) + +if(NOT (CMAKE_VERSION VERSION_LESS 3.0)) +#----------------------------------------------------------------------------- +# Don't include targets if this file is being picked up by another +# project which has already built this as a subproject +#----------------------------------------------------------------------------- +if(NOT TARGET ${PN}::pybind11) + include("${CMAKE_CURRENT_LIST_DIR}/${PN}Targets.cmake") + + find_package(PythonLibsNew ${PYBIND11_PYTHON_VERSION} MODULE REQUIRED) + set_property(TARGET ${PN}::pybind11 APPEND PROPERTY INTERFACE_INCLUDE_DIRECTORIES ${PYTHON_INCLUDE_DIRS}) + set_property(TARGET ${PN}::embed APPEND PROPERTY INTERFACE_LINK_LIBRARIES ${PYTHON_LIBRARIES}) + if(WIN32 OR CYGWIN) + set_property(TARGET ${PN}::module APPEND PROPERTY INTERFACE_LINK_LIBRARIES ${PYTHON_LIBRARIES}) + endif() + + set_property(TARGET ${PN}::pybind11 APPEND PROPERTY INTERFACE_COMPILE_OPTIONS "${PYBIND11_CPP_STANDARD}") + + get_property(_iid TARGET ${PN}::pybind11 PROPERTY INTERFACE_INCLUDE_DIRECTORIES) + get_property(_ill TARGET ${PN}::module PROPERTY INTERFACE_LINK_LIBRARIES) + set(${PN}_INCLUDE_DIRS ${_iid}) + set(${PN}_LIBRARIES ${_ico} ${_ill}) +endif() +endif() diff --git a/plugins/python/pybind11/tools/pybind11Tools.cmake b/plugins/python/pybind11/tools/pybind11Tools.cmake new file mode 100644 index 0000000..52a70c2 --- /dev/null +++ b/plugins/python/pybind11/tools/pybind11Tools.cmake @@ -0,0 +1,209 @@ +# tools/pybind11Tools.cmake -- Build system for the pybind11 modules +# +# Copyright (c) 2015 Wenzel Jakob +# +# All rights reserved. Use of this source code is governed by a +# BSD-style license that can be found in the LICENSE file. + +cmake_minimum_required(VERSION 2.8.12) + +# Add a CMake parameter for choosing a desired Python version +if(NOT PYBIND11_PYTHON_VERSION) + set(PYBIND11_PYTHON_VERSION "" CACHE STRING "Python version to use for compiling modules") +endif() + +set(Python_ADDITIONAL_VERSIONS 3.7 3.6 3.5 3.4) +find_package(PythonLibsNew ${PYBIND11_PYTHON_VERSION} REQUIRED) + +include(CheckCXXCompilerFlag) +include(CMakeParseArguments) + +if(NOT PYBIND11_CPP_STANDARD AND NOT CMAKE_CXX_STANDARD) + if(NOT MSVC) + check_cxx_compiler_flag("-std=c++14" HAS_CPP14_FLAG) + + if (HAS_CPP14_FLAG) + set(PYBIND11_CPP_STANDARD -std=c++14) + else() + check_cxx_compiler_flag("-std=c++11" HAS_CPP11_FLAG) + if (HAS_CPP11_FLAG) + set(PYBIND11_CPP_STANDARD -std=c++11) + else() + message(FATAL_ERROR "Unsupported compiler -- pybind11 requires C++11 support!") + endif() + endif() + elseif(MSVC) + set(PYBIND11_CPP_STANDARD /std:c++14) + endif() + + set(PYBIND11_CPP_STANDARD ${PYBIND11_CPP_STANDARD} CACHE STRING + "C++ standard flag, e.g. -std=c++11, -std=c++14, /std:c++14. Defaults to C++14 mode." FORCE) +endif() + +# Checks whether the given CXX/linker flags can compile and link a cxx file. cxxflags and +# linkerflags are lists of flags to use. The result variable is a unique variable name for each set +# of flags: the compilation result will be cached base on the result variable. If the flags work, +# sets them in cxxflags_out/linkerflags_out internal cache variables (in addition to ${result}). +function(_pybind11_return_if_cxx_and_linker_flags_work result cxxflags linkerflags cxxflags_out linkerflags_out) + set(CMAKE_REQUIRED_LIBRARIES ${linkerflags}) + check_cxx_compiler_flag("${cxxflags}" ${result}) + if (${result}) + set(${cxxflags_out} "${cxxflags}" CACHE INTERNAL "" FORCE) + set(${linkerflags_out} "${linkerflags}" CACHE INTERNAL "" FORCE) + endif() +endfunction() + +# Internal: find the appropriate link time optimization flags for this compiler +function(_pybind11_add_lto_flags target_name prefer_thin_lto) + if (NOT DEFINED PYBIND11_LTO_CXX_FLAGS) + set(PYBIND11_LTO_CXX_FLAGS "" CACHE INTERNAL "") + set(PYBIND11_LTO_LINKER_FLAGS "" CACHE INTERNAL "") + + if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang") + set(cxx_append "") + set(linker_append "") + if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND NOT APPLE) + # Clang Gold plugin does not support -Os; append -O3 to MinSizeRel builds to override it + set(linker_append ";$<$:-O3>") + elseif(CMAKE_CXX_COMPILER_ID MATCHES "GNU") + set(cxx_append ";-fno-fat-lto-objects") + endif() + + if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND prefer_thin_lto) + _pybind11_return_if_cxx_and_linker_flags_work(HAS_FLTO_THIN + "-flto=thin${cxx_append}" "-flto=thin${linker_append}" + PYBIND11_LTO_CXX_FLAGS PYBIND11_LTO_LINKER_FLAGS) + endif() + + if (NOT HAS_FLTO_THIN) + _pybind11_return_if_cxx_and_linker_flags_work(HAS_FLTO + "-flto${cxx_append}" "-flto${linker_append}" + PYBIND11_LTO_CXX_FLAGS PYBIND11_LTO_LINKER_FLAGS) + endif() + elseif (CMAKE_CXX_COMPILER_ID MATCHES "Intel") + # Intel equivalent to LTO is called IPO + _pybind11_return_if_cxx_and_linker_flags_work(HAS_INTEL_IPO + "-ipo" "-ipo" PYBIND11_LTO_CXX_FLAGS PYBIND11_LTO_LINKER_FLAGS) + elseif(MSVC) + # cmake only interprets libraries as linker flags when they start with a - (otherwise it + # converts /LTCG to \LTCG as if it was a Windows path). Luckily MSVC supports passing flags + # with - instead of /, even if it is a bit non-standard: + _pybind11_return_if_cxx_and_linker_flags_work(HAS_MSVC_GL_LTCG + "/GL" "-LTCG" PYBIND11_LTO_CXX_FLAGS PYBIND11_LTO_LINKER_FLAGS) + endif() + + if (PYBIND11_LTO_CXX_FLAGS) + message(STATUS "LTO enabled") + else() + message(STATUS "LTO disabled (not supported by the compiler and/or linker)") + endif() + endif() + + # Enable LTO flags if found, except for Debug builds + if (PYBIND11_LTO_CXX_FLAGS) + target_compile_options(${target_name} PRIVATE "$<$>:${PYBIND11_LTO_CXX_FLAGS}>") + endif() + if (PYBIND11_LTO_LINKER_FLAGS) + target_link_libraries(${target_name} PRIVATE "$<$>:${PYBIND11_LTO_LINKER_FLAGS}>") + endif() +endfunction() + +# Build a Python extension module: +# pybind11_add_module( [MODULE | SHARED] [EXCLUDE_FROM_ALL] +# [NO_EXTRAS] [THIN_LTO] source1 [source2 ...]) +# +function(pybind11_add_module target_name) + set(options MODULE SHARED EXCLUDE_FROM_ALL NO_EXTRAS THIN_LTO) + cmake_parse_arguments(ARG "${options}" "" "" ${ARGN}) + + if(ARG_MODULE AND ARG_SHARED) + message(FATAL_ERROR "Can't be both MODULE and SHARED") + elseif(ARG_SHARED) + set(lib_type SHARED) + else() + set(lib_type MODULE) + endif() + + if(ARG_EXCLUDE_FROM_ALL) + set(exclude_from_all EXCLUDE_FROM_ALL) + endif() + + add_library(${target_name} ${lib_type} ${exclude_from_all} ${ARG_UNPARSED_ARGUMENTS}) + + target_include_directories(${target_name} + PRIVATE ${PYBIND11_INCLUDE_DIR} # from project CMakeLists.txt + PRIVATE ${pybind11_INCLUDE_DIR} # from pybind11Config + PRIVATE ${PYTHON_INCLUDE_DIRS}) + + # Python debug libraries expose slightly different objects + # https://docs.python.org/3.6/c-api/intro.html#debugging-builds + # https://stackoverflow.com/questions/39161202/how-to-work-around-missing-pymodule-create2-in-amd64-win-python35-d-lib + if(PYTHON_IS_DEBUG) + target_compile_definitions(${target_name} PRIVATE Py_DEBUG) + endif() + + # The prefix and extension are provided by FindPythonLibsNew.cmake + set_target_properties(${target_name} PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}") + set_target_properties(${target_name} PROPERTIES SUFFIX "${PYTHON_MODULE_EXTENSION}") + + # -fvisibility=hidden is required to allow multiple modules compiled against + # different pybind versions to work properly, and for some features (e.g. + # py::module_local). We force it on everything inside the `pybind11` + # namespace; also turning it on for a pybind module compilation here avoids + # potential warnings or issues from having mixed hidden/non-hidden types. + set_target_properties(${target_name} PROPERTIES CXX_VISIBILITY_PRESET "hidden") + + if(WIN32 OR CYGWIN) + # Link against the Python shared library on Windows + target_link_libraries(${target_name} PRIVATE ${PYTHON_LIBRARIES}) + elseif(APPLE) + # It's quite common to have multiple copies of the same Python version + # installed on one's system. E.g.: one copy from the OS and another copy + # that's statically linked into an application like Blender or Maya. + # If we link our plugin library against the OS Python here and import it + # into Blender or Maya later on, this will cause segfaults when multiple + # conflicting Python instances are active at the same time (even when they + # are of the same version). + + # Windows is not affected by this issue since it handles DLL imports + # differently. The solution for Linux and Mac OS is simple: we just don't + # link against the Python library. The resulting shared library will have + # missing symbols, but that's perfectly fine -- they will be resolved at + # import time. + + target_link_libraries(${target_name} PRIVATE "-undefined dynamic_lookup") + + if(ARG_SHARED) + # Suppress CMake >= 3.0 warning for shared libraries + set_target_properties(${target_name} PROPERTIES MACOSX_RPATH ON) + endif() + endif() + + # Make sure C++11/14 are enabled + target_compile_options(${target_name} PUBLIC ${PYBIND11_CPP_STANDARD}) + + if(ARG_NO_EXTRAS) + return() + endif() + + _pybind11_add_lto_flags(${target_name} ${ARG_THIN_LTO}) + + if (NOT MSVC AND NOT ${CMAKE_BUILD_TYPE} MATCHES Debug) + # Strip unnecessary sections of the binary on Linux/Mac OS + if(CMAKE_STRIP) + if(APPLE) + add_custom_command(TARGET ${target_name} POST_BUILD + COMMAND ${CMAKE_STRIP} -x $) + else() + add_custom_command(TARGET ${target_name} POST_BUILD + COMMAND ${CMAKE_STRIP} $) + endif() + endif() + endif() + + if(MSVC) + # /MP enables multithreaded builds (relevant when there are many files), /bigobj is + # needed for bigger binding projects due to the limit to 64k addressable sections + target_compile_options(${target_name} PRIVATE /MP /bigobj) + endif() +endfunction() diff --git a/plugins/python/python.qrc b/plugins/python/python.qrc new file mode 100644 index 0000000..1f2044d --- /dev/null +++ b/plugins/python/python.qrc @@ -0,0 +1,5 @@ + + + resources/text-x-python.svg + + diff --git a/plugins/python/resources/text-x-python.svg b/plugins/python/resources/text-x-python.svg new file mode 100644 index 0000000..50d663e --- /dev/null +++ b/plugins/python/resources/text-x-python.svg @@ -0,0 +1,4410 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + Width: 2pxBlur: 12Opacity: 60 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/plugins/python/share/modules/README.md b/plugins/python/share/modules/README.md new file mode 100644 index 0000000..17b6d7f --- /dev/null +++ b/plugins/python/share/modules/README.md @@ -0,0 +1,11 @@ +### This is the official repository for python extensions. + +This repository is shipped with albert. If you want to have bleeding edge extensions or share your extension clone the repository. Check the docs on Python extensions. + +To install the extensions in user space type the following in your terminal: + +``` +git clone https://github.com/albertlauncher/python.git "~/.local/share/albert/org.albert.extension.python/modules" +``` + +If you send a PR I'll invite you to the reviewers team (if I don't forget it), I'd appreciate if you could review others contributions. diff --git a/plugins/python/share/modules/api_test/__init__.py b/plugins/python/share/modules/api_test/__init__.py new file mode 100644 index 0000000..8647fa9 --- /dev/null +++ b/plugins/python/share/modules/api_test/__init__.py @@ -0,0 +1,108 @@ +# -*- coding: utf-8 -*- + +"""This is a simple python template extension that should show the API in a comprehensible way. \ +Use the module docstring to provide a detailed description of the extension""" + +from albertv0 import * +import os +from time import sleep + + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Api Test" +__version__ = "1.0" +__trigger__ = "test " +__author__ = "Manuel Schneider" +__dependencies__ = ["whatever"] + +iconPath = iconLookup("albert") + + +# Can be omitted +def initialize(): + pass + + +# Can be omitted +def finalize(): + pass + + +def handleQuery(query): + if not query.isTriggered: + return + + # Note that when storing a reference to query, e.g. in a closure, you must not use + # query.isValid. Apart from the query beeing invalid anyway it will crash the appplication. + # The Python type holds a pointer to the C++ type used for isValid(). The C++ type will be + # deleted when the query is finished. Therfore getting isValid will result in a SEGFAULT. + + if query.string.startswith("delay"): + sleep(2) + return Item(id=__prettyname__, + icon=os.path.dirname(__file__)+"/plugin.svg", + text="Delayed test item", + subtext="Query string: %s" % query.string) + + if query.string.startswith("throw"): + raise ValueError('EXPLICITLY REQUESTED TEST EXCEPTION!') + + info(query.string) + info(query.rawString) + info(query.trigger) + info(str(query.isTriggered)) + info(str(query.isValid)) + + critical(query.string) + warning(query.string) + debug(query.string) + debug(query.string) + + results = [] + + item = Item() + + item.icon = iconPath + item.text = 'Python item containing %s' % query.string + item.subtext = 'Python description' + item.completion = __trigger__ + 'Completion Harharhar' + item.urgency = ItemBase.Notification # Alert, Normal + info(item.icon) + info(item.text) + info(item.subtext) + info(item.completion) + info(str(item.urgency)) + def function(): info(query.string) + item.addAction(FuncAction("Print info", function)) + item.addAction(FuncAction("Print warning", lambda: warning(query.string))) + results.append(item) + + item = Item(id=__prettyname__, + icon=os.path.dirname(__file__)+"/plugin.svg", + text="This is the primary text", + subtext="This is the subtext, some kind of description", + completion=__trigger__ + 'Hellooohooo!', + urgency=ItemBase.Alert, + actions=[ + FuncAction(text="FuncAction", + callable=lambda: critical(query.string)), + ClipAction(text="ClipAction", + clipboardText="blabla"), + UrlAction(text="UrlAction", + url="https://www.google.de"), + ProcAction(text="ProcAction", + commandline=["espeak", "hello"], + cwd="~"), # optional + TermAction(text="TermAction", + commandline=["sleep", "5"], + cwd="~/git") # optional + ]) + results.append(item) + + + # Api v 0.2 + info(configLocation()) + info(cacheLocation()) + info(dataLocation()) + + return results diff --git a/plugins/python/share/modules/api_test/plugin.svg b/plugins/python/share/modules/api_test/plugin.svg new file mode 100644 index 0000000..6cbefc6 --- /dev/null +++ b/plugins/python/share/modules/api_test/plugin.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/python/share/modules/arch_wiki/ArchWiki.svg b/plugins/python/share/modules/arch_wiki/ArchWiki.svg new file mode 100644 index 0000000..b95bef8 --- /dev/null +++ b/plugins/python/share/modules/arch_wiki/ArchWiki.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/python/share/modules/arch_wiki/__init__.py b/plugins/python/share/modules/arch_wiki/__init__.py new file mode 100644 index 0000000..c5da4a5 --- /dev/null +++ b/plugins/python/share/modules/arch_wiki/__init__.py @@ -0,0 +1,72 @@ +# -*- coding: utf-8 -*- + +"""Search Arch Linux Wiki articles.""" + +from albertv0 import * +from urllib import request, parse +import json +import os + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Arch Wiki" +__version__ = "1.0" +__trigger__ = "awiki " +__author__ = "Manuel Schneider" +__dependencies__ = [] + +iconPath = "%s/%s.svg" % (os.path.dirname(__file__), __name__) +baseurl = 'https://wiki.archlinux.org/api.php' +user_agent = "org.albert.extension.python.archwiki" + + +def handleQuery(query): + if query.isTriggered: + + stripped = query.string.strip() + + if stripped: + results = [] + + params = { + 'action': 'opensearch', + 'search': stripped, + 'limit': "max", + 'redirects': 'resolve', + 'utf8': 1, + 'format': 'json' + } + get_url = "%s?%s" % (baseurl, parse.urlencode(params)) + req = request.Request(get_url, headers={'User-Agent': user_agent}) + + with request.urlopen(req) as response: + data = json.loads(response.read().decode()) + for i in range(0, len(data[1])): + title = data[1][i] + summary = data[2][i] + url = data[3][i] + + results.append(Item(id=__prettyname__, + icon=iconPath, + text=title, + subtext=summary if summary else url, + completion=title, + actions=[ + UrlAction("Open article", url), + ClipAction("Copy URL", url) + ])) + if results: + return results + + return Item(id=__prettyname__, + icon=iconPath, + text="Search '%s'" % query.string, + subtext="No results. Start a online search on Arch Wiki", + completion=query.rawString, + actions=[UrlAction("Open search", "https://wiki.archlinux.org/index.php?search=%s" % query.string)]) + + else: + return Item(id=__prettyname__, + icon=iconPath, + text=__prettyname__, + subtext="Enter a query to search on the Arch Wiki", + completion=query.rawString) diff --git a/plugins/python/share/modules/atom_projects.py b/plugins/python/share/modules/atom_projects.py new file mode 100644 index 0000000..f84e26b --- /dev/null +++ b/plugins/python/share/modules/atom_projects.py @@ -0,0 +1,65 @@ +# -*- coding: utf-8 -*- + +"""List and open your Atom projects.""" + +import os +import re +import time +from pathlib import Path +from shutil import which + +import cson + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Atom Projects" +__version__ = "1.0" +__trigger__ = "atom " +__author__ = "Manuel Schneider" +__dependencies__ = ["python-cson"] + +projects_file = str(Path.home()) + "/.atom/projects.cson" + +if which("atom") is None: + raise Exception("'atom' is not in $PATH.") + +iconPath = iconLookup('atom') +mtime = 0 +projects = [] + + +def updateProjects(): + global mtime + try: + new_mtime = os.path.getmtime(projects_file) + except Exception as e: + warning("Could not get mtime of file: " + projects_file + str(e)) + if mtime != new_mtime: + mtime = new_mtime + with open(projects_file) as projects_cson: + global projects + projects = cson.loads(projects_cson.read()) + + +def handleQuery(query): + if not query.isTriggered: + return + + updateProjects() + + stripped = query.string.strip() + + items = [] + for project in projects: + if re.search(stripped, project['title'], re.IGNORECASE): + items.append(Item(id=__prettyname__ + project['title'], + icon=iconPath, + text=project['title'], + subtext="Group: %s" % (project['group'] if 'group' in project else "None"), + completion=query.rawString, + actions=[ + ProcAction(text="Open project in Atom", + commandline=["atom"] + project['paths']) + ])) + return items diff --git a/plugins/python/share/modules/aur/__init__.py b/plugins/python/share/modules/aur/__init__.py new file mode 100644 index 0000000..b9eee6d --- /dev/null +++ b/plugins/python/share/modules/aur/__init__.py @@ -0,0 +1,99 @@ +# -*- coding: utf-8 -*- + +"""This extension adapts the AUR web interface. You can search for packages and open their URLs. \ +This extension is also intended to be used to quickly install the packages. Currently yaourt and \ +pacaur can be used. If you are missing your favorite AUR helper tool send a PR.""" + +from albertv0 import * +from shutil import which +from datetime import datetime +from shlex import split +from urllib import request, parse +import json +import os +import re + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Archlinux User Repository" +__version__ = "1.2" +__trigger__ = "aur " +__author__ = "Manuel Schneider" +__dependencies__ = [] + +iconPath = os.path.dirname(__file__)+"/arch.svg" +baseurl = 'https://aur.archlinux.org/rpc/' +install_cmdline = None + +if which("yaourt"): + install_cmdline = "yaourt -S aur/%s" +elif which("pacaur"): + install_cmdline = "pacaur -S aur/%s" + + +def handleQuery(query): + if not query.isTriggered: + return + + stripped = query.string.strip() + + if stripped: + params = { + 'v': '5', + 'type': 'search', + 'by': 'name', + 'arg': stripped + } + url = "%s?%s" % (baseurl, parse.urlencode(params)) + req = request.Request(url) + + with request.urlopen(req) as response: + data = json.loads(response.read().decode()) + if data['type'] == "error": + return Item( + id=__prettyname__, + icon=iconPath, + text="Error", + subtext=data['error'], + completion=query.rawString + ) + else: + results = [] + pattern = re.compile(query.string, re.IGNORECASE) + results_json = data['results'] + results_json.sort(key=lambda item: item['Name']) + results_json.sort(key=lambda item: len(item['Name'])) + + for entry in results_json: + name = entry['Name'] + item = Item( + id=__prettyname__, + icon=iconPath, + text="%s %s (%s)" % (pattern.sub(lambda m: "%s" % m.group(0), name), entry['Version'], entry['NumVotes']), + completion=query.rawString + ) + subtext = entry['Description'] if entry['Description'] else "[No description]" + if entry['OutOfDate']: + subtext = '[Out of date: %s] %s' % (datetime.fromtimestamp(entry['OutOfDate']).strftime("%F"), subtext) + if entry['Maintainer'] is None: + subtext = '[Orphan] %s' % subtext + item.subtext = subtext + + if install_cmdline: + tokens = split(install_cmdline % name) + item.addAction(TermAction("Install with %s" % tokens[0], tokens)) + item.addAction(TermAction("Install with %s (noconfirm)" % tokens[0], tokens + ["--noconfirm"])) + + item.addAction(UrlAction("Open AUR website", "https://aur.archlinux.org/packages/%s/" % name)) + + if entry['URL']: + item.addAction(UrlAction("Open project website", entry['URL'])) + + results.append(item) + return results + else: + return Item(id=__prettyname__, + icon=iconPath, + text=__prettyname__, + subtext="Enter a query to search the AUR", + completion=query.rawString, + actions=[UrlAction("Open AUR packages website", "https://aur.archlinux.org/packages/")]) diff --git a/plugins/python/share/modules/aur/arch.svg b/plugins/python/share/modules/aur/arch.svg new file mode 100644 index 0000000..b95bef8 --- /dev/null +++ b/plugins/python/share/modules/aur/arch.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/python/share/modules/base_converter.py b/plugins/python/share/modules/base_converter.py new file mode 100644 index 0000000..a37b417 --- /dev/null +++ b/plugins/python/share/modules/base_converter.py @@ -0,0 +1,61 @@ +# -*- coding: utf-8 -*- + +"""Convert representations of numbers. +Usage: base + Or: [padding] +Examples: base 10 16 1234567890 + dec 1024 + hex 5f 8""" + +from albertv0 import * +import numpy as np + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Base Converter" +__version__ = "1.1" +__trigger__ = "base " +__author__ = "Manuel Schneider" +__dependencies__ = ["numpy"] + +base_keywords = {"bin": 2, "oct": 8, "dec": 10, "hex": 16} + +def buildItem(completion, src, dst, number, padding=0): + item = Item(id=__prettyname__, completion=completion) + try: + src = int(src) + dst = int(dst) + padding = int(padding) + integer = int(number, src) + item.text = np.base_repr(integer, dst) + if integer >= 0 and len(item.text) < padding: + item.text = '0'*(padding-len(item.text)) + item.text + item.subtext = "Base %s representation of %s (base %s)" % (dst, number, src) + item.addAction(ClipAction("Copy to clipboard", item.text)) + except Exception as e: + item.text = e.__class__.__name__ + item.subtext = str(e) + return item + +def handleQuery(query): + if query.isTriggered: + fields = query.string.split() + if len(fields) == 3: + return buildItem(query.rawString, fields[0], fields[1], fields[2]) + else: + item = Item(id=__prettyname__, completion=query.rawString) + item.text = __prettyname__ + item.subtext = "Enter a query in the form of \"<srcbase> <dstbase> <number>\"" + return item + else: + fields = query.string.split() + if len(fields) < 2 or fields[0] not in base_keywords: + return + src = base_keywords[fields[0]] + number = fields[1] + padding = 0 if len(fields) < 3 else fields[2] + results = [] + for dst in sorted(base_keywords.values()): + if dst == src: + continue + results.append(buildItem(query.rawString, src, dst, number, padding)) + return results diff --git a/plugins/python/share/modules/binance/Binance.svg b/plugins/python/share/modules/binance/Binance.svg new file mode 100644 index 0000000..f03f7c9 --- /dev/null +++ b/plugins/python/share/modules/binance/Binance.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/python/share/modules/binance/__init__.py b/plugins/python/share/modules/binance/__init__.py new file mode 100644 index 0000000..abf0768 --- /dev/null +++ b/plugins/python/share/modules/binance/__init__.py @@ -0,0 +1,107 @@ +# -*- coding: utf-8 -*- + +"""Quickly access the Binance markets. You can either search the items directly by typing the \ +market name, e.g. xrpbtc, or list and filter markets by using the trigger and filter, e.g 'bnc \ +[filter]'""" + +from albertv0 import * +import time +import os +import urllib.request +import urllib.error +from collections import namedtuple +import json +from threading import Thread, Event + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Binance" +__version__ = "1.2" +__trigger__ = "bnc " +__author__ = "Manuel Schneider" +__dependencies__ = [] + +iconPath = os.path.dirname(__file__) + "/%s.svg" % __name__ +exchangeInfoUrl = "https://api.binance.com/api/v1/exchangeInfo" +tradeUrl = "https://www.binance.com/tradeDetail.html?symbol=%s_%s" +markets = [] +thread = None + +Market = namedtuple("Market" , ["base", "quote"]) + +class UpdateThread(Thread): + def __init__(self): + super().__init__() + self._stopevent = Event() + + def run(self): + while True: + global thread + try: + global markets + with urllib.request.urlopen(exchangeInfoUrl) as response: + symbols = json.loads(response.read().decode())['symbols'] + markets.clear() + for symbol in symbols: + # Skip this strange 123456 market + if symbol['baseAsset'] != "123": + markets.append(Market(base=symbol['baseAsset'], + quote=symbol['quoteAsset'])) + info("Binance markets updated.") + self._stopevent.wait(3600) # Sleep 1h, wakeup on stop event + except Exception as e: + warning("Updating Binance markets failed: %s" % str(e)) + self._stopevent.wait(60) # Sleep 1 min, wakeup on stop event + + if self._stopevent.is_set(): + return + + def stop(self): + self._stopevent.set() + + +def initialize(): + global thread + thread = UpdateThread() + thread.start() + + +def finalize(): + global thread + if thread is not None: + thread.stop() + thread.join() + + +def makeItem(market): + url = tradeUrl % (market.base, market.quote) + return Item( + id="%s_%s%s" % (__prettyname__, market.base, market.quote), + icon=iconPath, + text="%s/%s" % (market.base, market.quote), + subtext="Open the %s/%s market on binance.com" % (market.base, market.quote), + completion="%s%s%s" % (__trigger__, market.base, market.quote), + actions=[ + UrlAction("Show market in browser", url), + ClipAction('Copy URL to clipboard', url) + ] + ) + + +def handleQuery(query): + items = [] + stripped = query.string.strip().upper() + + if query.isTriggered: + if stripped: + for market in markets: + if ("%s%s" % (market.base, market.quote)).startswith(stripped): + items.append(makeItem(market)) + else: + for market in markets: + items.append(makeItem(market)) + else: + for market in markets: + if stripped and ("%s%s" % (market.base, market.quote)).startswith(stripped): + items.append(makeItem(market)) + + return items diff --git a/plugins/python/share/modules/bitfinex/Bitfinex.svg b/plugins/python/share/modules/bitfinex/Bitfinex.svg new file mode 100644 index 0000000..05b9efc --- /dev/null +++ b/plugins/python/share/modules/bitfinex/Bitfinex.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/python/share/modules/bitfinex/__init__.py b/plugins/python/share/modules/bitfinex/__init__.py new file mode 100644 index 0000000..18c3872 --- /dev/null +++ b/plugins/python/share/modules/bitfinex/__init__.py @@ -0,0 +1,104 @@ +# -*- coding: utf-8 -*- + +"""Quickly access the Bitfinex markets. You can either search the items directly by typing the \ +market name, e.g. xrpbtc, or list and filter the markets by using the trigger and filter, e.g \ +'bfx [filter]'""" + +from albertv0 import * +import time +import os +import urllib.request +import urllib.error +import json +from collections import namedtuple +from threading import Thread, Event + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "BitFinex" +__version__ = "1.0" +__trigger__ = "bfx " +__author__ = "Manuel Schneider" +__dependencies__ = [] + +iconPath = os.path.dirname(__file__) + "/%s.svg" % __name__ +symbolsEndpoint = "https://api.bitfinex.com/v1/symbols" +tradeUrl = "https://www.bitfinex.com/t/%s:%s" +markets = [] +thread = None + +Market = namedtuple("Market" , ["base", "quote"]) + +class UpdateThread(Thread): + def __init__(self): + super().__init__() + self._stopevent = Event() + + def run(self): + while True: + global thread + try: + global markets + with urllib.request.urlopen(symbolsEndpoint) as response: + symbols = json.loads(response.read().decode()) + markets.clear() + for symbol in symbols: + symbol = symbol.upper() + markets.append(Market(base=symbol[0:3], quote=symbol[3:6])) + info("Bitfinex markets updated.") + self._stopevent.wait(3600) # Sleep 1h, wakeup on stop event + except Exception as e: + warning("Updating Bitfinex markets failed: %s" % str(e)) + self._stopevent.wait(60) # Sleep 1 min, wakeup on stop event + + if self._stopevent.is_set(): + return + + def stop(self): + self._stopevent.set() + + +def initialize(): + global thread + thread = UpdateThread() + thread.start() + + +def finalize(): + global thread + if thread is not None: + thread.stop() + thread.join() + +def makeItem(market): + url = tradeUrl % (market.base, market.quote) + return Item( + id="%s_%s%s" % (__prettyname__, market.base, market.quote), + icon=iconPath, + text="%s/%s" % (market.base, market.quote), + subtext="Open the %s/%s market on bitfinex.com" % (market.base, market.quote), + completion="%s%s%s" % (__trigger__, market.base, market.quote), + actions=[ + UrlAction("Show market in browser", url), + ClipAction('Copy URL to clipboard', url) + ] + ) + + +def handleQuery(query): + items = [] + stripped = query.string.strip().upper() + + if query.isTriggered: + if stripped: + for market in markets: + if ("%s%s" % (market.base, market.quote)).startswith(stripped): + items.append(makeItem(market)) + else: + for market in markets: + items.append(makeItem(market)) + else: + for market in markets: + if stripped and ("%s%s" % (market.base, market.quote)).startswith(stripped): + items.append(makeItem(market)) + + return items diff --git a/plugins/python/share/modules/coinmarketcap/__init__.py b/plugins/python/share/modules/coinmarketcap/__init__.py new file mode 100644 index 0000000..8496db1 --- /dev/null +++ b/plugins/python/share/modules/coinmarketcap/__init__.py @@ -0,0 +1,149 @@ +# -*- coding: utf-8 -*- + +"""Show and access crypto currencies on CoinmMarketCap.com. For max readability the units are \ +omitted. The values of "Change" are the hourly, daily and weekly changes of the price in percent. \ +"Cap" is the market capitalisation in USD. Volume is the volume of the last 24 hours in USD.""" + +from albertv0 import * +from threading import Thread, Event +from locale import format as lformat +from urllib import request +from urllib.parse import urlencode +import re +import os +import json + +__iid__ = "PythonInterface/v0.2" +__prettyname__ = "CoinMarketCap" +__version__ = "1.4" +__trigger__ = "cmc " +__author__ = "Manuel Schneider" +__dependencies__ = [] + +iconPath = os.path.dirname(__file__)+"/emblem-money.svg" +thread = None +coins = None + + +class Coin(): + def __init__(self, identifier, name, symbol, rank, price, + cap, vol, change_hour, change_day, change_week): + self.identifier = identifier + self.name = name + self.symbol = symbol + self.rank = rank + self.price = price + self.cap = cap + self.vol = vol + self.change_hour = change_hour + self.change_day = change_day + self.change_week = change_week + + +class UpdateThread(Thread): + def __init__(self): + super().__init__() + self._stopevent = Event() + + def run(self): + + while True: + url = "%s?%s" % ("https://api.coinmarketcap.com/v1/ticker/", urlencode({'limit': 0})) + req = request.Request(url) + with request.urlopen(req) as response: + if self._stopevent.is_set(): + return + + def colorize_float(value: str): + if value is None: + return value + elif float(value) < 0: + return "%s" % value + elif float(value) > 0: + return "%s" % value + else: + return value + + # Get coin data + data = json.loads(response.read().decode('utf-8')) + newCoins = [] + for coindata in data: + cap = coindata['market_cap_usd'] + cap = lformat("%d", float(cap), True) if cap else "?" + vol = coindata['24h_volume_usd'] + vol = lformat("%d", float(vol), True) if vol else "?" + price = coindata['price_usd'] + price_precision = "%.2f" if float(price) > 1 else "%.6f" + price = lformat(price_precision, float(price), True) if price else "?" + if "," in price: + price = price.rstrip("0").rstrip(",") + newCoins.append(Coin(identifier=coindata['id'], + name=coindata['name'], + symbol=coindata['symbol'], + rank=coindata['rank'], + price=price, + cap=cap, + vol=vol, + change_hour=colorize_float(coindata['percent_change_1h']), + change_day=colorize_float(coindata['percent_change_24h']), + change_week=colorize_float(coindata['percent_change_7d']))) + global coins + coins = newCoins + + self._stopevent.wait(900) # Sleep 15 min, wakeup on stop event + if self._stopevent.is_set(): + return + + def stop(self): + self._stop_event.set() + + +def initialize(): + thread = UpdateThread() + thread.start() + + +def finalize(): + if thread is not None: + thread.stop() + thread.join() + + +def handleQuery(query): + if not query.isTriggered or coins is None: + return + + stripped = query.string.strip().lower() + items = [] + if stripped: + pattern = re.compile(stripped, re.IGNORECASE) + for coin in coins: + if coin.name.lower().startswith(stripped) or coin.symbol.lower().startswith(stripped): + url = "https://coinmarketcap.com/currencies/%s/" % coin.identifier + items.append(Item( + id=__prettyname__, + icon=iconPath, + text="#%s %s (%s) %s$" % (coin.rank, pattern.sub(lambda m: "%s" % m.group(0), coin.name), + pattern.sub(lambda m: "%s" % m.group(0), coin.symbol), coin.price), + subtext="Change: %s/%s/%s, Cap: %s, Volume: %s" % (coin.change_hour, coin.change_day, coin.change_week, coin.cap, coin.vol), + completion=coin.price, + actions=[ + UrlAction("Show on CoinMarketCap website", url), + ClipAction('Copy URL to clipboard', url) + ] + )) + else: + for coin in coins: + url = "https://coinmarketcap.com/currencies/%s/" % coin.identifier + items.append(Item( + id=__prettyname__, + icon=iconPath, + text="#%s %s (%s) %s$" % (coin.rank, coin.name, coin.symbol, coin.price), + subtext="Change: %s/%s/%s, Cap: %s, Volume: %s" % (coin.change_hour, coin.change_day, coin.change_week, coin.cap, coin.vol), + completion=coin.price, + actions=[ + UrlAction("Show on CoinMarketCap website", url), + ClipAction('Copy URL to clipboard', url) + ] + )) + return items diff --git a/plugins/python/share/modules/coinmarketcap/emblem-money.svg b/plugins/python/share/modules/coinmarketcap/emblem-money.svg new file mode 100644 index 0000000..256f9cd --- /dev/null +++ b/plugins/python/share/modules/coinmarketcap/emblem-money.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/python/share/modules/copyq.py b/plugins/python/share/modules/copyq.py new file mode 100644 index 0000000..08eb7ba --- /dev/null +++ b/plugins/python/share/modules/copyq.py @@ -0,0 +1,94 @@ +# -*- coding: utf-8 -*- + +"""CopyQ clipboard management.""" + +import html +import json +import re +import subprocess +from shutil import which + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "CopyQ" +__version__ = "1.1" +__trigger__ = "cq " +__author__ = "Manuel Schneider" +__dependencies__ = ["copyq"] + + +if which("copyq") is None: + raise Exception("'copyq' is not in $PATH.") + +iconPath = iconLookup('copyq') + +copyq_script_getAll = r""" +var result=[]; +for ( var i = 0; i < size(); ++i ) { + var obj = {}; + obj.row = i; + obj.mimetypes = str(read("?", i)).split("\n"); + obj.mimetypes.pop(); + obj.text = str(read(i)); + result.push(obj); +} +JSON.stringify(result); +""" + +copyq_script_getMatches = r""" +var result=[]; +var match = "%s"; +for ( var i = 0; i < size(); ++i ) { + if (str(read(i)).search(new RegExp(match, "i")) !== -1) { + var obj = {}; + obj.row = i; + obj.mimetypes = str(read("?", i)).split("\n"); + obj.mimetypes.pop(); + obj.text = str(read(i)); + result.push(obj); + } +} +JSON.stringify(result); +""" + +def copyq_get_matches(substring): + script = copyq_script_getMatches % substring + proc = subprocess.run(['copyq', '-'], input=script.encode(), stdout=subprocess.PIPE) + return json.loads(proc.stdout.decode()) + + +def copyq_get_all(): + proc = subprocess.run(['copyq', '-'], input=copyq_script_getAll.encode(), stdout=subprocess.PIPE) + return json.loads(proc.stdout.decode()) + + +def handleQuery(query): + if query.isTriggered: + + items = [] + pattern = re.compile(query.string, re.IGNORECASE) + json_arr = copyq_get_matches(query.string) if query.string else copyq_get_all() + for json_obj in json_arr: + row = json_obj['row'] + text = json_obj['text'] + if not text: + text = "No text" + else: + text = html.escape(" ".join(filter(None, text.replace("\n", " ").split(" ")))) + if query.string: + text = pattern.sub(lambda m: "%s" % m.group(0), text) + items.append( + Item( + id=__prettyname__, + icon=iconPath, + text=text, + subtext="%s: %s" % (row, ", ".join(json_obj['mimetypes'])), + actions=[ + ProcAction("Paste", ["copyq", "select(%s); sleep(60); paste();" % row]), + ProcAction("Copy", ["copyq", "select(%s);" % row]), + ProcAction("Remove", ["copyq", "remove(%s);" % row]), + ] + ) + ) + return items diff --git a/plugins/python/share/modules/currency_converter.py b/plugins/python/share/modules/currency_converter.py new file mode 100644 index 0000000..8fbb8d7 --- /dev/null +++ b/plugins/python/share/modules/currency_converter.py @@ -0,0 +1,83 @@ +# -*- coding: utf-8 -*- + +"""Convert currencies. + +Synopsis: [to|as|in] """ + +import re +import time +from urllib.request import urlopen +from xml.etree import ElementTree + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Currency converter" +__version__ = "1.0" +__author__ = "Manuel Schneider" +__dependencies__ = [] + +iconPath = iconLookup('accessories-calculator') +if not iconPath: + iconPath = ":python_module" + + +class EuropeanCentralBank: + + url = "https://www.ecb.europa.eu/stats/eurofxref/eurofxref-daily.xml" + + def __init__(self): + self.lastUpdate = 0 + self.exchange_rates = dict() + self.name = "European Central Bank" + + def convert(self, amount, src, dst): + if self.lastUpdate < time.time()-10800: # Update every 3 hours + self.exchange_rates.clear() + with urlopen(EuropeanCentralBank.url) as response: + tree = ElementTree.fromstring(response.read().decode()) + for child in tree[2][0]: + curr = child.attrib['currency'] + rate = float(child.attrib['rate']) + self.exchange_rates[curr] = rate + self.exchange_rates["EUR"] = 1.0 # For simpler algorithmic + info("%s: Updated foreign exchange rates." % __prettyname__) + debug(str(self.exchange_rates)) + self.lastUpdate = time.time() + + if src in self.exchange_rates and dst in self.exchange_rates: + src_rate = self.exchange_rates[src] + dst_rate = self.exchange_rates[dst] + return str(amount / src_rate * dst_rate) + +class Yahoo: + + def __init__(self): + self.name = "Yahoo" + + def convert(self, amount, src, dst): + url = 'https://search.yahoo.com/search?p=%s+%s+to+%s' % (amount, src, dst) + with urlopen(url) as response: + html = response.read().decode() + m = re.search('(\d+(\.\d+)?)', html) + if m: + return m.group(1) + + +providers = [EuropeanCentralBank(), Yahoo()] +regex = re.compile(r"(\d+\.?\d*)\s+(\w{3})(?:\s+(?:to|in|as))?\s+(\w{3})") + +def handleQuery(query): + match = regex.fullmatch(query.string.strip()) + if match: + prep = (float(match.group(1)), match.group(2).upper(), match.group(3).upper()) + item = Item(id=__prettyname__, icon=iconPath, completion=query.rawString) + for provider in providers: + result = provider.convert(*prep) + if result: + item.text = result + item.subtext = "Value of %s %s in %s (Source: %s)" % (*prep, provider.name) + item.addAction(ClipAction("Copy result to clipboard", result)) + return item + else: + warning("None of the foreign exchange rate providers came up with a result for %s" % str(prep)) diff --git a/plugins/python/share/modules/dango_emoji/__init__.py b/plugins/python/share/modules/dango_emoji/__init__.py new file mode 100644 index 0000000..aae4951 --- /dev/null +++ b/plugins/python/share/modules/dango_emoji/__init__.py @@ -0,0 +1,85 @@ +# -*- coding: utf-8 -*- + +"""Use machinelearning to find the relevant emoji. If your emojis are not rendering properly go to \ + and install the emoji fonts at the following link: https://github.com/eosrei/emojione-color-font""" + +from albertv0 import * +import json +import os +import urllib.error +from urllib.request import urlopen, Request +from urllib.parse import urlencode + + +__iid__ = "PythonInterface/v0.2" +__prettyname__ = "Dango Emoji" +__version__ = "1.1" +__trigger__ = ":" +__author__ = "David Britt" +__dependencies__ = [] + +icon_path = "%s/%s.png" % (os.path.dirname(__file__), __name__) +dangoUrl = "https://emoji.getdango.com/api/emoji" +emojipedia_url = "https://emojipedia.org/%s" + + +def handleQuery(query): + results = [] + if query.isTriggered: + + item = Item( + id=__prettyname__, + icon=icon_path, + completion=query.rawString, + text=__prettyname__, + actions=[] + ) + + if len(query.string) >= 2: + try: + url = "%s?%s" % (dangoUrl, urlencode({"q": query.string, "syn": 0})) + with urlopen(Request(url)) as response: + + json_data = json.loads(response.read().decode()) + + if json_data["results"][0]["score"] > 0.025: + all_emojis = [] + for emoj in json_data["results"]: + if emoj["score"] > 0.025: + all_emojis.append(emoj["text"]) + + string_emojis = ''.join(all_emojis) + + results.append(Item( + id=__prettyname__, + icon=icon_path, + text=string_emojis, + subtext="Score > 0.025", + actions=[ + ClipAction( + "Copy translation to clipboard", string_emojis) + ] + )) + + for emoj in json_data["results"]: + results.append(Item( + id=__prettyname__, + icon=icon_path, + text=str(emoj["text"]), + subtext=str(emoj["score"]), + actions=[ + ClipAction( + "Copy translation to clipboard", str(emoj["text"])), + UrlAction("Open in Emojipedia", + emojipedia_url % str(emoj["text"])) + ] + )) + + except urllib.error.URLError as urlerr: + print("Troubleshoot internet connection: %s" % urlerr) + item.subtext = "Connection error" + return item + else: + item.subtext = "Search emojis!" + return item + return results diff --git a/plugins/python/share/modules/dango_emoji/dangoemoji.png b/plugins/python/share/modules/dango_emoji/dangoemoji.png new file mode 100644 index 0000000..ea7846e Binary files /dev/null and b/plugins/python/share/modules/dango_emoji/dangoemoji.png differ diff --git a/plugins/python/share/modules/dango_kao/__init__.py b/plugins/python/share/modules/dango_kao/__init__.py new file mode 100755 index 0000000..fd72a25 --- /dev/null +++ b/plugins/python/share/modules/dango_kao/__init__.py @@ -0,0 +1,59 @@ +# -*- coding: utf-8 -*- + +"""Find relevant Kaomoji's using machine learning.""" + +from albertv0 import * +import os +import json +import urllib.error +from urllib.request import urlopen, Request +from urllib.parse import urlencode + +__iid__ = "PythonInterface/v0.2" +__prettyname__ = "Dango Kaomoji" +__version__ = "1.0" +__trigger__ = "kao " +__author__ = "David Britt" +__dependencies__ = [] + +icon_path = os.path.dirname(__file__) + "/kaoicon.svg" +dangoUrl = "https://customer.getdango.com/dango/api/query/kaomoji" + + +def handleQuery(query): + results = [] + + if query.isTriggered: + + item = Item( + id=__prettyname__, + icon=icon_path, + completion=query.rawString, + text=__prettyname__, + actions=[] + ) + + if len(query.string) >= 2: + try: + url = "%s?%s" % (dangoUrl, urlencode({"q": query.string})) + with urlopen(Request(url)) as response: + json_data = json.loads(response.read().decode()) + for emoj in json_data["items"]: + results.append(Item( + id=__prettyname__, + icon=icon_path, + text=emoj["text"], + actions=[ + ClipAction( + "Copy translation to clipboard", emoj["text"]) + ] + )) + except urllib.error.URLError as urlerr: + print("Troubleshoot internet connection: %s" % urlerr) + item.subtext = "Connection error" + return item + else: + item.subtext = "Search emojis!" + return item + + return results diff --git a/plugins/python/share/modules/dango_kao/kaoicon.svg b/plugins/python/share/modules/dango_kao/kaoicon.svg new file mode 100644 index 0000000..43c9187 --- /dev/null +++ b/plugins/python/share/modules/dango_kao/kaoicon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/python/share/modules/datetime.py b/plugins/python/share/modules/datetime.py new file mode 100644 index 0000000..2708716 --- /dev/null +++ b/plugins/python/share/modules/datetime.py @@ -0,0 +1,63 @@ +# -*- coding: utf-8 -*- + +"""Retrieve and convert datetime strings. + +This extension provides items for 'time', 'date', 'datetime' and 'epoch' respectively 'unixtime'. \ +The latter two yield the unix timestamp and also accept a unix timestamp as parameter which will \ +be converted to a datetime string.""" + +import datetime +import time + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "DateTime" +__version__ = "1.0" +__author__ = "Manuel Schneider" +__dependencies__ = [] + +iconPath = iconLookup('x-office-calendar') + + +def handleQuery(query): + fields = list(filter(None, query.string.split())) + if fields: + def makeItem(text: str, subtext: str): + return Item( + id=__prettyname__, + icon=iconPath, + text=text, + subtext=subtext, + completion=query.rawString, + actions=[ClipAction("Copy to clipboard", text)] + ) + + if "date".startswith(fields[0]) and len(fields) == 1: + return makeItem(datetime.date.today().strftime("%x"), + "Current date") + elif "time".startswith(fields[0]) and len(fields) == 1: + return makeItem(datetime.datetime.now().strftime("%X"), + "Current time (local)") + elif "utc".startswith(fields[0]) and len(fields) == 1: + return makeItem(datetime.datetime.utcnow().strftime("%X"), + "Current time (UTC)") + elif "datetime".startswith(fields[0]) and len(fields) == 1: + return makeItem(datetime.datetime.now().strftime("%c"), + "Current date and time") + elif "unixtime".startswith(fields[0]) or "epoch".startswith(fields[0]): + if len(fields) == 2: + if fields[1].isdigit(): + return makeItem(time.strftime("%c", time.localtime(int(fields[1]))), + "Date and time of '%s'" % fields[1]) + else: + return Item( + id=__prettyname__, + icon=iconPath, + text="Invalid input", + subtext="Argument must be empty or numeric.", + completion=query.rawString + ) + else: + return makeItem(datetime.datetime.now().strftime("%s"), + "Current unixtime") diff --git a/plugins/python/share/modules/fortune.py b/plugins/python/share/modules/fortune.py new file mode 100644 index 0000000..f837390 --- /dev/null +++ b/plugins/python/share/modules/fortune.py @@ -0,0 +1,46 @@ +# -*- coding: utf-8 -*- + +"""Fortune wrapper extension""" + +import subprocess as sp +from shutil import which + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Fortune" +__version__ = "1.0" +__trigger__ = "fortune" +__author__ = "Kelvin Wong" +__dependencies__ = ["fortune"] + +cmd = __dependencies__[0] +if which(cmd) is None: + raise Exception("'%s' is not in $PATH." % cmd) + +iconPath = iconLookup("font") + + +def handleQuery(query): + if query.isTriggered: + newFortune = generateFortune() + if newFortune is not None: + return getFortuneItem(query, newFortune) + + +def generateFortune(): + try: + return sp.check_output(["fortune", "-s"]).decode().strip() + except sp.CalledProcessError as e: + return None + + +def getFortuneItem(query, fortune): + return Item( + id=__prettyname__, + icon=iconPath, + text=fortune, + subtext="Copy this random, hopefully interesting, adage", + completion=query.rawString, + actions=[ClipAction("Copy to clipboard", fortune)] + ) diff --git a/plugins/python/share/modules/gnome_dictionary.py b/plugins/python/share/modules/gnome_dictionary.py new file mode 100644 index 0000000..71bef4a --- /dev/null +++ b/plugins/python/share/modules/gnome_dictionary.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- + +"""Search in Gnome dictionary. Needs 'gnome-dictionary' to be already installed. \ +Uses similar keyword to Google's dictionary feature: 'def'. \ +To search, type 'def '""" + +from shutil import which +from subprocess import run + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Gnome Dictionary" +__version__ = "1.0" +__trigger__ = "def " +__author__ = "Nikhil Wanpal" +__dependencies__ = ["gnome-dictionary"] + +if which("gnome-dictionary") is None: + raise Exception("'gnome-dictionary' is not in $PATH.") + +iconPath = iconLookup('accessories-dictionary') + + +def handleQuery(query): + if query.isTriggered: + return Item(id=__prettyname__, + icon=iconPath, + text=__prettyname__, + subtext="Search for '%s' using %s" % (query.string, __prettyname__), + completion=query.rawString, + actions=[ProcAction("Opens %s and searches for '%s'" % (__prettyname__, query.string), + ["gnome-dictionary", "--look-up=%s" % query.string])]) diff --git a/plugins/python/share/modules/gnote.py b/plugins/python/share/modules/gnote.py new file mode 100644 index 0000000..092bce1 --- /dev/null +++ b/plugins/python/share/modules/gnote.py @@ -0,0 +1,74 @@ +# -*- coding: utf-8 -*- + +"""Search, open, create and delete notes.""" + +import re +from datetime import datetime +from shutil import which + +from dbus import DBusException, Interface, SessionBus + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Gnote" +__version__ = "1.1" +__trigger__ = "gn " +__author__ = "Manuel Schneider" +__dependencies__ = ["gnote", "python-dbus"] + +BUS = "org.gnome.%s" % __prettyname__ +OBJ = "/org/gnome/%s/RemoteControl" % __prettyname__ +IFACE = 'org.gnome.%s.RemoteControl' % __prettyname__ + +cmd = __prettyname__.lower() +if which(cmd) is None: + raise Exception("'%s' is not in $PATH." % cmd) + +iconPath = iconLookup(cmd) + + +def handleQuery(query): + results = [] + if query.isTriggered: + try: + if not SessionBus().name_has_owner(BUS): + warning("Seems like %s is not running" % cmd) + return + + obj = SessionBus().get_object(bus_name=BUS, object_path=OBJ) + iface = Interface(obj, dbus_interface=IFACE) + + if query.string.strip(): + for note in iface.SearchNotes(query.string.lower(), False): + results.append( + Item(id="%s%s" % (__prettyname__, note), + icon=iconPath, + text=iface.GetNoteTitle(note), + subtext="%s%s" % ("".join(["#%s " % re.search('.+:.+:(.+)', s).group(1) for s in iface.GetTagsForNote(note)]), + datetime.fromtimestamp(iface.GetNoteChangeDate(note)).strftime("Note from %c")), + completion=query.rawString, + actions=[ + FuncAction("Open note", + lambda note=note: iface.DisplayNote(note)), + FuncAction("Delete note", + lambda note=note: iface.DeleteNote(note)) + ])) + else: + def createAndShowNote(): + note = iface.CreateNote() + iface.DisplayNote(note) + + results.append(Item(id="%s-create" % __prettyname__, + icon=iconPath, + text=__prettyname__, + subtext="%s notes" % __prettyname__, + completion=query.rawString, + actions=[ + FuncAction("Open %s" % __prettyname__, + lambda: iface.DisplaySearch()), + FuncAction("Create a new note", createAndShowNote) + ])) + except DBusException as e: + critical(str(e)) + return results diff --git a/plugins/python/share/modules/goldendict.py b/plugins/python/share/modules/goldendict.py new file mode 100644 index 0000000..5331bb7 --- /dev/null +++ b/plugins/python/share/modules/goldendict.py @@ -0,0 +1,31 @@ +# -*- coding: utf-8 -*- + +"""Fire up an external search in GoldenDict. Just type gd """ + +from shutil import which +from subprocess import run + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "GoldenDict" +__version__ = "1.0" +__trigger__ = "gd " +__author__ = "Manuel Schneider" +__dependencies__ = ["goldendict"] + +if which("goldendict") is None: + raise Exception("'goldendict' is not in $PATH.") + +iconPath = iconLookup('goldendict') + + +def handleQuery(query): + if query.isTriggered: + return Item(id=__prettyname__, + icon=iconPath, + text=__prettyname__, + subtext="Look up '%s' using %s" % (query.string, __prettyname__), + completion=query.rawString, + actions=[ProcAction("Start query in %s" % __prettyname__, + ["goldendict", query.string])]) diff --git a/plugins/python/share/modules/google_translate.py b/plugins/python/share/modules/google_translate.py new file mode 100644 index 0000000..20ca43f --- /dev/null +++ b/plugins/python/share/modules/google_translate.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- + +"""Translate text using Google Translate. +Usage: tr +Example: tr en fr hello + +Check available languages here: https://cloud.google.com/translate/docs/languages""" + +import json +import urllib.parse +import urllib.request + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Google Translate" +__version__ = "1.0" +__trigger__ = "tr " +__author__ = "Manuel Schneider" +__dependencies__ = [] + +ua = "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.62 Safari/537.36" +urltmpl = "https://translate.googleapis.com/translate_a/single?client=gtx&sl=%s&tl=%s&dt=t&q=%s" + +iconPath = iconLookup('config-language') +if not iconPath: + iconPath = ":python_module" + + +def handleQuery(query): + if query.isTriggered: + fields = query.string.split() + item = Item(id=__prettyname__, icon=iconPath, completion=query.rawString) + if len(fields) >= 3: + src = fields[0] + dst = fields[1] + txt = " ".join(fields[2:]) + url = urltmpl % (src, dst, urllib.parse.quote_plus(txt)) + req = urllib.request.Request(url, headers={'User-Agent': ua}) + with urllib.request.urlopen(req) as response: + data = json.loads(response.read().decode('utf-8')) + result = data[0][0][0] + item.text = result + item.subtext = "%s-%s translation of %s" % (src.upper(), dst.upper(), txt) + item.addAction(ClipAction("Copy translation to clipboard", result)) + return item + else: + item.text = __prettyname__ + item.subtext = "Enter a query in the form of \"<srclang> <dstlang> <text>\"" + return item diff --git a/plugins/python/share/modules/ip.py b/plugins/python/share/modules/ip.py new file mode 100644 index 0000000..fa18f61 --- /dev/null +++ b/plugins/python/share/modules/ip.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- + +"""The extension finds out your internal and external IP address.""" + +import socket +from urllib import request + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "IP Addresses" +__version__ = "1.0" +__trigger__ = "ip " +__author__ = "Manuel Schneider, Benedict Dudel" +__dependencies__ = [] + +iconPath = iconLookup("preferences-system-network") + + +def handleQuery(query): + if not query.isTriggered: + return None + + with request.urlopen("https://ipecho.net/plain") as response: + externalIP = response.read().decode() + + s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) + s.connect(("10.255.255.255", 1)) + internalIP = s.getsockname()[0] + s.close() + + items = [] + if externalIP: + items.append(Item( + id = __prettyname__, + icon = iconPath, + text = externalIP, + subtext = "Your external ip address from ipecho.net", + actions = [ + ClipAction("Copy ip address to clipboard", externalIP) + ] + )) + + if internalIP: + items.append(Item( + id = __prettyname__, + icon = iconPath, + text = internalIP, + subtext = "Your internal ip address", + actions = [ + ClipAction("Copy ip address to clipboard", internalIP) + ] + )) + + return items diff --git a/plugins/python/share/modules/jetbrains_projects/__init__.py b/plugins/python/share/modules/jetbrains_projects/__init__.py new file mode 100644 index 0000000..763cf33 --- /dev/null +++ b/plugins/python/share/modules/jetbrains_projects/__init__.py @@ -0,0 +1,125 @@ +# -*- coding: utf-8 -*- + +"""List and open JetBrains IDE projects.""" + +import os +from shutil import which +from xml.etree import ElementTree + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Jetbrains IDE Projects" +__version__ = "1.1" +__trigger__ = "jb " +__author__ = "Markus Richter, Thomas Queste" +__dependencies__ = [] + +default_icon = os.path.dirname(__file__) + "/jetbrains.svg" +HOME_DIR = os.environ["HOME"] + +paths = [ # , + ["CLion", "clion"], + ["DataGrip", "datagrip"], + ["GoLand", "goland"], + ["IntelliJIdea", + "intellij-idea-ue-bundled-jre intellij-idea-ultimate-edition idea-ce-eap idea-ue-eap idea idea-ultimate"], + ["PhpStorm", "phpstorm"], + ["PyCharm", "pycharm pycharm-eap charm"], + ["WebStorm", "webstorm"], +] + + +# find the executable path and icon of a program described by space-separated lists of possible binary-names +def find_exec(namestr: str): + for name in namestr.split(" "): + executable = which(name) + if executable: + icon = iconLookup(name) or default_icon + return executable, icon + return None + + +# parse the xml at path, return all recent project paths and the time they were last open +def get_proj(path): + r = ElementTree.parse(path).getroot() # type:ElementTree.Element + add_info = None + items = dict() + for o in r[0]: # type:ElementTree.Element + if o.attrib["name"] == 'recentPaths': + for i in o[0]: + items[i.attrib["value"]] = 0 + + else: + if o.attrib["name"] == 'additionalInfo': + add_info = o[0] + + if len(items) == 0: + return [] + + if add_info is not None: + for i in add_info: + for o in i[0][0]: + if o.attrib["name"] == 'projectOpenTimestamp': + items[i.attrib["key"]] = int(o.attrib["value"]) + return [(items[e], e.replace("$USER_HOME$", HOME_DIR)) for e in items] + + +def handleQuery(query): + if query.isTriggered: + binaries = {} + projects = [] + + for app in paths: + config_path = "config/options/recentProjectDirectories.xml" + if app[0] == "IntelliJIdea": + config_path = "config/options/recentProjects.xml" + + # dirs contains possibly multiple directories for a program (eg. .GoLand2018.1 and .GoLand2017.3) + dirs = [f for f in os.listdir(HOME_DIR) if + os.path.isdir(os.path.join(HOME_DIR, f)) and f.startswith("." + app[0])] + # take the newest + dirs.sort(reverse=True) + if len(dirs) == 0: + continue + + config_path = os.path.join(HOME_DIR, dirs[0], config_path) + if not os.path.exists(config_path): + continue + + # extract the binary name and icon + binaries[app[0]] = find_exec(app[1]) + + # add all recently opened projects + projects.extend([[e[0], e[1], app[0]] for e in get_proj(config_path)]) + projects.sort(key=lambda s: s[0], reverse=True) + + # List all projects or the one corresponding to the query + if query.string: + projects = [p for p in projects if p[1].lower().find(query.string.lower()) != -1] + + items = [] + for p in projects: + last_update = p[0] + project_path = p[1] + project_dir = project_path.split("/")[-1] + product_name = p[2] + binary = binaries[product_name] + if not binary: + continue + + executable = binary[0] + icon = binary[1] + + items.append(Item( + id="-" + str(last_update), + icon=icon, + text=project_dir, + subtext=project_path, + completion=__trigger__ + project_dir, + actions=[ + ProcAction("Open in %s" % product_name, [executable, project_path]) + ] + )) + + return items diff --git a/plugins/python/share/modules/jetbrains_projects/jetbrains.svg b/plugins/python/share/modules/jetbrains_projects/jetbrains.svg new file mode 100644 index 0000000..f7c7652 --- /dev/null +++ b/plugins/python/share/modules/jetbrains_projects/jetbrains.svg @@ -0,0 +1,66 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/plugins/python/share/modules/kill.py b/plugins/python/share/modules/kill.py new file mode 100644 index 0000000..eb34e2e --- /dev/null +++ b/plugins/python/share/modules/kill.py @@ -0,0 +1,47 @@ +# -*- coding: utf-8 -*- + +"""Unix 'kill' wrapper extension.""" + +import os +from signal import SIGKILL, SIGTERM + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Kill Process" +__version__ = "1.4" +__trigger__ = "kill " +__author__ = "Benedict Dudel, Manuel Schneider" +__dependencies__ = [] + +iconPath = iconLookup('process-stop') + + +def handleQuery(query): + if query.isTriggered: + results = [] + uid = os.getuid() + for dir_entry in os.scandir('/proc'): + try: + if dir_entry.name.isdigit() and dir_entry.stat().st_uid == uid: + proc_command = open(os.path.join(dir_entry.path, 'comm'), 'r').read().strip() + if query.string in proc_command: + proc_cmdline = open(os.path.join(dir_entry.path, 'cmdline'), 'r').read().strip().replace("\0", " ") + results.append( + Item( + id="kill_%s" % proc_cmdline, + icon=iconPath, + text=proc_command.replace(query.string, "%s" % query.string), + subtext=proc_cmdline, + completion=query.rawString, + actions=[ + FuncAction("Terminate", lambda pid=int(dir_entry.name): os.kill(pid, SIGTERM)), + FuncAction("Kill", lambda pid=int(dir_entry.name): os.kill(pid, SIGKILL)) + ] + ) + ) + except FileNotFoundError: # TOCTOU dirs may disappear + continue + except IOError: # TOCTOU dirs may disappear + continue + return results diff --git a/plugins/python/share/modules/locate.py b/plugins/python/share/modules/locate.py new file mode 100644 index 0000000..f1b605e --- /dev/null +++ b/plugins/python/share/modules/locate.py @@ -0,0 +1,56 @@ +# -*- coding: utf-8 -*- + +"""Unix 'locate' wrapper extension. Note that it is up to you to ensure that the database is up to \ +date""" + +import os +import re +import subprocess +from shutil import which + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Locate" +__version__ = "1.0" +__trigger__ = "'" +__author__ = "Manuel Schneider" +__dependencies__ = ['locate'] + +if which("locate") is None: + raise Exception("'locate' is not in $PATH.") + +for iconName in ["system-search", "search", "text-x-generic"]: + iconPath = iconLookup(iconName) + if iconPath: + break + + +def handleQuery(query): + results = [] + if query.isTriggered: + if len(query.string) > 2: + pattern = re.compile(query.string, re.IGNORECASE) + proc = subprocess.Popen(['locate', '-bi', query.string], stdout=subprocess.PIPE) + for line in proc.stdout: + path = line.decode().strip() + basename = os.path.basename(path) + results.append( + Item( + id=path, + icon=iconPath, + text=pattern.sub(lambda m: "%s" % m.group(0), basename), + subtext=path, + completion="%s%s" % (__trigger__, basename), + actions=[UrlAction("Open", "file://%s" % path)])) + else: + results.append( + Item( + id=__prettyname__, + icon=iconPath, + text="Update locate database", + subtext="Type at least three chars for a seach", + completion=query.rawString, + actions=[TermAction("Update database", ["sudo", "updatedb"])])) + + return results diff --git a/plugins/python/share/modules/mathematica_eval.py b/plugins/python/share/modules/mathematica_eval.py new file mode 100644 index 0000000..2fada70 --- /dev/null +++ b/plugins/python/share/modules/mathematica_eval.py @@ -0,0 +1,43 @@ +# -*- coding: utf-8 -*- + +'''Evaulate Mathematica expressions.''' + +import subprocess +from shutil import which +from tempfile import NamedTemporaryFile + +from albertv0 import * + +__iid__ = 'PythonInterface/v0.1' +__prettyname__ = 'Mathematica eval' +__version__ = '1.0' +__trigger__ = 'mma ' +__author__ = 'Asger Hautop Drewsen' +__dependencies__ = ['mathematica'] + +if not which('wolframscript'): + raise Exception("`wolframscript` is not in $PATH.") + +ICON_PATH = iconLookup('wolfram-mathematica') + +def handleQuery(query): + if not query.isTriggered: + return + + item = Item(completion=query.rawString, icon=ICON_PATH) + stripped = query.string.strip() + + if stripped: + with NamedTemporaryFile() as f: + f.write(bytes(stripped, 'utf-8')) + f.flush() + output = subprocess.check_output(['wolframscript', '-print', '-f', f.name]) + result = str(output.strip(), 'utf-8') + item.text = result + item.subtext = 'Result' + item.addAction(ClipAction('Copy result to clipboard', result)) + else: + item.text = '' + item.subtext = 'Type a Mathematica expression' + + return item diff --git a/plugins/python/share/modules/multi_google_translate.py b/plugins/python/share/modules/multi_google_translate.py new file mode 100644 index 0000000..df25a2a --- /dev/null +++ b/plugins/python/share/modules/multi_google_translate.py @@ -0,0 +1,100 @@ +# -*- coding: utf-8 -*- + +"""Use Google Translate to translate your sentence into multiple languages. \ +Visit the following link to check available languages: \ +https://cloud.google.com/translate/docs/languages \ +To add or remove languages use modifier key when trigger is activated or go to: \ +'~/.config/albert/org.albert.extension.mtr/config.json' \ +Add or remove elements based on the ISO-Codes that you found on the google documentation page.""" + +import json +import os +import urllib.error +import urllib.parse +import urllib.request + +from albertv0 import * + +__iid__ = "PythonInterface/v0.2" +__prettyname__ = "MultiTranslate" +__version__ = "1.1" +__trigger__ = "mtr " +__author__ = "David Britt" +__dependencies__ = [] + +iconPath = iconLookup('config-language') +if not iconPath: + iconPath = ":python_module" + +ua = "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.62 Safari/537.36" +urltmpl = "https://translate.googleapis.com/translate_a/single?client=gtx&sl=auto&tl=%s&dt=t&q=%s" +urlbrowser = "https://translate.google.com/#auto/%s/%s" +configurationFileName = "language_config.json" +configuration_directory = os.path.join(configLocation(), __prettyname__) +language_configuration_file = os.path.join(configuration_directory, configurationFileName) +languages = [] + +def initialize(): + if os.path.exists(language_configuration_file): + with open(language_configuration_file) as json_config: + languages.extend(json.load(json_config)["languages"]) + else: + languages.extend(["en", "zh-CN", "hi", "es", "ru", "pt", "id", "bn", "ar", "ms", "ja", "fr", "de"]) + try: + os.makedirs(configuration_directory, exist_ok=True) + try: + with open(language_configuration_file, "w") as output_file: + json.dump({"languages": languages}, output_file) + except OSError: + print("There was an error opening the file: %s" % language_configuration_file) + except OSError: + print("There was an error making the directory: %s" % configuration_directory) + + +def handleQuery(query): + results = [] + if query.isTriggered: + item = Item( + id=__prettyname__, + icon=iconPath, + completion=query.rawString, + text=__prettyname__, + actions=[ProcAction("Open the language configuration file.", + commandline=["xdg-open", language_configuration_file])] + ) + if len(query.string) >= 2: + for lang in languages: + try: + url = urltmpl % (lang, urllib.parse.quote_plus(query.string)) + req = urllib.request.Request(url, headers={'User-Agent': ua}) + with urllib.request.urlopen(req) as response: + #print(type()) + #try: + data = json.loads(response.read().decode()) + #except TypeError as typerr: + # print("Urgh this type.error. %s" % typerr) + translText = data[0][0][0] + sourceText = data[2] + if sourceText == lang: + continue + else: + results.append( + Item( + id=__prettyname__, + icon=iconPath, + text="%s" % (translText), + subtext="%s" % lang.upper(), + actions=[ + ClipAction("Copy translation to clipboard", translText), + UrlAction("Open in your Browser", urlbrowser % (lang, query.string)) + ] + ) + ) + except urllib.error.URLError as urlerr : + print("Check your internet connection: %s" % urlerr) + item.subtext = "Check your internet connection." + return item + else: + item.subtext = "Enter a query: 'mtr <text>'. Languages {%s}" % ", ".join(languages) + return item + return results diff --git a/plugins/python/share/modules/npm/__init__.py b/plugins/python/share/modules/npm/__init__.py new file mode 100644 index 0000000..68757f6 --- /dev/null +++ b/plugins/python/share/modules/npm/__init__.py @@ -0,0 +1,80 @@ +# -*- coding: utf-8 -*- + +"""Provides a way to install, remove and search for packages in the npmjs.com database. To trigger \ +the extension you just need to type `npm ` in albert. If no search query is supplied you have the \ +option to update all globally installed packages.""" + +from albertv0 import * +from shutil import which +import os +import json +import subprocess + + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "npm" +__version__ = "1.0" +__trigger__ = "npm " +__author__ = "Benedict Dudel" +__dependencies__ = ["npm"] + + +if which("npm") is None: + raise Exception("'npm' is not in $PATH.") + +iconPath = iconLookup("npm") +if not iconPath: + iconPath = os.path.dirname(__file__)+"/logo.svg" + + +def handleQuery(query): + if query.isTriggered: + if not query.string.strip(): + return Item( + id = __prettyname__, + icon = iconPath, + text = "Update", + subtext = "Update all globally installed packages", + actions = [ + TermAction("", ["npm", "update", "--global"]) + ] + ) + + items = getSearchResults(query.string.strip()) + if not items: + return Item( + id = __prettyname__, + icon = iconPath, + text = "Search on npmjs.com", + subtext = "No modules found in local database. Try to search on npmjs.com", + actions = [ + UrlAction( + "Search on npmjs.com", + "https://www.npmjs.com/search?q=%s" % query.string.strip() + ) + ] + ) + + return items + +def getSearchResults(query): + proc = subprocess.run(["npm", "search", "--json", query], stdout=subprocess.PIPE) + + items = [] + for module in json.loads(proc.stdout.decode()): + items.append( + Item( + id = __prettyname__, + icon = iconPath, + text = "%s (%s)" % (module["name"], module["version"]), + subtext = module.get("description", ""), + actions = [ + UrlAction("Open module on npmjs.com", "https://www.npmjs.com/package/%s" % module["name"]), + TermAction("Install", ["npm", "install", "--global", module["name"]]), + TermAction("Update", ["npm", "update", "--global", module["name"]]), + TermAction("Remove", ["npm", "uninstall", "--global", module["name"]]), + ] + ) + ) + + return items diff --git a/plugins/python/share/modules/npm/logo.svg b/plugins/python/share/modules/npm/logo.svg new file mode 100644 index 0000000..77b5005 --- /dev/null +++ b/plugins/python/share/modules/npm/logo.svg @@ -0,0 +1,13 @@ + + + + + + + + + + diff --git a/plugins/python/share/modules/packagist/__init__.py b/plugins/python/share/modules/packagist/__init__.py new file mode 100644 index 0000000..32d056e --- /dev/null +++ b/plugins/python/share/modules/packagist/__init__.py @@ -0,0 +1,92 @@ +# -*- coding: utf-8 -*- + +"""Simple extension to search for PHP packages on Packagist. To install packages \ +you need to have installed composer. By default this extension will search by \ +package name. But searching for packages by type or tag is supported as well.""" + +from albertv0 import * +import os +import json +import urllib.request +from shutil import which + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Packagist" +__version__ = "1.0" +__trigger__ = "packagist " +__author__ = "Benedict Dudel" +__dependencies__ = ["composer"] + + +if which("composer") is None: + raise Exception("'composer' is not in $PATH.") + +iconPath = os.path.dirname(__file__)+"/logo.png" + + +def handleQuery(query): + if query.isTriggered: + if not query.string.strip(): + return [ + Item( + id = "packagist-search-by-tag", + icon = iconPath, + text = "by tag", + subtext = "Searching for packages by tag", + completion = "%stag " % __trigger__, + actions=[] + ), + Item( + id = "packagist-search-by-type", + icon = iconPath, + text = "by type", + subtext = "Searching for packages by type", + completion = "%stype " % __trigger__, + actions=[] + ) + ] + + if query.string.strip().startswith("tag "): + if query.string.strip()[4:]: + return getItems("https://packagist.org/search.json?tags=%s" % query.string.strip()[4:]) + + if query.string.strip().startswith("type "): + if query.string.strip()[5:]: + return getItems("https://packagist.org/search.json?type=%s" % query.string.strip()[5:]) + + return getItems("https://packagist.org/search.json?q=%s" % query.string) + +def getItems(url): + items = [] + with urllib.request.urlopen(url) as uri: + packages = json.loads(uri.read().decode()) + for package in packages['results']: + items.append( + Item( + id = "packagist-package-%s" % package["name"], + icon = iconPath, + text = package["name"], + subtext = package["description"], + completion = "%sname %s" % (__trigger__, package["name"]), + actions = [ + UrlAction( + text = "Open on packagist.org", + url = package["url"] + ), + UrlAction( + text = "Open url of repository", + url = package["repository"] + ), + TermAction( + text = "Install", + commandline = ["composer", "global", "require", package['name']] + ), + TermAction( + text = "Remove", + commandline = ["composer", "global", "remove", package['name']] + ) + ] + ) + ) + + return items diff --git a/plugins/python/share/modules/packagist/logo.png b/plugins/python/share/modules/packagist/logo.png new file mode 100644 index 0000000..76c0e62 Binary files /dev/null and b/plugins/python/share/modules/packagist/logo.png differ diff --git a/plugins/python/share/modules/pacman.py b/plugins/python/share/modules/pacman.py new file mode 100644 index 0000000..1399bda --- /dev/null +++ b/plugins/python/share/modules/pacman.py @@ -0,0 +1,97 @@ +# -*- coding: utf-8 -*- + +"""Extension for the package manager `pacman`. + +The extension provides a way to install, remove and search for packages in the \ +archlinux.org database. To trigger the extension you just need to type `pacman ` \ +in albert. + +If no search query is supplied you have the option to do a system update. \ +Otherwise albert will try to search for packages with the search query within \ +the package name. + +For more information about `pacman` please have a look at: \ +https://wiki.archlinux.org/index.php/pacman""" + +import re +import subprocess +from shutil import which + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "PacMan" +__version__ = "1.1" +__trigger__ = "pacman " +__author__ = "Manuel Schneider, Benedict Dudel" +__dependencies__ = ["pacman", "expac"] + + +if which("pacman") is None: + raise Exception("'pacman' is not in $PATH.") + +iconPath = iconLookup("system-software-install") + + +def handleQuery(query): + if query.isTriggered: + if not query.string.strip(): + return Item( + id="%s-update" % __prettyname__, + icon=iconPath, + text="Pacman package manager", + subtext="Enter the name of the package you are looking for", + completion=__trigger__ + ) + + items = [] + pattern = re.compile(query.string, re.IGNORECASE) + proc = subprocess.Popen(["expac", "-Ss", "%n\n%v\n%r\n%d\n%u\n%E", query.string], + stdout=subprocess.PIPE) + for line in proc.stdout: + name = line.decode().rstrip() + vers = proc.stdout.readline().decode().rstrip() + repo = proc.stdout.readline().decode().rstrip() + desc = proc.stdout.readline().decode().rstrip() + purl = proc.stdout.readline().decode().rstrip() + deps = proc.stdout.readline().decode().rstrip() + + items.append(Item( + id="%s%s%s" % (__prettyname__, repo, name), + icon=iconPath, + text="%s %s [%s]" % (pattern.sub(lambda m: "%s" % m.group(0), name), vers, repo), + subtext="%s (%s)" % (pattern.sub(lambda m: "%s" % m.group(0), desc), deps) if deps else pattern.sub(lambda m: "%s" % m.group(0), desc), + completion="%s%s" % (query.trigger, name), + actions=[ + TermAction("Install", ["sudo", "pacman", "-S", name]), + TermAction("Remove", ["sudo", "pacman", "-Rs", name]), + UrlAction("Show on packages.archlinux.org", + "https://www.archlinux.org/packages/%s/x86_64/%s/" % (repo, name)), + UrlAction("Show project website", purl) + ] + )) + + if not items: + return Item( + id="%s-empty" % __prettyname__, + icon=iconPath, + text="Search on archlinux.org", + subtext="No results found in the local database", + completion=__trigger__, + actions=[ + UrlAction("Search on archlinux.org", + "https://www.archlinux.org/packages/?q=%s" % query.string.strip()) + ] + ) + + return items + + elif len(query.string.strip()) > 0 and ("pacman".startswith(query.string.lower()) or "update".startswith(query.string.lower())): + return Item( + id="%s-update" % __prettyname__, + icon=iconPath, + text="Update all packages on the system", + subtext="Synchronizes the repository databases and updates the system's packages", + completion=__trigger__, + actions=[TermAction("Update the system", ["sudo", "pacman", "-Syu"])] + ) diff --git a/plugins/python/share/modules/pass.py b/plugins/python/share/modules/pass.py new file mode 100644 index 0000000..4125f08 --- /dev/null +++ b/plugins/python/share/modules/pass.py @@ -0,0 +1,93 @@ +# -*- coding: utf-8 -*- + +"""'pass' wrapper extension.""" + +import fnmatch +import os +from shutil import which + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Pass" +__version__ = "1.0" +__trigger__ = "pass " +__author__ = "Benedict Dudel" +__dependencies__ = ["pass"] + + +if which("pass") is None: + raise Exception("'pass' is not in $PATH.") + +HOME_DIR = os.environ["HOME"] +PASS_DIR = os.environ.get("PASSWORD_STORE_DIR", os.path.join(HOME_DIR, ".password-store/")) +ICON_PATH = iconLookup("dialog-password") + + +def handleQuery(query): + if query.isTriggered: + if query.string.strip().startswith("generate"): + return generatePassword(query) + + return showPasswords(query) + +def generatePassword(query): + location = query.string.strip()[9:] + + return [Item( + id=__prettyname__, + icon=ICON_PATH, + text="Generate a new password", + subtext="The new password will be located at %s" % location, + completion="pass %s" % query.string, + actions=[ + ProcAction("Generate", ["pass", "generate", "--clip", location, "20"]) + ] + )] + +def showPasswords(query): + passwords = [] + if query.string.strip(): + passwords = getPasswordsFromSearch(query) + else: + passwords = getPasswords() + + results = [] + for password in passwords: + name = password.split("/")[-1] + results.append( + Item( + id=password, + icon=ICON_PATH, + text=name, + subtext=password, + completion="pass %s" % password, + actions=[ + ProcAction("Copy", ["pass", "--clip", password]), + ProcAction("Edit", ["pass", "edit", password]), + ProcAction("Remove", ["pass", "rm", "--force", password]), + ] + ), + ) + + return results + +def getPasswords(): + passwords = [] + for root, dirnames, filenames in os.walk(PASS_DIR): + for filename in fnmatch.filter(filenames, "*.gpg"): + passwords.append( + os.path.join(root, filename.replace(".gpg", "")).replace(PASS_DIR, "") + ) + + return sorted(passwords, key=lambda s: s.lower()) + +def getPasswordsFromSearch(query): + passwords = [] + for password in getPasswords(): + if query.string.strip().lower() not in password.lower(): + continue + + passwords.append(password) + + return passwords diff --git a/plugins/python/share/modules/pidgin.py b/plugins/python/share/modules/pidgin.py new file mode 100644 index 0000000..90a9446 --- /dev/null +++ b/plugins/python/share/modules/pidgin.py @@ -0,0 +1,87 @@ +"""This plugin allows to open a chat window from albert +Usage: pidgin +Matching contacts will be suggested""" + +from albertv0 import * +import dbus + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Pidgin" +__version__ = "1.0" +__author__ = "Greizgh" +__trigger__ = "pidgin " +__dependencies__ = ["dbus"] + +iconPath = iconLookup("pidgin") +bus = dbus.SessionBus() + + +class ContactHandler: + """Handle pidgin contact list""" + + _purple = None + _contacts = [] + + def __init__(self): + self.refresh() + + def refresh(self): + """Refresh both dbus connection and pidgin contact list""" + try: + self._contacts = [] + self._purple = bus.get_object( + "im.pidgin.purple.PurpleService", "/im/pidgin/purple/PurpleObject" + ) + accounts = self._purple.PurpleAccountsGetAllActive() + for account in accounts: + buddies = self._purple.PurpleFindBuddies(account, "") + for buddy in buddies: + # if purple.PurpleBuddyIsOnline(buddy): + name = self._purple.PurpleBuddyGetAlias(buddy) + self._contacts.append((name, account)) + except dbus.DBusException: + critical("Could not connect to pidgin service") + + def isReady(self): + """Check that this handler is ready to communicate""" + return self._purple is not None + + def chatWith(self, account, name): + """Open a pidgin chat window""" + self._purple.PurpleConversationNew(1, account, name) + + def getMatch(self, query): + """Get buddies matching query""" + normalized = query.lower() + return [item for item in self._contacts if normalized in item[0].lower()] + + +handler = ContactHandler() + + +def handleQuery(query): + if not handler.isReady(): + handler.refresh() + + if query.isTriggered: + target = query.string.strip() + + if target: + items = [] + for match in handler.getMatch(target): + items.append( + Item( + id=__prettyname__, + icon=iconPath, + text="Chat with {}".format(match[0]), + subtext="Open a pidgin chat window", + completion=match[0], + actions=[ + FuncAction( + "Open chat window", + lambda: handler.chatWith(match[1], match[0]), + ) + ], + ) + ) + return items diff --git a/plugins/python/share/modules/pomodoro/__init__.py b/plugins/python/share/modules/pomodoro/__init__.py new file mode 100644 index 0000000..2c8ca45 --- /dev/null +++ b/plugins/python/share/modules/pomodoro/__init__.py @@ -0,0 +1,137 @@ +# -*- coding: utf-8 -*- + +"""Pomodoro extension. See https://en.wikipedia.org/wiki/Pomodoro_Technique""" + +from albertv0 import * +from shutil import which +import subprocess +import threading +import re +import time +import os + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Pomodoro" +__version__ = "1.0" +__author__ = "Manuel Schneider" +__dependencies__ = [] + + +class PomodoroTimer: + + def __init__(self): + self.isBreak = True + self.timer = None + + def timeout(self): + if self.isBreak: + duration = self.pomodoroDuration * 60 + self.timer = threading.Timer(duration, self.timeout) + self.endTime = time.time() + duration + debug("Pomodoro start (%s min)" % self.pomodoroDuration) + playSound(1) + self.timer.start() + else: + self.remainingTillLongBreak -= 1 + if self.remainingTillLongBreak == 0: + self.remainingTillLongBreak = self.count + duration = self.longBreakDuration * 60 + playSound(3) + debug("Pomodoro long break (%s min)" % self.breakDuration) + else: + duration = self.breakDuration * 60 + playSound(2) + debug("Pomodoro break (%s min)" % self.breakDuration) + self.endTime = time.time() + duration + self.timer = threading.Timer(duration, self.timeout) + self.timer.start() + self.isBreak = not self.isBreak + + def start(self, pomodoroDuration, breakDuration, longBreakDuration, count): + self.stop() + self.pomodoroDuration = pomodoroDuration + self.breakDuration = breakDuration + self.longBreakDuration = longBreakDuration + self.count = count + self.remainingTillLongBreak = count + self.isBreak = True + self.timeout() + + def stop(self): + if self.isActive(): + self.timer.cancel() + self.timer = None + + def isActive(self): + return self.timer is not None + + +iconPath = os.path.dirname(__file__)+"/pomodoro.svg" +soundPath = os.path.dirname(__file__)+"/bing.wav" +pomodoro = PomodoroTimer() + + +def playSound(num): + for x in range(num): + t = threading.Timer(0.5*x, lambda: subprocess.Popen(["aplay", soundPath])) + t.start() + + +def handleQuery(query): + tokens = query.string.split() + if tokens and "pomodoro".startswith(tokens[0].lower()): + + global pomodoro + pattern = re.compile(query.string, re.IGNORECASE) + item = Item( + id=__prettyname__, + icon=iconPath, + text=pattern.sub(lambda m: "%s" % m.group(0), "Pomodoro Timer"), + completion=query.rawString + ) + + if len(tokens) == 1 and pomodoro.isActive(): + item.addAction(FuncAction("Stop", lambda p=pomodoro: p.stop())) + if pomodoro.isBreak: + whatsNext = "Pomodoro" + else: + whatsNext = "Long break" if pomodoro.remainingTillLongBreak == 1 else "Short break" + item.subtext = "Stop pomodoro (Next: %s at %s)" % (whatsNext, time.strftime("%X", + time.localtime(pomodoro.endTime))) + return item + + p_duration = 25 + b_duration = 5 + lb_duration = 15 + count = 4 + + item.subtext = "Invalid parameters. Use pomodoro [duration [break duration [long break duration [count]]]]" + if len(tokens) > 1: + if not tokens[1].isdigit(): + return item + p_duration = int(tokens[1]) + + if len(tokens) > 2: + if not tokens[2].isdigit(): + return item + b_duration = int(tokens[2]) + + if len(tokens) > 3: + if not tokens[3].isdigit(): + return item + lb_duration = int(tokens[3]) + + if len(tokens) > 4: + if not tokens[4].isdigit(): + return item + count = int(tokens[4]) + + if len(tokens) > 5: + return item + + item.subtext = "Start new pomodoro timer (%s min/Break %s min/Long break %s min/Count %s)" % (p_duration, b_duration, lb_duration, count) + item.addAction(FuncAction("Start", + lambda p=p_duration, b=b_duration, lb=lb_duration, c=count: + pomodoro.start(p, b, lb, c))) + + return item diff --git a/plugins/python/share/modules/pomodoro/bing.wav b/plugins/python/share/modules/pomodoro/bing.wav new file mode 100644 index 0000000..1e9ef10 Binary files /dev/null and b/plugins/python/share/modules/pomodoro/bing.wav differ diff --git a/plugins/python/share/modules/pomodoro/pomodoro.svg b/plugins/python/share/modules/pomodoro/pomodoro.svg new file mode 100644 index 0000000..fea164a --- /dev/null +++ b/plugins/python/share/modules/pomodoro/pomodoro.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/python/share/modules/python_eval/__init__.py b/plugins/python/share/modules/python_eval/__init__.py new file mode 100644 index 0000000..8655ff8 --- /dev/null +++ b/plugins/python/share/modules/python_eval/__init__.py @@ -0,0 +1,43 @@ +# -*- coding: utf-8 -*- + +"""Evaluate simple python expressions. Use it with care every keystroke triggers an evaluation.""" + +from albertv0 import * +from math import * +from builtins import pow +try: + import numpy as np +except ImportError: + pass +import os + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Python Eval" +__version__ = "1.0" +__trigger__ = "py " +__author__ = "Manuel Schneider" +__dependencies__ = [] + + +iconPath = os.path.dirname(__file__)+"/python.svg" + + +def handleQuery(query): + if query.isTriggered: + item = Item(id=__prettyname__, icon=iconPath, completion=query.rawString) + stripped = query.string.strip() + + if stripped == '': + item.text = "Enter a python expression" + item.subtext = "Math is in the namespace and, if installed, also Numpy as 'np'" + return item + else: + try: + result = eval(stripped) + except Exception as ex: + result = ex + item.text = str(result) + item.subtext = type(result).__name__ + item.addAction(ClipAction("Copy result to clipboard", str(result))) + item.addAction(FuncAction("Execute", lambda: exec(str(result)))) + return item diff --git a/plugins/python/share/modules/python_eval/python.svg b/plugins/python/share/modules/python_eval/python.svg new file mode 100644 index 0000000..efd42b1 --- /dev/null +++ b/plugins/python/share/modules/python_eval/python.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/python/share/modules/scrot.py b/plugins/python/share/modules/scrot.py new file mode 100644 index 0000000..51cb3bf --- /dev/null +++ b/plugins/python/share/modules/scrot.py @@ -0,0 +1,101 @@ +# -*- coding: utf-8 -*- + +"""Extension which basically wraps the command line utility scrot to make \ +screenshots from albert. The extension supports taking screenshots of the whole \ +screen, an specific area or the current active window. + +When the screenshot was made you will hear a sound which indicates that the \ +screenshot was taken successfully. + +Screenshots will be saved in XDG_PICTURES_DIR or in the temp directory.""" + +import os +import subprocess +import tempfile +from shutil import which + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "SCReenshOT utility" +__version__ = "1.0" +__trigger__ = "scrot " +__author__ = "Benedict Dudel" +__dependencies__ = ["scrot", "xclip"] + + +if which("scrot") is None: + raise Exception("'scrot' is not in $PATH.") + +if which("xclip") is None: + raise Exception("'xclip' is not in $PATH.") + +iconPath = iconLookup("camera-photo") + + +def handleQuery(query): + if query.isTriggered: + return [ + Item( + id = "%s-whole-screen" % __prettyname__, + icon = iconPath, + text = "Screen", + subtext = "Take a screenshot of the whole screen", + actions = [ + FuncAction( + "Take screenshot of whole screen", + lambda: doScreenshot([]) + ), + FuncAction( + "Take screenshot of multiple displays", + lambda: doScreenshot(["--multidisp"]) + ), + ] + ), + Item( + id = "%s-area-of-screen" % __prettyname__, + icon = iconPath, + text = "Area", + subtext = "Draw a rectangle with your mouse to capture an area", + actions = [ + FuncAction( + "Take screenshot of selected area", + lambda: doScreenshot(["--select"]) + ), + ] + ), + Item( + id = "%s-current-window" % __prettyname__, + icon = iconPath, + text = "Window", + subtext = "Take a screenshot of the current active window", + actions = [ + FuncAction( + "Take screenshot of window with borders", + lambda: doScreenshot(["--focused", "--border"]) + ), + FuncAction( + "Take screenshot of window without borders", + lambda: doScreenshot(["--focused"]) + ), + ] + ), + ] + +def getScreenshotDirectory(): + if which("xdg-user-dir") is None: + return tempfile.gettempdir() + + proc = subprocess.run(["xdg-user-dir", "PICTURES"], stdout=subprocess.PIPE) + + pictureDirectory = proc.stdout.decode("utf-8") + if pictureDirectory: + return pictureDirectory.strip() + + return tempfile.gettempdir() + +def doScreenshot(additionalArguments): + file = os.path.join(getScreenshotDirectory(), "%Y-%m-%d-%T-screenshot.png") + + command = "sleep 0.1 && scrot --exec 'xclip -selection c -t image/png < $f' %s " % file + proc = subprocess.Popen(command + " ".join(additionalArguments), shell=True) diff --git a/plugins/python/share/modules/tex_to_unicode.py b/plugins/python/share/modules/tex_to_unicode.py new file mode 100644 index 0000000..a28f435 --- /dev/null +++ b/plugins/python/share/modules/tex_to_unicode.py @@ -0,0 +1,61 @@ +# -*- coding: utf-8 -*- + +'''Convert TeX mathmode commands to unicode characters.''' + +import re +import unicodedata + +from pylatexenc.latex2text import LatexNodes2Text + +from albertv0 import * + +__iid__ = 'PythonInterface/v0.1' +__prettyname__ = 'TeX to unicode' +__version__ = '1.0' +__trigger__ = 'tex ' +__author__ = 'Asger Hautop Drewsen' +__dependencies__ = ['python-pylatexenc'] + +COMBINING_LONG_SOLIDUS_OVERLAY = '\u0338' + + +def handleQuery(query): + if not query.isTriggered: + return + + item = Item(completion=query.rawString) + stripped = query.string.strip() + + success = False + if stripped: + if not stripped.startswith('\\'): + stripped = '\\' + stripped + + # Remove double backslashes (newlines) + stripped = stripped.replace('\\\\', ' ') + + # pylatexenc doesn't support \not + stripped = stripped.replace('\\not', '@NOT@') + + # pylatexenc doesn't like backslashes at end of string + if not stripped.endswith('\\'): + n = LatexNodes2Text() + result = n.latex_to_text(stripped) + if result: + result = unicodedata.normalize('NFC', result) + result = re.sub(r'@NOT@\s*(\S)', '\\1' + COMBINING_LONG_SOLIDUS_OVERLAY, result) + result = result.replace('@NOT@', '') + result = unicodedata.normalize('NFC', result) + item.text = result + item.subtext = 'Result' + success = True + + if not success: + item.text = stripped + item.subtext = 'Type some TeX math' + success = False + + if success: + item.addAction(ClipAction('Copy result to clipboard', result)) + + return item diff --git a/plugins/python/share/modules/timer/__init__.py b/plugins/python/share/modules/timer/__init__.py new file mode 100644 index 0000000..8ca8bb0 --- /dev/null +++ b/plugins/python/share/modules/timer/__init__.py @@ -0,0 +1,105 @@ +# -*- coding: utf-8 -*- + +"""Set up timers. Lists all timers when triggered. Additional arguments in the form of \ +[[hours:]minutes:]seconds let you set triggers. Empty field resolve to 0, e.g. "96::" starts a 96 \ +hours timer. Fields exceeding the maximum amount of the time interval are automatically \ +refactorized, e.g. "9:120:3600" resolves to 12 hours.""" + +from albertv0 import * +from threading import Timer +from time import strftime, time, localtime +import os +import subprocess + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Timer" +__version__ = "1.0" +__trigger__ = "timer " +__author__ = "Manuel Schneider" +__dependencies__ = [] + +iconPath = os.path.dirname(__file__)+"/time.svg" +soundPath = os.path.dirname(__file__)+"/bing.wav" +timers = [] + + +class AlbertTimer(Timer): + + def __init__(self, interval): + + def timeout(): + subprocess.Popen(["aplay", soundPath]) + global timers + timers.remove(self) + + super().__init__(interval=interval, function=timeout) + self.interval = interval + self.begin = int(time()) + self.end = self.begin + interval + self.start() + + +def startTimer(interval): + global timers + timers.append(AlbertTimer(interval)) + + +def deleteTimer(timer): + global timers + timers.remove(timer) + timer.cancel() + + +def formatSeconds(seconds): + m, s = divmod(seconds, 60) + h, m = divmod(m, 60) + return "%02d:%02d:%02d" % (h, m, s) + + +def handleQuery(query): + if query.isTriggered: + + if query.string.strip(): + fields = query.string.strip().split(":") + if not all(field.isdigit() or field == '' for field in fields): + return Item( + id=__prettyname__, + text="Invalid input", + subtext="Enter a query in the form of '%s[[hours:]minutes:]'" % __trigger__, + icon=iconPath, + completion=query.rawString + ) + + seconds = 0 + fields.reverse() + for i in range(len(fields)): + seconds += int(fields[i] if fields[i] else 0)*(60**i) + + return Item( + id=__prettyname__, + text=formatSeconds(seconds), + subtext="Set a timer", + icon=iconPath, + completion=query.rawString, + actions=[FuncAction("Set timer", lambda sec=seconds: startTimer(sec))] + ) + + else: + # List timers + items = [] + for timer in timers: + + m, s = divmod(timer.interval, 60) + h, m = divmod(m, 60) + identifier = "%d:%02d:%02d" % (h, m, s) + + items.append(Item( + id=__prettyname__, + text="Delete timer [%s]" % identifier, + subtext="Times out %s" % strftime("%X", localtime(timer.end)), + icon=iconPath, + completion=query.rawString, + actions=[FuncAction("Delete timer", lambda timer=timer: deleteTimer(timer))] + )) + + return items diff --git a/plugins/python/share/modules/timer/bing.wav b/plugins/python/share/modules/timer/bing.wav new file mode 100644 index 0000000..1e9ef10 Binary files /dev/null and b/plugins/python/share/modules/timer/bing.wav differ diff --git a/plugins/python/share/modules/timer/time.svg b/plugins/python/share/modules/timer/time.svg new file mode 100644 index 0000000..f6cc4d0 --- /dev/null +++ b/plugins/python/share/modules/timer/time.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/python/share/modules/tomboy.py b/plugins/python/share/modules/tomboy.py new file mode 100644 index 0000000..574dc44 --- /dev/null +++ b/plugins/python/share/modules/tomboy.py @@ -0,0 +1,74 @@ +# -*- coding: utf-8 -*- + +""""Search, open, create and delete Tomboy notes.""" + +import re +from datetime import datetime +from shutil import which + +from dbus import DBusException, Interface, SessionBus + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Tomboy" +__version__ = "1.1" +__trigger__ = "tb " +__author__ = "Manuel Schneider" +__dependencies__ = ["tomboy", "python-dbus"] + +BUS = "org.gnome.%s" % __prettyname__ +OBJ = "/org/gnome/%s/RemoteControl" % __prettyname__ +IFACE = 'org.gnome.%s.RemoteControl' % __prettyname__ + +cmd = __dependencies__[0] +if which(cmd) is None: + raise Exception("'%s' is not in $PATH." % cmd) + +iconPath = iconLookup(cmd) + + +def handleQuery(query): + results = [] + if query.isTriggered: + try: + if not SessionBus().name_has_owner(BUS): + warning("Seems like %s is not running" % cmd) + return + + obj = SessionBus().get_object(bus_name=BUS, object_path=OBJ) + iface = Interface(obj, dbus_interface=IFACE) + + if query.string.strip(): + for note in iface.SearchNotes(query.string.lower(), False): + results.append( + Item(id="%s%s" % (cmd, note), + icon=iconPath, + text=iface.GetNoteTitle(note), + subtext="%s%s" % ("".join(["#%s " % re.search('.+:.+:(.+)', s).group(1) for s in iface.GetTagsForNote(note)]), + datetime.fromtimestamp(iface.GetNoteChangeDate(note)).strftime("Note from %c")), + completion=query.rawString, + actions=[ + FuncAction("Open note", + lambda note=note: iface.DisplayNote(note)), + FuncAction("Delete note", + lambda note=note: iface.DeleteNote(note)) + ])) + else: + def createAndShowNote(): + note = iface.CreateNote() + iface.DisplayNote(note) + + results.append(Item(id="%s-create" % cmd, + icon=iconPath, + text=__prettyname__, + subtext="%s notes" % __prettyname__, + completion=query.rawString, + actions=[ + FuncAction("Open %s" % __prettyname__, + lambda: iface.DisplaySearch()), + FuncAction("Create a new note", createAndShowNote) + ])) + except DBusException as e: + critical(str(e)) + return results diff --git a/plugins/python/share/modules/trash.py b/plugins/python/share/modules/trash.py new file mode 100644 index 0000000..6127e56 --- /dev/null +++ b/plugins/python/share/modules/trash.py @@ -0,0 +1,31 @@ +# -*- coding: utf-8 -*- + +"""This is a simple trash extension providing a single item which opens the systems virtual trash \ +location in your default file manager on activation.""" + +import re + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Trash" +__version__ = "1.0" +__trigger__ = "trash " +__author__ = "Manuel Schneider" +__dependencies__ = [] + +iconPath = iconLookup("user-trash-full") + + +def handleQuery(query): + + if query.string.strip() and "trash".startswith(query.string.lower()): + pattern = re.compile(query.string, re.IGNORECASE) + return Item( + id="trash-open", + icon=iconPath, + text=pattern.sub(lambda m: "%s" % m.group(0), "Trash"), + subtext="Show trash folder", + completion="trash", + actions=[UrlAction("Show", "trash:///")] + ) diff --git a/plugins/python/share/modules/units.py b/plugins/python/share/modules/units.py new file mode 100644 index 0000000..a4c3627 --- /dev/null +++ b/plugins/python/share/modules/units.py @@ -0,0 +1,66 @@ +# -*- coding: utf-8 -*- + +"""This extension is a wrapper for the (extremely) powerful GNU units tool. \ +Note that spaces are separators. + +Synopsis: units +Synopsis: to + +Examples: + +mach to km/hr +0.7day to hour;min +barrel to decimeter^3;inch^3 +""" + +import re +import subprocess as sp +from shutil import which + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "GNU Units" +__version__ = "1.1" +__trigger__ = "units " +__author__ = "Manuel Schneider" +__dependencies__ = ["units"] + +if which("units") is None: + raise Exception("'units' is not in $PATH.") + +icon = iconLookup('calc') +if not icon: + icon = ":python_module" + +regex = re.compile(r"(\S+)(?:\s+to)\s+(\S+)") + +def handleQuery(query): + + if query.isTriggered: + args = query.string.split() + item = Item(id='python.gnu_units', icon=icon, completion=query.rawString) + if args: + try: + item.text = sp.check_output(['units', '-t'] + query.string.split(), stderr=sp.STDOUT).decode().strip() + item.addAction(ClipAction("Copy to clipboard", item.text)) + except sp.CalledProcessError as e: + item.text = e.stdout.decode().strip().partition('\n')[0] + item.subtext = "Result of 'units -t %s'" % query.string + else: + item.text = "Empty input" + item.subtext = "Enter something to convert" + return item + + else: + match = regex.fullmatch(query.string.strip()) + if match: + args = match.group(1, 2) + try: + item = Item(id='python.gnu_units', icon=icon, completion=query.rawString) + item.text = sp.check_output(['units', '-t'] + list(args)).decode().strip() + item.subtext = "Result of 'units -t %s %s'" % args + item.addAction(ClipAction("Copy to clipboard", item.text)) + return item + except sp.CalledProcessError as e: + pass diff --git a/plugins/python/share/modules/virtualbox.py b/plugins/python/share/modules/virtualbox.py new file mode 100644 index 0000000..6d4b412 --- /dev/null +++ b/plugins/python/share/modules/virtualbox.py @@ -0,0 +1,116 @@ +# -*- coding: utf-8 -*- + +"""VirtualBox extension. + +Manage your virtual machines.""" + +from virtualbox import Session, VirtualBox +from virtualbox.library import (LockType, MachineState, OleErrorInvalidarg, + OleErrorUnexpected, VBoxErrorFileError, + VBoxErrorHostError, + VBoxErrorInvalidObjectState, + VBoxErrorInvalidVmState, VBoxErrorIprtError, + VBoxErrorObjectNotFound) + +from albertv0 import FuncAction, Item, critical, iconLookup + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Virtual Box" +__version__ = "1.1" +__trigger__ = "vbox " +__author__ = "Manuel Schneider" +__dependencies__ = ['pyvbox'] + +vbox = None + +for iconName in ["virtualbox", "unknown"]: + iconPath = iconLookup(iconName) + if iconPath: + break + +def initialize(): + global vbox + vbox = VirtualBox() + +def finalize(): + pass + +def startVm(vm): + try: + with Session() as session: + vm.launch_vm_process(session, 'gui', '') + except OleErrorUnexpected as e: + print("OleErrorUnexpected") + except OleErrorInvalidarg as e: + print("OleErrorInvalidarg") + except VBoxErrorObjectNotFound as e: + print("VBoxErrorObjectNotFound") + except VBoxErrorInvalidObjectState as e: + print("VBoxErrorInvalidObjectState") + except VBoxErrorInvalidVmState as e: + print("VBoxErrorInvalidVmState") + except VBoxErrorIprtError as e: + print("VBoxErrorIprtError") + except VBoxErrorHostError as e: + print("VBoxErrorHostError") + except VBoxErrorFileError as e: + print("VBoxErrorFileError") + +def acpiPowerVm(vm): + with vm.create_session(LockType.shared) as session: + session.console.power_button() + +def stopVm(vm): + with vm.create_session(LockType.shared) as session: + session.console.power_down() + +def saveVm(vm): + with vm.create_session(LockType.shared) as session: + session.machine.save_state() + +def discardSavedVm(vm): + with vm.create_session(LockType.shared) as session: + session.machine.discard_save_state(True); + +def resumeVm(vm): + with vm.create_session(LockType.shared) as session: + session.console.resume() + +def pauseVm(vm): + with vm.create_session(LockType.shared) as session: + session.console.pause() + +def buildVmItem(vm): + item = Item( + id=vm.__uuid__, + icon=iconPath, + text=vm.name, + subtext="{vm.state}".format(vm=vm), + completion=vm.name + ) + + if vm.state == MachineState.powered_off: #1 + item.addAction(FuncAction(text="Start virtual machine", callable=lambda: startVm(vm))) + if vm.state == MachineState.saved: #2 + item.addAction(FuncAction(text="Restore virtual machine", callable=lambda: startVm(vm))) + item.addAction(FuncAction(text="Discard saved state", callable=lambda: discardSavedVm(vm))) + if vm.state == MachineState.aborted: #4 + item.addAction(FuncAction(text="Start virtual machine", callable=lambda: startVm(vm))) + if vm.state == MachineState.running: #5 + item.addAction(FuncAction(text="Save virtual machine", callable=lambda: saveVm(vm))) + item.addAction(FuncAction(text="Power off via ACPI event (Power button)", callable=lambda: acpiPowerVm(vm))) + item.addAction(FuncAction(text="Turn off virtual machine", callable=lambda: stopVm(vm))) + item.addAction(FuncAction(text="Pause virtual machine", callable=lambda: pauseVm(vm))) + if vm.state == MachineState.paused: #6 + item.addAction(FuncAction(text="Resume virtual machine", callable=lambda: resumeVm(vm))) + + return item + + +def handleQuery(query): + pattern = query.string.strip().lower() + results = [] + for vm in vbox.machines: + if (pattern and pattern in vm.name.lower() or not pattern and query.isTriggered): + results.append(buildVmItem(vm)) + return results diff --git a/plugins/python/share/modules/wikipedia/__init__.py b/plugins/python/share/modules/wikipedia/__init__.py new file mode 100644 index 0000000..06b19f5 --- /dev/null +++ b/plugins/python/share/modules/wikipedia/__init__.py @@ -0,0 +1,94 @@ +# -*- coding: utf-8 -*- + +"""Search Wikipedia articles.""" + +from albertv0 import * +from locale import getdefaultlocale +from urllib import request, parse +import json +import time +import os + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Wikipedia" +__version__ = "1.3" +__trigger__ = "wiki " +__author__ = "Manuel Schneider" +__dependencies__ = [] + +iconPath = iconLookup('wikipedia') +if not iconPath: + iconPath = os.path.dirname(__file__)+"/wikipedia.svg" +baseurl = 'https://en.wikipedia.org/w/api.php' +user_agent = "org.albert.extension.python.wikipedia" +limit = 20 + + +def initialize(): + global baseurl + params = { + 'action': 'query', + 'meta': 'siteinfo', + 'utf8': 1, + 'siprop': 'languages', + 'format': 'json' + } + + get_url = "%s?%s" % (baseurl, parse.urlencode(params)) + req = request.Request(get_url, headers={'User-Agent': user_agent}) + with request.urlopen(req) as response: + data = json.loads(response.read().decode('utf-8')) + languages = [lang['code'] for lang in data['query']['languages']] + local_lang_code = getdefaultlocale()[0][0:2] + if local_lang_code in languages: + baseurl = baseurl.replace("en", local_lang_code) + + +def handleQuery(query): + if query.isTriggered: + + # avoid rate limiting + time.sleep(0.1) + if not query.isValid: + return + + stripped = query.string.strip() + + if stripped: + results = [] + + params = { + 'action': 'opensearch', + 'search': stripped, + 'limit': limit, + 'utf8': 1, + 'format': 'json' + } + get_url = "%s?%s" % (baseurl, parse.urlencode(params)) + req = request.Request(get_url, headers={'User-Agent': user_agent}) + + with request.urlopen(req) as response: + data = json.loads(response.read().decode('utf-8')) + + for i in range(0, min(limit, len(data[1]))): + title = data[1][i] + summary = data[2][i] + url = data[3][i] + + results.append(Item(id=__prettyname__, + icon=iconPath, + text=title, + subtext=summary if summary else url, + completion=title, + actions=[ + UrlAction("Open article on Wikipedia", url), + ClipAction("Copy URL", url) + ])) + + return results + else: + return Item(id=__prettyname__, + icon=iconPath, + text=__prettyname__, + subtext="Enter a query to search on Wikipedia", + completion=query.rawString) diff --git a/plugins/python/share/modules/wikipedia/wikipedia.svg b/plugins/python/share/modules/wikipedia/wikipedia.svg new file mode 100644 index 0000000..f082c72 --- /dev/null +++ b/plugins/python/share/modules/wikipedia/wikipedia.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/python/share/modules/window_switcher.py b/plugins/python/share/modules/window_switcher.py new file mode 100644 index 0000000..06533a8 --- /dev/null +++ b/plugins/python/share/modules/window_switcher.py @@ -0,0 +1,41 @@ +# -*- coding: utf-8 -*- + +""" +X11 window switcher - list and activate windows. +""" + +import subprocess +from collections import namedtuple +from shutil import which + +from albertv0 import * + +Window = namedtuple("Window", ["wid", "desktop", "wm_class", "host", "wm_name"]) + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Window Switcher" +__version__ = "1.4" +__author__ = "Ed Perez, Manuel Schneider" +__dependencies__ = ["wmctrl"] + +if which("wmctrl") is None: + raise Exception("'wmctrl' is not in $PATH.") + +def handleQuery(query): + stripped = query.string.strip().lower() + if stripped: + results = [] + for line in subprocess.check_output(['wmctrl', '-l', '-x']).splitlines(): + win = Window(*[token.decode() for token in line.split(None,4)]) + if win.desktop != "-1" and stripped in win.wm_class.split('.')[0].lower(): + results.append(Item(id="%s%s" % (__prettyname__, win.wm_class), + icon=iconLookup(win.wm_class.split('.')[0]), + text="%s - Desktop %s" % (win.wm_class.split('.')[-1].replace('-',' '), win.desktop), + subtext=win.wm_name, + actions=[ProcAction("Switch Window", + ["wmctrl", '-i', '-a', win.wid] ), + ProcAction("Move window to this desktop", + ["wmctrl", '-i', '-R', win.wid] ), + ProcAction("Close the window gracefully.", + ["wmctrl", '-c', win.wid])])) + return results diff --git a/plugins/python/share/modules/youtube.py b/plugins/python/share/modules/youtube.py new file mode 100644 index 0000000..c77d803 --- /dev/null +++ b/plugins/python/share/modules/youtube.py @@ -0,0 +1,83 @@ +# -*- coding: utf-8 -*- + +"""Query and open YouTube videos and channels.""" + +import json +import re +import time +from os import path +from urllib.parse import urlencode +from urllib.request import Request, urlopen + +from albertv0 import * + +__iid__ = 'PythonInterface/v0.1' +__prettyname__ = 'Youtube' +__version__ = '1.0' +__trigger__ = 'yt ' +__author__ = 'Manuel Schneider' +__dependencies__ = [] +__icon__ = iconLookup('youtube') # path.dirname(__file__) + '/icons/YouTube.png' + +HEADERS = { + 'User-Agent': ( + 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko)' + ' Chrome/62.0.3202.62 Safari/537.36' + ) +} + +re_videos = re.compile(r"^\s*window\[\"ytInitialData\"\] = (.*);$", re.MULTILINE) + +def handleQuery(query): + if query.isTriggered and query.string.strip(): + + # avoid rate limiting + time.sleep(0.2) + if not query.isValid: + return + + url_values = urlencode({'search_query': query.string.strip()}) + url = 'https://www.youtube.com/results?%s' % url_values + req = Request(url=url, headers=HEADERS) + with urlopen(req) as response: + match = re.search(re_videos, response.read().decode()) + if match: + results = json.loads(match.group(1)) + results = results['contents']['twoColumnSearchResultsRenderer']['primaryContents']['sectionListRenderer']['contents'][0]['itemSectionRenderer']['contents'] + items = [] + for result in results: + for type, data in result.items(): + try: + if type == 'videoRenderer': + id = data['videoId'] + subtext = 'Video' + if 'lengthText' in data: + subtext = subtext + " | %s" % data['lengthText']['simpleText'].strip() + if 'shortViewCountText' in data: + subtext = subtext + " | %s" % data['shortViewCountText']['simpleText'].strip() + if 'publishedTimeText' in data: + subtext = subtext + " | %s" % data['publishedTimeText']['simpleText'].strip() + actions=[ UrlAction('Watch on Youtube', 'https://youtube.com/watch?v=%s' % id) ] + elif type == 'channelRenderer': + id = data['channelId'] + subtext = 'Channel' + if 'videoCountText' in data: + subtext = subtext + " | %s" % data['videoCountText']['simpleText'].strip() + if 'subscriberCountText' in data: + subtext = subtext + " | %s" % data['subscriberCountText']['simpleText'].strip() + actions=[ UrlAction('Show on Youtube', 'https://www.youtube.com/channel/%s' % id) ] + else: + continue + except Exception as e: + critical(e) + critical(json.dumps(result, indent=4)) + + item = Item(id=__prettyname__, + icon=data['thumbnail']['thumbnails'][0]['url'].split('?', 1)[0] if data['thumbnail']['thumbnails'] else __icon__, + text=data['title']['simpleText'], + subtext=subtext, + completion=query.rawString, + actions=actions + ) + items.append(item) + return items diff --git a/plugins/python/share/modules/zeal.py b/plugins/python/share/modules/zeal.py new file mode 100644 index 0000000..b9a21fd --- /dev/null +++ b/plugins/python/share/modules/zeal.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- + +"""Fire up an external search in Zeal. Just type zl """ + +from shutil import which +from subprocess import run + +from albertv0 import * + +__iid__ = "PythonInterface/v0.1" +__prettyname__ = "Zeal" +__version__ = "1.0" +__trigger__ = "zl " +__author__ = "Manuel Schneider" +__dependencies__ = ["zeal"] + +if which("zeal") is None: + raise Exception("'zeal' is not in $PATH.") + +iconPath = iconLookup('zeal') + + +def handleQuery(query): + if query.isTriggered: + return Item( + id=__prettyname__, + icon=iconPath, + text=__prettyname__, + subtext="Look up %s" % __prettyname__, + completion=query.rawString, + actions=[ProcAction("Start query in %s" % __prettyname__, + ["zeal", query.string])] + ) diff --git a/plugins/python/src/cast_specialization.h b/plugins/python/src/cast_specialization.h new file mode 100644 index 0000000..ac2ea83 --- /dev/null +++ b/plugins/python/src/cast_specialization.h @@ -0,0 +1,42 @@ +// Copyright (c) 2017-2018 Manuel Schneider + +#pragma once +#include +#include +namespace py = pybind11; + +// Python string <-> QString conversion +namespace pybind11 { +namespace detail { + + template <> struct type_caster { + PYBIND11_TYPE_CASTER(QString, _("QString")); + private: + using str_caster_t = make_caster; + str_caster_t str_caster; + public: + bool load(handle src, bool convert) { + if (str_caster.load(src, convert)) { value = QString::fromStdString(str_caster); return true; } + return false; + } + static handle cast(const QString &s, return_value_policy policy, handle parent) { + return str_caster_t::cast(s.toStdString(), policy, parent); + } + }; + + + + //template <> struct type_caster { + //public: + // PYBIND11_TYPE_CASTER(QString, _("str")); + // bool load(handle src, bool) { + // PyObject *source = src.ptr(); + // if (!PyUnicode_Check(source)) return false; + // value = PyUnicode_AsUTF8(source); + // return true; + // } + // static handle cast(QString src, return_value_policy /* policy */, handle /* parent */) { + // return PyUnicode_FromString(src.toUtf8().constData()); + // } + //}; +}} diff --git a/plugins/python/src/configwidget.cpp b/plugins/python/src/configwidget.cpp new file mode 100644 index 0000000..17d7498 --- /dev/null +++ b/plugins/python/src/configwidget.cpp @@ -0,0 +1,18 @@ +// Copyright (c) 2017-2018 Manuel Schneider + +#include "configwidget.h" + +/** ***************************************************************************/ +Python::ConfigWidget::ConfigWidget(QWidget *parent) : QWidget(parent) { + ui.setupUi(this); + ui.tableView->verticalHeader()->setSectionResizeMode(QHeaderView::ResizeToContents); + ui.tableView->horizontalHeader()->setSectionResizeMode(QHeaderView::ResizeToContents); + ui.tableView->horizontalHeader()->setStretchLastSection(true); +} + + + +/** ***************************************************************************/ +Python::ConfigWidget::~ConfigWidget() { + +} diff --git a/plugins/python/src/configwidget.h b/plugins/python/src/configwidget.h new file mode 100644 index 0000000..df6eed5 --- /dev/null +++ b/plugins/python/src/configwidget.h @@ -0,0 +1,17 @@ +// Copyright (c) 2017-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" + +namespace Python { + +class ConfigWidget final : public QWidget +{ + Q_OBJECT +public: + explicit ConfigWidget(QWidget *parent = nullptr); + ~ConfigWidget(); + Ui::ConfigWidget ui; +}; +} diff --git a/plugins/python/src/configwidget.ui b/plugins/python/src/configwidget.ui new file mode 100644 index 0000000..d79d8a2 --- /dev/null +++ b/plugins/python/src/configwidget.ui @@ -0,0 +1,59 @@ + + + Python::ConfigWidget + + + + 0 + 0 + 631 + 521 + + + + + + + <html><head/><body><p><span style=" color:#808080;">Embedded python provides a convenient way to write custom extensions. The list below contains the python extensions found on your system.</span></p></body></html> + + + true + + + + + + + QAbstractScrollArea::AdjustToContents + + + true + + + QAbstractItemView::SingleSelection + + + QAbstractItemView::SelectRows + + + Qt::ElideLeft + + + false + + + false + + + false + + + false + + + + + + + + diff --git a/plugins/python/src/extension.cpp b/plugins/python/src/extension.cpp new file mode 100644 index 0000000..2669302 --- /dev/null +++ b/plugins/python/src/extension.cpp @@ -0,0 +1,355 @@ +// Copyright (c) 2017-2018 Manuel Schneider + +#include +#include +#include "pythonmodulev1.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "xdg/iconlookup.h" +#include "albert/query.h" +#include "albert/item.h" +#include "albert/action.h" +#include "albert/util/standardactions.h" +#include "albert/util/standarditem.h" +#include "extension.h" +#include "modulesmodel.h" +#include "configwidget.h" +#include "cast_specialization.h" +using namespace std; +using namespace Core; +namespace py = pybind11; + +Q_LOGGING_CATEGORY(qlc_python, "python") +#define DEBUG qCDebug(qlc_python).noquote() +#define INFO qCInfo(qlc_python).noquote() +#define WARNING qCWarning(qlc_python).noquote() +#define CRITICAL qCCritical(qlc_python).noquote() + +namespace Python { + +const constexpr char* MODULES_DIR = "modules"; +const constexpr char* CFG_ENABLEDMODS = "enabled_modules"; + +/* + * Module definition + */ + +#include + +PYBIND11_EMBEDDED_MODULE(albertv0, m) +{ + /* + * 0.1 + */ + + m.doc() = "pybind11 example module"; + + py::class_>(m, "Query", "The query object to handle for a user input") + .def_property_readonly("string", &Query::string) + .def_property_readonly("rawString", &Query::rawString) + .def_property_readonly("trigger", &Query::trigger) + .def_property_readonly("isTriggered", &Query::isTriggered) + .def_property_readonly("isValid", &Query::isValid) + ; + + py::class_>(m, "ActionBase", "An abstract action") + ; + + py::class_> iitem(m, "ItemBase", "An abstract item") + ; + + /* This is a bit more evolved. In this case a piece of python code is injected into C++ code and + * has to be handled with care. The GIL has to be locked whenever the code is touched, i.e. on + * execution and deletion. Further exceptions thrown from python have to be catched. */ + py::class_>(m, "FuncAction", "Executes the callable") + .def(py::init([](QString text, const py::object& callable) { + return shared_ptr( + new FuncAction(move(text), [callable](){ + py::gil_scoped_acquire acquire; + try{ + callable(); + } catch (exception &e) { + WARNING << e.what(); + } + }), + [=](FuncAction *funcAction) { + py::gil_scoped_acquire acquire; + delete funcAction; + } + ); + }), py::arg("text"), py::arg("callable")) + ; + + py::class_>(m, "ClipAction", "Copies to clipboard") + .def(py::init(), py::arg("text"), py::arg("clipboardText")) + ; + + py::class_>(m, "UrlAction", "Opens a URL") + .def(py::init(), py::arg("text"), py::arg("url")) + ; + + py::class_>(m, "ProcAction", "Runs a process") + .def(py::init([](QString text, list commandline, QString workdir) { + return std::make_shared(move(text), QStringList::fromStdList(commandline), move(workdir)); + }), py::arg("text"), py::arg("commandline"), py::arg("cwd") = QString()) + ; + + py::class_>pyTermAction(m, "TermAction", "Runs a command in terminal"); + + py::enum_(pyTermAction, "CloseBehavior") + .value("CloseOnSuccess", TermAction::CloseBehavior::CloseOnSuccess) + .value("CloseOnExit", TermAction::CloseBehavior::CloseOnExit) + .value("DoNotClose", TermAction::CloseBehavior::DoNotClose) + .export_values() + ; + + pyTermAction.def(py::init([](QString text, list commandline, QString workdir, bool shell, TermAction::CloseBehavior behavior) { + return std::make_shared(move(text), QStringList::fromStdList(commandline), move(workdir), shell, behavior); + }), py::arg("text"), py::arg("commandline"), py::arg("cwd") = QString(), py::arg("shell") = true, py::arg("behavior") = TermAction::CloseBehavior::CloseOnSuccess) + ; + + py::enum_(iitem, "Urgency") + .value("Alert", Item::Urgency::Alert) + .value("Notification", Item::Urgency::Notification) + .value("Normal", Item::Urgency::Normal) + .export_values() + ; + + py::class_>(m, "Item", "A result item") + .def(py::init>>(), + py::arg("id") = QString(), + py::arg("icon") = QString(":python_module"), + py::arg("text") = QString(), + py::arg("subtext") = QString(), + py::arg("completion") = QString(), + py::arg("urgency") = Item::Urgency::Normal, + py::arg("actions") = vector>()) + .def_property("id", &StandardItem::id, &StandardItem::setId) + .def_property("icon", &StandardItem::iconPath, &StandardItem::setIconPath) + .def_property("text", &StandardItem::text, &StandardItem::setText) + .def_property("subtext", &StandardItem::subtext, &StandardItem::setSubtext) + .def_property("completion", &StandardItem::completion, &StandardItem::setCompletion) + .def_property("urgency", &StandardItem::urgency, &StandardItem::setUrgency) + .def("addAction", static_cast &)>(&StandardItem::addAction)) + ; + + m.def("debug", [](const py::object &obj){ DEBUG << py::str(obj).cast(); }); + m.def("info", [](const py::object &obj){ INFO << py::str(obj).cast(); }); + m.def("warning", [](const py::object &obj){ WARNING << py::str(obj).cast(); }); + m.def("critical", [](const py::object &obj){ CRITICAL << py::str(obj).cast(); }); + + m.def("iconLookup", [](const py::str &str){ return XDG::IconLookup::iconPath(str.cast()); }); + + /* + * 0.2 + */ + + m.def("configLocation", [](){ return QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation); }); + m.def("dataLocation", [](){ return QStandardPaths::writableLocation(QStandardPaths::AppDataLocation); }); + m.def("cacheLocation", [](){ return QStandardPaths::writableLocation(QStandardPaths::CacheLocation); }); + + +} + +} + +class Python::Private +{ +public: + unique_ptr release; + QPointer widget; + vector> modules; + QFileSystemWatcher extensionDirectoryWatcher; + QFileSystemWatcher sourcesWatcher; + QStringList enabledModules; +}; + + +/** ***************************************************************************/ +Python::Extension::Extension() + : Core::Extension("org.albert.extension.python"), // Must match the id in metadata + Core::QueryHandler(Core::Plugin::id()), + d(new Private) { + + /* + * The python interpreter is never unloaded once it has been loaded. This is working around the + * ugly segfault that occur when third-party libraries have been loaded an the interpreter is + * finalized and initialized. + */ + if ( !Py_IsInitialized() ) + py::initialize_interpreter(false); + d->release.reset(new py::gil_scoped_release); + + d->enabledModules = settings().value(CFG_ENABLEDMODS).toStringList(); + + if ( !dataLocation().exists(MODULES_DIR) ) + dataLocation().mkdir(MODULES_DIR); + + // Watch the modules directories for changes + for (const QString &dataDir : QStandardPaths::locateAll(QStandardPaths::DataLocation, + Core::Plugin::id(), + QStandardPaths::LocateDirectory) ) { + QDir dir{dataDir}; + if (dir.cd(MODULES_DIR)) + d->extensionDirectoryWatcher.addPath(dir.path()); + } + + connect(&d->extensionDirectoryWatcher, &QFileSystemWatcher::directoryChanged, + this, &Extension::reloadModules); + + connect(&d->sourcesWatcher, &QFileSystemWatcher::fileChanged, + this, &Extension::reloadModules); + + reloadModules(); + + registerQueryHandler(this); +} + + + +/** ***************************************************************************/ +Python::Extension::~Extension() { + d->modules.clear(); +} + + + +/** ***************************************************************************/ +QWidget *Python::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) { + d->widget = new ConfigWidget(parent); + + ModulesModel *model = new ModulesModel(this, d->widget->ui.tableView); + d->widget->ui.tableView->setModel(model); + + connect(d->widget->ui.tableView, &QTableView::activated, + this, [this](const QModelIndex &index){ + QDesktopServices::openUrl(QUrl(d->modules[static_cast(index.row())]->path())); + }); + } + return d->widget; +} + + +/** ***************************************************************************/ +void Python::Extension::handleQuery(Core::Query *query) const { + if ( query->isTriggered() ) { + for ( auto & module : d->modules ) { + if ( d->enabledModules.contains(module->id()) + && module->state() == PythonModuleV1::State::Loaded + && module->trigger() == query->trigger() ) { + module->handleQuery(query); + return; + } + } + } + else { + for ( auto & module : d->modules ) { + if ( d->enabledModules.contains(module->id()) + && module->state() == PythonModuleV1::State::Loaded) { + module->handleQuery(query); + if ( !query->isValid() ) + return; + } + } + } +} + + +/** ***************************************************************************/ +QStringList Python::Extension::triggers() const { + QStringList retval; + for ( auto &module : d->modules ) + retval << module->trigger(); + return retval; +} + + +/** ***************************************************************************/ +const std::vector > &Python::Extension::modules() { + return d->modules; +} + + +/** ***************************************************************************/ +bool Python::Extension::isEnabled(Python::PythonModuleV1 &module) { + return d->enabledModules.contains(module.id()); +} + + +/** ***************************************************************************/ +void Python::Extension::setEnabled(Python::PythonModuleV1 &module, bool enable) { + if (enable) + d->enabledModules.append(module.id()); + else + d->enabledModules.removeAll(module.id()); + settings().setValue(CFG_ENABLEDMODS, d->enabledModules); + enable ? module.load() : module.unload(); +} + + +/** ***************************************************************************/ +void Python::Extension::reloadModules() { + + // Reset + + d->modules.clear(); + d->sourcesWatcher.removePaths(d->sourcesWatcher.files()); + + // Get all module source paths + + QStringList paths; + for (const QString &dataDir : QStandardPaths::locateAll(QStandardPaths::DataLocation, + Core::Plugin::id(), + QStandardPaths::LocateDirectory) ) { + QDir dir{dataDir}; + if (dir.cd(MODULES_DIR)) { + for(const QFileInfo &fileInfo : dir.entryInfoList(QDir::Dirs|QDir::NoDotAndDotDot)) { + QDir dir{fileInfo.filePath()}; + if (dir.exists("__init__.py")) + paths.append(dir.absolutePath()); + } + for(const QFileInfo &fileInfo : dir.entryInfoList({"*.py"}, QDir::Files)) + paths.append(fileInfo.absoluteFilePath()); + } + } + + // Read metada, ignore dup ids, load id enabled, source file watcher + + for(const QString &path : paths){ + try { + auto module = make_unique(path); + + // Skip if this id already exists + if ( find_if(d->modules.begin(), d->modules.end(), + [&module](const unique_ptr &rhs){return module->id() == rhs->id();}) + != d->modules.end() ) + continue; + + if (d->enabledModules.contains(module->id())) + module->load(); + + d->sourcesWatcher.addPath(module->sourcePath()); + d->modules.emplace_back(move(module)); + + } catch (const std::exception &e) { + WARNING << e.what() << path; + } + } + + std::sort(d->modules.begin(), d->modules.end(), + [](auto& lhs, auto& rhs){ return 0 > lhs->name().localeAwareCompare(rhs->name()); }); + + emit modulesChanged(); + +} + + diff --git a/plugins/python/src/extension.h b/plugins/python/src/extension.h new file mode 100644 index 0000000..3eff98f --- /dev/null +++ b/plugins/python/src/extension.h @@ -0,0 +1,49 @@ +// Copyright (c) 2017-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +Q_DECLARE_LOGGING_CATEGORY(qlc_python) + +namespace Python { + +class Private; +class PythonModuleV1; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension() override; + + QString name() const override { return "Python extensions"; } + QWidget *widget(QWidget *parent = nullptr) override; + void handleQuery(Core::Query * query) const override; + QStringList triggers() const override; + + const std::vector> &modules(); + + bool isEnabled(PythonModuleV1 &module); + void setEnabled(PythonModuleV1 &module, bool enabled); + +private: + + std::unique_ptr d; + + void reloadModules(); + +signals: + + void modulesChanged(); +}; +} diff --git a/plugins/python/src/modulesmodel.cpp b/plugins/python/src/modulesmodel.cpp new file mode 100644 index 0000000..c7ab484 --- /dev/null +++ b/plugins/python/src/modulesmodel.cpp @@ -0,0 +1,179 @@ +// Copyright (c) 2017-2018 Manuel Schneider + +#include "pythonmodulev1.h" +#include +#include +#include +#include +#include "modulesmodel.h" +#include "extension.h" + + +namespace { +enum class Section{Name, Trigger, Version, Author, Count}; +} + + +/** ***************************************************************************/ +Python::ModulesModel::ModulesModel(Extension *extension, QObject *parent) + : QAbstractTableModel(parent), extension(extension) { + + connect(extension, &Extension::modulesChanged, + this, &ModulesModel::endResetModel); + +} + + +/** ***************************************************************************/ +int Python::ModulesModel::rowCount(const QModelIndex &) const { + return static_cast(extension->modules().size()); +} + + + +/** ***************************************************************************/ +int Python::ModulesModel::columnCount(const QModelIndex &) const { + return static_cast(Section::Count); +} + + + +/** ***************************************************************************/ +QVariant Python::ModulesModel::headerData(int section, Qt::Orientation orientation, int role) const { + // No sanity check necessary since + if ( section<0 || static_cast(Section::Count)<=section ) + return QVariant(); + + + if (orientation == Qt::Horizontal){ + switch (static_cast
    (section)) { + case Section::Name:{ + switch (role) { + case Qt::DisplayRole: return "Name"; + case Qt::ToolTipRole: return "The name of the module."; + default: return QVariant(); + } + } + case Section::Trigger:{ + switch (role) { + case Qt::DisplayRole: return "Trigger"; + case Qt::ToolTipRole: return "The term that triggers this extension."; + default: return QVariant(); + } + } + case Section::Version:{ + switch (role) { + case Qt::DisplayRole: return "Version"; + case Qt::ToolTipRole: return "The version of this extension."; + default: return QVariant(); + } + } + case Section::Author:{ + switch (role) { + case Qt::DisplayRole: return "Author"; + case Qt::ToolTipRole: return "The author of this extension."; + default: return QVariant(); + } + } + default: return QVariant(); + } + } + return QVariant(); +} + + + +/** ***************************************************************************/ +QVariant Python::ModulesModel::data(const QModelIndex &index, int role) const { + if (!index.isValid() + || index.row() >= static_cast(extension->modules().size()) + || index.column() >= static_cast(static_cast(Section::Count))) + return QVariant(); + + switch (role) { + case Qt::DecorationRole: { + if ( static_cast
    (index.column()) == Section::Name ) { + switch (extension->modules()[static_cast(index.row())]->state()) { + case PythonModuleV1::State::Unloaded: + return QIcon(":plugin_notloaded"); + case PythonModuleV1::State::Loaded: + return QIcon(":plugin_loaded"); + case PythonModuleV1::State::InvalidMetadata: + case PythonModuleV1::State::Error: + return QIcon(":plugin_error"); + } + } + return QVariant(); + } + case Qt::DisplayRole: { + const PythonModuleV1 *module = extension->modules()[static_cast(index.row())].get(); + switch (static_cast
    (index.column())) { + case Section::Name: return module->name(); + case Section::Trigger: return module->trigger(); + case Section::Version: return module->version(); + case Section::Author: return module->author(); + default: return QVariant(); + } + } + case Qt::ToolTipRole: { + QString toolTip; + const PythonModuleV1 *module = extension->modules()[static_cast(index.row())].get(); + + toolTip = QString("

    Name: %1

    ").arg(module->name().toHtmlEscaped()); + + if (!module->dependencies().empty()) + toolTip.append(QString("

    Dependencies: %1

    ").arg(module->dependencies().join(", ").toHtmlEscaped())); + + if (!module->description().isEmpty()) + toolTip.append(QString("

    Description: %1

    ").arg(QString(module->description().toHtmlEscaped()).replace("\n","
    "))); + +// if (!module->version().isEmpty()) +// toolTip.append(QString("\nVersion: %1").arg(module->version())); + +// if (!module->author().isEmpty()) +// toolTip.append(QString("\nAuthor: %1").arg(module->author())); + + toolTip.append(QString("

    Path:%1

    ").arg(module->path().toHtmlEscaped())); + + if ((module->state() == PythonModuleV1::State::Error || module->state() == PythonModuleV1::State::InvalidMetadata) + && !module->errorString().isEmpty()) + toolTip.append(QString("

    ERROR:%1

    ").arg(QString(module->errorString().toHtmlEscaped()).replace("\n","
    "))); + + return QString("%1").arg(toolTip); + } + case Qt::CheckStateRole: + if ( static_cast
    (index.column()) == Section::Name ) + return (extension->isEnabled(*extension->modules()[static_cast(index.row())].get())) + ? Qt::Checked : Qt::Unchecked; + } + return QVariant(); +} + + +/** ***************************************************************************/ +bool Python::ModulesModel::setData(const QModelIndex &index, const QVariant &value, int role) { + if (!index.isValid() || index.row() < 0 || rowCount() <= index.row()) + return false; + + switch (role) { + case Qt::CheckStateRole: + if ( static_cast
    (index.column()) == Section::Name ) { + extension->setEnabled(*extension->modules()[static_cast(index.row())].get(), + value == Qt::Checked); + dataChanged(this->index(index.row(),0), + this->index(index.row(),static_cast(Section::Count))); + return true; + } + } + return false; +} + + +/** ***************************************************************************/ +Qt::ItemFlags Python::ModulesModel::flags(const QModelIndex &index) const { + if (!index.isValid() || index.row() >= static_cast(extension->modules().size()) ) + return Qt::NoItemFlags; + + return Qt::ItemIsEnabled | Qt::ItemIsUserCheckable | Qt::ItemNeverHasChildren; +} + diff --git a/plugins/python/src/modulesmodel.h b/plugins/python/src/modulesmodel.h new file mode 100644 index 0000000..27a155e --- /dev/null +++ b/plugins/python/src/modulesmodel.h @@ -0,0 +1,32 @@ +// Copyright (c) 2017-2018 Manuel Schneider + +#pragma once +#include +#include +#include + +namespace Python { + +class Extension; + +class ModulesModel : public QAbstractTableModel +{ + Q_OBJECT + +public: + + ModulesModel(Extension *extension, QObject *parent = nullptr); + + int rowCount(const QModelIndex & parent = QModelIndex()) const override; + int columnCount(const QModelIndex & parent = QModelIndex()) const override; + QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override; + QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const override; + bool setData(const QModelIndex &index, const QVariant &value, int role) override; + Qt::ItemFlags flags(const QModelIndex & index) const override; + +private: + + Extension *extension; +}; + +} diff --git a/plugins/python/src/pythonmodulev1.cpp b/plugins/python/src/pythonmodulev1.cpp new file mode 100644 index 0000000..52ef632 --- /dev/null +++ b/plugins/python/src/pythonmodulev1.cpp @@ -0,0 +1,364 @@ +// Copyright (c) 2017-2018 Manuel Schneider + +#include +#include +#include "pythonmodulev1.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "cast_specialization.h" +#include "albert/query.h" +#include "albert/util/standarditem.h" +#include "xdg/iconlookup.h" +using namespace std; +using namespace Core; +namespace py = pybind11; + +Q_LOGGING_CATEGORY(qlc_python_modulev1, "python.modulev1") +#define DEBUG qCDebug(qlc_python_modulev1).noquote() +#define INFO qCInfo(qlc_python_modulev1).noquote() +#define WARNING qCWarning(qlc_python_modulev1).noquote() +#define CRITICAL qCCritical(qlc_python_modulev1).noquote() + + + +namespace { +uint majorInterfaceVersion = 0; +uint minorInterfaceVersion = 2; + +enum Target { IID, NAME, VERSION, TRIGGER, AUTHOR, DEPS}; +const QStringList targetNames = { + "__iid__", + "__prettyname__", + "__version__", + "__trigger__", + "__author__", + "__dependencies__" +}; +} + +class Python::PythonModuleV1Private +{ +public: + QString path; + QString sourceFilePath; + QString id; // id, __name__, Effectively the module name + + PythonModuleV1::State state; + QString errorString; + + py::module module; + + struct Spec { + QString iid; + QString prettyName; + QString author; + QString version; + QString trigger; + QString description; + QStringList dependencies; + + } spec; +}; + +/** ***************************************************************************/ +Python::PythonModuleV1::PythonModuleV1(const QString &path) : d(new PythonModuleV1Private) { + + d->path = path; + QFileInfo fileInfo{d->path}; + + if (!fileInfo.exists()) + throw std::runtime_error("Path does not exist"); + else if (fileInfo.isDir()){ + QDir dir{path}; + if (dir.exists("__init__.py")) + d->sourceFilePath = dir.filePath("__init__.py"); + else + throw std::runtime_error("Dir does not contain an init file"); + } + else if (fileInfo.isFile()) + d->sourceFilePath = fileInfo.absoluteFilePath(); + else + qFatal("This should never happen"); + + d->spec.prettyName = d->id = fileInfo.completeBaseName(); + d->state = State::InvalidMetadata; + + readMetadata(); +} + +void Python::PythonModuleV1::readMetadata() { + + DEBUG << "Reading metadata of python module:" << QFileInfo(d->path).fileName(); + + py::gil_scoped_acquire acquire; + + try { + + // Get the extension spec source code + + QFile file(d->sourceFilePath); + if(!file.open(QIODevice::ReadOnly)) + throw QString("Cant open init file: %1").arg(d->sourceFilePath); + QString source = QTextStream(&file).readAll(); + file.close(); + + // Parse it with ast + + py::module ast = py::module::import("ast"); + py::object ast_root = ast.attr("parse")(source.toStdString()); + + // Get all FunctionDef and Assign ast nodes + + std::map metadata_values; + for (auto node : ast_root.attr("body")){ + + if (py::isinstance(node, ast.attr("FunctionDef"))) + metadata_values.emplace(node.attr("name").cast(), node.attr("args").attr("args")); + + if (py::isinstance(node, ast.attr("Assign"))){ + py::list targets = node.attr("targets"); + if (py::len(targets) == 1 && py::isinstance(targets[0], ast.attr("Name"))){ + QString targetName = targets[0].attr("id").cast(); + if (targetNames.contains(targetName)) + metadata_values.emplace(targetName, node.attr("value")); + } + } + } + + // Check interface id + + QString targetName = targetNames[Target::IID]; + if (!metadata_values.count(targetName)) + throw QString("Module has no %1 specified").arg(targetName); + + py::object astStringType = py::module::import("ast").attr("Str"); + py::object obj = metadata_values[targetName]; + if (!py::isinstance(obj, astStringType)) + throw QString("%1 is not of type ast.Str").arg(targetName); + + d->spec.iid = obj.attr("s").cast().cast(); + + QRegularExpression re("^PythonInterface\\/v(\\d)\\.(\\d)$"); + QRegularExpressionMatch match = re.match(d->spec.iid); + if (!match.hasMatch()) + throw QString("Invalid interface id: %1").arg(d->spec.iid); + + uint maj = match.captured(1).toUInt(); + if (maj != majorInterfaceVersion) + throw QString("Incompatible major interface version. Expected %1, got %2").arg(majorInterfaceVersion).arg(maj); + + uint min = match.captured(2).toUInt(); + if (min > minorInterfaceVersion) + throw QString("Incompatible minor interface version. Up to %1 supported, got %2").arg(minorInterfaceVersion).arg(min); + + // Check mandatory handleQuery + + if (!metadata_values.count("handleQuery")) + throw QString("Modules does not contain a function definition for 'handleQuery'"); + + if (py::len(metadata_values.at("handleQuery")) != 1) + throw QString("handleQuery function definition does not take exactly one argument"); + + // Extract mandatory metadata + + obj = ast.attr("get_docstring")(ast_root); + if (py::isinstance(obj)) + d->spec.description = obj.cast().cast(); + else + throw QString("Module does not contain a docstring"); + + map zip{{Target::NAME, d->spec.prettyName}, + {Target::VERSION, d->spec.version}, + {Target::AUTHOR, d->spec.author}}; + for (const auto &pair : zip) { + targetName = targetNames[pair.first]; + if (metadata_values.count(targetName)){ + obj = metadata_values[targetName]; + if (py::isinstance(obj, astStringType)) + pair.second = obj.attr("s").cast().cast(); + else + throw QString("%1 is not of type ast.Str").arg(targetName); + } + else + throw QString("Module has no %1 specified").arg(targetName); + } + + // Extract optional metadata + + targetName = targetNames[Target::TRIGGER]; + if (metadata_values.count(targetName)){ + obj = metadata_values[targetName]; + if (py::isinstance(obj, astStringType)) + d->spec.trigger = obj.attr("s").cast().cast(); + else + throw QString("%1 is not of type ast.Str").arg(targetName); + } + + targetName = targetNames[Target::DEPS]; + if (metadata_values.count(targetName)) { + py::list deps = metadata_values[targetName].attr("elts").cast(); + for (const py::handle dep : deps) { + if (py::isinstance(dep, astStringType)) + d->spec.dependencies.append(dep.attr("s").cast().cast()); + else + throw QString("Dependencies contain non string values"); + } + } + + d->state = State::Unloaded; + } + catch(const QString &error) + { + d->errorString = error; + WARNING << QString("[%1] %2").arg(d->id).arg(d->errorString); + d->state = State::InvalidMetadata; + } + catch(const std::exception &e) + { + d->errorString = e.what(); + WARNING << QString("[%1] %2").arg(d->id).arg(d->errorString); + d->state = State::InvalidMetadata; + } +} + + +/** ***************************************************************************/ +Python::PythonModuleV1::~PythonModuleV1() { + unload(); +} + + +/** ***************************************************************************/ +void Python::PythonModuleV1::load(){ + + if (d->state == State::Loaded || d->state == State::InvalidMetadata) + return; + + py::gil_scoped_acquire acquire; + + try + { + DEBUG << "Loading" << d->path; + + py::module importlib = py::module::import("importlib"); + py::module importli_util = py::module::import("importlib.util"); + py::object spec = importli_util.attr("spec_from_file_location")(QString("albert.%1").arg(d->id), d->sourceFilePath); // Prefix to avoid conflicts + d->module = importli_util.attr("module_from_spec")(spec); + spec.attr("loader").attr("exec_module")(d->module); + + // Call init function, if exists + if (py::hasattr(d->module, "initialize")) + if (py::isinstance(d->module.attr("initialize"))) + d->module.attr("initialize")(); + } + catch(const std::exception &e) + { + d->errorString = e.what(); + WARNING << QString("[%1] %2.").arg(QFileInfo(d->path).fileName()).arg(d->errorString); + d->module = py::object(); + d->state = State::Error; + return; + } + + d->state = State::Loaded; +} + + +/** ***************************************************************************/ +void Python::PythonModuleV1::unload(){ + + if (d->state == State::Unloaded) + return; + + if (d->state == State::Loaded) { + + DEBUG << "Unloading" << d->path; + + py::gil_scoped_acquire acquire; + + try + { + // Call fini function, if exists + if (py::hasattr(d->module, "finalize")) + if (py::isinstance(d->module.attr("finalize"))) + d->module.attr("finalize")(); + + // Dereference module, unloads hopefully + d->module = py::object(); + } + catch(std::exception const &e) + { + WARNING << QString("[%1] %2.").arg(QFileInfo(d->path).fileName()).arg(e.what()); + } + } + + d->errorString.clear(); + d->state = State::Unloaded; +} + + +/** ***************************************************************************/ +void Python::PythonModuleV1::handleQuery(Query *query) const { + + py::gil_scoped_acquire acquire; + + try { + vector,uint>> results; + py::function f = py::function(d->module.attr("handleQuery")); + py::object pythonResult = f(query); + + if ( !query->isValid() ) + return; + + if (py::isinstance(pythonResult)) { + + py::list list(pythonResult); + for(py::size_t i = 0; i < py::len(pythonResult); ++i) { + py::object elem = list[i]; + results.emplace_back(elem.cast>(), 0); + } + + query->addMatches(std::make_move_iterator(results.begin()), + std::make_move_iterator(results.end())); + } + + if (py::isinstance(pythonResult)) { + query->addMatch(pythonResult.cast>()); + } + } + catch(const exception &e) + { + WARNING << QString("[%1] %2.").arg(d->id).arg(e.what()); + } +} + + +/** ***************************************************************************/ +Python::PythonModuleV1::State Python::PythonModuleV1::state() const { return d->state; } +const QString &Python::PythonModuleV1::errorString() const { return d->errorString; } +const QString &Python::PythonModuleV1::path() const { return d->path; } +const QString &Python::PythonModuleV1::sourcePath() const { return d->sourceFilePath; } +const QString &Python::PythonModuleV1::id() const { return d->id; } +const QString &Python::PythonModuleV1::name() const { return d->spec.prettyName; } +const QString &Python::PythonModuleV1::author() const { return d->spec.author; } +const QString &Python::PythonModuleV1::version() const { return d->spec.version; } +const QString &Python::PythonModuleV1::description() const { return d->spec.description; } +const QString &Python::PythonModuleV1::trigger() const { return d->spec.trigger; } +const QStringList &Python::PythonModuleV1::dependencies() const { return d->spec.dependencies; } + + + diff --git a/plugins/python/src/pythonmodulev1.h b/plugins/python/src/pythonmodulev1.h new file mode 100644 index 0000000..85b7dd2 --- /dev/null +++ b/plugins/python/src/pythonmodulev1.h @@ -0,0 +1,53 @@ +// Copyright (c) 2017-2018 Manuel Schneider + +#pragma once +#include +#include +#include + +Q_DECLARE_LOGGING_CATEGORY(qlc_python_modulev1) + +namespace Core { +class Query; +} + +namespace Python { + +class PythonModuleV1Private; + +class PythonModuleV1 final +{ + +public: + + enum class State { InvalidMetadata, Unloaded, Loaded, Error }; + + PythonModuleV1(const QString &path); + ~PythonModuleV1(); + + void load(); + void unload(); + + void handleQuery(Core::Query * query) const; + + const QString &path() const; + const QString &sourcePath() const; + const QString &id() const; + const QString &name() const; + const QString &author() const; + const QString &version() const; + const QString &description() const; + const QString &trigger() const; + const QStringList &dependencies() const; + const QString &errorString() const; + State state() const; + +private: + + void readMetadata(); + + std::unique_ptr d; + +}; + +} diff --git a/plugins/qmlboxmodel/CMakeLists.txt b/plugins/qmlboxmodel/CMakeLists.txt new file mode 100644 index 0000000..818e63e --- /dev/null +++ b/plugins/qmlboxmodel/CMakeLists.txt @@ -0,0 +1,23 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(qmlboxmodel) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets Qml Quick) + +add_library(${PROJECT_NAME} SHARED ${SRC} metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Qml + Qt5::Quick + Qt5::Widgets + albert::lib + Xext +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) +install(DIRECTORY "share/" DESTINATION "${CMAKE_INSTALL_DATADIR}/albert/org.albert.frontend.qmlboxmodel") diff --git a/plugins/qmlboxmodel/metadata.json b/plugins/qmlboxmodel/metadata.json new file mode 100644 index 0000000..ad422ea --- /dev/null +++ b/plugins/qmlboxmodel/metadata.json @@ -0,0 +1,6 @@ +{ + "id" : "org.albert.frontend.qmlboxmodel", + "name" : "QML Box Model", + "version" : "1.0", + "author" : "Manuel Schneider" +} diff --git a/plugins/qmlboxmodel/qmlboxmodel.qrc b/plugins/qmlboxmodel/qmlboxmodel.qrc new file mode 100644 index 0000000..bb5946e --- /dev/null +++ b/plugins/qmlboxmodel/qmlboxmodel.qrc @@ -0,0 +1,7 @@ + + + resources/gear.svg + resources/HistoryTextInput.qml + resources/MainComponent.qml + + diff --git a/plugins/qmlboxmodel/share/styles/BoxModel/DesktopListView.qml b/plugins/qmlboxmodel/share/styles/BoxModel/DesktopListView.qml new file mode 100644 index 0000000..0ca112f --- /dev/null +++ b/plugins/qmlboxmodel/share/styles/BoxModel/DesktopListView.qml @@ -0,0 +1,44 @@ +import QtQuick 2.0 + +ListView { + + property int itemCount: 5 + + width: parent.width + height: (count === 0) ? 0 : Math.min(itemCount, count)*(itemAt(0,0).height+spacing)-spacing + snapMode: ListView.SnapToItem + clip: true + keyNavigationWraps: false + boundsBehavior: Flickable.StopAtBounds + highlightMoveDuration : 250 + highlightMoveVelocity : 100 + + Connections { + target: model + onModelReset: currentIndex = 0 + } + + Keys.onPressed: { + if ( count === 0 ) + return + + event.accepted = true + + if ( event.key === Qt.Key_Up && event.modifiers === Qt.NoModifier + || event.key === Qt.Key_P && event.modifiers === Qt.ControlModifier ) + decrementCurrentIndex() + else if ( event.key === Qt.Key_Down && event.modifiers === Qt.NoModifier + || event.key === Qt.Key_N && event.modifiers === Qt.ControlModifier ) + incrementCurrentIndex() + else if ( event.key === Qt.Key_PageUp) + currentIndex = Math.max(currentIndex - (itemCount-1), 0) + else if ( event.key === Qt.Key_PageDown) + currentIndex = Math.min(currentIndex + (itemCount-1), count-1) + else if ( event.key === Qt.Key_Home && event.modifiers === Qt.ControlModifier) + currentIndex = 0 + else if ( event.key === Qt.Key_End && event.modifiers === Qt.ControlModifier) + currentIndex = count-1 + else + event.accepted = false + } +} diff --git a/plugins/qmlboxmodel/share/styles/BoxModel/HistoryTextInput.qml b/plugins/qmlboxmodel/share/styles/BoxModel/HistoryTextInput.qml new file mode 100644 index 0000000..9f63cd3 --- /dev/null +++ b/plugins/qmlboxmodel/share/styles/BoxModel/HistoryTextInput.qml @@ -0,0 +1,36 @@ +import QtQuick 2.9 // Min Qt version 5.9 since ubuntu 18.04 LTS was released, needed for textEdited signal + +TextInput { + + property string userText + + function pushTextToHistory() { + if (text.trim() !== "") + history.add(text) + } + + function resetHistoryMode() { + history.resetIterator() + } + + function forwardSearchHistory() { + var match = history.next(userText) + if (match === text) // Simple hack to avoid the seemingly-noop-on-first-history-iteration on disabled clear-on-hide + match = history.next(userText) + if (match) + text = match + } + + function backwardSearchHistory() { + var match = history.prev(userText) + if (match === text) // Simple hack to avoid the seemingly-noop-on-first-history-iteration on disabled clear-on-hide + match = history.prev(userText) + if (match) + text = match + } + + onTextEdited: { + userText = text + history.resetIterator() + } +} diff --git a/plugins/qmlboxmodel/share/styles/BoxModel/ItemViewDelegate.qml b/plugins/qmlboxmodel/share/styles/BoxModel/ItemViewDelegate.qml new file mode 100644 index 0000000..b5b35ad --- /dev/null +++ b/plugins/qmlboxmodel/share/styles/BoxModel/ItemViewDelegate.qml @@ -0,0 +1,158 @@ +import QtQuick 2.5 +import QtGraphicalEffects 1.0 + +Item { + + id: listItem + + property variant attachedModel: model + property int iconSize + property int spacing + property int textSize + property int descriptionSize + property color textColor + property color highlightColor + property string fontName + property int animationDuration: 150 + + width: parent.width + height: Math.max(listItemIconArea.height, listItemTextArea.height) + + MouseArea { + anchors.fill: parent + onClicked: resultsList.currentIndex = index + onDoubleClicked: (mouse.modifiers===Qt.NoModifier) ? root.activate(resultsList.currentIndex) : root.activate(resultsList.currentIndex, -mouse.modifiers) + } + + Item { + id: listItemIconArea + width: iconSize + height: iconSize + spacing + + Image { + id: listItemIcon + asynchronous: true + source: { + var path = itemDecorationRole + return ( path[0] === ":" ) ? "qrc"+path : path + } + width: listItem.iconSize + height: listItem.iconSize + sourceSize.width: listItem.iconSize*2 + sourceSize.height: listItem.iconSize*2 + cache: true + fillMode: Image.PreserveAspectFit + visible: false + } + InnerShadow { + id: sunkenListItemIcon + width: source.width + height: source.height + horizontalOffset: listItem.ListView.isCurrentItem ? 0 : 2 + verticalOffset: listItem.ListView.isCurrentItem ? 0 : 2 + radius: listItem.ListView.isCurrentItem ? 0 : 4 + samples: 8 + color: "#80000000" + visible: false + Behavior on verticalOffset { NumberAnimation{ duration: animationDuration } } + Behavior on horizontalOffset { NumberAnimation{ duration: animationDuration } } + Behavior on radius { NumberAnimation{ duration: animationDuration } } + source: listItemIcon + } + Desaturate { + id: desaturatedSunkenListItemIcon + anchors.centerIn: parent + width: source.width + height: source.height + desaturation: listItem.ListView.isCurrentItem ? 0 : 0.25 + Behavior on desaturation { NumberAnimation{ duration: animationDuration } } + source: sunkenListItemIcon + } + } + + + Column { + id: listItemTextArea + anchors { + left: listItemIconArea.right + leftMargin: listItem.spacing + right: parent.right + verticalCenter: parent.verticalCenter + } + Text { + id: textId + width: parent.width + text: itemTextRole + elide: Text.ElideRight + color: listItem.ListView.isCurrentItem ? listItem.highlightColor : listItem.textColor + font.family: listItem.fontName + font.pixelSize: listItem.textSize + Behavior on color { ColorAnimation{ duration: animationDuration } } + } + Text { + id: subTextId + width: parent.width + text: (listItem.ListView.isCurrentItem && root.state==="fallback") ? itemFallbackRole : itemToolTipRole + elide: Text.ElideRight + color: listItem.ListView.isCurrentItem ? listItem.highlightColor : listItem.textColor + font.family: listItem.fontName + font.pixelSize: listItem.descriptionSize + Behavior on color { ColorAnimation{ duration: animationDuration } } + Behavior on text { + SequentialAnimation { + NumberAnimation { target: subTextId; property: "opacity"; from:1; to: 0; duration: animationDuration/2 } + PropertyAction { } + NumberAnimation { target: subTextId; property: "opacity"; from:0; to: 1; duration: animationDuration/2 } + } + } + } + } // listItemTextArea (Column) + + Text { + id: shortcutId + anchors.right: listItemTextArea.right + anchors.verticalCenter: listItemTextArea.verticalCenter + text: { + var num = 1 + index - Math.max(0, listItem.ListView.view.indexAt(1, listItem.ListView.view.contentY+1)) + return (num < 10) ? "Ctrl+" + num : '' + } + font.family: listItem.fontName + font.pixelSize: listItem.textSize + color: root.ctrl ? listItem.textColor : Qt.rgba(listItem.textColor.r, listItem.textColor.g, listItem.textColor.b, 0) + Behavior on color { ColorAnimation{ duration: animationDuration } } + } + + Glow { + anchors.fill: shortcutId + source: shortcutId + color: root.ctrl ? frame.color : Qt.rgba(frame.color.r, frame.color.g, frame.color.b, 0) + Behavior on color { ColorAnimation{ duration: animationDuration } } + radius: 8 + samples: 17 + spread: 0.7 + } + + + /* + * The function to activate an item + * Currently work as follows: + * action is undefined -> default action + * action 0<= are the alternative actions + * action 0> activation while modifier is pressed (-action is the number of the modifier) + * currently only Meta is supported + */ + function activate(/*optional*/ action){ + if (typeof action === 'undefined') + itemActionRole = 0 + else + if (action < 0 && -action==Qt.MetaModifier) + itemFallbackRole = 0 + else + itemAltActionsRole = action + } + + function actionsList() { + return itemAltActionsRole + } + +} // listItem (MouseArea) diff --git a/plugins/qmlboxmodel/share/styles/BoxModel/MainComponent.qml b/plugins/qmlboxmodel/share/styles/BoxModel/MainComponent.qml new file mode 100644 index 0000000..7506873 --- /dev/null +++ b/plugins/qmlboxmodel/share/styles/BoxModel/MainComponent.qml @@ -0,0 +1,343 @@ +import QtQuick 2.5 +import QtQuick.Controls 1.0 +import QtGraphicalEffects 1.0 +import "themes.js" as Themes + +Item { + + id: root + + property bool ctrl: false + + width: frame.width+2*preferences.shadow_size + height: frame.height+2*preferences.shadow_size + + layer.enabled: true + layer.effect: DropShadow { + transparentBorder: true + verticalOffset: preferences.shadow_size/3 + radius: preferences.shadow_size + samples: preferences.shadow_size*2 + color: preferences.shadow_color + } + + Preferences { + id: preferences + objectName: "preferences" + } + + FontLoader { + source: "fonts/Roboto-Thin.ttf" + onStatusChanged: if (loader.status === FontLoader.Ready) preferences.font_name = fontname + } + + Rectangle { + + id: frame + objectName: "frame" // for C++ + x: preferences.shadow_size; + y: preferences.shadow_size + width: preferences.window_width + height: content.height+2*content.anchors.margins + radius: preferences.radius + color: preferences.background_color + Behavior on color { ColorAnimation { duration: preferences.animation_duration; easing.type: Easing.OutCubic } } + Behavior on border.color { ColorAnimation { duration: preferences.animation_duration; easing.type: Easing.OutCubic } } + border.color: preferences.border_color + border.width: preferences.border_size + + Column { + + id: content + anchors { + top: parent.top + left: parent.left + right: parent.right + margins: preferences.border_size+preferences.padding + } + spacing: preferences.spacing + + HistoryTextInput { + id: historyTextInput + anchors { + left: parent.left; + right: parent.right; + } + clip: true + color: preferences.input_color + focus: true + font.pixelSize: preferences.input_fontsize + font.family: preferences.font_name + selectByMouse: true + selectedTextColor: preferences.background_color + selectionColor: preferences.selection_color + Keys.forwardTo: [root, resultsList] + cursorDelegate : Item { + Rectangle { + width: 1 + height: parent.height + color: preferences.cursor_color + } + SequentialAnimation on opacity { + id: animation + loops: Animation.Infinite; + NumberAnimation { to: 0; duration: 750; easing.type: Easing.InOutExpo } + NumberAnimation { to: 1; duration: 750; easing.type: Easing.InOutExpo } + } + Connections { + target: historyTextInput + onTextChanged: { opacity=1; animation.restart() } + onCursorPositionChanged: { opacity=1; animation.restart() } + } + } + onTextChanged: { root.state="" } + } // historyTextInput + + DesktopListView { + id: resultsList + width: parent.width + model: resultsModel + itemCount: preferences.max_items + delegate: Component { + ItemViewDelegate{ + iconSize: preferences.icon_size + spacing: preferences.spacing + textSize: preferences.item_title_fontsize + descriptionSize: preferences.item_description_fontsize + textColor: preferences.foreground_color + highlightColor: preferences.highlight_color + fontName: preferences.font_name + animationDuration: preferences.animation_duration + } + } + Keys.onEnterPressed: (event.modifiers===Qt.KeypadModifier) ? root.activate(resultsList.currentIndex) : root.activate(resultsList.currentIndex,-event.modifiers) + Keys.onReturnPressed: (event.modifiers===Qt.NoModifier) ? root.activate(resultsList.currentIndex) : root.activate(resultsList.currentIndex,-event.modifiers) + onCurrentIndexChanged: if (root.state==="detailsView") root.state="" + } // resultsList (ListView) + + DesktopListView { + id: actionsListView + width: parent.width + model: ListModel { id: actionsModel } + itemCount: actionsModel.count + spacing: preferences.spacing + Behavior on visible { + SequentialAnimation { + PropertyAction { } + NumberAnimation { target: actionsListView; property: "opacity"; from:0; to: 1; duration: preferences.animation_duration } + } + } + delegate: Text { + horizontalAlignment: Text.AlignHCenter + width: parent.width + text: name + textFormat: Text.PlainText + font.family: preferences.font_name + elide: Text.ElideRight + font.pixelSize: (preferences.item_description_fontsize+preferences.item_title_fontsize)/2 + color: ListView.isCurrentItem ? preferences.highlight_color : preferences.foreground_color + Behavior on color { ColorAnimation{ duration: preferences.animation_duration } } + MouseArea { + anchors.fill: parent + onClicked: actionsListView.currentIndex = index + onDoubleClicked: root.activate(resultsList.currentIndex, actionsListView.currentIndex) + } + } + visible: false + Keys.onEnterPressed: root.activate(resultsList.currentIndex, actionsListView.currentIndex) + Keys.onReturnPressed: root.activate(resultsList.currentIndex, actionsListView.currentIndex) + } // actionsListView (ListView) + } // content (Column) + + + SettingsButton { + id: settingsButton + size: preferences.settingsbutton_size + color: preferences.settingsbutton_color + hoverColor: preferences.settingsbutton_hover_color + onLeftClicked: settingsWidgetRequested() + onRightClicked: menu.popup() + anchors { + top: parent.top + right: parent.right + topMargin: preferences.padding+preferences.border_size + rightMargin: preferences.padding+preferences.border_size + } + + Menu { + id: menu + MenuItem { + text: "Settings" + shortcut: "Alt+," + onTriggered: settingsWidgetRequested() + } + MenuItem { + text: "Quit" + shortcut: "Alt+F4" + onTriggered: Qt.quit() + + } + } + } + } // frame (Rectangle) + + onActiveFocusChanged: state="" + + // Key handling + Keys.onPressed: { + event.accepted = true + if (state === "" + && ((event.key === Qt.Key_Up && resultsList.currentIndex === 0 && !event.isAutoRepeat) // top item selected + || (event.modifiers === Qt.ControlModifier && (event.key === Qt.Key_P || event.key === Qt.Key_Up)))){ // whatever item, using control modifier + state == "" + historyTextInput.forwardSearchHistory() + } + else if (event.modifiers === Qt.ControlModifier && (event.key === Qt.Key_Down || event.key === Qt.Key_N)) { + state == "" + historyTextInput.backwardSearchHistory() + } + else if (event.key === Qt.Key_Meta) { + if (resultsList.currentIndex === -1) + resultsList.currentIndex = 0 + state="fallback" + } + else if (event.key === Qt.Key_Comma && (event.modifiers === Qt.AltModifier || event.modifiers === Qt.ControlModifier)) { + settingsWidgetRequested() + } + else if (event.key === Qt.Key_Alt && resultsList.count > 0) { + if (resultsList.currentIndex === -1) + resultsList.currentIndex = 0 + state = "detailsView" + } + else if (48 <= event.key && event.key <= 57 && event.modifiers === Qt.ControlModifier){ + var num = 9 + if (event.key !== Qt.Key_0) + num = event.key - 49 + if (num < preferences.max_items && num < resultsList.count) { + var index = resultsList.indexAt(0, resultsList.contentY) + index += num + resultsList.currentIndex = index + root.activate(resultsList.currentIndex) + } + } + else if ( event.key === Qt.Key_Control ) + ctrl = true + else if ( event.key === Qt.Key_Tab && resultsList.count > 0 ) { + if ( resultsList.currentIndex === -1 ) + resultsList.currentIndex = 0 + historyTextInput.text = resultsList.currentItem.attachedModel.itemCompletionStringRole + } else event.accepted = false + } + Keys.onReleased: { + event.accepted = true + if ( event.key === Qt.Key_Meta ) + state="" + else if ( event.key === Qt.Key_Alt ) + state="" + else if ( event.key === Qt.Key_Control ) + ctrl = false + else event.accepted = false + + } + + states : [ + State { + name: "" + StateChangeScript { + name: "defaultStateScript" + script: { + actionsModel.clear() + } + } + }, + State { + name: "fallback" + }, + State { + name: "detailsView" + PropertyChanges { target: actionsListView; visible: true } + PropertyChanges { target: historyTextInput; Keys.forwardTo: [root, actionsListView] } + StateChangeScript { + name: "detailsViewStateScript" + script: { + var actionTexts = resultsList.currentItem.actionsList(); + for ( var i = 0; i < actionTexts.length; i++ ) + actionsModel.append({"name": actionTexts[i]}); + } + } + } + ] + + Connections { + target: mainWindow + onVisibleChanged: { + if (!arg) { + + // Save the text if the text displayed has been entered by the user + if (historyTextInput.userText === historyTextInput.text) + historyTextInput.pushTextToHistory() + + // Reset state + state="" + ctrl=false + historyTextInput.selectAll() + historyTextInput.userText = null + historyTextInput.resetHistoryMode() + } + } + } + + Component.onCompleted: setTheme("Bright") + + + // ▼ ▼ ▼ ▼ ▼ DO NOT CHANGE THIS UNLESS YOU KNOW WHAT YOU ARE DOING ▼ ▼ ▼ ▼ ▼ + + /* + * Currently the interface with the program logic comprises the following: + * + * These context properties are set: + * - mainWindow + * - resultsModel + * - history + * + * These properties must exist in root: + * - inputText (string, including the implicitly genreated signal) + * + * These functions must extist in root: + * - availableThemes() + * - setTheme(str) + * + * These signals must exist in root: + * - settingsWidgetRequested() + * + * These object names with must exist somewhere: + * - frame (the visual root frame, i.e. withouth shadow) + * - preferences (QtObject containing only preference propterties) + */ + property string interfaceVersion: "1.0-alpha" // Will not change until beta + + property alias inputText: historyTextInput.text + signal settingsWidgetRequested() + + function activate(index, action) { + if ( resultsList.count > 0 ) { + resultsList.currentIndex = index + if ( resultsList.currentIndex === -1 ) + resultsList.currentIndex = 0 + resultsList.currentItem.activate(action) + + // Order important! (hide triggers root.onVisibleChanged()) + historyTextInput.pushTextToHistory() + mainWindow.hide() + historyTextInput.text = "" + } + } + + function availableThemes() { return Object.keys(Themes.themes()) } + function setTheme(themeName) { + var themeObject = Themes.themes()[themeName] + for (var property in themeObject) + if (themeObject.hasOwnProperty(property)) + preferences[property] = themeObject[property] + } +} diff --git a/plugins/qmlboxmodel/share/styles/BoxModel/Preferences.qml b/plugins/qmlboxmodel/share/styles/BoxModel/Preferences.qml new file mode 100644 index 0000000..480cdfa --- /dev/null +++ b/plugins/qmlboxmodel/share/styles/BoxModel/Preferences.qml @@ -0,0 +1,30 @@ +import QtQuick 2.5 + +QtObject { + + property color background_color + property color foreground_color + property color input_color + property color cursor_color + property color selection_color + property color highlight_color + property color border_color + property color settingsbutton_color + property color settingsbutton_hover_color + property color shadow_color + property int border_size + property int settingsbutton_size + property int input_fontsize + property int icon_size + property int shadow_size + property int item_title_fontsize + property int item_description_fontsize + property int max_items + property int spacing + property int padding + property int radius + property int window_width + property string font_name + property int animation_duration + +} diff --git a/plugins/qmlboxmodel/share/styles/BoxModel/SettingsButton.qml b/plugins/qmlboxmodel/share/styles/BoxModel/SettingsButton.qml new file mode 100644 index 0000000..90a1bda --- /dev/null +++ b/plugins/qmlboxmodel/share/styles/BoxModel/SettingsButton.qml @@ -0,0 +1,63 @@ +import QtQuick 2.5 +import QtGraphicalEffects 1.0 + +Item { + id: root + property color color + property color hoverColor + property int size + signal rightClicked() + signal leftClicked() + + width: size + height: size + + Rectangle { + id: gearcolor + anchors.fill: gearmask + color: root.color + Behavior on color { ColorAnimation { duration: 3000; easing.type: Easing.OutExpo } } + visible: false + } + Image { + id: gearmask + source: "gear.svg" + anchors.fill: gear + sourceSize.width: width*2 + sourceSize.height: height*2 + smooth: true + visible: false + } + OpacityMask { + id: gear + anchors.fill: parent + source: gearcolor + maskSource: gearmask + RotationAnimation on rotation { + duration : 10000 + easing.type: Easing.Linear + loops: Animation.Infinite + from: 0 + to: 360 + } + } + MouseArea { + id: mouseArea + anchors.fill: parent + hoverEnabled: true + acceptedButtons: Qt.LeftButton | Qt.RightButton + onClicked: { + if ( mouse.button === Qt.LeftButton ) + leftClicked() + else if ( mouse.button === Qt.RightButton ) + rightClicked() + } + } + + states: State { + name: "hovered" + when: mouseArea.containsMouse + PropertyChanges { target: gearcolor; color: root.hoverColor } + } + +} diff --git a/plugins/qmlboxmodel/share/styles/BoxModel/fonts/Roboto-Thin.ttf b/plugins/qmlboxmodel/share/styles/BoxModel/fonts/Roboto-Thin.ttf new file mode 100644 index 0000000..b74a4fd Binary files /dev/null and b/plugins/qmlboxmodel/share/styles/BoxModel/fonts/Roboto-Thin.ttf differ diff --git a/plugins/qmlboxmodel/share/styles/BoxModel/gear.svg b/plugins/qmlboxmodel/share/styles/BoxModel/gear.svg new file mode 100644 index 0000000..39117b1 --- /dev/null +++ b/plugins/qmlboxmodel/share/styles/BoxModel/gear.svg @@ -0,0 +1,38 @@ + + + +image/svg+xml \ No newline at end of file diff --git a/plugins/qmlboxmodel/share/styles/BoxModel/metadata.json b/plugins/qmlboxmodel/share/styles/BoxModel/metadata.json new file mode 100644 index 0000000..b8d7a0a --- /dev/null +++ b/plugins/qmlboxmodel/share/styles/BoxModel/metadata.json @@ -0,0 +1,5 @@ +{ + "name" : "BoxModel", + "version" : "1.0-alpha", + "author" : "Manuel Schneider" +} diff --git a/plugins/qmlboxmodel/share/styles/BoxModel/themes.js b/plugins/qmlboxmodel/share/styles/BoxModel/themes.js new file mode 100644 index 0000000..e8ea821 --- /dev/null +++ b/plugins/qmlboxmodel/share/styles/BoxModel/themes.js @@ -0,0 +1,276 @@ + +function themes() { + + var themes = {} + + themes.Bright = {} + themes.Bright.input_fontsize = 36 + themes.Bright.item_title_fontsize = 26 + themes.Bright.item_description_fontsize = 12 + themes.Bright.icon_size = 48 + themes.Bright.max_items = 5 + themes.Bright.spacing = 6 + themes.Bright.padding = 6 + themes.Bright.radius = 16 + themes.Bright.border_size = 6 + themes.Bright.settingsbutton_size = 16 + themes.Bright.animation_duration = 200 + themes.Bright.window_width = 640 + themes.Bright.font_name = "Roboto" + themes.Bright.shadow_size = 30 + themes.Bright.shadow_color = "#40000000" + themes.Bright.foreground_color = "#a0a0a0" + themes.Bright.background_color = "#FFFFFF" + themes.Bright.highlight_color = "#606060" + themes.Bright.border_color = themes.Bright.foreground_color + themes.Bright.input_color = themes.Bright.foreground_color + themes.Bright.cursor_color = themes.Bright.foreground_color + themes.Bright.selection_color = themes.Bright.highlight_color + themes.Bright.settingsbutton_hover_color = themes.Bright.highlight_color + themes.Bright.settingsbutton_color = themes.Bright.background_color + + var highlights = {} + highlights.BrightOrange = "#ff9f3f" + highlights.BrightMagenta = "#ff3f9f" + highlights.BrightMint = "#3fff9f" + highlights.BrightGreen = "#9fff3f" + highlights.BrightBlue = "#3f9fff" + highlights.BrightViolet = "#9f3fff" + + for (var name in highlights){ + if (highlights.hasOwnProperty(name)){ + themes[name] = JSON.parse(JSON.stringify(themes.Bright)) + themes[name].highlight_color = highlights[name] + themes[name].selection_color = highlights[name] + themes[name].border_color = highlights[name] + themes[name].settingsbutton_hover_color = highlights[name] + } + } + + themes.Dark = JSON.parse(JSON.stringify(themes.Bright)) + themes.Dark.foreground_color = "#808080" + themes.Dark.background_color = "#404040" + themes.Dark.highlight_color = "#E0E0E0" + themes.Dark.border_color = themes.Dark.foreground_color + themes.Dark.input_color = themes.Dark.foreground_color + themes.Dark.cursor_color = themes.Dark.foreground_color + themes.Dark.settingsbutton_color = themes.Dark.background_color + themes.Dark.settingsbutton_hover_color = themes.Dark.highlight_color + themes.Dark.selection_color = themes.Dark.highlight_color + + highlights = {} + highlights.DarkOrange = "#FF9020" + highlights.DarkMagenta = "#FF2090" + highlights.DarkMint = "#20FF90" + highlights.DarkGreen = "#90FF20" + highlights.DarkBlue = "#2090FF" + highlights.DarkViolet = "#9020FF" + + for (name in highlights){ + if (highlights.hasOwnProperty(name)){ + themes[name] = JSON.parse(JSON.stringify(themes.Dark)) + themes[name].highlight_color = highlights[name] + themes[name].selection_color = highlights[name] + themes[name].border_color = highlights[name] + themes[name].settingsbutton_hover_color = highlights[name] + } + } + + themes.SolarizedBrightYellow = JSON.parse(JSON.stringify(themes.Dark)) + themes.SolarizedBrightYellow.background_color = "#fdf6e3" + themes.SolarizedBrightYellow.foreground_color = "#839496" + themes.SolarizedBrightYellow.highlight_color = "#b58900" + themes.SolarizedBrightYellow.input_color = themes.SolarizedBrightYellow.foreground_color + themes.SolarizedBrightYellow.cursor_color = themes.SolarizedBrightYellow.foreground_color + themes.SolarizedBrightYellow.settingsbutton_color = themes.SolarizedBrightYellow.background_color + themes.SolarizedBrightYellow.settingsbutton_hover_color = themes.SolarizedBrightYellow.highlight_color + themes.SolarizedBrightYellow.selection_color = themes.SolarizedBrightYellow.highlight_color + themes.SolarizedBrightYellow.border_color = themes.SolarizedBrightYellow.highlight_color + + highlights = {} + highlights.SolarizedBrightOrange = "#cb4b16" + highlights.SolarizedBrightRed = "#dc322f" + highlights.SolarizedBrightMagenta = "#d33682" + highlights.SolarizedBrightCyan = "#2aa198" + highlights.SolarizedBrightViolet = "#6c71c4" + highlights.SolarizedBrightBlue = "#268bd2" + highlights.SolarizedBrightGreen = "#859900" + + for (name in highlights){ + if (highlights.hasOwnProperty(name)){ + themes[name] = JSON.parse(JSON.stringify(themes.SolarizedBrightYellow)) + themes[name].highlight_color = highlights[name] + themes[name].selection_color = highlights[name] + themes[name].border_color = highlights[name] + themes[name].settingsbutton_hover_color = highlights[name] + } + } + + themes.SolarizedDarkYellow = JSON.parse(JSON.stringify(themes.SolarizedBrightYellow)) + themes.SolarizedDarkYellow.background_color = "#002b36" + themes.SolarizedDarkYellow.highlight_color = "#b58900" + themes.SolarizedDarkYellow.input_color = themes.SolarizedDarkYellow.foreground_color + themes.SolarizedDarkYellow.cursor_color = themes.SolarizedDarkYellow.foreground_color + themes.SolarizedDarkYellow.settingsbutton_color = themes.SolarizedDarkYellow.background_color + themes.SolarizedDarkYellow.settingsbutton_hover_color = themes.SolarizedDarkYellow.highlight_color + themes.SolarizedDarkYellow.selection_color = themes.SolarizedDarkYellow.highlight_color + themes.SolarizedDarkYellow.border_color = themes.SolarizedDarkYellow.highlight_color + + highlights = {} + highlights.SolarizedDarkOrange = "#cb4b16" + highlights.SolarizedDarkRed = "#dc322f" + highlights.SolarizedDarkMagenta = "#d33682" + highlights.SolarizedDarkCyan = "#2aa198" + highlights.SolarizedDarkViolet = "#6c71c4" + highlights.SolarizedDarkBlue = "#268bd2" + highlights.SolarizedDarkGreen = "#859900" + + for (name in highlights){ + if (highlights.hasOwnProperty(name)){ + themes[name] = JSON.parse(JSON.stringify(themes.SolarizedDarkYellow)) + themes[name].highlight_color = highlights[name] + themes[name].selection_color = highlights[name] + themes[name].border_color = highlights[name] + themes[name].settingsbutton_hover_color = highlights[name] + } + } + + themes.Tiffany = JSON.parse(JSON.stringify(themes.Bright)) + themes.Tiffany.background_color = "#e2f2fa" + themes.Tiffany.foreground_color = "#73BDE4" + themes.Tiffany.highlight_color = "#a47a51" + themes.Tiffany.border_color = "#1d6a87" + themes.Tiffany.input_color = themes.Tiffany.foreground_color + themes.Tiffany.cursor_color = themes.Tiffany.foreground_color + themes.Tiffany.settingsbutton_color = themes.Tiffany.background_color + themes.Tiffany.settingsbutton_hover_color = themes.Tiffany.highlight_color + themes.Tiffany.selection_color = themes.Tiffany.highlight_color + + themes.Nerdy = JSON.parse(JSON.stringify(themes.Bright)) + themes.Nerdy.icon_size = 36 + themes.Nerdy.input_fontsize = 26 + themes.Nerdy.item_title_fontsize = 18 + themes.Nerdy.item_description_fontsize = 11 + themes.Nerdy.max_items = 8 + themes.Nerdy.spacing = 6 + themes.Nerdy.radius = 6 + themes.Nerdy.border_size = 1 + themes.Nerdy.settingsbutton_size = 14 + themes.Nerdy.window_width = 600 + themes.Nerdy.font_name = "monospace" + themes.Nerdy.background_color = "#202020" + themes.Nerdy.foreground_color = "#808080" + themes.Nerdy.highlight_color = "#00FF00" + themes.Nerdy.border_color = "#404040" + themes.Nerdy.cursor_color = themes.Nerdy.highlight_color + themes.Nerdy.input_color = themes.Nerdy.highlight_color + themes.Nerdy.selection_color = themes.Nerdy.foreground_color + themes.Nerdy.settingsbutton_color = "#303030" + themes.Nerdy.settingsbutton_hover_color = themes.Nerdy.highlight_color + + themes.Spotlight = {} + themes.Spotlight.icon_size = 38 + themes.Spotlight.input_fontsize = 28 + themes.Spotlight.item_title_fontsize = 20 + themes.Spotlight.item_description_fontsize = 12 + themes.Spotlight.max_items = 5 + themes.Spotlight.spacing = 6 + themes.Spotlight.shadow_size = 30 + themes.Spotlight.radius = 8 + themes.Spotlight.padding = 8 + themes.Spotlight.border_size = 0 + themes.Spotlight.settingsbutton_size = 15 + themes.Spotlight.window_width = 600 + themes.Spotlight.animation_duration = 200 + themes.Spotlight.font_name = "Roboto" + themes.Spotlight.background_color = "#ffffff" + themes.Spotlight.foreground_color = "#808080" + themes.Spotlight.highlight_color = "#303030" + themes.Spotlight.border_color = "#ffffff" + themes.Spotlight.input_color = "#303030" + themes.Spotlight.cursor_color = "#303030" + themes.Spotlight.selection_color = "#c0c0c0" + themes.Spotlight.settingsbutton_color = "#ffffff" + themes.Spotlight.settingsbutton_hover_color = "#a0a0a0" + themes.Spotlight.shadow_color = "#70000000" + + themes.ArcDark = {} + themes.ArcDark.icon_size = 38 + themes.ArcDark.input_fontsize = 28 + themes.ArcDark.item_title_fontsize = 20 + themes.ArcDark.item_description_fontsize = 12 + themes.ArcDark.max_items = 5 + themes.ArcDark.spacing = 6 + themes.ArcDark.shadow_size = 30 + themes.ArcDark.radius = 8 + themes.ArcDark.padding = 8 + themes.ArcDark.border_size = 1 + themes.ArcDark.settingsbutton_size = 15 + themes.ArcDark.window_width = 600 + themes.ArcDark.animation_duration = 200 + themes.ArcDark.font_name = "Roboto" + themes.ArcDark.background_color = "#2F343F" + themes.ArcDark.foreground_color = "#c2c2c2" + themes.ArcDark.highlight_color = "#ffffff" + themes.ArcDark.border_color = "#262A32" + themes.ArcDark.input_color = "#ffffff" + themes.ArcDark.cursor_color = "#ffffff" + themes.ArcDark.selection_color = "#c0c0c0" + themes.ArcDark.settingsbutton_color = "#666A73" + themes.ArcDark.settingsbutton_hover_color = "#ffffff" + themes.ArcDark.shadow_color = "#70000000" + + themes.ArcGreyDark = {} + themes.ArcGreyDark.icon_size = 38 + themes.ArcGreyDark.input_fontsize = 28 + themes.ArcGreyDark.item_title_fontsize = 20 + themes.ArcGreyDark.item_description_fontsize = 12 + themes.ArcGreyDark.max_items = 5 + themes.ArcGreyDark.spacing = 6 + themes.ArcGreyDark.shadow_size = 30 + themes.ArcGreyDark.radius = 8 + themes.ArcGreyDark.padding = 8 + themes.ArcGreyDark.border_size = 1 + themes.ArcGreyDark.settingsbutton_size = 15 + themes.ArcGreyDark.window_width = 600 + themes.ArcGreyDark.animation_duration = 200 + themes.ArcGreyDark.font_name = "Roboto" + themes.ArcGreyDark.background_color = "#404040" + themes.ArcGreyDark.foreground_color = "#c2c2c2" + themes.ArcGreyDark.highlight_color = "#ffffff" + themes.ArcGreyDark.border_color = "#2d2f3b" + themes.ArcGreyDark.input_color = "#ffffff" + themes.ArcGreyDark.cursor_color = "#ffffff" + themes.ArcGreyDark.selection_color = "#c0c0c0" + themes.ArcGreyDark.settingsbutton_color = "#2d2f3b" + themes.ArcGreyDark.settingsbutton_hover_color = "#000000" + themes.ArcGreyDark.shadow_color = "#70000000" + + themes.BreezeDark = {} + themes.BreezeDark.icon_size = 38 + themes.BreezeDark.input_fontsize = 28 + themes.BreezeDark.item_title_fontsize = 20 + themes.BreezeDark.item_description_fontsize = 12 + themes.BreezeDark.max_items = 8 + themes.BreezeDark.spacing = 6 + themes.BreezeDark.shadow_size = 0 + themes.BreezeDark.radius = 0 + themes.BreezeDark.padding = 4 + themes.BreezeDark.border_size = 0 + themes.BreezeDark.settingsbutton_size = 15 + themes.BreezeDark.window_width = 400 + themes.BreezeDark.animation_duration = 200 + themes.BreezeDark.font_name = "Roboto" + themes.BreezeDark.background_color = "#32373b" + themes.BreezeDark.foreground_color = "#ffffff" + themes.BreezeDark.highlight_color = "#61abff" + themes.BreezeDark.border_color = "#5595df" + themes.BreezeDark.input_color = "#ffffff" + themes.BreezeDark.cursor_color = "#ffffff" + themes.BreezeDark.selection_color = "#c0c0c0" + themes.BreezeDark.settingsbutton_color = "#222629" + themes.BreezeDark.settingsbutton_hover_color = "#5595df" + themes.BreezeDark.shadow_color = "#70000000" + + return themes +} diff --git a/plugins/qmlboxmodel/src/colordialog.hpp b/plugins/qmlboxmodel/src/colordialog.hpp new file mode 100644 index 0000000..6c05cc1 --- /dev/null +++ b/plugins/qmlboxmodel/src/colordialog.hpp @@ -0,0 +1,25 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include + +namespace QmlBoxModel { + +class ColorDialog : public QColorDialog +{ + Q_OBJECT + Q_PROPERTY(QColor color READ color WRITE setColor NOTIFY colorChanged USER true) +public: + ColorDialog(QWidget * parent = 0) : QColorDialog(parent){ + setOptions(QColorDialog::ShowAlphaChannel); + connect(this, &QColorDialog::currentColorChanged, + this, &ColorDialog::colorChanged); + } + + QColor color(){ return currentColor(); } + void setColor(const QColor& c){ setCurrentColor(c); } +signals: + void colorChanged(const QColor &color); +}; + +} diff --git a/plugins/qmlboxmodel/src/configwidget.cpp b/plugins/qmlboxmodel/src/configwidget.cpp new file mode 100644 index 0000000..2df0f1b --- /dev/null +++ b/plugins/qmlboxmodel/src/configwidget.cpp @@ -0,0 +1,115 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "configwidget.h" +#include "mainwindow.h" +#include "propertyeditor.h" + +/** ***************************************************************************/ +QmlBoxModel::ConfigWidget::ConfigWidget(MainWindow *mainWindow, QWidget *parent, Qt::WindowFlags f) + : QWidget(parent, f), mainWindow_(mainWindow) { + + ui.setupUi(this); + + // ALWAYS ON TOP + ui.checkBox_onTop->setChecked(mainWindow_->alwaysOnTop()); + connect(ui.checkBox_onTop, &QCheckBox::toggled, mainWindow_, + &MainWindow::setAlwaysOnTop); + + // HIDE ON FOCUS OUT + ui.checkBox_hideOnFocusOut->setChecked(mainWindow_->hideOnFocusLoss()); + connect(ui.checkBox_hideOnFocusOut, &QCheckBox::toggled, + mainWindow_, &MainWindow::setHideOnFocusLoss); + + // ALWAYS CENTER + ui.checkBox_center->setChecked(mainWindow_->showCentered()); + connect(ui.checkBox_center, &QCheckBox::toggled, + mainWindow_, &MainWindow::setShowCentered); + + // HIDE ON CLOSE + ui.checkBox_hideOnClose->setChecked(mainWindow_->hideOnClose()); + connect(ui.checkBox_hideOnClose, &QCheckBox::toggled, + mainWindow_, &MainWindow::setHideOnClose); + + // CLEAR ON HIDE + ui.checkBox_clearOnHide->setChecked(mainWindow_->clearOnHide()); + connect(ui.checkBox_clearOnHide, &QCheckBox::toggled, + mainWindow_, &MainWindow::setClearOnHide); + + + /* + * STYLES + */ + + // Fill the combobox + for ( const QmlStyleSpec &style : mainWindow_->availableStyles() ) { + ui.comboBox_style->addItem(style.name, style.mainComponent); + + // Add tooltip + ui.comboBox_style->setItemData(ui.comboBox_style->count()-1, + QString("%1\nVersion: %2\nAuthor: %3") + .arg(style.name, style.version, style.author), + Qt::ToolTipRole); + + if ( style.mainComponent == mainWindow_->source().toString() ) + ui.comboBox_style->setCurrentIndex(ui.comboBox_style->count()-1); + } + updateThemes(); + + connect(ui.comboBox_style, static_cast(&QComboBox::currentIndexChanged), + this, &ConfigWidget::onStyleChanged); + + connect(ui.comboBox_themes, static_cast(&QComboBox::currentIndexChanged), + this, &ConfigWidget::onThemeChanged); + + // PROPERTY EDITOR + connect(ui.toolButton_propertyEditor, &QToolButton::clicked, mainWindow_, [this](){ + PropertyEditor *pe = new PropertyEditor(mainWindow_, this); + pe->setWindowModality(Qt::WindowModality::WindowModal); + pe->show(); + }); +} + + +/** ***************************************************************************/ +void QmlBoxModel::ConfigWidget::onStyleChanged(int i) { + // Apply the style + mainWindow_->setSource(mainWindow_->availableStyles()[static_cast(i)].mainComponent); + updateThemes(); +} + + +/** ***************************************************************************/ +void QmlBoxModel::ConfigWidget::onThemeChanged(const QString &text) { + mainWindow_->setTheme(text); +} + + +/** ***************************************************************************/ +void QmlBoxModel::ConfigWidget::updateThemes() { + + ui.comboBox_themes->blockSignals(true); + + ui.comboBox_themes->clear(); + + // Add disabled placeholder item + ui.comboBox_themes->addItem("Choose theme..."); + const QStandardItemModel* model = qobject_cast(ui.comboBox_themes->model()); + QStandardItem* item = model->item(0); + item->setEnabled(false); + ui.comboBox_themes->insertSeparator(1); + + // Add themes + ui.comboBox_themes->addItems(mainWindow_->availableThemes()); + + ui.comboBox_themes->blockSignals(false); + +} diff --git a/plugins/qmlboxmodel/src/configwidget.h b/plugins/qmlboxmodel/src/configwidget.h new file mode 100644 index 0000000..4c85de3 --- /dev/null +++ b/plugins/qmlboxmodel/src/configwidget.h @@ -0,0 +1,28 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include "ui_configwidget.h" + +namespace QmlBoxModel { + +class MainWindow; + +class ConfigWidget final : public QWidget +{ + Q_OBJECT + +public: + + ConfigWidget(MainWindow *mainWindow, QWidget * parent = 0, Qt::WindowFlags f = 0); + +private: + + void onStyleChanged(int); + void onThemeChanged(const QString &text); + void updateThemes(); + + MainWindow *mainWindow_; + Ui::SettingsDialog ui; +}; + +} diff --git a/plugins/qmlboxmodel/src/configwidget.ui b/plugins/qmlboxmodel/src/configwidget.ui new file mode 100644 index 0000000..834edfa --- /dev/null +++ b/plugins/qmlboxmodel/src/configwidget.ui @@ -0,0 +1,141 @@ + + + QmlBoxModel::SettingsDialog + + + + + + User Interface + + + + Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter + + + + + Style: + + + comboBox_style + + + + + + + + + + + + + .. + + + + + + + + + Apply theme: + + + + + + + + + + Hide on focus out: + + + checkBox_hideOnFocusOut + + + + + + + + + + + + + + Always center Albert: + + + checkBox_center + + + + + + + + + + + + + + Always on top: + + + checkBox_onTop + + + + + + + + + + + + + + Hide on close: + + + + + + + + + + Clear on hide: + + + + + + + + + + + + + Qt::Vertical + + + + 0 + 0 + + + + + + + + + diff --git a/plugins/qmlboxmodel/src/frontendplugin.cpp b/plugins/qmlboxmodel/src/frontendplugin.cpp new file mode 100644 index 0000000..81ea90a --- /dev/null +++ b/plugins/qmlboxmodel/src/frontendplugin.cpp @@ -0,0 +1,69 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "frontendplugin.h" +#include "configwidget.h" +#include "mainwindow.h" + + +/** ***************************************************************************/ +QmlBoxModel::FrontendPlugin::FrontendPlugin() + : Frontend("org.albert.frontend.qmlboxmodel"), + mainWindow(new MainWindow(this)){ + + connect(mainWindow.get(), &MainWindow::inputChanged, [this](){ + emit inputChanged(input()); + }); + + connect(mainWindow.get(), &MainWindow::settingsWidgetRequested, + this, &Frontend::settingsWidgetRequested); + + connect(mainWindow.get(), &MainWindow::visibilityChanged, + this, [this](QWindow::Visibility visibility){ + emit ( visibility == QWindow::Visibility::Hidden ) ? widgetHidden() : widgetShown(); + }); +} + + +/** ***************************************************************************/ +QmlBoxModel::FrontendPlugin::~FrontendPlugin() { + +} + + +/** ***************************************************************************/ +bool QmlBoxModel::FrontendPlugin::isVisible() { + return mainWindow->isVisible(); +} + + +/** ***************************************************************************/ +void QmlBoxModel::FrontendPlugin::setVisible(bool visible) { + mainWindow->setVisible(visible); + mainWindow->raise(); + mainWindow->requestActivate(); +} + + +/** ***************************************************************************/ +QString QmlBoxModel::FrontendPlugin::input() { + return mainWindow->input(); +} + + +/** ***************************************************************************/ +void QmlBoxModel::FrontendPlugin::setInput(const QString &input) { + mainWindow->setInput(input); +} + + +/** ***************************************************************************/ +void QmlBoxModel::FrontendPlugin::setModel(QAbstractItemModel *m) { + mainWindow->setModel(m); +} + + +/** ***************************************************************************/ +QWidget *QmlBoxModel::FrontendPlugin::widget(QWidget *parent) { + return new ConfigWidget(mainWindow.get(), parent); +} + diff --git a/plugins/qmlboxmodel/src/frontendplugin.h b/plugins/qmlboxmodel/src/frontendplugin.h new file mode 100644 index 0000000..80d56bf --- /dev/null +++ b/plugins/qmlboxmodel/src/frontendplugin.h @@ -0,0 +1,37 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "albert/frontend.h" + +namespace QmlBoxModel { + +class MainWindow; + +class FrontendPlugin final : public Core::Frontend +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_FRONTEND_IID FILE "metadata.json") + +public: + + FrontendPlugin(); + ~FrontendPlugin(); + + bool isVisible() override; + void setVisible(bool visible) override; + + QString input() override; + void setInput(const QString&) override; + + void setModel(QAbstractItemModel *) override; + + QWidget* widget(QWidget *parent = nullptr) override; + +private: + + std::unique_ptr mainWindow; +}; + +} diff --git a/plugins/qmlboxmodel/src/mainwindow.cpp b/plugins/qmlboxmodel/src/mainwindow.cpp new file mode 100644 index 0000000..4149793 --- /dev/null +++ b/plugins/qmlboxmodel/src/mainwindow.cpp @@ -0,0 +1,577 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "mainwindow.h" +#include "frontendplugin.h" +#ifdef __unix__ +#include "xcb/xcb.h" +#include +#undef KeyPress +#undef KeyRelease +#undef FocusOut +#undef Status +#include +#endif + +namespace { +const QString CFG_CENTERED = "showCentered"; +const bool DEF_CENTERED = true; +const QString CFG_HIDEONFOCUSLOSS = "hideOnFocusLoss"; +const bool DEF_HIDEONFOCUSLOSS = true; +const QString CFG_ALWAYS_ON_TOP = "alwaysOnTop"; +const bool DEF_ALWAYS_ON_TOP = true; +const char* CFG_HIDE_ON_CLOSE = "hideOnClose"; +const bool DEF_HIDE_ON_CLOSE = false; +const char* CFG_CLEAR_ON_HIDE = "clearOnHide"; +const bool DEF_CLEAR_ON_HIDE = false; +const QString CFG_STYLEPATH = "stylePath"; +const QString CFG_WND_POS = "windowPosition"; +const QString PLUGIN_ID = "org.albert.frontend.qmlboxmodel"; +const QString STYLE_MAIN_NAME = "MainComponent.qml"; +const QString STYLE_CONFIG_NAME = "style_properties.ini"; +const QString PREF_OBJ_NAME = "preferences"; +const QString FRAME_OBJ_NAME = "frame"; +} + +/** ***************************************************************************/ +QmlBoxModel::MainWindow::MainWindow(FrontendPlugin *plugin, QWindow *parent) : QQuickView(parent) { + setColor(Qt::transparent); + setFlags(Qt::Tool + | Qt::WindowStaysOnTopHint + | Qt::FramelessWindowHint + | Qt::WindowCloseButtonHint // No close event w/o this + ); + + plugin_ = plugin; + + // Set qml environment + rootContext()->setContextProperty("mainWindow", this); + rootContext()->setContextProperty("history", &history_); + rootContext()->setContextProperty("resultsModel", &model_); + + // Quit application when qml signals quit + connect(engine(), SIGNAL(quit()), QCoreApplication::instance(), SLOT(quit())); + + // When component is ready load the saved properties + connect(this, &QQuickView::statusChanged, this, [this](QQuickView::Status status){ + if ( status == QQuickView::Status::Ready ){ + + // Get root object + if (!rootObject()){ + qWarning() << "Could not retrieve settableProperties: There is no root object."; + return; + } + + // Forward signals + connect(rootObject(), SIGNAL(inputTextChanged()), + this, SIGNAL(inputChanged())); + + connect(rootObject(), SIGNAL(settingsWidgetRequested()), + this, SIGNAL(settingsWidgetRequested())); + + connect(rootObject(), SIGNAL(settingsWidgetRequested()), + this, SLOT(hide())); + + // Get preferences object + QObject *preferencesObject = rootObject()->findChild(PREF_OBJ_NAME); + if (!preferencesObject){ + qWarning() << qPrintable(QString("Could not retrieve settableProperties: " + "There is no object named '%1'.").arg(PREF_OBJ_NAME)); + return; + } + + // Load the style properties in the group of this style id + QSettings s(plugin_->configLocation().filePath(STYLE_CONFIG_NAME), QSettings::Format::IniFormat); + s.beginGroup(QFileInfo(source().toString()).dir().dirName()); + for (const QString &prop : settableProperties()) + if (s.contains(prop)) + preferencesObject->setProperty(prop.toLatin1().data(), s.value(prop)); + } + }); + + // Reload if source file changed + connect(&watcher_, &QFileSystemWatcher::fileChanged, this, [this](){ + qDebug() << "QML file reloaded."; + QUrl url = source(); + setSource(QUrl()); + engine()->clearComponentCache(); + setSource(url); + watcher_.addPath(url.toString()); + }); + + // Center window between each hide and show + connect(this, &QQuickView::visibilityChanged, this, [this](QWindow::Visibility visibility){ + if ( visibility != QWindow::Visibility::Hidden ) + if ( showCentered_ ){ + QDesktopWidget *dw = QApplication::desktop(); + setPosition(dw->availableGeometry(dw->screenNumber(QCursor::pos())) + .center()-QPoint(width()/2,256)); + } + if ( clearOnHide_ ) + this->setInput(""); + }); + + QStringList pluginDataPaths = QStandardPaths::locateAll(QStandardPaths::AppDataLocation, + plugin->id(), + QStandardPaths::LocateDirectory); + +// // Add the shared modules to the lookup path +// for (const QString &pluginDataPath : pluginDataPaths){ +// QDir pluginDataDir = QDir(pluginDataPath); +// if ( pluginDataDir.exists("shared") ) +// engine()->addImportPath(pluginDataDir.filePath("shared")); +// } + + // Get style files + QFileInfoList styles; + for (const QString &pluginDataPath : pluginDataPaths) { + QDirIterator it(QString("%1/styles").arg(pluginDataPath), QDir::Dirs|QDir::NoDotAndDotDot); + while ( it.hasNext() ) { + QDir root = QDir(it.next()); + if ( root.exists(STYLE_MAIN_NAME) ){ + QmlStyleSpec style; + style.mainComponent = root.filePath(STYLE_MAIN_NAME); + style.name = root.dirName(); + style.author = "N/A"; + style.version = "N/A"; + if ( root.exists("metadata.json") ) { + QFile file(root.filePath("metadata.json")); + if (file.open(QIODevice::ReadOnly)) { + QJsonObject metadata = QJsonDocument::fromJson(file.readAll()).object(); + if (metadata.contains("name")) + style.name = metadata["name"].toString(); + if (metadata.contains("author")) + style.author = metadata["author"].toString(); + if (metadata.contains("version")) + style.version = metadata["version"].toString(); + } + } + styles_.push_back(style); + } + } + } + + if (styles_.empty()) + throw "No styles found."; + + + auto storeWinPos = [this](){ + plugin_->settings().setValue(CFG_WND_POS, position()); + }; + connect(this, &MainWindow::xChanged, this, storeWinPos); + connect(this, &MainWindow::yChanged, this, storeWinPos); + + // Load window settings + setPosition(plugin_->settings().value(CFG_WND_POS).toPoint()); + setShowCentered(plugin_->settings().value(CFG_CENTERED, DEF_CENTERED).toBool()); + setClearOnHide(plugin_->settings().value(CFG_CLEAR_ON_HIDE, DEF_CLEAR_ON_HIDE).toBool()); + setHideOnFocusLoss(plugin_->settings().value(CFG_HIDEONFOCUSLOSS, DEF_HIDEONFOCUSLOSS).toBool()); + setAlwaysOnTop(plugin_->settings().value(CFG_ALWAYS_ON_TOP, DEF_ALWAYS_ON_TOP).toBool()); + setHideOnClose(plugin_->settings().value(CFG_HIDE_ON_CLOSE, DEF_HIDE_ON_CLOSE).toBool()); + if ( plugin_->settings().contains(CFG_STYLEPATH) && QFile::exists(plugin_->settings().value(CFG_STYLEPATH).toString()) ) + setSource(plugin_->settings().value(CFG_STYLEPATH).toString()); + else { + setSource(styles_[0].mainComponent); + plugin_->settings().setValue(CFG_STYLEPATH, styles_[0].mainComponent); + } + +} + + +/** ***************************************************************************/ +QmlBoxModel::MainWindow::~MainWindow() { + +} + + +/** ***************************************************************************/ +QString QmlBoxModel::MainWindow::input() { + + // Get root object + QObject *rootObj = rootObject(); + if (!rootObj){ + qWarning() << "Could not retrieve input: There is no root object."; + return QString(); + } + return rootObj->property("inputText").toString(); +} + + +/** ***************************************************************************/ +void QmlBoxModel::MainWindow::setInput(const QString &input) { + + // Get root object + QObject *rootObj = rootObject(); + if (!rootObj){ + qWarning() << "Could not retrieve input: There is no root object."; + return; + } + rootObj->setProperty("inputText", input); +} + + +/** ***************************************************************************/ +void QmlBoxModel::MainWindow::setSource(const QUrl &url) { + + // Apply the source + QQuickView::setSource(url); + + if ( url.isEmpty() ) + return; + + // Save the theme + plugin_->settings().setValue(CFG_STYLEPATH, source().toString()); + + // Watch this source file for modifications + if ( !watcher_.files().isEmpty() ) + watcher_.removePaths(watcher_.files()); + watcher_.addPath(url.toString()); +} + + +/** ***************************************************************************/ +const std::vector &QmlBoxModel::MainWindow::availableStyles() const { + return styles_; +} + + +/** ***************************************************************************/ +QStringList QmlBoxModel::MainWindow::settableProperties() { + + // Get root object + if (!rootObject()){ + qWarning() << "Could not retrieve settableProperties: There is no root object."; + return QStringList(); + } + + // Get preferences object + const QObject *preferencesObject = rootObject()->findChild(PREF_OBJ_NAME); + if (!preferencesObject){ + qWarning() << qPrintable(QString("Could not retrieve settableProperties: " + "There is no object named '%1'.").arg(PREF_OBJ_NAME)); + return QStringList(); + } + + // Get preferences object's meta object (Reflection yieh…) + const QMetaObject *preferencesMetaObject = preferencesObject->metaObject(); + if (!preferencesMetaObject){ + qWarning() << "Could not retrieve settableProperties: Fetching MetaObject failed."; + return QStringList(); + } + + // Get all properties of the object + QStringList settableProperties; + for (int i = 0; i < preferencesMetaObject->propertyCount(); i++) + settableProperties.append(preferencesMetaObject->property(i).name()); + + // QtObject type has a single property "objectName". Remove it. + settableProperties.removeAll("objectName"); + + return settableProperties; +} + + +/** ***************************************************************************/ +QVariant QmlBoxModel::MainWindow::property(const char *name) const { + + // Get root object + if (!rootObject()){ + qWarning() << "Could not retrieve settableProperties: There is no root object."; + return QVariant(); + } + + // Get preferences object + const QObject *preferencesObject = rootObject()->findChild(PREF_OBJ_NAME); + if (!preferencesObject){ + qWarning() << qPrintable(QString("Could not retrieve settableProperties: " + "There is no object named '%1'.").arg(PREF_OBJ_NAME)); + return QVariant(); + } + + return preferencesObject->property(name); +} + + +/** ***************************************************************************/ +void QmlBoxModel::MainWindow::setProperty(const char *attribute, const QVariant &value) { + + // Create the settings instance of the decicated file in config location + QSettings s(plugin_->configLocation().filePath(STYLE_CONFIG_NAME), QSettings::Format::IniFormat); + s.beginGroup(QFileInfo(source().toString()).dir().dirName()); + s.setValue(attribute, value); + + // Get root object + if (!rootObject()) { + qWarning() << "Could not retrieve settableProperties: There is no root object."; + return; + } + + // Get preferences object + QObject *preferencesObject = rootObject()->findChild(PREF_OBJ_NAME); + if (!preferencesObject) { + qWarning() << qPrintable(QString("Could not retrieve settableProperties: " + "There is no object named '%1'.").arg(PREF_OBJ_NAME)); + return; + } + + // Set the property + preferencesObject->setProperty(attribute, value); +} + + +/** ***************************************************************************/ +QStringList QmlBoxModel::MainWindow::availableThemes() { + + // Get root object + if (!rootObject()){ + qWarning() << "Could not retrieve settableProperties: There is no root object."; + return QStringList(); + } + + QVariant returnedValue; + QMetaObject::invokeMethod(rootObject(), "availableThemes", Q_RETURN_ARG(QVariant, returnedValue)); + return returnedValue.toStringList(); +} + + +/** ***************************************************************************/ +void QmlBoxModel::MainWindow::setTheme(const QString &name){ + + // Get root object + if (!rootObject()) { + qWarning() << "Could not retrieve settableProperties: There is no root object."; + return; + } + + // Let qml apply the theme + QMetaObject::invokeMethod(rootObject(), "setTheme", Q_ARG(QVariant, QVariant::fromValue(name))); + + // Save all current poperties in the group with this style id + QSettings s(plugin_->configLocation().filePath(STYLE_CONFIG_NAME), QSettings::Format::IniFormat); + QString styleId = QFileInfo(source().toString()).dir().dirName(); + s.beginGroup(styleId); + for (const QString &prop : settableProperties()) + s.setValue(prop, property(prop.toLatin1().data())); +} + + +/** ***************************************************************************/ +void QmlBoxModel::MainWindow::setModel(QAbstractItemModel *model) { + model_.setSourceModel(model); +} + + +/** ***************************************************************************/ +bool QmlBoxModel::MainWindow::event(QEvent *event) { + switch (event->type()) + { + // Quit on Alt+F4 + case QEvent::Close: + ( hideOnClose_ ) ? setVisible(false) : qApp->quit(); + return true; + + // Hide window on escape key + case QEvent::KeyPress: + if ( static_cast(event)->modifiers() == Qt::NoModifier + && static_cast(event)->key() == Qt::Key_Escape ){ + hide(); + return true; + } + break; + default:break; + } + return QQuickView::event(event); +} + + +#ifdef Q_OS_LINUX +/** **************************************************************************** + * @brief MainWidget::nativeEvent + * + * The purpose of this function is to hide in special casesonly. + */ +bool QmlBoxModel::MainWindow::nativeEvent(const QByteArray &eventType, void *message, long *) +{ + if (eventType == "xcb_generic_event_t") + { + xcb_generic_event_t* event = static_cast(message); + switch (event->response_type & 127) + { + case XCB_FOCUS_OUT: { + /* This is a horribly hackish but working solution. + + A triggered key grab on X11 steals the focus of the window for short + period of time. This may result in the following annoying behaviour: + When the hotkey is pressed and X11 steals the focus there arises a + race condition between the hotkey event and the focus out event. + When the app is visible and the focus out event is delivered the app + gets hidden. Finally when the hotkey is received the app gets shown + again although the user intended to hide the app with the hotkey. + + Solutions: + Although X11 differs between the two focus out events, qt does not. + One might install a native event filter and use the XCB structs to + decide which type of event is delivered, but this approach is not + platform independent (unless designed so explicitely, but its a + hassle). The behaviour was expected when the app hides on: + + (mode==XCB_NOTIFY_MODE_GRAB && detail==XCB_NOTIFY_DETAIL_NONLINEAR)|| + (mode==XCB_NOTIFY_MODE_NORMAL && detail==XCB_NOTIFY_DETAIL_NONLINEAR) + (Check Xlib Programming Manual) + + Another much simpler but less elegant solution is to delay the + hiding a few milliseconds, so that the hotkey event will always be + handled first. */ + + xcb_focus_out_event_t *fe = reinterpret_cast(event); +// qDebug() << "MainWidget::nativeEvent::XCB_FOCUS_OUT\t"; +// switch (fe->mode) { +// case XCB_NOTIFY_MODE_NORMAL: qDebug() << "XCB_NOTIFY_MODE_NORMAL";break; +// case XCB_NOTIFY_MODE_GRAB: qDebug() << "XCB_NOTIFY_MODE_GRAB";break; +// case XCB_NOTIFY_MODE_UNGRAB: qDebug() << "XCB_NOTIFY_MODE_UNGRAB";break; +// case XCB_NOTIFY_MODE_WHILE_GRABBED: qDebug() << "XCB_NOTIFY_MODE_WHILE_GRABBED";break; +// } +// switch (fe->detail) { +// case XCB_NOTIFY_DETAIL_ANCESTOR: qDebug() << "ANCESTOR";break; +// case XCB_NOTIFY_DETAIL_INFERIOR: qDebug() << "INFERIOR";break; +// case XCB_NOTIFY_DETAIL_NONE: qDebug() << "NONE";break; +// case XCB_NOTIFY_DETAIL_NONLINEAR: qDebug() << "NONLINEAR";break; +// case XCB_NOTIFY_DETAIL_NONLINEAR_VIRTUAL: qDebug() << "NONLINEAR_VIRTUAL";break; +// case XCB_NOTIFY_DETAIL_POINTER: qDebug() << "POINTER";break;break; +// case XCB_NOTIFY_DETAIL_POINTER_ROOT: qDebug() << "POINTER_ROOT"; +// case XCB_NOTIFY_DETAIL_VIRTUAL: qDebug() << "VIRTUAL";break; +// } + if ((/*(fe->mode==XCB_NOTIFY_MODE_GRAB && fe->detail==XCB_NOTIFY_DETAIL_NONLINEAR) ||*/ + (fe->mode==XCB_NOTIFY_MODE_NORMAL && fe->detail==XCB_NOTIFY_DETAIL_NONLINEAR )) && + hideOnFocusLoss_) + hide(); + return true; + } + } + } + return false; +} +#endif + + +/** ***************************************************************************/ +void QmlBoxModel::MainWindow::resizeEvent(QResizeEvent *event) { + + QQuickView::resizeEvent(event); + +#ifdef __unix__ + + // Get root object + if (!rootObject()) { + qWarning() << "Could not retrieve settableProperties: There is no root object."; + return; + } + + // Get preferences object + QObject *frameObject = rootObject()->findChild(FRAME_OBJ_NAME, Qt::FindChildrenRecursively); + if (frameObject) { + // Keep the input shape consistent + int shape_event_base, shape_error_base; + if (XShapeQueryExtension(QX11Info::display(), &shape_event_base, &shape_error_base)) { + + Region region = XCreateRegion(); + XRectangle rectangle; + double scalefactor = devicePixelRatio(); + rectangle.x = static_cast(frameObject->property("x").toUInt()*scalefactor); + rectangle.y = static_cast(frameObject->property("y").toUInt()*scalefactor); + rectangle.width = static_cast(frameObject->property("width").toUInt()*scalefactor); + rectangle.height = static_cast(frameObject->property("height").toUInt()*scalefactor); + XUnionRectWithRegion(&rectangle, region, region); + XShapeCombineRegion(QX11Info::display(), winId(), ShapeInput, 0, 0, region, ShapeSet); + XDestroyRegion(region); + } + } else + qWarning() << qPrintable(QString("Could not retrieve settableProperties: " + "There is no object named '%1'.").arg(FRAME_OBJ_NAME)); +#endif + +} + + +/** ***************************************************************************/ +bool QmlBoxModel::MainWindow::alwaysOnTop() const { + return flags() & Qt::WindowStaysOnTopHint; +} + + +/** ***************************************************************************/ +void QmlBoxModel::MainWindow::setAlwaysOnTop(bool alwaysOnTop) { + + plugin_->settings().setValue(CFG_ALWAYS_ON_TOP, alwaysOnTop); + + alwaysOnTop + ? setFlags(flags() | Qt::WindowStaysOnTopHint) + : setFlags(flags() & ~Qt::WindowStaysOnTopHint); + // Flags changed. Update + QQuickView::hide(); +} + + +/** ***************************************************************************/ +bool QmlBoxModel::MainWindow::hideOnFocusLoss() const { + return hideOnFocusLoss_; +} + + +/** ***************************************************************************/ +void QmlBoxModel::MainWindow::setHideOnFocusLoss(bool hideOnFocusLoss) { + plugin_->settings().setValue(CFG_HIDEONFOCUSLOSS, hideOnFocusLoss); + hideOnFocusLoss_ = hideOnFocusLoss; +} + + +/** ***************************************************************************/ +bool QmlBoxModel::MainWindow::showCentered() const { + return showCentered_; +} + + +/** ***************************************************************************/ +void QmlBoxModel::MainWindow::setShowCentered(bool showCentered) { + plugin_->settings().setValue(CFG_CENTERED, showCentered); + showCentered_ = showCentered; +} + + +/** ***************************************************************************/ +bool QmlBoxModel::MainWindow::hideOnClose() const { + return hideOnClose_; +} + + +/** ***************************************************************************/ +void QmlBoxModel::MainWindow::setHideOnClose(bool hideOnClose) { + plugin_->settings().setValue(CFG_HIDE_ON_CLOSE, hideOnClose); + hideOnClose_ = hideOnClose; +} + + +/** ***************************************************************************/ +bool QmlBoxModel::MainWindow::clearOnHide() const { + return clearOnHide_; +} + + +/** ***************************************************************************/ +void QmlBoxModel::MainWindow::setClearOnHide(bool b) { + plugin_->settings().setValue(CFG_CLEAR_ON_HIDE, b); + clearOnHide_ = b; +} diff --git a/plugins/qmlboxmodel/src/mainwindow.h b/plugins/qmlboxmodel/src/mainwindow.h new file mode 100644 index 0000000..e7b65b3 --- /dev/null +++ b/plugins/qmlboxmodel/src/mainwindow.h @@ -0,0 +1,84 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include +#include "albert/util/history.h" + +namespace QmlBoxModel { + +struct QmlStyleSpec { + QString name; + QString version; + QString author; + QString mainComponent; +}; + +class FrontendPlugin; + +class MainWindow final : public QQuickView +{ + Q_OBJECT + +public: + + MainWindow(FrontendPlugin *plugin, QWindow *parent = 0); + ~MainWindow(); + + QString input(); + void setInput(const QString&); + void setModel(QAbstractItemModel* model); + + const std::vector &availableStyles() const; + QStringList settableProperties(); + + QVariant property(const char *name) const; + void setProperty(const char *attribute, const QVariant &value); + + QStringList availableThemes(); + void setTheme(const QString& name); + + void setSource(const QUrl & url); + + bool showCentered() const; + void setShowCentered(bool showCentered); + + bool hideOnFocusLoss() const; + void setHideOnFocusLoss(bool hideOnFocusLoss); + + bool hideOnClose() const; + void setHideOnClose(bool b = true); + + bool clearOnHide() const; + void setClearOnHide(bool b = true); + + bool alwaysOnTop() const; + void setAlwaysOnTop(bool alwaysOnTop); + +protected: + + bool event(QEvent *event) override; + bool nativeEvent(const QByteArray &eventType, void *message, long *) override; + void resizeEvent(QResizeEvent *event) override; + + bool showCentered_; + bool hideOnFocusLoss_; + bool hideOnClose_; + bool clearOnHide_; + Core::History history_; + QIdentityProxyModel model_; + std::vector styles_; + QFileSystemWatcher watcher_; + FrontendPlugin *plugin_; + +signals: + + void inputChanged(); + void settingsWidgetRequested(); + +}; + +} diff --git a/plugins/qmlboxmodel/src/propertyeditor.cpp b/plugins/qmlboxmodel/src/propertyeditor.cpp new file mode 100644 index 0000000..4438784 --- /dev/null +++ b/plugins/qmlboxmodel/src/propertyeditor.cpp @@ -0,0 +1,109 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "propertyeditor.h" +#include "mainwindow.h" +#include "colordialog.hpp" +#include +#include +#include +#include +#include +#include + +namespace QmlBoxModel { + +class PropertyModel final : public QAbstractTableModel +{ +public: + PropertyModel(MainWindow *mainWindow, QObject * parent = 0) + : QAbstractTableModel(parent), mainWindow_(mainWindow){ + properties_ = mainWindow_->settableProperties(); + } + + ~PropertyModel() { + + } + + int rowCount(const QModelIndex & parent = QModelIndex()) const override { + Q_UNUSED(parent) + return properties_.count(); + } + + int columnCount(const QModelIndex & parent = QModelIndex()) const override { + Q_UNUSED(parent) + return 2; + } + + QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const override { + if (role == Qt::DisplayRole || role == Qt::EditRole) { + if ( index.column() == 0 ) + return properties_[index.row()]; + else if (index.column()==1) + return mainWindow_->property(properties_.at(index.row()).toLatin1().data()); + } + return QVariant(); + } + + QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override { + if (orientation == Qt::Horizontal && role == Qt::DisplayRole){ + if (section==0) + return "Property"; + if (section==1) + return "Value"; + } + return QVariant(); + } + + bool setData(const QModelIndex & index, const QVariant & value, int role = Qt::EditRole) override { + if (role == Qt::EditRole){ + mainWindow_->setProperty(properties_[index.row()].toLatin1().data(), value); + return true; + } + return true; + } + + Qt::ItemFlags flags(const QModelIndex & index) const override { + if (index.column()==0) + return Qt::NoItemFlags|Qt::ItemIsEnabled; + if (index.column()==1) + return Qt::ItemIsEditable|Qt::ItemIsEnabled; + return Qt::NoItemFlags; + } + +private: + MainWindow *mainWindow_; + QStringList properties_; +}; + +} + + + +///****************************************************************************/ +QmlBoxModel::PropertyEditor::PropertyEditor(MainWindow *mainWindow, QWidget *parent) + : QDialog (parent){ + + resize(320, 480); + setWindowTitle("PropertyEditor"); + + QTableView *tableView = new QTableView(this); + tableView->setObjectName(QStringLiteral("tableView")); + tableView->horizontalHeader()->setSectionResizeMode(QHeaderView::ResizeToContents); + tableView->verticalHeader()->setSectionResizeMode(QHeaderView::ResizeToContents); + tableView->horizontalHeader()->setStretchLastSection(true); + tableView->setAlternatingRowColors(true); + tableView->setShowGrid(false); + tableView->horizontalHeader()->setMinimumSectionSize(16); + tableView->setModel(new PropertyModel(mainWindow, tableView)); + + QVBoxLayout *layout = new QVBoxLayout(this); + layout->addWidget(tableView); + + QItemEditorFactory *editorFactory = new QItemEditorFactory; + editorFactory->registerEditor(QVariant::Color, new QStandardItemEditorCreator()); + + // Create a delgate using the factory + QStyledItemDelegate *delegate = new QStyledItemDelegate(this); + delegate->setItemEditorFactory(editorFactory); + tableView->setItemDelegate(delegate); +} diff --git a/plugins/qmlboxmodel/src/propertyeditor.h b/plugins/qmlboxmodel/src/propertyeditor.h new file mode 100644 index 0000000..3673618 --- /dev/null +++ b/plugins/qmlboxmodel/src/propertyeditor.h @@ -0,0 +1,18 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include + +namespace QmlBoxModel { + +class MainWindow; + +class PropertyEditor : public QDialog +{ + Q_OBJECT + +public: + explicit PropertyEditor(MainWindow *mainWindow, QWidget *parent = 0); +}; + +} diff --git a/plugins/snippets/CMakeLists.txt b/plugins/snippets/CMakeLists.txt new file mode 100644 index 0000000..6588f79 --- /dev/null +++ b/plugins/snippets/CMakeLists.txt @@ -0,0 +1,20 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(snippets) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets Sql) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Sql + Qt5::Widgets + albert::lib +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) diff --git a/plugins/snippets/metadata.json b/plugins/snippets/metadata.json new file mode 100644 index 0000000..88ba1b0 --- /dev/null +++ b/plugins/snippets/metadata.json @@ -0,0 +1,9 @@ +{ + "id" : "org.albert.extension.snippets", + "name" : "Snippets", + "version" : "1.0", + "platform" : "All", + "group" : "Extensions", + "author" : "manuelschneid3r", + "dependencies" : [] +} diff --git a/plugins/snippets/resources/snippet.svg b/plugins/snippets/resources/snippet.svg new file mode 100644 index 0000000..fabc497 --- /dev/null +++ b/plugins/snippets/resources/snippet.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/snippets/snippets.qrc b/plugins/snippets/snippets.qrc new file mode 100644 index 0000000..8e54fae --- /dev/null +++ b/plugins/snippets/snippets.qrc @@ -0,0 +1,5 @@ + + + resources/snippet.svg + + diff --git a/plugins/snippets/src/configwidget.cpp b/plugins/snippets/src/configwidget.cpp new file mode 100644 index 0000000..02a3260 --- /dev/null +++ b/plugins/snippets/src/configwidget.cpp @@ -0,0 +1,82 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include "configwidget.h" +#include "snippeteditordialog.h" + + +/** ***************************************************************************/ +Snippets::ConfigWidget::ConfigWidget(QSqlDatabase *db, QWidget *parent) : QWidget(parent) { + ui.setupUi(this); + + model = new QSqlTableModel(this, *db); + model->setTable("snippets"); + model->setHeaderData(0, Qt::Horizontal, tr("Title")); + model->setHeaderData(1, Qt::Horizontal, tr("Text")); + model->select(); + + proxyModel = new QSortFilterProxyModel(this); + proxyModel->setSortCaseSensitivity(Qt::CaseInsensitive); + proxyModel->setSourceModel(model); + + ui.tableView->horizontalHeader()->setSectionResizeMode(QHeaderView::ResizeToContents); + ui.tableView->verticalHeader()->setSectionResizeMode(QHeaderView::ResizeToContents); + ui.tableView->setModel(proxyModel); + ui.tableView->sortByColumn(0, Qt::SortOrder::AscendingOrder); + + connect(ui.tableView, &QTableView::activated, + this, &ConfigWidget::onItemActivated); + + connect(ui.toolButton_add, &QToolButton::clicked, + this, &ConfigWidget::onAddClicked); + + connect(ui.toolButton_remove, &QToolButton::clicked, + this, &ConfigWidget::onRemoveClicked); +} + +/** ***************************************************************************/ +Snippets::ConfigWidget::~ConfigWidget() { + +} + +/** ***************************************************************************/ +void Snippets::ConfigWidget::onItemActivated(QModelIndex index) { + + QModelIndex keywordIdx = proxyModel->index(index.row(), 0); + QModelIndex snippetIdx = proxyModel->index(index.row(), 1); + SnippetEditorDialog editor; + + editor.ui.lineEdit->setText(keywordIdx.data().toString()); + editor.ui.plainTextEdit->setPlainText(snippetIdx.data().toString()); + + if (editor.exec()) { + proxyModel->setData(keywordIdx, editor.ui.lineEdit->text()); + proxyModel->setData(snippetIdx, editor.ui.plainTextEdit->toPlainText()); + model->submitAll(); + } +} + +/** ***************************************************************************/ +void Snippets::ConfigWidget::onAddClicked() { + SnippetEditorDialog editor; + if (editor.exec()) { + int row = model->rowCount(); + model->insertRow(row); + model->setData(model->index(row, 0), editor.ui.lineEdit->text()); + model->setData(model->index(row, 1), editor.ui.plainTextEdit->toPlainText()); + model->submitAll(); + + // Update view + model->select(); + } +} + +/** ***************************************************************************/ +void Snippets::ConfigWidget::onRemoveClicked() { + QModelIndex idx = ui.tableView->currentIndex(); + if (idx.isValid()) + proxyModel->removeRows(idx.row(), 1); + + // Update view + model->select(); +} diff --git a/plugins/snippets/src/configwidget.h b/plugins/snippets/src/configwidget.h new file mode 100644 index 0000000..16e62ca --- /dev/null +++ b/plugins/snippets/src/configwidget.h @@ -0,0 +1,31 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include "ui_configwidget.h" + +namespace Snippets { +class ConfigWidget final : public QWidget +{ + Q_OBJECT + +public: + + explicit ConfigWidget(QSqlDatabase *db, QWidget *parent = nullptr); + ~ConfigWidget(); + Ui::ConfigWidget ui; + +private: + + void onItemActivated(QModelIndex); + void onAddClicked(); + void onRemoveClicked(); + + QSqlTableModel *model; + QSortFilterProxyModel *proxyModel; + +}; +} diff --git a/plugins/snippets/src/configwidget.ui b/plugins/snippets/src/configwidget.ui new file mode 100644 index 0000000..c5749f2 --- /dev/null +++ b/plugins/snippets/src/configwidget.ui @@ -0,0 +1,92 @@ + + + Snippets::ConfigWidget + + + + 0 + 0 + 743 + 445 + + + + + + + <html><head/><body><p>With this extension you can store text snippets and look them up by their title. Using the trigger &quot;snip &quot; you can list all snippets. Further characters are used as a filter. Note that the lookup works without the trigger too.</p></body></html> + + + true + + + + + + + QAbstractItemView::NoEditTriggers + + + true + + + QAbstractItemView::SingleSelection + + + QAbstractItemView::SelectRows + + + false + + + false + + + true + + + false + + + + + + + + + + .. + + + + + + + ... + + + + .. + + + + + + + Qt::Horizontal + + + + 40 + 20 + + + + + + + + + + + diff --git a/plugins/snippets/src/extension.cpp b/plugins/snippets/src/extension.cpp new file mode 100644 index 0000000..feccf59 --- /dev/null +++ b/plugins/snippets/src/extension.cpp @@ -0,0 +1,189 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "configwidget.h" +#include "albert/util/standardactions.h" +#include "albert/util/standarditem.h" +#include "extension.h" +#include +using namespace std; +using namespace Core; + +namespace { +const QString trigger = "snip "; +mutex db_mutex; +} + + +class Snippets::Private +{ +public: + QPointer widget; + QSqlDatabase db; +}; + + +/** ***************************************************************************/ +Snippets::Extension::Extension() + : Core::Extension("org.albert.extension.snippets"), // Must match the id in metadata + Core::QueryHandler(Plugin::id()), + d(new Private) { + + // Check if sqlite is available + d->db = QSqlDatabase::addDatabase("QSQLITE", Plugin::id()); + if ( !d->db.isValid() ) + throw("No SQLite driver available"); + + + // Port config to new name + QDir configDir(QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation)); + QString oldId = "org.albert.extension.kvstore"; + if (!configDir.exists(Plugin::id()) && configDir.exists(oldId)){ + + // Rename database and folder + configDir.cd(oldId); + configDir.rename("kvstore.db", "snippets.db"); + + // Rename config dir + configDir.cdUp(); + configDir.rename(oldId, Plugin::id()); + + d->db.setDatabaseName(configLocation().filePath("snippets.db")); + if (!d->db.open()) + throw("Unable to establish a database connection."); + + // Create tables + d->db.exec("CREATE TABLE snippets (title TEXT PRIMARY KEY, text NOT NULL);"); + d->db.exec("INSERT INTO snippets SELECT * FROM kv;"); + d->db.exec("DROP TABLE kv;"); + } + + d->db.setDatabaseName(configLocation().filePath("snippets.db")); + if (!d->db.open()) + throw("Unable to establish a database connection."); + + // Create tables + QSqlQuery q(d->db); + if (!q.exec("CREATE TABLE IF NOT EXISTS snippets (title TEXT PRIMARY KEY, text NOT NULL);")) + throw("Unable to create table."); + + registerQueryHandler(this); +} + + +/** ***************************************************************************/ +Snippets::Extension::~Extension() { + d->db.close(); +} + + +/** ***************************************************************************/ +QWidget *Snippets::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) { + d->widget = new ConfigWidget(&d->db, parent); + } + return d->widget; +} + +/** ***************************************************************************/ +QStringList Snippets::Extension::triggers() const { + return { trigger }; +} + + +/** ***************************************************************************/ +void Snippets::Extension::handleQuery(Core::Query * query) const { + +// if ( query->isTriggered() ) { + +// QString sec1 = query->string().section(' ', 0, 0, QString::SectionSkipEmpty); + +// // SETTING +// if ( sec1 == "set" ){ +// QString key = query->string().section(' ', 1, 1, QString::SectionSkipEmpty); +// QString value = query->string().section(' ', 2, -1, QString::SectionSkipEmpty); + +// if ( key.isEmpty() || value.isEmpty() ) +// return; + +// auto item = std::make_shared(); +// item->setText(QString("Set '%1': '%2'").arg(key, value)); +// item->setSubtext(QString("Store this mapping in the database.")); +// item->setIconPath(":snippet"); +// item->setCompletion(query->string()); +// item->addAction(make_shared("Add mapping to the database", +// [this, key, value](){ +// QSqlQuery q(d->db); +// q.prepare(insertStmt); +// q.bindValue(":key", key); +// q.bindValue(":value", value); +// q.exec(); +// if (this->d->widget) +// this->d->widget->updateTable(); +// })); + +// query->addMatch(move(item)); +// } + +// // UNSETTING +// else if ( sec1 == "unset" ){ +// QString searchterm = query->string().section(' ', 1, -1, QString::SectionSkipEmpty); +// QSqlQuery q(d->db); +// q.exec(QString("SELECT key, value FROM kv WHERE key LIKE '%1%'").arg(searchterm)); +// while ( q.next() ){ +// QString key = q.value(0).toString(); + +// auto item = std::make_shared(); +// item->setText(QString("Unset '%1': '%2'").arg(key, q.value(1).toString())); +// item->setSubtext(QString("Remove this mapping from the database.")); +// item->setIconPath(":snippet"); +// item->setCompletion(QString("%1 unset %2").arg(trigger, key)); +// item->addAction(make_shared("Remove mapping from database", +// [this, key](){ +// QSqlQuery q(d->db); +// q.prepare(removeStmt); +// q.bindValue(":key", key); +// q.exec(); +// if (this->d->widget) +// this->d->widget->updateTable(); +// })); + +// query->addMatch(move(item), static_cast(1.0/key.length()*searchterm.length())); +// } +// } +// } + + // LOOKUP + + // Allow empty lookup only for triggered queries + if (query->string().trimmed().isEmpty() && !query->isTriggered()) + return; + + unique_lock lock(db_mutex); + + QSqlQuery q(d->db); + q.exec(QString("SELECT * FROM snippets WHERE title LIKE '%%%1%%'").arg(query->string())); + QRegularExpression re(QString("(%1)").arg(query->string()), QRegularExpression::CaseInsensitiveOption); + while ( q.next() ){ + QString key = q.value(0).toString(); + QString value = q.value(1).toString(); + + auto item = std::make_shared(QString("%1_%2").arg(Plugin::id(), key)); + item->setText(QString("Text snippet '%1'").arg(QString(key).replace(re, "\\1"))); + item->setSubtext("Copy the snippet to clipboard"); + item->setIconPath(":snippet"); + item->setCompletion(QString("%1%2").arg(trigger, key)); + item->addAction(make_shared("Copy value to clipboard", value)); + + query->addMatch(move(item), static_cast(1.0/key.length()*query->string().length())); + } +} + diff --git a/plugins/snippets/src/extension.h b/plugins/snippets/src/extension.h new file mode 100644 index 0000000..09b7075 --- /dev/null +++ b/plugins/snippets/src/extension.h @@ -0,0 +1,35 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +namespace Snippets { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension(); + + QString name() const override { return "Snippets"; } + QWidget *widget(QWidget *parent = nullptr) override; + QStringList triggers() const override; + void handleQuery(Core::Query * query) const override; + +private: + + std::unique_ptr d; + +}; +} diff --git a/plugins/snippets/src/snippeteditordialog.cpp b/plugins/snippets/src/snippeteditordialog.cpp new file mode 100644 index 0000000..8da331f --- /dev/null +++ b/plugins/snippets/src/snippeteditordialog.cpp @@ -0,0 +1,26 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "snippeteditordialog.h" +#include + +/** ***************************************************************************/ +Snippets::SnippetEditorDialog::SnippetEditorDialog(QWidget *parent) : QDialog(parent) { + ui.setupUi(this); +} + + +/** ***************************************************************************/ +Snippets::SnippetEditorDialog::~SnippetEditorDialog() { + +} + + +/** ***************************************************************************/ +void Snippets::SnippetEditorDialog::accept() +{ + if (ui.lineEdit->text().trimmed().isEmpty()) + QMessageBox::information(this, tr("Empty title."), + tr("The title field must not be empty.")); + else + QDialog::accept(); +} diff --git a/plugins/snippets/src/snippeteditordialog.h b/plugins/snippets/src/snippeteditordialog.h new file mode 100644 index 0000000..e7ea11e --- /dev/null +++ b/plugins/snippets/src/snippeteditordialog.h @@ -0,0 +1,22 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include "ui_snippeteditordialog.h" + +namespace Snippets { +class SnippetEditorDialog final : public QDialog +{ + Q_OBJECT + +public: + + SnippetEditorDialog(QWidget *parent = nullptr); + ~SnippetEditorDialog(); + Ui::SnippetEditorDialog ui; + +protected: + + void accept() override; + +}; +} diff --git a/plugins/snippets/src/snippeteditordialog.ui b/plugins/snippets/src/snippeteditordialog.ui new file mode 100644 index 0000000..a8e4777 --- /dev/null +++ b/plugins/snippets/src/snippeteditordialog.ui @@ -0,0 +1,99 @@ + + + Snippets::SnippetEditorDialog + + + + 0 + 0 + 451 + 402 + + + + Snippet editor + + + + + + + + Title: + + + + + + + The keyword used to lookup the snippet… + + + + + + + Text: + + + Qt::AlignRight|Qt::AlignTop|Qt::AlignTrailing + + + + + + + Put snippet here… + + + + + + + + + Qt::Horizontal + + + QDialogButtonBox::Cancel|QDialogButtonBox::Ok + + + + + + + + + buttonBox + accepted() + Snippets::SnippetEditorDialog + accept() + + + 248 + 254 + + + 157 + 274 + + + + + buttonBox + rejected() + Snippets::SnippetEditorDialog + reject() + + + 316 + 260 + + + 286 + 274 + + + + + diff --git a/plugins/ssh/CMakeLists.txt b/plugins/ssh/CMakeLists.txt new file mode 100644 index 0000000..1d93516 --- /dev/null +++ b/plugins/ssh/CMakeLists.txt @@ -0,0 +1,20 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(ssh) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Widgets + albert::lib + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) diff --git a/plugins/ssh/metadata.json b/plugins/ssh/metadata.json new file mode 100644 index 0000000..18f896b --- /dev/null +++ b/plugins/ssh/metadata.json @@ -0,0 +1,10 @@ +{ + "id" : "org.albert.extension.ssh", + "name" : "Secure Shell", + "version" : "1.1", + "platform" : "All", + "group" : "Extensions", + "author" : "Manuel Schneider", + "dependencies" : [], + "enabledbydefault": true +} diff --git a/plugins/ssh/resources/ssh.svg b/plugins/ssh/resources/ssh.svg new file mode 100644 index 0000000..d17d953 --- /dev/null +++ b/plugins/ssh/resources/ssh.svg @@ -0,0 +1,741 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/plugins/ssh/src/configwidget.cpp b/plugins/ssh/src/configwidget.cpp new file mode 100644 index 0000000..f9ead10 --- /dev/null +++ b/plugins/ssh/src/configwidget.cpp @@ -0,0 +1,15 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "configwidget.h" + +/** ***************************************************************************/ +Ssh::ConfigWidget::ConfigWidget(QWidget *parent) : QWidget(parent) { + ui.setupUi(this); +} + + + +/** ***************************************************************************/ +Ssh::ConfigWidget::~ConfigWidget() { + +} diff --git a/plugins/ssh/src/configwidget.h b/plugins/ssh/src/configwidget.h new file mode 100644 index 0000000..c5e7678 --- /dev/null +++ b/plugins/ssh/src/configwidget.h @@ -0,0 +1,18 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" + +namespace Ssh { + +class ConfigWidget final : public QWidget +{ + Q_OBJECT +public: + explicit ConfigWidget(QWidget *parent = 0); + ~ConfigWidget(); + Ui::ConfigWidget ui; +}; + +} diff --git a/plugins/ssh/src/configwidget.ui b/plugins/ssh/src/configwidget.ui new file mode 100644 index 0000000..0c23522 --- /dev/null +++ b/plugins/ssh/src/configwidget.ui @@ -0,0 +1,53 @@ + + + Ssh::ConfigWidget + + + + + + This extension scans your /etc/ssh/config and ~/.ssh/config and makes your ssh hosts accessible by Albert. This is a pure convenience extension. If you want to use ssh to the full extend consider using it directly via the Terminal extension. + + + true + + + + + + + Use 'known_hosts' + + + + + + + + 0 + 0 + + + + Rescan + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + diff --git a/plugins/ssh/src/extension.cpp b/plugins/ssh/src/extension.cpp new file mode 100644 index 0000000..0158bc1 --- /dev/null +++ b/plugins/ssh/src/extension.cpp @@ -0,0 +1,244 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "extension.h" +#include "configwidget.h" +#include "albert/util/standardactions.h" +#include "albert/util/standarditem.h" +#include "albert/util/shutil.h" +#include "xdg/iconlookup.h" +using namespace std; +using namespace Core; + +extern QString terminalCommand; + +namespace { +const char* CFG_USE_KNOWN_HOSTS = "use_known_hosts"; +const bool DEF_USE_KNOWN_HOSTS = true; +} + +class Ssh::Private +{ +public: + QString icon; + QPointer widget; + QFileSystemWatcher fileSystemWatcher; + vector> hosts; + bool useKnownHosts; +}; + + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +Ssh::Extension::Extension() + : Core::Extension("org.albert.extension.ssh"), + QueryHandler(Plugin::id()), + d(new Private) { + + registerQueryHandler(this); + + // Load settings + d->useKnownHosts = settings().value(CFG_USE_KNOWN_HOSTS, DEF_USE_KNOWN_HOSTS).toBool(); + + // Find ssh + if (QStandardPaths::findExecutable("ssh").isNull()) + throw QString("[%s] ssh not found.").arg(Plugin::id()); + + // Find an appropriate icon + d->icon = XDG::IconLookup::iconPath({"ssh", "terminal"}); + if (d->icon.isEmpty()) + d->icon = ":ssh"; // Fallback + + rescan(); +} + + + +/** ***************************************************************************/ +Ssh::Extension::~Extension() { + +} + + + +/** ***************************************************************************/ +QWidget *Ssh::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) { + d->widget = new ConfigWidget(parent); + + // Checkboxes + d->widget->ui.checkBox_knownhosts->setChecked(useKnownHosts()); + connect(d->widget->ui.checkBox_knownhosts, &QCheckBox::toggled, + this, &Extension::setUseKnownHosts); + connect(d->widget->ui.pushButton_rescan, &QPushButton::clicked, + this, &Extension::rescan); + + } + return d->widget; +} + + + +/** ***************************************************************************/ +void Ssh::Extension::handleQuery(Query * query) const { + + QString trimmed = query->string().trimmed(); + + if (trimmed.isEmpty()) { + if (query->isTriggered()) { + for (const auto &pair : d->hosts) { + + const QString &host = pair.first; + const QString &port = pair.second; + + QString target = port.isEmpty() ? host : QString("[%1]:%2").arg(host, port); + + auto item = std::make_shared("ssh_" + target); + item->setText(target); + item->setSubtext(QString("Connect to '%1'").arg(target)); + item->setCompletion(QString("ssh %1").arg(target)); + item->setIconPath(d->icon); + item->addAction(make_shared(QString("Connect to '%1'").arg(target), + QStringList{"ssh", target})); + + query->addMatch(std::move(item)); + } + } + } + else + { + // Check sanity of input + QRegularExpression re(R"raw(^(?:(\w+)@)?\[?((?:\w[\w:]*|[\w\.]*))\]?(?::(\d+))?$)raw"); + QRegularExpressionMatch match = re.match(trimmed); + + if (match.hasMatch()) + { + QString q_user = match.captured(1); + QString q_host = match.captured(2); + QString q_port = match.captured(3); + + // Show all hosts matching the query + for (const auto &pair : d->hosts) { + + const QString &host = pair.first; + const QString &port = pair.second; + + if (host.startsWith(q_host, Qt::CaseInsensitive)) + { + auto item = std::make_shared("ssh_"+host); + item->setText(host); + item->setIconPath(d->icon); + + QString target = host; + if (!q_port.isEmpty()) + target = QString("[%1]:%2").arg(target, q_port); + else if (!port.isEmpty()) + target = QString("[%1]:%2").arg(target, port); + if (!q_user.isEmpty()) + target = QString("%1@%2").arg(q_user, target); + QString subtext = QString("Connect to '%1'").arg(target); + + item->setSubtext(subtext); + item->setCompletion(QString("ssh %1").arg(target)); + item->addAction(make_shared(subtext, QStringList{"ssh", target})); + + query->addMatch(std::move(item), static_cast(1.0*q_host.size()/host.size()* UINT_MAX)); + } + } + + if (query->isTriggered() && !q_host.isEmpty()) { + // Add the quick connect item + auto item = std::make_shared(); + item->setText(trimmed); + item->setSubtext("Quick connect to an unknown host"); + item->setCompletion(QString("ssh %1").arg(trimmed)); + item->setIconPath(d->icon); + item->addAction(make_shared(QString("Connect to '%1'").arg(match.captured(0)), + QStringList{"ssh", trimmed})); + query->addMatch(std::move(item)); + } + } + } +} + + + +/** ***************************************************************************/ +void Ssh::Extension::rescan() { + + map hosts; + + // Get the hosts in config + for (const QString& path : { QString("/etc/ssh/config"), QDir::home().filePath(".ssh/config") }) { + if (QFile::exists(path)) { + QFile file(path); + if (file.open(QIODevice::ReadOnly | QIODevice::Text)) { + QTextStream in(&file); + while (!in.atEnd()) { + QStringList fields = in.readLine().split(QRegularExpression("\\s+"), QString::SkipEmptyParts); + if ( fields.size() > 1 && fields[0] == "Host") + for ( int i = 1; i < fields.size(); ++i ) + if ( !(fields[i].contains('*') || fields[i].contains('?')) ) + hosts.emplace(fields[i], QString()); + } + file.close(); + } + } + } + + // Get the hosts in known_hosts + if (d->useKnownHosts) { + const QString& path = QDir::home().filePath(".ssh/known_hosts"); + if (QFile::exists(path)){ + QFile file(path); + if (file.open(QIODevice::ReadOnly | QIODevice::Text)) { + QRegularExpression re(R"raw(^\[?([\w\-\.\:]+)\]?(?::(\d+))?)raw"); + QTextStream in(&file); + while (!in.atEnd()) { + QRegularExpressionMatch match = re.match(in.readLine()); + if (match.hasMatch()) + hosts.emplace(match.captured(1), match.captured(2)); + } + file.close(); + } + } + } + + d->hosts = vector>{hosts.begin(), hosts.end()}; + + // Sort by length and lexical + std::sort(d->hosts.begin(), d->hosts.end(), + [](const auto &li, const auto &ri){ return li.first < ri.first; }); + std::stable_sort(d->hosts.begin(), d->hosts.end(), + [](const auto &li, const auto &ri){ return li.first.size() < ri.first.size(); }); +} + + + +/** ***************************************************************************/ +bool Ssh::Extension::useKnownHosts() { + return d->useKnownHosts; +} + + + +/** ***************************************************************************/ +void Ssh::Extension::setUseKnownHosts(bool b) { + settings().setValue(CFG_USE_KNOWN_HOSTS, b); + d->useKnownHosts = b; + rescan(); +} diff --git a/plugins/ssh/src/extension.h b/plugins/ssh/src/extension.h new file mode 100644 index 0000000..f4cb98a --- /dev/null +++ b/plugins/ssh/src/extension.h @@ -0,0 +1,40 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +namespace Ssh { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension() override; + + QString name() const override { return "SecureShell"; } + QWidget *widget(QWidget *parent = nullptr) override; + QStringList triggers() const override { return {"ssh "}; } + void handleQuery(Core::Query * query) const override; + + void rescan(); + + bool useKnownHosts(); + void setUseKnownHosts(bool b = true); + +private: + + std::unique_ptr d; + +}; +} diff --git a/plugins/ssh/ssh.qrc b/plugins/ssh/ssh.qrc new file mode 100644 index 0000000..44406ad --- /dev/null +++ b/plugins/ssh/ssh.qrc @@ -0,0 +1,5 @@ + + + resources/ssh.svg + + diff --git a/plugins/system/CMakeLists.txt b/plugins/system/CMakeLists.txt new file mode 100644 index 0000000..186dfef --- /dev/null +++ b/plugins/system/CMakeLists.txt @@ -0,0 +1,20 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(system) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Widgets + albert::lib + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) diff --git a/plugins/system/metadata.json b/plugins/system/metadata.json new file mode 100644 index 0000000..82db8f3 --- /dev/null +++ b/plugins/system/metadata.json @@ -0,0 +1,10 @@ +{ + "id" : "org.albert.extension.system", + "name" : "System", + "version" : "1.0", + "platform" : "Linux", + "group" : "Extensions", + "author" : "Manuel Schneider", + "dependencies" : [], + "enabledbydefault": true +} diff --git a/plugins/system/resources/hibernate.svg b/plugins/system/resources/hibernate.svg new file mode 100644 index 0000000..8778785 --- /dev/null +++ b/plugins/system/resources/hibernate.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/system/resources/lock.svg b/plugins/system/resources/lock.svg new file mode 100644 index 0000000..efa4a64 --- /dev/null +++ b/plugins/system/resources/lock.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/system/resources/logout.svg b/plugins/system/resources/logout.svg new file mode 100644 index 0000000..4b56391 --- /dev/null +++ b/plugins/system/resources/logout.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/system/resources/poweroff.svg b/plugins/system/resources/poweroff.svg new file mode 100644 index 0000000..c464148 --- /dev/null +++ b/plugins/system/resources/poweroff.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/system/resources/reboot.svg b/plugins/system/resources/reboot.svg new file mode 100644 index 0000000..af22c16 --- /dev/null +++ b/plugins/system/resources/reboot.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/system/resources/suspend.svg b/plugins/system/resources/suspend.svg new file mode 100644 index 0000000..f2fb356 --- /dev/null +++ b/plugins/system/resources/suspend.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/system/src/configwidget.cpp b/plugins/system/src/configwidget.cpp new file mode 100644 index 0000000..82bd647 --- /dev/null +++ b/plugins/system/src/configwidget.cpp @@ -0,0 +1,15 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "configwidget.h" + +/** ***************************************************************************/ +System::ConfigWidget::ConfigWidget(QWidget *parent) : QWidget(parent) { + ui.setupUi(this); +} + + + +/** ***************************************************************************/ +System::ConfigWidget::~ConfigWidget() { + +} diff --git a/plugins/system/src/configwidget.h b/plugins/system/src/configwidget.h new file mode 100644 index 0000000..16fa408 --- /dev/null +++ b/plugins/system/src/configwidget.h @@ -0,0 +1,16 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" + +namespace System { +class ConfigWidget final : public QWidget +{ + Q_OBJECT +public: + explicit ConfigWidget(QWidget *parent = 0); + ~ConfigWidget(); + Ui::ConfigWidget ui; +}; +} diff --git a/plugins/system/src/configwidget.ui b/plugins/system/src/configwidget.ui new file mode 100644 index 0000000..77d82cf --- /dev/null +++ b/plugins/system/src/configwidget.ui @@ -0,0 +1,118 @@ + + + System::ConfigWidget + + + + + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + Suspend: + + + Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter + + + + + + + Lock: + + + Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter + + + + + + + + + + + + + Log out: + + + Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter + + + + + + + Shut down: + + + Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter + + + + + + + Restart: + + + Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter + + + + + + + + + + + + + + + + <html><head/><body><p><span style=" color:#808080;">Be aware that on most distributions the standard commands to control your systems state (e.g. reboot, shutdown, systemctl etc) do not shutdown your desktop session gracefully. Try to use your desktop session managers interface. If you think you know good defaults for your desktop environment, please suggest it on </span><a href="https://github.com/ManuelSchneid3r/albert/issues"><span style=" text-decoration: underline; color:#0000ff;">github</span></a><span style=" color:#808080;">.</span></p></body></html> + + + true + + + true + + + + + + + Hibernate: + + + Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter + + + + + + + + + + diff --git a/plugins/system/src/extension.cpp b/plugins/system/src/extension.cpp new file mode 100644 index 0000000..1813885 --- /dev/null +++ b/plugins/system/src/extension.cpp @@ -0,0 +1,252 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include "configwidget.h" +#include "extension.h" +#include "albert/util/shutil.h" +#include "albert/util/standardactions.h" +#include "albert/util/standarditem.h" +#include "xdg/iconlookup.h" +using namespace std; +using namespace Core; + + +namespace { + +const uint NUMCOMMANDS = 6; + +enum SupportedCommands { + LOCK, + LOGOUT, + SUSPEND, + HIBERNATE, + REBOOT, + POWEROFF, +}; + +array configNames{{ + "lock", + "logout", + "suspend", + "hibernate", + "reboot", + "shutdown" +}}; + +array itemTitles{{ + "Lock", + "Log out", + "Suspend", + "Hibernate", + "Restart", + "Shut down" +}}; + +array, 6> aliases{{ + {"lock"}, + {"log out", "logout", "leave"}, + {"suspend", "sleep"}, + {"suspend", "hibernate"}, + {"restart", "reboot"}, + {"shut down", "shutdown", "poweroff", "halt"} +}}; + +array itemDescriptions{{ + "Lock the session.", + "Quit the session.", + "Suspend to memory.", + "Suspend to disk.", + "Restart the machine.", + "Shut down the machine.", +}}; + +array iconNames{{ + "system-lock-screen", + "system-log-out", + "system-suspend", + "system-suspend-hibernate", + "system-reboot", + "system-shutdown" +}}; + + +QString defaultCommand(SupportedCommands command){ + + for (const QString &de : QString(::getenv("XDG_CURRENT_DESKTOP")).split(":")) { + + if (de == "Unity" || de == "Pantheon" || de == "GNOME") + switch (command) { + case LOCK: return "gnome-screensaver-command --lock"; + case LOGOUT: return "gnome-session-quit --logout"; + case SUSPEND: break ; + case HIBERNATE: break ; + case REBOOT: return "gnome-session-quit --reboot"; + case POWEROFF: return "gnome-session-quit --power-off"; + } + + else if (de == "kde-plasma" || de == "KDE") + switch (command) { + case LOCK: return "dbus-send --dest=org.freedesktop.ScreenSaver --type=method_call /ScreenSaver org.freedesktop.ScreenSaver.Lock"; + case LOGOUT: return "qdbus org.kde.ksmserver /KSMServer logout 0 0 0"; + case SUSPEND: break ; + case HIBERNATE: break ; + case REBOOT: return "qdbus org.kde.ksmserver /KSMServer logout 0 1 0"; + case POWEROFF: return "qdbus org.kde.ksmserver /KSMServer logout 0 2 0"; + } + + else if (de == "X-Cinnamon" || de == "Cinnamon") + switch (command) { + case LOCK: return "cinnamon-screensaver-command --lock"; + case LOGOUT: return "cinnamon-session-quit --logout"; + case SUSPEND: break ; + case HIBERNATE: break ; + case REBOOT: return "cinnamon-session-quit --reboot"; + case POWEROFF: return "cinnamon-session-quit --power-off"; + } + + else if (de == "MATE") + switch (command) { + case LOCK: return "mate-screensaver-command --lock"; + case LOGOUT: return "mate-session-save --logout-dialog"; + case SUSPEND: return "sh -c \"mate-screensaver-command --lock && systemctl suspend -i\""; + case HIBERNATE: return "sh -c \"mate-screensaver-command --lock && systemctl hibernate -i\""; + case REBOOT: return "mate-session-save --shutdown-dialog"; + case POWEROFF: return "mate-session-save --shutdown-dialog"; + } + + else if (de == "XFCE") + switch (command) { + case LOCK: return "xflock4"; + case LOGOUT: return "xfce4-session-logout --logout"; + case SUSPEND: return "xfce4-session-logout --suspend"; + case HIBERNATE: return "xfce4-session-logout --hibernate"; + case REBOOT: return "xfce4-session-logout --reboot"; + case POWEROFF: return "xfce4-session-logout --halt"; + } + } + + switch (command) { + case LOCK: return "xdg-screensaver lock"; + case LOGOUT: return "notify-send \"Error.\" \"Logout command is not set.\" --icon=system-log-out"; + case SUSPEND: return "systemctl suspend -i"; + case HIBERNATE: return "systemctl hibernate -i"; + case REBOOT: return "notify-send \"Error.\" \"Reboot command is not set.\" --icon=system-reboot"; + case POWEROFF: return "notify-send \"Error.\" \"Poweroff command is not set.\" --icon=system-shutdown"; + } + + // NEVER REACHED + return QString(); +} + +} + + + +class System::Private +{ +public: + QPointer widget; + vector iconPaths; + vector commands; +}; + + + +/** ***************************************************************************/ +System::Extension::Extension() + : Core::Extension("org.albert.extension.system"), + Core::QueryHandler(Core::Plugin::id()), + d(new Private) { + + registerQueryHandler(this); + + // Load settings + for (size_t i = 0; i < NUMCOMMANDS; ++i) { + d->iconPaths.push_back(XDG::IconLookup::iconPath(iconNames[i])); + d->commands.push_back(settings().value(configNames[i], defaultCommand(static_cast(i))).toString()); + } +} + + + +/** ***************************************************************************/ +System::Extension::~Extension() { + +} + + + +/** ***************************************************************************/ +QWidget *System::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) { + d->widget = new ConfigWidget(parent); + + // Initialize the content and connect the signals + + d->widget->ui.lineEdit_lock->setText(d->commands[LOCK]); + connect(d->widget->ui.lineEdit_lock, &QLineEdit::textEdited, [this](const QString &s){ + d->commands[LOCK]= s; + settings().setValue(configNames[LOCK], s); + }); + + d->widget->ui.lineEdit_logout->setText(d->commands[LOGOUT]); + connect(d->widget->ui.lineEdit_logout, &QLineEdit::textEdited, [this](const QString &s){ + d->commands[LOGOUT]= s; + settings().setValue(configNames[LOGOUT], s); + }); + + d->widget->ui.lineEdit_suspend->setText(d->commands[SUSPEND]); + connect(d->widget->ui.lineEdit_suspend, &QLineEdit::textEdited, [this](const QString &s){ + d->commands[SUSPEND]= s; + settings().setValue(configNames[SUSPEND], s); + }); + + d->widget->ui.lineEdit_hibernate->setText(d->commands[HIBERNATE]); + connect(d->widget->ui.lineEdit_hibernate, &QLineEdit::textEdited, [this](const QString &s){ + d->commands[HIBERNATE]= s; + settings().setValue(configNames[HIBERNATE], s); + }); + + d->widget->ui.lineEdit_reboot->setText(d->commands[REBOOT]); + connect(d->widget->ui.lineEdit_reboot, &QLineEdit::textEdited, [this](const QString &s){ + d->commands[REBOOT]= s; + settings().setValue(configNames[REBOOT], s); + }); + + d->widget->ui.lineEdit_shutdown->setText(d->commands[POWEROFF]); + connect(d->widget->ui.lineEdit_shutdown, &QLineEdit::textEdited, [this](const QString &s){ + d->commands[POWEROFF]= s; + settings().setValue(configNames[POWEROFF], s); + }); + } + return d->widget; +} + + + +/** ***************************************************************************/ +void System::Extension::handleQuery(Core::Query * query) const { + + if ( query->string().isEmpty()) + return; + + QRegularExpression re(QString("(%1)").arg(query->string()), QRegularExpression::CaseInsensitiveOption); + for (size_t i = 0; i < NUMCOMMANDS; ++i) { + for (auto &alias : aliases[i]) { + if ( alias.startsWith(query->string(), Qt::CaseInsensitive) ) { + auto item = std::make_shared(configNames[i]); + item->setText(QString(itemTitles[i]).replace(re, "\\1")); + item->setSubtext(itemDescriptions[i]); + item->setIconPath(d->iconPaths[i]); + item->addAction(make_shared(itemDescriptions[i], QStringList(Core::ShUtil::split(d->commands[i])))); + query->addMatch(std::move(item), static_cast(static_cast(query->string().size())/itemTitles[i].size()*UINT_MAX)); + break; + } + } + } +} + diff --git a/plugins/system/src/extension.h b/plugins/system/src/extension.h new file mode 100644 index 0000000..4a9b903 --- /dev/null +++ b/plugins/system/src/extension.h @@ -0,0 +1,34 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +namespace System { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension(); + + QString name() const override { return "System"; } + QWidget *widget(QWidget *parent = nullptr) override; + void handleQuery(Core::Query * query) const override; + +private: + + std::unique_ptr d; + +}; +} diff --git a/plugins/system/system.qrc b/plugins/system/system.qrc new file mode 100644 index 0000000..e5d5f07 --- /dev/null +++ b/plugins/system/system.qrc @@ -0,0 +1,10 @@ + + + resources/poweroff.svg + resources/reboot.svg + resources/suspend.svg + resources/hibernate.svg + resources/lock.svg + resources/logout.svg + + diff --git a/plugins/templateExtension/CMakeLists.txt b/plugins/templateExtension/CMakeLists.txt new file mode 100644 index 0000000..d04927b --- /dev/null +++ b/plugins/templateExtension/CMakeLists.txt @@ -0,0 +1,20 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(projectid) + +file(GLOB_RECURSE SRC src/* metadata.json) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets) + +add_library(${PROJECT_NAME} SHARED ${SRC}) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Widgets + albert::lib + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION lib/albert/plugins) diff --git a/plugins/templateExtension/metadata.json b/plugins/templateExtension/metadata.json new file mode 100644 index 0000000..3392405 --- /dev/null +++ b/plugins/templateExtension/metadata.json @@ -0,0 +1,10 @@ +{ + "id" : "org.albert.extension.projectid", + "name" : "Template", + "version" : "1.0", + "platform" : "All", + "group" : "Extensions", + "author" : "Author missing", + "dependencies" : [], + "enabledbydefault": false +} diff --git a/plugins/templateExtension/src/configwidget.cpp b/plugins/templateExtension/src/configwidget.cpp new file mode 100644 index 0000000..a394d93 --- /dev/null +++ b/plugins/templateExtension/src/configwidget.cpp @@ -0,0 +1,15 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "configwidget.h" + +/** ***************************************************************************/ +ProjectNamespace::ConfigWidget::ConfigWidget(QWidget *parent) : QWidget(parent) { + ui.setupUi(this); +} + + + +/** ***************************************************************************/ +ProjectNamespace::ConfigWidget::~ConfigWidget() { + +} diff --git a/plugins/templateExtension/src/configwidget.h b/plugins/templateExtension/src/configwidget.h new file mode 100644 index 0000000..322eab7 --- /dev/null +++ b/plugins/templateExtension/src/configwidget.h @@ -0,0 +1,16 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" + +namespace ProjectNamespace { +class ConfigWidget final : public QWidget +{ + Q_OBJECT +public: + explicit ConfigWidget(QWidget *parent = nullptr); + ~ConfigWidget(); + Ui::ConfigWidget ui; +}; +} diff --git a/plugins/templateExtension/src/configwidget.ui b/plugins/templateExtension/src/configwidget.ui new file mode 100644 index 0000000..0f5fc2a --- /dev/null +++ b/plugins/templateExtension/src/configwidget.ui @@ -0,0 +1,51 @@ + + + ProjectNamespace::ConfigWidget + + + + 0 + 0 + 480 + 320 + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + <html><head/><body><p align="center"><span style=" color:#808080;">This is a simple template extension.</span></p></body></html> + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + diff --git a/plugins/templateExtension/src/extension.cpp b/plugins/templateExtension/src/extension.cpp new file mode 100644 index 0000000..f95f139 --- /dev/null +++ b/plugins/templateExtension/src/extension.cpp @@ -0,0 +1,116 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include "albert/util/standarditem.h" +#include "xdg/iconlookup.h" +#include "configwidget.h" +#include "extension.h" +using namespace Core; +using namespace std; + +class ProjectNamespace::Private +{ +public: + QPointer widget; +}; + + +/** ***************************************************************************/ +ProjectNamespace::Extension::Extension() + : Core::Extension("org.albert.extension.projectid"), // Must match the id in metadata + Core::QueryHandler(Core::Plugin::id()), + d(new Private) { + + registerQueryHandler(this); + + // You can throw in the constructor if something fatal happened + // throw std::runtime_error( "Description of error." ); + // throw std::string( "Description of error." ); + // throw QString( "Description of error." ); + // throw "Description of error."; + // throw; // Whatever prints "unknown error" +} + + + +/** ***************************************************************************/ +ProjectNamespace::Extension::~Extension() { + +} + + + +/** ***************************************************************************/ +QWidget *ProjectNamespace::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) { + d->widget = new ConfigWidget(parent); + } + return d->widget; +} + + + +/** ***************************************************************************/ +void ProjectNamespace::Extension::setupSession() { + +} + + + +/** ***************************************************************************/ +void ProjectNamespace::Extension::teardownSession() { + +} + + + +/** ***************************************************************************/ +void ProjectNamespace::Extension::handleQuery(Core::Query *) const { + + /* + * Things change so often I wont maintain this tutorial here. Check the relevant headers. + * + * - core/extension.h + * - core/queryhandler.h + * - core/query.h + * - core/item.h + * - core/action.h + * - util/standarditem.h + * - util/offlineindex.h + * - util/standardindexitem.h + * + * Use + * + * query->addMatch(my_item) + * + * to add matches. If you created a throw away item MOVE it instead of + * copying e.g.: + * + * query->addMatch(std::move(my_tmp_item)) + * + * The relevance factor is optional. (Defaults to 0) its a usigned integer depicting the + * relevance of the item 0 mean not relevant UINT_MAX is totally relevant (exact match). + * E.g. it the query is "it" and your items name is "item" + * + * my_item.name().startswith(query->string) + * + * is a naive match criterion and + * + * UINT_MAX / ( query.searchterm().size() / my_item.name().size() ) + * + * a naive match factor. + * + * If you have a lot of items use the iterator versions addMatches, e.g. like that + * + * query->addMatches(my_items.begin(), my_items.end()); + * + * If the items in the container are temporary object move them to avoid uneccesary + * reference counting: + * + * query->addMatches(std::make_move_iterator(my_tmp_items.begin()), + * std::make_move_iterator(my_tmp_items.end())); + */ +} + diff --git a/plugins/templateExtension/src/extension.h b/plugins/templateExtension/src/extension.h new file mode 100644 index 0000000..8d1b4c7 --- /dev/null +++ b/plugins/templateExtension/src/extension.h @@ -0,0 +1,36 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +namespace ProjectNamespace { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension() override; + + QString name() const override { return "Template"; } + QWidget *widget(QWidget *parent = nullptr) override; + void setupSession() override; + void teardownSession() override; + void handleQuery(Core::Query * query) const override; + +private: + + std::unique_ptr d; + +}; +} diff --git a/plugins/terminal/CMakeLists.txt b/plugins/terminal/CMakeLists.txt new file mode 100644 index 0000000..9e4cce9 --- /dev/null +++ b/plugins/terminal/CMakeLists.txt @@ -0,0 +1,21 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(terminal) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets Concurrent) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Concurrent + Qt5::Widgets + albert::lib + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) diff --git a/plugins/terminal/metadata.json b/plugins/terminal/metadata.json new file mode 100644 index 0000000..af83766 --- /dev/null +++ b/plugins/terminal/metadata.json @@ -0,0 +1,10 @@ +{ + "id" : "org.albert.extension.terminal", + "name" : "Terminal", + "version" : "1.0", + "platform" : "Linux", + "group" : "Extensions", + "author" : "Manuel Schneider", + "dependencies" : [], + "enabledbydefault": true +} diff --git a/plugins/terminal/resources/terminal.svg b/plugins/terminal/resources/terminal.svg new file mode 100644 index 0000000..089a5c4 --- /dev/null +++ b/plugins/terminal/resources/terminal.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/terminal/src/configwidget.cpp b/plugins/terminal/src/configwidget.cpp new file mode 100644 index 0000000..546e8bd --- /dev/null +++ b/plugins/terminal/src/configwidget.cpp @@ -0,0 +1,3 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "configwidget.h" diff --git a/plugins/terminal/src/configwidget.h b/plugins/terminal/src/configwidget.h new file mode 100644 index 0000000..047280c --- /dev/null +++ b/plugins/terminal/src/configwidget.h @@ -0,0 +1,23 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" + +namespace Terminal { + +class ConfigWidget final : public QWidget +{ + Q_OBJECT + +public: + + ConfigWidget(QWidget *parent) : QWidget(parent) { + ui.setupUi(this); + } + + Ui::ConfigWidget ui; + +}; + +} diff --git a/plugins/terminal/src/configwidget.ui b/plugins/terminal/src/configwidget.ui new file mode 100644 index 0000000..b59efcd --- /dev/null +++ b/plugins/terminal/src/configwidget.ui @@ -0,0 +1,33 @@ + + + Terminal::ConfigWidget + + + + + + The terminal extension allows you to run commands in a terminal or a shell directly. Theres not much more about it but convenience. Just invoke the extension using the trigger '>'. + + + true + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + diff --git a/plugins/terminal/src/extension.cpp b/plugins/terminal/src/extension.cpp new file mode 100644 index 0000000..0d53b6f --- /dev/null +++ b/plugins/terminal/src/extension.cpp @@ -0,0 +1,178 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "extension.h" +#include "configwidget.h" +#include "albert/util/shutil.h" +#include "albert/util/standardactions.h" +#include "albert/util/standarditem.h" +#include "xdg/iconlookup.h" +using namespace std; +using namespace Core; + +extern QString terminalCommand; + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +class Terminal::Private +{ +public: + QPointer widget; + QString iconPath; + QFileSystemWatcher watcher; + set index; + QFutureWatcher> futureWatcher; +}; + + + +/** ***************************************************************************/ +Terminal::Extension::Extension() + : Core::Extension("org.albert.extension.terminal"), + Core::QueryHandler(Core::Plugin::id()), + d(new Private) { + + registerQueryHandler(this); + + QString iconPath = XDG::IconLookup::iconPath("utilities-terminal", "terminal"); + d->iconPath = iconPath.isNull() ? ":terminal" : iconPath; + + d->watcher.addPaths(QString(::getenv("PATH")).split(':', QString::SkipEmptyParts)); + connect(&d->watcher, &QFileSystemWatcher::directoryChanged, + this, &Extension::rebuildIndex); + + rebuildIndex(); +} + + + +/** ***************************************************************************/ +Terminal::Extension::~Extension() { + +} + + + +/** ***************************************************************************/ +QWidget *Terminal::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) + d->widget = new ConfigWidget(parent); + return d->widget; +} + + + +/** ***************************************************************************/ +void Terminal::Extension::handleQuery(Core::Query * query) const { + + if ( !query->isTriggered() || query->string().trimmed().isEmpty() ) + return; + + vector,short>> results; + + // Extract data from input string: [0] program. The rest: args + QString potentialProgram = query->string().section(' ', 0, 0, QString::SectionSkipEmpty); + QStringList arguments = ShUtil::split(query->string().section(' ', 1, -1, QString::SectionSkipEmpty)); + + // Iterate over matches + set::iterator it = lower_bound(d->index.begin(), d->index.end(), potentialProgram); + + // Get the + QString commonPrefix; + if ( it != d->index.end() ) + commonPrefix = *it; + + while (it != d->index.end() && it->startsWith(potentialProgram)){ + + // Update common prefix + auto mismatchindexes = std::mismatch(it->begin()+potentialProgram.size()-1, it->end(), + commonPrefix.begin()+potentialProgram.size()-1); + commonPrefix.resize(std::distance(it->begin(), mismatchindexes.first)); + + QStringList commandline(*it); + commandline << arguments; + + auto item = make_shared(*it); + item->setIconPath(d->iconPath); + item->setText(commandline.join(' ')); + item->setSubtext(QString("Run '%1'").arg(item->text())); + item->setCompletion(item->text()); + item->addAction(make_shared("Run", commandline, QString(), + true, TermAction::CloseBehavior::DoNotClose)); + item->addAction(make_shared("Run and close on exit", commandline, QString(), + true, TermAction::CloseBehavior::CloseOnExit)); + item->addAction(make_shared("Run and close on success", commandline, QString(), + true, TermAction::CloseBehavior::CloseOnSuccess)); + item->addAction(make_shared("Run in background (without terminal)", commandline)); + results.emplace_back(item, 0); + ++it; + } + + // Apply completion string to items + QString completion = QString(">%1").arg(commonPrefix); + for (pair,short> &match: results) + std::static_pointer_cast(match.first)->setCompletion(completion); + + // Build generic item + QStringList commandline = ShUtil::split(query->string()); + + auto item = make_shared(); + item->setIconPath(d->iconPath); + item->setText("I'm Feeling Lucky"); + item->setSubtext(QString("Try running '%1'").arg(query->string())); + item->setCompletion(query->rawString()); + item->addAction(make_shared("Run", commandline, QString(), + true, TermAction::CloseBehavior::DoNotClose)); + item->addAction(make_shared("Run and close on exit", commandline, QString(), + true, TermAction::CloseBehavior::CloseOnExit)); + item->addAction(make_shared("Run and close on success", commandline, QString(), + true, TermAction::CloseBehavior::CloseOnSuccess)); + item->addAction(make_shared("Run in background (without terminal)", commandline)); + results.emplace_back(item, 0); + + // Add results to query + query->addMatches(results.begin(), results.end()); +} + + +/** ***************************************************************************/ +void Terminal::Extension::rebuildIndex() { + + if ( d->futureWatcher.isRunning() ) + return; + + auto index = [](){ + qDebug() << "Indexing executables in $PATH."; + set index; + QStringList paths = QString(::getenv("PATH")).split(':', QString::SkipEmptyParts); + for (const QString &path : paths) { + QDirIterator dirIt(path); + while (dirIt.hasNext()) { + QFileInfo file(dirIt.next()); + if ( file.isExecutable() ) + index.insert(file.fileName()); + } + } + qDebug() << "Finished indexing executables in $PATH."; + return index; + }; + + connect(&d->futureWatcher, &QFutureWatcher>::finished, this, [this](){ + d->index = d->futureWatcher.future().result(); + disconnect(&d->futureWatcher, nullptr, nullptr, nullptr); + }); + + d->futureWatcher.setFuture(QtConcurrent::run(index)); +} diff --git a/plugins/terminal/src/extension.h b/plugins/terminal/src/extension.h new file mode 100644 index 0000000..6982ee5 --- /dev/null +++ b/plugins/terminal/src/extension.h @@ -0,0 +1,37 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +namespace Terminal { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension(); + + QString name() const override { return "Terminal"; } + QWidget *widget(QWidget *parent = nullptr) override; + QStringList triggers() const override { return {">"}; } + void handleQuery(Core::Query * query) const override; + +private: + + void rebuildIndex(); + + std::unique_ptr d; + +}; +} diff --git a/plugins/terminal/terminal.qrc b/plugins/terminal/terminal.qrc new file mode 100644 index 0000000..e46a4cb --- /dev/null +++ b/plugins/terminal/terminal.qrc @@ -0,0 +1,5 @@ + + + resources/terminal.svg + + diff --git a/plugins/virtualbox/CMakeLists.txt b/plugins/virtualbox/CMakeLists.txt new file mode 100644 index 0000000..2523e98 --- /dev/null +++ b/plugins/virtualbox/CMakeLists.txt @@ -0,0 +1,40 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(virtualbox) + +file(GLOB_RECURSE SRC src/* metadata.json) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets Xml) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc) + +add_definitions(-DRT_OS_LINUX) +add_definitions(-DVBOX_WITH_XPCOM_NAMESPACE_CLEANUP) +set(PATH_XPCOM /usr/${CMAKE_INSTALL_LIBDIR}/virtualbox/sdk/bindings/xpcom) +set(PATH_BIN /usr/${CMAKE_INSTALL_LIBDIR}/virtualbox) + +if(NOT EXISTS ${PATH_XPCOM}/include/VirtualBox_XPCOM.h) + message("${PATH_XPCOM}/include/VirtualBox_XPCOM.h not found. Build will fail!") +endif() + +set_target_properties(${PROJECT_NAME} PROPERTIES INSTALL_RPATH "${PATH_BIN}") + +target_include_directories(${PROJECT_NAME} + PRIVATE + src/ + ${PATH_XPCOM}/include + ${PATH_XPCOM}/include/nsprpub + ${PATH_XPCOM}/include/string + ${PATH_XPCOM}/include/xpcom +) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Widgets + Qt5::Xml + albert::lib + ${PATH_BIN}/VBoxXPCOM.so + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) diff --git a/plugins/virtualbox/metadata.json b/plugins/virtualbox/metadata.json new file mode 100644 index 0000000..e944418 --- /dev/null +++ b/plugins/virtualbox/metadata.json @@ -0,0 +1,10 @@ +{ + "id" : "org.albert.extension.virtualbox", + "name" : "VirtualBox", + "version" : "1.4", + "platform" : "Linux", + "group" : "Extensions", + "author" : "Manuel Schneider", + "dependencies" : ["virtualbox"], + "enabledbydefault": false +} diff --git a/plugins/virtualbox/resources/virtualbox.svg b/plugins/virtualbox/resources/virtualbox.svg new file mode 100644 index 0000000..f8b6600 --- /dev/null +++ b/plugins/virtualbox/resources/virtualbox.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/virtualbox/src/configwidget.cpp b/plugins/virtualbox/src/configwidget.cpp new file mode 100644 index 0000000..c6b7ee5 --- /dev/null +++ b/plugins/virtualbox/src/configwidget.cpp @@ -0,0 +1,15 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "configwidget.h" + +/** ***************************************************************************/ +VirtualBox::ConfigWidget::ConfigWidget(QWidget *parent) : QWidget(parent) { + ui.setupUi(this); +} + + + +/** ***************************************************************************/ +VirtualBox::ConfigWidget::~ConfigWidget() { + +} diff --git a/plugins/virtualbox/src/configwidget.h b/plugins/virtualbox/src/configwidget.h new file mode 100644 index 0000000..7217c56 --- /dev/null +++ b/plugins/virtualbox/src/configwidget.h @@ -0,0 +1,16 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" + +namespace VirtualBox { +class ConfigWidget final : public QWidget +{ + Q_OBJECT +public: + explicit ConfigWidget(QWidget *parent = 0); + ~ConfigWidget(); + Ui::ConfigWidget ui; +}; +} diff --git a/plugins/virtualbox/src/configwidget.ui b/plugins/virtualbox/src/configwidget.ui new file mode 100644 index 0000000..d9a1ec5 --- /dev/null +++ b/plugins/virtualbox/src/configwidget.ui @@ -0,0 +1,35 @@ + + + VirtualBox::ConfigWidget + + + + 0 + 0 + 480 + 320 + + + + + + + Found VMs: + + + + + + + + + + Refresh + + + + + + + + diff --git a/plugins/virtualbox/src/extension.cpp b/plugins/virtualbox/src/extension.cpp new file mode 100644 index 0000000..582e886 --- /dev/null +++ b/plugins/virtualbox/src/extension.cpp @@ -0,0 +1,321 @@ +// Copyright (C) 2014-2019 Manuel Schneider + +#include +#include +#include +#include +#include +#include "VirtualBox_XPCOM.h" +#include "nsIServiceManager.h" +#include "nsString.h" +#include "configwidget.h" +#include "extension.h" +#include "albert/util/standardactions.h" +#include "albert/util/standarditem.h" +#include "xdg/iconlookup.h" +using namespace std; +using namespace Core; + +Q_LOGGING_CATEGORY(qlc_virtualbox, "virtualbox") +#define DEBUG qCDebug (qlc_virtualbox).noquote() +#define INFO qCInfo (qlc_virtualbox).noquote() +#define WARNING qCWarning (qlc_virtualbox).noquote() +#define CRITICAL qCCritical(qlc_virtualbox).noquote() + +class VirtualBox::Private +{ +public: + + QPointer widget; + + nsCOMPtr manager; + nsCOMPtr virtualBox; + std::map> virtualMachines; + + QString iconPath; + + void reloadVirtualMachines(); +}; + + +/** ***************************************************************************/ +void VirtualBox::Private::reloadVirtualMachines() { + + virtualMachines.clear(); + + // Get the virtual machines + nsresult rc; + IMachine **machines = nullptr; + PRUint32 machineCnt = 0; + rc = virtualBox->GetMachines(&machineCnt, &machines); + if (NS_SUCCEEDED(rc)) { + for (PRUint32 i = 0; i < machineCnt; ++ i) { + IMachine *machine = machines[i]; + if (machine){ + + PRBool isAccessible = PR_FALSE; + machine->GetAccessible(&isAccessible); + if (isAccessible) { + + nsXPIDLString xpcomString; + machine->GetName(getter_Copies(xpcomString)); + char *cstr = ToNewCString(xpcomString); + QString name(cstr); + free(cstr); + + virtualMachines.emplace(name, machine); + } + } + } + } +} + + + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +VirtualBox::Extension::Extension() + : Core::Extension("org.albert.extension.virtualbox"), + Core::QueryHandler(Core::Plugin::id()), + d(new Private) { + + registerQueryHandler(this); + + nsresult rc; + rc = NS_GetComponentManager(getter_AddRefs(d->manager)); + if (NS_FAILED(rc)) + throw("Error: could not get component manager."); + + rc = d->manager->CreateInstanceByContractID(NS_VIRTUALBOX_CONTRACTID, + nullptr, + NS_GET_IID(IVirtualBox), + getter_AddRefs(d->virtualBox)); + if (NS_FAILED(rc)) + throw("Error, could not instantiate IVirtualBox object."); + + d->iconPath = XDG::IconLookup::iconPath("virtualbox"); + if ( d->iconPath.isNull() ) + d->iconPath = ":vbox"; +} + + + +/** ***************************************************************************/ +VirtualBox::Extension::~Extension() { + d->virtualBox = nullptr; + NS_ShutdownXPCOM(nullptr); +} + + + +/** ***************************************************************************/ +QWidget *VirtualBox::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) { + d->widget = new ConfigWidget(parent); + + d->widget->ui.listWidget->clear(); + for (auto &pair : d->virtualMachines) + d->widget->ui.listWidget->addItem(pair.first); + + connect(d->widget->ui.pushButton, &QPushButton::clicked, + this, [=](){d->reloadVirtualMachines();}); + } + return d->widget; +} + + + +/** ***************************************************************************/ +void VirtualBox::Extension::setupSession() { + d->reloadVirtualMachines(); +} + + + +/** ***************************************************************************/ +void VirtualBox::Extension::handleQuery(Core::Query * query) const { + + if ( query->string().trimmed().isEmpty() ) + return; + + for (auto &pair : d->virtualMachines) { + if (pair.first.contains(query->string(), Qt::CaseInsensitive)){ + const QString &name = pair.first; + nsCOMPtr &vm = pair.second; + + auto item = make_shared(name); + item->setIconPath(d->iconPath); + item->setText(pair.first); + item->setCompletion(pair.first); + + + auto startVM = make_shared("Start virtual machine", [this, vm]() + { + nsresult rc; + nsCOMPtr session; + if (NS_SUCCEEDED(rc = d->manager->CreateInstanceByContractID(NS_SESSION_CONTRACTID, nullptr, NS_GET_IID(ISession), getter_AddRefs(session)))) { + nsCOMPtr progress; + if (NS_FAILED(rc = vm->LaunchVMProcess(session, QString("gui").utf16(), QString("").utf16(), getter_AddRefs(progress)))) + CRITICAL << "Error, could not start virtual machine:" << rc; + // << NS_ERROR_UNEXPECTED <<"Virtual machine not registered." + // << NS_ERROR_INVALID_ARG <<"Invalid session type." + // << VBOX_E_OBJECT_NOT_FOUND<< "No machine matching machineId found." + // << VBOX_E_INVALID_OBJECT_STATE<< "Session already open or being opened." + // << VBOX_E_IPRT_ERROR<<" Launching process for machine failed." + // << VBOX_E_VM_ERROR<<"Failed to assign machine to session."; + session->UnlockMachine(); + } else + CRITICAL << "Error, could not instantiate ISession object."; + }); + + auto saveVm = make_shared("Save virtual machine", [this, vm]() + { + nsCOMPtr session; + nsresult rc; + + if (NS_SUCCEEDED(d->manager->CreateInstanceByContractID(NS_SESSION_CONTRACTID, nullptr, NS_GET_IID(ISession), getter_AddRefs(session)))){ + if (NS_SUCCEEDED(vm->LockMachine(session, LockType_Shared))){ + nsCOMPtr mutableVm; + if (NS_SUCCEEDED(session->GetMachine(getter_AddRefs(mutableVm)))){ + nsCOMPtr progress; + if (NS_FAILED(rc = mutableVm->SaveState(getter_AddRefs(progress)))) + CRITICAL << "Error, failed saving state:" << rc; + } else + CRITICAL << "Error, failed getting mutable IMachine of ISession."; + } else + CRITICAL << "Error, could not acquire ISession lock."; + session->UnlockMachine(); + } else + CRITICAL << "Error, could not instantiate ISession object."; + }); + + auto discardSavedVm = make_shared("Discard saved state", [this, vm]() + { + nsCOMPtr session; + if (NS_SUCCEEDED(d->manager->CreateInstanceByContractID(NS_SESSION_CONTRACTID, nullptr, NS_GET_IID(ISession), getter_AddRefs(session)))){ + if (NS_SUCCEEDED(vm->LockMachine(session, LockType_Shared))){ + nsCOMPtr mutableVm; + if (NS_SUCCEEDED(session->GetMachine(getter_AddRefs(mutableVm)))){ + if (NS_FAILED(mutableVm->DiscardSavedState(PR_TRUE))) + CRITICAL << "Error, failed discarding saving state."; + } else + CRITICAL << "Error, failed getting mutable IMachine of ISession."; + } else + CRITICAL << "Error, could not acquire ISession lock."; + session->UnlockMachine(); + } else + CRITICAL << "Error, could not instantiate ISession object."; + }); + + auto acpiPowerVm = make_shared("Power off via ACPI event (Power button)", [this, vm]() + { + nsCOMPtr session; + if (NS_SUCCEEDED(d->manager->CreateInstanceByContractID(NS_SESSION_CONTRACTID, nullptr, NS_GET_IID(ISession), getter_AddRefs(session)))){ + if (NS_SUCCEEDED(vm->LockMachine(session, LockType_Shared))){ + nsCOMPtr console; + if (NS_SUCCEEDED(session->GetConsole(getter_AddRefs(console)))){ + if (NS_FAILED(console->PowerButton())) + CRITICAL << "Error, failed sending ACPI event (Power button)."; + } else + CRITICAL << "Error, failed getting IConsole of ISession."; + } else + CRITICAL << "Error, could not acquire ISession lock."; + session->UnlockMachine(); + } else + CRITICAL << "Error, could not instantiate ISession object."; + }); + + auto killVm = make_shared("Turn off virtual machine", [this, vm]() + { + nsCOMPtr session; + if (NS_SUCCEEDED(d->manager->CreateInstanceByContractID(NS_SESSION_CONTRACTID, nullptr, NS_GET_IID(ISession), getter_AddRefs(session)))){ + if (NS_SUCCEEDED(vm->LockMachine(session, LockType_Shared))){ + nsCOMPtr console; + if (NS_SUCCEEDED(session->GetConsole(getter_AddRefs(console)))){ + nsCOMPtr progress; + if (NS_FAILED(console->PowerDown(getter_AddRefs(progress)))) + CRITICAL << "Error, failed powering down machine."; + } else + CRITICAL << "Error, failed getting IConsole of ISession."; + } else + CRITICAL << "Error, could not acquire ISession lock."; + session->UnlockMachine(); + } else + CRITICAL << "Error, could not instantiate ISession object."; + }); + + auto pauseVm = make_shared("Pause virtual machine", [this, vm]() + { + nsCOMPtr session; + if (NS_SUCCEEDED(d->manager->CreateInstanceByContractID(NS_SESSION_CONTRACTID, nullptr, NS_GET_IID(ISession), getter_AddRefs(session)))){ + if (NS_SUCCEEDED(vm->LockMachine(session, LockType_Shared))){ + nsCOMPtr console; + if (NS_SUCCEEDED(session->GetConsole(getter_AddRefs(console)))){ + if (NS_FAILED(console->Pause())) + CRITICAL << "Error, failed pausing machine."; + } else + CRITICAL << "Error, failed getting IConsole of ISession."; + } else + CRITICAL << "Error, could not acquire ISession lock."; + session->UnlockMachine(); + } else + CRITICAL << "Error, could not instantiate ISession object."; + }); + + auto resumeVm = make_shared("Resume virtual machine", [this, vm]() + { + nsCOMPtr session; + if (NS_SUCCEEDED(d->manager->CreateInstanceByContractID(NS_SESSION_CONTRACTID, nullptr, NS_GET_IID(ISession), getter_AddRefs(session)))){ + if (NS_SUCCEEDED(vm->LockMachine(session, LockType_Shared))){ + nsCOMPtr console; + if (NS_SUCCEEDED(session->GetConsole(getter_AddRefs(console)))){ + if (NS_FAILED(console->Resume())) + CRITICAL << "Error, failed resuming machine."; + } else + CRITICAL << "Error, failed getting IConsole of ISession."; + } else + CRITICAL << "Error, could not acquire ISession lock."; + session->UnlockMachine(); + } else + CRITICAL << "Error, could not instantiate ISession object."; + }); + + + PRUint32 state; + vm ->GetState(&state); + switch (state) { + case MachineState::PoweredOff: + item->setSubtext("Machine is powered off"); + item->addAction(startVM); + break; + case MachineState::Saved: + item->setSubtext("Machine is in saved state"); + item->addAction(startVM); + item->addAction(discardSavedVm); + break; + case MachineState::Aborted: + item->setSubtext("Machine is in aborted state"); + item->addAction(startVM); + break; + case MachineState::Running: + item->setSubtext("Machine is running"); + item->addAction(saveVm); + item->addAction(acpiPowerVm); + item->addAction(killVm); + item->addAction(pauseVm); + break; + case MachineState::Paused: + item->setSubtext("Machine is in paused state"); + item->addAction(resumeVm); + break; + default: + item->setSubtext("Machine is doing something. Please wait."); + break; + } + + query->addMatch(move(item), UINT_MAX); + } + } +} diff --git a/plugins/virtualbox/src/extension.h b/plugins/virtualbox/src/extension.h new file mode 100644 index 0000000..9271e66 --- /dev/null +++ b/plugins/virtualbox/src/extension.h @@ -0,0 +1,39 @@ +// Copyright (C) 2014-2015 Manuel Schneider +// Contributed to by 2016-2017 Martin Buergmann + +#pragma once +#include +#include +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" + +Q_DECLARE_LOGGING_CATEGORY(qlc_virtualbox) + +namespace VirtualBox { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension() override; + + QString name() const override { return tr("VirtualBox"); } + QWidget *widget(QWidget *parent = nullptr) override; + void setupSession() override; + void handleQuery(Core::Query *) const override; + +private: + + std::unique_ptr d; + +}; +} diff --git a/plugins/virtualbox/virtualbox.qrc b/plugins/virtualbox/virtualbox.qrc new file mode 100644 index 0000000..7587dd0 --- /dev/null +++ b/plugins/virtualbox/virtualbox.qrc @@ -0,0 +1,5 @@ + + + resources/virtualbox.svg + + diff --git a/plugins/websearch/CMakeLists.txt b/plugins/websearch/CMakeLists.txt new file mode 100644 index 0000000..c560cf8 --- /dev/null +++ b/plugins/websearch/CMakeLists.txt @@ -0,0 +1,20 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(websearch) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets) + +add_library(${PROJECT_NAME} SHARED ${SRC} ${PROJECT_NAME}.qrc metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Widgets + albert::lib + xdg +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) diff --git a/plugins/websearch/metadata.json b/plugins/websearch/metadata.json new file mode 100644 index 0000000..3d15496 --- /dev/null +++ b/plugins/websearch/metadata.json @@ -0,0 +1,10 @@ +{ + "id" : "org.albert.extension.websearch", + "name" : "WebSearch", + "version" : "1.0", + "platform" : "All", + "group" : "Extensions", + "author" : "Manuel Schneider", + "dependencies" : [], + "enabledbydefault": true +} diff --git a/plugins/websearch/resources/amazon.svg b/plugins/websearch/resources/amazon.svg new file mode 100644 index 0000000..046e2f0 --- /dev/null +++ b/plugins/websearch/resources/amazon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/websearch/resources/default.svg b/plugins/websearch/resources/default.svg new file mode 100644 index 0000000..2c7c073 --- /dev/null +++ b/plugins/websearch/resources/default.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/websearch/resources/duckduckgo.svg b/plugins/websearch/resources/duckduckgo.svg new file mode 100644 index 0000000..ac41d66 --- /dev/null +++ b/plugins/websearch/resources/duckduckgo.svg @@ -0,0 +1,14 @@ + \ No newline at end of file diff --git a/plugins/websearch/resources/ebay.svg b/plugins/websearch/resources/ebay.svg new file mode 100644 index 0000000..5b52a3c --- /dev/null +++ b/plugins/websearch/resources/ebay.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/websearch/resources/google.svg b/plugins/websearch/resources/google.svg new file mode 100644 index 0000000..657c2a3 --- /dev/null +++ b/plugins/websearch/resources/google.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/websearch/resources/octocat.svg b/plugins/websearch/resources/octocat.svg new file mode 100644 index 0000000..5fa2ec5 --- /dev/null +++ b/plugins/websearch/resources/octocat.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/websearch/resources/wikipedia.svg b/plugins/websearch/resources/wikipedia.svg new file mode 100644 index 0000000..ccc960f --- /dev/null +++ b/plugins/websearch/resources/wikipedia.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/plugins/websearch/resources/wolfram.png b/plugins/websearch/resources/wolfram.png new file mode 100644 index 0000000..c438377 Binary files /dev/null and b/plugins/websearch/resources/wolfram.png differ diff --git a/plugins/websearch/resources/wolfram.svg b/plugins/websearch/resources/wolfram.svg new file mode 100644 index 0000000..31ad028 --- /dev/null +++ b/plugins/websearch/resources/wolfram.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/websearch/resources/youtube.svg b/plugins/websearch/resources/youtube.svg new file mode 100644 index 0000000..31a15c7 --- /dev/null +++ b/plugins/websearch/resources/youtube.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/plugins/websearch/src/configwidget.cpp b/plugins/websearch/src/configwidget.cpp new file mode 100644 index 0000000..294b195 --- /dev/null +++ b/plugins/websearch/src/configwidget.cpp @@ -0,0 +1,121 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include "configwidget.h" +#include "enginesmodel.h" +#include "extension.h" +#include "searchengineeditor.h" + +/** ***************************************************************************/ +Websearch::ConfigWidget::ConfigWidget(Extension *extension, QWidget *parent) + : QWidget(parent), extension_(extension) { + + ui.setupUi(this); + + enginesModel_ = new EnginesModel(extension, ui.tableView_searches); + ui.tableView_searches->setModel(enginesModel_); + + ui.tableView_searches->horizontalHeader()->setSectionResizeMode(QHeaderView::ResizeToContents); + ui.tableView_searches->verticalHeader()->setSectionResizeMode(QHeaderView::ResizeToContents); + + // Initialize connections + connect(ui.pushButton_new, &QPushButton::clicked, + this, &ConfigWidget::onButton_new); + + connect(ui.pushButton_remove, &QPushButton::clicked, + this, &ConfigWidget::onButton_remove); + + connect(ui.pushButton_restoreDefaults, &QPushButton::clicked, + this, &ConfigWidget::onButton_restoreDefaults); + + connect(ui.tableView_searches, &QTableView::activated, + this, &ConfigWidget::onActivated); +} + + + +/** ***************************************************************************/ +Websearch::ConfigWidget::~ConfigWidget() { +} + + + +/** ***************************************************************************/ +void Websearch::ConfigWidget::onActivated(QModelIndex index) { + int row = index.row(); + SearchEngineEditor searchEngineEditor(extension_->engines()[static_cast(row)], this); + + if (searchEngineEditor.exec()){ + // Set the new engine + const SearchEngine & searchEngine = searchEngineEditor.searchEngine(); + enginesModel_->setData(enginesModel_->index(row, 0), searchEngine.name, Qt::DisplayRole); + enginesModel_->setData(enginesModel_->index(row, 0), searchEngine.iconPath, Qt::DecorationRole); + enginesModel_->setData(enginesModel_->index(row, 1), searchEngine.trigger, Qt::DisplayRole); + enginesModel_->setData(enginesModel_->index(row, 2), searchEngine.url, Qt::DisplayRole); + } + ui.tableView_searches->reset(); +} + + + +/** ***************************************************************************/ +void Websearch::ConfigWidget::onButton_new() { + + // Open search engine editor + SearchEngine searchEngine; + searchEngine.iconPath = ":default"; + SearchEngineEditor searchEngineEditor(searchEngine, this); + + if (searchEngineEditor.exec()){ + + // Insert new row in model + int row = (ui.tableView_searches->currentIndex().isValid()) + ? ui.tableView_searches->currentIndex().row() + : ui.tableView_searches->model()->rowCount(); + enginesModel_->insertRow(row); + + // Set the new engine + searchEngine = searchEngineEditor.searchEngine(); + enginesModel_->setData(enginesModel_->index(row, 0), searchEngine.name, Qt::DisplayRole); + enginesModel_->setData(enginesModel_->index(row, 0), searchEngine.iconPath, Qt::DecorationRole); + enginesModel_->setData(enginesModel_->index(row, 1), searchEngine.trigger, Qt::DisplayRole); + enginesModel_->setData(enginesModel_->index(row, 2), searchEngine.url, Qt::DisplayRole); + + // Set current + QModelIndex index = ui.tableView_searches->model()->index(row, 0, QModelIndex()); + ui.tableView_searches->setCurrentIndex(index); + } +} + + + +/** ***************************************************************************/ +void Websearch::ConfigWidget::onButton_remove() { + // Ask if sure + int row = ui.tableView_searches->currentIndex().row(); + QString engineName = ui.tableView_searches->model() + ->data(ui.tableView_searches->model()->index(row, 1)).toString(); + QMessageBox::StandardButton reply = + QMessageBox::question(this, "Sure?", + QString("Do you really want to remove '%1' from the search engines?") + .arg(engineName), + QMessageBox::Yes|QMessageBox::No); + // Remove if sure + if (reply == QMessageBox::Yes) + ui.tableView_searches->model()->removeRow(ui.tableView_searches->currentIndex().row()); +} + + + +/** ***************************************************************************/ +void Websearch::ConfigWidget::onButton_restoreDefaults() { + QMessageBox::StandardButton reply = + QMessageBox::question(this, "Sure?", + QString("Do you really want to restore the default search engines?"), + QMessageBox::Yes|QMessageBox::No); + // Remove if sure + if (reply == QMessageBox::Yes) + enginesModel_->restoreDefaults(); +} diff --git a/plugins/websearch/src/configwidget.h b/plugins/websearch/src/configwidget.h new file mode 100644 index 0000000..6d54c00 --- /dev/null +++ b/plugins/websearch/src/configwidget.h @@ -0,0 +1,33 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_configwidget.h" + +namespace Websearch { + +class Extension; +class EnginesModel; + +class ConfigWidget final : public QWidget +{ + Q_OBJECT + +public: + + explicit ConfigWidget(Extension *extension, QWidget *parent = 0); + ~ConfigWidget(); + Ui::ConfigWidget ui; + +private: + + void onActivated(QModelIndex index); + void onButton_new(); + void onButton_remove(); + void onButton_restoreDefaults(); + + Extension *extension_; + EnginesModel *enginesModel_; +}; + +} diff --git a/plugins/websearch/src/configwidget.ui b/plugins/websearch/src/configwidget.ui new file mode 100644 index 0000000..75b5ec2 --- /dev/null +++ b/plugins/websearch/src/configwidget.ui @@ -0,0 +1,90 @@ + + + Websearch::ConfigWidget + + + + + + Qt::ScrollBarAsNeeded + + + Qt::ScrollBarAlwaysOff + + + QAbstractScrollArea::AdjustToContents + + + QAbstractItemView::InternalMove + + + true + + + QAbstractItemView::SingleSelection + + + QAbstractItemView::SelectRows + + + false + + + false + + + false + + + true + + + false + + + + + + + + + Qt::Horizontal + + + + 0 + 0 + + + + + + + + + .. + + + + + + + + .. + + + + + + + Restore + + + + + + + + + + diff --git a/plugins/websearch/src/enginesmodel.cpp b/plugins/websearch/src/enginesmodel.cpp new file mode 100644 index 0000000..6632794 --- /dev/null +++ b/plugins/websearch/src/enginesmodel.cpp @@ -0,0 +1,312 @@ +// Copyright (C) 2014-2018 Manuel Schneider + + +#include +#include +#include +#include +#include +#include +#include +#include "enginesmodel.h" +#include "extension.h" +#include "searchengine.h" + +namespace { + +enum class Section{ Name, Trigger, URL} ; +const int sectionCount = 3; + +std::map iconCache; + +} + + +/** ***************************************************************************/ +Websearch::EnginesModel::EnginesModel(Extension *extension, QObject *parent) + : QAbstractTableModel(parent), extension_(extension) { +} + + +/** ***************************************************************************/ +int Websearch::EnginesModel::rowCount(const QModelIndex &) const { + return static_cast(extension_->engines().size()); +} + + + +/** ***************************************************************************/ +int Websearch::EnginesModel::columnCount(const QModelIndex &) const { + return sectionCount; +} + + + +/** ***************************************************************************/ +QVariant Websearch::EnginesModel::headerData(int section, Qt::Orientation orientation, int role) const { + // No sanity check necessary since + if ( section < 0 || sectionCount <= section ) + return QVariant(); + + + if (orientation == Qt::Horizontal){ + switch (static_cast
    (section)) { + case Section::Name:{ + switch (role) { + case Qt::DisplayRole: return "Name"; + case Qt::ToolTipRole: return "The name of the searchengine."; + default: return QVariant(); + } + + } + case Section::Trigger:{ + switch (role) { + case Qt::DisplayRole: return "Trigger"; + case Qt::ToolTipRole: return "The term that triggers this searchengine."; + default: return QVariant(); + } + + } + case Section::URL:{ + switch (role) { + case Qt::DisplayRole: return "URL"; + case Qt::ToolTipRole: return "The URL of this searchengine. %s will be replaced by your searchterm."; + default: return QVariant(); + } + + } + } + } + return QVariant(); +} + + + +/** ***************************************************************************/ +QVariant Websearch::EnginesModel::data(const QModelIndex &index, int role) const { + if ( !index.isValid() || + index.row() >= static_cast(extension_->engines().size()) || + index.column() >= sectionCount ) + return QVariant(); + + switch (role) { + case Qt::DisplayRole: + case Qt::EditRole: { + switch (static_cast
    (index.column())) { + case Section::Name: + return extension_->engines()[static_cast(index.row())].name; + case Section::Trigger: + return extension_->engines()[static_cast(index.row())].trigger; + case Section::URL: + return extension_->engines()[static_cast(index.row())].url; + } + } + case Qt::DecorationRole: { + if (static_cast
    (index.column()) == Section::Name) { + // Resizing request thounsands of repaints. Creating an icon for + // ever paint event is to expensive. Therefor maintain an icon cache + const QString &iconPath = extension_->engines()[static_cast(index.row())].iconPath; + std::map::iterator it = iconCache.find(iconPath); + if ( it != iconCache.end() ) + return it->second; + return iconCache.insert(std::make_pair(iconPath, QIcon(iconPath))).second; + } + return QVariant(); + } + case Qt::ToolTipRole: return "Double click to edit"; + default: return QVariant(); + } +} + + + +/** ***************************************************************************/ +bool Websearch::EnginesModel::setData(const QModelIndex &index, const QVariant &value, int role) { + if ( !index.isValid() || + index.row() >= static_cast(extension_->engines().size()) || + index.column() >= sectionCount) + return false; + + switch (role) { + case Qt::DisplayRole: { + if ( !value.canConvert(QMetaType::QString) ) + return false; + QString s = value.toString(); + switch (static_cast
    (index.column())) { + case Section::Name: { + std::vector newEngines = extension_->engines(); + newEngines[static_cast(index.row())].name = s; + extension_->setEngines(newEngines); + dataChanged(index, index, QVector({Qt::DisplayRole})); + return true; + } + case Section::Trigger: { + std::vector newEngines = extension_->engines(); + newEngines[static_cast(index.row())].trigger = s; + extension_->setEngines(newEngines); + dataChanged(index, index, QVector({Qt::DisplayRole})); + return true; + } + case Section::URL: { + std::vector newEngines = extension_->engines(); + newEngines[static_cast(index.row())].url = s; + extension_->setEngines(newEngines); + dataChanged(index, index, QVector({Qt::DisplayRole})); + return true; + } + } + return false; + } + case Qt::DecorationRole: { + QFileInfo fileInfo(value.toString()); + + if ( !fileInfo.exists() ) + return false; + + // Remove icon from cache + iconCache.erase(extension_->engines()[static_cast(index.row())].iconPath); + + // Create extension dir if necessary + QDir configDir = QDir(QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation)); + if ( !configDir.exists(extension_->Core::Plugin::id()) ) { + if ( !configDir.mkdir(extension_->Core::Plugin::id()) ) { + qWarning() << "Could not create extension data dir."; + return false; + } + } + + configDir.cd(extension_->Core::Plugin::id()); + + // Build the new random path + QString newFilePath = configDir.filePath(QString("%1.%2") + .arg(QUuid::createUuid().toString()) + .arg(fileInfo.suffix())); + + // Copy the file into data dir + if ( !QFile::copy(fileInfo.filePath(), newFilePath) ) { + qWarning() << "Could not copy icon to cache."; + return false; + } + + // Remove old icon and set the copied file as icon + std::vector newEngines = extension_->engines(); + QFile::remove(newEngines[static_cast(index.row())].iconPath); + newEngines[static_cast(index.row())].iconPath = newFilePath; + extension_->setEngines(newEngines); + + // Update the icon in the first section of the row + QModelIndex firstSectionIndex = index.model()->index(index.row(), 0); + dataChanged(firstSectionIndex, firstSectionIndex, QVector({Qt::DecorationRole})); + + return true; + } + default: + return false; + } +} + + + +/** ***************************************************************************/ +Qt::ItemFlags Websearch::EnginesModel::flags(const QModelIndex &index) const { + if (index.isValid()) + return QAbstractTableModel::flags(index) | Qt::ItemIsSelectable | Qt::ItemIsEnabled | Qt::ItemIsDragEnabled; + else + return QAbstractTableModel::flags(index) | Qt::ItemIsDropEnabled; +} + + + +/** ***************************************************************************/ +bool Websearch::EnginesModel::insertRows(int position, int rows, const QModelIndex &) { + if ( position < 0 || rows < 1 || + static_cast(extension_->engines().size()) < position) + return false; + + beginInsertRows(QModelIndex(), position, position + rows - 1); + std::vector newEngines = extension_->engines(); + for ( int row = position; row < position + rows; ++row ) + newEngines.insert(newEngines.begin() + row, + SearchEngine({"", "", ":default", + ""})); + extension_->setEngines(newEngines); + endInsertRows(); + return true; +} + + + +/** ***************************************************************************/ +bool Websearch::EnginesModel::removeRows(int position, int rows, const QModelIndex &) { + if ( position < 0 || rows < 1 || + static_cast(extension_->engines().size()) < position + rows) + return false; + + beginRemoveRows(QModelIndex(), position, position + rows - 1); + std::vector newEngines = extension_->engines(); + newEngines.erase(newEngines.begin() + position, + newEngines.begin() + position + rows); + extension_->setEngines(newEngines); + endRemoveRows(); + return true; +} + + + +/** ***************************************************************************/ +bool Websearch::EnginesModel::moveRows(const QModelIndex &srcParent, int srcRow, int cnt, + const QModelIndex &dstParent, int dstRow) { + if ( srcRow < 0 || cnt < 1 || dstRow < 0 || + static_cast(extension_->engines().size()) < srcRow + cnt - 1 || + static_cast(extension_->engines().size()) < dstRow || + ( srcRow <= dstRow && dstRow < srcRow + cnt) ) // If its inside the source do nothing + return false; + + std::vector newEngines = extension_->engines(); + beginMoveRows(srcParent, srcRow, srcRow + cnt - 1, dstParent, dstRow); + newEngines.insert(newEngines.begin() + dstRow, + extension_->engines().begin() + srcRow, + extension_->engines().begin() + srcRow + cnt); + if ( srcRow < dstRow ) + newEngines.erase(newEngines.begin() + srcRow, + newEngines.begin() + srcRow + cnt); + else + newEngines.erase(newEngines.begin() + srcRow + cnt, + newEngines.begin() + srcRow + cnt * 2); + extension_->setEngines(newEngines); + endMoveRows(); + return true; +} + + + +/** ***************************************************************************/ +void Websearch::EnginesModel::restoreDefaults() { + beginResetModel(); + extension_->restoreDefaultEngines(); + endResetModel(); +} + + + +/** ***************************************************************************/ +Qt::DropActions Websearch::EnginesModel::supportedDropActions() const { + return Qt::MoveAction; +} + + + +/** ***************************************************************************/ +bool Websearch::EnginesModel::dropMimeData(const QMimeData *data, + Qt::DropAction /*action*/, + int dstRow, + int /*column*/, + const QModelIndex &/*parent*/) { + QByteArray encoded = data->data("application/x-qabstractitemmodeldatalist"); + QDataStream stream(&encoded, QIODevice::ReadOnly); + int srcRow = 0; + if (!stream.atEnd()) + stream >> srcRow; + moveRows(QModelIndex(), srcRow, 1, QModelIndex(), dstRow); + return false; +} diff --git a/plugins/websearch/src/enginesmodel.h b/plugins/websearch/src/enginesmodel.h new file mode 100644 index 0000000..006aa4b --- /dev/null +++ b/plugins/websearch/src/enginesmodel.h @@ -0,0 +1,38 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include + +namespace Websearch { + +class Extension; + +class EnginesModel final : public QAbstractTableModel +{ + Q_OBJECT + +public: + + EnginesModel(Extension *extension, QObject *parent = Q_NULLPTR); + + int rowCount(const QModelIndex & parent = QModelIndex()) const override; + int columnCount(const QModelIndex & parent = QModelIndex()) const override; + QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override; + QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const override; + bool setData(const QModelIndex & index, const QVariant & value, int role = Qt::EditRole) override; + Qt::ItemFlags flags(const QModelIndex & index) const override; + bool insertRows (int position, int rows, const QModelIndex & parent = QModelIndex()) override; + bool removeRows (int position, int rows, const QModelIndex & parent = QModelIndex()) override; + bool moveRows(const QModelIndex &sourceRow, int srcRow, int cnt, const QModelIndex & dst, int destinationChild) override; + Qt::DropActions supportedDropActions() const override; + bool dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override; + + void restoreDefaults(); + +private: + + Extension *extension_; + +}; + +} diff --git a/plugins/websearch/src/extension.cpp b/plugins/websearch/src/extension.cpp new file mode 100644 index 0000000..9755602 --- /dev/null +++ b/plugins/websearch/src/extension.cpp @@ -0,0 +1,221 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "configwidget.h" +#include "enginesmodel.h" +#include "extension.h" +#include "albert/util/standardactions.h" +#include "albert/util/standarditem.h" +#include "xdg/iconlookup.h" +using namespace Core; +using namespace std; + + +namespace { + +vector defaultSearchEngines = { + {"Google", "gg ", ":google", "https://www.google.com/search?q=%s"}, + {"Youtube", "yt ", ":youtube", "https://www.youtube.com/results?search_query=%s"}, + {"Amazon", "ama ", ":amazon", "http://www.amazon.com/s/?field-keywords=%s"}, + {"Ebay", "eb ", ":ebay", "http://www.ebay.com/sch/i.html?_nkw=%s"}, + {"GitHub", "gh ", ":github", "https://github.com/search?utf8=✓&q=%s"}, + {"Wolfram Alpha", "=", ":wolfram", "https://www.wolframalpha.com/input/?i=%s"}, + {"DuckDuckGo", "dd ", ":duckduckgo","https://duckduckgo.com/?q=%s"}, +}; + +shared_ptr buildWebsearchItem(const Websearch::SearchEngine &se, const QString &searchterm) { + + QString urlString = QString(se.url).replace("%s", QUrl::toPercentEncoding(searchterm)); + QUrl url = QUrl(urlString); + QString desc = QString("Start %1 search in your browser").arg(se.name); + + auto item = make_shared(se.name); + item->setText(se.name); + item->setSubtext(desc); + item->setIconPath(se.iconPath); + item->setCompletion(QString("%1%2").arg(se.trigger, searchterm)); + item->addAction(make_shared("Open URL", url)); + + return item; +} + +static constexpr const char * ENGINES_FILE_NAME = "engines.json"; + +} + + + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +class Websearch::Private +{ +public: + QPointer widget; + vector searchEngines; +}; + + + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +Websearch::Extension::Extension() + : Core::Extension("org.albert.extension.websearch"), + Core::QueryHandler(Core::Plugin::id()), + d(new Private) { + + registerQueryHandler(this); + registerFallbackProvider(this); + + // Move config file from old location to new. (data -> config) TODO: REMOVE in 0.14 + QString oldpath = QDir(QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation)) + .filePath(QString("%1.json").arg(Core::Plugin::id())); + QString enginesJson = configLocation().filePath(ENGINES_FILE_NAME); + if ( QFile::exists(oldpath) ) { + if ( QFile::exists(enginesJson) ) + QFile::remove(oldpath); + else + QFile::rename(oldpath, enginesJson); + } + + // Deserialize engines + QFile file(enginesJson); + if (file.open(QIODevice::ReadOnly)) { + QJsonArray array = QJsonDocument::fromJson(file.readAll()).array(); + SearchEngine searchEngine; + for ( const QJsonValue& value : array) { + QJsonObject object = value.toObject(); + searchEngine.name = object["name"].toString(); + searchEngine.trigger = object["trigger"].toString(); + searchEngine.iconPath = object["iconPath"].toString(); + searchEngine.url = object["url"].toString(); + d->searchEngines.push_back(searchEngine); + } + } else { + qWarning() << qPrintable(QString("Could not load from file: '%1'.").arg(enginesJson)); + setEngines(defaultSearchEngines); + } +} + + + +/** ***************************************************************************/ +Websearch::Extension::~Extension() { + +} + + + +/** ***************************************************************************/ +QWidget *Websearch::Extension::widget(QWidget *parent) { + if (d->widget.isNull()) + d->widget = new ConfigWidget(this, parent); + return d->widget; +} + + + +/** ***************************************************************************/ +QStringList Websearch::Extension::triggers() const { + QStringList triggers; + for ( const SearchEngine& se : d->searchEngines ) + triggers.push_back(se.trigger); + return triggers; +} + + + +/** ***************************************************************************/ +void Websearch::Extension::handleQuery(Core::Query * query) const { + + if ( query->isTriggered() ) { + for ( const SearchEngine &se : d->searchEngines ) + if ( query->trigger() == se.trigger ) + query->addMatch(buildWebsearchItem(se, query->string())); + } + else + { + QUrl url = QUrl::fromUserInput(query->string().trimmed()); + + // Check syntax and TLD validity + if ( url.isValid() && ( query->string().startsWith("http://") || // explict scheme + query->string().startsWith("https://") || // explict scheme + ( QRegularExpression(R"R(\S+\.\S+$)R").match(url.host()).hasMatch() && + !url.topLevelDomain().isNull()) ) ) { // valid TLD + auto item = make_shared("valid_url"); + item->setText(QString("Open url in browser")); + item->setSubtext(QString("Visit %1").arg(url.authority())); + item->setCompletion(query->string()); + QString icon = XDG::IconLookup::iconPath({"www", "web-browser", "emblem-web"}); + item->setIconPath(icon.isNull() ? ":favicon" : icon); + item->addAction(make_shared("Open URL", url)); + + query->addMatch(move(item), UINT_MAX); + } + } +} + + + +/** ***************************************************************************/ +vector> Websearch::Extension::fallbacks(const QString & searchterm) { + vector> res; + for (const SearchEngine &se : d->searchEngines) + res.push_back(buildWebsearchItem(se, searchterm)); + return res; +} + + + +/** ***************************************************************************/ +const vector &Websearch::Extension::engines() const { + return d->searchEngines; +} + + + +/** ***************************************************************************/ +void Websearch::Extension::setEngines(const vector &engines) { + d->searchEngines = engines; + emit enginesChanged(d->searchEngines); + + // Serialize the engines + QFile file(configLocation().filePath(ENGINES_FILE_NAME)); + if (file.open(QIODevice::WriteOnly)) { + QJsonArray array; + for ( const SearchEngine& searchEngine : d->searchEngines ) { + QJsonObject object; + object["name"] = searchEngine.name; + object["url"] = searchEngine.url; + object["trigger"] = searchEngine.trigger; + object["iconPath"] = searchEngine.iconPath; + array.append(object); + } + file.write(QJsonDocument(array).toJson()); + } else + qCritical() << qPrintable(QString("Could not write to file: '%1'.").arg(file.fileName())); +} + + + +/** ***************************************************************************/ +void Websearch::Extension::restoreDefaultEngines() { + setEngines(defaultSearchEngines); +} diff --git a/plugins/websearch/src/extension.h b/plugins/websearch/src/extension.h new file mode 100644 index 0000000..624009e --- /dev/null +++ b/plugins/websearch/src/extension.h @@ -0,0 +1,48 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "albert/extension.h" +#include "albert/queryhandler.h" +#include "albert/fallbackprovider.h" +#include "searchengine.h" + +namespace Websearch { + +class Private; + +class Extension final : + public Core::Extension, + public Core::QueryHandler, + public Core::FallbackProvider +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_EXTENSION_IID FILE "metadata.json") + +public: + + Extension(); + ~Extension(); + + QString name() const override { return "Websearch"; } + QWidget *widget(QWidget *parent = nullptr) override; + QStringList triggers() const override; + void handleQuery(Core::Query * query) const override; + std::vector> fallbacks(const QString &) override; + + const std::vector& engines() const; + void setEngines(const std::vector &engines); + + void restoreDefaultEngines(); + +private: + + std::unique_ptr d; + +signals: + + void enginesChanged(const std::vector &engines); + +}; + +} diff --git a/plugins/websearch/src/searchengine.h b/plugins/websearch/src/searchengine.h new file mode 100644 index 0000000..8479f4c --- /dev/null +++ b/plugins/websearch/src/searchengine.h @@ -0,0 +1,16 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include + +namespace Websearch { + +class SearchEngine { +public: + QString name; + QString trigger; + QString iconPath; + QString url; +}; + +} diff --git a/plugins/websearch/src/searchengineeditor.cpp b/plugins/websearch/src/searchengineeditor.cpp new file mode 100644 index 0000000..594e389 --- /dev/null +++ b/plugins/websearch/src/searchengineeditor.cpp @@ -0,0 +1,47 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include "searchengineeditor.h" + + + +/** ***************************************************************************/ +Websearch::SearchEngineEditor::SearchEngineEditor(const SearchEngine &searchEngine, QWidget *parent) + : QDialog(parent), searchEngine_(searchEngine) { + + ui.setupUi(this); + setWindowModality(Qt::WindowModal); + + ui.lineEdit_name->setText(searchEngine.name); + ui.lineEdit_trigger->setText(searchEngine.trigger); + ui.lineEdit_url->setText(searchEngine.url); + ui.toolButton_icon->setIcon(QIcon(searchEngine.iconPath)); + + connect(ui.lineEdit_name, &QLineEdit::textChanged, + [this](const QString & text){ searchEngine_.name = text; }); + + connect(ui.lineEdit_trigger, &QLineEdit::textChanged, + [this](const QString & text){ searchEngine_.trigger = text; }); + + connect(ui.lineEdit_url, &QLineEdit::textChanged, + [this](const QString & text){ searchEngine_.url = text; }); + + connect(ui.toolButton_icon, &QToolButton::clicked, + [this](){ + + QString fileName = + QFileDialog::getOpenFileName( + this, + tr("Choose icon"), + QStandardPaths::writableLocation(QStandardPaths::HomeLocation), + tr("Images (*.png *.svg)")); + + if(fileName.isEmpty()) + return; + + searchEngine_.iconPath = fileName; + ui.toolButton_icon->setIcon(QIcon(fileName)); + }); + +} diff --git a/plugins/websearch/src/searchengineeditor.h b/plugins/websearch/src/searchengineeditor.h new file mode 100644 index 0000000..616eb06 --- /dev/null +++ b/plugins/websearch/src/searchengineeditor.h @@ -0,0 +1,26 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "ui_searchengineeditor.h" +#include "searchengine.h" + +namespace Websearch { + +class SearchEngineEditor : public QDialog +{ + Q_OBJECT + +public: + + explicit SearchEngineEditor(const SearchEngine &searchEngine, QWidget *parent = 0); + const SearchEngine &searchEngine() { return searchEngine_; } + +private: + + SearchEngine searchEngine_; + Ui::SearchEngineEditor ui; + +}; + +} diff --git a/plugins/websearch/src/searchengineeditor.ui b/plugins/websearch/src/searchengineeditor.ui new file mode 100644 index 0000000..ed6d455 --- /dev/null +++ b/plugins/websearch/src/searchengineeditor.ui @@ -0,0 +1,194 @@ + + + Websearch::SearchEngineEditor + + + + 0 + 0 + 420 + 320 + + + + Edit search engine + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + + Qt::Horizontal + + + + 40 + 20 + + + + + + + + Click to set an icon for the search engine. + + + + 96 + 96 + + + + + + + + Qt::Horizontal + + + + 40 + 20 + + + + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + + Name: + + + + + + + Name of the search engine. + + + Name of the search engine + + + + + + + Trigger: + + + + + + + The query prefix that triggers this engine. Note that it may make sense to append a space to the trigger prefix. + + + The query prefix that triggers this engine + + + + + + + URL: + + + + + + + The URL containing a %s that will be replaced by the query. + + + The URL containing a %s that will be replaced by the query + + + + + + + + + Qt::Horizontal + + + QDialogButtonBox::Cancel|QDialogButtonBox::Ok + + + + + + + lineEdit_name + lineEdit_trigger + lineEdit_url + toolButton_icon + + + + + buttonBox + accepted() + Websearch::SearchEngineEditor + accept() + + + 275 + 310 + + + 157 + 274 + + + + + buttonBox + rejected() + Websearch::SearchEngineEditor + reject() + + + 343 + 310 + + + 286 + 274 + + + + + diff --git a/plugins/websearch/websearch.qrc b/plugins/websearch/websearch.qrc new file mode 100644 index 0000000..518e167 --- /dev/null +++ b/plugins/websearch/websearch.qrc @@ -0,0 +1,13 @@ + + + resources/amazon.svg + resources/default.svg + resources/ebay.svg + resources/google.svg + resources/youtube.svg + resources/octocat.svg + resources/wikipedia.svg + resources/wolfram.png + resources/duckduckgo.svg + + diff --git a/plugins/widgetboxmodel/CMakeLists.txt b/plugins/widgetboxmodel/CMakeLists.txt new file mode 100644 index 0000000..687923a --- /dev/null +++ b/plugins/widgetboxmodel/CMakeLists.txt @@ -0,0 +1,22 @@ +cmake_minimum_required(VERSION 3.1.3) + +project(widgetboxmodel) + +file(GLOB_RECURSE SRC src/*) + +find_package(Qt5 5.5.0 REQUIRED COMPONENTS Widgets Svg) + +add_library(${PROJECT_NAME} SHARED ${SRC} metadata.json) + +target_include_directories(${PROJECT_NAME} PRIVATE src/) + +target_link_libraries(${PROJECT_NAME} + PRIVATE + Qt5::Svg + Qt5::Widgets + albert::lib + Xext +) + +install(TARGETS ${PROJECT_NAME} LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}/albert/plugins) +install(DIRECTORY "share/" DESTINATION "${CMAKE_INSTALL_DATADIR}/albert/org.albert.frontend.widgetboxmodel") diff --git a/plugins/widgetboxmodel/metadata.json b/plugins/widgetboxmodel/metadata.json new file mode 100644 index 0000000..d3bfd57 --- /dev/null +++ b/plugins/widgetboxmodel/metadata.json @@ -0,0 +1,6 @@ +{ + "id" : "org.albert.frontend.widgetboxmodel", + "name" : "Widget Box Model", + "version" : "1.0", + "author" : "Manuel Schneider" +} diff --git a/plugins/widgetboxmodel/share/ArcTemplate.qss b/plugins/widgetboxmodel/share/ArcTemplate.qss new file mode 100644 index 0000000..803d335 --- /dev/null +++ b/plugins/widgetboxmodel/share/ArcTemplate.qss @@ -0,0 +1,101 @@ +/* + * author: ubervison + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #%foreground_color%; + background-color: #%background_color%; +} + +#frame { + padding: 4px; + border-radius: 3px; + background-color: #%background_color%; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + border: 1px solid #%border_color%; + font-size: 36px; + selection-color: #%background_color%; + selection-background-color: #%foreground_color%; + background-color: #%inputline_color%; +} + +#settingsButton { + color : #%button_color%; + background-color: #%background_color%; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + selection-color: #%foreground_color%; +} + +QListView::item:selected { + background: #%selection_background_color%; + border: 1px solid #%selection_border_color%; +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #%scroll_color%; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/ArcTemplate.sh b/plugins/widgetboxmodel/share/ArcTemplate.sh new file mode 100755 index 0000000..0371bf8 --- /dev/null +++ b/plugins/widgetboxmodel/share/ArcTemplate.sh @@ -0,0 +1,21 @@ +#!/bin/bash + +TEMPLATE="ArcTemplate.qss" + +function makeStyle(){ + cat "$1" | sed \ + -e "s/%background_color%/$2/g" \ + -e "s/%foreground_color%/$3/g" \ + -e "s/%inputline_color%/$4/g" \ + -e "s/%border_color%/$5/g" \ + -e "s/%button_color%/$6/g" \ + -e "s/%scroll_color%/$7/g" \ + -e "s/%selection_background_color%/$8/g" \ + -e "s/%selection_border_color%/$9/g" > "${10}" +} + +#makeStyle bg fg input border button scrollbar sel_bg sel_border output +makeStyle "$TEMPLATE" "e7e8eb" "727A8F" "fdfdfd" "CFD6E6" "ffffff" "b8babf" "95c4fb" "cfd6e6" "themes/Arc Blue.qss" +makeStyle "$TEMPLATE" "e7e8eb" "727A8F" "fdfdfd" "CFD6E6" "ffffff" "b8babf" "F5F6F7" "4084D6" "themes/Arc Grey.qss" +makeStyle "$TEMPLATE" "383C4A" "AFB8C5" "404552" "21252B" "ffffff" "b8babf" "4084D6" "4084D6" "themes/Arc Dark Blue.qss" +makeStyle "$TEMPLATE" "383C4A" "AFB8C5" "404552" "21252B" "ffffff" "b8babf" "404552" "2B2E39" "themes/Arc Dark Grey.qss" \ No newline at end of file diff --git a/plugins/widgetboxmodel/share/SpotlightTemplate.qss b/plugins/widgetboxmodel/share/SpotlightTemplate.qss new file mode 100644 index 0000000..1dfe99e --- /dev/null +++ b/plugins/widgetboxmodel/share/SpotlightTemplate.qss @@ -0,0 +1,88 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #%foreground_color%; + background-color: #%background_color%; +} + +#frame { + padding: 6px 0px; + border-radius: 8px; + background-color: #%background_color%; + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 0px 8px; + font-size: 36px; + selection-color: #%background_color%; + selection-background-color: #%foreground_color%; + background-color: transparent; +} + +#settingsButton { + margin: 6px 6px 0px 0px; + color: #%button_color%; + background-color: transparent; + padding: 2px; + min-width:14px; + min-height:14px; + max-width:14px; + max-height:14px; +} + +/********** ListViews ************/ + +QListView { + background: transparent; + selection-color: #%selection_foreground_color%; +} + +QListView::item:selected { + background: #%selection_background_color%; +} + +QListView QScrollBar:vertical { + width: 3px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #%scroll_color%; + border-radius: 1px; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 40px; + font-size: 24px; +} + +QListView#resultsList::item{ + padding: 8px 0px 0px 0px; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} diff --git a/plugins/widgetboxmodel/share/SpotlightTemplate.sh b/plugins/widgetboxmodel/share/SpotlightTemplate.sh new file mode 100755 index 0000000..e87f599 --- /dev/null +++ b/plugins/widgetboxmodel/share/SpotlightTemplate.sh @@ -0,0 +1,17 @@ +#!/bin/bash + +TEMPLATE="SpotlightTemplate.qss" + +function makeStyle(){ + cat "$1" | sed \ + -e "s/%background_color%/$2/g" \ + -e "s/%foreground_color%/$3/g" \ + -e "s/%button_color%/$4/g" \ + -e "s/%scroll_color%/$5/g" \ + -e "s/%selection_foreground_color%/$6/g"\ + -e "s/%selection_background_color%/$7/g" > "${8}" +} + +#makeStyle bg fg button scroll sel_fg sel_bg output +makeStyle "$TEMPLATE" "fcfcfc" "808080" "e0e0e0" "c0c0c0" "606060" "e0e0e0" "${1}Spotlight.qss" +makeStyle "$TEMPLATE" "030303" "808080" "202020" "404040" "a0a0a0" "202020" "${1}Spotlight Dark.qss" diff --git a/plugins/widgetboxmodel/share/StandardThemeTemplate.qss b/plugins/widgetboxmodel/share/StandardThemeTemplate.qss new file mode 100644 index 0000000..95e2d69 --- /dev/null +++ b/plugins/widgetboxmodel/share/StandardThemeTemplate.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #%foreground_color%; + background-color: #%background_color%; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #%background_color%; + border: 6px solid #%border_color%; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #%background_color%; + selection-background-color: #%foreground_color%; + background-color: #%inputline_color%; +} + +#settingsButton { + color : #%button_color%; + background-color: #%background_color%; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #%selection_foreground_color%; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20%selection_background_color%, stop:0.5 #10%selection_background_color%, stop:1.0 #20%selection_background_color% ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #%scroll_color%; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/StandardThemeTemplate.sh b/plugins/widgetboxmodel/share/StandardThemeTemplate.sh new file mode 100755 index 0000000..4646e70 --- /dev/null +++ b/plugins/widgetboxmodel/share/StandardThemeTemplate.sh @@ -0,0 +1,48 @@ +#!/bin/bash + +TEMPLATE="StandardThemeTemplate.qss" + +function makeStyle(){ + cat "${1}" | sed \ + -e "s/%background_color%/${2}/g" \ + -e "s/%foreground_color%/${3}/g" \ + -e "s/%inputline_color%/${4}/g" \ + -e "s/%border_color%/${5}/g" \ + -e "s/%button_color%/${6}/g" \ + -e "s/%scroll_color%/${7}/g" \ + -e "s/%selection_foreground_color%/${8}/g"\ + -e "s/%selection_background_color%/${9}/g" \ + -e "s/%selection_border_color%/${10}/g" > "${11}" +} + +#makeStyle bg fg input border button scroll sel_fg sel_bg sel_bor output +makeStyle "$TEMPLATE" "FFFFFF" "808080" "D0D0D0" "808080" "808080" "808080" "808080" "808080" "808080" "${1}Bright.qss" +makeStyle "$TEMPLATE" "FFFFFF" "808080" "D0D0D0" "FF8000" "FF8000" "FF8000" "808080" "FF8000" "FF8000" "${1}BrightOrange.qss" +makeStyle "$TEMPLATE" "FFFFFF" "808080" "D0D0D0" "FF0080" "FF0080" "FF0080" "808080" "FF0080" "FF0080" "${1}BrightMagenta.qss" +makeStyle "$TEMPLATE" "FFFFFF" "808080" "D0D0D0" "00FF80" "00FF80" "00FF80" "808080" "00FF80" "00FF80" "${1}BrightMint.qss" +makeStyle "$TEMPLATE" "FFFFFF" "808080" "D0D0D0" "80FF00" "80FF00" "80FF00" "808080" "80FF00" "80FF00" "${1}BrightGreen.qss" +makeStyle "$TEMPLATE" "FFFFFF" "808080" "D0D0D0" "0080FF" "0080FF" "0080FF" "808080" "0080FF" "0080FF" "${1}BrightBlue.qss" +makeStyle "$TEMPLATE" "FFFFFF" "808080" "D0D0D0" "8000FF" "8000FF" "8000FF" "808080" "8000FF" "8000FF" "${1}BrightViolet.qss" +makeStyle "$TEMPLATE" "404040" "808080" "202020" "808080" "808080" "808080" "808080" "808080" "808080" "${1}Dark.qss" +makeStyle "$TEMPLATE" "404040" "808080" "202020" "FF8000" "FF8000" "FF8000" "808080" "FF8000" "FF8000" "${1}DarkOrange.qss" +makeStyle "$TEMPLATE" "404040" "808080" "202020" "FF0080" "FF0080" "FF0080" "808080" "FF0080" "FF0080" "${1}DarkMagenta.qss" +makeStyle "$TEMPLATE" "404040" "808080" "202020" "00FF80" "00FF80" "00FF80" "808080" "00FF80" "00FF80" "${1}DarkMint.qss" +makeStyle "$TEMPLATE" "404040" "808080" "202020" "80FF00" "80FF00" "80FF00" "808080" "80FF00" "80FF00" "${1}DarkGreen.qss" +makeStyle "$TEMPLATE" "404040" "808080" "202020" "0080FF" "0080FF" "0080FF" "808080" "0080FF" "0080FF" "${1}DarkBlue.qss" +makeStyle "$TEMPLATE" "404040" "808080" "202020" "8000FF" "8000FF" "8000FF" "808080" "8000FF" "8000FF" "${1}DarkViolet.qss" +makeStyle "$TEMPLATE" "002b36" "93a1a1" "073642" "b58900" "b58900" "b58900" "93a1a1" "b58900" "b58900" "${1}SolarizedDarkYellow.qss" +makeStyle "$TEMPLATE" "002b36" "93a1a1" "073642" "cb4b16" "cb4b16" "cb4b16" "93a1a1" "cb4b16" "cb4b16" "${1}SolarizedDarkOrange.qss" +makeStyle "$TEMPLATE" "002b36" "93a1a1" "073642" "dc322f" "dc322f" "dc322f" "93a1a1" "dc322f" "dc322f" "${1}SolarizedDarkRed.qss" +makeStyle "$TEMPLATE" "002b36" "93a1a1" "073642" "d33682" "d33682" "d33682" "93a1a1" "d33682" "d33682" "${1}SolarizedDarkMagenta.qss" +makeStyle "$TEMPLATE" "002b36" "93a1a1" "073642" "6c71c4" "6c71c4" "6c71c4" "93a1a1" "6c71c4" "6c71c4" "${1}SolarizedDarkViolet.qss" +makeStyle "$TEMPLATE" "002b36" "93a1a1" "073642" "268bd2" "268bd2" "268bd2" "93a1a1" "268bd2" "268bd2" "${1}SolarizedDarkBlue.qss" +makeStyle "$TEMPLATE" "002b36" "93a1a1" "073642" "2aa198" "2aa198" "2aa198" "93a1a1" "2aa198" "2aa198" "${1}SolarizedDarkCyan.qss" +makeStyle "$TEMPLATE" "002b36" "93a1a1" "073642" "859900" "859900" "859900" "93a1a1" "859900" "859900" "${1}SolarizedDarkGreen.qss" +makeStyle "$TEMPLATE" "fdf6e3" "586e75" "eee8d5" "b58900" "b58900" "b58900" "586e75" "b58900" "b58900" "${1}SolarizedBrightYellow.qss" +makeStyle "$TEMPLATE" "fdf6e3" "586e75" "eee8d5" "cb4b16" "cb4b16" "cb4b16" "586e75" "cb4b16" "cb4b16" "${1}SolarizedBrightOrange.qss" +makeStyle "$TEMPLATE" "fdf6e3" "586e75" "eee8d5" "dc322f" "dc322f" "dc322f" "586e75" "dc322f" "dc322f" "${1}SolarizedBrightRed.qss" +makeStyle "$TEMPLATE" "fdf6e3" "586e75" "eee8d5" "d33682" "d33682" "d33682" "586e75" "d33682" "d33682" "${1}SolarizedBrightMagenta.qss" +makeStyle "$TEMPLATE" "fdf6e3" "586e75" "eee8d5" "6c71c4" "6c71c4" "6c71c4" "586e75" "6c71c4" "6c71c4" "${1}SolarizedBrightViolet.qss" +makeStyle "$TEMPLATE" "fdf6e3" "586e75" "eee8d5" "268bd2" "268bd2" "268bd2" "586e75" "268bd2" "268bd2" "${1}SolarizedBrightBlue.qss" +makeStyle "$TEMPLATE" "fdf6e3" "586e75" "eee8d5" "2aa198" "2aa198" "2aa198" "586e75" "2aa198" "2aa198" "${1}SolarizedBrightCyan.qss" +makeStyle "$TEMPLATE" "fdf6e3" "586e75" "eee8d5" "859900" "859900" "859900" "586e75" "859900" "859900" "${1}SolarizedBrightGreen.qss" diff --git a/plugins/widgetboxmodel/share/themes/Adapta.qss b/plugins/widgetboxmodel/share/themes/Adapta.qss new file mode 100644 index 0000000..8923946 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Adapta.qss @@ -0,0 +1,98 @@ +/* + * author: will8211 + * Modified from a theme by ubervison + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #E6E9EB; + background-color: #2A373E; +} + +#frame { + padding: 4px; + border-radius: 3px; + background-color: #2A373E; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + border: 1px solid #21252B; + font-size: 36px; + selection-color: #2A373E; + selection-background-color: #E6E9EB; + background-color: #3E515A; +} + +#settingsButton { + color : #ffffff; + background-color: #2A373E; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView::item:selected { + background: #00BCD4; + border: 1px solid #00BCD4; +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #b8babf; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/Arc Blue.qss b/plugins/widgetboxmodel/share/themes/Arc Blue.qss new file mode 100644 index 0000000..8da91f5 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Arc Blue.qss @@ -0,0 +1,101 @@ +/* + * author: ubervison + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #727A8F; + background-color: #e7e8eb; +} + +#frame { + padding: 4px; + border-radius: 3px; + background-color: #e7e8eb; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + border: 1px solid #CFD6E6; + font-size: 36px; + selection-color: #e7e8eb; + selection-background-color: #727A8F; + background-color: #fdfdfd; +} + +#settingsButton { + color : #ffffff; + background-color: #e7e8eb; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + selection-color: #727A8F; +} + +QListView::item:selected { + background: #95c4fb; + border: 1px solid #cfd6e6; +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #b8babf; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/Arc Dark Blue.qss b/plugins/widgetboxmodel/share/themes/Arc Dark Blue.qss new file mode 100644 index 0000000..a293691 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Arc Dark Blue.qss @@ -0,0 +1,101 @@ +/* + * author: ubervison + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #AFB8C5; + background-color: #383C4A; +} + +#frame { + padding: 4px; + border-radius: 3px; + background-color: #383C4A; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + border: 1px solid #21252B; + font-size: 36px; + selection-color: #383C4A; + selection-background-color: #AFB8C5; + background-color: #404552; +} + +#settingsButton { + color : #ffffff; + background-color: #383C4A; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + selection-color: #AFB8C5; +} + +QListView::item:selected { + background: #4084D6; + border: 1px solid #4084D6; +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #b8babf; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/Arc Dark Grey.qss b/plugins/widgetboxmodel/share/themes/Arc Dark Grey.qss new file mode 100644 index 0000000..5a5a796 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Arc Dark Grey.qss @@ -0,0 +1,101 @@ +/* + * author: ubervison + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #AFB8C5; + background-color: #383C4A; +} + +#frame { + padding: 4px; + border-radius: 3px; + background-color: #383C4A; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + border: 1px solid #21252B; + font-size: 36px; + selection-color: #383C4A; + selection-background-color: #AFB8C5; + background-color: #404552; +} + +#settingsButton { + color : #ffffff; + background-color: #383C4A; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + selection-color: #AFB8C5; +} + +QListView::item:selected { + background: #404552; + border: 1px solid #2B2E39; +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #b8babf; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/Arc Grey.qss b/plugins/widgetboxmodel/share/themes/Arc Grey.qss new file mode 100644 index 0000000..637c34b --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Arc Grey.qss @@ -0,0 +1,101 @@ +/* + * author: ubervison + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #727A8F; + background-color: #e7e8eb; +} + +#frame { + padding: 4px; + border-radius: 3px; + background-color: #e7e8eb; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + border: 1px solid #CFD6E6; + font-size: 36px; + selection-color: #e7e8eb; + selection-background-color: #727A8F; + background-color: #fdfdfd; +} + +#settingsButton { + color : #ffffff; + background-color: #e7e8eb; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + selection-color: #727A8F; +} + +QListView::item:selected { + background: #F5F6F7; + border: 1px solid #4084D6; +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #b8babf; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/Bright.qss b/plugins/widgetboxmodel/share/themes/Bright.qss new file mode 100644 index 0000000..9842c0e --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Bright.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #FFFFFF; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #FFFFFF; + border: 6px solid #808080; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #FFFFFF; + selection-background-color: #808080; + background-color: #D0D0D0; +} + +#settingsButton { + color : #808080; + background-color: #FFFFFF; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20808080, stop:0.5 #10808080, stop:1.0 #20808080 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #808080; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/BrightBlue.qss b/plugins/widgetboxmodel/share/themes/BrightBlue.qss new file mode 100644 index 0000000..d978650 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/BrightBlue.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #FFFFFF; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #FFFFFF; + border: 6px solid #0080FF; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #FFFFFF; + selection-background-color: #808080; + background-color: #D0D0D0; +} + +#settingsButton { + color : #0080FF; + background-color: #FFFFFF; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #200080FF, stop:0.5 #100080FF, stop:1.0 #200080FF ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #0080FF; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/BrightGreen.qss b/plugins/widgetboxmodel/share/themes/BrightGreen.qss new file mode 100644 index 0000000..b705ac1 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/BrightGreen.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #FFFFFF; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #FFFFFF; + border: 6px solid #80FF00; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #FFFFFF; + selection-background-color: #808080; + background-color: #D0D0D0; +} + +#settingsButton { + color : #80FF00; + background-color: #FFFFFF; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #2080FF00, stop:0.5 #1080FF00, stop:1.0 #2080FF00 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #80FF00; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/BrightMagenta.qss b/plugins/widgetboxmodel/share/themes/BrightMagenta.qss new file mode 100644 index 0000000..015e431 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/BrightMagenta.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #FFFFFF; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #FFFFFF; + border: 6px solid #FF0080; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #FFFFFF; + selection-background-color: #808080; + background-color: #D0D0D0; +} + +#settingsButton { + color : #FF0080; + background-color: #FFFFFF; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20FF0080, stop:0.5 #10FF0080, stop:1.0 #20FF0080 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #FF0080; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/BrightMint.qss b/plugins/widgetboxmodel/share/themes/BrightMint.qss new file mode 100644 index 0000000..c4a4531 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/BrightMint.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #FFFFFF; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #FFFFFF; + border: 6px solid #00FF80; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #FFFFFF; + selection-background-color: #808080; + background-color: #D0D0D0; +} + +#settingsButton { + color : #00FF80; + background-color: #FFFFFF; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #2000FF80, stop:0.5 #1000FF80, stop:1.0 #2000FF80 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #00FF80; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/BrightOrange.qss b/plugins/widgetboxmodel/share/themes/BrightOrange.qss new file mode 100644 index 0000000..dbb67d3 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/BrightOrange.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #FFFFFF; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #FFFFFF; + border: 6px solid #FF8000; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #FFFFFF; + selection-background-color: #808080; + background-color: #D0D0D0; +} + +#settingsButton { + color : #FF8000; + background-color: #FFFFFF; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20FF8000, stop:0.5 #10FF8000, stop:1.0 #20FF8000 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #FF8000; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/BrightViolet.qss b/plugins/widgetboxmodel/share/themes/BrightViolet.qss new file mode 100644 index 0000000..cac1327 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/BrightViolet.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #FFFFFF; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #FFFFFF; + border: 6px solid #8000FF; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #FFFFFF; + selection-background-color: #808080; + background-color: #D0D0D0; +} + +#settingsButton { + color : #8000FF; + background-color: #FFFFFF; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #208000FF, stop:0.5 #108000FF, stop:1.0 #208000FF ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #8000FF; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/Dark.qss b/plugins/widgetboxmodel/share/themes/Dark.qss new file mode 100644 index 0000000..b259814 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Dark.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #404040; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #404040; + border: 6px solid #808080; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #404040; + selection-background-color: #808080; + background-color: #202020; +} + +#settingsButton { + color : #808080; + background-color: #404040; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20808080, stop:0.5 #10808080, stop:1.0 #20808080 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #808080; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/DarkBlue.qss b/plugins/widgetboxmodel/share/themes/DarkBlue.qss new file mode 100644 index 0000000..7633af0 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/DarkBlue.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #404040; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #404040; + border: 6px solid #0080FF; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #404040; + selection-background-color: #808080; + background-color: #202020; +} + +#settingsButton { + color : #0080FF; + background-color: #404040; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #200080FF, stop:0.5 #100080FF, stop:1.0 #200080FF ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #0080FF; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/DarkGreen.qss b/plugins/widgetboxmodel/share/themes/DarkGreen.qss new file mode 100644 index 0000000..f897f35 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/DarkGreen.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #404040; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #404040; + border: 6px solid #80FF00; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #404040; + selection-background-color: #808080; + background-color: #202020; +} + +#settingsButton { + color : #80FF00; + background-color: #404040; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #2080FF00, stop:0.5 #1080FF00, stop:1.0 #2080FF00 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #80FF00; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/DarkMagenta.qss b/plugins/widgetboxmodel/share/themes/DarkMagenta.qss new file mode 100644 index 0000000..341ea02 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/DarkMagenta.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #404040; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #404040; + border: 6px solid #FF0080; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #404040; + selection-background-color: #808080; + background-color: #202020; +} + +#settingsButton { + color : #FF0080; + background-color: #404040; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20FF0080, stop:0.5 #10FF0080, stop:1.0 #20FF0080 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #FF0080; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/DarkMint.qss b/plugins/widgetboxmodel/share/themes/DarkMint.qss new file mode 100644 index 0000000..e66e684 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/DarkMint.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #404040; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #404040; + border: 6px solid #00FF80; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #404040; + selection-background-color: #808080; + background-color: #202020; +} + +#settingsButton { + color : #00FF80; + background-color: #404040; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #2000FF80, stop:0.5 #1000FF80, stop:1.0 #2000FF80 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #00FF80; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/DarkOrange.qss b/plugins/widgetboxmodel/share/themes/DarkOrange.qss new file mode 100644 index 0000000..289ce67 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/DarkOrange.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #404040; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #404040; + border: 6px solid #FF8000; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #404040; + selection-background-color: #808080; + background-color: #202020; +} + +#settingsButton { + color : #FF8000; + background-color: #404040; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20FF8000, stop:0.5 #10FF8000, stop:1.0 #20FF8000 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #FF8000; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/DarkViolet.qss b/plugins/widgetboxmodel/share/themes/DarkViolet.qss new file mode 100644 index 0000000..e678089 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/DarkViolet.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #404040; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #404040; + border: 6px solid #8000FF; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #404040; + selection-background-color: #808080; + background-color: #202020; +} + +#settingsButton { + color : #8000FF; + background-color: #404040; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #808080; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #208000FF, stop:0.5 #108000FF, stop:1.0 #208000FF ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #8000FF; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/Elementary.qss b/plugins/widgetboxmodel/share/themes/Elementary.qss new file mode 100644 index 0000000..d67f9ff --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Elementary.qss @@ -0,0 +1,117 @@ +/* + * author: Bart Zaalberg + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #404040; + +} + +#frame { + padding: 10px; + border-radius: 4px; + background-color: #F5F5F5; + border: 1px solid #808080; + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 0px; + border-radius: 2px; + border: 1px solid lightblue; + font-size:15px; + selection-color: #404040; + selection-background-color: #FFFFFF; + background-color: #FFFFFF; + padding-left:10px; + margin-right:20px; + color:black; +} + +#settingsButton { + color : #808080; + background-color: #F5F5F5; + padding: 4px; + + /* Respect the frame border */ + margin: 12px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + selection-color: #331; + background-color: #F5F5F5; +} + +QListView::item { + background-color: #F5F5F5; + padding:6px; +} + +QListView::item:selected { + border-radius: 4px; + background-color: #D8D8D8; +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #808080; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: #F5F5F5; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 15px; + color: black; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 35px; + font-size: 13px; + color: #331; + fill: #333; + font-family: "Open Sans"; + src: url("//fonts.googleapis.com/css?family=Open+Sans"); + font-weight: 400; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/HamoniKR_Dark.qss b/plugins/widgetboxmodel/share/themes/HamoniKR_Dark.qss new file mode 100644 index 0000000..af53308 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/HamoniKR_Dark.qss @@ -0,0 +1,95 @@ +/* + * author: Kevin Kim + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + font-family: "Open Sans"; + src: url("//fonts.googleapis.com/css?family=Open+Sans"); + font-weight: 400; + + border: none; + color : #828282; + background-color: #BF252525; +} + +#frame { + padding: 2px 15px; + border-radius: 15px; + background-color: #BF252525; + min-width:700px; + max-width:700px; +} + +#inputLine { + padding: 2px 15px; + font-size: 30px; + selection-color: #030303; + selection-background-color: #808080; + background-color: transparent; +} + +#settingsButton { + margin: 6px 6px 0px 0px; + color: #BF252525; + background-color: transparent; + padding: 2px; + min-width:15px; + min-height:15px; + max-width:15px; + max-height:15px; +} + +/********** ListViews ************/ + +QListView { + background: transparent; + selection-color: #ffffff; + padding: 5px 5px 5px 5px; +} + +QListView::item:selected { + background: #0767c8; + border-radius: 10px; +} + +QListView QScrollBar:vertical { + width: 2px; + background: #000000; +} + +QListView QScrollBar::handle:vertical { + background: #BF808080; + border-radius: 3px; + min-height: 100px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: #BF252525; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 40px; + font-size: 20px; + padding: 5px 5px 5px 5px; +} + +QListView#resultsList::item{ + padding: 8px 20px 20px 0px; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} diff --git a/plugins/widgetboxmodel/share/themes/HamoniKR_White.qss b/plugins/widgetboxmodel/share/themes/HamoniKR_White.qss new file mode 100644 index 0000000..6c8f12d --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/HamoniKR_White.qss @@ -0,0 +1,93 @@ +/* + * author: Kevin Kim + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + font-family: "Open Sans"; + src: url("//fonts.googleapis.com/css?family=Open+Sans"); + font-weight: 400; + + border: none; + color : #303030; + background-color: #BFf4f3f6; +} + +#frame { + padding: 2px 15px; + border-radius: 15px; + background-color: #BFf4f3f6; + min-width:700px; + max-width:700px; +} + +#inputLine { + padding: 2px 15px; + font-size: 45px; + selection-color: #ffffff; + selection-background-color: #808080; + background-color: transparent; +} + +#settingsButton { + margin: 6px 6px 0px 0px; + color: #CCc8c8c8; + background-color: transparent; + padding: 2px; + min-width:15px; + min-height:15px; + max-width:15px; + max-height:15px; +} + +/********** ListViews ************/ + +QListView { + background: transparent; + selection-color: #ffffff; +} + +QListView::item:selected { + background: #0767c8; + border-radius: 0px; +} + +QListView QScrollBar:vertical { + width: 2px; + background: #000000; +} + +QListView QScrollBar::handle:vertical { + background: #000000; + border-radius: 3px; + min-height: 100px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: #BFf4f3f6; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 50px; + font-size: 25px; +} + +QListView#resultsList::item{ + padding: 8px 0px 0px 0px; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} diff --git a/plugins/widgetboxmodel/share/themes/Numix Rounded.qss b/plugins/widgetboxmodel/share/themes/Numix Rounded.qss new file mode 100644 index 0000000..c22ed39 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Numix Rounded.qss @@ -0,0 +1,118 @@ +/* + * author: Leandro Heck + * based on Manuel Schneider's themes Numix and Yosemite Dark + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + color : #ccc; + background-color: #2d2d2d; +} + +#frame { + width:640px; + padding: 12px; + border-radius: 5px; + background-color: #2d2d2d; + /*border: 1px solid #555;*/ + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + font: 36px "Source Sans Pro Bold"; + selection-color: #fdf6e3; + selection-background-color: #586e75; + border: none; + background-color: #2d2d2d; +} + +#settingsButton { + border: none; + border-radius: 7px; + color : #555; + background-color: transparent; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:14px; + min-height:14px; + max-width:14px; + max-height:14px; +} + +#settingsButton:hover { + background-color: #2d2d2d; +} + + +/********** ListViews ************/ + +QListView { + selection-color: #ccc; +} + +QListView::item:selected { + border: none; + background: qlineargradient(x1:0, x2:1, stop:0.0 #3a3a3a, stop:0.5 #3a3a3a, stop:1.0 #3a3a3a ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #AAAAAA; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 36px; + font-size: 26px; + font: 20px "Source Sans Pro Bold"; + background-color: transparent; + border: none; +} + +QListView#resultsList::item{ + height:48px; + padding: 4px; + border-bottom: 1px dotted #555; +} + +QListView#resultsList::item:selected{ + border: none; + background: #3a3a3a; +} diff --git a/plugins/widgetboxmodel/share/themes/Numix.qss b/plugins/widgetboxmodel/share/themes/Numix.qss new file mode 100644 index 0000000..3a097d4 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Numix.qss @@ -0,0 +1,118 @@ +/* + * author: + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + + +* { + color : #ccc; + background-color: #2d2d2d; +} + +#frame { + width:640px; + padding: 5px; + background-color: #2d2d2d; + /*border: 1px solid #555;*/ + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + font: 36px "Source Sans Pro Bold"; + selection-color: #fdf6e3; + selection-background-color: #586e75; + border: none; + background-color: #2d2d2d; +} + +#settingsButton { + border: none; + border-radius: 7px; + color : #555; + background-color: transparent; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:14px; + min-height:14px; + max-width:14px; + max-height:14px; +} + +#settingsButton:hover { + background-color: #2d2d2d; +} + + +/********** ListViews **********/ + +QListView { + selection-color: #ccc; +} + +QListView::item:selected { + border: none; + background: qlineargradient(x1:0, x2:1, stop:0.0 #3a3a3a, stop:0.5 #3a3a3a, stop:1.0 #3a3a3a ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #AAAAAA; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 36px; + font-size: 26px; + font: 20px "Source Sans Pro Bold"; + background-color: transparent; + border: none; +} + +QListView#resultsList::item{ + height:48px; + padding: 4px; + border-bottom: 1px dotted #555; +} + +QListView#resultsList::item:selected{ + border: none; + background: #3a3a3a; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedBrightBlue.qss b/plugins/widgetboxmodel/share/themes/SolarizedBrightBlue.qss new file mode 100644 index 0000000..bd69067 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedBrightBlue.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #586e75; + background-color: #fdf6e3; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #fdf6e3; + border: 6px solid #268bd2; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #fdf6e3; + selection-background-color: #586e75; + background-color: #eee8d5; +} + +#settingsButton { + color : #268bd2; + background-color: #fdf6e3; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #586e75; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20268bd2, stop:0.5 #10268bd2, stop:1.0 #20268bd2 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #268bd2; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedBrightCyan.qss b/plugins/widgetboxmodel/share/themes/SolarizedBrightCyan.qss new file mode 100644 index 0000000..17c3917 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedBrightCyan.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #586e75; + background-color: #fdf6e3; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #fdf6e3; + border: 6px solid #2aa198; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #fdf6e3; + selection-background-color: #586e75; + background-color: #eee8d5; +} + +#settingsButton { + color : #2aa198; + background-color: #fdf6e3; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #586e75; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #202aa198, stop:0.5 #102aa198, stop:1.0 #202aa198 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #2aa198; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedBrightGreen.qss b/plugins/widgetboxmodel/share/themes/SolarizedBrightGreen.qss new file mode 100644 index 0000000..b1ffdf0 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedBrightGreen.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #586e75; + background-color: #fdf6e3; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #fdf6e3; + border: 6px solid #859900; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #fdf6e3; + selection-background-color: #586e75; + background-color: #eee8d5; +} + +#settingsButton { + color : #859900; + background-color: #fdf6e3; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #586e75; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20859900, stop:0.5 #10859900, stop:1.0 #20859900 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #859900; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedBrightMagenta.qss b/plugins/widgetboxmodel/share/themes/SolarizedBrightMagenta.qss new file mode 100644 index 0000000..01ba77a --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedBrightMagenta.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #586e75; + background-color: #fdf6e3; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #fdf6e3; + border: 6px solid #d33682; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #fdf6e3; + selection-background-color: #586e75; + background-color: #eee8d5; +} + +#settingsButton { + color : #d33682; + background-color: #fdf6e3; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #586e75; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20d33682, stop:0.5 #10d33682, stop:1.0 #20d33682 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #d33682; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedBrightOrange.qss b/plugins/widgetboxmodel/share/themes/SolarizedBrightOrange.qss new file mode 100644 index 0000000..a75c776 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedBrightOrange.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #586e75; + background-color: #fdf6e3; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #fdf6e3; + border: 6px solid #cb4b16; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #fdf6e3; + selection-background-color: #586e75; + background-color: #eee8d5; +} + +#settingsButton { + color : #cb4b16; + background-color: #fdf6e3; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #586e75; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20cb4b16, stop:0.5 #10cb4b16, stop:1.0 #20cb4b16 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #cb4b16; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedBrightRed.qss b/plugins/widgetboxmodel/share/themes/SolarizedBrightRed.qss new file mode 100644 index 0000000..3d6cbc0 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedBrightRed.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #586e75; + background-color: #fdf6e3; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #fdf6e3; + border: 6px solid #dc322f; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #fdf6e3; + selection-background-color: #586e75; + background-color: #eee8d5; +} + +#settingsButton { + color : #dc322f; + background-color: #fdf6e3; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #586e75; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20dc322f, stop:0.5 #10dc322f, stop:1.0 #20dc322f ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #dc322f; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedBrightViolet.qss b/plugins/widgetboxmodel/share/themes/SolarizedBrightViolet.qss new file mode 100644 index 0000000..3e6925f --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedBrightViolet.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #586e75; + background-color: #fdf6e3; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #fdf6e3; + border: 6px solid #6c71c4; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #fdf6e3; + selection-background-color: #586e75; + background-color: #eee8d5; +} + +#settingsButton { + color : #6c71c4; + background-color: #fdf6e3; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #586e75; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #206c71c4, stop:0.5 #106c71c4, stop:1.0 #206c71c4 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #6c71c4; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedBrightYellow.qss b/plugins/widgetboxmodel/share/themes/SolarizedBrightYellow.qss new file mode 100644 index 0000000..3364118 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedBrightYellow.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #586e75; + background-color: #fdf6e3; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #fdf6e3; + border: 6px solid #b58900; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #fdf6e3; + selection-background-color: #586e75; + background-color: #eee8d5; +} + +#settingsButton { + color : #b58900; + background-color: #fdf6e3; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #586e75; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20b58900, stop:0.5 #10b58900, stop:1.0 #20b58900 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #b58900; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedDarkBlue.qss b/plugins/widgetboxmodel/share/themes/SolarizedDarkBlue.qss new file mode 100644 index 0000000..09d865d --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedDarkBlue.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #93a1a1; + background-color: #002b36; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #002b36; + border: 6px solid #268bd2; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #002b36; + selection-background-color: #93a1a1; + background-color: #073642; +} + +#settingsButton { + color : #268bd2; + background-color: #002b36; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #93a1a1; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20268bd2, stop:0.5 #10268bd2, stop:1.0 #20268bd2 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #268bd2; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedDarkCyan.qss b/plugins/widgetboxmodel/share/themes/SolarizedDarkCyan.qss new file mode 100644 index 0000000..40fec68 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedDarkCyan.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #93a1a1; + background-color: #002b36; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #002b36; + border: 6px solid #2aa198; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #002b36; + selection-background-color: #93a1a1; + background-color: #073642; +} + +#settingsButton { + color : #2aa198; + background-color: #002b36; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #93a1a1; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #202aa198, stop:0.5 #102aa198, stop:1.0 #202aa198 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #2aa198; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedDarkGreen.qss b/plugins/widgetboxmodel/share/themes/SolarizedDarkGreen.qss new file mode 100644 index 0000000..93d6fad --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedDarkGreen.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #93a1a1; + background-color: #002b36; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #002b36; + border: 6px solid #859900; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #002b36; + selection-background-color: #93a1a1; + background-color: #073642; +} + +#settingsButton { + color : #859900; + background-color: #002b36; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #93a1a1; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20859900, stop:0.5 #10859900, stop:1.0 #20859900 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #859900; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedDarkMagenta.qss b/plugins/widgetboxmodel/share/themes/SolarizedDarkMagenta.qss new file mode 100644 index 0000000..7834a0b --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedDarkMagenta.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #93a1a1; + background-color: #002b36; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #002b36; + border: 6px solid #d33682; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #002b36; + selection-background-color: #93a1a1; + background-color: #073642; +} + +#settingsButton { + color : #d33682; + background-color: #002b36; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #93a1a1; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20d33682, stop:0.5 #10d33682, stop:1.0 #20d33682 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #d33682; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedDarkOrange.qss b/plugins/widgetboxmodel/share/themes/SolarizedDarkOrange.qss new file mode 100644 index 0000000..745ab12 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedDarkOrange.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #93a1a1; + background-color: #002b36; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #002b36; + border: 6px solid #cb4b16; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #002b36; + selection-background-color: #93a1a1; + background-color: #073642; +} + +#settingsButton { + color : #cb4b16; + background-color: #002b36; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #93a1a1; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20cb4b16, stop:0.5 #10cb4b16, stop:1.0 #20cb4b16 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #cb4b16; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedDarkRed.qss b/plugins/widgetboxmodel/share/themes/SolarizedDarkRed.qss new file mode 100644 index 0000000..361b89c --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedDarkRed.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #93a1a1; + background-color: #002b36; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #002b36; + border: 6px solid #dc322f; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #002b36; + selection-background-color: #93a1a1; + background-color: #073642; +} + +#settingsButton { + color : #dc322f; + background-color: #002b36; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #93a1a1; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20dc322f, stop:0.5 #10dc322f, stop:1.0 #20dc322f ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #dc322f; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedDarkViolet.qss b/plugins/widgetboxmodel/share/themes/SolarizedDarkViolet.qss new file mode 100644 index 0000000..89850fb --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedDarkViolet.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #93a1a1; + background-color: #002b36; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #002b36; + border: 6px solid #6c71c4; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #002b36; + selection-background-color: #93a1a1; + background-color: #073642; +} + +#settingsButton { + color : #6c71c4; + background-color: #002b36; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #93a1a1; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #206c71c4, stop:0.5 #106c71c4, stop:1.0 #206c71c4 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #6c71c4; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/SolarizedDarkYellow.qss b/plugins/widgetboxmodel/share/themes/SolarizedDarkYellow.qss new file mode 100644 index 0000000..8923138 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/SolarizedDarkYellow.qss @@ -0,0 +1,101 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #93a1a1; + background-color: #002b36; +} + +#frame { + padding: 6px; + border-radius: 12px; + background-color: #002b36; + border: 6px solid #b58900; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 2px; + border-radius: 2px; + font-size: 36px; + selection-color: #002b36; + selection-background-color: #93a1a1; + background-color: #073642; +} + +#settingsButton { + color : #b58900; + background-color: #002b36; + padding: 4px; + + /* Respect the frame border */ + margin: 6px 6px 0px 0px; + border-top-right-radius: 6px; + border-bottom-left-radius: 10px; + + /* Workaround for Qt to get fixed size button*/ + min-width:13px; + min-height:13px; + max-width:13px; + max-height:13px; +} + +/********** ListViews **********/ + +QListView { + background: transparent; + selection-color: #93a1a1; +} + +QListView::item:selected { + background: qlineargradient(x1:0, x2:1, stop:0.0 #20b58900, stop:0.5 #10b58900, stop:1.0 #20b58900 ); +} + +QListView QScrollBar:vertical { + width: 5px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #b58900; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 44px; + font-size: 26px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/Spotlight Dark.qss b/plugins/widgetboxmodel/share/themes/Spotlight Dark.qss new file mode 100644 index 0000000..1347f69 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Spotlight Dark.qss @@ -0,0 +1,88 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #030303; +} + +#frame { + padding: 6px 0px; + border-radius: 8px; + background-color: #030303; + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 0px 8px; + font-size: 36px; + selection-color: #030303; + selection-background-color: #808080; + background-color: transparent; +} + +#settingsButton { + margin: 6px 6px 0px 0px; + color: #202020; + background-color: transparent; + padding: 2px; + min-width:14px; + min-height:14px; + max-width:14px; + max-height:14px; +} + +/********** ListViews ************/ + +QListView { + background: transparent; + selection-color: #a0a0a0; +} + +QListView::item:selected { + background: #202020; +} + +QListView QScrollBar:vertical { + width: 3px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #404040; + border-radius: 1px; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 40px; + font-size: 24px; +} + +QListView#resultsList::item{ + padding: 8px 0px 0px 0px; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} diff --git a/plugins/widgetboxmodel/share/themes/Spotlight.qss b/plugins/widgetboxmodel/share/themes/Spotlight.qss new file mode 100644 index 0000000..fc21eb2 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Spotlight.qss @@ -0,0 +1,88 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + color : #808080; + background-color: #fcfcfc; +} + +#frame { + padding: 6px 0px; + border-radius: 8px; + background-color: #fcfcfc; + min-width:640px; + max-width:640px; +} + +#inputLine { + padding: 0px 8px; + font-size: 36px; + selection-color: #fcfcfc; + selection-background-color: #808080; + background-color: transparent; +} + +#settingsButton { + margin: 6px 6px 0px 0px; + color: #e0e0e0; + background-color: transparent; + padding: 2px; + min-width:14px; + min-height:14px; + max-width:14px; + max-height:14px; +} + +/********** ListViews ************/ + +QListView { + background: transparent; + selection-color: #606060; +} + +QListView::item:selected { + background: #e0e0e0; +} + +QListView QScrollBar:vertical { + width: 3px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #c0c0c0; + border-radius: 1px; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 40px; + font-size: 24px; +} + +QListView#resultsList::item{ + padding: 8px 0px 0px 0px; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} diff --git a/plugins/widgetboxmodel/share/themes/Yosemite Dark.qss b/plugins/widgetboxmodel/share/themes/Yosemite Dark.qss new file mode 100644 index 0000000..1f2ecc6 --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Yosemite Dark.qss @@ -0,0 +1,95 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + font-family:"DejaVu Sans"; + font-weight: 200; + color : #ffffff; + background-color: #f4000000; +} + +#frame { + padding: 12px; + border-radius: 5px; + background-color: #f4000000; + border: 1px solid #20808080; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + font-size: 36px; + selection-color: #f4000000; + selection-background-color: #ffffff; + background-color: transparent; +} + +#settingsButton { + color: #484848; + background-color: transparent; + padding: 8px; + + /* Workaround for Qt to get fixed size button*/ + min-width:14px; + min-height:14px; + max-width:14px; + max-height:14px; +} + +/********** ListViews ************/ + +QListView { + selection-color: #ffffff; +} + +QListView::item:selected { + background: #262626; +} + +QListView QScrollBar:vertical { + width: 2px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #484848; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 40px; + font-size: 22px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/share/themes/Yosemite.qss b/plugins/widgetboxmodel/share/themes/Yosemite.qss new file mode 100644 index 0000000..cb03aea --- /dev/null +++ b/plugins/widgetboxmodel/share/themes/Yosemite.qss @@ -0,0 +1,95 @@ +/* + * author: Manuel Schneider + * + * Check http://doc.qt.io/qt-5/stylesheet-syntax.html especially the subtopics: + * The Style Sheet Syntax (http://doc.qt.io/qt-5/stylesheet-syntax.html) + * Qt Style Sheets Reference (http://doc.qt.io/qt-5/stylesheet-reference.html) + */ + +* { + border: none; + font-family:"DejaVu Sans"; + font-weight: 200; + color : #000000; + background-color: #fcfcfc; +} + +#frame { + padding: 12px; + border-radius: 5px; + background-color: #fcfcfc; + border: 1px solid #20808080; + + /* Workaround for Qt to get fixed size button*/ + min-width:640px; + max-width:640px; +} + +#inputLine { + font-size: 36px; + selection-color: #fcfcfc; + selection-background-color: #000000; + background-color: transparent; +} + +#settingsButton { + color: #bdbdbd; + background-color: transparent; + padding: 8px; + + /* Workaround for Qt to get fixed size button*/ + min-width:14px; + min-height:14px; + max-width:14px; + max-height:14px; +} + +/********** ListViews ************/ + +QListView { + selection-color: #000000; +} + +QListView::item:selected { + background: #eeeeee; +} + +QListView QScrollBar:vertical { + width: 2px; + background: transparent; +} + +QListView QScrollBar::handle:vertical { + background: #e2e2e2; + min-height: 24px; +} + +QListView QScrollBar::add-line:vertical, QScrollBar::sub-line:vertical, +QListView QScrollBar::up-arrow:vertical, QScrollBar::down-arrow:vertical, +QListView QScrollBar::add-page:vertical, QScrollBar::sub-page:vertical { + border: 0px; + width: 0px; + height: 0px; + background: transparent; +} + +/********** actionList **********/ + +QListView#actionList { + font-size: 20px; +} + +QListView#actionList::item{ + height:28px; +} + +/********** resultsList **********/ + +QListView#resultsList { + icon-size: 40px; + font-size: 22px; +} + +QListView#resultsList::item{ + height:48px; +} diff --git a/plugins/widgetboxmodel/src/actionlist.cpp b/plugins/widgetboxmodel/src/actionlist.cpp new file mode 100644 index 0000000..2beb1e0 --- /dev/null +++ b/plugins/widgetboxmodel/src/actionlist.cpp @@ -0,0 +1,62 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include "actionlist.h" + +/** ***************************************************************************/ +WidgetBoxModel::ActionList::ActionList(QWidget *parent) : ResizingList(parent) { + setItemDelegate(new ActionDelegate); +} + + + +/** ***************************************************************************/ +bool WidgetBoxModel::ActionList::eventFilter(QObject*, QEvent *event) { + + if (event->type() == QEvent::KeyPress) { + QKeyEvent* keyEvent = static_cast(event); + switch (keyEvent->key()) { + + // Navigation + case Qt::Key_Up: + case Qt::Key_Down: + case Qt::Key_PageUp: + case Qt::Key_PageDown: + case Qt::Key_Home: + case Qt::Key_End: + // Activation + case Qt::Key_Enter: + case Qt::Key_Return: + keyPressEvent(keyEvent); + return false; + } + } + return false; +} + + + +/** ***************************************************************************/ +void WidgetBoxModel::ActionList::ActionDelegate::paint(QPainter *painter, const QStyleOptionViewItem &options, const QModelIndex &index) const { + + painter->save(); + + QStyleOptionViewItem option = options; + initStyleOption(&option, index); + + // Draw selection + option.widget->style()->drawPrimitive(QStyle::PE_PanelItemViewItem, &option, painter, option.widget); + + // Draw text + painter->setFont(option.font); + QString text = QFontMetrics(option.font).elidedText(index.data(Qt::DisplayRole).toString(), option.textElideMode, option.rect.width()); + option.widget->style()->drawItemText(painter, + option.rect, + Qt::AlignCenter|Qt::AlignHCenter, + option.palette, + option.state & QStyle::State_Enabled, + text, + (option.state & QStyle::State_Selected) ? QPalette::HighlightedText : QPalette::WindowText); + painter->restore(); +} diff --git a/plugins/widgetboxmodel/src/actionlist.h b/plugins/widgetboxmodel/src/actionlist.h new file mode 100644 index 0000000..a209569 --- /dev/null +++ b/plugins/widgetboxmodel/src/actionlist.h @@ -0,0 +1,39 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "resizinglist.h" +#include + +namespace WidgetBoxModel { + + +/** ***************************************************************************/ +class ActionList final : public ResizingList +{ + Q_OBJECT + class ActionDelegate; + +public: + + ActionList(QWidget *parent = 0); + +private: + + bool eventFilter(QObject*, QEvent *event) override; + +}; + + + +/** ***************************************************************************/ +class ActionList::ActionDelegate final : public QStyledItemDelegate +{ +public: + + ActionDelegate(QObject *parent = nullptr) : QStyledItemDelegate(parent) {} + + void paint(QPainter *painter, const QStyleOptionViewItem &options, const QModelIndex &index) const override; +}; + +} diff --git a/plugins/widgetboxmodel/src/configwidget.cpp b/plugins/widgetboxmodel/src/configwidget.cpp new file mode 100644 index 0000000..c4c7efd --- /dev/null +++ b/plugins/widgetboxmodel/src/configwidget.cpp @@ -0,0 +1,111 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include "configwidget.h" +#include "frontendwidget.h" +#include "ui_configwidget.h" +using namespace Core; + +class WidgetBoxModel::ConfigWidget::Private { +public: + WidgetBoxModel::Ui::ConfigWidget ui; + FrontendWidget *frontend = nullptr; +}; + + +/** ***********************************************************************************************/ +WidgetBoxModel::ConfigWidget::ConfigWidget(FrontendWidget *frontend, QWidget *parent) + : QWidget(parent), d(new Private) { + + d->ui.setupUi(this); + + d->frontend = frontend; + + // ALWAYS CENTER + d->ui.checkBox_center->setChecked(d->frontend->showCentered()); + connect(d->ui.checkBox_center, &QCheckBox::toggled, + d->frontend, &FrontendWidget::setShowCentered); + + // ALWAYS ON TOP + d->ui.checkBox_onTop->setChecked(d->frontend->alwaysOnTop()); + connect(d->ui.checkBox_onTop, &QCheckBox::toggled, + d->frontend, &FrontendWidget::setAlwaysOnTop); + + // HIDE ON FOCUS OUT + d->ui.checkBox_hideOnFocusOut->setChecked(d->frontend->hideOnFocusLoss()); + connect(d->ui.checkBox_hideOnFocusOut, &QCheckBox::toggled, + d->frontend, &FrontendWidget::setHideOnFocusLoss); + + // HIDE ON CLOSE + d->ui.checkBox_hideOnClose->setChecked(d->frontend->hideOnClose()); + connect(d->ui.checkBox_hideOnClose, &QCheckBox::toggled, + d->frontend, &FrontendWidget::setHideOnClose); + + // CLEAR ON HIDE + d->ui.checkBox_clearOnHide->setChecked(d->frontend->clearOnHide()); + connect(d->ui.checkBox_clearOnHide, &QCheckBox::toggled, + d->frontend, &FrontendWidget::setClearOnHide); + + // MAX RESULTS + d->ui.spinBox_results->setValue(d->frontend->maxResults()); + connect(d->ui.spinBox_results, static_cast(&QSpinBox::valueChanged), + d->frontend, &FrontendWidget::setMaxResults); + + // DISPLAY SCROLLBAR + d->ui.checkBox_scrollbar->setChecked(d->frontend->displayScrollbar()); + connect(d->ui.checkBox_scrollbar, &QCheckBox::toggled, + d->frontend, &FrontendWidget::setDisplayScrollbar); + + // DISPLAY ICONS + d->ui.checkBox_icons->setChecked(d->frontend->displayIcons()); + connect(d->ui.checkBox_icons, &QCheckBox::toggled, + d->frontend, &FrontendWidget::setDisplayIcons); + + // DISPLAY SHADOW + d->ui.checkBox_shadow->setChecked(d->frontend->displayShadow()); + connect(d->ui.checkBox_shadow, &QCheckBox::toggled, + d->frontend, &FrontendWidget::setDisplayShadow); + + // THEMES + QStringList pluginDataPaths = QStandardPaths::locateAll(QStandardPaths::AppDataLocation, + "org.albert.frontend.widgetboxmodel", + QStandardPaths::LocateDirectory); + + QFileInfoList themes; + for (const QString &pluginDataPath : pluginDataPaths) + themes << QDir(QString("%1/themes").arg(pluginDataPath)) + .entryInfoList(QStringList("*.qss"), QDir::Files | QDir::NoSymLinks); + + for (const QFileInfo &fi : themes) { + d->ui.comboBox_themes->addItem(fi.baseName(), fi.canonicalFilePath()); + if ( fi.baseName() == d->frontend->theme()) + d->ui.comboBox_themes->setCurrentIndex(d->ui.comboBox_themes->count()-1); + } + + connect(d->ui.comboBox_themes, static_cast(&QComboBox::currentIndexChanged), + [this](int i){ + // Apply and save the theme + QString currentTheme = d->frontend->theme(); + if (!d->frontend->setTheme(d->ui.comboBox_themes->itemText(i))) { + QMessageBox(QMessageBox::Critical, "Error", + "Could not apply theme.", + QMessageBox::NoButton, + this).exec(); + if (!d->frontend->setTheme(currentTheme)) { + qFatal("Rolling back theme failed."); + } + } + }); +} + + +/** ***********************************************************************************************/ +WidgetBoxModel::ConfigWidget::~ConfigWidget() { + // Needed since default dtor of unique ptr in the header has to know the type +} diff --git a/plugins/widgetboxmodel/src/configwidget.h b/plugins/widgetboxmodel/src/configwidget.h new file mode 100644 index 0000000..1f27a99 --- /dev/null +++ b/plugins/widgetboxmodel/src/configwidget.h @@ -0,0 +1,28 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include + +namespace WidgetBoxModel { + +class FrontendWidget; + +class ConfigWidget final : public QWidget +{ + Q_OBJECT + + class Private; + +public: + + ConfigWidget(FrontendWidget *frontend, QWidget *parent); + ~ConfigWidget(); + +private: + + std::unique_ptr d; + +}; + +} diff --git a/plugins/widgetboxmodel/src/configwidget.ui b/plugins/widgetboxmodel/src/configwidget.ui new file mode 100644 index 0000000..a723e58 --- /dev/null +++ b/plugins/widgetboxmodel/src/configwidget.ui @@ -0,0 +1,296 @@ + + + WidgetBoxModel::ConfigWidget + + + Frontend settings + + + + + + + + User Interface + + + + Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter + + + + + + 0 + 0 + + + + Theme: + + + + + + + + 0 + 0 + + + + + + + + + 0 + 0 + + + + Amount of results: + + + + + + + + 0 + 0 + + + + + + + 1 + + + 10 + + + + + + + + 0 + 0 + + + + Display scrollbar: + + + + + + + + 0 + 0 + + + + <html><head/><body><p>If this option is enabled, albert displays a scrollbar in the results list.</p></body></html> + + + + + + + + 0 + 0 + + + + Display icons: + + + + + + + + 0 + 0 + + + + <html><head/><body><p>If this option is enabled, albert displays icons provided by the items.</p></body></html> + + + + + + + Display shadow: + + + + + + + + 0 + 0 + + + + <html><head/><body><p>If this option is enabled, albert displays a shadow below the widget. Note that the shadow area appears to be transparent, but it is not for mouse clicks due to Qt limitations. However its just a handful of pixels and you can use it to drag the window.</p></body></html> + + + + + + + + 0 + 0 + + + + Hide on close: + + + + + + + + 0 + 0 + + + + <html><head/><body><p>If the user closes the main window, the main window gets hidden instead of the application getting quit.</p></body></html> + + + + + + + + 0 + 0 + + + + Always center Albert: + + + + + + + + 0 + 0 + + + + <html><head/><body><p>If this option is enabled, albert centers the main window in the screen where the pointer resides.</p></body></html> + + + + + + + + 0 + 0 + + + + Always on top: + + + + + + + + 0 + 0 + + + + <html><head/><body><p>If this option is enabled, albert will stay on top of all top level windows.</p></body></html> + + + + + + + + 0 + 0 + + + + Hide on focus out: + + + + + + + + 0 + 0 + + + + <html><head/><body><p>Hide the main window, if it lost keyboard focus, e.g. by clicking on another app or changing the window with Alt+Tab. Note that this feature is automatically disabled as long as the settings widget is open.</p></body></html> + + + + + + + Clear on hide: + + + + + + + + 0 + 0 + + + + <html><head/><body><p>Clear the input line when the window is hidden.</p></body></html> + + + + + + + + + + + + + Qt::Vertical + + + + 0 + 0 + + + + + + + + + + + diff --git a/plugins/widgetboxmodel/src/frontend.ui b/plugins/widgetboxmodel/src/frontend.ui new file mode 100644 index 0000000..222b860 --- /dev/null +++ b/plugins/widgetboxmodel/src/frontend.ui @@ -0,0 +1,92 @@ + + + WidgetBoxModel::MainWindow + + + + QLayout::SetFixedSize + + + 0 + + + 0 + + + 0 + + + 0 + + + + + + 0 + + + 0 + + + 0 + + + 0 + + + + + + + + QFrame::NoFrame + + + Qt::ScrollBarAlwaysOff + + + QAbstractItemView::NoEditTriggers + + + true + + + + + + + + 0 + 0 + + + + QFrame::NoFrame + + + QAbstractItemView::NoEditTriggers + + + true + + + + + + + + + + + ResultsList + QListView +
    resultslist.h
    +     + + ActionList + QListView +
    actionlist.h
    +     +     + +     diff --git a/plugins/widgetboxmodel/src/frontendplugin.cpp b/plugins/widgetboxmodel/src/frontendplugin.cpp new file mode 100644 index 0000000..bda835c --- /dev/null +++ b/plugins/widgetboxmodel/src/frontendplugin.cpp @@ -0,0 +1,65 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "frontendwidget.h" +#include "frontendplugin.h" + + +/** ***************************************************************************/ +WidgetBoxModel::FrontendPlugin::FrontendPlugin() + : Frontend("org.albert.frontend.widgetboxmodel"), + frontendWidget_(new FrontendWidget(&settings())){ + + connect(frontendWidget_.get(), &FrontendWidget::inputChanged, + this, &Frontend::inputChanged); + + connect(frontendWidget_.get(), &FrontendWidget::settingsWidgetRequested, + this, &Frontend::settingsWidgetRequested); + + connect(frontendWidget_.get(), &FrontendWidget::widgetShown, + this, &Frontend::widgetShown); + + connect(frontendWidget_.get(), &FrontendWidget::widgetHidden, + this, &Frontend::widgetHidden); +} + + +/** ***************************************************************************/ +WidgetBoxModel::FrontendPlugin::~FrontendPlugin() { +} + + +/** ***************************************************************************/ +bool WidgetBoxModel::FrontendPlugin::isVisible() { + return frontendWidget_->isVisible(); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendPlugin::setVisible(bool visible) { + frontendWidget_->setVisible(visible); +} + + +/** ***************************************************************************/ +QString WidgetBoxModel::FrontendPlugin::input() { + return frontendWidget_->input(); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendPlugin::setInput(const QString &input) { + frontendWidget_->setInput(input); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendPlugin::setModel(QAbstractItemModel *m) { + frontendWidget_->setModel(m); +} + + +/** ***************************************************************************/ +QWidget *WidgetBoxModel::FrontendPlugin::widget(QWidget *parent) { + return frontendWidget_->widget(parent); +} + diff --git a/plugins/widgetboxmodel/src/frontendplugin.h b/plugins/widgetboxmodel/src/frontendplugin.h new file mode 100644 index 0000000..c922de8 --- /dev/null +++ b/plugins/widgetboxmodel/src/frontendplugin.h @@ -0,0 +1,37 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include "albert/frontend.h" + +namespace WidgetBoxModel { + +class FrontendWidget; + +class FrontendPlugin final : public Core::Frontend +{ + Q_OBJECT + Q_PLUGIN_METADATA(IID ALBERT_FRONTEND_IID FILE "metadata.json") + +public: + + FrontendPlugin(); + ~FrontendPlugin(); + + bool isVisible() override; + void setVisible(bool visible) override; + + QString input() override; + void setInput(const QString&) override; + + void setModel(QAbstractItemModel *) override; + + QWidget* widget(QWidget *parent = nullptr) override; + +private: + + std::unique_ptr frontendWidget_; +}; + +} diff --git a/plugins/widgetboxmodel/src/frontendwidget.cpp b/plugins/widgetboxmodel/src/frontendwidget.cpp new file mode 100644 index 0000000..3172d3e --- /dev/null +++ b/plugins/widgetboxmodel/src/frontendwidget.cpp @@ -0,0 +1,725 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "albert/util/history.h" +#include "albert/util/itemroles.h" +#include "configwidget.h" +#include "frontendwidget.h" +#include "resultslist.h" +#include "settingsbutton.h" +#include "ui_frontend.h" + +#ifdef __unix__ +#include "xcb/xcb.h" +#include +#undef KeyPress +#undef KeyRelease +#include +#endif + + +namespace { + +const char* CFG_WND_POS = "windowPosition"; +const char* CFG_CENTERED = "showCentered"; +const bool DEF_CENTERED = true; +const char* CFG_THEME = "theme"; +const char* DEF_THEME = "Bright"; +const char* CFG_HIDE_ON_FOCUS_LOSS = "hideOnFocusLoss"; +const bool DEF_HIDE_ON_FOCUS_LOSS = true; +const char* CFG_HIDE_ON_CLOSE = "hideOnClose"; +const bool DEF_HIDE_ON_CLOSE = false; +const char* CFG_CLEAR_ON_HIDE = "clearOnHide"; +const bool DEF_CLEAR_ON_HIDE = false; +const char* CFG_ALWAYS_ON_TOP = "alwaysOnTop"; +const bool DEF_ALWAYS_ON_TOP = true; +const char* CFG_MAX_RESULTS = "itemCount"; +const uint8_t DEF_MAX_RESULTS = 5; +const char* CFG_DISPLAY_SCROLLBAR = "displayScrollbar"; +const bool DEF_DISPLAY_SCROLLBAR = false; +const char* CFG_DISPLAY_ICONS = "displayIcons"; +const bool DEF_DISPLAY_ICONS = true; +const char* CFG_DISPLAY_SHADOW = "displayShadow"; +const bool DEF_DISPLAY_SHADOW = true; + +} + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ + +class WidgetBoxModel::FrontendWidget::Private +{ +public: + + /** The name of the current theme */ + QString theme_; + + /** The offset from cursor to topleft. Used when the window is dagged */ + QPoint clickOffset_; + + /** The model of the action list view */ + QStringListModel *actionsListModel_; + + /** The button to open the settings dialog */ + SettingsButton *settingsButton_; + + /** The input history */ + Core::History *history_; + + /** The modifier used to navigate directly in the history */ + Qt::KeyboardModifier historyMoveMod_; + + /** The form of the main app */ + Ui::MainWindow ui; + + QSettings *settings; + + /** Indicates that the app should be shown centered */ + bool showCentered_; + + /** Indicates that the app should be hidden on focus loss */ + bool hideOnFocusLoss_; + + /** Indicates that the app should be hidden on close event */ + bool hideOnClose_; + + /** Indcates the state that the app is in */ + bool actionsShown_; + + /** Indcates that a shadow should be drawn */ + bool displayShadow_; + + /** Indcates that the inputline should be cleared on hide */ + bool clearOnHide_; + +}; + +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +/** ***************************************************************************/ +WidgetBoxModel::FrontendWidget::FrontendWidget(QSettings *settings) : d(new Private) { + + d->actionsShown_ = false; + d->historyMoveMod_ = Qt::ControlModifier; + d->settings = settings; + + // INITIALIZE UI + d->ui.setupUi(this); +// setWindowIcon(qApp->windowIcon()); + setWindowTitle(qAppName()); + setWindowFlags(Qt::Tool + | Qt::WindowCloseButtonHint // No close event w/o this + | Qt::FramelessWindowHint); + setAttribute(Qt::WA_TranslucentBackground); + + QGraphicsDropShadowEffect* effect = new QGraphicsDropShadowEffect(this); + effect->setBlurRadius(20); + effect->setColor(QColor(0, 0, 0 , 192 )) ; + effect->setXOffset(0.0); + effect->setYOffset(3.0); + setGraphicsEffect(effect); + + // Disable tabbing completely + d->ui.actionList->setFocusPolicy(Qt::NoFocus); + d->ui.resultsList->setFocusPolicy(Qt::NoFocus); + + // Set initial event filter pipeline: window -> resultslist -> lineedit + d->ui.inputLine->installEventFilter(d->ui.resultsList); + d->ui.inputLine->installEventFilter(this); + + // Set stringlistmodel for actions view + d->actionsListModel_ = new QStringListModel(this); + d->ui.actionList->setModel(d->actionsListModel_); + + // Hide lists + d->ui.actionList->hide(); + d->ui.resultsList->hide(); + + // Settings button + d->settingsButton_ = new SettingsButton(this); + d->settingsButton_->setObjectName("settingsButton"); + d->settingsButton_->setFocusPolicy(Qt::NoFocus); + d->settingsButton_->setContextMenuPolicy(Qt::ActionsContextMenu); + + // Context menu of settingsbutton + QAction *action = new QAction("Settings", d->settingsButton_); + action->setShortcuts({QKeySequence("Ctrl+,"), QKeySequence("Alt+,")}); + connect(action, &QAction::triggered, this, &FrontendWidget::hide); + connect(action, &QAction::triggered, this, &FrontendWidget::settingsWidgetRequested); + connect(d->settingsButton_, &QPushButton::clicked, action, &QAction::trigger); + d->settingsButton_->addAction(action); + + action = new QAction("Hide", d->settingsButton_); + action->setShortcut(QKeySequence("Esc")); + connect(action, &QAction::triggered, this, &FrontendWidget::hide); + d->settingsButton_->addAction(action); + + action = new QAction("Separator", d->settingsButton_); + action->setSeparator(true); + d->settingsButton_->addAction(action); + + action = new QAction("Quit", d->settingsButton_); + action->setShortcut(QKeySequence("Alt+F4")); + connect(action, &QAction::triggered, qApp, &QApplication::quit); + d->settingsButton_->addAction(action); + + // History + d->history_ = new Core::History(this); + + /* + * Settings + */ + + setShowCentered(d->settings->value(CFG_CENTERED, DEF_CENTERED).toBool()); + if (!showCentered() && d->settings->contains(CFG_WND_POS) + && d->settings->value(CFG_WND_POS).canConvert(QMetaType::QPoint)) + move(d->settings->value(CFG_WND_POS).toPoint()); + setHideOnFocusLoss(d->settings->value(CFG_HIDE_ON_FOCUS_LOSS, DEF_HIDE_ON_FOCUS_LOSS).toBool()); + setHideOnClose(d->settings->value(CFG_HIDE_ON_CLOSE, DEF_HIDE_ON_CLOSE).toBool()); + setClearOnHide(d->settings->value(CFG_CLEAR_ON_HIDE, DEF_CLEAR_ON_HIDE).toBool()); + setAlwaysOnTop(d->settings->value(CFG_ALWAYS_ON_TOP, DEF_ALWAYS_ON_TOP).toBool()); + setMaxResults(d->settings->value(CFG_MAX_RESULTS, DEF_MAX_RESULTS).toUInt()); + setDisplayScrollbar(d->settings->value(CFG_DISPLAY_SCROLLBAR, DEF_DISPLAY_SCROLLBAR).toBool()); + setDisplayIcons(d->settings->value(CFG_DISPLAY_ICONS, DEF_DISPLAY_ICONS).toBool()); + setDisplayShadow(d->settings->value(CFG_DISPLAY_SHADOW, DEF_DISPLAY_SHADOW).toBool()); + d->theme_ = d->settings->value(CFG_THEME, DEF_THEME).toString(); + if (!setTheme(d->theme_)) + qFatal("FATAL: Stylefile not found: %s", d->theme_.toStdString().c_str()); + + + /* + * Signals + */ + + // Trigger query, if text changed + connect(d->ui.inputLine, &QLineEdit::textChanged, this, &FrontendWidget::inputChanged); + + // Hide the actionview, if text was changed + connect(d->ui.inputLine, &QLineEdit::textChanged, this, [this](){ setShowActions(false); }); + + // Reset history, if text was manually changed + connect(d->ui.inputLine, &QLineEdit::textEdited, d->history_, &Core::History::resetIterator); + + // Hide the actionview, if another item gets clicked + connect(d->ui.resultsList, &ResultsList::pressed, this, [this](){ setShowActions(false); }); + + // Trigger default action, if item in resultslist was activated + QObject::connect(d->ui.resultsList, &ResultsList::activated, [this](const QModelIndex &index){ + + switch (qApp->queryKeyboardModifiers()) { + case Qt::MetaModifier: // Default fallback action (Meta) + d->ui.resultsList->model()->setData(index, -1, Core::ItemRoles::FallbackRole); + break; + default: // DefaultAction + d->ui.resultsList->model()->setData(index, -1, Core::ItemRoles::ActionRole); + break; + } + + // Do not move this up! (Invalidates index) + d->history_->add(d->ui.inputLine->text()); + this->setVisible(false); + d->ui.inputLine->clear(); + }); + + // Trigger alternative action, if item in actionList was activated + QObject::connect(d->ui.actionList, &ActionList::activated, [this](const QModelIndex &index){ + d->history_->add(d->ui.inputLine->text()); + d->ui.resultsList->model()->setData(d->ui.resultsList->currentIndex(), index.row(), Core::ItemRoles::AltActionRole); + this->setVisible(false); + d->ui.inputLine->clear(); + }); +} + + +/** ***************************************************************************/ +WidgetBoxModel::FrontendWidget::~FrontendWidget() { + // Needed since default dtor of unique ptr in the header has to know the type +} + + +/** ***************************************************************************/ +bool WidgetBoxModel::FrontendWidget::isVisible() { + return QWidget::isVisible(); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::setVisible(bool visible) { + + // Skip if nothing to do + if ( (isVisible() && visible) || !(isVisible() || visible) ) + return; + + QWidget::setVisible(visible); + + if (visible) { + // Move widget after showing it since QWidget::move works only on widgets + // that have been shown once. Well as long as this does not introduce ugly + // flicker this may be okay. + if (d->showCentered_){ + QDesktopWidget *dw = QApplication::desktop(); + this->move(dw->screenGeometry(dw->screenNumber(QCursor::pos())).center() + -QPoint(rect().right()/2,256 )); + } + this->raise(); + this->activateWindow(); + d->ui.inputLine->setFocus(); + emit widgetShown(); + } else { + setShowActions(false); + d->history_->resetIterator(); + ( d->clearOnHide_ ) ? d->ui.inputLine->clear() : d->ui.inputLine->selectAll(); + emit widgetHidden(); + } +} + + +/** ***************************************************************************/ +QString WidgetBoxModel::FrontendWidget::input() { + return d->ui.inputLine->text(); +} + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::setInput(const QString &input) { + d->ui.inputLine->setText(input); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::setModel(QAbstractItemModel *m) { + d->ui.resultsList->setModel(m); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::setShowCentered(bool b) { + d->settings->setValue(CFG_CENTERED, b); + d->showCentered_ = b; +} + + +/** ***************************************************************************/ +bool WidgetBoxModel::FrontendWidget::showCentered() const { + return d->showCentered_; +} + + +/** ***************************************************************************/ +const QString &WidgetBoxModel::FrontendWidget::theme() const { + return d->theme_; +} + + +/** ***************************************************************************/ +bool WidgetBoxModel::FrontendWidget::setTheme(const QString &theme) { + d->theme_ = theme; + QFileInfoList themes; + + + QStringList pluginDataPaths = QStandardPaths::locateAll(QStandardPaths::AppDataLocation, + "org.albert.frontend.widgetboxmodel", + QStandardPaths::LocateDirectory); + + for (const QString &pluginDataPath : pluginDataPaths) + themes << QDir(QString("%1/themes").arg(pluginDataPath)) + .entryInfoList(QStringList("*.qss"), QDir::Files | QDir::NoSymLinks); + + // Find and apply the theme + bool success = false; + for (const QFileInfo &fi : themes) { + if (fi.baseName() == d->theme_) { + QFile f(fi.canonicalFilePath()); + if (f.open(QFile::ReadOnly)) { + d->settings->setValue(CFG_THEME, d->theme_); + setStyleSheet(f.readAll()); + f.close(); + success = true; + break; + } + } + } + return success; +} + + +/** ***************************************************************************/ +bool WidgetBoxModel::FrontendWidget::hideOnFocusLoss() const { + return d->hideOnFocusLoss_; +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::setHideOnFocusLoss(bool b) { + d->settings->setValue(CFG_HIDE_ON_FOCUS_LOSS, b); + d->hideOnFocusLoss_ = b; +} + + +/** ***************************************************************************/ +bool WidgetBoxModel::FrontendWidget::hideOnClose() const { + return d->hideOnClose_; +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::setHideOnClose(bool b) { + d->settings->setValue(CFG_HIDE_ON_CLOSE, b); + d->hideOnClose_ = b; +} + + +/** ***************************************************************************/ +bool WidgetBoxModel::FrontendWidget::clearOnHide() const { + return d->clearOnHide_; +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::setClearOnHide(bool b) { + d->settings->setValue(CFG_CLEAR_ON_HIDE, b); + d->clearOnHide_ = b; +} + + +/** ***************************************************************************/ +bool WidgetBoxModel::FrontendWidget::alwaysOnTop() const { + return windowFlags().testFlag(Qt::WindowStaysOnTopHint); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::setAlwaysOnTop(bool alwaysOnTop) { + d->settings->setValue(CFG_ALWAYS_ON_TOP, alwaysOnTop); + // TODO: QT_MINREL 5.7 setFlag + alwaysOnTop ? setWindowFlags(windowFlags() | Qt::WindowStaysOnTopHint) + : setWindowFlags(windowFlags() & ~Qt::WindowStaysOnTopHint); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::setMaxResults(uint maxItems) { + d->settings->setValue(CFG_MAX_RESULTS, maxItems); + d->ui.resultsList->setMaxItems(maxItems); +} + + +/** ***************************************************************************/ +bool WidgetBoxModel::FrontendWidget::displayIcons() const { + return d->ui.resultsList->displayIcons(); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::setDisplayIcons(bool value) { + d->settings->setValue(CFG_DISPLAY_ICONS, value); + d->ui.resultsList->setDisplayIcons(value); +} + + +/** ***************************************************************************/ +bool WidgetBoxModel::FrontendWidget::displayScrollbar() const { + return d->ui.resultsList->verticalScrollBarPolicy() != Qt::ScrollBarAlwaysOff; +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::setDisplayScrollbar(bool value) { + d->settings->setValue(CFG_DISPLAY_SCROLLBAR, value); + d->ui.resultsList->setVerticalScrollBarPolicy( + value ? Qt::ScrollBarAsNeeded : Qt::ScrollBarAlwaysOff); +} + + +/** ***************************************************************************/ +bool WidgetBoxModel::FrontendWidget::displayShadow() const { + return d->displayShadow_; +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::setDisplayShadow(bool value) { + d->settings->setValue(CFG_DISPLAY_SHADOW, value); + d->displayShadow_ = value; + graphicsEffect()->setEnabled(value); + value ? setContentsMargins(20,20,20,20) : setContentsMargins(0,0,0,0); +} + + +/** ***************************************************************************/ +uint WidgetBoxModel::FrontendWidget::maxResults() const { + return d->ui.resultsList->maxItems(); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::setShowActions(bool showActions) { + + // Show actions + if ( showActions && !d->actionsShown_ ) { + + // Skip if nothing selected + if ( !d->ui.resultsList->currentIndex().isValid()) + return; + + // Get actions + d->actionsListModel_->setStringList(d->ui.resultsList->model()->data( + d->ui.resultsList->currentIndex(), + Core::ItemRoles::AltActionRole).toStringList()); + + // Skip if actions are empty + if (d->actionsListModel_->rowCount() < 1) + return; + + d->ui.actionList->setCurrentIndex(d->actionsListModel_->index(0, 0, d->ui.actionList->rootIndex())); + d->ui.actionList->show(); + + // Change event filter pipeline: window -> _action_list -> lineedit + d->ui.inputLine->removeEventFilter(this); + d->ui.inputLine->removeEventFilter(d->ui.resultsList); + d->ui.inputLine->installEventFilter(d->ui.actionList); + d->ui.inputLine->installEventFilter(this); + + // Finally set the state + d->actionsShown_ = true; + } + + // Hide actions + if ( !showActions && d->actionsShown_ ) { + + d->ui.actionList->hide(); + + // Change event filter pipeline: window -> resultslist -> lineedit + d->ui.inputLine->removeEventFilter(this); + d->ui.inputLine->removeEventFilter(d->ui.actionList); + d->ui.inputLine->installEventFilter(d->ui.resultsList); + d->ui.inputLine->installEventFilter(this); + + // Finally set the state + d->actionsShown_ = false; + } +} + + +/** ***************************************************************************/ +QWidget *WidgetBoxModel::FrontendWidget::widget(QWidget *parent) { + return new ConfigWidget(this, parent); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::closeEvent(QCloseEvent *event) { + event->accept(); + if (!d->hideOnClose_) + qApp->quit(); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::resizeEvent(QResizeEvent *event) { + + // Let settingsbutton be in top right corner of frame + d->settingsButton_->move(d->ui.frame->geometry().topRight() - QPoint(d->settingsButton_->width()-1,0)); + +#ifdef __unix__ + // Keep the input shape consistent + int shape_event_base, shape_error_base; + if (XShapeQueryExtension(QX11Info::display(), &shape_event_base, &shape_error_base)) { + + Region region = XCreateRegion(); + XRectangle rectangle; + int scalefactor = devicePixelRatio(); // TODO Qt>5.6 devicePixelRatioF + rectangle.x = static_cast(d->ui.frame->geometry().x()*scalefactor); + rectangle.y = static_cast(d->ui.frame->geometry().y()*scalefactor); + rectangle.width = static_cast(d->ui.frame->geometry().width()*scalefactor); + rectangle.height = static_cast(d->ui.frame->geometry().height()*scalefactor); + XUnionRectWithRegion(&rectangle, region, region); + XShapeCombineRegion(QX11Info::display(), winId(), ShapeInput, 0, 0, region, ShapeSet); + XDestroyRegion(region); + } +#endif + + QWidget::resizeEvent(event); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::mouseMoveEvent(QMouseEvent *event) { + // Move the widget with the mouse + move(event->globalPos() - d->clickOffset_); + QWidget::mouseMoveEvent(event); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::mousePressEvent(QMouseEvent *event) { + // Save the offset on press for movement calculations + d->clickOffset_ = event->pos(); + QWidget::mousePressEvent(event); +} + + +/** ***************************************************************************/ +void WidgetBoxModel::FrontendWidget::mouseReleaseEvent(QMouseEvent *event) { + // Save the window position () + d->settings->setValue(CFG_WND_POS, pos()); + QWidget::mousePressEvent(event); +} + + +/** ***************************************************************************/ +bool WidgetBoxModel::FrontendWidget::eventFilter(QObject *, QEvent *event) { + + if ( event->type() == QEvent::KeyPress ) { + QKeyEvent* keyEvent = static_cast(event); + switch (keyEvent->key()) { + + // Toggle insert completion string + case Qt::Key_Tab: + if ( d->ui.resultsList->currentIndex().isValid() ) + d->ui.inputLine->setText( + d->ui.resultsList->model()->data( + d->ui.resultsList->currentIndex(), Core::ItemRoles::CompletionRole + ).toString() + ); + return true; + + case Qt::Key_Alt: + setShowActions(true); + return true; + + case Qt::Key_Up:{ + // Move up in the history + if ( !d->ui.resultsList->currentIndex().isValid() // Empty list + || keyEvent->modifiers() == d->historyMoveMod_ // MoveMod (Ctrl) hold + || ( !d->actionsShown_ // Not in actions state... + && d->ui.resultsList->currentIndex().row()==0 && !keyEvent->isAutoRepeat() ) ){ // ... and first row (non repeat) + QString next = d->history_->next(); + if (!next.isEmpty()) + d->ui.inputLine->setText(next); + return true; + } + return false; + } + + // Move down in the history + case Qt::Key_Down:{ + if ( !d->actionsShown_ && keyEvent->modifiers() == Qt::ControlModifier ) { + QString prev = d->history_->prev(); + if (!prev.isEmpty()) + d->ui.inputLine->setText(prev); + return true; + } + } + } + } + + if ( event->type() == QEvent::KeyRelease ) { + QKeyEvent* keyEvent = static_cast(event); + switch (keyEvent->key()) { + case Qt::Key_Alt: + setShowActions(false); + return true; + } + } + + if (event->type() == QEvent::Wheel) { + QWheelEvent* wheelEvent = static_cast(event); + if ( wheelEvent->angleDelta().y() > 0 ) { + QString next = d->history_->next(); + if (!next.isEmpty()) + d->ui.inputLine->setText(next); + } else { + QString prev = d->history_->prev(); + if (!prev.isEmpty()) + d->ui.inputLine->setText(prev); + } + } + + return false; +} + + +#ifdef Q_OS_LINUX +/** **************************************************************************** + * @brief MainWidget::nativeEvent + * + * The purpose of this function is to hide in special casesonly. + */ +bool WidgetBoxModel::FrontendWidget::nativeEvent(const QByteArray &eventType, void *message, long *) +{ + if (eventType == "xcb_generic_event_t") + { + xcb_generic_event_t* event = static_cast(message); + switch (event->response_type & 127) + { + case XCB_FOCUS_OUT: { + /* This is a horribly hackish but working solution. + + A triggered key grab on X11 steals the focus of the window for short + period of time. This may result in the following annoying behaviour: + When the hotkey is pressed and X11 steals the focus there arises a + race condition between the hotkey event and the focus out event. + When the app is visible and the focus out event is delivered the app + gets hidden. Finally when the hotkey is received the app gets shown + again although the user intended to hide the app with the hotkey. + + Solutions: + Although X11 differs between the two focus out events, qt does not. + One might install a native event filter and use the XCB structs to + decide which type of event is delivered, but this approach is not + platform independent (unless designed so explicitely, but its a + hassle). The behaviour was expected when the app hides on: + + (mode==XCB_NOTIFY_MODE_GRAB && detail==XCB_NOTIFY_DETAIL_NONLINEAR)|| + (mode==XCB_NOTIFY_MODE_NORMAL && detail==XCB_NOTIFY_DETAIL_NONLINEAR) + (Check Xlib Programming Manual) + + Another much simpler but less elegant solution is to delay the + hiding a few milliseconds, so that the hotkey event will always be + handled first. */ + + xcb_focus_out_event_t *fe = reinterpret_cast(event); +// qDebug() << "MainWidget::nativeEvent::XCB_FOCUS_OUT\t"; +// switch (fe->mode) { +// case XCB_NOTIFY_MODE_NORMAL: qDebug() << "XCB_NOTIFY_MODE_NORMAL";break; +// case XCB_NOTIFY_MODE_GRAB: qDebug() << "XCB_NOTIFY_MODE_GRAB";break; +// case XCB_NOTIFY_MODE_UNGRAB: qDebug() << "XCB_NOTIFY_MODE_UNGRAB";break; +// case XCB_NOTIFY_MODE_WHILE_GRABBED: qDebug() << "XCB_NOTIFY_MODE_WHILE_GRABBED";break; +// } +// switch (fe->detail) { +// case XCB_NOTIFY_DETAIL_ANCESTOR: qDebug() << "ANCESTOR";break; +// case XCB_NOTIFY_DETAIL_INFERIOR: qDebug() << "INFERIOR";break; +// case XCB_NOTIFY_DETAIL_NONE: qDebug() << "NONE";break; +// case XCB_NOTIFY_DETAIL_NONLINEAR: qDebug() << "NONLINEAR";break; +// case XCB_NOTIFY_DETAIL_NONLINEAR_VIRTUAL: qDebug() << "NONLINEAR_VIRTUAL";break; +// case XCB_NOTIFY_DETAIL_POINTER: qDebug() << "POINTER";break;break; +// case XCB_NOTIFY_DETAIL_POINTER_ROOT: qDebug() << "POINTER_ROOT"; +// case XCB_NOTIFY_DETAIL_VIRTUAL: qDebug() << "VIRTUAL";break; +// } + if ((/*(fe->mode==XCB_NOTIFY_MODE_GRAB && fe->detail==XCB_NOTIFY_DETAIL_NONLINEAR) ||*/ + (fe->mode==XCB_NOTIFY_MODE_NORMAL && fe->detail==XCB_NOTIFY_DETAIL_NONLINEAR )) && + d->hideOnFocusLoss_) + hide(); + } + } + } + return false; +} +#endif diff --git a/plugins/widgetboxmodel/src/frontendwidget.h b/plugins/widgetboxmodel/src/frontendwidget.h new file mode 100644 index 0000000..5b6df43 --- /dev/null +++ b/plugins/widgetboxmodel/src/frontendwidget.h @@ -0,0 +1,87 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include "albert/frontend.h" + +namespace WidgetBoxModel { + +class FrontendWidget final : public QWidget +{ + Q_OBJECT + + class Private; + +public: + + FrontendWidget(QSettings*); + ~FrontendWidget(); + + bool isVisible(); + void setVisible(bool visible) override; + + QString input(); + void setInput(const QString&); + + void setModel(QAbstractItemModel *); + + QWidget* widget(QWidget *parent = nullptr); + + const QString &theme() const; + bool setTheme(const QString& theme); + + uint maxResults() const; + void setMaxResults(uint max); + + bool showCentered() const; + void setShowCentered(bool b = true); + + bool hideOnFocusLoss() const; + void setHideOnFocusLoss(bool b = true); + + bool hideOnClose() const; + void setHideOnClose(bool b = true); + + bool clearOnHide() const; + void setClearOnHide(bool b = true); + + bool alwaysOnTop() const; + void setAlwaysOnTop(bool alwaysOnTop); + + bool displayIcons() const; + void setDisplayIcons(bool value); + + bool displayScrollbar() const; + void setDisplayScrollbar(bool value); + + bool displayShadow() const; + void setDisplayShadow(bool value); + + +protected: + + void closeEvent(QCloseEvent* event) override; + void mouseMoveEvent(QMouseEvent* event) override; + void mousePressEvent(QMouseEvent * event) override; + void mouseReleaseEvent(QMouseEvent * event) override; + void resizeEvent(QResizeEvent* event) override; + bool nativeEvent(const QByteArray &eventType, void *message, long *) override; + bool eventFilter(QObject*, QEvent *event) override; + + void setShowActions(bool showActions); + +private: + + std::unique_ptr d; + +signals: + + void widgetShown(); + void widgetHidden(); + void inputChanged(QString qry); + void settingsWidgetRequested(); +}; + +} diff --git a/plugins/widgetboxmodel/src/resizinglist.cpp b/plugins/widgetboxmodel/src/resizinglist.cpp new file mode 100644 index 0000000..09a4334 --- /dev/null +++ b/plugins/widgetboxmodel/src/resizinglist.cpp @@ -0,0 +1,72 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "resizinglist.h" +#include + +/** ***************************************************************************/ +uint WidgetBoxModel::ResizingList::maxItems() const { + return maxItems_; +} + + + +/** ***************************************************************************/ +void WidgetBoxModel::ResizingList::setMaxItems(uint maxItems) { + maxItems_ = maxItems; + updateGeometry(); +} + + + +/** ***************************************************************************/ +QSize WidgetBoxModel::ResizingList::sizeHint() const { + if (model() == nullptr) + return QSize(); + return QSize(width(), sizeHintForRow(0) * std::min(static_cast(maxItems_), model()->rowCount(rootIndex()))); +} + + + +/** ***************************************************************************/ +QSize WidgetBoxModel::ResizingList::minimumSizeHint() const { + return QSize(0,0); // Fix for small lists +} + + + +/** ***************************************************************************/ +void WidgetBoxModel::ResizingList::setModel(QAbstractItemModel * m) { + if (model() == m) + return; + + if (model()!=nullptr) { + disconnect(this->model(), &QAbstractItemModel::rowsInserted, this, &ResizingList::updateAppearance); + disconnect(this->model(), &QAbstractItemModel::modelReset, this, &ResizingList::updateAppearance); + } + + QItemSelectionModel *sm = selectionModel(); + QAbstractItemView::setModel(m); + delete sm; + updateAppearance(); + + // If not empty show and select first, update geom. If not null connect. + if (model()!=nullptr) { + connect(this->model(), &QAbstractItemModel::rowsInserted, this, &ResizingList::updateAppearance); + connect(this->model(), &QAbstractItemModel::modelReset, this, &ResizingList::updateAppearance); + } +} + + + +/** ***************************************************************************/ +void WidgetBoxModel::ResizingList::updateAppearance() { + if ( model() == nullptr || model()->rowCount() == 0 ) + hide(); + else { + show(); + if ( !currentIndex().isValid() ) + setCurrentIndex(model()->index(0, 0)); + updateGeometry(); + } +} + diff --git a/plugins/widgetboxmodel/src/resizinglist.h b/plugins/widgetboxmodel/src/resizinglist.h new file mode 100644 index 0000000..5b43eab --- /dev/null +++ b/plugins/widgetboxmodel/src/resizinglist.h @@ -0,0 +1,37 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include + +namespace WidgetBoxModel { + +class ResizingList : public QListView +{ + Q_OBJECT + Q_PROPERTY(int maxItems READ maxItems WRITE setMaxItems MEMBER maxItems_ NOTIFY maxItemsChanged) + +public: + + ResizingList(QWidget *parent = 0) : QListView(parent), maxItems_(5) {} + virtual ~ResizingList() {} + + uint maxItems() const; + void setMaxItems(uint maxItems); + + QSize minimumSizeHint() const override; + QSize sizeHint() const override; + void setModel(QAbstractItemModel * model) override; + +private: + + void updateAppearance(); + + uint maxItems_; + +signals: + + void maxItemsChanged(); + +}; + +} diff --git a/plugins/widgetboxmodel/src/resultslist.cpp b/plugins/widgetboxmodel/src/resultslist.cpp new file mode 100644 index 0000000..4650389 --- /dev/null +++ b/plugins/widgetboxmodel/src/resultslist.cpp @@ -0,0 +1,281 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include "resultslist.h" +#include "albert/util/itemroles.h" + +/** ***************************************************************************/ +class WidgetBoxModel::ResultsList::ItemDelegate final : public QStyledItemDelegate +{ +public: + ItemDelegate(QObject *parent = nullptr) + : QStyledItemDelegate(parent), drawIcon(true), subTextRole(Core::ItemRoles::ToolTipRole) {} + + void paint(QPainter *painter, const QStyleOptionViewItem &options, const QModelIndex &index) const override; + + bool drawIcon; + int subTextRole; +}; + + + +/** ***************************************************************************/ +WidgetBoxModel::ResultsList::ResultsList(QWidget *parent) : ResizingList(parent) { + setItemDelegate(delegate_ = new ItemDelegate(this)); + + // Single click activation (segfaults without queued connection) + connect(this, &ResultsList::clicked, this, &ResultsList::activated, Qt::QueuedConnection); +} + + + +/** ***************************************************************************/ +bool WidgetBoxModel::ResultsList::displayIcons() const { + return delegate_->drawIcon; +} + + + +/** ***************************************************************************/ +void WidgetBoxModel::ResultsList::setDisplayIcons(bool value) { + delegate_->drawIcon = value; + update(); +} + + + +/** ***************************************************************************/ +bool WidgetBoxModel::ResultsList::eventFilter(QObject*, QEvent *event) { + + if (event->type() == QEvent::KeyPress) { + QKeyEvent* keyEvent = static_cast(event); + switch (keyEvent->key()) { + + // Display different subtexts according to the KeyboardModifiers + case Qt::Key_Control: + case Qt::Key_Shift: + case Qt::Key_Alt: + case Qt::Key_Meta: + switch (keyEvent->modifiers()) { + case Qt::MetaModifier: // Default fallback action (Meta) + delegate_->subTextRole = Core::ItemRoles::FallbackRole; + break; + default: // DefaultAction + delegate_->subTextRole = Core::ItemRoles::ToolTipRole; + break; + } + update(); + return false; + + + // Expose the navigation hidden by the lineedit with the control modifier + case Qt::Key_Home: + case Qt::Key_End: + if ( keyEvent->modifiers() == Qt::ControlModifier ) { + keyPressEvent(keyEvent); + return true; + } + return false; + + case Qt::Key_P: + if ( keyEvent->modifiers() == Qt::ControlModifier ){ + setCurrentIndex(model()->index(std::max(currentIndex().row() - 1, 0), 0)); + return true; + } + return false; + case Qt::Key_N: + if ( keyEvent->modifiers() == Qt::ControlModifier ){ + setCurrentIndex(model()->index(std::min(currentIndex().row() + 1, model()->rowCount()-1), 0)); + return true; + } + return false; + + // Navigation + case Qt::Key_Up: + case Qt::Key_Down: + case Qt::Key_PageUp: + case Qt::Key_PageDown: + // Activation + case Qt::Key_Enter: + case Qt::Key_Return: + keyPressEvent(keyEvent); + return true; + } + } + + if (event->type() == QEvent::KeyRelease) { + QKeyEvent* keyEvent = static_cast(event); + switch (keyEvent->key()) { + + // Display different subtexts according to the KeyboardModifiers + case Qt::Key_Control: + case Qt::Key_Shift: + case Qt::Key_Alt: + case Qt::Key_Meta: + switch (keyEvent->modifiers()) { + case Qt::MetaModifier: // Default fallback action (Meta) + delegate_->subTextRole = Core::ItemRoles::FallbackRole; + break; + default: // DefaultAction + delegate_->subTextRole = Core::ItemRoles::ToolTipRole; + break; + } + update(); + return false; + } + } + return false; +} + + + +/** ***************************************************************************/ +void WidgetBoxModel::ResultsList::showEvent(QShowEvent *event) { + QWidget::showEvent(event); + if (qApp->keyboardModifiers() == Qt::MetaModifier) + delegate_->subTextRole = Core::ItemRoles::FallbackRole; + else + delegate_->subTextRole = Core::ItemRoles::ToolTipRole; +} + + + +/** ***************************************************************************/ +void WidgetBoxModel::ResultsList::ItemDelegate::paint(QPainter *painter, const QStyleOptionViewItem &options, const QModelIndex &index) const { + + painter->save(); + + QStyleOptionViewItem option = options; + initStyleOption(&option, index); + + /* + * fm(x) := fontmetrics of x + * DR := DisplayRole + * TR := ToolTipRole + * +---------------------+----------------------------------------+ + * | | | + * | +-------------+ | | + * | | | | | + * | | | |a*fm(DR)/(fm(DR)+fm(TR)) DisplayRole | + * a| | icon | | | + * | | | | | + * | | | +----------------------------------------+ + * | | | | | + * | +-------------+ |a*fm(TR)/(fm(DR)+fm(TR)) ToolTipRole+x | + * | | | + * +---------------------------------------------------------------+ + */ + + + // Avoid ugly dark blue mouseover background + // TODO: QT_MINREL 5.7 setFlag + option.state &= ~QStyle::State_MouseOver; + + // Draw selection + option.widget->style()->drawPrimitive(QStyle::PE_PanelItemViewItem, &option, painter, option.widget); + + // Draw icon + if ( drawIcon ){ + QRect iconRect = QRect( + QPoint((option.rect.height() - option.decorationSize.width())/2 + option.rect.x(), + (option.rect.height() - option.decorationSize.height())/2 + option.rect.y()), + option.decorationSize); + QPixmap pixmap; + QString iconPath = index.data(Core::ItemRoles::DecorationRole).value(); + QString cacheKey = QString("%1%2%3").arg(option.decorationSize.width(), option.decorationSize.height()).arg(iconPath); + if ( !QPixmapCache::find(cacheKey, &pixmap) ) { +#if QT_VERSION >= 0x050600 // TODO: Remove when 18.04 is released + pixmap = QPixmap(iconPath).scaled(option.decorationSize * option.widget->devicePixelRatioF(), Qt::KeepAspectRatio, Qt::SmoothTransformation); +#else + pixmap = QPixmap(iconPath).scaled(option.decorationSize, Qt::KeepAspectRatio, Qt::SmoothTransformation); +#endif + QPixmapCache::insert(cacheKey, pixmap); + } + painter->drawPixmap(iconRect, pixmap); + } + + // Calculate text rects + QFont font1 = option.font; + QFont font2 = option.font; + font2.setPixelSize(12); + QFontMetrics fontMetrics1 = QFontMetrics(font1); + QFontMetrics fontMetrics2 = QFontMetrics(font2); + QRect contentRect = option.rect; + contentRect.setLeft(drawIcon ? option.rect.height() : 0); + contentRect.setTop(option.rect.y()+option.rect.height()/2-(fontMetrics1.height()+fontMetrics2.height())/2); + contentRect.setBottom(option.rect.y()+option.rect.height()/2+(fontMetrics1.height()+fontMetrics2.height())/2); + QRect textRect = contentRect.adjusted(0,-2,0,-fontMetrics2.height()-2); + + + QAbstractTextDocumentLayout::PaintContext ctx; + ctx.palette.setColor(QPalette::Text, option.widget->palette().color((option.state & QStyle::State_Selected) ? QPalette::HighlightedText : QPalette::WindowText)); + + QTextDocument doc; + doc.setDefaultFont(font1); + painter->translate(textRect.left(), textRect.top()); + doc.setHtml(index.data(Core::ItemRoles::TextRole).toString()); + doc.documentLayout()->draw(painter, ctx); + + doc.setDefaultFont(font2); + painter->translate(0, textRect.height()-4); + doc.setHtml(index.data(option.state.testFlag(QStyle::State_Selected) + ? subTextRole + : Core::ItemRoles::ToolTipRole).toString()); + doc.documentLayout()->draw(painter, ctx); + + + +// painter->setPen(( option.state & QStyle::State_Selected) ? QPalette::HighlightedText : QPalette::WindowText); +// doc.drawContents(painter); +// doc.drawContents(painter); + + // // Test +// painter->drawRect(option.rect); +// painter->setPen(Qt::red); +// painter->drawRect(contentRect); +// painter->setPen(Qt::blue); +// painter->drawRect(textRect); +// painter->setPen(Qt::green); +// painter->drawRect(subTextRect); +// painter->fillRect(option.rect, Qt::magenta); +// painter->fillRect(contentRect, Qt::red); +// painter->fillRect(textRect, Qt::blue); +// painter->fillRect(subTextRect, Qt::yellow); + + // Draw display role +// QString text = fontMetrics1.elidedText(index.data(Core::ItemRoles::TextRole).toString(), +// option.textElideMode, +// textRect.width()); +// painter->setFont(font1); +// option.widget->style()->drawItemText(painter, +// textRect, +// option.displayAlignment, +// option.palette, +// option.state & QStyle::State_Enabled, +// text, +// (option.state & QStyle::State_Selected) ? QPalette::HighlightedText : QPalette::WindowText); + + // Draw tooltip role +// text = fontMetrics2.elidedText(index.data(option.state.testFlag(QStyle::State_Selected) +// ? subTextRole +// : Core::ItemRoles::ToolTipRole).toString(), +// option.textElideMode, +// subTextRect.width()); +// painter->setFont(font2); +// option.widget->style()->drawItemText(painter, +// subTextRect, +// Qt::AlignBottom|Qt::AlignLeft, +// option.palette, +// option.state & QStyle::State_Enabled, +// text, +// (option.state & QStyle::State_Selected) ? QPalette::HighlightedText : QPalette::WindowText); + + + painter->restore(); +} diff --git a/plugins/widgetboxmodel/src/resultslist.h b/plugins/widgetboxmodel/src/resultslist.h new file mode 100644 index 0000000..1de0f6c --- /dev/null +++ b/plugins/widgetboxmodel/src/resultslist.h @@ -0,0 +1,29 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include "resizinglist.h" +#include + +namespace WidgetBoxModel { + +class ResultsList final : public ResizingList +{ + Q_OBJECT + class ItemDelegate; + +public: + + ResultsList(QWidget *parent = 0); + + bool displayIcons() const; + void setDisplayIcons(bool value); + +private: + + bool eventFilter(QObject*, QEvent *event) override; + void showEvent(QShowEvent *event) override; + + ItemDelegate *delegate_; +}; +} diff --git a/plugins/widgetboxmodel/src/settingsbutton.cpp b/plugins/widgetboxmodel/src/settingsbutton.cpp new file mode 100644 index 0000000..bec770b --- /dev/null +++ b/plugins/widgetboxmodel/src/settingsbutton.cpp @@ -0,0 +1,84 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "settingsbutton.h" +#include +#include +#include +#include +#include +#include +#include + +/** ***************************************************************************/ +WidgetBoxModel::SettingsButton::SettingsButton(QWidget *parent) : QPushButton(parent) { + animation_ = new QPropertyAnimation(this, "angle"); + animation_->setDuration(10000); + animation_->setStartValue(0); + animation_->setEndValue(360); + animation_->setLoopCount(-1); + animation_->start(); + connect(animation_, &QPropertyAnimation::valueChanged, this, static_cast(&QWidget::update)); + + svgRenderer_ = new QSvgRenderer(QString(":gear")); + + setCursor(Qt::PointingHandCursor); +} + + + +/** ***************************************************************************/ +WidgetBoxModel::SettingsButton::~SettingsButton() { + delete animation_; + delete svgRenderer_; +} + + + +/** ***************************************************************************/ +void WidgetBoxModel::SettingsButton::hideEvent(QHideEvent *event) { + animation_->stop(); + QPushButton::hideEvent(event); +} + + + +/** ***************************************************************************/ +void WidgetBoxModel::SettingsButton::showEvent(QShowEvent *event) { + animation_->start(); + QPushButton::showEvent(event); +} + + + +/** ***************************************************************************/ +void WidgetBoxModel::SettingsButton::paintEvent(QPaintEvent *event) { + QPushButton::paintEvent(event); + + QStyleOptionButton option; + option.initFrom(this); + QRect contentRect = style()->subElementRect(QStyle::SE_PushButtonContents, &option, this); + + // Prepare image in pixmap using mask +#if QT_VERSION >= 0x050600 // TODO: Remove when 18.04 is released + QPixmap gearPixmap(contentRect.size() * devicePixelRatioF()); +#else + QPixmap gearPixmap(contentRect.size()); +#endif + gearPixmap.fill(Qt::transparent); + + QPointF rotationOrigin = QRectF(QPoint(), gearPixmap.size()).center(); + + QPainter pixmapPainter(&gearPixmap); + pixmapPainter.translate(rotationOrigin); + pixmapPainter.rotate(angle_); + pixmapPainter.translate(-rotationOrigin); + svgRenderer_->render(&pixmapPainter); + pixmapPainter.resetTransform(); + pixmapPainter.setCompositionMode(QPainter::CompositionMode_SourceIn); + pixmapPainter.fillRect(gearPixmap.rect(), option.palette.windowText().color()); + + // Draw pixmap on button + QPainter painter(this); + painter.drawPixmap(contentRect, gearPixmap); + +} diff --git a/plugins/widgetboxmodel/src/settingsbutton.h b/plugins/widgetboxmodel/src/settingsbutton.h new file mode 100644 index 0000000..26415a7 --- /dev/null +++ b/plugins/widgetboxmodel/src/settingsbutton.h @@ -0,0 +1,34 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +class QPropertyAnimation; +class QSvgRenderer; + +namespace WidgetBoxModel { + +class SettingsButton final : public QPushButton +{ + Q_OBJECT + Q_PROPERTY(int angle MEMBER angle_) + +public: + + SettingsButton(QWidget *parent = 0); + ~SettingsButton(); + +protected: + + void hideEvent(QHideEvent * event) override; + void showEvent(QShowEvent * event) override; + +private: + + void paintEvent(QPaintEvent *event) override; + + int angle_; + QPropertyAnimation *animation_; + QSvgRenderer *svgRenderer_; + +}; +} diff --git a/resources.qrc b/resources.qrc new file mode 100644 index 0000000..474ae4a --- /dev/null +++ b/resources.qrc @@ -0,0 +1,10 @@ + + + resources/icons/plugin_error.png + resources/icons/plugin_notloaded.png + resources/icons/plugin_ok.png + resources/icons/albert.svg + resources/icons/gear.svg + resources/icons/unknown.svg + + diff --git a/resources/albert.desktop b/resources/albert.desktop new file mode 100755 index 0000000..70e9cfb --- /dev/null +++ b/resources/albert.desktop @@ -0,0 +1,13 @@ +#!/usr/bin/env xdg-open +[Desktop Entry] +Categories=Utility; +Comment=A desktop agnostic launcher +Comment[ko]=빠른 프로그램 실행도구 +Exec=albert +GenericName=Launcher +Icon=albert +Name=Albert +Name[ko]=런처 +StartupNotify=false +Type=Application +Version=1.0 diff --git a/resources/icons/albert.svg b/resources/icons/albert.svg new file mode 100644 index 0000000..63b6fe1 --- /dev/null +++ b/resources/icons/albert.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/resources/icons/gear.svg b/resources/icons/gear.svg new file mode 100644 index 0000000..5ce78c0 --- /dev/null +++ b/resources/icons/gear.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/resources/icons/plugin_error.png b/resources/icons/plugin_error.png new file mode 100644 index 0000000..0070d0b Binary files /dev/null and b/resources/icons/plugin_error.png differ diff --git a/resources/icons/plugin_notloaded.png b/resources/icons/plugin_notloaded.png new file mode 100644 index 0000000..a43b8ea Binary files /dev/null and b/resources/icons/plugin_notloaded.png differ diff --git a/resources/icons/plugin_ok.png b/resources/icons/plugin_ok.png new file mode 100644 index 0000000..8cd5b6e Binary files /dev/null and b/resources/icons/plugin_ok.png differ diff --git a/resources/icons/unknown.svg b/resources/icons/unknown.svg new file mode 100644 index 0000000..146de17 --- /dev/null +++ b/resources/icons/unknown.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/src/app/extension.cpp b/src/app/extension.cpp new file mode 100644 index 0000000..1fa0a2d --- /dev/null +++ b/src/app/extension.cpp @@ -0,0 +1,56 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include "albert/extension.h" +#include "extensionmanager.h" +using namespace std; + + +Core::ExtensionManager *Core::Extension::extensionManager = nullptr; + +struct Core::Private { + set registeredQueryHandlers; + set registeredFallbackProviders; +}; + + +/**************************************************************************************************/ +Core::Extension::Extension(const QString &id) : Plugin(id), d(new Private) { + +} + + +/**************************************************************************************************/ +Core::Extension::~Extension() { + // If the extensin did it not by itself unregister all the remaining handlers + for (auto ptr : d->registeredQueryHandlers) + unregisterQueryHandler(ptr); + for (auto ptr : d->registeredFallbackProviders) + unregisterFallbackProvider(ptr); +} + + +/**************************************************************************************************/ +void Core::Extension::registerQueryHandler(Core::QueryHandler *object) { + d->registeredQueryHandlers.insert(object); + extensionManager->registerQueryHandler(object); +} + + +/**************************************************************************************************/ +void Core::Extension::unregisterQueryHandler(Core::QueryHandler *object) { + extensionManager->unregisterQueryHandler(object); +} + + +/**************************************************************************************************/ +void Core::Extension::registerFallbackProvider(Core::FallbackProvider *object) { + d->registeredFallbackProviders.insert(object); + extensionManager->registerFallbackProvider(object); +} + + +/**************************************************************************************************/ +void Core::Extension::unregisterFallbackProvider(Core::FallbackProvider *object) { + extensionManager->unregisterFallbackProvider(object); +} diff --git a/src/app/extensionmanager.cpp b/src/app/extensionmanager.cpp new file mode 100644 index 0000000..75c78ec --- /dev/null +++ b/src/app/extensionmanager.cpp @@ -0,0 +1,191 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "extensionmanager.h" +#include "albert/queryhandler.h" +#include "albert/fallbackprovider.h" +#include "pluginspec.h" +using namespace std; +using namespace chrono; + + +/** ***************************************************************************/ +class Core::ExtensionManagerPrivate { +public: + vector> extensionSpecs_; + set loadedExtensions_; + set queryHandlers_; + set fallbackProviders_; +}; + + +/** ***************************************************************************/ +Core::ExtensionManager::ExtensionManager(QStringList pluginDirs) + : d(new ExtensionManagerPrivate) { + + Q_ASSERT( Extension::extensionManager == nullptr); + Extension::extensionManager = this; + + // Find plugins + for ( const QString &pluginDir : pluginDirs ) { + QDirIterator dirIterator(pluginDir, QDir::Files); + while (dirIterator.hasNext()) { + std::unique_ptr plugin(new PluginSpec(dirIterator.next())); + + if ( plugin->iid() != ALBERT_EXTENSION_IID ) + continue; + + if (std::any_of(d->extensionSpecs_.begin(), d->extensionSpecs_.end(), + [&](const unique_ptr &spec){ return plugin->id() == spec->id(); })) { + qWarning() << qPrintable(QString("Extension IDs already exists. Skipping. (%1)").arg(plugin->path())); + continue; + } + + d->extensionSpecs_.push_back(std::move(plugin)); + } + } + + // Sort alphabetically + std::sort(d->extensionSpecs_.begin(), + d->extensionSpecs_.end(), + [](const unique_ptr& lhs, const unique_ptr& rhs){ + return lhs->name() < rhs->name(); + }); +} + + +/** ***************************************************************************/ +Core::ExtensionManager::~ExtensionManager() { + for (unique_ptr & pluginSpec : d->extensionSpecs_) + unloadExtension(pluginSpec); +} + + +/** ***************************************************************************/ +const vector>& Core::ExtensionManager::extensionSpecs() const { + return d->extensionSpecs_; +} + + +/** ***************************************************************************/ +void Core::ExtensionManager::reloadExtensions() { + + // Unload all extensions + for (unique_ptr & pluginSpec : d->extensionSpecs_) + unloadExtension(pluginSpec); + + // Load if enabled + QSettings settings(qApp->applicationName()); + for (unique_ptr & pluginSpec : d->extensionSpecs_) { + if ( settings.value(QString("%1/enabled").arg(pluginSpec->id()), false).toBool() ) + loadExtension(pluginSpec); + } +} + + +/** ***************************************************************************/ +void Core::ExtensionManager::loadExtension(const unique_ptr &spec) { + if ( spec->state() != PluginSpec::State::Loaded ){ + + // Load + qInfo() << "Loading extension" << spec->id(); + std::chrono::system_clock::time_point start = std::chrono::system_clock::now(); + if ( !spec->load() ) { + qInfo() << QString("Loading %1 failed. (%2)").arg(spec->id(), spec->lastError()).toLocal8Bit().data(); + return; + } + qDebug() << qPrintable(QString("%1 loaded in %2 milliseconds").arg(spec->id()) + .arg(duration_cast(system_clock::now()-start).count())); + + Extension *extension = dynamic_cast(spec->instance()); + if (!extension) { + qInfo() << QString("Instance is not of tyoe Extension. (%2)").arg(spec->id()).toLocal8Bit().data(); + return; + } + + d->loadedExtensions_.insert(extension); + } +} + + +/** ***************************************************************************/ +void Core::ExtensionManager::unloadExtension(const unique_ptr &spec) { + if (spec->state() == PluginSpec::State::NotLoaded) + return; + + if (spec->state() == PluginSpec::State::Loaded) + d->loadedExtensions_.erase(dynamic_cast(spec->instance())); + + spec->unload(); +} + + +/** ***************************************************************************/ +void Core::ExtensionManager::enableExtension(const unique_ptr &pluginSpec) { + QSettings(qApp->applicationName()).setValue(QString("%1/enabled").arg(pluginSpec->id()), true); + loadExtension(pluginSpec); +} + + +/** ***************************************************************************/ +void Core::ExtensionManager::disableExtension(const unique_ptr &pluginSpec) { + QSettings(qApp->applicationName()).setValue(QString("%1/enabled").arg(pluginSpec->id()), false); + unloadExtension(pluginSpec); +} + + +/** ***************************************************************************/ +bool Core::ExtensionManager::extensionIsEnabled(const unique_ptr &pluginSpec) { + QSettings settings(qApp->applicationName()); + return settings.value(QString("%1/enabled").arg(pluginSpec->id())).toBool(); +} + + +/** ***************************************************************************/ +void Core::ExtensionManager::registerQueryHandler(Core::QueryHandler *queryHandler) { + d->queryHandlers_.insert(queryHandler); + emit queryHandlerRegistered(queryHandler); +} + + +/** ***************************************************************************/ +void Core::ExtensionManager::unregisterQueryHandler(Core::QueryHandler *queryHandler) { + d->queryHandlers_.erase(queryHandler); + emit queryHandlerUnregistered(queryHandler); +} + + +/** ***************************************************************************/ +const std::set &Core::ExtensionManager::queryHandlers() { + return d->queryHandlers_; +} + + +/** ***************************************************************************/ +void Core::ExtensionManager::registerFallbackProvider(Core::FallbackProvider *fallbackProvider) { + d->fallbackProviders_.insert(fallbackProvider); + emit fallbackProviderRegistered(fallbackProvider); + +} + + +/** ***************************************************************************/ +void Core::ExtensionManager::unregisterFallbackProvider(Core::FallbackProvider *fallbackProvider) { + d->fallbackProviders_.erase(fallbackProvider); + emit fallbackProviderUnregistered(fallbackProvider); +} + + +/** ***************************************************************************/ +const std::set &Core::ExtensionManager::fallbackProviders() { + return d->fallbackProviders_; +} diff --git a/src/app/extensionmanager.h b/src/app/extensionmanager.h new file mode 100644 index 0000000..6aa2f80 --- /dev/null +++ b/src/app/extensionmanager.h @@ -0,0 +1,62 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include +#include +#include "albert/extension.h" + +namespace Core { + +class Extension; +class QueryHandler; +class FallbackProvider; +class PluginSpec; +class ExtensionManagerPrivate; + +class ExtensionManager final : public QObject +{ + Q_OBJECT + +public: + + ExtensionManager(QStringList pluginroots); + ~ExtensionManager(); + + const std::vector> & extensionSpecs() const; + + void reloadExtensions(); + + void enableExtension(const std::unique_ptr &); + void disableExtension(const std::unique_ptr &); + bool extensionIsEnabled(const std::unique_ptr &); + + void registerQueryHandler(QueryHandler*); + void unregisterQueryHandler(QueryHandler*); + const std::set &queryHandlers(); + + void registerFallbackProvider(FallbackProvider*); + void unregisterFallbackProvider(FallbackProvider*); + const std::set &fallbackProviders(); + +private: + + void loadExtension(const std::unique_ptr &); + void unloadExtension(const std::unique_ptr &); + + std::unique_ptr d; + +signals: + + void queryHandlerRegistered(QueryHandler*); + void queryHandlerUnregistered(QueryHandler*); + + void fallbackProviderRegistered(FallbackProvider*); + void fallbackProviderUnregistered(FallbackProvider*); + +}; + +} diff --git a/src/app/frontendmanager.cpp b/src/app/frontendmanager.cpp new file mode 100644 index 0000000..0b8b188 --- /dev/null +++ b/src/app/frontendmanager.cpp @@ -0,0 +1,138 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include "frontendmanager.h" +#include "albert/frontend.h" +#include "pluginspec.h" +using std::unique_ptr; +using std::vector; + + +namespace { +const char* CFG_FRONTEND_ID = "frontendId"; +const char* DEF_FRONTEND_ID = "org.albert.frontend.widgetboxmodel"; +} + + +/** ***************************************************************************/ +class Core::FrontendManagerPrivate { +public: + vector> frontendPlugins; + Frontend* currentFrontend; +}; + + +/** ***************************************************************************/ +Core::FrontendManager::FrontendManager(QStringList pluginDirs) + : d(new FrontendManagerPrivate) { + + // Find plugins + for ( const QString &pluginDir : pluginDirs ) { + QDirIterator dirIterator(pluginDir, QDir::Files); + while (dirIterator.hasNext()) { + std::unique_ptr plugin(new PluginSpec(dirIterator.next())); + + if ( plugin->iid() != ALBERT_FRONTEND_IID ) + continue; + + if (std::any_of(d->frontendPlugins.begin(), d->frontendPlugins.end(), + [&](const unique_ptr &spec){ return plugin->id() == spec->id(); })) { + qWarning() << qPrintable(QString("Frontend IDs already exists. Skipping. (%1)").arg(plugin->path())); + continue; + } + + d->frontendPlugins.push_back(std::move(plugin)); + } + } + + if ( d->frontendPlugins.empty() ) + qFatal("No frontends available"); + + // Find the configured frontend, fallback to default if not configured + QSettings s(qApp->applicationName()); + QString id = s.value(CFG_FRONTEND_ID, DEF_FRONTEND_ID).toString(); + vector>::iterator it = + std::find_if(d->frontendPlugins.begin(), d->frontendPlugins.end(), + [&](std::unique_ptr &plugin){ + return plugin->id() == id; + }); + + if ( it == d->frontendPlugins.end() ) { + it = d->frontendPlugins.begin(); + qWarning("Frontend '%s' could not be found. Using %s instead.", + qPrintable(id), qPrintable((*it)->id())); + s.setValue(CFG_FRONTEND_ID, (*it)->id()); + } + + if ( !(*it)->load() ) + qFatal("Failed loading frontend"); + + d->currentFrontend = dynamic_cast((*it)->instance()); + if (!d->currentFrontend) + qFatal("Could not cast plugin instance to frontend"); +} + + +/** ***************************************************************************/ +Core::FrontendManager::~FrontendManager() { + +} + + + +/** ***************************************************************************/ +const std::vector > &Core::FrontendManager::frontendSpecs() const { + return d->frontendPlugins; +} + + + +/** ***************************************************************************/ +Core::Frontend *Core::FrontendManager::currentFrontend() { + return d->currentFrontend; +} + + + +/** ***************************************************************************/ +bool Core::FrontendManager::setCurrentFrontend(QString id) { + + QSettings s(qApp->applicationName()); + s.setValue(CFG_FRONTEND_ID, id); + + // Find plugin + vector>::iterator it = + std::find_if(d->frontendPlugins.begin(), d->frontendPlugins.end(), + [&](std::unique_ptr &spec){ + return spec->id() == id; + }); + if ( it == d->frontendPlugins.end() ) { + qWarning("Frontend '%s' could not be found.", qPrintable(id)); + return false; + } + std::unique_ptr &newFrontendSpec = *it; + + it = std::find_if(d->frontendPlugins.begin(), d->frontendPlugins.end(), + [&](std::unique_ptr &spec){ + return spec->id() == d->currentFrontend->id(); + }); + std::unique_ptr &oldFrontendSpec = *it; + + newFrontendSpec->load(); + + Frontend *newFrontend = dynamic_cast(newFrontendSpec->instance()); + if (!newFrontend) + qFatal("Could not cast plugin instance to frontend"); + + d->currentFrontend->disconnect(); + d->currentFrontend = newFrontend; + emit frontendChanged(d->currentFrontend); + oldFrontendSpec->unload(); + + return true; +} diff --git a/src/app/frontendmanager.h b/src/app/frontendmanager.h new file mode 100644 index 0000000..27efc4c --- /dev/null +++ b/src/app/frontendmanager.h @@ -0,0 +1,38 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include + +namespace Core { + +class Frontend; +class PluginSpec; +class FrontendManagerPrivate; + +class FrontendManager : public QObject +{ + Q_OBJECT + +public: + + FrontendManager(QStringList pluginroots); + ~FrontendManager(); + + const std::vector > &frontendSpecs() const; + + Frontend *currentFrontend(); + bool setCurrentFrontend(QString id); + +private: + + std::unique_ptr d; + +signals: + + void frontendChanged(Frontend*); + +}; + +} + diff --git a/src/app/main.cpp b/src/app/main.cpp new file mode 100644 index 0000000..cae4cda --- /dev/null +++ b/src/app/main.cpp @@ -0,0 +1,602 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "globalshortcut/hotkeymanager.h" +#include "xdg/iconlookup.h" +#include "extensionmanager.h" +#include "albert/frontend.h" +#include "frontendmanager.h" +#include "pluginspec.h" +#include "querymanager.h" +#include "settingswidget/settingswidget.h" +#include "telemetry.h" +#include "trayicon.h" +using namespace Core; +using namespace GlobalShortcut; + +static void myMessageOutput(QtMsgType type, const QMessageLogContext &context, const QString &message); +static void dispatchMessage(); +static void printReport(); + +// Core components +static QApplication *app; +static ExtensionManager *extensionManager; +static FrontendManager *frontendManager; +static QueryManager *queryManager; +static HotkeyManager *hotkeyManager; +static SettingsWidget *settingsWidget; +static TrayIcon *trayIcon; +static Telemetry *telemetry; +static QMenu *trayIconMenu; +static QLocalServer *localServer; + + +int main(int argc, char **argv) { + + // Parse commandline + QCommandLineParser parser; + parser.setApplicationDescription("Albert is still in alpha. These options may change in future versions."); + parser.addHelpOption(); + parser.addVersionOption(); + parser.addOption(QCommandLineOption({"k", "hotkey"}, "Overwrite the hotkey to use.", "hotkey")); + parser.addOption(QCommandLineOption({"p", "plugin-dirs"}, "Set the plugin dirs to use. Comma separated.", "directory")); + parser.addOption(QCommandLineOption({"r", "report"}, "Print issue report.")); + parser.addPositionalArgument("command", "Command to send to a running instance, if any. (show, hide, toggle)", "[command]"); + + /* + * IPC/SINGLETON MECHANISM (Client) + * For performance purposes this has been optimized by using a QCoreApp + */ + QString socketPath = QStandardPaths::writableLocation(QStandardPaths::CacheLocation)+"/socket"; + { + QCoreApplication *capp = new QCoreApplication(argc, argv); + capp->setApplicationName("albert"); + capp->setApplicationVersion(ALBERT_VERSION); + parser.process(*capp); + + if (parser.isSet("report")){ + printReport(); + return EXIT_SUCCESS; + } + + const QStringList args = parser.positionalArguments(); + QLocalSocket socket; + socket.connectToServer(socketPath); + if ( socket.waitForConnected(500) ) { // Should connect instantly + // If there is a command send it + if ( args.count() != 0 ){ + socket.write(args.join(' ').toUtf8()); + socket.flush(); + socket.waitForReadyRead(500); + if (socket.bytesAvailable()) + qInfo().noquote() << socket.readAll(); + } + else + qInfo("There is another instance of albert running."); + socket.close(); + ::exit(EXIT_SUCCESS); + } else if ( args.count() == 1 ) { + qInfo("There is no other instance of albert running."); + ::exit(EXIT_FAILURE); + } + + delete capp; + } + + + /* + * INITIALIZE APPLICATION + */ + { + QSettings::setPath(QSettings::defaultFormat(), QSettings::UserScope, + QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation)); + QSettings settings(qApp->applicationName()); + + qInstallMessageHandler(myMessageOutput); + + qDebug() << "Initializing application"; +#if QT_VERSION >= 0x050600 // TODO: Remove when 18.04 is released + if (!qEnvironmentVariableIsSet("QT_DEVICE_PIXEL_RATIO") + && !qEnvironmentVariableIsSet("QT_AUTO_SCREEN_SCALE_FACTOR") + && !qEnvironmentVariableIsSet("QT_SCALE_FACTOR") + && !qEnvironmentVariableIsSet("QT_SCREEN_SCALE_FACTORS")) + QApplication::setAttribute(Qt::AA_EnableHighDpiScaling); + QApplication::setAttribute(Qt::AA_UseHighDpiPixmaps); +#endif + app = new QApplication(argc, argv); + app->setApplicationName("albert"); + app->setApplicationDisplayName("Albert"); + app->setApplicationVersion(ALBERT_VERSION); + app->setQuitOnLastWindowClosed(false); + QString icon = XDG::IconLookup::iconPath("albert"); + if ( icon.isEmpty() ) icon = ":app_icon"; + app->setWindowIcon(QIcon(icon)); + + + + /* + * IPC/SINGLETON MECHANISM (Server) + */ + + // Remove pipes potentially leftover after crash + QLocalServer::removeServer(socketPath); + + // Create server and handle messages + qDebug() << "Creating IPC server"; + localServer = new QLocalServer; + if ( !localServer->listen(socketPath) ) + qWarning() << "Local server could not be created. IPC will not work! Reason:" + << localServer->errorString(); + + // Handle incoming messages + QObject::connect(localServer, &QLocalServer::newConnection, dispatchMessage); + + + + /* + * INITIALIZE PATHS + */ + + // Make sure data, cache and config dir exists + qDebug() << "Initializing mandatory paths"; + QString dataLocation = QStandardPaths::writableLocation(QStandardPaths::DataLocation); + QString cacheLocation = QStandardPaths::writableLocation(QStandardPaths::CacheLocation); + QString configLocation = QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation); + for ( const QString &location : {dataLocation, cacheLocation, configLocation} ) + if (!QDir(location).mkpath(".")) + qFatal("Could not create dir: %s", qPrintable(location)); + + + + /* + * ADJUST PATHS OF FILES OF OLDER VERSIONS + */ + + // If there is a firstRun file, rename it to lastVersion (since v0.11) + if ( QFile::exists(QString("%1/firstrun").arg(dataLocation)) ) { + qDebug() << "Renaming 'firstrun' to 'last_used_version'"; + QFile::rename(QString("%1/firstrun").arg(dataLocation), + QString("%1/last_used_version").arg(dataLocation)); + } + + // Move old config for user convenience (since v0.13) + QFileInfo oldcfg(QStandardPaths::writableLocation(QStandardPaths::ConfigLocation) + "/albert.conf"); + QFileInfo newcfg(QStandardPaths::writableLocation(QStandardPaths::ConfigLocation) + "/albert/albert.conf"); + if (oldcfg.exists()){ + if (newcfg.exists()) + QFile::remove(newcfg.filePath()); + QFile::rename(oldcfg.filePath(), newcfg.filePath()); + } + + // If there is a lastVersion file move it to config (since v0.13) + if ( QFile::exists(QString("%1/last_used_version").arg(dataLocation)) ) { + qDebug() << "Moving 'last_used_version' to config path"; + QFile::rename(QString("%1/last_used_version").arg(dataLocation), + QString("%1/last_used_version").arg(configLocation)); + } + + // If move database from old location in cache to config (since v0.14.7) + if ( QFile::exists(QString("%1/core.db").arg(cacheLocation)) ){ + qInfo() << "Moving 'core.db' to config path"; + QFile::rename(QString("%1/core.db").arg(cacheLocation), + QString("%1/core.db").arg(configLocation)); + } + + + /* + * MISC + */ + + // Quit gracefully on unix signals + qDebug() << "Setup signal handlers"; + for ( int sig : { SIGINT, SIGTERM, SIGHUP, SIGPIPE } ) { + signal(sig, [](int){ + QMetaObject::invokeMethod(qApp, "quit", Qt::QueuedConnection); + }); + } + + // Print a message if the app was not terminated graciously + qDebug() << "Creating running indicator file"; + QString filePath = QStandardPaths::writableLocation(QStandardPaths::CacheLocation)+"/running"; + if (QFile::exists(filePath)){ + qWarning() << "Application has not been terminated graciously."; + } else { + // Create the running indicator file + QFile file(filePath); + if (!file.open(QIODevice::WriteOnly)) + qWarning() << "Could not create file:" << filePath; + file.close(); + } + + + + /* + * INITIALIZE CORE DATABASE + */ + + + QSqlDatabase db = QSqlDatabase::addDatabase("QSQLITE"); + if ( !db.isValid() ) + qFatal("No sqlite available"); + if (!db.driver()->hasFeature(QSqlDriver::Transactions)) + qFatal("QSqlDriver::Transactions not available."); + db.setDatabaseName(QDir(QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation)).filePath("core.db")); + if (!db.open()) + qFatal("Unable to establish a database connection."); + + db.transaction(); + + QSqlQuery q(db); + if (!q.exec("CREATE TABLE IF NOT EXISTS query_handler ( " + " id INTEGER PRIMARY KEY NOT NULL, " + " string_id TEXT UNIQUE NOT NULL " + "); ")) + qFatal("Unable to create table 'query_handler': %s", q.lastError().text().toUtf8().constData()); + + if (!q.exec("CREATE TABLE IF NOT EXISTS query ( " + " id INTEGER PRIMARY KEY, " + " input TEXT NOT NULL, " + " cancelled INTEGER NOT NULL, " + " runtime INTEGER NOT NULL, " + " timestamp INTEGER DEFAULT CURRENT_TIMESTAMP " + "); ")) + qFatal("Unable to create table 'query': %s", q.lastError().text().toUtf8().constData()); + + if (!q.exec("CREATE TABLE IF NOT EXISTS execution ( " + " query_id INTEGER NOT NULL REFERENCES query(id) ON UPDATE CASCADE, " + " handler_id INTEGER NOT NULL REFERENCES query_handler(id) ON UPDATE CASCADE, " + " runtime INTEGER NOT NULL, " + " PRIMARY KEY (query_id, handler_id) " + ") WITHOUT ROWID; ")) + qFatal("Unable to create table 'execution': %s", q.lastError().text().toUtf8().constData()); + + if (!q.exec("CREATE TABLE IF NOT EXISTS activation ( " + " query_id INTEGER PRIMARY KEY NOT NULL REFERENCES query(id) ON UPDATE CASCADE, " + " item_id TEXT NOT NULL " + "); ")) + qFatal("Unable to create table 'activation': %s", q.lastError().text().toUtf8().constData()); + + if (!q.exec("DELETE FROM query WHERE julianday('now')-julianday(timestamp)>30; ")) + qWarning("Unable to cleanup 'query' table."); + + if (!q.exec("CREATE TABLE IF NOT EXISTS conf(key TEXT UNIQUE, value TEXT); ")) + qFatal("Unable to create table 'conf': %s", q.lastError().text().toUtf8().constData()); + + db.commit(); + + + /* + * INITIALIZE APPLICATION COMPONENTS + */ + + qDebug() << "Initializing core components"; + + // Define plugindirs + QStringList pluginDirs; + if ( parser.isSet("plugin-dirs") ) + pluginDirs = parser.value("plugin-dirs").split(','); + else { +#if defined __linux__ + QStringList dirs = { +#if defined MULTIARCH_TUPLE + QFileInfo("/usr/lib/" MULTIARCH_TUPLE).canonicalFilePath(), +#endif + QFileInfo("/usr/lib/").canonicalFilePath(), + QFileInfo("/usr/lib64/").canonicalFilePath(), + QFileInfo("/usr/local/lib/").canonicalFilePath(), + QFileInfo("/usr/local/lib64/").canonicalFilePath(), + QDir::home().filePath(".local/lib/"), + QDir::home().filePath(".local/lib64/") + }; + + dirs.removeDuplicates(); + + for ( const QString& dir : dirs ) { + QFileInfo fileInfo = QFileInfo(QDir(dir).filePath("albert/plugins")); + if ( fileInfo.isDir() ) + pluginDirs.push_back(fileInfo.canonicalFilePath()); + } +#elif defined __APPLE__ + throw "Not implemented"; +#elif defined _WIN32 + throw "Not implemented"; +#endif + } + + frontendManager = new FrontendManager(pluginDirs); + extensionManager = new ExtensionManager(pluginDirs); + extensionManager->reloadExtensions(); + hotkeyManager = new HotkeyManager; + if ( parser.isSet("hotkey") ) { + QString hotkey = parser.value("hotkey"); + if ( !hotkeyManager->registerHotkey(hotkey) ) + qFatal("Failed to set hotkey to %s.", hotkey.toLocal8Bit().constData()); + } else if ( settings.contains("hotkey") ) { + QString hotkey = settings.value("hotkey").toString(); + if ( !hotkeyManager->registerHotkey(hotkey) ) + qFatal("Failed to set hotkey to %s.", hotkey.toLocal8Bit().constData()); + } + queryManager = new QueryManager(extensionManager); + telemetry = new Telemetry; + trayIcon = new TrayIcon; + trayIconMenu = new QMenu; + settingsWidget = new SettingsWidget(extensionManager, + frontendManager, + queryManager, + hotkeyManager, + trayIcon, + telemetry); + + QAction* showAction = new QAction("Show", trayIconMenu); + showAction->setIcon(app->style()->standardIcon(QStyle::SP_TitleBarMaxButton)); + trayIconMenu->addAction(showAction); + + QAction* settingsAction = new QAction("Settings", trayIconMenu); + settingsAction->setIcon(app->style()->standardIcon(QStyle::SP_FileDialogDetailedView)); + trayIconMenu->addAction(settingsAction); + QObject::connect(settingsAction, &QAction::triggered, [](){ + settingsWidget->show(); + settingsWidget->raise(); + }); + + QAction* docsAction = new QAction("Open docs", trayIconMenu); + docsAction->setIcon(app->style()->standardIcon(QStyle::SP_DialogHelpButton)); + trayIconMenu->addAction(docsAction); + QObject::connect(docsAction, &QAction::triggered, [](){ + QDesktopServices::openUrl(QUrl("https://albertlauncher.github.io/docs/")); + }); + + trayIconMenu->addSeparator(); + QAction* quitAction = new QAction("Quit", trayIconMenu); + quitAction->setIcon(app->style()->standardIcon(QStyle::SP_TitleBarCloseButton)); + trayIconMenu->addAction(quitAction); + QObject::connect(quitAction, &QAction::triggered, app, &QApplication::quit); + + trayIcon->setContextMenu(trayIconMenu); + + + + /* + * DETECT FIRST RUN AND VERSION CHANGE + */ + + qDebug() << "Checking last used version"; + QFile file(QString("%1/last_used_version").arg(configLocation)); + if ( file.exists() ) { + // Read last used version + if ( file.open(QIODevice::ReadOnly|QIODevice::Text) ) { + QString lastUsedVersion; + QTextStream(&file) >> lastUsedVersion; + file.close(); + + // Show newsbox in case of major version change + if ( app->applicationVersion().section('.', 1, 1) != lastUsedVersion.section('.', 1, 1) ){ + // Do whatever is neccessary on first run + QMessageBox(QMessageBox::Information, "Major version changed", + QString("You are now using Albert %1. Albert is still in the alpha " + "stage. This means things may change unexpectedly. Check " + "the " + "news to read about the things that changed.") + .arg(app->applicationVersion())).exec(); + } + } + else + qCritical() << qPrintable(QString("Could not open file %1: %2,. Config migration may fail.") + .arg(file.fileName(), file.errorString())); + } else { + // Do whatever is neccessary on first run + QMessageBox(QMessageBox::Information, "First run", + "Seems like this is the first time you run Albert. Albert is " + "standalone, free and open source software. Note that Albert is not " + "related to or affiliated with any other projects or corporations.\n\n" + "You should set a hotkey and enable some extensions.").exec(); + settingsWidget->show(); + } + + // Write the current version into the file + if ( file.open(QIODevice::WriteOnly|QIODevice::Text) ) { + QTextStream out(&file); + out << app->applicationVersion(); + file.close(); + } else + qCritical() << qPrintable(QString("Could not open file %1: %2").arg(file.fileName(), file.errorString())); + + + + /* + * SIGNALING + */ + + // Define a lambda that connects a new frontend + auto connectFrontend = [&](Frontend *f){ + + QObject::connect(hotkeyManager, &HotkeyManager::hotKeyPressed, + f, &Frontend::toggleVisibility); + + QObject::connect(queryManager, &QueryManager::resultsReady, + f, &Frontend::setModel); + + QObject::connect(showAction, &QAction::triggered, + f, &Frontend::setVisible); + + QObject::connect(trayIcon, &TrayIcon::activated, + f, [=](QSystemTrayIcon::ActivationReason reason){ + if( reason == QSystemTrayIcon::ActivationReason::Trigger) + f->toggleVisibility(); + }); + + QObject::connect(f, &Frontend::settingsWidgetRequested, [](){ + settingsWidget->show(); + settingsWidget->raise(); + settingsWidget->activateWindow(); + }); + + QObject::connect(f, &Frontend::widgetShown, [f](){ + queryManager->setupSession(); + queryManager->startQuery(f->input()); + }); + + QObject::connect(f, &Frontend::widgetHidden, + queryManager, &QueryManager::teardownSession); + + QObject::connect(f, &Frontend::inputChanged, + queryManager, &QueryManager::startQuery); + }; + + // Connect the current frontend + connectFrontend(frontendManager->currentFrontend()); + + // Connect new frontends + QObject::connect(frontendManager, &FrontendManager::frontendChanged, connectFrontend); + } + + + /* + * ENTER EVENTLOOP + */ + + qDebug() << "Entering eventloop"; + int retval = app->exec(); + + + /* + * FINALIZE APPLICATION + */ + + qDebug() << "Cleaning up core components"; + delete settingsWidget; + delete trayIconMenu; + delete trayIcon; + delete queryManager; + delete hotkeyManager; + delete extensionManager; + delete frontendManager; + + qDebug() << "Shutting down IPC server"; + localServer->close(); + + // Delete the running indicator file + qDebug() << "Deleting running indicator file"; + QFile::remove(QStandardPaths::writableLocation(QStandardPaths::CacheLocation)+"/running"); + + qDebug() << "Quit"; + return retval; +} + + +/** ***************************************************************************/ +void myMessageOutput(QtMsgType type, const QMessageLogContext &context, const QString &message) { + switch (type) { + case QtDebugMsg: + fprintf(stdout, "%s \x1b[34;1m[DEBG:%s]\x1b[0m \x1b[3m%s\x1b[0m\n", + QTime::currentTime().toString().toLocal8Bit().constData(), + context.category, + message.toLocal8Bit().constData()); + break; + case QtInfoMsg: + fprintf(stdout, "%s \x1b[32;1m[INFO:%s]\x1b[0m %s\n", + QTime::currentTime().toString().toLocal8Bit().constData(), + context.category, + message.toLocal8Bit().constData()); + break; + case QtWarningMsg: + fprintf(stdout, "%s \x1b[33;1m[WARN:%s]\x1b[0;1m %s\x1b[0m\n", + QTime::currentTime().toString().toLocal8Bit().constData(), + context.category, + message.toLocal8Bit().constData()); + break; + case QtCriticalMsg: + fprintf(stdout, "%s \x1b[31;1m[CRIT:%s]\x1b[0;1m %s\x1b[0m\n", + QTime::currentTime().toString().toLocal8Bit().constData(), + context.category, + message.toLocal8Bit().constData()); + break; + case QtFatalMsg: + fprintf(stderr, "%s \x1b[41;30;4m[FATAL:%s]\x1b[0;1m %s -- [%s]\x1b[0m\n", + QTime::currentTime().toString().toLocal8Bit().constData(), + context.category, + message.toLocal8Bit().constData(), + context.function); + exit(1); + } + fflush(stdout); +} + + +/** ***************************************************************************/ +void dispatchMessage() { + QLocalSocket* socket = localServer->nextPendingConnection(); // Should be safe + socket->waitForReadyRead(500); + if (socket->bytesAvailable()) { + QString msg = QString::fromLocal8Bit(socket->readAll()); + if ( msg.startsWith("show")) { + if (msg.size() > 5) { + QString input = msg.mid(5); + frontendManager->currentFrontend()->setInput(input); + } + frontendManager->currentFrontend()->setVisible(true); + socket->write("Application set visible."); + } else if ( msg == "hide") { + frontendManager->currentFrontend()->setVisible(false); + socket->write("Application set invisible."); + } else if ( msg == "toggle") { + frontendManager->currentFrontend()->toggleVisibility(); + socket->write("Visibility toggled."); + } else + socket->write("Command not supported."); + } + socket->flush(); + socket->close(); + socket->deleteLater(); +} + + +/** ***************************************************************************/ +static void printReport() +{ + const uint8_t w = 22; + qInfo().noquote() << QString("%1: %2").arg("Albert version", w).arg(qApp->applicationVersion()); + qInfo().noquote() << QString("%1: %2").arg("Build date", w).arg(__DATE__ " " __TIME__); + + qInfo().noquote() << QString("%1: %2").arg("Qt version", w).arg(qVersion()); + qInfo().noquote() << QString("%1: %2").arg("QT_QPA_PLATFORMTHEME", w).arg(QString::fromLocal8Bit(qgetenv("QT_QPA_PLATFORMTHEME"))); + + qInfo().noquote() << QString("%1: %2").arg("Binary location", w).arg(qApp->applicationFilePath()); + + qInfo().noquote() << QString("%1: %2").arg("PWD", w).arg(QString::fromLocal8Bit(qgetenv("PWD"))); + qInfo().noquote() << QString("%1: %2").arg("SHELL", w).arg(QString::fromLocal8Bit(qgetenv("SHELL"))); + qInfo().noquote() << QString("%1: %2").arg("LANG", w).arg(QString::fromLocal8Bit(qgetenv("LANG"))); + + qInfo().noquote() << QString("%1: %2").arg("XDG_SESSION_TYPE", w).arg(QString::fromLocal8Bit(qgetenv("XDG_SESSION_TYPE"))); + qInfo().noquote() << QString("%1: %2").arg("XDG_CURRENT_DESKTOP", w).arg(QString::fromLocal8Bit(qgetenv("XDG_CURRENT_DESKTOP"))); + qInfo().noquote() << QString("%1: %2").arg("DESKTOP_SESSION", w).arg(QString::fromLocal8Bit(qgetenv("DESKTOP_SESSION"))); + qInfo().noquote() << QString("%1: %2").arg("XDG_SESSION_DESKTOP", w).arg(QString::fromLocal8Bit(qgetenv("XDG_SESSION_DESKTOP"))); + + qInfo().noquote() << QString("%1: %2").arg("OS", w).arg(QSysInfo::prettyProductName()); + qInfo().noquote() << QString("%1: %2/%3").arg("OS (type/version)", w).arg(QSysInfo::productType(), QSysInfo::productVersion()); + + qInfo().noquote() << QString("%1: %2").arg("Build ABI", w).arg(QSysInfo::buildAbi()); + qInfo().noquote() << QString("%1: %2/%3").arg("Arch (build/current)", w).arg(QSysInfo::buildCpuArchitecture(), QSysInfo::currentCpuArchitecture()); + + qInfo().noquote() << QString("%1: %2/%3").arg("Kernel (type/version)", w).arg(QSysInfo::kernelType(), QSysInfo::kernelVersion()); +} diff --git a/src/app/matchcompare.cpp b/src/app/matchcompare.cpp new file mode 100644 index 0000000..60f3911 --- /dev/null +++ b/src/app/matchcompare.cpp @@ -0,0 +1,17 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "albert/item.h" +#include "matchcompare.h" +using namespace std; + +/** ***************************************************************************/ +bool Core::MatchCompare::operator()(const pair, uint> &lhs, + const pair, uint> &rhs) { + // Compare urgency then score + if (lhs.first->urgency() != rhs.first->urgency()) + return lhs.first->urgency() < rhs.first->urgency(); + else if (lhs.second != rhs.second) + return lhs.second > rhs.second; // Compare match score + else + return lhs.first->text().size() < rhs.first->text().size(); +} diff --git a/src/app/matchcompare.h b/src/app/matchcompare.h new file mode 100644 index 0000000..f56f431 --- /dev/null +++ b/src/app/matchcompare.h @@ -0,0 +1,21 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include + +namespace Core { + +class Item; + +/** + * @brief The MatchOrder class + * The implements the order of the results + */ +class MatchCompare +{ +public: + bool operator()(const std::pair, uint>& lhs, + const std::pair, uint>& rhs); +}; + +} diff --git a/src/app/pluginspec.cpp b/src/app/pluginspec.cpp new file mode 100644 index 0000000..b34323b --- /dev/null +++ b/src/app/pluginspec.cpp @@ -0,0 +1,151 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include "pluginspec.h" +#include "albert/plugin.h" + + +/** ***************************************************************************/ +Core::PluginSpec::PluginSpec(const QString &path) + : loader_(path) { + + // Some python libs do not link against python. Export the python symbols to the main app. + loader_.setLoadHints(QLibrary::ExportExternalSymbolsHint); + + iid_ = loader_.metaData()["IID"].toString(); + id_ = metadata("id").toString(); + name_ = metadata("name").toString("N/A"); + version_ = metadata("version").toString("N/A"); + author_ = metadata("author").toString("N/A"); + dependencies_ = metadata("dependencies").toVariant().toStringList(); + state_ = State::NotLoaded; +} + + +/** ***************************************************************************/ +Core::PluginSpec::~PluginSpec() { + if ( state_ != State::NotLoaded ) + unload(); +} + + +/** ***************************************************************************/ +QString Core::PluginSpec::path() const { + return loader_.fileName(); +} + + +/** ***************************************************************************/ +QString Core::PluginSpec::iid() const { + return iid_; +} + + +/** ***************************************************************************/ +QString Core::PluginSpec::id() const { + return id_; +} + + +/** ***************************************************************************/ +QString Core::PluginSpec::name() const { + return name_; +} + + +/** ***************************************************************************/ +QString Core::PluginSpec::version() const { + return version_; +} + + +/** ***************************************************************************/ +QString Core::PluginSpec::author() const { + return author_; +} + + +/** ***************************************************************************/ +QStringList Core::PluginSpec::dependencies() const { + return dependencies_; +} + + +/** ***************************************************************************/ +QJsonValue Core::PluginSpec::metadata(const QString &key) const { + return loader_.metaData()["MetaData"].toObject()[key]; +} + + +/** ***************************************************************************/ +bool Core::PluginSpec::load() { + + Plugin *plugin = nullptr; + if ( state_ != State::Loaded ) { + try { + if ( !loader_.instance() ) + lastError_ = loader_.errorString(); + else if ( ! (plugin = dynamic_cast(loader_.instance())) ) + lastError_ = "Plugin instance is not of type Plugin"; + else + state_ = State::Loaded; + } catch (const std::exception& ex) { + lastError_ = ex.what(); + } catch (const std::string& s) { + lastError_ = QString::fromStdString(s); + } catch (const QString& s) { + lastError_ = s; + } catch (const char *s) { + lastError_ = s; + } catch (...) { + lastError_ = "Unkown exception in plugin constructor."; + } + + if (!plugin) { + qWarning() << qPrintable(QString("Failed loading plugin: %1 [%2]").arg(path()).arg(lastError_)); + loader_.unload(); + state_ = State::Error; + } + } + + return state_ == State::Loaded; +} + + +/** ***************************************************************************/ +void Core::PluginSpec::unload(){ + + /* + * Never really unload a plugin, since otherwise all objects instanciated by + * this extension (items, widgets, etc) and spread all over the app would + * have to be deleted. This is a lot of work and nobody cares about that + * little amount of extra KBs in RAM until next restart. + */ + + if ( state_ == State::Loaded ) + delete loader_.instance(); + state_ = State::NotLoaded; +} + + +/** ***************************************************************************/ +Core::PluginSpec::State Core::PluginSpec::state() const { + return state_; +} + + +/** ***************************************************************************/ +QString Core::PluginSpec::lastError() const { + return state_ == State::Error ? lastError_ : QString(); +} + + +/** ***************************************************************************/ +QObject *Core::PluginSpec::instance() { + return (state_ == State::Loaded) ? loader_.instance() : nullptr; +} + diff --git a/src/app/pluginspec.h b/src/app/pluginspec.h new file mode 100644 index 0000000..f97c299 --- /dev/null +++ b/src/app/pluginspec.h @@ -0,0 +1,61 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include + +namespace Core { + +class PluginSpec +{ +public: + + enum class State : char { + Loaded, + NotLoaded, + Error + }; + + PluginSpec(const QString &path); + ~PluginSpec(); + PluginSpec(const PluginSpec &other) = delete; + PluginSpec &operator=(const PluginSpec &other) = delete; + + QString path() const; + QString iid() const; + QString id() const; + QString name() const; + QString version() const; + QString author() const; + QStringList dependencies() const; + QJsonValue metadata(const QString & key) const; + + bool load(); + void unload(); + State state() const; + QString lastError() const; + + QObject *instance(); + +private: + + QPluginLoader loader_; + QString iid_; + QString id_; + QString name_; + QString version_; + QString author_; + QStringList dependencies_; + QString lastError_; + State state_; + +}; + +} + + + + diff --git a/src/app/query.cpp b/src/app/query.cpp new file mode 100644 index 0000000..164c1bc --- /dev/null +++ b/src/app/query.cpp @@ -0,0 +1,56 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include "albert/item.h" +#include "albert/query.h" +#include "matchcompare.h" + + +/** ***************************************************************************/ +const QString &Core::Query::string() const { + return string_; +} + + +/** ***************************************************************************/ +const QString &Core::Query::rawString() const { + return rawString_; +} + + +/** ***************************************************************************/ +bool Core::Query::isTriggered() const { + return !trigger_.isNull(); +} + + +/** ***************************************************************************/ +const QString &Core::Query::trigger() const { + return trigger_; +} + + +/** ***************************************************************************/ +bool Core::Query::isValid() const { + return isValid_; +} + + +/** ***************************************************************************/ +void Core::Query::addMatchWithoutLock(const std::shared_ptr &item, uint score) { + auto it = scores_.find(item->id()); + if ( it == scores_.end() ) + results_.emplace_back(item, score/2); + else + results_.emplace_back(item, (static_cast(score)+it->second)/2); +} + + +/** ***************************************************************************/ +void Core::Query::addMatchWithoutLock(std::shared_ptr &&item, uint score) { + auto it = scores_.find(item->id()); + if ( it == scores_.end() ) + results_.emplace_back(std::move(item), score/2); + else + results_.emplace_back(std::move(item), (static_cast(score)+it->second)/2); +} diff --git a/src/app/queryexecution.cpp b/src/app/queryexecution.cpp new file mode 100644 index 0000000..27cdb2c --- /dev/null +++ b/src/app/queryexecution.cpp @@ -0,0 +1,362 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include "albert/action.h" +#include "albert/fallbackprovider.h" +#include "albert/item.h" +#include "albert/queryhandler.h" +#include "albert/util/itemroles.h" +#include "matchcompare.h" +#include "queryexecution.h" +using namespace std; +using namespace chrono; + +namespace { + const int FETCH_SIZE = 20; +} + + +/** ***************************************************************************/ +Core::QueryExecution::QueryExecution(const set & queryHandlers, + const set &fallbackProviders, + const QString &queryString, + std::map scores, + bool fetchIncrementally) { + + fetchIncrementally_ = fetchIncrementally; + query_.rawString_ = queryString; + query_.string_ = queryString; + query_.scores_ = move(scores); + stats.input = queryString; + + // Get fallbacks + if ( !query_.string_.trimmed().isEmpty() ) + for ( FallbackProvider *fallbackProvider : fallbackProviders ) + for ( shared_ptr & item : fallbackProvider->fallbacks(queryString) ) + fallbacks_.emplace_back(move(item), 0); + + // Run with a single handler if the trigger matches + for ( QueryHandler *handler : queryHandlers ) { + for ( const QString& trigger : handler->triggers() ) { + if ( !trigger.isNull() && queryString.startsWith(trigger) ) { + query_.trigger_ = trigger; + query_.string_ = queryString.mid(trigger.size()); + ( handler->executionType()==QueryHandler::ExecutionType::Batch ) + ? batchHandlers_.insert(handler) + : realtimeHandlers_.insert(handler); + return; + } + } + } + + // Else run all batched handlers + for ( QueryHandler *queryHandler : queryHandlers ) + if ( queryHandler->executionType()==QueryHandler::ExecutionType::Batch ) + batchHandlers_.insert(queryHandler); +} + + +/** ***************************************************************************/ +Core::QueryExecution::~QueryExecution() { + +} + + +/** ***************************************************************************/ +const Core::Query *Core::QueryExecution::query() { + return &query_; +} + + +/** ***************************************************************************/ +const Core::QueryExecution::State &Core::QueryExecution::state() const { + return state_; +} + + +/** ***************************************************************************/ +void Core::QueryExecution::setState(State state) { + state_ = state; + if (state_ == State::Finished) + stats.end = system_clock::now(); + emit stateChanged(state_); +} + + +/** ***************************************************************************/ +void Core::QueryExecution::run() { + + setState(State::Running); + + stats.start = system_clock::now(); + + if ( !batchHandlers_.empty() ) + return runBatchHandlers(); + + emit resultsReady(this); + + if ( !realtimeHandlers_.empty() ) + return runRealtimeHandlers(); + + setState(State::Finished); +} + + +/** ***************************************************************************/ +void Core::QueryExecution::cancel() { + futureWatcher_.disconnect(); + future_.cancel(); + query_.isValid_ = false; + stats.cancelled = true; +} + + +/** ***************************************************************************/ +void Core::QueryExecution::runBatchHandlers() { + + // Call onBatchHandlersFinished when all handlers finished + connect(&futureWatcher_, &QFutureWatcher>::finished, + this, &QueryExecution::onBatchHandlersFinished); + + // Run the handlers concurrently and measure the runtimes + function(QueryHandler*)> func = [this](QueryHandler* queryHandler){ + system_clock::time_point start = system_clock::now(); + queryHandler->handleQuery(&query_); + long duration = duration_cast(system_clock::now()-start).count(); + qDebug() << qPrintable(QString("TIME: %1 µs MATCHES [%2]").arg(duration, 6).arg(queryHandler->id)); + return make_pair(queryHandler, static_cast(duration)); + }; + future_ = QtConcurrent::mapped(batchHandlers_.begin(), batchHandlers_.end(), func); + futureWatcher_.setFuture(future_); +} + + +/** ***************************************************************************/ +void Core::QueryExecution::onBatchHandlersFinished() { + + // Save the runtimes of the current future + for ( auto it = future_.begin(); it != future_.end(); ++it ) + stats.runtimes.emplace(it->first->id, it->second); + + // Move the items of the "pending results" into "results" + query_.mutex_.lock(); + swap(query_.results_, results_); + query_.mutex_.unlock(); + + // Sort the results + if (query_.trigger_.isNull()){ + if ( fetchIncrementally_ ) { + int sortUntil = min(sortedItems_ + FETCH_SIZE, static_cast(results_.size())); + partial_sort(results_.begin() + sortedItems_, results_.begin() + sortUntil, + results_.end(), MatchCompare()); + sortedItems_ = sortUntil; + } + else + std::sort(results_.begin(), results_.end(), MatchCompare()); + } + + if ( realtimeHandlers_.empty() ){ + if( results_.empty() && !query_.rawString_.isEmpty() ){ + results_ = fallbacks_; + sortedItems_ = static_cast(fallbacks_.size()); + fetchIncrementally_ = false; + } + setState(State::Finished); + } + else + runRealtimeHandlers(); + + emit resultsReady(this); +} + + +/** ***************************************************************************/ +void Core::QueryExecution::runRealtimeHandlers() { + + // Call onRealtimeHandlersFinsished when all handlers finished + disconnect(&futureWatcher_, &QFutureWatcher>::finished, + this, &QueryExecution::onBatchHandlersFinished); + + connect(&futureWatcher_, &QFutureWatcher>::finished, + this, &QueryExecution::onRealtimeHandlersFinsished); + + // Run the handlers concurrently and measure the runtimes + function(QueryHandler*)> func = [this](QueryHandler* queryHandler){ + system_clock::time_point start = system_clock::now(); + queryHandler->handleQuery(&query_); + long duration = duration_cast(system_clock::now()-start).count(); + qDebug() << qPrintable(QString("TIME: %1 µs MATCHES REALTIME [%2]").arg(duration, 6).arg(queryHandler->id)); + return make_pair(queryHandler, static_cast(duration)); + }; + future_ = QtConcurrent::mapped(realtimeHandlers_.begin(), realtimeHandlers_.end(), func); + futureWatcher_.setFuture(future_); + + // Insert pending results every 50 milliseconds + connect(&fiftyMsTimer_, &QTimer::timeout, this, &QueryExecution::insertPendingResults); + fiftyMsTimer_.start(50); +} + + +/** ***************************************************************************/ +void Core::QueryExecution::onRealtimeHandlersFinsished() { + + // Save the runtimes of the current future + for ( auto it = future_.begin(); it != future_.end(); ++it ) + stats.runtimes.emplace(it->first->id, it->second); + + // Finally done + fiftyMsTimer_.stop(); + fiftyMsTimer_.disconnect(); + insertPendingResults(); + + if( results_.empty() && !query_.rawString_.isEmpty() ){ + beginInsertRows(QModelIndex(), 0, static_cast(fallbacks_.size()-1)); + results_ = fallbacks_; + endInsertRows(); + fetchIncrementally_ = false; + } + setState(State::Finished); +} + + +/** ***************************************************************************/ +void Core::QueryExecution::insertPendingResults() { + + if(query_.results_.size()) { + QMutexLocker lock(&query_.mutex_); + + // When fetching incrementally, only emit if this is in the fetched range + if ( !fetchIncrementally_ || sortedItems_ == static_cast(results_.size()) ){ + beginInsertRows(QModelIndex(), + static_cast(results_.size()), + static_cast(results_.size() + query_.results_.size() - 1)); + results_.reserve(results_.size() + query_.results_.size()); + move(query_.results_.begin(), query_.results_.end(), back_inserter(results_)); + endInsertRows(); + } else { + results_.reserve(results_.size() + query_.results_.size()); + move(query_.results_.begin(), query_.results_.end(), back_inserter(results_)); + } + query_.results_.clear(); + } +} + + +/** ***************************************************************************/ +int Core::QueryExecution::rowCount(const QModelIndex &) const { + return query_.trigger_.isNull() && fetchIncrementally_ ? sortedItems_ : static_cast(results_.size()); +} + + +/** ***************************************************************************/ +QHash Core::QueryExecution::roleNames() const { + QHash roles; + roles[static_cast(ItemRoles::TextRole)] = "itemTextRole"; + roles[static_cast(ItemRoles::ToolTipRole)] = "itemToolTipRole"; + roles[static_cast(ItemRoles::DecorationRole)] = "itemDecorationRole"; + roles[static_cast(ItemRoles::CompletionRole)] = "itemCompletionStringRole"; + roles[static_cast(ItemRoles::ActionRole)] = "itemActionRole"; // used to activate items as well + roles[static_cast(ItemRoles::AltActionRole)] = "itemAltActionsRole"; // used to activate items as well + roles[static_cast(ItemRoles::FallbackRole)] = "itemFallbackRole"; // used to activate items as well + return roles; +} + + +/** ***************************************************************************/ +QVariant Core::QueryExecution::data(const QModelIndex &index, int role) const { + if (index.isValid()) { + const shared_ptr &item = results_[static_cast(index.row())].first; + + switch ( role ) { + case ItemRoles::TextRole: + return item->text(); + case ItemRoles::ToolTipRole: + return item->subtext(); + case ItemRoles::DecorationRole: + return item->iconPath(); + case ItemRoles::CompletionRole: + return item->completion(); + case ItemRoles::ActionRole: + return (0 < static_cast(item->actions().size())) + ? item->actions()[0]->text() + : item->subtext(); + case ItemRoles::AltActionRole: { // Actions list + QStringList actionTexts; + for (auto &action : item->actions()) + actionTexts.append(action->text()); + return actionTexts; + } + case ItemRoles::FallbackRole: + return QString("Search '%1' using default fallback").arg(query_.rawString_); + } + } + return QVariant(); +} + + +/** ***************************************************************************/ +bool Core::QueryExecution::canFetchMore(const QModelIndex & /* index */) const +{ + if (query_.trigger_.isNull() && fetchIncrementally_ && sortedItems_ < static_cast(results_.size())) + return true; + else + return false; +} + + +/** ***************************************************************************/ +void Core::QueryExecution::fetchMore(const QModelIndex & /* index */) +{ + int sortUntil = min(sortedItems_ + FETCH_SIZE, static_cast(results_.size())); + if (query_.trigger_.isNull()) + partial_sort(results_.begin() + sortedItems_, + results_.begin() + sortUntil, + results_.end(), + MatchCompare()); + beginInsertRows(QModelIndex(), sortedItems_, sortUntil-1); + sortedItems_ = sortUntil; + endInsertRows(); + sortedItems_ = sortUntil; +} + + +/** ***************************************************************************/ +bool Core::QueryExecution::setData(const QModelIndex &index, const QVariant &value, int role) { + + if (index.isValid()) { + shared_ptr &item = results_[static_cast(index.row())].first; + switch ( role ) { + case ItemRoles::ActionRole:{ + if (0U < item->actions().size()){ + item->actions()[0]->activate(); + stats.activatedItem = item->id(); + } + break; + } + case ItemRoles::AltActionRole:{ + size_t actionValue = static_cast(value.toInt()); + if (actionValue < item->actions().size()) { + item->actions()[actionValue]->activate(); + stats.activatedItem = item->id(); + } + break; + } + case ItemRoles::FallbackRole:{ + if (0U < fallbacks_.size() && 0U < fallbacks_[0].first->actions().size()) { + fallbacks_[0].first->actions()[0]->activate(); + stats.activatedItem = fallbacks_[0].first->id(); + } + break; + } + } + return true; + } + return false; +} diff --git a/src/app/queryexecution.h b/src/app/queryexecution.h new file mode 100644 index 0000000..5de6c50 --- /dev/null +++ b/src/app/queryexecution.h @@ -0,0 +1,106 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "albert/query.h" + +namespace Core { + +class QueryHandler; +class FallbackProvider; +class Extension; +class Item; + +struct QueryStatistics { + QString input; + std::chrono::system_clock::time_point start; + std::chrono::system_clock::time_point end; + std::map runtimes; + bool cancelled = false; + QString activatedItem; +}; + + +/** + * @brief The QueryExecution class + * Represents the execution of a query + */ +class QueryExecution : public QAbstractListModel +{ + Q_OBJECT + +public: + + enum class State { Idle, Running, Finished }; + + QueryExecution(const std::set &, + const std::set &, + const QString &queryString, + std::map scores, + bool fetchIncrementally); + ~QueryExecution() override; + + const State &state() const; + + const Query *query(); + + void run(); + void cancel(); + + // Model interface + int rowCount(const QModelIndex &) const override; + QHash roleNames() const override; + QVariant data(const QModelIndex &index, int role) const override; + bool setData(const QModelIndex &index, const QVariant &value, int role) override; + bool canFetchMore(const QModelIndex &) const override; + void fetchMore(const QModelIndex &) override; + + QueryStatistics stats; + +private: + + void setState(State state); + + void runBatchHandlers(); + void onBatchHandlersFinished(); + void runRealtimeHandlers(); + void onRealtimeHandlersFinsished(); + void insertPendingResults(); + + bool isValid_ = true; + + Query query_; + State state_; + + std::set batchHandlers_; + std::set realtimeHandlers_; + + mutable std::vector, uint>> results_; + mutable std::vector, uint>> fallbacks_; + mutable int sortedItems_ = 0; + bool fetchIncrementally_ = false; + + QTimer fiftyMsTimer_; + + QFuture> future_; + QFutureWatcher> futureWatcher_; + +signals: + + void resultsReady(QAbstractItemModel*); + void stateChanged(State state); + +}; + +} + + diff --git a/src/app/querymanager.cpp b/src/app/querymanager.cpp new file mode 100644 index 0000000..181f66f --- /dev/null +++ b/src/app/querymanager.cpp @@ -0,0 +1,248 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "albert/extension.h" +#include "albert/fallbackprovider.h" +#include "albert/item.h" +#include "albert/queryhandler.h" +#include "extensionmanager.h" +#include "matchcompare.h" +#include "queryexecution.h" +#include "querymanager.h" +using namespace Core; +using namespace std; +using namespace std::chrono; + +namespace { +const char* CFG_INCREMENTAL_SORT = "incrementalSort"; +const bool DEF_INCREMENTAL_SORT = false; +} + +/** ***************************************************************************/ +Core::QueryManager::QueryManager(ExtensionManager* em, QObject *parent) + : QObject(parent), + extensionManager_(em) { + + QSqlQuery q; + + // Get last query id + lastQueryId_ = 0; + q.prepare("SELECT MAX(id) FROM query;"); + if (!q.exec()) + qFatal("SQL ERROR: %s %s", qPrintable(q.executedQuery()), qPrintable(q.lastError().text())); + if (q.next()) + lastQueryId_ = q.value(0).toULongLong(); + + // Get the handlers Ids + q.exec("SELECT string_id, id FROM query_handler;"); + if (!q.exec()) + qFatal("SQL ERROR: %s %s", qPrintable(q.executedQuery()), qPrintable(q.lastError().text())); + while(q.next()) + handlerIds_.emplace(q.value(0).toString(), q.value(1).toULongLong()); + + // Initialize the order + updateScores(); + + QSettings s(qApp->applicationName()); + incrementalSort_ = s.value(CFG_INCREMENTAL_SORT, DEF_INCREMENTAL_SORT).toBool(); +} + + +/** ***************************************************************************/ +QueryManager::~QueryManager() { + +} + + +/** ***************************************************************************/ +void Core::QueryManager::setupSession() { + + qDebug() << "========== SESSION SETUP STARTED =========="; + + system_clock::time_point start = system_clock::now(); + + // Call all setup routines + for (Core::QueryHandler *handler : extensionManager_->queryHandlers()) { + system_clock::time_point start = system_clock::now(); + handler->setupSession(); + long duration = duration_cast(system_clock::now()-start).count(); + qDebug() << qPrintable(QString("TIME: %1 µs SESSION SETUP [%2]").arg(duration, 6).arg(handler->id)); + } + + long duration = duration_cast(system_clock::now()-start).count(); + qDebug() << qPrintable(QString("TIME: %1 µs SESSION SETUP OVERALL").arg(duration, 6)); +} + + +/** ***************************************************************************/ +void Core::QueryManager::teardownSession() { + + qDebug() << "========== SESSION TEARDOWN STARTED =========="; + + system_clock::time_point start = system_clock::now(); + + // Call all teardown routines + for (Core::QueryHandler *handler : extensionManager_->queryHandlers()) { + system_clock::time_point start = system_clock::now(); + handler->teardownSession(); + long duration = duration_cast(system_clock::now()-start).count(); + qDebug() << qPrintable(QString("TIME: %1 µs SESSION TEARDOWN [%2]").arg(duration, 6).arg(handler->id)); + } + + // Clear views + emit resultsReady(nullptr); + + // Store statistics + QSqlDatabase db = QSqlDatabase::database(); + db.transaction(); + QSqlQuery query(db); + for ( QueryExecution *queryExecution : pastQueries_ ){ + + ++lastQueryId_; + const QueryStatistics &stats = queryExecution->stats; + + // Create a query record + query.prepare("INSERT INTO query (id, input, cancelled, runtime, timestamp) " + "VALUES (:id, :input, :cancelled, :runtime, :timestamp);"); + query.bindValue(":id", lastQueryId_); + query.bindValue(":input", stats.input); + query.bindValue(":cancelled", stats.cancelled); + query.bindValue(":runtime", static_cast(duration_cast(stats.end-stats.start).count())); + query.bindValue(":timestamp", static_cast(duration_cast(stats.start.time_since_epoch()).count())); + if (!query.exec()) + qFatal("SQL ERROR: %s", qPrintable(query.lastError().text())); + + // Make sure all handlers exits in database + query.prepare("INSERT INTO query_handler (string_id) VALUES (:id);"); + for ( auto & runtime : stats.runtimes ) { + auto it = handlerIds_.find(runtime.first); + if ( it == handlerIds_.end()){ + query.bindValue(":id", runtime.first); + if (!query.exec()) + qFatal("SQL ERROR: %s %s", qPrintable(query.executedQuery()), qPrintable(query.lastError().text())); + handlerIds_.emplace(runtime.first, query.lastInsertId().toULongLong()); + } + } + + // Create execution records + query.prepare("INSERT INTO execution (query_id, handler_id, runtime) " + "VALUES (:query_id, :handler_id, :runtime);"); + for ( auto & runtime : stats.runtimes ) { + query.bindValue(":query_id", lastQueryId_); + query.bindValue(":handler_id", handlerIds_[runtime.first]); + query.bindValue(":runtime", runtime.second); + if (!query.exec()) + qFatal("SQL ERROR: %s %s", qPrintable(query.executedQuery()), qPrintable(query.lastError().text())); + } + + // Create activation record + if (!stats.activatedItem.isNull()) { + query.prepare("INSERT INTO activation (query_id, item_id) VALUES (:query_id, :item_id);"); + query.bindValue(":query_id", lastQueryId_); + query.bindValue(":item_id", stats.activatedItem); + if (!query.exec()) + qFatal("SQL ERROR: %s %s", qPrintable(query.executedQuery()), qPrintable(query.lastError().text())); + } + } + db.commit(); + + // Delete queries + for ( QueryExecution *query : pastQueries_ ) + if ( query->state() == QueryExecution::State::Running ) + connect(query, &QueryExecution::stateChanged, + query, [query](){ query->deleteLater(); }); + else + delete query; + pastQueries_.clear(); + + // Compute new match rankings + updateScores(); + + long duration = duration_cast(system_clock::now()-start).count(); + qDebug() << qPrintable(QString("TIME: %1 µs SESSION TEARDOWN OVERALL").arg(duration, 6)); +} + + +/** ***************************************************************************/ +void Core::QueryManager::startQuery(const QString &searchTerm) { + + qDebug() << "========== QUERY:" << searchTerm << " =========="; + + if ( pastQueries_.size() ) { + // Stop last query + QueryExecution *last = pastQueries_.back(); + disconnect(last, &QueryExecution::resultsReady, this, &QueryManager::resultsReady); + if (last->state() != QueryExecution::State::Finished) + last->cancel(); + } + + system_clock::time_point start = system_clock::now(); + + // Start query + QueryExecution *currentQuery = new QueryExecution(extensionManager_->queryHandlers(), + extensionManager_->fallbackProviders(), + searchTerm, + scores_, + incrementalSort_); + connect(currentQuery, &QueryExecution::resultsReady, this, &QueryManager::resultsReady); + currentQuery->run(); + + connect(currentQuery, &QueryExecution::stateChanged, [start](QueryExecution::State state){ + if ( state == QueryExecution::State::Finished ) { + long duration = duration_cast(system_clock::now()-start).count(); + qDebug() << qPrintable(QString("TIME: %1 µs QUERY OVERALL").arg(duration, 6)); + } + }); + + pastQueries_.emplace_back(currentQuery); + + long duration = duration_cast(system_clock::now()-start).count(); + qDebug() << qPrintable(QString("TIME: %1 µs SESSION TEARDOWN OVERALL").arg(duration, 6)); +} + + +/** ***************************************************************************/ +bool QueryManager::incrementalSort(){ + return incrementalSort_; +} + + +/** ***************************************************************************/ +void QueryManager::setIncrementalSort(bool value){ + QSettings(qApp->applicationName()).setValue(CFG_INCREMENTAL_SORT, value); + incrementalSort_ = value; +} + + +/** *************************************************************************** + * @brief Core::MatchCompare::update + * Update the usage score: + * Score of a single usage is 1/(+1). + * Accumulate all scores groupes by itemId. + * Normalize the scores to the range of UINT_MAX. + */ +void QueryManager::updateScores() +{ + scores_.clear(); + QSqlQuery query("SELECT a.item_id AS id, SUM(1/(julianday('now')-julianday(timestamp, 'unixepoch')+1)) AS score " + "FROM activation a JOIN query q ON a.query_id = q.id " + "WHERE a.item_id<>'' " + "GROUP BY a.item_id " + "ORDER BY score DESC"); + if ( query.next() ){ + double max = query.value(1).toDouble(); + do { + scores_.emplace(query.value(0).toString(), static_cast(query.value(1).toDouble()*UINT_MAX/max)); + } while (query.next()); + } +} diff --git a/src/app/querymanager.h b/src/app/querymanager.h new file mode 100644 index 0000000..06055c7 --- /dev/null +++ b/src/app/querymanager.h @@ -0,0 +1,46 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include + +namespace Core { + +class ExtensionManager; +class QueryExecution; + +class QueryManager final : public QObject +{ + Q_OBJECT + +public: + + QueryManager(ExtensionManager* em, QObject *parent = 0); + ~QueryManager(); + + void setupSession(); + void teardownSession(); + void startQuery(const QString &searchTerm); + + bool incrementalSort(); + void setIncrementalSort(bool value); + +private: + + void updateScores(); + + ExtensionManager *extensionManager_; + std::list pastQueries_; + bool incrementalSort_; + std::map scores_; + std::map handlerIds_; + unsigned long long lastQueryId_; + +signals: + + void resultsReady(QAbstractItemModel*); +}; + +} diff --git a/src/app/settingswidget/grabkeybutton.cpp b/src/app/settingswidget/grabkeybutton.cpp new file mode 100644 index 0000000..34db042 --- /dev/null +++ b/src/app/settingswidget/grabkeybutton.cpp @@ -0,0 +1,90 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "grabkeybutton.h" + +/** ***************************************************************************/ + +Core::GrabKeyButton::GrabKeyButton(QWidget * parent) : QPushButton(parent) { + waitingForHotkey_ = false; + connect(this, &QPushButton::clicked, + this, &GrabKeyButton::onClick); +} + + + +/** ***************************************************************************/ +Core::GrabKeyButton::~GrabKeyButton() { +} + + + +/** ***************************************************************************/ +void Core::GrabKeyButton::onClick() { + oldText_ = text(); + setText("?"); + grabAll(); +} + + + +/** ***************************************************************************/ +void Core::GrabKeyButton::grabAll() { + grabKeyboard(); + grabMouse(); + waitingForHotkey_ = true; +} + + + +/** ***************************************************************************/ +void Core::GrabKeyButton::releaseAll() { + releaseKeyboard(); + releaseMouse(); + waitingForHotkey_ = false; +} + + + +/** ***************************************************************************/ +void Core::GrabKeyButton::keyPressEvent(QKeyEvent *event) { + if ( waitingForHotkey_ ) { + // Modifier pressed -> update the label + int key = event->key(); + int mods = event->modifiers(); + if(key == Qt::Key_Control || key == Qt::Key_Shift || key == Qt::Key_Alt || key == Qt::Key_Meta ) { + setText(QKeySequence((mods&~Qt::GroupSwitchModifier)|Qt::Key_Question).toString());//QTBUG-45568 + event->accept(); + return; + } + + if(key == Qt::Key_Escape && mods == Qt::NoModifier) { + event->accept(); + setText(oldText_); + releaseAll(); // Can not be before since window closes on esc + return; + } + releaseAll(); + + setText(QKeySequence((mods&~Qt::GroupSwitchModifier)|key).toString()); //QTBUG-45568 + emit keyCombinationPressed(mods|key); + return; + } +// QWidget::keyPressEvent( event ); +} + + + +/** ***************************************************************************/ +void Core::GrabKeyButton::keyReleaseEvent(QKeyEvent *event) { + if ( waitingForHotkey_ ) { + // Modifier released -> update the label + int key = event->key(); + if(key == Qt::Key_Control || key == Qt::Key_Shift || key == Qt::Key_Alt || key == Qt::Key_Meta) { + setText(QKeySequence((event->modifiers()&~Qt::GroupSwitchModifier)|Qt::Key_Question).toString());//QTBUG-45568 + event->accept(); + return; + } + return; + } + QWidget::keyReleaseEvent( event ); +} diff --git a/src/app/settingswidget/grabkeybutton.h b/src/app/settingswidget/grabkeybutton.h new file mode 100644 index 0000000..6a5f836 --- /dev/null +++ b/src/app/settingswidget/grabkeybutton.h @@ -0,0 +1,32 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include + +namespace Core { + +class GrabKeyButton final : public QPushButton +{ + Q_OBJECT + +public: + GrabKeyButton(QWidget * parent = 0); + ~GrabKeyButton(); + +private: + bool waitingForHotkey_; + QString oldText_; + + void grabAll(); + void releaseAll(); + void onClick(); + void keyPressEvent (QKeyEvent *) override; + void keyReleaseEvent ( QKeyEvent* ) override; + +signals: + void keyCombinationPressed(int); +}; + +} diff --git a/src/app/settingswidget/loadermodel.cpp b/src/app/settingswidget/loadermodel.cpp new file mode 100644 index 0000000..64518be --- /dev/null +++ b/src/app/settingswidget/loadermodel.cpp @@ -0,0 +1,90 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include "loadermodel.h" +#include "extensionmanager.h" +#include "pluginspec.h" +using std::unique_ptr; +using namespace Core; + + + +/** ***************************************************************************/ +Core::LoaderModel::LoaderModel(ExtensionManager* pm, QObject *parent) + : QAbstractListModel(parent), extensionManager_(pm){ +} + + + +/** ***************************************************************************/ +int Core::LoaderModel::rowCount(const QModelIndex &) const { + return static_cast(extensionManager_->extensionSpecs().size()); +} + + + +/** ***************************************************************************/ +QVariant Core::LoaderModel::data(const QModelIndex &index, int role) const { + if (!index.isValid() || index.row() < 0 || rowCount() <= index.row()) + return QVariant(); + + const unique_ptr &loader = extensionManager_->extensionSpecs()[index.row()]; + + switch (role) { + case Qt::DisplayRole: + return loader->name(); + case Qt::ToolTipRole:{ + QString toolTip; + toolTip = QString("ID: %1\nVersion: %2\nAuthor: %3\n").arg(loader->id(), loader->version(), loader->author()); + if (!loader->lastError().isEmpty()) + toolTip.append(QString("Error: %1\n").arg(loader->lastError())); + if (!loader->dependencies().empty()) + toolTip.append(QString("Dependencies: %1\n").arg(loader->dependencies().join(", "))); + toolTip.append(QString("Path: %1").arg(loader->path())); + return toolTip; + } + case Qt::DecorationRole: + switch (loader->state()) { + case PluginSpec::State::Loaded: + return QIcon(":plugin_loaded"); + case PluginSpec::State::NotLoaded: + return QIcon(":plugin_notloaded"); + case PluginSpec::State::Error: + return QIcon(":plugin_error"); + } + case Qt::CheckStateRole: + return (extensionManager_->extensionIsEnabled(loader))?Qt::Checked:Qt::Unchecked; + default: + return QVariant(); + } +} + + + +/** ***************************************************************************/ +bool Core::LoaderModel::setData(const QModelIndex &index, const QVariant &value, int role) { + if (!index.isValid() || index.row() < 0 || rowCount() <= index.row()) + return false; + + switch (role) { + case Qt::CheckStateRole: + if (value == Qt::Checked) + extensionManager_->enableExtension(extensionManager_->extensionSpecs()[index.row()]); + else + extensionManager_->disableExtension(extensionManager_->extensionSpecs()[index.row()]); + dataChanged(index, index, {Qt::CheckStateRole}); + return true; + default: + return false; + } +} + + + +/** ***************************************************************************/ +Qt::ItemFlags Core::LoaderModel::flags(const QModelIndex &) const { + return Qt::ItemIsSelectable + |Qt::ItemIsUserCheckable + |Qt::ItemIsEnabled + |Qt::ItemNeverHasChildren; +} diff --git a/src/app/settingswidget/loadermodel.h b/src/app/settingswidget/loadermodel.h new file mode 100644 index 0000000..12a5c48 --- /dev/null +++ b/src/app/settingswidget/loadermodel.h @@ -0,0 +1,22 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include + +namespace Core { + +class ExtensionManager; + +class LoaderModel final : public QAbstractListModel +{ +public: + LoaderModel(Core::ExtensionManager* pm, QObject *parent = nullptr); + int rowCount(const QModelIndex & parent = QModelIndex()) const override; + QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const override; + bool setData(const QModelIndex & index, const QVariant & value, int role = Qt::EditRole) override; + Qt::ItemFlags flags(const QModelIndex & index) const override; +private: + Core::ExtensionManager *extensionManager_; +}; + +} diff --git a/src/app/settingswidget/settingswidget.cpp b/src/app/settingswidget/settingswidget.cpp new file mode 100644 index 0000000..1cfeaea --- /dev/null +++ b/src/app/settingswidget/settingswidget.cpp @@ -0,0 +1,365 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "../extensionmanager.h" +#include "../frontendmanager.h" +#include "../pluginspec.h" +#include "../querymanager.h" +#include "../telemetry.h" +#include "../trayicon.h" +#include "albert/extension.h" +#include "albert/frontend.h" +#include "globalshortcut/hotkeymanager.h" +#include "grabkeybutton.h" +#include "loadermodel.h" +#include "settingswidget.h" +// TODO: Remove Apr 2020 +#ifdef BUILD_WITH_QTCHARTS +#include "statswidget.h" +#endif +using namespace std; +using namespace Core; +using namespace GlobalShortcut; + +namespace { +const char* CFG_TERM = "terminal"; +} + +extern QString terminalCommand; + + +/** ***************************************************************************/ +Core::SettingsWidget::SettingsWidget(ExtensionManager *extensionManager, + FrontendManager *frontendManager, + QueryManager *queryManager, + HotkeyManager *hotkeyManager, + TrayIcon *systemTrayIcon, + Telemetry *telemetry, + QWidget *parent, Qt::WindowFlags f) + : QWidget(parent, f), + extensionManager_(extensionManager), + frontendManager_(frontendManager), + queryManager_(queryManager), + hotkeyManager_(hotkeyManager), + trayIcon_(systemTrayIcon), + telemetry_(telemetry) { + + ui.setupUi(this); + + + /* + * GENERAL + */ + + // HOTKEY + QSet hks = hotkeyManager->hotkeys(); + if (hks.size() < 1) + ui.grabKeyButton_hotkey->setText("Press to set hotkey"); + else + ui.grabKeyButton_hotkey->setText(QKeySequence(*hks.begin()).toString()); // OMG + connect(ui.grabKeyButton_hotkey, &GrabKeyButton::keyCombinationPressed, + this, &SettingsWidget::changeHotkey); + + // TRAY + ui.checkBox_showTray->setChecked(trayIcon_->isVisible()); + connect(ui.checkBox_showTray, &QCheckBox::toggled, + trayIcon_, &TrayIcon::setVisible); + + // INCREMENTAL SORT + ui.checkBox_incrementalSort->setChecked(queryManager_->incrementalSort()); + connect(ui.checkBox_incrementalSort, &QCheckBox::toggled, + queryManager_, &QueryManager::setIncrementalSort); + + // TELEMETRY + ui.checkBox_telemetry->setChecked(telemetry_->isEnabled()); + connect(ui.checkBox_telemetry, &QCheckBox::toggled, this, [this](bool checked){ telemetry_->enable(checked); }); + + // AUTOSTART +#ifdef Q_OS_LINUX + QString desktopfile_path = QStandardPaths::locate(QStandardPaths::ApplicationsLocation, + "albert.desktop", + QStandardPaths::LocateFile); + if (!desktopfile_path.isNull()) { + QString autostart_path = QDir(QStandardPaths::writableLocation(QStandardPaths::ConfigLocation)).filePath("autostart/albert.desktop"); + ui.checkBox_autostart->setChecked(QFile::exists(autostart_path)); + connect(ui.checkBox_autostart, &QCheckBox::toggled, + this, [=](bool toggled){ + if (toggled) + QFile::link(desktopfile_path, autostart_path); + else + QFile::remove(autostart_path); + }); + } + else + qCritical() << "Deskop entry not found! Autostart option is nonfuctional"; +#elif + ui.autostartCheckBox->setEnabled(false); + qWarning() << "Autostart not implemented on this platform!" +#endif + + // FRONTEND + for ( const unique_ptr &plugin : frontendManager_->frontendSpecs() ){ + + // Add item (text and id) + ui.comboBox_frontend->addItem(plugin->name(), plugin->id()); + + // Add tooltip + ui.comboBox_frontend->setItemData(ui.comboBox_frontend->count()-1, + QString("%1\nID: %2\nVersion: %3\nAuthor: %4\nDependencies: %5") + .arg(plugin->name(), + plugin->id(), + plugin->version(), + plugin->author(), + plugin->dependencies().join(", ")), + Qt::ToolTipRole); + // Set to current if ids match + if ( plugin->id() == frontendManager_->currentFrontend()->id() ) + ui.comboBox_frontend->setCurrentIndex(ui.comboBox_frontend->count()-1); + } + + ui.tabGeneral->layout()->addWidget(frontendManager_->currentFrontend()->widget(ui.tabGeneral)); + + connect(ui.comboBox_frontend, static_cast(&QComboBox::currentIndexChanged), + [this](int i){ + QString id = ui.comboBox_frontend->itemData(i, Qt::UserRole).toString(); + frontendManager_->setCurrentFrontend(id); + + QLayoutItem* item; + for ( int i = ui.tabGeneral->layout()->count() - 1; i > 0; --i ) { + item = ui.tabGeneral->layout()->takeAt(i); + delete item->widget(); + delete item; + } + + ui.tabGeneral->layout()->addWidget(frontendManager_->currentFrontend()->widget(ui.tabGeneral)); + + }); + + + // TERM CMD (TOOOOOOOOOOODOOOOOOOOOO CENTRALIZE THIS) + // Define the (global extern) terminal command + terminalCommand = QSettings(qApp->applicationName()).value(CFG_TERM, QString()).toString(); + + // Available terms + std::vector> terms { + // Distro terms + {"Deepin Terminal", "deepin-terminal -x"}, + {"Gnome Terminal", "gnome-terminal --"}, + {"Konsole", "konsole -e"}, + {"LXTerminal", "lxterminal -e"}, + {"Mate-Terminal", "mate-terminal -x"}, + {"XFCE-Terminal", "xfce4-terminal -x"}, + // Standalone terms + {"Cool Retro Term", "cool-retro-term -e"}, + {"RoxTerm", "roxterm -x"}, + {"Terminator", "terminator -x"}, + {"UXTerm", "uxterm -e"}, + {"XTerm", "xterm -e"}, + {"urxvt", "urxvt -e"} + }; + + // Filter available terms by availability + for (auto it = terms.cbegin(); it != terms.cend(); ++it) + if (QStandardPaths::findExecutable(it->second.split(' ').first()).isEmpty()) + it = terms.erase(it); + else + ++it; + + // if terminalCommand is not set, use the first found + if (terminalCommand.isNull()) + terminalCommand = terms[0].second; + + // Fill checkbox + for (const auto & t : terms) + ui.comboBox_term->addItem(t.first, t.second); + ui.comboBox_term->insertSeparator(ui.comboBox_term->count()); + ui.comboBox_term->addItem(tr("Custom")); + + // Set current item + ui.comboBox_term->setCurrentIndex(-1); + for (size_t i = 0; i < terms.size(); ++i) + if (terms[i].second == terminalCommand) + ui.comboBox_term->setCurrentIndex(static_cast(i)); + if (ui.comboBox_term->currentIndex() == -1) + ui.comboBox_term->setCurrentIndex(ui.comboBox_term->count()-1); // Is never -1 since Custom is always there + + // Put command in lineedit + ui.lineEdit_term->setText(terminalCommand); + ui.lineEdit_term->setEnabled(ui.comboBox_term->currentIndex() == ui.comboBox_term->count()-1); + + // Set behavior on index change + connect(ui.comboBox_term, static_cast(&QComboBox::currentIndexChanged), + [this](int index){ + if ( index != ui.comboBox_term->count()-1) { + terminalCommand = ui.comboBox_term->currentData(Qt::UserRole).toString(); + ui.lineEdit_term->setText(terminalCommand); + QSettings(qApp->applicationName()).setValue(CFG_TERM, terminalCommand); + } + ui.lineEdit_term->setEnabled(index == ui.comboBox_term->count()-1); + }); + + // Set behavior for textEdited signal of custom-term-lineedit + connect(ui.lineEdit_term, &QLineEdit::textEdited, [](QString str){ + terminalCommand = str; + QSettings(qApp->applicationName()).setValue(CFG_TERM, terminalCommand); + }); + + // Cache + connect(ui.pushButton_clearHistory, &QPushButton::clicked, + []{ QSqlQuery("DELETE FROM activation;"); }); + + /* + * PLUGINS + */ + + // Show the plugins. This* widget takes ownership of the model + ui.listView_plugins->setModel(new LoaderModel(extensionManager_, ui.listView_plugins)); + + // Update infos when item is changed + connect(ui.listView_plugins->selectionModel(), &QItemSelectionModel::currentChanged, + this, &SettingsWidget::updatePluginInformations); + + connect(ui.listView_plugins->model(), &QAbstractListModel::dataChanged, + this, &SettingsWidget::onPluginDataChanged); + + // Initially hide the title label + ui.label_pluginTitle->hide(); + + + /* + * STATS + */ + +// TODO: Remove Apr 2020 +#ifdef BUILD_WITH_QTCHARTS + StatsWidget *statsWidget = new StatsWidget(this); + ui.tabs->insertTab(2, statsWidget, "Stats"); +#endif + + + /* + * ABOUT + */ + + QString about = ui.about_text->text(); + about.replace("___versionstring___", qApp->applicationVersion()); + about.replace("___buildinfo___", QString("Built %1 %2").arg(__DATE__, __TIME__)); + ui.about_text->setText(about); + + QDesktopWidget *dw = QApplication::desktop(); + move(dw->availableGeometry(dw->screenNumber(QCursor::pos())).center() + -QPoint(width()/2,height()/2)); + raise(); + activateWindow(); +} + + + +/** ***************************************************************************/ +void SettingsWidget::updatePluginInformations(const QModelIndex & current) { + // Hidde the placehodler text + QLayoutItem *i = ui.widget_pluginInfos->layout()->takeAt(1); + delete i->widget(); + delete i; + + if ( extensionManager_->extensionSpecs()[static_cast(current.row())]->state() + == PluginSpec::State::Loaded ){ + Extension *extension = dynamic_cast( + extensionManager_->extensionSpecs()[static_cast(current.row())]->instance()); + if (!extension){ + qWarning() << "Cannot cast an object of extension spec to an extension!"; + return; // Should no happen + } + QWidget *pw = extension->widget(); + if ( pw->layout() != nullptr) + pw->layout()->setMargin(0); + ui.widget_pluginInfos->layout()->addWidget(pw);// Takes ownership + ui.label_pluginTitle->setText(extension->name()); + ui.label_pluginTitle->show(); + } + else{ + QString msg("Plugin not loaded.\n%1"); + QLabel *lbl = new QLabel(msg.arg(extensionManager_->extensionSpecs()[static_cast(current.row())]->lastError())); + lbl->setEnabled(false); + lbl->setAlignment(Qt::AlignCenter); + lbl->setWordWrap(true); + ui.widget_pluginInfos->layout()->addWidget(lbl); + ui.label_pluginTitle->hide(); + } +} + + + +/** ***************************************************************************/ +void SettingsWidget::changeHotkey(int newhk) { + int oldhk = *hotkeyManager_->hotkeys().begin(); //TODO Make cool sharesdpointer design + + // Try to set the hotkey + if (hotkeyManager_->registerHotkey(newhk)) { + QString hkText(QKeySequence((newhk&~Qt::GroupSwitchModifier)).toString());//QTBUG-45568 + ui.grabKeyButton_hotkey->setText(hkText); + QSettings(qApp->applicationName()).setValue("hotkey", hkText); + hotkeyManager_->unregisterHotkey(oldhk); + } else { + ui.grabKeyButton_hotkey->setText(QKeySequence(oldhk).toString()); + QMessageBox(QMessageBox::Critical, "Error", + QKeySequence(newhk).toString() + " could not be registered.", + QMessageBox::NoButton, + this).exec(); + } +} + + + +/** ***************************************************************************/ +void SettingsWidget::onPluginDataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector &roles) { + Q_UNUSED(bottomRight) + if (topLeft == ui.listView_plugins->currentIndex()) + for (int role : roles) + if (role == Qt::CheckStateRole) + updatePluginInformations(topLeft); +} + + + +/** ***************************************************************************/ +void SettingsWidget::keyPressEvent(QKeyEvent *event) { + if (event->modifiers() == Qt::NoModifier && event->key() == Qt::Key_Escape ) { + close(); + } +} + + + +/** ***************************************************************************/ +void SettingsWidget::closeEvent(QCloseEvent *event) { + if (hotkeyManager_->hotkeys().empty()) { + QMessageBox msgBox(QMessageBox::Warning, "Hotkey Missing", + "Hotkey is invalid, please set it. Press OK to go "\ + "back to the settings.", + QMessageBox::Ok|QMessageBox::Ignore, + this); + msgBox.exec(); + if ( msgBox.result() == QMessageBox::Ok ) { + ui.tabs->setCurrentIndex(0); + show(); + event->ignore(); + return; + } + } + event->accept(); +} diff --git a/src/app/settingswidget/settingswidget.h b/src/app/settingswidget/settingswidget.h new file mode 100644 index 0000000..0db9c62 --- /dev/null +++ b/src/app/settingswidget/settingswidget.h @@ -0,0 +1,50 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include "ui_settingswidget.h" + +namespace GlobalShortcut { +class HotkeyManager; +} +namespace Core { +class ExtensionManager; +class FrontendManager; +class QueryManager; +class MainWindow; +class TrayIcon; +class Telemetry; + +class SettingsWidget final : public QWidget +{ + Q_OBJECT + +public: + + SettingsWidget(ExtensionManager *extensionManager, + FrontendManager *frontendManager, + QueryManager *queryManager, + GlobalShortcut::HotkeyManager *hotkeyManager, + TrayIcon *trayIcon, + Telemetry *telemetry, + QWidget * parent = nullptr, + Qt::WindowFlags f = nullptr); + +private: + + void keyPressEvent(QKeyEvent * event) override; + void closeEvent(QCloseEvent * event) override; + void onPluginDataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector &roles); + void changeHotkey(int); + void updatePluginInformations(const QModelIndex & curr); + + ExtensionManager *extensionManager_; + FrontendManager *frontendManager_; + QueryManager *queryManager_; + GlobalShortcut::HotkeyManager *hotkeyManager_; + TrayIcon *trayIcon_; + Telemetry *telemetry_; + Ui::SettingsDialog ui; + +}; + +} diff --git a/src/app/settingswidget/settingswidget.ui b/src/app/settingswidget/settingswidget.ui new file mode 100644 index 0000000..f156dd3 --- /dev/null +++ b/src/app/settingswidget/settingswidget.ui @@ -0,0 +1,450 @@ + + + Core::SettingsDialog + + + + 0 + 0 + 800 + 480 + + + + + 720 + 400 + + + + Settings + + + + 0 + + + 0 + + + 0 + + + 0 + + + + + 0 + + + + General + + + + + + + + General + + + + Qt::AlignRight|Qt::AlignTrailing|Qt::AlignVCenter + + + + + Hotkey: + + + grabKeyButton_hotkey + + + + + + + + 0 + 0 + + + + + 120 + 0 + + + + <html><head/><body><p>Press to set hotkey.</p></body></html> + + + + + + + + + + Frontend: + + + comboBox_frontend + + + + + + + + 0 + 0 + + + + <html><head/><body><p>Choose the frontend to use.</p></body></html> + + + + + + + Ter&minal: + + + comboBox_term + + + + + + + + 0 + 0 + + + + <html><head/><body><p>Choose the terminal to use.</p></body></html> + + + + + + + Terminal command: + + + lineEdit_term + + + + + + + <html><head/><body><p>This is the command that is used to start terminal. Chose &quot;Custom&quot; in the checkbox above to set it manually.</p></body></html> + + + + + + + Show tray icon: + + + checkBox_showTray + + + + + + + <html><head/><body><p>If this option is enabled, albert displays an icon in the system tray.</p></body></html> + + + + + + + + + + I&ncremental sort: + + + checkBox_incrementalSort + + + + + + + <html><head/><body><p>If this option is enabled only the visible items are sorted. This improves the performance when displaying huge result sets. However the size of the scrollbar will be less intuitive since the height of the scrollbar is determined by the sorted results instead of the actual amount of results.</p></body></html> + + + + + + + &Clear history: + + + pushButton_clearHistory + + + + + + + + 0 + 0 + + + + <html><head/><body><p>Clears the history database. Note that this will reset your sort order of recently used items too.</p></body></html> + + + Clear + + + + + + + Autostart on login: + + + checkBox_autostart + + + + + + + <html><head/><body><p>If this option is enabled Albert will be started on session login.</p></body></html> + + + + + + + Send telemetry: + + + checkBox_telemetry + + + + + + + <html><head/><body><p>If this option is enabled albert reports anonymous data.</p></body></html> + + + + + + + + + + + + + Qt::Vertical + + + + 0 + 0 + + + + + + + + + + + Extensions + + + + + + + + + 0 + 0 + + + + + 200 + 0 + + + + + 200 + 16777215 + + + + Qt::ScrollBarAlwaysOff + + + true + + + + + + + + + + 0 + + + 0 + + + 0 + + + 0 + + + + + + 0 + 0 + + + + font-size: 12pt;padding-bottom: 5px; + + + + + + + false + + + Select a plugin. + + + Qt::AlignCenter + + + + + + + + + + + About + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + :/app_icon + + + false + + + Qt::AlignCenter + + + + + + + <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd"> +<html><head><meta name="qrichtext" content="1" /><style type="text/css"> +p, li { white-space: pre-wrap; } +</style></head><body style=" font-family:'Roboto'; font-size:10pt; font-weight:200; font-style:normal;"> +<p style=" margin-top:16px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><span style=" font-size:x-large; font-weight:600;">Albert launcher ___versionstring___</span></p> +<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">If you encounter bugs or think you have suggestions for improvement, tell me at <a href="https://github.com/albertlauncher/albert/issues"><span style=" text-decoration: underline; color:#00cccc;">GitHub</span></a>.</p> +<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">If you really like this software please consider a <a href="https://albertlauncher.github.io/docs/donation/"><span style=" text-decoration: underline; color:#00cccc;">donation</span></a> or become a <a href="https://www.patreon.com/albertlauncher"><span style=" text-decoration: underline; color:#00cccc;">patron</span></a>.</p> +<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">I'd like to thank all <a href="https://github.com/albertlauncher/albert/graphs/contributors"><span style=" text-decoration: underline; color:#00cccc;">contributors</span></a>, <a href="https://albertlauncher.github.io/docs/supporters/"><span style=" text-decoration: underline; color:#00cccc;">supporters</span></a> and users. You keep this project going on.</p> +<p style=" margin-top:12px; margin-bottom:12px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;"><span style=" font-size:8pt; color:#808080;">___buildinfo___</span></p></body></html> + + + Qt::AlignCenter + + + true + + + true + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + + + + + GrabKeyButton + QPushButton +
    grabkeybutton.h
    +     +     + + tabs + grabKeyButton_hotkey + comboBox_frontend + comboBox_term + lineEdit_term + checkBox_showTray + checkBox_incrementalSort + pushButton_clearHistory + listView_plugins + + + + + +     diff --git a/src/app/settingswidget/statswidget.cpp b/src/app/settingswidget/statswidget.cpp new file mode 100644 index 0000000..d5317f1 --- /dev/null +++ b/src/app/settingswidget/statswidget.cpp @@ -0,0 +1,147 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "statswidget.h" +#include +#include +#include + +StatsWidget::StatsWidget(QWidget *parent) : QChartView(parent) +{ + _dateTimeAxis = new QDateTimeAxis; + _dateTimeAxis->setTickCount(8); + _dateTimeAxis->setFormat("dd.MM."); + _dateTimeAxis->setLabelsAngle(-45); + _dateTimeAxis->setTitleText("Date"); + + _valueAxis_activations = new QValueAxis; + _valueAxis_activations->setLabelFormat("%i"); + _valueAxis_activations->setTitleText("Activations per day"); +// valueAxis_activations->setMinorTickCount(1); + + _valueAxis_cumsum = new QValueAxis; + _valueAxis_cumsum->setLabelFormat("%i"); + _valueAxis_cumsum->setTitleText("Cumulative activations"); + + _chart = new QChart(); + _chart->layout()->setContentsMargins(0, 0, 0, 0); + _chart->setBackgroundRoundness(0); +// chart->setTitle("Usage"); + _chart->addAxis(_dateTimeAxis, Qt::AlignBottom); + _chart->addAxis(_valueAxis_activations, Qt::AlignLeft); + _chart->addAxis(_valueAxis_cumsum, Qt::AlignRight); + + setChart(_chart); + setRenderHint(QPainter::Antialiasing); +} + +void StatsWidget::showEvent(QShowEvent *) +{ + updateChart(); +} + +void StatsWidget::updateChart() +{ + _chart->removeAllSeries(); + + // Add user data + + QLineSeries *activationSeries = new QLineSeries(); + activationSeries->setName("Your daily activations"); + QLineSeries *cumSumSeries = new QLineSeries(); + cumSumSeries->setName("Your cumulative activations"); + + for (auto & series : {activationSeries, cumSumSeries}) { + QPen pen = series->pen(); + pen.setWidth(1); + pen.setColor("#00cccc"); + series->setPen(pen); + } + QPen pen = cumSumSeries->pen(); + pen.setStyle(Qt::DashDotLine); + cumSumSeries->setPen(pen); + + QSqlQuery q("SELECT q.timestamp, COUNT(*) " + "FROM activation a JOIN query q ON a.query_id == q.id " + "GROUP BY date(q.timestamp, 'unixepoch') " + "HAVING q.timestamp > strftime('%s', 'now', '-30 days');"); + double cumsum = 0; + while (q.next()) { + int activationsPerDay = q.value(1).toInt(); + cumsum += activationsPerDay; + activationSeries->append(q.value(0).toLongLong()*1000, activationsPerDay); + cumSumSeries->append(q.value(0).toLongLong()*1000, cumsum); + } + _chart->addSeries(activationSeries); + _chart->addSeries(cumSumSeries); + + activationSeries->attachAxis(_dateTimeAxis); + activationSeries->attachAxis(_valueAxis_activations); + + cumSumSeries->attachAxis(_dateTimeAxis); + cumSumSeries->attachAxis(_valueAxis_cumsum); + + _valueAxis_activations->setRange(0, _valueAxis_activations->max()); + _valueAxis_cumsum->setRange(0, _valueAxis_cumsum->max()); + + + // Add global data + + QString addr = "Zffb,!!*\" $## $\"' **!"; + for ( auto &c: addr) + c.unicode()=c.unicode()+14; + addr.append("api/activations?days=30"); + + static QNetworkAccessManager *manager = new QNetworkAccessManager; + QNetworkReply* reply = manager->get(QNetworkRequest(QUrl(addr))); + + QObject::connect(reply, &QNetworkReply::finished, [reply, this](){ + if (reply->error() == QNetworkReply::NoError){ + + QLineSeries *activationSeries = new QLineSeries(); + activationSeries->setName("Global Ø daily activations"); + QLineSeries *cumSumSeries = new QLineSeries(); + cumSumSeries->setName("Global Ø cumulative activations"); + + for (auto & series : {activationSeries, cumSumSeries}) { + QPen pen = series->pen(); + pen.setWidth(1); + pen.setColor("#FF7400"); + series->setPen(pen); + } + QPen pen = cumSumSeries->pen(); + pen.setStyle(Qt::DashDotLine); + cumSumSeries->setPen(pen); + + QJsonArray jsonArray = QJsonDocument::fromJson(reply->readAll()).array(); + double cumSum = 0; + for (QJsonValueRef jsonValue : jsonArray) { + const QJsonObject &jsonObject = jsonValue.toObject(); + /* + * { + * "date": "2018-10-17", + * "reports": 5941, + * "activations": 32238 + * }, + */ + double avgActivationsPerDay = jsonObject.value("activations").toDouble() / jsonObject.value("reports").toDouble(); + int64_t msTimestamp = QDateTime::fromString(jsonObject.value("date").toString(), "yyyy-MM-dd").toMSecsSinceEpoch(); + cumSum += avgActivationsPerDay; + activationSeries->append(msTimestamp, avgActivationsPerDay); + cumSumSeries->append(msTimestamp, cumSum); + } + + _chart->addSeries(activationSeries); + _chart->addSeries(cumSumSeries); + + activationSeries->attachAxis(_dateTimeAxis); + activationSeries->attachAxis(_valueAxis_activations); + + cumSumSeries->attachAxis(_dateTimeAxis); + cumSumSeries->attachAxis(_valueAxis_cumsum); + + _valueAxis_activations->setRange(0, _valueAxis_activations->max()); + _valueAxis_cumsum->setRange(0, _valueAxis_cumsum->max()); + } + reply->deleteLater(); + }); +} diff --git a/src/app/settingswidget/statswidget.h b/src/app/settingswidget/statswidget.h new file mode 100644 index 0000000..a4c6eb3 --- /dev/null +++ b/src/app/settingswidget/statswidget.h @@ -0,0 +1,24 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include + +class StatsWidget : public QChartView +{ + Q_OBJECT + +public: + explicit StatsWidget(QWidget *parent = nullptr); + +protected: + void showEvent(QShowEvent *event) override; + +private: + void updateChart(); + + QChart *_chart; + QDateTimeAxis *_dateTimeAxis; + QValueAxis *_valueAxis_activations; + QValueAxis *_valueAxis_cumsum; + +}; diff --git a/src/app/telemetry.cpp b/src/app/telemetry.cpp new file mode 100644 index 0000000..09b7713 --- /dev/null +++ b/src/app/telemetry.cpp @@ -0,0 +1,129 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "telemetry.h" + +namespace { +const QString config_key = "telemetry"; +} + +Core::Telemetry::Telemetry() +{ + QObject::connect(&timer_, &QTimer::timeout, [this]{trySendReport();}); + + QSettings settings(qApp->applicationName()); + if ( !settings.contains(config_key) ) { + QMessageBox mb(QMessageBox::Question, "Albert telemetry", + "Albert collects anonymous data to improve user " + "experience and plot nice charts (upcoming feature). " + "Further a high usercount helps me to stay motivated " + "working on albert. ;)\n\nYou can check the data " + "sent in the details.\n\nDo you want to send " + "telemetry data?", + QMessageBox::No|QMessageBox::Yes); + mb.setDefaultButton(QMessageBox::Yes); + mb.setDetailedText(QJsonDocument(buildReport()).toJson(QJsonDocument::Indented)); + settings.setValue(config_key, mb.exec() == QMessageBox::Yes); + } + enable(settings.value(config_key).toBool()); +} + +void Core::Telemetry::enable(bool enable) +{ + if (enable) { + trySendReport(); + timer_.start(60000); + } + else { + timer_.stop(); + } + QSettings(qApp->applicationName()).setValue(config_key, enable); +} + +bool Core::Telemetry::isEnabled() const +{ + return QSettings(qApp->applicationName()).value(config_key).toBool(); +} + +void Core::Telemetry::trySendReport() +{ + + QSqlQuery q(QSqlDatabase::database()); + + // Get timestamp of last report + if (!q.exec("SELECT value FROM conf WHERE key=\"last_report\"; ")) + qFatal("Unable to get last_report from conf: %s", q.lastError().text().toUtf8().constData()); + int64_t last_report = 0; + if (q.next()) + last_report = q.value(0).toLongLong(); + + // If not reported today + if (QDateTime::fromMSecsSinceEpoch(last_report*1000).date() != QDate::currentDate()) { + + QJsonObject object = buildReport(); + + QString addr = "Zffb,!!*\" $## $\"' **!"; + for ( auto &c: addr) + c.unicode()=c.unicode()+14; + + static QNetworkAccessManager *manager = new QNetworkAccessManager; + QNetworkRequest request((QUrl(addr))); + request.setHeader(QNetworkRequest::ContentTypeHeader, QString("application/json")); + QNetworkReply* reply = manager->put(request, QJsonDocument(object).toJson(QJsonDocument::Compact)); + QObject::connect(reply, &QNetworkReply::finished, [reply](){ + if (reply->error() == QNetworkReply::NoError){ + qDebug() << "Report sent."; + // Store time of last report + QSqlQuery q(QSqlDatabase::database()); + q.prepare("INSERT OR REPLACE INTO conf VALUES(\"last_report\", :ts); "); + q.bindValue(":ts", static_cast(QDateTime::currentMSecsSinceEpoch()/1000)); + if (!q.exec()) + qFatal("Could not set last_report: %s %s", qPrintable(q.executedQuery()), qPrintable(q.lastError().text())); + } + reply->deleteLater(); + }); + } + +} + +QJsonObject Core::Telemetry::buildReport() +{ + QSqlQuery q(QSqlDatabase::database()); + + // Get timestamp of last report + if (!q.exec("SELECT value FROM conf WHERE key=\"last_report\"; ")) + qFatal("Unable to get last_report from conf: %s", q.lastError().text().toUtf8().constData()); + int64_t last_report = 0; + if (q.next()) + last_report = q.value(0).toLongLong(); + + // Get activations + q.prepare("SELECT count(*) " + "FROM activation a " + "JOIN query q " + "ON a.query_id = q.id " + "WHERE :since < q.timestamp;"); + q.bindValue(":since", static_cast(last_report)); + if (!q.exec()) + qFatal("SQL ERROR: %s %s", qPrintable(q.executedQuery()), qPrintable(q.lastError().text())); + if (!q.next()) + qFatal("Could not compute activations."); + int64_t activations = q.value(0).toLongLong(); + + + QJsonObject object; + object.insert("version", qApp->applicationVersion()); + object.insert("os", QSysInfo::prettyProductName()); + object.insert("os_version", QSysInfo::productVersion()); + object.insert("activations", static_cast(activations)); + return object; +} diff --git a/src/app/telemetry.h b/src/app/telemetry.h new file mode 100644 index 0000000..5b4d796 --- /dev/null +++ b/src/app/telemetry.h @@ -0,0 +1,27 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include + +namespace Core { + +class Telemetry final +{ +public: + + Telemetry(); + + void enable(bool enable); + bool isEnabled() const; + QJsonObject buildReport(); + +private: + + void trySendReport(); + + QTimer timer_; + +}; + +} diff --git a/src/app/trayicon.cpp b/src/app/trayicon.cpp new file mode 100644 index 0000000..c2fcbfa --- /dev/null +++ b/src/app/trayicon.cpp @@ -0,0 +1,26 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include "trayicon.h" +#include "xdg/iconlookup.h" + +namespace { + const char* CFG_SHOWTRAY = "showTray"; + const bool DEF_SHOWTRAY = true; +} + +/** ***************************************************************************/ +Core::TrayIcon::TrayIcon() { + setIcon(QIcon(XDG::IconLookup::iconPath({"albert-tray", "albert"}))); + if (QSettings(qApp->applicationName()).value(CFG_SHOWTRAY, DEF_SHOWTRAY).toBool()) + setVisible(true); +} + + +/** ***************************************************************************/ +void Core::TrayIcon::setVisible(bool enable) { + QSettings(qApp->applicationName()).setValue(CFG_SHOWTRAY, enable); + QSystemTrayIcon::setVisible(enable); + emit stateChanged(enable); +} diff --git a/src/app/trayicon.h b/src/app/trayicon.h new file mode 100644 index 0000000..947fce4 --- /dev/null +++ b/src/app/trayicon.h @@ -0,0 +1,25 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include + +namespace Core { + +class TrayIcon : public QSystemTrayIcon +{ + Q_OBJECT + +public: + + TrayIcon(); + + void setVisible(bool = true); + +signals: + + void stateChanged(bool); +}; + +} diff --git a/src/lib/fuzzysearch.cpp b/src/lib/fuzzysearch.cpp new file mode 100644 index 0000000..147bc20 --- /dev/null +++ b/src/lib/fuzzysearch.cpp @@ -0,0 +1,232 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include "fuzzysearch.h" +#include "indexable.h" +#include "prefixsearch.h" +using std::map; +using std::set; +using std::pair; +using std::shared_ptr; +using std::vector; + +namespace { + +bool checkPrefixEditDistance(const QString &prefix, const QString &str, uint delta) { + uint n = prefix.size() + 1; + uint m = std::min(prefix.size() + delta + 1, static_cast(str.size()) + 1); + + uint* matrix = new uint[n*m]; + + // Initialize left and top row. + for (uint i = 0; i < n; ++i) { matrix[i*m+0] = i; } + for (uint i = 0; i < m; ++i) { matrix[0*m+i] = i; } + + // Now fill the whole matrix. + for (uint i = 1; i < n; ++i) { + for (uint j = 1; j < m; ++j) { + uint dia = matrix[(i-1)*m+j-1] + (prefix[i-1] == str[j-1] ? 0 : 1); + matrix[i*m+j] = std::min(std::min( + dia, + matrix[i*m+j-1] + 1), + matrix[(i-1)*m+j] + 1); + } + } + + // Check the last row if there is an entry <= delta. + bool result = false; + for (uint j = 0; j < m; ++j) { + if (matrix[(n-1)*m+j] <= delta) { + result = true; + break; + } + } + delete[] matrix; + return result; +} + +} + + + +/** ***************************************************************************/ +Core::FuzzySearch::FuzzySearch(uint q, double d) : q_(q), delta_(d) { + +} + + + +/** ***************************************************************************/ +Core::FuzzySearch::FuzzySearch(const Core::PrefixSearch &rhs, uint q, double d) + : PrefixSearch(rhs), q_(q), delta_(d) { + // Iterate over the inverted index and build the qGramindex + for ( const std::pair> &invertedIndexEntry : invertedIndex_ ) { + QString spaced = QString(q_-1,' ').append(invertedIndexEntry.first); + for (uint i = 0 ; i < static_cast(invertedIndexEntry.first.size()); ++i) + ++qGramIndex_[spaced.mid(i,q_)][invertedIndexEntry.first]; + } +} + + + +/** ***************************************************************************/ +Core::FuzzySearch::~FuzzySearch() { + +} + + + +/** ***************************************************************************/ +void Core::FuzzySearch::add(const std::shared_ptr &indexable) { + + // Add indexable to the index + index_.push_back(indexable); + uint id = static_cast(index_.size()-1); + + // Add a mappings to the inverted index which maps on t. + vector indexStrings = indexable->indexStrings(); + for (const auto &idxStr : indexStrings) { + set words = splitString(idxStr.string); + for (const QString &w : words) { + + // Add word to inverted index (map word to item) + this->invertedIndex_[w].insert(id); + + // Build a qGram index (map substring to word) + QString spaced = QString(q_-1,' ').append(w); + for (uint i = 0 ; i < static_cast(w.size()); ++i) + ++qGramIndex_[spaced.mid(i,q_)][w]; //FIXME Currently occurences are not uses + } + } +} + + + +/** ***************************************************************************/ +void Core::FuzzySearch::clear() { + qGramIndex_.clear(); + invertedIndex_.clear(); + index_.clear(); +} + + +/** ***************************************************************************/ +vector > Core::FuzzySearch::search(const QString &query) const { + + // Make words unique, lower and prefixfree + set words = splitString(query); + + // Quit if there are no words in query + if (words.empty()) + return vector>(); + + vector> resultsPerWord; // id, count + for ( const QString &word : words ) { + + uint delta = static_cast((delta_ < 1)? (word.size()-1)*delta_ : delta_); + + // Generate the qGrams of this word + map qGrams; + QString spaced(q_-1,' '); + spaced.append(word); + for ( uint i = 0; i < static_cast(word.size()); ++i ) + ++qGrams[spaced.mid(i,q_)]; + + // Get the words referenced by each qGram and count the references + map wordMatches; + for ( const pair &qGram : qGrams ) { + + // Find the qGram in the index, skip if nothing found + decltype(qGramIndex_)::const_iterator qGramIndexIt = qGramIndex_.find(qGram.first); + if ( qGramIndexIt == qGramIndex_.end() ) + continue; + + // Iterate over the set of words referenced by this qGram + for (const pair &indexEntry : qGramIndexIt->second) { + // CRUCIAL: The match can contain only the commom amount of qGrams + wordMatches[indexEntry.first] += std::min(qGram.second, indexEntry.second); + } + } + + // Unite the items referenced by the words accumulating their #matches + map results; // id, count + for (const pair &wordMatch : wordMatches) { + + /* + * Do some kind of (cheap) preselection by mathematical bound + * If the matched word has less than |word|-δ*q matching qGrams + * it cannot be a match. + * This is because a single error can reduce the common qGram by + * maximum q. δ errors can therefore reduce the common qGrams by + * maximum δ*q. If the common qGrams are less than |word|-δ*q this + * implies that there are more errors than δ. + */ + if (wordMatch.second < (word.size()-delta*q_) ) + continue; + + // Now check the (expensive) prefix edit distance + if (!checkPrefixEditDistance(word, wordMatch.first, delta)) + continue; + + // Checks should not be neccessary since this builds on the index + for(uint id : invertedIndex_.at(wordMatch.first)) { + results[id] += wordMatch.second; + } + } + + resultsPerWord.push_back(std::move(results)); + } + + // Intersect the set of items references by the (referenced) words + // This assusmes that there is at least one word (the query would not have + // been started elsewise) + vector> finalResult; + if (resultsPerWord.size() > 1) { + // Get the smallest list for intersection (performance) + uint smallest=0; + for (uint i = 1; i < static_cast(resultsPerWord.size()); ++i) + if (resultsPerWord[i].size() < resultsPerWord[smallest].size()) + smallest = i; + + bool allResultsContainEntry; + for (map::const_iterator r = resultsPerWord[smallest].begin(); + r != resultsPerWord[smallest].cend(); ++r) { + // Check if all results contain this entry + allResultsContainEntry=true; + uint accMatches = resultsPerWord[smallest][r->first]; + for (uint i = 0; i < static_cast(resultsPerWord.size()); ++i) { + // Ignore itself + if (i==smallest) + continue; + + // If it is in: check next relutlist + if (resultsPerWord[i].find(r->first) != resultsPerWord[i].end() ) { + // Accumulate matches + accMatches += resultsPerWord[i][r->first]; + continue; + } + + allResultsContainEntry = false; + break; + } + + // If this is not common, check the next entry + if (!allResultsContainEntry) + continue; + + // Finally this match is common an can be put into the results + finalResult.emplace_back(r->first, accMatches); + } + } else {// Else do it without intersction + for ( const pair &result : resultsPerWord[0] ) + finalResult.emplace_back(result.first, result.second); + } + + vector> result; + for (const pair &pair : finalResult) { + result.emplace_back(index_.at(pair.first)); + } + return result; +} + + diff --git a/src/lib/fuzzysearch.h b/src/lib/fuzzysearch.h new file mode 100644 index 0000000..911ca6d --- /dev/null +++ b/src/lib/fuzzysearch.h @@ -0,0 +1,38 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include "prefixsearch.h" + +namespace Core { + +class FuzzySearch final : public PrefixSearch +{ +public: + + explicit FuzzySearch(uint q = 3, double d = 1.0/3); + explicit FuzzySearch(const PrefixSearch& rhs, uint q = 3, double d = 1.0/3); + ~FuzzySearch(); + + void add(const std::shared_ptr &idxble) override; + void clear() override; + std::vector> search(const QString &req) const override; + inline double delta() const {return delta_;} + inline void setDelta(double d){delta_=d;} + +private: + + // Map of qGrams, containing their word references and #occurences + std::map> qGramIndex_; + + // Size of the slices + uint q_; + + // Maximum error + double delta_; +}; + +} diff --git a/src/lib/history.cpp b/src/lib/history.cpp new file mode 100644 index 0000000..4cc691a --- /dev/null +++ b/src/lib/history.cpp @@ -0,0 +1,63 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include "history.h" + + +Core::History::History(QObject *parent) : QObject(parent) { + QSqlQuery query("SELECT input " + "FROM activation a JOIN query q ON a.query_id = q.id " + "GROUP BY input " + "ORDER BY max(timestamp) DESC;"); + while (query.next()) + lines_.append(query.value(0).toString()); + + currentLine_ = -1; // This means historymode is not active +} + + +/** ***************************************************************************/ +void Core::History::add(QString str) { + if (!str.isEmpty()){ + if (lines_.contains(str)) + lines_.removeAll(str); // Remove dups + lines_.prepend(str); + } + resetIterator(); +} + + +/** ***************************************************************************/ +QString Core::History::next(const QString &substring) { + int newCurrentLine = currentLine_; + while (++newCurrentLine < static_cast(lines_.size())){ + const QString &line = lines_[newCurrentLine]; + if (line.contains(substring, Qt::CaseInsensitive)){ + currentLine_ = newCurrentLine; + return line; + } + } + return QString{}; +} + + +/** ***************************************************************************/ +QString Core::History::prev(const QString &substring) { + int newCurrentLine = currentLine_; + while (-1 < --newCurrentLine){ + const QString &line = lines_[newCurrentLine]; + if (line.contains(substring, Qt::CaseInsensitive)){ + currentLine_ = newCurrentLine; + return line; + } + } + return QString{}; +} + + +/** ***************************************************************************/ +void Core::History::resetIterator() { + currentLine_ = -1; +} diff --git a/src/lib/offlineindex.cpp b/src/lib/offlineindex.cpp new file mode 100644 index 0000000..265497b --- /dev/null +++ b/src/lib/offlineindex.cpp @@ -0,0 +1,86 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "albert/util/offlineindex.h" +#include "albert/indexable.h" +#include "prefixsearch.h" +#include "fuzzysearch.h" + + +/** ***************************************************************************/ +Core::OfflineIndex::OfflineIndex(bool fuzzy) + : impl_((fuzzy) ? new FuzzySearch() : new PrefixSearch()){ +} + + +/** ***************************************************************************/ +Core::OfflineIndex::OfflineIndex(OfflineIndex &&other) { + impl_ = std::move(other.impl_); +} + + +/** ***************************************************************************/ +Core::OfflineIndex &Core::OfflineIndex::operator=(Core::OfflineIndex &&other) { + impl_ = std::move(other.impl_); + return *this; +} + + +/** ***************************************************************************/ +Core::OfflineIndex::~OfflineIndex() { + +} + + +/** ***************************************************************************/ +void Core::OfflineIndex::setFuzzy(bool fuzzy) { + if (dynamic_cast(impl_.get())) { + if (fuzzy) return; + impl_.reset(new PrefixSearch(*dynamic_cast(impl_.get()))); + } else if (dynamic_cast(impl_.get())) { + if (!fuzzy) return; + impl_.reset(new FuzzySearch(*dynamic_cast(impl_.get()))); + } else { + throw; //should not happen + } +} + + +/** ***************************************************************************/ +bool Core::OfflineIndex::fuzzy() { + return dynamic_cast(impl_.get()) != nullptr; +} + + +/** ***************************************************************************/ +void Core::OfflineIndex::setDelta(double d) { + FuzzySearch* f = dynamic_cast(impl_.get()); + if (f) + f->setDelta(d); +} + + +/** ***************************************************************************/ +double Core::OfflineIndex::delta() { + FuzzySearch* f = dynamic_cast(impl_.get()); + if (f) + return f->delta(); + return 0; +} + + +/** ***************************************************************************/ +void Core::OfflineIndex::add(const std::shared_ptr &idxble) { + impl_->add(idxble); +} + + +/** ***************************************************************************/ +void Core::OfflineIndex::clear() { + impl_->clear(); +} + + +/** ***************************************************************************/ +std::vector > Core::OfflineIndex::search(const QString &req) const { + return impl_->search(req); +} diff --git a/src/lib/plugin.cpp b/src/lib/plugin.cpp new file mode 100644 index 0000000..7f679f4 --- /dev/null +++ b/src/lib/plugin.cpp @@ -0,0 +1,92 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include "albert/plugin.h" + +class Core::PluginPrivate +{ +public: + QString id; + std::unique_ptr settings; +}; + +Core::Plugin::Plugin(const QString &id) : d(new PluginPrivate) +{ + d->id = id; + d->settings.reset(new QSettings(qApp->applicationName())); + d->settings->beginGroup(d->id); + + +// // Create a settings instance +// d->settings.reset(new QSettings(configLocation().filePath("config"), +// QSettings::Format::IniFormat)); + +// // Define a function to port the config from one settings to another +// std::function portRecursively = +// [&portRecursively](QSettings &from, QSettings &to){ + +// for ( const QString & key : from.childKeys() ) { +// to.setValue(key, from.value(key)); +// from.remove(key); +// } + +// for ( const QString & group : from.childGroups() ){ +// from.beginGroup(group); +// to.beginGroup(group); +// portRecursively(from, to); +// to.endGroup(); +// from.endGroup(); +// } +// }; + +// // Port the settings from the global settings to the new one +// QSettings oldSettings(qApp->applicationName()); +// oldSettings.beginGroup(d->id); +// portRecursively(oldSettings, *d->settings); + + +} + +Core::Plugin::~Plugin() +{ + +} + +const QString &Core::Plugin::id() const +{ + return d->id; +} + +QDir Core::Plugin::cacheLocation() const +{ + QDir cacheDir(QStandardPaths::writableLocation(QStandardPaths::CacheLocation)); + if ( !cacheDir.exists(d->id) ) + cacheDir.mkdir(d->id); + cacheDir.cd(d->id); + return cacheDir; +} + +QDir Core::Plugin::configLocation() const +{ + QDir configDir(QStandardPaths::writableLocation(QStandardPaths::AppConfigLocation)); + if ( !configDir.exists(d->id) ) + configDir.mkdir(d->id); + configDir.cd(d->id); + return configDir; +} + +QDir Core::Plugin::dataLocation() const +{ + QDir dataDir(QStandardPaths::writableLocation(QStandardPaths::AppDataLocation)); + if ( !dataDir.exists(d->id) ) + dataDir.mkdir(d->id); + dataDir.cd(d->id); + return dataDir; +} + +QSettings &Core::Plugin::settings() const +{ + + return *d->settings; +} diff --git a/src/lib/prefixsearch.cpp b/src/lib/prefixsearch.cpp new file mode 100644 index 0000000..3e66795 --- /dev/null +++ b/src/lib/prefixsearch.cpp @@ -0,0 +1,102 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include "indexable.h" +#include "prefixsearch.h" +using std::map; +using std::set; +using std::shared_ptr; +using std::vector; + + + +/** ***************************************************************************/ +Core::PrefixSearch::PrefixSearch(){ + +} + + +/** ***************************************************************************/ +Core::PrefixSearch::PrefixSearch(const Core::PrefixSearch &rhs) { + index_ = rhs.index_; + invertedIndex_ = rhs.invertedIndex_; +} + + +/** ***************************************************************************/ +Core::PrefixSearch::~PrefixSearch(){} + + +/** ***************************************************************************/ +void Core::PrefixSearch::add(const std::shared_ptr &indexable) { + + // Add indexable to the index + index_.push_back(indexable); + uint id = static_cast(index_.size()-1); + + vector indexStrings = indexable->indexStrings(); + for (const auto &idxStr : indexStrings) { + // Build an inverted index + QStringList words = idxStr.string.split(QRegularExpression(SEPARATOR_REGEX), QString::SkipEmptyParts); + for (const QString &w : words) { + invertedIndex_[w.toLower()].insert(id); + } + } +} + + +/** ***************************************************************************/ +void Core::PrefixSearch::clear() { + invertedIndex_.clear(); + index_.clear(); +} + + +/** ***************************************************************************/ +vector > Core::PrefixSearch::search(const QString &query) const { + + // Make words unique, lower and prefixfree + set words = splitString(query); + + // Skip if there arent any // CONSTRAINT (2): |W| > 0 + if (words.empty()) + return vector>(); + + set resultsSet; + set::iterator wordIt = words.begin(); + + // Get a word mapping once before going to handle intersections + for (std::map>::const_iterator lb = invertedIndex_.lower_bound(*wordIt); + lb != invertedIndex_.cend() && lb->first.startsWith(*wordIt); ++lb) + resultsSet.insert(lb->second.begin(), lb->second.end()); + wordIt++; + + for (;wordIt != words.end(); ++wordIt) { + + // Unite the sets that are mapped by words that begin with word + // w ∈ W. This set is called U_w + set wordMappingsUnion; + for (std::map>::const_iterator lb = invertedIndex_.lower_bound(*wordIt); + lb != invertedIndex_.cend() && lb->first.startsWith(*wordIt); ++lb) + wordMappingsUnion.insert(lb->second.begin(), lb->second.end()); + + // Intersect all sets U_w with the results + set intersection; + std::set_intersection(resultsSet.begin(), resultsSet.end(), + wordMappingsUnion.begin(), wordMappingsUnion.end(), + std::inserter(intersection, intersection.begin())); + + // Break if intersection is empty + if (intersection.empty()) + return vector>(); + + resultsSet = std::move(intersection); + } + + // Convert to a std::vector + vector> resultsVector; + for (uint id : resultsSet) + resultsVector.emplace_back(index_.at(id)); + return resultsVector; +} diff --git a/src/lib/prefixsearch.h b/src/lib/prefixsearch.h new file mode 100644 index 0000000..400810e --- /dev/null +++ b/src/lib/prefixsearch.h @@ -0,0 +1,111 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include +#include "searchbase.h" + +namespace Core { + +class IndexableItem; + +class PrefixSearch : public SearchBase +{ +public: + + PrefixSearch(); + PrefixSearch(const PrefixSearch &rhs); + ~PrefixSearch(); + + void add(const std::shared_ptr &idxble) override; + void clear() override; + std::vector> search(const QString &req) const override; + +protected: + + std::vector> index_; + std::map> invertedIndex_; +}; + + + + + + + + + + + + + + + + + + + + + + + + +// class CaseInsensitiveCompare; +// class CaseInsensitiveComparePrefix; + +//template +//struct PrefixSearch::CaseInsensitiveCompare +//{ +// inline bool operator()( Posting const &lhs, Posting const &rhs ) const { +// return (*this)(lhs.first, rhs.first); +// } + +// inline bool operator()( QString const &lhs, Posting const &rhs ) const { +// return (*this)(lhs, rhs.first); +// } + +// inline bool operator()( Posting const &lhs, QString const &rhs ) const { +// return (*this)(lhs.first, rhs); +// } + +// inline bool operator()( QString const &lhs, QString const &rhs ) const { +// return lhs.compare(rhs, Qt::CaseInsensitive)<0; +// } +//}; + +///** ***************************************************************************/ +//template +//struct PrefixSearch::CaseInsensitiveComparePrefix +//{ +// inline bool operator()( Posting const &pre, Posting const &rhs ) const { +// return (*this)(pre.first, rhs.first); +// } + +// inline bool operator()( QString const &pre, Posting const &rhs ) const { +// return (*this)(pre, rhs.first); +// } + +// inline bool operator()( Posting const &pre, QString const &rhs ) const { +// return (*this)(pre.first, rhs); +// } + +// inline bool operator()( QString const& pre, QString const& rhs ) const { +// QString::const_iterator a,b; +// a = pre.cbegin(); +// b = rhs.cbegin(); +// QChar ca,cb; +// while (a != pre.cend() && b != rhs.cend()) { +// ca = a++->toLower(); +// cb = b++->toLower(); +// if (ca < cb) +// return true; +// if (ca > cb) +// return false; +// } +// return false; +// } +//}; + +} diff --git a/src/lib/searchbase.cpp b/src/lib/searchbase.cpp new file mode 100644 index 0000000..a4d5f83 --- /dev/null +++ b/src/lib/searchbase.cpp @@ -0,0 +1,31 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include +#include +#include +#include "searchbase.h" +using std::set; + +Core::SearchBase::~SearchBase() { + +} + +std::set Core::SearchBase::splitString(const QString &str) const { + + // Split the query into words W + QStringList wordlist = str.toLower().split(QRegularExpression(SEPARATOR_REGEX), QString::SkipEmptyParts); + + // Make words unique + set words(wordlist.begin(), wordlist.end()); + + // Drop all words that are prefixes of others (since this an ordered set the next word) + for (auto it = words.begin(); it != words.end();) { + auto next = std::next(it); + if ( next != words.end() && next->startsWith(*it) ) + it = words.erase(it); + else + ++it; + } + + return words; +} diff --git a/src/lib/searchbase.h b/src/lib/searchbase.h new file mode 100644 index 0000000..6c07b23 --- /dev/null +++ b/src/lib/searchbase.h @@ -0,0 +1,30 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#pragma once +#include +#include +#include +#include + +namespace Core { + +class IndexableItem; + +class SearchBase +{ +public: + + virtual ~SearchBase(); + virtual void add(const std::shared_ptr &idxble) = 0; + virtual void clear() = 0; + virtual std::vector> search(const QString &req) const = 0; + +protected: + + std::set splitString(const QString &) const; + + static constexpr const char* SEPARATOR_REGEX = "[!?<>\"'=+*.:,;\\\\\\/ _\\-]+"; + +}; + +} diff --git a/src/lib/shutil.cpp b/src/lib/shutil.cpp new file mode 100644 index 0000000..1fe3534 --- /dev/null +++ b/src/lib/shutil.cpp @@ -0,0 +1,114 @@ +// Copyright (C) 2014-2018 Manuel Schneider + +#include "shutil.h" +#include + + +/******************************************************************************/ +QString Core::ShUtil::quote(QString input) { + return QString("'%1'").arg(input.replace(R"(')", R"('"'"')")); +} + + +/******************************************************************************/ +QStringList Core::ShUtil::split(const QString &input) { + + QString part; + QStringList result; + QString::const_iterator it = input.begin(); + + while(it != input.end()){ + + // Check for a backslash (escape) + if (*it == '\\'){ + if (++it == input.end()){ + qWarning() << "EOL detected. Excpected one of {\",`,\\,$, ,\\n,\\t,',<,>,~,|,&,;,*,?,#,(,)}"; + return QStringList(); + } + + switch (it->toLatin1()) { + case 'n': part.push_back('\n'); + break; + case 't': part.push_back('\t'); + break; + case ' ': + case '\'': + case '<': + case '>': + case '~': + case '|': + case '&': + case ';': + case '*': + case '?': + case '#': + case '(': + case ')': + case '"': + case '`': + case '\\': + case '$': part.push_back(*it); + break; + default: + qWarning() << "Invalid char following \\. Excpected one of {\",`,\\,$, ,\\n,\\t,',<,>,~,|,&,;,*,?,#,(,)}"; + return QStringList(); + } + } + + // Check for quoted strings + else if (*it == '"'){ + while (true){ + if (++it == input.end()){ + qWarning() << "Detected EOL inside a qoute."; + return QStringList(); + } + + // Leave the "quotation loop" on double qoute + else if (*it == '"') + break; + + // Check for a backslash (escape) + else if (*it == '\\'){ + if (++it == input.end()){ + qWarning() << "EOL detected. Excpected one of {\",`,\\,$}"; + return QStringList(); + } + + switch (it->toLatin1()) { + case '"': + case '`': + case '\\': + case '$': part.push_back(*it); + break; + default: + qWarning() << "Invalid char following \\. Excpected one of {\",`,\\,$}"; + return QStringList(); + } + } + + // Accept everything else + else { + part.push_back(*it); + } + } + } + + // Check for spaces (separators) + else if (*it == ' '){ + result.push_back(part); + part.clear(); + } + + // Rest of input alphabet, save and continue + else { + part.push_back(*it); + } + + ++it; + } + + if (!part.isEmpty()) + result.push_back(part); + + return result; +} diff --git a/src/lib/standardactions.cpp b/src/lib/standardactions.cpp new file mode 100644 index 0000000..7be4bd8 --- /dev/null +++ b/src/lib/standardactions.cpp @@ -0,0 +1,125 @@ +// Copyright (C) 2014-2019 Manuel Schneider + +#include +#include +#include +#include +#include +#include +#include +#include "albert/util/shutil.h" +#include "standardactions.h" + +// Place it somewhere for now. TODO: move it to potential core plugin +EXPORT_CORE QString terminalCommand; + +/** **************************************************************************/ +Core::StandardActionBase::StandardActionBase(const QString &text) + : text_(std::move(text)) +{ + +} + +QString Core::StandardActionBase::text() const +{ + return text_; +} + + +/** **************************************************************************/ +Core::FuncAction::FuncAction(const QString &text, std::function action) + : StandardActionBase(text), action_(std::move(action)) +{ + +} + +void Core::FuncAction::activate() +{ + action_(); +} + + +/** **************************************************************************/ +Core::ClipAction::ClipAction(const QString &text, QString clipBoardText) + : StandardActionBase(text), clipBoardText_(std::move(clipBoardText)) +{ + +} + +void Core::ClipAction::activate() +{ + QGuiApplication::clipboard()->setText(clipBoardText_); +} + + +/** **************************************************************************/ +Core::UrlAction::UrlAction(const QString &text, QUrl url) + : StandardActionBase(text), url_(std::move(url)) +{ + +} + +void Core::UrlAction::activate() +{ + QDesktopServices::openUrl(url_); +} + + +/** **************************************************************************/ +Core::ProcAction::ProcAction(const QString &text, const QStringList &commandline, const QString &workingDirectory) + : StandardActionBase(text), commandline_(commandline), workingDir_(workingDirectory) +{ + +} + +void Core::ProcAction::activate() +{ + if (commandline_.isEmpty()) + return; + + QStringList commandline = commandline_; + if (workingDir_.isEmpty()) + QProcess::startDetached(commandline.takeFirst(), commandline); + else + QProcess::startDetached(commandline.takeFirst(), commandline, workingDir_); +} + + +/** **************************************************************************/ +Core::TermAction::TermAction(const QString &text, const QStringList &commandline, const QString &workingDirectory, bool shell, Core::TermAction::CloseBehavior behavior) + : ProcAction (text, commandline, workingDirectory), shell_(shell), behavior_(behavior) +{ + +} + +void Core::TermAction::activate() +{ + if (commandline_.isEmpty()) + return; + + if (shell_){ + + // Quote the input commandline since it's nested + QStringList quotedCommandLine; + for (const QString &strRef : commandline_) + quotedCommandLine << ShUtil::quote(strRef); + + // Get the user shell (passwd must not be freed) + passwd *pwd = getpwuid(geteuid()); + if (pwd == nullptr) + throw "Could not retrieve user shell"; + + // Let standard shell handle flow control (syntax differs in shells, e.g. fish) + commandline_ = Core::ShUtil::split(terminalCommand); + if (behavior_ == CloseBehavior::DoNotClose) + commandline_ << "sh" << "-ic" << QString("%1 -ic '%2'; exec %1").arg(pwd->pw_shell, quotedCommandLine.join(' ')); + else if (behavior_ == CloseBehavior::CloseOnSuccess) + commandline_ << "sh" << "-ic" << QString("%1 -ic '%2' && sleep 1 || exec %1").arg(pwd->pw_shell, quotedCommandLine.join(' ')); + else // behavior_ == CloseBehavior::CloseOnExit + commandline_ << "sh" << "-ic" << QString("%1 -ic '%2'; sleep 1 ").arg(pwd->pw_shell, quotedCommandLine.join(' ')); + } else { + commandline_ = Core::ShUtil::split(terminalCommand) + commandline_; + } + + ProcAction::activate(); +} diff --git a/src/lib/standardindexitem.cpp b/src/lib/standardindexitem.cpp new file mode 100644 index 0000000..5921e56 --- /dev/null +++ b/src/lib/standardindexitem.cpp @@ -0,0 +1,47 @@ +// Copyright (C) 2018-2019 Manuel Schneider + +#include "standardindexitem.h" + +Core::StandardIndexItem::StandardIndexItem(QString id, QString iconPath, QString text, QString subtext, QString completion, Core::Item::Urgency urgency, std::vector > actions, std::vector indexStrings) + : id_(std::move(id)), + iconPath_(std::move(iconPath)), + text_(std::move(text)), + subtext_(std::move(subtext)), + completion_(std::move(completion)), + urgency_(urgency), + actions_(std::move(actions)), + indexStrings_(std::move(indexStrings)) { } + +QString Core::StandardIndexItem::id() const { return id_; } + +void Core::StandardIndexItem::setId(QString id) { id_ = std::move(id); } + +QString Core::StandardIndexItem::iconPath() const { return iconPath_; } + +void Core::StandardIndexItem::setIconPath(QString iconPath) { iconPath_ = std::move(iconPath); } + +QString Core::StandardIndexItem::text() const { return text_; } + +void Core::StandardIndexItem::setText(QString text) { text_ = std::move(text); } + +QString Core::StandardIndexItem::subtext() const { return subtext_; } + +void Core::StandardIndexItem::setSubtext(QString subtext) { subtext_ = std::move(subtext); } + +QString Core::StandardIndexItem::completion() const { return completion_; } + +void Core::StandardIndexItem::setCompletion(QString completion) { completion_ = std::move(completion); } + +Core::Item::Urgency Core::StandardIndexItem::urgency() const { return urgency_; } + +void Core::StandardIndexItem::setUrgency(Core::Item::Urgency urgency) { urgency_ = urgency; } + +std::vector > Core::StandardIndexItem::actions() { return actions_; } + +void Core::StandardIndexItem::setActions(std::vector > actions) { actions_ = std::move(actions); } + +void Core::StandardIndexItem::addAction(std::shared_ptr action) { actions_.push_back(std::move(action)); } + +std::vector Core::StandardIndexItem::indexStrings() const { return indexStrings_; } + +void Core::StandardIndexItem::setIndexKeywords(std::vector indexStrings) { indexStrings_ = std::move(indexStrings); } diff --git a/src/lib/standarditem.cpp b/src/lib/standarditem.cpp new file mode 100644 index 0000000..db8b567 --- /dev/null +++ b/src/lib/standarditem.cpp @@ -0,0 +1,46 @@ +// Copyright (C) 2014-2019 Manuel Schneider + +#include "standarditem.h" + +Core::StandardItem::StandardItem(QString id, QString iconPath, QString text, QString subtext, QString completion, Core::Item::Urgency urgency, std::vector > actions) + : id_(std::move(id)), + iconPath_(std::move(iconPath)), + text_(std::move(text)), + subtext_(std::move(subtext)), + completion_(std::move(completion)), + urgency_(urgency), + actions_(std::move(actions)) { } + +QString Core::StandardItem::id() const { return id_; } + +void Core::StandardItem::setId(QString id) { id_ = std::move(id); } + +QString Core::StandardItem::iconPath() const { return iconPath_; } + +void Core::StandardItem::setIconPath(QString iconPath) { iconPath_ = std::move(iconPath); } + +QString Core::StandardItem::text() const { return text_; } + +void Core::StandardItem::setText(QString text) { text_ = std::move(text); } + +QString Core::StandardItem::subtext() const { return subtext_; } + +void Core::StandardItem::setSubtext(QString subtext) { subtext_ = std::move(subtext); } + +QString Core::StandardItem::completion() const { return completion_; } + +void Core::StandardItem::setCompletion(QString completion) { completion_ = std::move(completion); } + +Core::Item::Urgency Core::StandardItem::urgency() const { return urgency_; } + +void Core::StandardItem::setUrgency(Core::Item::Urgency urgency) { urgency_ = urgency; } + +std::vector > Core::StandardItem::actions() { return actions_; } + +void Core::StandardItem::setActions(std::vector > &&actions) { actions_ = std::move(actions); } + +void Core::StandardItem::setActions(const std::vector > &actions) { actions_ = actions; } + +void Core::StandardItem::addAction(std::shared_ptr &&action) { actions_.push_back(std::move(action)); } + +void Core::StandardItem::addAction(const std::shared_ptr &action) { actions_.push_back(action); }