initial move to base repo

addons/xterm-addon-image/fixture/endless.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# sixel endless mode
+# Should print an endless sine curve, abort with Ctrl-C.
+
+period=200
+amplitude=50
+
+sixels=(@\$ A\$ C\$ G\$ O\$ _\$-)
+pi=$(echo "scale=10; 4*a(1)" | bc -l)
+run=true
+trap run=false INT
+
+echo -ne "\x1bP0;0;0q\"1;1#1;2;100;0;0#1"
+y=0
+while $run
+do
+  x=$(echo "s(2*${pi}*${y}/${period})*${amplitude}+2*${amplitude}+0.5" | bc -l)
+  echo -ne "!${x%%.*}?${sixels[$((y%6))]}"
+  (( y++ ))
+done
+echo -e "\x1b\\"

addons/xterm-addon-image/fixture/gcrglf.sh

@@ -0,0 +1,52 @@
+#!/bin/bash
+
+# GLF should move the text cursor downwards,
+# even if no pixels were modified,
+# when sixel scrolling is on.
+
+echo -n $'\e[?80l'		# Ensure sixel scrolling is on (disable DECSDM)
+
+clear
+echo "A test of Sixel GLF (Graphics Line Feed) when sixel scrolling is on"
+echo
+
+# Move cursor down three using GLF ("-")
+echo -e '\x1bPq$-$-$-$-\x1b\\'
+
+# Show a single sixel line that says, "Your terminal ->"
+cat <<'EOF'
+P0;0;0q"1;1;244;21#0;2;0;0;0#1;2;80;80;80#0~~~NFFFN~~~n!4FN!68~NFN!64~bbb!42~rbbbBB!41~$#1???owwwo???O!4wo!68?owo!64?[[[!42?K[[[{{-#0!5~{woBFB`o{}!4~NFBpp!4xpbBF~~~x@@@~~~xxp@@!5~xxp@@b`pxwxpz!17~zpp???!5px!5~NFBpxxwxxpBBN!4~xxp@@b`pxwxpz~x@@@xxp@@pxx@@F!4~xppp@@!8~x@@@pxxwxp@B!5~zxXXXWXX@BF!10~??!24~!10^FNN^~~~$#1!5?BFN{w{]NB@!4?ow{MM!4EM[{w???E}}}???EEM}}!5?EEM}}[]MEFEMC!17?CMM~~~!5ME!5?ow{MEEFEEM{{o!4?EEM}}[]MEFEMC?E}}}EEM}}MEE}}w!4?EMMM}}!8?E}}}MEEFEM}{!5?CEeeefee}{w!10?~~!24?!10_woo_-#0!5~nFFF??FFN!5~wo_FF!4NFb_o!4~{o_!4Ffb??Fn~~~NFF??!4FN!23~_??!5NFFn~~~w__C!7KCC!4~NFF??!4FN!4~N???N~~??Fn~???N~~N!4F??!4Fn~~~F???Fn~~nF??Fn~~p??KMMMEE???Fn~~~N!4F??!4Fn!29~{{}!4~$#1!5?Owww~~wwo!5?FN^ww!4ow[^N!4?BN^!4wW[~~wO???oww~~!4wo!23?^~~!5owwO???F^^z!7rzz!4?oww~~!4wo!4?o~~~o??~~wO?~~~o??o!4w~~!4wO???w~~~wO??Ow~~wO??M~~rpppxx~~~wO???o!4w~~!4wO!29?BB@-#0!25FE!63FE!15FE!77FE!60F$#1!25?@!63?@!15?@!77?@-\
+EOF
+
+sleep 1
+tput cup 2 30
+
+# Show four lines saying, "<- A genuine VT340 would end here"
+cat <<'EOF'
+P0;0;0q"1;1;144;80#0;2;0;0;0#1;2;80;80;80#0~~rpp@@`@BN!25~!11^!5~^^^N^^^!6~!7^N^^^!5~!4^~~~!5^!6~^^^WWW!8~!7^N^^^!8~^^^N^^^!5~$#1??KMM}}]}{o!25?!11_!5?___o___!6?!7_o___!5?!4_???!5_!6?___fff!8?!7_o___!8?___o___-#0~~NB??EFE??@F^!19~B??{!4}{W??}}~~B@?K!5MK??B~~~}???{!4}{??!4~}???~~~}}{??!6~}{{{??!8~}???{!4}{??!4~B@?K!5MK??B~~$#1??o{~~xwx~~}w_!19?{~~B!4@Bf~~@@??{}~r!5pr~~{???@~~~B!4@B~~!4?@~~~???@@B~~!6?@BBB~~!8?@~~~B!4@B~~!4?{}~r!5pr~~{-#0rpoopr~~~zpooopr!17~}{ww!4pwW??!4~}wwprrb!4rpp~~~pooopz~~zpoopz!4~{w!4pxwoopz~~~r!4poo!4pz~~~pooopz~~zpoopz~~}wwprrb!4rpp~~$#1KMNNMK???CMNNNMK!17?@BFF!4MFf~~!4?@FFMKK[!4KMM???MNNNMC??CMNNMC!4?BF!4MEFNNMC???K!4MNN!4MC???MNNNMC??CMNNMC??@FFMKK[!4KMM-#0!32~^NNNKWwww[[MNNN^~!13N!5~NN!5FNN^!10~N!4F!8~NN!4FN^!36~$#1!32?_ooorfFFFbbpooo_?!13o!5?oo!5woo_!10?o!4w!8?oo!4wo_-#0!32~}{o?AM!4~E?_w}}~o_o}}???}}}__!5~}}~fFFFAOw!6~^FB_w{???!6~B??}!4~{??!35~$#1!32?@BN~|p!4?x~^F@@?N^N@@~~~@@@^^!5?@@?Wwww|nF!6?_w{^FB~~~!6?{~~@!4?B~~-#0!36~{_?FB?o}!7~^NN???NN^!6~!8NE?_x!4~poooP@@???X!5~{o?F!4NB_o!35~$#1!36?B^~w{~N@!7?_oo~~~oo_!6?!8ox~^E!4?MNNNm}}~~~e!5?BN~w!4o{^N-#0!38~}}}!11~!8}!8~!6}!13~!6}!9~!4}!38~$#1!38?@@@!11?!8@!8?!6@!13?!6@!9?!4@-#0!5^!5~!5^!5~!7^!6~!4^~~~!5^!6~{www??!11~^^^N^\W???!22~^^^N^^^!6~!7^N^^^!8~^^^N^\W???~~$#1!5_!5?!5_!5?!7_!6?!4_???!5_!6?BFFF~~!11?___o_af~~~!22?___o___!6?!7_o___!8?___o_af~~~-#0}{??CMB@@FM??o{~~B@?{{!4}{w?@~~~}???~~~}}{??!10~??!8~B??{!5}{???!19~B@?K!5MK??B~~~}???{!4}{??!4~B??{!5}{???~~$#1@B~~zp{}}wp~~NB??{}~BB!4@BF~}???@~~~???@@B~~!10?~~!8?{~~B!5@B~~~!19?{}~r!5pr~~{???@~~~B!4@B~~!4?{~~B!5@B~~~-#0~~~woow~}woo{!4~}{wpprbrrpww{!5~{w!4pxwoopz~~~r!4poo!4pz~~~}{ww!5pwooopz!17~}wwprrb!4rpp~~~pooopz~~zpoopz~~}{ww!5pwooopz$#1???FNNF?@FNNB!4?@BFMMK[KKMFFB!5?BF!4MEFNNMC???K!4MNN!4MC???@BFF!5MFNNNMC!17?@FFMKK[!4KMM???MNNNMC??CMNNMC??@BFF!5MFNNNMC-#0!40~n!4F!99~$#1!40?O!4w-#0!10~^^n!29~???b!4rbBF!4~^NFbrrprrbFF^!4~rrbBBFBbrrrbv~~^NFbrrprrbFF^!42~$#1!10?__O!29?~~~[!4K[{w!4?_ow[KKMKK[ww_!4?KK[{{w{[KKK[G??_ow[KKMKK[ww_-#0!9~}{wq!10}!18~N???N^~~^N??N^~~o??H!6XWGG!4~^NN??!4N^!5~o??H!6XWGG!42~$#1!9?@BFL!10@!18?o~~~o_??_o~~o_??N~~u!6efvv!4?_oo~~!4o_!5?N~~u!6efvv-#0!41B!6ABB!6A!5BAAA?!6A!4B!10A!8BAAA?!6A!42B$#1!41?!6@??!6@!5?@@@B!6@!4?!10@!8?@@@B!6@$-\This text should be indented.
+EOF
+
+# For more details, please see:
+# https://github.com/jerch/xterm-addon-image/issues/37
+
+# By default, sixel is in a 2:1 aspect ratio, which means
+# every sixel graphics linefeed (GLF) adds another 12 pixels.
+# With four GLFs, we have five sixel lines = 5 * 12 =  60 pixels.
+
+# Which text line that ends up on depends upon the height of your
+# font. On the VT340, the font is 20 pixels high. 
+
+# On a VT340 sixel scrolling is on by default. DEC refers to this by
+# two different names "sixel scrolling" and its negation, "DECSDM"
+# (Sixel Display Mode). They control the same thing, so when DECSDM is
+# on, sixel scrolling is off, and vice versa. 
+
+# When DECSDM is on, the graphic line feeds do not affect the text cursor.
+
+
+# How hackerb9 created the two sixel test images:
+#
+# convert -family "Courier" -style normal -density 72 -pointsize 26 -interline-spacing -12 -gravity center -fill gray80 -background none label:$'A genuine\nVT340\nwould end\n← here  '  +trim +dither -colors 2 sixel:- > reference.six
+#
+# convert -family "Courier" -style normal -density 72 -pointsize 26 -interline-spacing -12 -gravity center -fill gray80 -background none label:$'Your terminal →'  +trim -bordercolor none -border 2 +dither -colors 2 sixel:- > yourterminal.six
+

