keymap.vi: support ":marks"

* canvas: refactor ble/util/c2s-edit

Author: akinomyoga

docs/ChangeLog.md

@@ -77,6 +77,7 @@
 - keymap/vi: add readline-compatible widgets for `vi_imap` and `vi_nmap` (requested by excited-bore) `#D2304` d7ec488a
 - edit: support bash-5.2 readline bindable function `vi-edit-and-execute-command` `#D2306` c395eb33 xxxxxxxx
 - edit: support readline bindable function `paste-from-clipboard` in more environments `#D2307` 17646524
+- keymap/vi: support `:marks` `#D2320` xxxxxxxx
 
 ## Changes
 

lib/core-syntax.sh

@@ -355,16 +355,9 @@ function ble/syntax/print-status/.graph {
     return 0
   else
     local ret
-    ble/util/s2c "$char"
-    local code=$ret
-    if ((code<32)); then
-      ble/util/c2s "$((code+64))"
-      graph="$_ble_term_rev^$ret$_ble_term_sgr0"
-    elif ((code==127)); then
-      graph="$_ble_term_rev^?$_ble_term_sgr0"
-    elif ((128<=code&&code<160)); then
-      ble/util/c2s "$((code-64))"
-      graph="${_ble_term_rev}M-^$ret$_ble_term_sgr0"
+    ble/util/s2c "$char"; local code=$ret
+    if ble/unicode/GraphemeCluster/ControlRepresentation "$code"; then
+      graph=$_ble_term_rev$ret$_ble_term_sgr0
     else
       graph="'$char' ($code)"
     fi

lib/keymap.vi.sh

@@ -1137,35 +1137,6 @@ function ble/keymap:vi/register#play {
   ble/widget/.MACRO "${ret[@]}"
   return 0
 }
