# tp.el - Emacs 文本属性操作库

<p align="center">
  <strong>一个功能强大的文本属性操作库，具有创新的图层系统</strong>
</p>

<p align="center">
  <a href="#功能特性">功能特性</a> •
  <a href="#安装">安装</a> •
  <a href="#快速开始">快速开始</a> •
  <a href="#api-参考">API 参考</a> •
  <a href="#图层系统">图层系统</a>
</p>

---

**tp.el** 提供了一个便捷统一的 API 来操作 Emacs 文本属性。灵感来自用于叠加层的 [ov.el](https://github.com/emacsorphanage/ov)，tp.el 提供：

- **统一 API**：所有属性设置函数同时支持 **字符串** 和 **缓冲区**
- **图层系统**：在同一文本区域上堆叠多组属性
- **模式匹配**：将属性应用到匹配字符串或正则表达式的文本

## 功能特性

- ✅ **统一对象支持**：`tp-set`、`tp-match`、`tp-regexp` 等函数同时支持字符串和缓冲区
- ✅ **清晰语义**：`tp-reset`（替换全部）、`tp-set`（替换指定）、`tp-add`（深度合并）
- ✅ **嵌套属性访问**：使用路径语法获取/设置/移除嵌套子属性
- ✅ **创新图层系统**：堆叠、轮换和管理多层属性
- ✅ **图层组**：定义可复用的相关图层集合
- ✅ **搜索和导航**：查找并导航带属性的文本
- ✅ **模式匹配**：将属性应用到字符串/正则匹配，支持 reset/add 变体
- ✅ **简洁 API**：一致的命名和调用约定

## 系统要求

- **Emacs 28.1+**（使用 `object-intervals` 函数）
- **dash.el**（列表操作工具库）

## 安装

```elisp
;; 添加到 load-path
(add-to-list 'load-path "/path/to/tp")
(require 'tp)
```

或使用 `use-package`：

```elisp
(use-package tp
  :load-path "/path/to/tp")
```

---

## 快速开始

### 设置属性

tp.el 提供三个主要的属性设置函数，每个有不同的语义：

```elisp
;; tp-set: 只替换指定的属性，保留其他属性
(tp-set 1 10 '(face bold help-echo "Hello!"))

;; tp-reset: 完全替换所有属性
(tp-reset 1 10 '(face bold))  ; 其他任何属性都会被移除

;; tp-add: 深度合并嵌套属性
(tp-add 1 10 '(face (:underline t)))  ; 与现有 face 合并
```

这三个函数都支持四种调用约定：

```elisp
;; 在当前缓冲区（属性作为列表）
(tp-set 1 10 '(face bold help-echo "Hello!"))

;; 在特定缓冲区
(tp-set 1 10 '(face bold) some-buffer)

;; 在字符串上（0 索引）
(tp-set 0 5 '(face bold) "Hello World")
;; => #("Hello World" 0 5 (face bold))

;; 在整个字符串上（平铺属性）
(tp-set "Hello World" 'face 'bold 'help-echo "test")
;; => #("Hello World" 0 11 (face bold help-echo "test"))
```

### 单属性设置器

```elisp
;; 只设置 face 属性
(tp-set-face 1 10 'bold)
(tp-set-face "Hello" 'italic)  ; 整个字符串

;; 只设置 display 属性
(tp-set-display 1 10 '(space :width 10))
```

### 获取属性

```elisp
;; 获取特定位置的属性
(tp-get 5 'face)  ; => bold

;; 获取嵌套子属性
(tp-get 5 'face :foreground)  ; => "red"
(tp-get 5 'face :box :color)  ; => "blue"（深度嵌套）

;; 获取范围内的特定属性
(tp-get 1 10 'face)  ; => bold

;; 获取范围内的所有属性
(tp-get 1 10)  ; => (face bold help-echo "Hello!")

;; 获取该位置的所有属性
(tp-at 5)  ; => (face bold help-echo "Hello!")
```

### 移除属性

```elisp
;; 移除整个属性
(tp-remove 1 10 'face)

;; 移除子属性
(tp-remove 1 10 '(face :underline))

;; 移除嵌套子属性（保留其他）
(tp-remove 1 10 '(face :underline (:style :position)))
;; 从 :underline 中移除 :style 和 :position，如果存在 :color 则保留
```

### 模式匹配

```elisp
;; 将属性应用到缓冲区中所有 "TODO" 出现的位置
(tp-match "TODO" '(face warning))

;; 应用到字符串
(tp-match "world" "Hello world world" '(face bold))
;; => #("Hello world world" 6 11 (face bold) 12 17 (face bold))

;; 使用 (PATTERN STRING) 格式匹配
(tp-match '("world" "Hello world") '(face bold))
;; => #("Hello world" 6 11 (face bold))

;; 使用正则表达式
(tp-regexp "\\b[0-9]+\\b" '(face font-lock-number-face))

;; reset 变体（替换匹配处的所有属性）
(tp-match-reset "TODO" '(face warning))
(tp-regexp-reset "[0-9]+" '(face bold))

;; add 变体（深度合并匹配处的属性）
(tp-match-add "TODO" '(face (:underline t)))
(tp-regexp-add "[0-9]+" '(face (:weight bold)))
```

---

## API 参考

### 核心属性函数

#### `tp-set` - 设置文本属性

在字符串或缓冲区区域上设置文本属性。只替换指定的属性，保留其他属性。

```elisp
;; 当前缓冲区（属性作为列表）
(tp-set START END '(PROPERTY VALUE ...))

;; 特定缓冲区或字符串
(tp-set START END '(PROPERTY VALUE ...) OBJECT)

;; 整个字符串（平铺属性）
(tp-set STRING PROPERTY VALUE ...)
```

**示例：**

```elisp
;; 在缓冲区区域设置 face
(tp-set 1 10 '(face bold))  ; => (1 . 10)

;; 设置多个属性
(tp-set 1 10 '(face bold help-echo "Click me"))

;; 在特定缓冲区设置
(tp-set 1 10 '(face italic) my-buffer)

;; 在字符串上设置属性（0 索引）
(setq my-string (tp-set 0 5 '(face italic) "Hello World"))
;; => #("Hello World" 0 5 (face italic))

;; 在整个字符串上设置属性
(tp-set "Hello" 'face 'bold 'mouse-face 'highlight)
;; => #("Hello" 0 5 (face bold mouse-face highlight))
```

---

#### `tp-reset` - 替换所有属性

用指定的属性完全替换所有文本属性。

```elisp
(tp-reset START END '(PROPERTY VALUE ...) &optional OBJECT)
(tp-reset STRING PROPERTY VALUE ...)
```

**示例：**

```elisp
;; 替换区域中的所有属性
(tp-reset 1 10 '(face bold))  ; 任何现有属性都会被移除

;; 在字符串上
(tp-reset "Hello" 'face 'italic)
```

---

#### `tp-add` - 添加/合并属性

添加或更新属性，支持嵌套属性列表的深度合并。

```elisp
(tp-add START END '(PROPERTY VALUE ...) &optional OBJECT)
(tp-add STRING PROPERTY VALUE ...)
```

**示例：**

```elisp
;; 添加属性（保留现有，合并嵌套）
(tp-add 1 10 '(help-echo "tooltip"))

;; 深度合并 face 属性
(tp-set 1 10 '(face (:foreground "red")))
(tp-add 1 10 '(face (:background "blue")))
;; 结果: face 是 (:foreground "red" :background "blue")
```

---

#### `tp-set-face` - 设置 Face 属性

只设置 face 属性，保留其他属性。

```elisp
(tp-set-face START END FACE &optional OBJECT)
(tp-set-face STRING FACE)
```

**示例：**

```elisp
(tp-set-face 1 10 'bold)
(tp-set-face 1 10 '(:foreground "red" :weight bold))
(tp-set-face "Hello" 'italic)
```

---

#### `tp-set-display` - 设置 Display 属性

只设置 display 属性，保留其他属性。

```elisp
(tp-set-display START END DISPLAY &optional OBJECT)
(tp-set-display STRING DISPLAY)
```

**示例：**

```elisp
(tp-set-display 1 10 '(space :width 10))
(tp-set-display "  " '(space :width 20))
```

---

#### `tp-get` - 获取属性值

从位置或范围获取属性值，支持嵌套子属性访问。

```elisp
;; 单个位置
(tp-get POSITION PROPERTY)
(tp-get POSITION PROPERTY OBJECT)

;; 嵌套子属性访问
(tp-get POSITION PROPERTY SUB-KEY ...)

;; 范围 - 特定属性
(tp-get START END PROPERTY)
(tp-get START END PROPERTY OBJECT)

;; 范围 - 所有属性
(tp-get START END)
(tp-get START END OBJECT)
```

**示例：**

```elisp
;; 从当前缓冲区获取
(tp-get 5 'face)           ; => bold

;; 获取嵌套子属性
(tp-get 5 'face :foreground)      ; => "red"
(tp-get 5 'face :box :color)      ; => "blue"
(tp-get 5 'display :width)        ; => 10

;; 从字符串获取（0 索引）
(tp-get 0 'face my-string) ; => italic

;; 从范围获取
(tp-get 1 10 'face)        ; => bold

;; 获取范围内的所有属性
(tp-get 1 10)              ; => (face bold help-echo "test")
```

---

#### 细粒度属性函数

用于操作复杂属性（如 `face` 或 `display`）内的子属性：

```elisp
;; 获取子属性
(tp-get-sub POSITION PROPERTY SUB-PROPERTY &optional OBJECT)

;; 设置子属性
(tp-put-sub START END PROPERTY SUB-PROPERTY VALUE &optional OBJECT)

;; 移除子属性
(tp-remove-sub START END PROPERTY SUB-PROPERTY &optional OBJECT)
```

**示例：**

```elisp
;; 获取 face 的 :foreground
(tp-get-sub 1 'face :foreground)  ; => "red"

;; 设置 face 的 :weight
(tp-put-sub 1 6 'face :weight 'bold)

;; 移除 face 的 :background
(tp-remove-sub 1 6 'face :background)
```

---

#### `tp-at` - 获取所有属性

```elisp
(tp-at &optional POINT OBJECT)
```

获取 POINT 位置的所有文本属性，返回属性列表。

**示例：**

```elisp
(tp-at 5)  ; => (face bold help-echo "test")
(tp-at 0 my-string)  ; 从字符串获取
```

---

#### `tp-remove` - 移除属性

从区域中移除属性或嵌套子属性。

```elisp
;; 移除整个属性
(tp-remove START END PROPERTY &optional OBJECT)

;; 移除子属性
(tp-remove START END '(PROPERTY SUB-KEY) &optional OBJECT)

;; 移除嵌套子属性
(tp-remove START END '(PROPERTY SUB-KEY (NESTED-KEYS...)) &optional OBJECT)
```

**示例：**

```elisp
;; 移除整个属性
(tp-remove 1 10 'face)

;; 从 face 移除子属性
(tp-remove 1 10 '(face :underline))

;; 移除特定嵌套键，保留其他
(tp-remove 1 10 '(face :underline (:style :position)))
;; 从 :underline 移除 :style 和 :position
;; 如果 :underline 中存在 :color，则保留
```

---

#### `tp-remove-list` - 移除多个属性

```elisp
(tp-remove-list START END PROPERTIES &optional OBJECT)
```

一次移除多个属性。

**示例：**

```elisp
(tp-remove-list 1 10 '(face help-echo mouse-face))
```

---

#### `tp-clear` - 清除所有属性

```elisp
(tp-clear &optional START END OBJECT)
```

清除区域中的所有文本属性。

**示例：**

```elisp
(tp-clear 1 10)     ; 清除区域
(tp-clear)          ; 清除整个缓冲区
```

---

### 模式匹配函数

#### `tp-match` - 匹配字符串

```elisp
;; 缓冲区
(tp-match PATTERN '(PROPERTY VALUE ...))

;; 字符串或缓冲区对象
(tp-match PATTERN OBJECT '(PROPERTY VALUE ...))

;; 使用 (PATTERN STRING) 格式
(tp-match '(PATTERN STRING) '(PROPERTY VALUE ...))
```

在所有字符串模式匹配处设置属性。

**示例：**

```elisp
;; 在缓冲区中 - 返回 (START . END) 对的列表
(tp-match "TODO" '(face warning))
;; => ((10 . 14) (50 . 54) ...)

;; 在字符串上 - 返回修改后的字符串
(tp-match "o" "Hello World" '(face bold))
;; => #("Hello World" 4 5 (face bold) 7 8 (face bold))

;; 使用 (PATTERN STRING) 格式
(tp-match '("world" "Hello world") '(face bold))
;; => #("Hello world" 6 11 (face bold))
```

---

#### `tp-match-reset` - 匹配并重置

重置（完全替换）匹配处的所有属性。

```elisp
(tp-match-reset PATTERN '(PROPERTY VALUE ...) &optional OBJECT)
```

**示例：**

```elisp
(tp-match-reset "TODO" '(face warning))
;; 替换匹配文本上的所有属性
```

---

#### `tp-match-add` - 匹配并添加

在匹配处添加/合并属性，支持深度合并。

```elisp
(tp-match-add PATTERN '(PROPERTY VALUE ...) &optional OBJECT)
```

**示例：**

```elisp
(tp-match-add "TODO" '(face (:underline t)))
;; 与现有属性合并
```

---

#### `tp-regexp` - 匹配正则表达式

```elisp
;; 缓冲区
(tp-regexp PATTERN '(PROPERTY VALUE ...))

;; 字符串或缓冲区对象
(tp-regexp PATTERN OBJECT '(PROPERTY VALUE ...))
```

在所有正则表达式匹配处设置属性。

**示例：**

```elisp
;; 高亮缓冲区中的所有数字
(tp-regexp "[0-9]+" '(face font-lock-number-face))

;; 在字符串上
(tp-regexp "[A-Z]+" "Hello WORLD" '(face bold))
;; => #("Hello WORLD" 6 11 (face bold))
```

---

#### `tp-regexp-reset` - 正则匹配并重置

重置（完全替换）正则匹配处的所有属性。

```elisp
(tp-regexp-reset PATTERN '(PROPERTY VALUE ...) &optional OBJECT)
```

---

#### `tp-regexp-add` - 正则匹配并添加

在正则匹配处添加/合并属性，支持深度合并。

```elisp
(tp-regexp-add PATTERN '(PROPERTY VALUE ...) &optional OBJECT)
```

---

### 属性化函数

#### `tp-layer-propertize` - 将图层应用到对象

```elisp
(tp-layer-propertize OBJECT LAYER &optional START END)
```

将预定义图层的属性应用到对象。

**示例：**

```elisp
;; 首先定义一个图层
(tp-layer-define highlight '(face (:background "yellow")))

;; 应用到字符串
(tp-layer-propertize "Important" 'highlight)

;; 应用到子字符串
(tp-layer-propertize "Hello World" 'highlight 0 5)

;; 应用到缓冲区区域
(tp-layer-propertize (current-buffer) 'highlight 1 10)
```

---

#### `tp-group-propertize` - 应用图层组

```elisp
(tp-group-propertize OBJECT LAYER-GROUP &optional START END)
```

将图层组中的所有图层应用到对象。

---

### 搜索和导航函数

#### `tp-forward` / `tp-backward`

```elisp
(tp-forward PROPERTY &optional VALUE PREDICATE NOT-CURRENT)
(tp-backward PROPERTY &optional VALUE PREDICATE NOT-CURRENT)
```

向前/向后搜索具有 PROPERTY 的文本。

**示例：**

```elisp
;; 查找下一个具有 'marker 属性的文本
(tp-forward 'marker)

;; 查找下一个 'type 等于 'heading 的文本
(tp-forward 'type 'heading)
```

---

#### `tp-next` / `tp-prev`

```elisp
(tp-next &optional POINT PROPERTY VALUE)
(tp-prev &optional POINT PROPERTY VALUE)
```

获取下一个/上一个具有文本属性的位置。

---

#### `tp-goto-next` / `tp-goto-prev`

```elisp
(tp-goto-next &optional PROPERTY VALUE)
(tp-goto-prev &optional PROPERTY VALUE)
```

将光标移动到下一个/上一个具有 PROPERTY 的文本。

---

#### `tp-regions-map` / `tp-strings-map`

```elisp
(tp-regions-map FUNCTION PROPERTY &optional VALUE PREDICATE COLLECT)
(tp-strings-map FUNCTION PROPERTY &optional VALUE PREDICATE COLLECT)
```

对所有具有 PROPERTY 的区域/字符串应用函数。

**示例：**

```elisp
;; 处理所有标记的文本
(tp-strings-map
 (lambda (str idx)
   (message "找到: %s，索引 %d" str idx))
 'marker)
```

---

### 查询函数

#### `tp-in` - 查找具有属性的区域

```elisp
(tp-in PROPERTY &optional VALUE START END)
```

获取当前缓冲区中所有具有 PROPERTY 的区域。

**示例：**

```elisp
;; 获取所有具有 'marker 属性的区域
(tp-in 'marker)
;; => ((1 5 (marker t ...)) (10 15 (marker t ...)))

;; 按值过滤
(tp-in 'type 'heading)
```

---

#### `tp-all` - 获取所有带属性的区域

```elisp
(tp-all &optional START END)
```

获取所有具有任何文本属性的区域。

---

#### `tp-intervals` - 获取属性区间

```elisp
(tp-intervals START END &optional OBJECT)
```

获取区域中所有文本属性区间。

---

#### `tp-empty-p` - 检查属性

```elisp
(tp-empty-p OBJECT)
```

如果 OBJECT 没有文本属性则返回 t。

---

#### `tp-plist` - 获取合并的属性

```elisp
(tp-plist START END &optional OBJECT)
```

获取区域中所有属性的合并属性列表。

---

## 图层系统

**图层系统**是 tp.el 的创新功能，允许在同一文本区域上堆叠多组属性。只有**顶层**可见，但下层会被保留，可以通过轮换或置顶来显示。

### 图层概念

```
┌─────────────────────────────┐
│   顶层（可见）              │  ← 你看到的
├─────────────────────────────┤
│   中间层（隐藏）            │  ← 被保留
├─────────────────────────────┤
│   底层（隐藏）              │  ← 被保留
└─────────────────────────────┘
```

### 图层定义函数

#### `tp-layer-define` - 定义图层

```elisp
(tp-layer-define NAME PROPERTIES)
```

定义一个带属性的命名图层。

**示例：**

```elisp
(tp-layer-define highlight
  '(face (:background "yellow" :foreground "black")))

(tp-layer-define error
  '(face (:background "red" :foreground "white")
    help-echo "错误!"))

(tp-layer-define info
  '(face (:background "blue" :foreground "white")))
```

---

#### `tp-group-define` - 定义图层组

```elisp
(tp-group-define NAME
  LAYER1 PROPERTIES1
  LAYER2 PROPERTIES2
  ...)
```

定义一组相关的图层。

**示例：**

```elisp
(tp-group-define status-colors
  status-ok      '(face (:foreground "green"))
  status-warning '(face (:foreground "orange"))
  status-error   '(face (:foreground "red")))
```

---

#### `tp-layer-props` / `tp-group-props`

```elisp
(tp-layer-props LAYER-NAME)
(tp-group-props GROUP-NAME)
```

获取图层或图层组中所有图层的属性。

---

#### `tp-layer-undefine` / `tp-group-undefine`

```elisp
(tp-layer-undefine NAME)
(tp-group-undefine NAME)
```

移除图层或图层组定义。

---

#### `tp-layer-reset`

```elisp
(tp-layer-reset)
```

清除所有图层和图层组定义。

---

### 图层操作函数

#### `tp-layer-push` - 添加图层

```elisp
(tp-layer-push START END NAME &optional OBJECT)
```

将图层推到堆栈顶部。

**示例：**

```elisp
(tp-layer-define base '(face default))
(tp-layer-define highlight '(face (:background "yellow")))

;; 首先推入 base 图层
(tp-layer-push 1 10 'base)

;; 将 highlight 推到顶部（现在可见）
(tp-layer-push 1 10 'highlight)
```

---

#### `tp-layer-delete` - 删除图层

```elisp
(tp-layer-delete START END NAME &optional OBJECT)
```

从堆栈任何位置删除图层。

**示例：**

```elisp
;; 删除 highlight 图层
(tp-layer-delete 1 10 'highlight)
;; base 图层现在可见
```

---

#### `tp-layer-rotate` - 轮换图层

```elisp
(tp-layer-rotate START END &optional OBJECT)
```

轮换图层 - 顶层移到底部，下一层变为可见。

**示例：**

```elisp
;; 堆栈: highlight (顶) -> base (底)
(tp-layer-rotate 1 10)
;; 堆栈: base (顶) -> highlight (底)
```

---

#### `tp-layer-pin` - 将图层置顶

```elisp
(tp-layer-pin START END NAME &optional OBJECT)
```

将特定图层移到顶部。

**示例：**

```elisp
;; 将 'base 设为顶层
(tp-layer-pin 1 10 'base)
```

---

#### `tp-layer-hide` / `tp-layer-show`

```elisp
(tp-layer-hide START END NAME &optional OBJECT)
(tp-layer-show START END NAME &optional OBJECT)
```

隐藏图层（移到底部）或显示图层（移到顶部）。

---

#### `tp-layer-merge`

```elisp
(tp-layer-merge START END LAYER1 LAYER2 NEW-NAME &optional OBJECT)
```

将两个图层合并为一个新图层。

---

### 图层查询函数

#### `tp-layer-list` - 列出所有图层

```elisp
(tp-layer-list START END &optional OBJECT)
```

获取区域中所有图层名称的列表。

**示例：**

```elisp
(tp-layer-list 1 10)  ; => (highlight base)
```

---

#### `tp-layer-count`

```elisp
(tp-layer-count START END &optional OBJECT)
```

计算区域中的图层数量。

---

#### `tp-layer-exists-p`

```elisp
(tp-layer-exists-p START END NAME &optional OBJECT)
```

检查区域中是否存在某图层。

---

#### `tp-layer-top`

```elisp
(tp-layer-top START END &optional OBJECT)
```

获取顶层（可见）图层的名称。

---

## 实用示例

### 多图层语法高亮

```elisp
;; 为不同高亮目的定义图层
(tp-layer-define code-base
  '(face font-lock-keyword-face))

(tp-layer-define code-error
  '(face (:underline (:color "red" :style wave))
    help-echo "语法错误"))

(tp-layer-define code-debug
  '(face (:background "dark blue")))

;; 应用基础高亮
(tp-layer-push 1 100 'code-base)

;; 在有问题的代码上添加错误高亮
(tp-layer-push 50 60 'code-error)

;; 在错误和正常视图之间切换
(defun toggle-error-view ()
  (interactive)
  (tp-layer-rotate 50 60))
```

### 状态指示器

```elisp
(tp-group-define task-status
  status-todo     '(face (:foreground "gray"))
  status-progress '(face (:foreground "yellow"))
  status-done     '(face (:foreground "green")))

;; 循环切换状态
(defun cycle-task-status ()
  (interactive)
  (tp-layer-rotate (line-beginning-position) (line-end-position)))
```

### 临时高亮

```elisp
(tp-layer-define temp-highlight
  '(face (:background "yellow")))

(defun flash-region (start end)
  "临时闪烁一个区域。"
  (tp-layer-push start end 'temp-highlight)
  (run-with-timer 0.5 nil
                  (lambda ()
                    (tp-layer-delete start end 'temp-highlight))))
```

---

## 别名

为方便使用，tp.el 提供以下别名：

| 别名 | 原函数 |
|------|--------|
| `tp-put` | `tp-set` |
| `tp-layer-properties` | `tp-layer-props` |
| `tp-layer-group-define` | `tp-group-define` |
| `tp-layer-group-properties` | `tp-group-props` |
| `tp-layer-group-propertize` | `tp-group-propertize` |
| `tp-layer-group-undefine` | `tp-group-undefine` |

### 已弃用函数

| 函数 | 替代 | 说明 |
|------|------|------|
| `tp-propertize` | `tp-set` | 新代码请使用 `tp-set` |

---

## 许可证

GNU 通用公共许可证 v2 或更高版本。

---

## 贡献

欢迎贡献！请随时提交 issues 或 pull requests。

---

<p align="center">
  <em>tp.el - 让文本属性变得强大且易用</em>
</p>