addons/xterm-addon-image/fixture/growing_rect.js

@@ -0,0 +1,44 @@
+const sixelEncode = require('../node_modules/sixel/lib/SixelEncoder').image2sixel;
+const toRGBA8888 = require('../node_modules/sixel/lib/Colors').toRGBA8888;
+
+function createRect(size, color) {
+  const pixels = new Uint32Array(size * size);
+  pixels.fill(toRGBA8888(...color));
+  return sixelEncode(new Uint8ClampedArray(pixels.buffer), size, size);
+}
+
+function createRectMinusOne(size, color) {
+  const pixels = new Uint32Array(size * size);
+  if (size - 1) {
+    const sub = new Uint32Array(size - 1);
+    sub.fill(toRGBA8888(...color));
+    const last = size * (size - 1);
+    for (let y = 0; y < last; y += size) {
+      pixels.set(sub, y);
+    }
+  }
+  return sixelEncode(new Uint8ClampedArray(pixels.buffer), size, size);
+}
+
+async function main() {
+  // clear + cursor and sixelScrolling off
+  process.stdout.write('\x1b[2J\x1b[?25;80h');
+
+  for (let i = 1; i < 300; ++i) {
+    await new Promise(res => setTimeout(() => {
+      process.stdout.write(createRect(i, [0, 255, 0]));
+      res();
+    }, 5));
+  }
+  for (let i = 299; i >= 1; --i) {
+    await new Promise(res => setTimeout(() => {
+      process.stdout.write(createRectMinusOne(i, [0, 255, 0]));
+      res();
+    }, 5));
+  }
+
+  // re-enable cursor and sixel scrolling
+  process.stdout.write('\x1b[2J\x1b[?25;80l');
+}
+
+main();

