[vte/wip/egmont/bidi: 26/76] add test file (doc/bidi.txt)

[Egmont Koblinger <egmontkob src gnome org>]

commit 8137f38e9ffce1de03d3156443e9824a15305691
Author: Egmont Koblinger <egmont gmail com>
Date:   Thu Aug 23 14:04:54 2018 +0200

    add test file (doc/bidi.txt)

 doc/bidi.txt | 165 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 165 insertions(+)
---
diff --git a/doc/bidi.txt b/doc/bidi.txt
new file mode 100644
index 00000000..d8b87ca4
--- /dev/null
+++ b/doc/bidi.txt
@@ -0,0 +1,165 @@
+                 ╔════════════════════════════════════════════╗
+═════════════════╣ BiDi test – should be cat’ed at 80 columns ╠═════════════════
+                 ╚════════════════════════════════════════════╝
+
+In text examples, the subsection title (bold) sometimes shows the wire order,
+transcribed to English (“Shalom” abbreviated to occupy the same width).
+This is followed by the reference rendering, using similar LTR glyphs.
+Finally the actual rendering which should match the line above.
+
+All words, except for subsection titles under explicit modes, should show up
+in human readable order.
+
+Boxes should all show up nicely.
+
+                                ┌──────────────┐
+────────────────────────────────┤ Implicit LTR ├────────────────────────────────
+                                └──────────────┘
+⸤Hello⸣ ⸤Shlm⸣
+⸤Hello⸣ ⸤oi7w⸣
+⸤Hello⸣ ⸤שָׁלוֹם⸣
+
+Hello1 ⸤Hello2⸣ Hello3 Shlm1 ⸤Shlm2⸣ Shlm3
+Hello1 ⸤Hello2⸣ Hello3 3oi7w ⸢2oi7w⸥ 1oi7w
+Hello1 ⸤Hello2⸣ Hello3 שָׁלוֹם1 ⸤שָׁלוֹם2⸣ שָׁלוֹם3
+
+⸤Shlm⸣ ⸤Hello⸣
+⸤oi7w⸣ ⸤Hello⸣
+⸤שָׁלוֹם⸣ ⸤Hello⸣
+
+Shlm1 ⸤Shlm2⸣ Shlm3 Hello1 ⸤Hello2⸣ Hello3
+3oi7w ⸢2oi7w⸥ 1oi7w Hello1 ⸤Hello2⸣ Hello3
+שָׁלוֹם1 ⸤שָׁלוֹם2⸣ שָׁלוֹם3 Hello1 ⸤Hello2⸣ Hello3
+
+Paragraph wrapping at foreign word
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor w
+oi7 incididunt ut labore et dolore magna aliqua.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor שָׁלוֹם incididunt ut labore 
et dolore magna aliqua.
+
+Box
+┏━┓╔═╗┌─┐╭─╮
+┗━┛╚═╝└─┘╰─╯
+
+Box in mirrored mode
+[?2500h┏━┓╔═╗┌─┐╭─╮
+┗━┛╚═╝└─┘╰─╯[?2500l
+
+                                ┌──────────────┐
+────────────────────────────────┤ Implicit RTL ├────────────────────────────────
+                                └──────────────┘
+⸤Hello⸣ ⸤Shlm⸣
+                                                                  ⸢oi7w⸥ ⸢Hello⸥
+[3 S⸤Hello⸣ ⸤שָׁלוֹם⸣[0 S
+
+Hello1 ⸤Hello2⸣ Hello3 Shlm1 ⸤Shlm2⸣ Shlm3
+                                      3oi7w ⸢2oi7w⸥ 1oi7w Hello1 ⸤Hello2⸣ Hello3
+[3 SHello1 ⸤Hello2⸣ Hello3 שָׁלוֹם1 ⸤שָׁלוֹם2⸣ שָׁלוֹם3[0 S
+
+⸤Shlm⸣ ⸤Hello⸣
+                                                                  ⸢Hello⸥ ⸢oi7w⸥
+[3 S⸤שָׁלוֹם⸣ ⸤Hello⸣[0 S
+
+Shlm1 ⸤Shlm2⸣ Shlm3 Hello1 ⸤Hello2⸣ Hello3
+                                      Hello1 ⸤Hello2⸣ Hello3 3oi7w ⸢2oi7w⸥ 1oi7w
+[3 Sשָׁלוֹם1 ⸤שָׁלוֹם2⸣ שָׁלוֹם3 Hello1 ⸤Hello2⸣ Hello3[0 S
+
+Paragraph with wrong direction (should look broken)
+w Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+                                .incididunt ut labore et dolore magna aliqua oi7
+[3 SLorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor שָׁלוֹם incididunt ut 
labore et dolore magna aliqua.[0 S
+
+Box
+[3 S┓━┏╗═╔┐─┌╮─╭
+┛━┗╝═╚┘─└╯─╰[0 S
+
+Box in mirrored mode
+[3 S[?2500h┏━┓╔═╗┌─┐╭─╮
+┗━┛╚═╝└─┘╰─╯[?2500l[0 S
+
+                        ┌──────────────────────────────┐
+────────────────────────┤ Implicit auto (LTR fallback) ├────────────────────────
+                        └──────────────────────────────┘
+⸤Hello⸣ ⸤Shlm⸣
+⸤Hello⸣ ⸤oi7w⸣
+[?2501h⸤Hello⸣ ⸤שָׁלוֹם⸣[?2501l
+
+⸤Shlm⸣ ⸤Hello⸣
+                                                                  ⸢Hello⸥ ⸢oi7w⸥
+[?2501h⸤שָׁלוֹם⸣ ⸤Hello⸣[?2501l
+
+Paragraph wrapping at foreign word
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor w
+oi7 incididunt ut labore et dolore magna aliqua.
+[?2501hLorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor שָׁלוֹם incididunt ut 
labore et dolore magna aliqua.[?2501l
+
+Box
+[?2501h┏━┓╔═╗┌─┐╭─╮
+┗━┛╚═╝└─┘╰─╯[?2501l
+
+Box in mirrored mode
+[?2501h[?2500h┏━┓╔═╗┌─┐╭─╮
+┗━┛╚═╝└─┘╰─╯[?2500l[?2501l
+
+                        ┌──────────────────────────────┐
+────────────────────────┤ Implicit auto (RTL fallback) ├────────────────────────
+                        └──────────────────────────────┘
+⸤Hello⸣ ⸤Shlm⸣
+⸤Hello⸣ ⸤oi7w⸣
+[3 S[?2501h⸤Hello⸣ ⸤שָׁלוֹם⸣[?2501l[0 S
+
+⸤Shlm⸣ ⸤Hello⸣
+                                                                  ⸢Hello⸥ ⸢oi7w⸥
+[3 S[?2501h⸤שָׁלוֹם⸣ ⸤Hello⸣[?2501l[0 S
+
+Paragraph wrapping at foreign word
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor w
+oi7 incididunt ut labore et dolore magna aliqua.
+[3 S[?2501hLorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor שָׁלוֹם 
incididunt ut labore et dolore magna aliqua.[?2501l[0 S
+
+Box
+[3 S[?2501h┓━┏╗═╔┐─┌╮─╭
+┛━┗╝═╚┘─└╯─╰[?2501l[0 S
+
+Box in mirrored mode
+[3 S[?2501h[?2500h┏━┓╔═╗┌─┐╭─╮
+┗━┛╚═╝└─┘╰─╯[?2500l[?2501l[0 S
+
+                                ┌──────────────┐
+────────────────────────────────┤ Explicit LTR ├────────────────────────────────
+                                └──────────────┘
+⸤Hello⸣ ⸤mlhS⸣
+⸤Hello⸣ ⸤oi7w⸣
+⸤Hello⸣ ⸤םוֹלשָׁ⸣
+
+⸤mlhS⸣ ⸤Hello⸣
+⸤oi7w⸣ ⸤Hello⸣
+⸤םוֹלשָׁ⸣ ⸤Hello⸣
+
+Box
+┏━┓╔═╗┌─┐╭─╮
+┗━┛╚═╝└─┘╰─╯
+
+Box in mirrored mode
+[?2500h┏━┓╔═╗┌─┐╭─╮
+┗━┛╚═╝└─┘╰─╯[?2500l
+
+                                ┌──────────────┐
+────────────────────────────────┤ Explicit RTL ├────────────────────────────────
+                                └──────────────┘
+⸤olleH⸣ ⸤Shlm⸣
+                                                                  ⸢oi7w⸥ ⸢Hello⸥
+[3 S⸤olleH⸣ ⸤שָׁלוֹם⸣[0 S
+
+⸤Shlm⸣ ⸤olleH⸣
+                                                                  ⸢Hello⸥ ⸢oi7w⸥
+[3 S⸤שָׁלוֹם⸣ ⸤olleH⸣[0 S
+
+Box
+[3 S┓━┏╗═╔┐─┌╮─╭
+┛━┗╝═╚┘─└╯─╰[0 S
+
+Box in mirrored mode
+[3 S[?2500h┏━┓╔═╗┌─┐╭─╮
+┗━┛╚═╝└─┘╰─╯[?2500l[0 S
+
+────────────────────────────────────────────────────────────────────────────────