// 该辅助函数最后返回一个 plugin 插件
export function buildInputRules(schema: Schema) {
  // 将所创建的输入规则实例「整合」在一个数组 rules 里面
  let rules = smartQuotes.concat(ellipsis, emDash), type
  // 这里需要判断 schema 里是否有提供相应的节点类型，才在 rules 数组里添加相应的输入规则
  if (type = schema.nodes.blockquote) rules.push(blockQuoteRule(type))
  if (type = schema.nodes.ordered_list) rules.push(orderedListRule(type))
  if (type = schema.nodes.bullet_list) rules.push(bulletListRule(type))
  if (type = schema.nodes.code_block) rules.push(codeBlockRule(type))
  if (type = schema.nodes.heading) rules.push(headingRule(type, 6))
  // 最后使用方法 inputRules({rules}) 创建一个 plugin 插件
  return inputRules({rules})
}

export function buildKeymap(schema: Schema, mapKeys?: {[key: string]: false | string}) {
  // 初始化一个空的对象 keys，以键值对的形式将按键和指令进行匹配
  let keys: {[key: string]: Command} = {}, type

  // 函数 bind 将快捷键名称 key 和指令 cmd 相「绑定」
  function bind(key: string, cmd: Command) {
    // 会根据参数 mapKeys 判断是否需要对当前的快捷键进行调整
    if (mapKeys) {
      // 当 mapKeys 中包含该快捷键 key
      let mapped = mapKeys[key]
      // 如果该快捷键在 mapKeys 中映射值为 false，则表示取消快捷键，则直接返回，不执行后续的绑定操作
      if (mapped === false) return
      // 如果该快捷键在 mapKeys 中映射为其他快捷键，则调整快捷键名称
      if (mapped) key = mapped
    }
    // 为对象 keys 添加该快捷键与指令的映射关系
    keys[key] = cmd
  }

  // 💡 使用 Mod- 作为 MacOS 系统上 Cmd- 与其他系统上的 Ctrl- 的通用别名

  // 将 Mod-z 快捷键绑定 undo 指令（撤销修改）
  bind("Mod-z", undo)
  // 将 Shift-Mod-z 快捷键绑定 redo 指令（重做修改）
  bind("Shift-Mod-z", redo)
  // 将 Backspace 快捷键绑定 undoInputRule 指令（以撤销由输入规则所触发的转换操作，而且该操作是编辑器的最后一次执行的转换操作）
  bind("Backspace", undoInputRule)

  // 如果用户的系统不是 Mac，则将 Mod-y 快捷键绑定 redo 指令（重做修改）
  if (!mac) bind("Mod-y", redo)

  // 将 Alt-ArrowUp 快捷键绑定 joinUp 指令（将当前 block 块节点与前面相邻的兄弟节点相融合）
  bind("Alt-ArrowUp", joinUp)
  // 将 Alt-ArrowDown 快捷键绑定 joinDown 指令（将当前 block 块节点与后面相邻的兄弟节点相融合）
  bind("Alt-ArrowDown", joinDown)
  // 将 Mod-BracketLeft 快捷键绑定 lift 指令（提升 lift 当前选中节点的层级，将它移出父节点）
  // 💡 BracketLeft 是指键盘上的左方括号键 [
  bind("Mod-BracketLeft", lift)
  // 将 Escape 快捷键绑定 selectParentNode 指令
  bind("Escape", selectParentNode)

  if (type = schema.marks.strong) {
    // 如果 schema 支持 strong 加粗样式标记
    // 则将 Mod-b 和 Mod-B 快捷键绑定 toggleMark(schema.marks.strong) 指令（切换加粗样式）
    bind("Mod-b", toggleMark(type))
    bind("Mod-B", toggleMark(type))
  }

  if (type = schema.marks.em) {
    // 如果 schema 支持 em 斜体样式标记
    // 则将 Mod-i 和 Mod-I 快捷键绑定 toggleMark(schema.marks.em) 指令（切换斜体样式）
    bind("Mod-i", toggleMark(type))
    bind("Mod-I", toggleMark(type))
  }

  // 如果 schema 支持 code 代码样式标记
  // 则将 Mod-` 快捷键绑定 toggleMark(schema.marks.code) 指令（切换代码样式）
  if (type = schema.marks.code)
    bind("Mod-`", toggleMark(type))

  // 如果 schema 支持 bullet_list 无序列表节点
  // 则将 Shift-Ctrl-8 快捷键绑定 wrapInList(schema.nodes.bullet_list) 指令（将用户选中的内容所在的块节点包裹进无序列表节点里）
  if (type = schema.nodes.bullet_list)
    bind("Shift-Ctrl-8", wrapInList(type))

  // 如果 schema 支持 ordered_list 有序列表节点
  // 则将 Shift-Ctrl-9 快捷键绑定 wrapInList(schema.nodes.ordered_list) 指令（将用户选中的内容所在的块节点包裹进有序列表节点里）
  if (type = schema.nodes.ordered_list)
    bind("Shift-Ctrl-9", wrapInList(type))

  // 如果 schema 支持 blockquote 引文节点
  // 则将 Ctrl-> 快捷键绑定 wrapIn(schema.nodes.blockquote) 指令（将用户选中的内容所在的块节点包裹进引文节点里）
  // ⚠️ 在 Windows 系统中该快捷键是 Shift-Ctrl->
  if (type = schema.nodes.blockquote)
    bind("Ctrl->", wrapIn(type))

  if (type = schema.nodes.hard_break) {
    // 如果 schema 支持 hard_break 换行节点
    let br = type;
    // 使用方法 chainCommands 将给定的一系列指令封装为一个新的指令
    // 依次执行 exitCode 指令（由于在代码类型的节点中，不能插入换行节点，需要先跳出该节点），然后将选区内容替换为新建的换行节点，最后将光标滚动到视图中
    let cmd = chainCommands(exitCode, (state, dispatch) => {
      if (dispatch) dispatch(state.tr.replaceSelectionWith(br.create()).scrollIntoView())
      return true
    })

    // 则将 Mod-Enter 和 Shift-Enter（如果用户的系统是 Mac 还将 Ctrl-Enter）快捷键绑定前面所构建的 cmd 指令（插入 <br/> 进行硬换行）
    bind("Mod-Enter", cmd)
    bind("Shift-Enter", cmd)
    if (mac) bind("Ctrl-Enter", cmd)
  }

  if (type = schema.nodes.list_item) {
    // 如果 schema 支持 list_item 列表项节点
    // 则将 Enter 快捷键绑定 splitListItem(schema.nodes.list_item) 指令（分割列表项的直接子节点的内容）
    bind("Enter", splitListItem(type))
    // 则将 Mod-[ 快捷键绑定 liftListItem(schema.nodes.list_item) 指令（将选中的列表项的内容往上提升一级，跳出当前列表）
    bind("Mod-[", liftListItem(type))
    // 则将 Mod-] 快捷键绑定 sinkListItem(schema.nodes.list_item) 指令（将选中的列表项内容往内缩进一级，到一个嵌套列表中去）
    bind("Mod-]", sinkListItem(type))
  }

  // 如果 schema 支持 paragraph 段落节点
  // 则将 Shift-Ctrl-0 快捷键绑定 setBlockType(schema.nodes.paragraph) 指令（将选区所在的 textblock 文本块转换为段落节点）
  // ⚠️ 在 Windows 系统中似乎无效
  if (type = schema.nodes.paragraph)
    bind("Shift-Ctrl-0", setBlockType(type))

  // 如果 schema 支持 code_block 代码块节点
  // 则将 Shift-Ctrl-\\ 快捷键绑定 setBlockType(schema.nodes.code_block) 指令（将选区所在的 textblock 文本块转换为代码块节点）
  // 💡 \\ 第一个 \ 符号是转义符 ❓ 第二个 \ 符号表示反斜杠
  if (type = schema.nodes.code_block)
    bind("Shift-Ctrl-\\", setBlockType(type))

  // 如果 schema 支持 heading 标题节点
  // 则依次将 Shift-Ctrl-i（其中 i 表示与标题级别相应的数字）快捷键绑定 setBlockType(type, {level: i}) 指令（将选区所在的 textblock 文本块转换为相应级别的标题节点）
  if (type = schema.nodes.heading)
    for (let i = 1; i <= 6; i++) bind("Shift-Ctrl-" + i, setBlockType(type, {level: i}))

  // 如果 schema 支持 horizontal_rule 水平线节点
  if (type = schema.nodes.horizontal_rule) {
    let hr = type

    // 则将 Mod-_ 快捷键绑定到所构造的指令（将选区内容替代为新建的水平线节点，然后将光标滚动到视图中）
    bind("Mod-_", (state, dispatch) => {
      if (dispatch) dispatch(state.tr.replaceSelectionWith(hr.create()).scrollIntoView())
      return true
    })
  }

  // 最后返回对象 keys，它以键值对的形式将按键和指令进行匹配
  return keys
}