addons/xterm-addon-image/fixture/iip/palette.iip

@@ -0,0 +1 @@
+]1337;File=inline=1;size=525;name=Li4vcGFsZXR0ZS5wbmc=:iVBORw0KGgoAAAANSUhEUgAAAoAAAABQCAYAAACJbMQlAAAABmJLR0QA/wD/AP+gvaeTAAABwklEQVR4nO3dwQnEMAwAQedIIem/yVwLBj0C3pm3uAO/Fj2ia631rh3P1lRu7vnof0+Z836zOe83m/N+sznvN5vzfrM57zeb+23+HAAAhxCAAAAxAhAAIEYAAgDECEAAgBgBCAAQIwABAGIEIABAjAAEAIi59z8tDQDACWwAAQBiBCAAQIwABACIEYAAADECEAAgRgACAMQIQACAGAEIABAjAAEAYlwCAQCIsQEEAIgRgAAAMQIQACBGAAIAxAhAAIAYAQgAECMAAQBiBCAAQIwABACIcQkEACDGBhAAIEYAAgDECEAAgBgBCAAQIwABAGIEIABAjAAEAIgRgAAAMQIQACDGJRAAgBgbQACAGAEIABAjAAEAYgQgAECMAAQAiBGAAAAxAhAAIEYAAgDECEAAgBiXQAAAYmwAAQBiBCAAQIwABACIEYAAADECEAAgRgACAMQIQACAGAEIABAjAAEAYlwCAQCIsQEEAIgRgAAAMQIQACBGAAIAxAhAAIAYAQgAECMAAQBiBCAAQIwABACIcQkEACDGBhAAIEYAAgDECEAAgBgBCAAQIwABAGIEIABAjAAEAIgRgAAAMQIQACDmDz4lC02AaqMRAAAAAElFTkSuQmCC

addons/xterm-addon-image/fixture/iip/w3c_gif.iip

@@ -0,0 +1 @@
+]1337;File=inline=1;size=1667;name=Li4vdGVzdGltYWdlcy93M2NfaG9tZV8yNTYuZ2lm:R0lGODlhSAAwAPcAAAQCBIyKjMzOzERGRHSOvAxCnLy6vNzm9DRmrCQiJGxubNze3HSWxJSq1JyenCRarPz+/FR+vBweHLzG5FxeXGSKxBROpOzu7ERytDw+PHx+fLTC5AwODIyOjExOTAxGnLy+vDxqtCwuLHR2dNTa7ISezKS23KyurMTO5GyKxOzy/ACCXwAAN7AAF+IAjIEAw8DPArtsAOSupIHW2HBvAsUBAHIAbwAAARwAiEdgA/caAr+CAgCIALAjAOMcJIGCAAB8EADGAAByiAAArcQcSrtHBOT3zYG/AaQA7sVgE3Ib9wCCv88AZ2wAAaIAANUAAG+M4wEjogAc9wCCv8SwGbvGBeRyAIEAAF/PrBZsxwCucgDWAIRvpMUBaHIAAQAAAFCMfEIjj/kcUb+CAAC4sLAZKOL3AIG/AECQoAfGowBy9wAAvwBQAABCAAD5UAC/ALgALBlguPcaUb+CAMRwpNUFaAAAAQAAAOAAAPgAAHIAAAAAAG24DBgZAPf3UL+/AM/QAGzWAKIAUNUAAADgfAD4jwByUQAAAKJtQNUYAH/3AFe/AGTPABNsAACuAADWAAAAMgAABUYAAAIAAACuGQDWBQh/AABXAAJH1AABx8QAcgsAAAMAUAAApTdG9wYCv3oAADMAAKUBULAAAEcCZwEApQCM9wDDv0ACAAcAAABfUAAWAKUAQ7AAAEelAAGwAPhHQ8UBAHIAAAAAABhwFIkFxX8AUIEAABClAtKwADxHAIIBABAUopPXKKZm99Iov/gf+MUXx3IAcgAAAAxwZsYFtHIA9wAAvxgAAIlgAH8aUIGCAHiM1QrDtD0C94IAvxAAAJMASqYChdIAgQxw78YFGXIA+AAAvw4AM6EAGvcA+L8AvyYAALMASveNhb+tgQBKLGAEuDzNUYIBAADRmwABbgAA9wAAv8+kFmzYxWYCUNYAAG+k4wHYKAACQgAAAAAAHmAAxTsoUIIAADwcvcZ6bnIC9wAAvxgAm4kAbn8A94EAv0QABAoAAD0MAIIXACH5BAAAAAAALAAAAABIADAABwj/AAEIHEiwoMGDCBMqXGgQgsOHECNKnEixosWLGDNq3Mixo8ePIEOKHCkxgMkRBkiq7BhAgEmXAlbKxBgAwoALAyDUnMlzYs0EA1LuVIGiKAoVEg8YRXFxQoOnJpZKLYpUY0wII2wKGLBg54EPYD+YkEgi7AemFS2AVRuW7Qe3aB8K8ACAA4UFDy+IcGhg54URFx4+CFthIlsLDCqiKGD2bWOzcSE4MOjAoQYAck0GCPyQweGJFcI+qMiA8eO2azFAFIDQwAUOAEBcRNGWhEQTZg9QRFDg8NrTkSUglKBAYOWLbhNHVGG2wcSvYVNE3GC28MPJA0VoUJCAIAfOFiOE/0UwEYPjCBMbmK0quC17CBkGHodwgcJADRlxO9YdMXTY9w6Jx1gIEZXg2AclQHSBfBLZ911GzIU1VkRufTCBRL8595AKbo0G0QkCUUCRdhuFEBZ6EJFQoXUPTWCWbQ/5B9aFEF0GAF4TCQAeRuqFVeBvH3gYo2gQ0eaYahHR5cFKZTm2AUQIPAajQ4OBpZxD5oXFH0TxzUdSlR9c+VWFFiToUJNgPemQfmCxyCUAO44ko5BsukWeQz1aYMGGg7kVwpQOZSDBTC46BqN4bxn4n0MmgoUiBD2iJhaXGfDUnENuHSCeWmNFCNaEEJRQoVmgalDpTIh+oBp1YJEXKXpsfv+wJQol1IqAbxZU5cCpMuHGlgoMrJUYdG9BEJpaBFKEQoVmLsDrSsSKBSaMYC4blpkUoVmsZT1FCVaj20Lg2bcvXnQsWDDKxtO4jbFoZGNCVsTqWxr2BEGTvtGIqaRuZmsWtvaO+sF7Moalr0VuAdxTwR88uuaBYAH43G8pqItRnBkVGla9DnmqlsOK/btkRhnguFGEbG35UJZg1TtBBHdGFCxbKHSA30UBAHCCRywnG1GksjrkrYXLgTnwAgB4KZEAsN3MUaRXQkSszzJaAGiwJzpUnNJywZa0R9BZEBlED6glpltlokDCuW+h9RoAO0EUgNd7fdQnaWBFpqjAWT9gBCIAxJ1wggLCCcSByR0F22+R4a7cWIUIAIjdQRxc9RFtoBq2uAopnPZBCBJL5jVBElgOUq4WVZB5kZt+u3pECygggkAZdICxvbjnrvvuvPfu++/ABy88Q8QXb/zxAgUEADs=

