[vte/wip/egmont/bidi: 12/13] [add BIDI-STATUS temporary file, not to be committed]

[Egmont Koblinger <egmontkob src gnome org>]

commit d049191c92b98db7566f51d6eb1fbceeb4cb7eff
Author: Egmont Koblinger <egmont gmail com>
Date:   Fri Jun 7 22:17:58 2019 +0200

    [add BIDI-STATUS temporary file, not to be committed]

 BIDI-STATUS | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
---
diff --git a/BIDI-STATUS b/BIDI-STATUS
new file mode 100644
index 00000000..c79cf04a
--- /dev/null
+++ b/BIDI-STATUS
@@ -0,0 +1,56 @@
+Done:
+- Implicit (level 1) and Explicit (a small subset only) modes (SM / RM 8).
+- Overall LTR or RTL direction (SCP 1 / 2 or SPD 0 / 3).
+- Possibility to autodetect paragraph direction (DECSET / DECRST 2501).
+- Possibility to make box drawing characters mirrorable (DECSET / DECRST 2500).
+- I-Beam cursor shows the character's resolved directionality when the
+  paragraph has a foreign directionality character.
+- Mouse highlighting, text copying (logical in normal modes, visual in
+  rectangle mode).
+- Mouse reporting.
+- Regex match and explicit hyperlink underlining on hover.
+- VTE_DEBUG=bidi highlights characters with resolved RTL directionality.
+- Arabic shaping using Unicode presentation forms.
+- Erase in Display, Scroll escape sequences turn some lines to hard wrapped.
+- Test file.
+- Configure flag.
+- Keyboard arrow swapping.
+
+Bugs:
+- SPD should also update all the onscreen lines – really?
+- Or should we drop SPD?
+
+Missing from first release:
+- Code cleanup and review, of course.
+
+Planned future improvements:
+- Real shaping (harfbuzz?).
+- Right-align RTL glyphs.
+- Implicit mode level 2 (handling BiDi control characters).
+- Mirror the glyphs that don't have mirrored counterpart.
+- Play with other possibilities for placing the cursor (especially when it's
+  at the end of the logical line).
+- Play with better placement of the preedit box.
+- Remember some lines that are no longer user-accessible as they scroll out,
+  to properly BiDi the still remaining part of that paragraph.
+- Possibility for default RTL directionality?
+- API (for what exactly)?
+
+Not planned at all:
+- Operating on the presentation component (DCSM reset).
+- BiDi in explicit mode by transferring the embedding levels (SDS, SRS...).
+- Escape sequences that modify the emulation behavior (SIMD...).
+
+Useful aliases:
+  alias ltr='printf "\e[1 k"'
+  alias rtl='printf "\e[2 k"'
+  alias implicit='printf "\e[8h"'
+  alias explicit='printf "\e[8l"'
+  alias bidi='printf "\e[8h"'    # same as implicit
+  alias nobidi='printf "\e[8l"'  # same as explicit
+  alias box-mirror='printf "\e[?2500h"'
+  alias box-normal='printf "\e[?2500l"'
+  alias auto='printf "\e[?2501h"'
+  alias noauto='printf "\e[?2501l"'
+  alias kbdswap='printf "\e[?1243h"'
+  alias nokbdswap='printf "\e[?1243l"'