-## @fn ble/keymap:vi/register#dump/escape text
-##   @var[out] ret
-function ble/keymap:vi/register#dump/escape {
-  local text=$1
-  local out= i=0 iN=${#text}
-  while ((i<iN)); do
-    local tail=${text:i}
-    if ble/util/isprint+ "$tail"; then
-      out=$out$BASH_REMATCH
-      ((i+=${#BASH_REMATCH}))
-    else
-      ble/util/s2c "$tail"
-      local code=$ret
-      if ((code<32)); then
-        ble/util/c2s "$((code+64))"
-        out=$out$_ble_term_rev^$ret$_ble_term_sgr0
-      elif ((code==127)); then
-        out=$out$_ble_term_rev^?$_ble_term_sgr0
-      elif ((128<=code&&code<160)); then
-        ble/util/c2s "$((code-64))"
-        out=$out${_ble_term_rev}M-^$ret$_ble_term_sgr0
-      else
-        out=$out${tail::1}
-      fi
-      ((i++))
-    fi
-  done
-  ret=$out
-}
 function ble/keymap:vi/register#dump {
   local k ret out=
   local value type content
@@ -1184,19 +1155,13 @@ function ble/keymap:vi/register#dump {
     (B:*) type=block ;;
     (*)   type=char ;;
     esac
-    ble/keymap:vi/register#dump/escape "$content"; content=$ret
 
-    out=$out'"'$k' ('$type') '$content$'\n'
+    ble/string#escape-for-display "$content" sgr1="$_ble_term_rev":sgr0="$_ble_term_sgr0"
+    out=$out'"'$k' ('$type') '$ret$'\n'
   done
   ble/edit/info/show ansi "$out"
   return 0
 }
-function ble/widget/vi-command:reg { ble/keymap:vi/register#dump; }
-function ble/widget/vi-command:regi { ble/keymap:vi/register#dump; }
-function ble/widget/vi-command:regis { ble/keymap:vi/register#dump; }
-function ble/widget/vi-command:regist { ble/keymap:vi/register#dump; }
-function ble/widget/vi-command:registe { ble/keymap:vi/register#dump; }
-function ble/widget/vi-command:register { ble/keymap:vi/register#dump; }
 function ble/widget/vi-command:registers { ble/keymap:vi/register#dump; }
 
 function ble/widget/vi-command/append-arg {
@@ -2710,7 +2675,7 @@ function ble/keymap:vi/mark/get-mark.impl {
   ret=$index
   return 0
 }
-## @fn ble/keymap:vi/mark/get-mark.impl c
+## @fn ble/keymap:vi/mark/get-local-mark
 ##   @param[in] c
 ##     mark の番号 (文字コード) を指定します。
 ##   @var[out] ret
@@ -2855,6 +2820,55 @@ function ble/widget/vi-command/goto-mark.hook {
   return 1
 }
 
+function ble/widget/vi-command:marks {
+  ble/keymap:vi/mark/update-mark-history
+
+  local -a entries=() # <char>:<hindex>:<bol>:<col>
+  local c
+  for c in "${!_ble_keymap_vi_mark_local[@]}"; do
+    local value=${_ble_keymap_vi_mark_local[c]}
+    [[ $value ]] && ble/array#push entries "$c::$value"
+  done
+  for c in "${!_ble_keymap_vi_mark_global[@]}"; do
+    local value=${_ble_keymap_vi_mark_global[c]}
+    [[ $value ]] && ble/array#push entries "$c:$value"
+  done
+
+  local -a fields=()
+  local data ret
+  for data in "${entries[@]}"; do
+    ble/string#split data : "$data"
+
+    ble/util/c2s-edit "${data[0]}" sgr1=$'\e[9807m':sgr0=$'\e[9807m'; local s=$ret
+
+    # determine the line number and history position
+    local line hlabel=
+    if [[ ${data[1]} ]]; then
+      local entry
+      ble/history/get-edited-entry "$index"
+      line=$entry
+      hlabel=' !'${data[1]}
+    else
+      line=$_ble_edit_str
+    fi
+    ble/string#count-char "${line::data[2]}" $'\n'
+    ((line=1+ret))
+
+    ble/keymap:vi/mark/get-mark.impl "$line" "${data[3]}"; local ind=$ret
+
+    ble/array#push fields "${data[0]}" "$s" "$line" "${data[3]}" "$ind" "$hlabel"
+  done
+
+  if ((${#fields[@]})); then
+    local content
+    ble/util/sprintf content '%7d %s\t(%3d, %3d) %5d%s\n' "${fields[@]}"
+    content=${content%$'\n'}
+    local mydbg=1
+    ble/edit/info/show ansi "$content"
+  fi
+  return 0
+}
+
 #------------------------------------------------------------------------------
 # repeat (nmap .)
 
@@ -5503,6 +5517,8 @@ function ble/widget/vi-command/commandline.hook {
   local cmd=ble/widget/vi-command:"${command[0]}"
   if ble/is-function "$cmd"; then
     "$cmd" "${command[@]:1}"; local ext=$?
+  elif ble/util/compgen cmd -A function -- "ble/widget/vi-command:${command[@]}" && ((${#cmd[@]}==1)); then
+    "$cmd" "${command[@]:1}"; local ext=$?
   else
     ble/widget/vi-command/bell "unknown command $1"; local ext=1
   fi

note.txt

@@ -1926,6 +1926,11 @@ bash_tips
   - make_command.sh の整理 (scan 分離, char_width 分離)
   - note.txt -> memo.txt
 
+2025-01-21
+
+  * global: LC_COLLATE=C grc '\[ -\?\]' で検索すると LC_COLLATE=C を設定せずに
+    判定している箇所が沢山出てくる。これらは大丈夫だろうか? 駄目の気がする。
+
 2025-01-16
 
   * README: ble-attach は startup files の最後でなければならないという話。
@@ -1969,8 +1974,6 @@ bash_tips
 
 2024-12-23
 
-  * vi_cmap: :marks の対応。ないと marks のデバグの時に不便
-
   * vi_nmap: pu をした時のカーソル位置が vim と一致しない
     Ref #D2304
 
@@ -7734,6 +7737,59 @@ bash_tips
 
 2025-01-30
 
+  * 2024-12-23 vi_cmap: :marks の対応。ないと marks のデバグの時に不便 [#D2320]
+
+    * done: ble/string#escape-for-display 等も調整が必要ではないか? Unicode 制
+      御文字の対応はどうなっている? これは新しく用意した
+      ble/unicode/GraphemeCluster/ControlRepresentation を用いて処理することに
+      した。
+
+    * fixed: c2w-edit 及び c2s-edit は未だ判定していない Unicode 制御文字は素通
+      りしてしまう。これは問題ではないのか? → 原理的には c2w-edit 及び
+      c2s-edit を使用している段階では既に Unicode 制御文字の処理を行っていると
+      いう前提? だとすると実は c2s-edit を現在の様に外部から呼び出すのは本当は
+      駄目なのでは?
+
+      現在 c2w-edit を使っている箇所は 3 つある。何れも既に処理済みの文字列に対
+      する処理と分かっているのだろうか?
+
+      * self-insert については overwrite mode で削除する文字数を決定するのに使っ
+        ている。これは、未だ判定していない Unicode 制御文字が来る可能性があるが、
+        ずれていたとしても其処まで大した問題にはならないだろうという気がする。
+
+      * .delete-backward-char に関しては、既に登録されている文字に対しての判定
+        なので、(rendering 後であれば) Unicode 制御文字として登録されている筈で、
+        問題は発生しない筈。
+
+      何れにしても c2w-edit は頻繁に使用されているという訳でもないので、Unicode
+      制御文字としての判定を追加しても良いのでは? 少なくとも s2c 等の処理よりは
+      軽い様な気がするので其処まで気にしなくて良いのではないかという気がする。
+
+    ? ok: そもそも c2w-edit や c2s-edit は LANG=C の時には全ての unicode 文字に
+      ついて ASCII 表現を使用するべきなのではないか? と思ったが、よく考えたら
+      LC_CTYPE が unicode でない時にはそもそも code として Unicode 範囲の物が現
+      れる事もないので気にしなくて良い? 既存の取り扱いだと self-insert の時点で
+      本当に ASCII の文字列に変換されてしまうという物だった様な気がする。なので、
+      code として Unicode 範囲の物を受け取ったら常に Unicode が使える前提として
+      処理してしまって問題ない?
+
+      これは将来的に "表示に用いる文字コードだけ変更する機能" が必要になった時
+      に考えれば良い。
+
+    * global marks と local marks の両方を表示する様にするべき? うーん。と思っ
+      たが global marks は全然登録されていない。後で global marks を定義する方
+      法について確認して、global marks を定義した上で動作確認する。global marks
+      は mA などとすれば作る事ができる → 動作確認した。動いている気がする。
+
+    * 記録されている行頭位置をそのまま表示しているが、行頭位置は行頭の ind なの
+      ではないか。これを行番号に変換するべきでは → その様に変換してから表示す
+      る様に修正した。
+
+    2025-01-28 動作確認する。うーん。特殊文字の反転がそのままになっている。
+    toggle をちゃんと指定しているのに。確認してみると c2s-edit の結果が単に
+    sgr1 だけになっている。何故? → これは複数の呼び出しで ret を上書きしていた。
+    ちゃんと ret の結果を保持する様にして修正した。
+
   * keymap.vi: command mode を使った後 marks が消滅する問題 [#D2319]
 
     #D2320 の :marks のテストをするに当たって、そもそも全然 `[ や `] が登録され

src/canvas.sh

@@ -91,16 +91,8 @@ function ble/util/c2w {
 ##   編集画面での表示上の文字幅を返します。
 ##   @var[out] ret
 function ble/util/c2w-edit {
-  local cs=${_ble_unicode_GraphemeCluster_ControlRepresentation[$1]}
-  if [[ $cs ]]; then
-    ret=${#cs}
-  elif (($1<32||127<=$1&&$1<160)); then
-    # 制御文字は ^? と表示される。
-    ret=2
-    # TAB は???
-
-    # 128-159: M-^?
-    ((128<=$1&&(ret=4)))
+  if ble/unicode/GraphemeCluster/ControlRepresentation "$1"; then
+    ret=${#ret}
   else
     ble/util/c2w "$1"
   fi
@@ -122,6 +114,29 @@ function ble/util/s2w {
   ble/util/s2w-edit "$1" R
 }
 
+## @fn ble/util/c2s-edit ccode [opts]
+##   編集画面での表現を返します。
+##   @param[opt] opts
+##     @opt sgr1 sgr0
+##       制御文字の代替表現を囲むのに使用する文字列を指定します。
+##
+##   @var[out] ret
+function ble/util/c2s-edit {
+  if ble/unicode/GraphemeCluster/ControlRepresentation "$1"; then
+    if [[ ${2-} ]]; then
+      local cr=$ret sgr0= sgr1=
+      if ble/opts#extract-last-optarg "$2" sgr1 "$_ble_term_rev"; then
+        sgr1=$ret
+        ble/opts#extract-last-optarg "$2" sgr0 "$_ble_term_sgr0"
+        sgr0=$ret
+        ret=$sgr1$cr$sgr0
+      fi
+    fi
+  else
+    ble/util/c2s "$1"
+  fi
+}
+
 # ---- 文字種判定 ----
 
 #%< canvas.c2w.sh
@@ -946,6 +961,27 @@ function ble/unicode/GraphemeCluster/.get-ascii-rep {
   fi
 }
 
+function ble/unicode/GraphemeCluster/ControlRepresentation {
+  # cache
+  if [[ ${_ble_unicode_GraphemeCluster_ControlRepresentation[$1]+set} ]]; then
+    ret=${_ble_unicode_GraphemeCluster_ControlRepresentation[$1]}
+    [[ $ret ]]
+    return "$?"
+  fi
+
+  if (($1<32||127<=$1&&$1<160)) || {
+       ble/unicode/GraphemeCluster/c2break "$1"
+       ((ret==_ble_unicode_GraphemeClusterBreak_Control)); }; then
+    local cs
+    ble/unicode/GraphemeCluster/.get-ascii-rep "$1"
+    ret=$cs
+    return 0
+  else
+    _ble_unicode_GraphemeCluster_ControlRepresentation[$1]=
+    return 1
+  fi
+}
+
 ## @fn ble/unicode/GraphemeCluster/match text i flags
 ##   @param[in] text i
 ##   @param[in] flags

src/color.sh

@@ -1726,18 +1726,9 @@ function ble/highlight/layer:plain/update/.getch {
       ch='^?'
     fi
   else
-    local ret; ble/util/s2c "$ch"
-    local cs=${_ble_unicode_GraphemeCluster_ControlRepresentation[ret]}
-    if [[ $cs ]]; then
-      ch=$cs
-    elif ((ret<0x20)); then
-      ble/util/c2s "$((ret+64))"
-      ch="^$ret"
-    elif ((0x80<=ret&&ret<=0x9F)); then
-      # C1 characters
-      ble/util/c2s "$((ret-64))"
-      ch="M-^$ret"
-    fi
+    local ret
+    ble/util/s2c "$ch"
+    ble/unicode/GraphemeCluster/ControlRepresentation "$ret" && ch=$ret
   fi
 }
 

src/edit.sh

@@ -5190,6 +5190,8 @@ function ble/widget/self-insert {
       # 上書きモードの時は Unicode 文字幅を考慮して既存の文字を置き換える。
       # ※現在の LC_CTYPE で対応する文字がない場合でも、意図しない動作を防ぐために、
       #   対応していたと想定した時の文字幅で削除する。
+      # TODO: c2w-edit では TAB は "^I" として扱われるが、本当は現在の列に応じ
+      # て計算するべき?
       local ret w; ble/util/c2w-edit "$code"; w=$((arg*ret))
 
       local iN=${#_ble_edit_str}
@@ -5432,6 +5434,8 @@ function ble/widget/.delete-backward-char {
         local w=0 ret i
         for ((i=0;i<a;i++)); do
           ble/util/s2c "${_ble_edit_str:_ble_edit_ind-a+i:1}"
+          # TODO: c2w-edit では TAB は "^I" として扱われるが、本当は現在の列に
+          # 応じて計算するべき?
           ble/util/c2w-edit "$ret"
           ((w+=ret))
         done

src/util.sh

@@ -1182,19 +1182,12 @@ function ble/string#escape-for-display {
 
   while [[ $tail ]]; do
     if ble/util/isprint+ "$tail"; then
-      head=$head${BASH_REMATCH}
+      head=$head$BASH_REMATCH
       tail=${tail:${#BASH_REMATCH}}
     else
-      ble/util/s2c "${tail::1}"
-      local code=$ret
-      if ((code<32)); then
-        ble/util/c2s "$((code+64))"
-        ret=$sgr1^$ret$sgr0
-      elif ((code==127)); then
-        ret=$sgr1^?$sgr0
-      elif ((128<=code&&code<160)); then
-        ble/util/c2s "$((code-64))"
-        ret=${sgr1}M-^$ret$sgr0
+      ble/util/s2c "${tail::1}"; local code=$ret
+      if ble/unicode/GraphemeCluster/ControlRepresentation "$ret"; then
+        ret=$sgr1$ret$sgr0
       else
         ret=${tail::1}
       fi