addons/xterm-addon-image/fixture/iip/w3c_jpg.iip

@@ -0,0 +1 @@
+]1337;File=inline=1;size=2159;name=Li4vdGVzdGltYWdlcy93M2NfaG9tZV8yNTYuanBn:/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCAAwAEgDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD33/hXPgn/AKE7w3/4K4P/AImj/hXPgn/oTvDf/grg/wDia8y/aLuNX0PWtB1nS7+8ghcGJ4o5mWPejbhlQcHIYj6LXr07J4l8IO1jM8K6lZboZUbayb0yrAjoRkH8K6J4flpwqX0l+BhGrzSlC2qM7/hXPgn/AKE7w3/4K4P/AImj/hXPgn/oTvDf/grg/wDia81/Zt8S313da3ousXk9xcR7biLz5S7DB2OMknvsrov2ifEEujeB0trSd4bq/uFiDRsVYIvzMQR9FH/AquWDlHELD3+ZMcQnS9qdR/wrnwT/ANCd4b/8FcH/AMTR/wAK58E/9Cd4b/8ABXB/8TXhFr4F8dL4SXX5fFCWOntbfays1/OrqhGRkKpGSMcZzyB1q7+z9D4g8QeKzqF3q2pSaZpwzIsty7LJIwIVME4Pcn0wPUVvPL4xhKaqJqJnHFNyUXFq57V/wrnwT/0J3hv/AMFcH/xNH/CufBP/AEJ3hv8A8FcH/wATXgnxP8YePPiB8Sr/AMI/DKe8tbLSG8u4ntZ/ILSKcOzy5BVQ2VCg87ScHoF0/wAcfE3T9Z8O/D7xJZSNr0mq20635YYuLJG3upZeGHycsOdoYEZ6+Ydh6Pd2fgW38Qvpn/CA+G2EaNKzfYoPMEStIrPs8voDDJ37D+JlUld9ceFNNnvzcyISGfzGjKoQW+Yn5iu8Al3yoYA73yPmbJQBzvx30X+2fhtqRRN01jtvE9tmdx/74L1ynw18Z/Y/gVqN20n+laMktuhJ5y3MX4ZdV/CvZ7qCO6tpredQ8UqGN1PdSMEfrXxPqb6hoD674WDExveKkygHLmJnC4Hvuz74Fexl8FiaToy6NP5dTz8VJ0Zqouqa/wAjb+Ed/P4c8f8Ah++uEeO0v2MIc8K6Oxjzn0DgH/gNdt8bpH8V/FnQ/DFu5KQeXC+P4GlIZz+CbD+FT/Grwf8A2L8NvCk1uu2fSQtvMyccuNzN/wB/F/8AH6p/AeO48V/E/VfE2ohWkgRpiQOFkk+VQPYLvH4V3SqQmnjV0TXzvoc6jKP+zPq0/wDM0P2k/FRt47Twnp+Y4QizXOOAQPuR/QY3H/gNdx8BtQ8PS+CoLDQJibm3G+9jlULIZW6uR3BxgEE8ADqK7nUdG0zUlcajp1pdb12t50KuSPqRXzl4bgTwP+0C2m2EhSwMxgKs/HlSR7wpP+ySp5/u1wUnDE4Z0Y6OKv6nTNSpVlUeqenoej/s26IuneAZdSmX/iY6xf3N3cuw+YkSsgB+gXOOxY16bNY2s17b3k1vE91bh1hlZQWjDY3BT2zgZ+lQ6JpcGj2H2O0GIfOllA9PMkaQgewLEVeJx1ryDvFooooAK8K8X+C/tf7QWjTCPNneKt9KSPl3QjDD8dsf/fdel/8ACxvBP/Q4+G//AAaQf/FVG3j/AMCNcJO3i3wwZ0VkSQ6lBuVWILAHdkA7VyO+B6V0YevKg249U0ZVaSqJJ9Hcu/EDRf8AhIfBesaYF3yT27eUP+mi/Mn/AI8BXm3wa8Panb/CDUbjRZ/sms6mzy28xUEgJ8qDDDAztbntuzXoH/CxvBP/AEOPhv8A8GkH/wAVUdv4/wDAltCkNv4t8MRRIMKialAqj6ANTp4mUKTpLun939IUqKlPn8rHkXg340XnhuwuNJ8Y2N9eX9s77ZWbEuSSdkm70PQjtgY4ql8KdCu/iD4+1LxNrVsTppMpkyPkd3QoI1Pfarfhgetet6n4l+F+qzCbVNa8F3soG0PcXVrIwHpliavW3j7wHawJBa+LPC8MKDCRx6jAqqPQANgV1SxtNRl7KFpS3/4BjHDTuueV0tjg0+LX/CvL5/DfxPivRNCT9i1iKHzI7+AfddgORJjAYAEZ54yM8xd/ETV/jN4v0zw/4Btrux8PWV3DealqU67WZY3DKMAkAZXhc5YgdADXrereMPhxrNr9m1fxF4Qv7bOfKur22lTPrhmIpdK8ZfDnSLRbXSfEfhGxtV5ENtfW0SD/AICrAV5h2HbUVyv/AAsbwT/0OPhv/wAGkH/xVFAH/9k=

