BATsh 速查表 [ZH] 简体中文
==========================

----------------------------------------------------------------------
概要
  BATsh 是一个双语 shell，可在同一脚本文件中运行 cmd.exe 批处理与
  bash/sh 语法。它按行/按节自动切换模式。
  无需外部 shell —— 纯 Perl 实现。
  支持管道、重定向、函数以及变量展开扩展。

混合模式示例
  :: CMD 节（首个标记为大写）
  @ECHO OFF
  SET LANG=BATsh
  SET COUNT=3

  # SH 节（首个标记为小写）
  greet() { echo "Hello from $1 (bash mode)"; }
  greet $LANG
  for i in 1 2 3; do echo "  item $i of $COUNT"; done
  result=$(echo $LANG | perl -ne "print uc")
  echo "Uppercase: $result"

  :: 再次进入 CMD 节（经桥接读取 SH 的结果）
  ECHO Back in CMD: %result%

  # 运行方式： perl lib/BATsh.pm script.batsh
  # 或者：     use BATsh; BATsh->run('script.batsh');
----------------------------------------------------------------------


BATsh 是一个双语 shell，可在同一脚本中运行 cmd.exe 与 bash/sh 语法。
脚本被划分为若干节；每一节都由相应的 shell 原样执行。

1. 模式检测
-----------
  一个节的首个有效行的「首个标记」决定由哪个 shell 执行该节：

  CMD 模式：首个标记完全由 [A-Z 0-9 _ - \ / : . @ %] 组成，
            且至少包含一个大写字母 A-Z。

    ECHO hello          -> CMD 节 (cmd.exe)
    SET FOO=bar baz     -> CMD 节  （不检测取值部分）
    @ECHO OFF           -> CMD 节
    IF "%X%"=="Y" (     -> CMD 节

  SH 模式：其他任何情形（含小写字母，或完全不含字母）。

    echo hello          -> SH 节  (bash/sh)
    export FOO=bar      -> SH 节
    if [ -f "$f" ]; then  -> SH 节
    #!/bin/sh           -> SH 节  （shebang 属于 SH 行）

  注释与空行被并入当前节。
  注释语法：
    ::           CMD 风格注释
    REM ...      CMD 风格注释（不区分大小写）
    @REM ...     CMD 风格注释
    # ...        SH 风格注释  （不含 #! shebang）

2. 启动 Shell
-------------
  perl lib/BATsh.pm               # 交互式 REPL
  perl lib/BATsh.pm script.batsh  # 运行脚本文件
  perl lib/BATsh.pm -e "echo hi"  # 内联单行命令

  从 Perl 调用：
    use BATsh;
    BATsh->run('script.batsh');
    BATsh->run_string("echo hello");
    BATsh->repl();

3. 环境变量桥接
---------------
  在每一节运行之前，BATsh 会将当前的 %ENV 作为前导注入（CMD 用 SET 行，
  SH 用 export 行）。该节结束后，shell 的最终环境会被读回到 %ENV。

  export FOO=hello   # SH 设置 FOO
  ECHO %FOO%         # CMD 经桥接读取 FOO（Windows）

  SET BAR=world      # CMD 设置 BAR
  echo $BAR          # SH 经桥接读取 BAR

4. SETLOCAL / ENDLOCAL
----------------------
  SETLOCAL           # 对 %ENV 拍快照（由 BATsh 处理，而非 cmd.exe）
  SET TMP=local_val
  ECHO %TMP%
  ENDLOCAL           # 恢复 %ENV（TMP 消失）

  作用域可以嵌套。

5. 节边界检测
-------------
  当节的块深度归零，且下一有效行属于不同模式时，该节结束。

  CMD 节跟踪引号外的 ( 与 ) 的深度：

    IF "%X%"=="Y" (     <- 打开块（深度 1）
        ECHO yes
    ) ELSE (            <- 关闭并重新打开（深度保持 >=1）
        ECHO no
    )                   <- 关闭块（深度 0）-> 节可能结束

  SH 节跟踪关键字深度：

    for x in 1 2; do   <- 打开块（深度 1）
        echo $x
    done                <- 关闭块（深度 0）-> 节可能结束

  即便处于打开块内的行其首个标记看起来像另一种模式，也会被并入当前节。
  这样便允许：

    for x in A B; do
        ECHO $x          <- SH 块内的大写：仍为 SH 节
    done

  SH 关键字配对：
    开启者 (+1)：if  for  while  until  case  function  select  {
    闭合者 (-1)：fi  done  esac  }
    中性   ( 0)：then  do  else  elif

6. 子例程定义
-------------
  :GREET
  echo "Hello $BATSH_ARG1"
  RET

  标签以 : 开头，以 RET 或 RETURN 结尾。
  函数体在执行前被提取（不会内联运行）。
  函数体可包含 CMD 行、SH 行，或两者混合。

7. CALL 与 source
-----------------
  CALL :GREET world      # 带参数调用子例程
  CALL other.batsh       # 包含/运行另一个 .batsh 文件（CMD）
  source other.batsh     # 包含/运行另一个 .batsh 文件（SH）
  . other.batsh          # POSIX 点号写法

  参数：$BATSH_ARG1 .. $BATSH_ARGn  （CMD 中为 %BATSH_ARG1%）
  个数：$BATSH_ARGC

8. Perl API
-----------
  BATsh->run($file)            # 运行 .batsh 文件
  BATsh->run_string($source)   # 运行源字符串
  BATsh->run_lines(@lines)     # 运行行数组
  BATsh->repl()                # 交互式 REPL
  BATsh->classify_token($tok)  # 'CMD' 或 'SH'
  BATsh->setlocal()            # 对 %ENV 拍快照
  BATsh->endlocal()            # 恢复 %ENV
  BATsh->call_sub($lbl, @args) # 调用子例程
  BATsh->source_file($file)    # 包含 .batsh 文件
  BATsh->version()             # 版本字符串

9. 平台说明
-----------
  Windows：CMD 节与 SH 节均以纯 Perl 运行 —— 无需外部 cmd.exe、bash 或 sh。
  UNIX：   CMD 节与 SH 节均以纯 Perl 运行 —— 无需外部 cmd.exe、bash 或 sh。

10. 运行要求
------------
  Perl 5.005_03 或更高版本。  仅核心模块（File::Spec, Carp）。
  无 CPAN 依赖。

11. CMD 管道与参数修饰符
------------------------
  cmd1 | cmd2              # 经由临时文件的管道（纯 Perl）
  ECHO hello | perl -e "while(<STDIN>){print uc}"

  SET /P VAR=Prompt:       # 从 STDIN 读取一行存入 VAR

  批处理参数波浪号修饰符（例如当 %0=C:\scripts\deploy.bat 时）：
    %~0   -> C:\scripts\deploy.bat  （仅去引号）
    %~f0  -> C:/scripts/deploy.bat  （完整绝对路径）
    %~d0  -> C:                     （驱动器盘符）
    %~p0  -> /scripts/              （目录路径）
    %~n0  -> deploy                 （不含扩展名的文件名）
    %~x0  -> .bat                   （扩展名）
    %~dp0 -> C:/scripts/            （驱动器 + 目录，最常用）
    %~nx1 -> deploy.bat             （文件名 + 扩展名）

12. SH 函数与展开
-----------------
  greet() {              # 函数定义
      echo "Hi $1"
  }
  function add {         # 备用语法
      echo $(( $1 + $2 ))
  }
  greet world            # 调用函数
  add 3 4                # -> 7

  ${var%.*}    删除匹配 .* 的最短后缀
  ${var%%.*}   删除匹配 .* 的最长后缀
  ${var#*.}    删除匹配 *. 的最短前缀
  ${var##*.}   删除匹配 *. 的最长前缀
  ${var/a/b}   将首个 a 替换为 b
  ${var//a/b}  将全部 a 替换为 b
  ${var^^}     全部转为大写
  ${var,,}     全部转为小写
  ${var:2:4}   从偏移量 2 起、长度 4 的子串
  ${#var}      字符串长度
  ${var:-def}  若已设置则取其值，否则取 def

13. SH 输入输出重定向
---------------------
  cmd > file      覆盖写入 stdout
  cmd >> file     追加写入 stdout
  cmd < file      从文件读取 stdin
  cmd 2> file     stderr 写入文件
  cmd 2>&1        将 stderr 合并到 stdout
  cmd > f 2>&1    stdout 与 stderr 均写入文件

  Here-document（在 stdin 上输入）：
    cmd <<EOF       直至 EOF 的正文行；展开 $VAR
    cmd <<'EOF'     直至 EOF 的正文行；不展开（按字面）
    cmd <<-EOF      同 <<EOF，但去除行首的 TAB 字符

14. SH 复合命令
---------------
  cmd1 && cmd2    仅当 cmd1 成功时运行 cmd2
  cmd1 || cmd2    仅当 cmd1 失败时运行 cmd2
  cmd1 ; cmd2     无条件运行 cmd2

15. SH 数组
-----------
  arr=(a b c)            # 索引数组字面量
  arr+=(d e)             # 追加元素
  arr[5]=x               # 按索引赋值
  declare -a list        # 声明索引数组
  declare -A map         # 声明关联数组
  map[key]=value         # 关联数组赋值
  map=([k1]=v1 [k2]=v2)  # 关联数组字面量

  ${arr[0]}    第0个元素  ($arr 等同于 ${arr[0]})
  ${arr[-1]}   最后一个元素
  ${arr[@]}    全部元素(按词分割)
  ${arr[*]}    全部元素(单个词)
  ${#arr[@]}   元素个数
  ${#arr[2]}   元素2的长度
  ${!arr[@]}   索引(或键)列表
  unset arr[1] # 删除一个元素
  unset arr    # 删除整个数组

16. SH case 语句
----------------
  case $x in
      a|b|c)      echo "a、b 或 c" ;;    # |  -- 多个模式
      [0-9])      echo "一个数字"    ;;    # [..]  字符类
      [!aeiou])   echo "辅音"      ;;    # [!..] 否定字符类
      data*)      echo "前缀"      ;;    # *  和  ?  通配
      "*")        echo "星号"      ;;    # 加引号=字面匹配
      *)          echo "默认"      ;;    # *)  兜底子句
  esac

  子句终止符(每个主体之后):
    ;;    在此停止(通常情形)
    ;&    贯穿执行下一个子句主体
    ;;&   继续测试其余模式

17. SH trap 与信号
------------------
  trap 'echo bye' EXIT       # 脚本结束(或 exit)时运行
  trap 'rm -f $tmp' EXIT     # 处理器在触发时展开
  trap 'echo got INT' INT    # 通过 %SIG 桥接真实信号
  trap '' INT                # 忽略该信号
  trap - INT                 # 恢复默认动作
  trap                       # 列出当前 trap(也可: trap -p)

  SIGSPEC: 名称(INT 或 SIGINT)、编号(2)或 EXIT(= 0)。
  EXIT 在结束时运行一次；真实信号名会安装 Perl %SIG 处理器。

另见： https://metacpan.org/dist/BATsh
