diff --git a/.gitignore b/.gitignore index 63c1ed0a5..8e8d13adf 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ debian obj-x86_64-linux-gnu +python/.eggs/ +python/dist/ +python/src/notcurses.egg-info/ rust/target diff --git a/README.md b/README.md index c78fb3f9f..1d571dacd 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ for more information, see [my wiki](https://nick-black.com/dankwiki/index.php/No * [Environment notes](#environment-notes) * [DirectColor detection](#DirectColor-detection) * [Fonts](#fonts) + * [FAQs](#faqs) * [Supplemental material](#supplemental-material) * [Useful links](#useful-links) * [Other TUI libraries](#other-tui-libraries-of-note) @@ -52,9 +53,8 @@ notcurses abandons the X/Open Curses API bundled as part of the Single UNIX Specification. The latter shows its age, and seems not capable of making use of terminal functionality such as unindexed 24-bit color ("DirectColor", not to be confused with 8-bit indexed 24-bit color, aka "TrueColor" or (by NCURSES) as -"extended color"). For some necessary -background, consult Thomas E. Dickey's superb and authoritative [NCURSES -FAQ](https://invisible-island.net/ncurses/ncurses.faq.html#xterm_16MegaColors). +"extended color"). For some necessary background, consult Thomas E. Dickey's +superb and authoritative [NCURSES FAQ](https://invisible-island.net/ncurses/ncurses.faq.html#xterm_16MegaColors). As such, notcurses is not a drop-in Curses replacement. It is almost certainly less portable, and definitely tested on less hardware. Sorry about that. Ultimately, I hope to properly support all terminals *supporting the features @@ -136,7 +136,9 @@ Before calling into notcurses—and usually as one of the first calls of the program—be sure to call `setlocale(3)` with an appropriate UTF-8 `LC_ALL` locale. It is usually appropriate to use `setlocale(LC_ALL, "")`, relying on the user to properly set the `LANG` environment variable. notcurses will -refuse to start if `nl_langinfo(3)` doesn't indicate UTF-8. +refuse to start if `nl_langinfo(3)` doesn't indicate UTF-8. In addition, it is +wise to mask most signals early in the program, before any threads are spawned. +(this is particularly critical for `SIGWINCH`). notcurses requires an available `terminfo(5)` definition appropriate for the terminal. It is usually appropriate to pass `NULL` in the `termtype` field of a @@ -2408,9 +2410,18 @@ purposes, makes the detection work quite well **today**. Fonts end up being a whole thing, little of which is pleasant. I'll write this up someday **FIXME**. -### When all else fails... +### FAQs -...fuck wit' it harder, hax0r. +* *Q:* Why didn't you just use Sixel? +* *A:* Many terminal emulators don't support Sixel. Sixel doesn't work well + with mouse selection. With that said, I do intend to support Sixel soon, + as a backend, when available, for certain types of drawing. + +* *Q:* I'm not seeing `NCKEY_RESIZE` until I press some other key. +* *A:* You've almost certainly failed to mask `SIGWINCH` in some thread, and + that thread is receiving the signal instead of the thread which called + `notcurses_getc_blocking()`. As a result, the `poll()` is not + interrupted. Call `pthread_sigmask()` before spawning any threads. ## Supplemental material diff --git a/python/LICENSE.txt b/python/LICENSE.txt new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/python/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/src/demo/demo.c b/src/demo/demo.c index 5946d403f..54d2979eb 100644 --- a/src/demo/demo.c +++ b/src/demo/demo.c @@ -360,6 +360,10 @@ int main(int argc, char** argv){ fprintf(stderr, "Couldn't set locale based on user preferences\n"); return EXIT_FAILURE; } + sigset_t sigmask; + sigemptyset(&sigmask); + sigaddset(&sigmask, SIGWINCH); + pthread_sigmask(SIG_SETMASK, &sigmask, NULL); const char* demos; if((demos = handle_opts(argc, argv, &nopts, &use_hud)) == NULL){ if(argv[optind] != NULL){ diff --git a/src/lib/input.c b/src/lib/input.c index d6eb50bb2..163aeea95 100644 --- a/src/lib/input.c +++ b/src/lib/input.c @@ -13,7 +13,11 @@ static const char32_t NCKEY_CSI = 1; static const unsigned char ESC = 0x1b; // 27 -sig_atomic_t resize_seen = 0; +static sig_atomic_t resize_seen; + +void sigwinch_handler(int signo){ + resize_seen = signo; +} static inline int pop_input_keypress(notcurses* nc){ diff --git a/src/lib/internal.h b/src/lib/internal.h index b7daa86fc..3ca7aca3b 100644 --- a/src/lib/internal.h +++ b/src/lib/internal.h @@ -184,7 +184,7 @@ typedef struct notcurses { struct esctrie* inputescapes; // trie of input escapes -> ncspecial_keys } notcurses; -extern sig_atomic_t resize_seen; +void sigwinch_handler(int signo); // load all known special keys from terminfo, and build the input sequence trie int prep_special_keys(notcurses* nc); diff --git a/src/lib/notcurses.c b/src/lib/notcurses.c index 8710b1bab..6014096a4 100644 --- a/src/lib/notcurses.c +++ b/src/lib/notcurses.c @@ -25,11 +25,6 @@ static notcurses* _Atomic signal_nc = ATOMIC_VAR_INIT(NULL); // ugh static void (*signal_sa_handler)(int); // stashed signal handler we replaced -static void -sigwinch_handler(int signo){ - resize_seen = signo; -} - // this wildly unsafe handler will attempt to restore the screen upon // reception of SIG{INT, SEGV, ABRT, QUIT}. godspeed you, black emperor! static void