addons/xterm-addon-image/fixture/iip/w3c_png.iip

@@ -0,0 +1 @@
+]1337;File=inline=1;size=1658;name=Li4vdGVzdGltYWdlcy93M2NfaG9tZV8yNTYucG5n:iVBORw0KGgoAAAANSUhEUgAAAEgAAAAwCAMAAACFQszZAAADAFBMVEUEAgSMiozMzsxERkR0jrwMQpy8urzc5vQ0ZqwkIiRsbmzc3tx0lsSUqtScnpwkWqz8/vxUfrwcHhy8xuRcXlxkisQUTqTs7uxEcrQ8Pjx8fny0wuQMDgyMjoxMTkwMRpy8vrw8arQsLix0dnTU2uyEnsykttysrqzEzuRsisTs8vwAgl8AADewABfiAACBAAlwzwPVbADkrqSB1thwbwLFAQByAG8AAAEcADBHYAf3GgK/ggIA/ACwaADjHByBggAAfA4AxgAAchQAACB0HEbVRwTk98WBvwGkAO7FYBNyG/cAgr/PAGdsAAGiAADVAABvAOMBaaIAHPcAgr90sBXVxgXkcgCBAABfz6wWbMcArnIA1gCEb1TFARNyAAAAAABQANRCaU35HFG/ggAAuLCwGSji9wCBvwD4kKAIxqMAcvcAAL8AUAAAQgAA+VAAvwC4AIQZYHb3GlG/ggDElFTVDxMAAAAAAADgAAD4AAByAAAAAABtuAwYGQD391C/vwDP0ABs1gCiAFDVAAAA4NQA+E0AclEAAACibUDVGAB/9wBXvwBkzwATbAAArgAA1gAAABgAAAVGAAACAAAArhUA1gUIfwAAVwADR9QAAcd0AHIlAAADAFAAAKU3RvcGAr96AAAzAAClAVCwAABHA2cBAKUAAPcACb/4AwAIAAAAX1AAFgClAEOwAABHpQABsAD4R0PFAQByAAAAAAAYlByJD8V/AFCBAAAQpQLSsAA8RwCCAQAQFKKT1yimZvfSKL/4H/jFF8dyAHIAAAAMlGbGD7RyAPcAAL8YAACJYAB/GlCBggB4ANUKCbQ9A/eCAL8QAACTAEqmA4XSAIEMlO/GDxlyAPgAAL8OADOhABr3APi/AL8mAACzAEr3GoW/IIEARoRgBHY8xVGCAQAAz5sAAW4AAPcAAL/PpB5s2MVmAlDWAABvpOMB2CgAAkIAAAAAABZgAMU7KFCCAAA8HL3Gem5yAvcAAL8YAJuJAG5/APeBAL9EAAQKAAA9DACCFwCk+0jYAAAACXBIWXMAAAAAAAAAAACdYiYyAAADIElEQVR4nO2WW3OqQAyAAUehArJWXcDSUiwg3f//A8/msheU0/bBhzNnutMOEZKPJJtkCYJHLfGg9V+CwjD82DwAFEah/oseABKrciXCR4CeVhsEqUkvRXdjkD2tQ57n4+SWuqFEQnyIVbRKARS3eo30oAfZI8m2lXBL8j89it6C5phqobwIsQn19aOE0AqtcfIsM8uZ1q3B0ELQjkp5J8QZzHWywxJ3LQNrNj1p7cKCsrVFAE1W6I9pik3ZBO9GFUATqPX0ewSb2DxN1hSb9B16NqDnLbrlQBBPy/Eo0M/5IWbvE8WX1sSPgV3O2ye4NuUMtNdKCd+o9Ov3LOdgTRsFeZQo1pQeUR61cBYz0AjOxy5JbKxfsG47lAaIbgCpDGw8R88hAimvADAdB5KBj2EqaffgGgRHY3xxDnGvdVqP4umlTYY4gNhbN4l+DoLUGEflLQiTwTFAEIWNEqUJblZk8Ba8iaVFoB40X0BKaJ/Rj8JsZuXVRO12fAFkbWLuiEFwuwB9dNECqPwKZKIYuSESildCwasCb3VUsvXzIseADmDfY0XJgQvA7EBuOgT3ta6/BAkuaHh1vNdWo6uJwfYs/Dp/A4LirrAREnRh77puGoYhwYaD0t59AxrBd5XhEIEWkzptkssa1oRu6T1IvwHRdCto5+GCloNTxD2E3J+XMN5xBAXUsS4MqM6WEy/wEG6830NmoIxTCvUycXILXxPyJ/M7wB2o5wmGHcUj+uRr9u081r+BBHukKIzWGwKewk9AZEwzYKROmR0+MTj5eZOhm3mEC4cGT1mFoe1nNpi44ab1aztSHEhhWrjHKwM97M0MzuDx9Drb/TC43oPQ2FRgzmWd2EypAoNN/SkSNW5oe6DcnSVYnwCFxNFJlXEGt46kOTfHkTWW9rQuJM0nLIRh6rEc4bE+FEOOS3MuYgGkO0NaOePTcPAPbMz+FU7G63UL52STLoIyrwInA63MNNJzgcphZz9km0gsgiZzJMGSDFWfxp/OlNWu4SPb48w//aRXgScLnWDQtZ33knR7CYL6dTa8/6Wv2l/Qj0GPWn8AP2jx/kucqREAAAAASUVORK5CYII=

addons/xterm-addon-image/fixture/inspect_palette.sh

@@ -0,0 +1,67 @@
+#!/bin/bash
+
+function print_palette() {
+  L=$(( LOWER / 256))
+  U=$(( (UPPER-1) / 256))
+  for ((p = $L; p <= $U; p++))
+  do
+    echo "slot $((p*256))..$((p*256+255)):"
+    echo -ne "\x1bP;1q"
+    for i in {0..15}
+    do
+      a=$((i * 16 + p * 256))
+      for j in {0..15}
+      do
+        echo -ne "#$((a+j))!6~"
+      done
+      echo -ne "\$-"
+    done
+    echo -e "\x1b\\"
+  done
+}
+
+colors=undefined
+max_colors=undefined
+
+echo "Terminal Reports (XTSMGRAPHICS):"
+IFS=";" read -a REPLY -s -t 1 -d "S" -p $'\e[?1;1;0S'
+[[ ${REPLY[1]} == "0" ]] && colors=${REPLY[2]}
+echo "active colors: ${colors}"
+
+IFS=";" read -a REPLY -s -t 1 -d "S" -p $'\e[?1;4;0S'
+[[ ${REPLY[1]} == "0" ]] && max_colors=${REPLY[2]}
+echo "max colors   : ${max_colors}"
+echo
+
+
+# query up to colors by default
+# if colors is undefined (no XTSMGRAPHICS), assume 256
+ARG1=${1:-${colors}}
+if [[ $colors == "undefined" ]]
+then
+  ARG1=${1:-256}
+fi
+LOWER=0
+UPPER=$ARG1
+ARG2=${2:-undefined}
+if [[ $ARG2 != "undefined" ]]
+then
+  LOWER=ARG1
+  UPPER=ARG2
+fi
+
+if [[ $colors != "undefined" ]]
+then
+  if [[ $colors -lt $UPPER ]] || [[ $colors -lt 256 ]]
+  then
+    echo -e "\x1b[33mNote: Active colors is smaller than test range."
+    echo -e "A spec-conform terminal may repeat colors in 'slot mod ${colors}'.\x1b[m"
+    echo
+  fi
+else
+  echo -e "\x1b[33mNote: Cannot query active colors."
+  echo -e "The terminal may repeat colors beyond it max slot (e.g. slot mod 16).\x1b[m"
+  echo
+fi
+
+print_palette

addons/xterm-addon-image/fixture/overdraw.sh

@@ -0,0 +1,141 @@
+#!/bin/bash
+
+function smiling_smiley() {
+  echo -ne '\x1bP;2q"1;1;60;60
+#6!60~$-
+!60~$-
+!60~$
+!15?#1!4]!22?!4]$-
+#6!60~$-
+!60~$-
+!60~$-
+!60~$
+!15?#1!4~!22?!4~$-
+#6!60~$
+!15?#1!30N$-
+#6!60~$-
+!60~$-
+'
+  echo -ne '\x1b\\'
+}
+
+function indifferent_smiley() {
+  echo -ne '\x1bP;2q"1;1;60;60
+#6!60~$-
+!60~$-
+!60~$
+!15?#1!4]!22?!4]$-
+#6!60~$-
+!60~$-
+!60~$-
+!60~$-
+!60~$
+!15?#1!30N$-
+#6!60~$-
+!60~$-
+'
+  echo -ne '\x1b\\'
+}
+
+function sad_smiley() {
+  echo -ne '\x1bP;2q"1;1;60;60
+#6!60~$-
+!60~$-
+!60~$
+!15?#1!4]!22?!4]$-
+#6!60~$-
+!60~$-
+!60~$-
+!60~$-
+!60~$
+!15?#1!30N$
+!15?#1!4o!22?!4o$-
+#6!60~$
+!15?#1!4B!22?!4B$-
+#6!60~$-
+'
+  echo -ne '\x1b\\'
+}
+
+function smiling_smiley_slim() {
+  echo -ne '\x1bP;1q"1;1;60;60
+$-
+$-
+$-
+$-
+$-
+$-
+!15?#1!4~!22?!4~$-
+!15?#1!30N
+'
+  echo -ne '\x1b\\'
+}
+
+function indifferent_smiley_slim() {
+  echo -ne '\x1bP;1q"1;1;60;60
+$-
+$-
+$-
+$-
+$-
+$-
+!15?#6!4~!22?!4~$-
+!15?!4o!22?!4o$ !15?#1!30N$-
+!15?#6!4B!22?!4B
+'
+  echo -ne '\x1b\\'
+}
+
+function sad_smiley_slim() {
+  echo -ne '\x1bP;1q"1;1;60;60
+$-
+$-
+$-
+$-
+$-
+$-
+$-
+!15?#1!30N$
+!15?#1!4o!22?!4o$-
+!15?#1!4B!22?!4B$-
+'
+  echo -ne '\x1b\\'
+}
+
+function full() {
+  smiling_smiley
+  sleep .5
+  indifferent_smiley
+  sleep .5
+  sad_smiley
+  sleep .5
+  indifferent_smiley
+  sleep .5
+  smiling_smiley
+}
+
+function slim() {
+  smiling_smiley
+  sleep .5
+  indifferent_smiley_slim
+  sleep .5
+  sad_smiley_slim
+  sleep .5
+  indifferent_smiley_slim
+  sleep .5
+  smiling_smiley_slim
+}
+
+# clear screen and place cursor to 1;10
+echo -ne '\x1b[2J\x1b[10;1H'
+
+# switch sixel scrolling off
+echo -ne '\x1b[?80h'
+
+case "$1" in
+  full ) full ;;
+  slim ) slim ;;
+esac
+
+# re-enable sixel scrolling
+echo -ne '\x1b[?80l'

addons/xterm-addon-image/fixture/textcursor.sh

@@ -0,0 +1,288 @@
+#!/bin/bash
+
+# Test cursor row, column placement after sixel image is sent.
+
+# After a sixel image is displayed, the text cursor is moved to the
+# row of the last sixel cursor position, but the column stays the same
+# as it was before the sixel image was sent.
+#
+# This can be thought of as sixel images always ending with an
+# implicit Graphics Carriage Return (`$`). 
+
+# ADDENDUM: It is not as simple as I thought. When a row of sixels
+# straddles two rows of text, the text cursor can be left on the upper row.
+# It seems up to three lines of pixels may be beneath any words printed.
+#
+# The rule for when this happens is not obvious to me, but can be seen
+# with images of height: 21, 22, 23, 24, 41, 42, 81, 82, 83, 84...
+#
+# My guess:
+# for a sixel image of height h, let a=(h-1)%6 and b=(h-1)%20,
+# then, the text will overlap the image when a>b.
+#
+# If that is the case, then the entire list of heights for which this
+# will happen on the VT340's 480 pixel high screen is:
+#
+#  21  22  23  24   41  42   81  82  83  84
+# 101 102  141 142 143 144  161 162 
+# 201 202 203 204  221 222  261 262 263 264  281 282 
+# 321 322 323 324  341 342  381 382 383 384
+# 401 402  441 442 443 444  461 462
+#
+# Note that there are 48 entries, so that means there's a 10% chance
+# if heights are chosen randomly from 1 to 480. However, if one were
+# to always pick heights which are a multiple of the character cell
+# height (20px), then the chances are 0% as there are no problematic
+# heights divisible by 20. 
+
+
+# Sixel images often do *not* end with a `-` (Graphics New Line = GNL)
+# which sends the sixel cursor down 6 pixels. Any text printed next
+# will potentially overlap the last row of sixels!
+
+# I am not yet positive, but I believe that, in general, applications
+# should send sixel images without a GNL but then send `^J`, a text
+# newline (NL), before displaying more text or graphics.
+
+# IMPORTANT: sometimes neither a graphics nor a text newline is wanted. 
+# For example, if an image is full screen, either newline would cause
+# the top line to scroll off the screen.
+
+#         | Text cursor column | Text cursor row
+# --------|--------------------|-------------------------------------
+# !GNL !NL| Unchanged	       | Overlapping last line of graphics
+# !GNL  NL| Column=1	       | First line immediately after graphic (usually)
+#  GNL !NL| Unchanged	       | _Sometimes_ overlapping graphics
+#  GNL  NL| Column=1	       | First *or* second line after graphic
+
+
+CSI=$'\e['			# Control Sequence Introducer 
+DCS=$'\eP'			# Device Control String
+ST=$'\e\\'			# String Terminator
+
+set_cursor_pos() {
+    # Home, top left is row 1, col 1.
+    local row=$1 col=$2
+    echo -n ${CSI}${row}';'${col}'H'
+}
+
+reset_palette() {
+    # Send DECRSTS to load colors from a Color Table Report
+    echo -n ${DCS}'2$p'
+
+    echo -n "0;2;0;0;0/"        # VT color #0 is black and BG text color
+
+    echo -n "1;2;20;20;79/"	# VT color #1 is blue
+    echo -n "2;2;79;13;13/"	# VT color #2 is red
+    echo -n "3;2;20;79;20/"	# VT color #3 is green
+
+    echo -n "4;2;79;20;79/"	# VT color #4 is magenta
+    echo -n "5;2;20;79;79/"	# VT color #5 is cyan
+    echo -n "6;2;79;79;20/"	# VT color #6 is yellow
+
+    echo -n "7;2;46;46;46/"	# VT color #7 is gray 50% and FG text color
+    echo -n "8;2;26;26;26/"	# VT color #8 is gray 25%
+
+    echo -n "9;2;33;33;59/"	# VT color #9 is pastel blue
+    echo -n "10;2;59;26;26/"	# VT color #10 is pastel red
+    echo -n "11;2;33;59;33/"	# VT color #11 is pastel green
+
+    echo -n "12;2;59;33;59/"	# VT color #12 is pastel magenta
+    echo -n "13;2;33;59;59/"	# VT color #13 is pastel cyan
+    echo -n "14;2;59;59;33/"	# VT color #14 is pastel yellow
+
+    echo -n "15;2;79;79;79"	# VT color #15 is gray 75% and BOLD text color
+
+    echo -n ${ST}		# String Terminator
+}
+
+# Generate square of size w with final graphics new line removed
+square() {
+    # Given a color index number and (optionally) a size, row, and column, 
+    # draw a square with top left corner at (row, column) and of size×size px.
+    # Default size 100×100px  (10cols, 5 rows)
+
+    local -i color=${1:-1}	# Default is color index 1 (blue)
+    local -i size=${2:-100}	# Size in pixels (defaults to 100)
+    local -i row=$3 column=$4	# If set to 0, cursor is not moved
+
+    if [[ row -ne 0 && column -ne 0 ]]; then
+	set_cursor_pos $row $column
+    fi
+
+    # Draw a square of the right color & size 
+    squaresize $color $size
+}
+
+squaresize() {
+    # Helper for square() that uses convert to return a  sixel square of
+    # the right color ($1) and size ($2).
+
+    # Similar to this but with variable size squares:
+    #    echo -n ${DCS}'0;0;0q"1;1;100;100#'${color}'!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100~-!100N'${ST}
+
+
+    local color=${1:-1}			# Default color index is 1 (blue)
+    local size=${2:-100}		# Default size is 100x100
+
+    # Get a sixel string 
+    local sq=$(convert -geometry ${size}x${size} xc:black sixel:-)
+
+    # Remove ImageMagick's extraneous Graphic New Line at end of image.
+    sq=${sq%-??}$'\e\\'
+
+    # VT340s always used the same color register for the first sixel
+    # color defined no matter what number it was assigned. That means,
+    # each time we send a new sixel image, the previous one's color
+    # palette gets changed. We don't want squares of all the same
+    # color, so remove the color definition and just use the defaults.
+    sq=${sq/\#0;2;0;0;0/}
+
+    # And finally, switch to the proper index for the color we want.
+    echo -n ${sq//\#0/#${color}}
+}
+
+squaregnl() {
+    # Same as square(), but sends a graphics newline at the end of the sixels.
+    # (Sticks a `-` before the String Terminator, "Esc \")
+    sq=$(square "${@}")
+    echo -n ${sq%??}$'-\e\\'
+}
+
+
+main() {
+    clear
+    reset_palette
+    show_labels
+    neither_graphic_nor_text 96 4 4 31 		# size, color, row, column
+    text_newline_only 96 9 4 1
+    text_newline_only 84 9 4 14
+    graphics_new_line_only 100 1 4 51
+    graphics_new_line_only 96 1 4 64
+    set_cursor_pos 1000 1
+}
+
+
+neither_graphic_nor_text() {
+    # Typically sixel images should not end with a Graphics New Line (GNL)
+    # However, if a text newline isn't sent, there will be overlap.
+
+    local -i size  color  row  column
+    read size color row column <<<"$@"
+
+    set_cursor_pos $((row++)) $column
+    echo -n "Height $size"
+    set_cursor_pos $((row++)) $column
+
+    # Three squares sent as separate sixel images, indented +1 
+    for i in {1..3}; do
+	square $((color++)) $size
+	tput cuf 1
+    done
+
+    echo -n "overlap?"
+}
+
+
+text_newline_only() {
+    # USING A TEXT NEWLINE (NL) after an sixel image that does NOT
+    # have GNL is probably the best way to be on the text line
+    # immediately below the image. However, the text will still
+    # occasionally overlap the last four rows of pixels.
+
+    # Also, if multiple images are intended to be shown, there will
+    # usually be a gap between them when using a text newline.
+
+    # Overlap happens because the height of a text cell is 20 pixels
+    # and the height of a sixel is 6. 
+    # for (h=0; h<480; h++) if ((h-1)%6 > (h-1)%20 ) { h }
+
+    # Let the pixel position of the top of the graphics cursor be 'Yg'
+    # and let the pixel position of the top of the corresponding cell
+    # of text which the text cursor will be placed on be 'Yt'. Note
+    # that Yg is evenly divisible by 6 and Yt, by 20. Taking the
+    # remainder, r, after dividing Yg by 20 tells us how many pixels
+    # down into a row of text the last line of sixels started. When
+    # r==0, the sixels started at the top of the text row.
+
+    # When r = 14, the sixels covered the bottom six pixels on the row
+    # of text. When 14 < r < 20, the sixel line impinged by r - 14
+    # pixels into the text row below and there is a chance the next
+    # text printed will overlap. 
+
+
+    local -i size  color  row  column
+    read size color row column <<<"$@"
+
+    local -i offset
+    offset=$((column-1))
+
+    set_cursor_pos $row 1
+
+    if ((offset)); then tput cuf $((offset)); fi
+    echo "Height $size"
+
+    # Three squares, separated by text new lines and indented +1 
+    for i in {1..3}; do
+	if ((offset)); then tput cuf $offset; fi
+	square $((color++)) $size
+	offset=offset+1
+	echo
+    done
+
+    tput cuf $((offset))
+    echo -n "overlap?"
+}
+
+graphics_new_line_only() {
+    # However, some sixel images end with a `-`, a Graphics New Line.
+    # This can be useful for writing another image starting at the same
+    # column without having to reposition the cursor.
+    #
+    # However, this runs the risk of having occasional overlap.
+
+    local -i size  color  row  column
+    read size color row column <<<"$@"
+
+    set_cursor_pos $((row++)) $column
+    echo -n "Height $size"
+    set_cursor_pos $((row++)) $column
+
+    # Three squares, separated by graphics new lines and indented +1 
+    for i in {1..3}; do
+	squaregnl $((color++))  $size
+	tput cuf 1
+    done
+
+    echo -n "overlap?"
+}
+
+
+show_labels() {
+    set_cursor_pos 1 10
+    echo -n "Should sixel images include a GNL ('-') at the end?"
+
+    set_cursor_pos 3 29
+    echo -n "Neither NL nor GNL"
+    set_cursor_pos 3 1
+    echo -n "Text New Line only"
+    set_cursor_pos 3 51
+    echo -n "Graphics New Line only"
+
+    set_cursor_pos 22 29
+    echo -n "Always overlaps"		# Neither NL nor GNL
+
+    set_cursor_pos 22 3
+    echo -n "Overlaps a little"		# NL only
+    set_cursor_pos 23 3
+    echo -n "    Gaps a little"		# NL only
+
+    set_cursor_pos 22 54
+    echo -n "Overlaps badly"		# GNL only
+    set_cursor_pos 23 54
+    echo -n "Never gaps"		# GNL only
+}
+
+
+main
+