trimer小知识(2) 配置文件中的一些yaml语法

yaml小知识

Yaml简介

首先，yaml的全称 Yaml Ain't Markup Language。即Yaml不是标记语言,这是针对XML而言的，即Yaml中不需要使用标签。 注: Ain't是am not的缩写,后来又变成isn't等否定的缩写

YAML is a human friendly data serialization standard for all programming languages.

官方给的定义是，Yaml是一种可读的数据序列化标准。

简单的讲，就是yaml就是一种描述各种结构化数据的纯文本语言。与它同样地位的，可以相互类比的是xml和json。 关于这三者的比较，可以看这里 序列化格式：XML、JSON、YAML

数据表示方法

Yaml是如何描述数据的结构呢？主要有以下三条:

• Structure通过空格来展示,即通过缩进来表示包含关系，也可以通过[]和{}后面有介绍
• Sequence里的项用"-"来代表
• Map里的键值对用":"分隔.

  qwerty:
    ascii_mode: 0
    author: "osfans <[email protected]>"
    height: 55
    keys: [{click: q, long_click: "!", swipe_up: 1}, {click: w, long_click: "@", swipe_up: 2}, {click: e, long_click: "#", swipe_up: 3}, {click: r, long_click: "$", swipe_up: 4}, {click: t, long_click: "%", swipe_up: 5}, {click: y, long_click: "^", swipe_up: 6}, {click: u, long_click: "&", swipe_up: 7}, {click: i, long_click: "*", swipe_up: 8}, {click: o, long_click: "(", swipe_up: 9}, {click: p, long_click: ")", swipe_up: 0}, {width: 5}, {click: a, long_click: select_all, swipe_down: Down, swipe_left: Left, swipe_right: Right, swipe_up: Up}, {click: s, long_click: "~", swipe_down: Page_Down, swipe_left: Home, swipe_right: End, swipe_up: Page_Up}, {click: d, long_click: "-", swipe_down: _}, {click: f, long_click: "+", swipe_down: "="}, {click: g, long_click: "\\", swipe_down: "|"}, {click: h, long_click: "[]", swipe_left: "[", swipe_right: "]"}, {click: j, long_click: "{}", swipe_left: "{", swipe_right: "}"}, {click: k, long_click: ":"}, {click: l, long_click: ";"}, {width: 5}, {click: Shift_L, composing: "'", send_bindings: true, width: 15}, {click: z, long_click: "`"}, {click: x, long_click: cut}, {click: c, long_click: copy}, {click: v, long_click: paste}, {click: b, long_click: Time, swipe_up: Date}, {click: n, long_click: "\""}, {click: m, long_click: "'"}, {click: BackSpace, width: 15}, {click: Mode_switch, long_click: Menu, width: 15}, {click: Keyboard_symbols, long_click: Keyboard_number}, {click: ",", long_click: "<", paging: Page_Up}, {click: space, width: 30}, {click: ., has_menu: Page_Down, long_click: ">"}, {click: "/", long_click: "?"}, {click: Return, long_click: CommitComment, width: 15}]

上面的文件定义了一个名叫qwerty的映射，这个映射包含几个个字段:

• ascii_mode
• author
• height
• keys :　这是一个复合类型，其中包含了多个按键，每个按键，又包含多个属性值

每个字段的取值，在冒号后面指定。 其中keys是一个复合字段，它本身又是一个列表，它包含多个键值。另外，每个键值，又是一个字典(又叫映射)，包含多个属性值对。

列表和字典的区别在于，列表是有序的，而字典是无序的。上面的keys要表示键盘每个键的排列，所以必须是有序的排列。 而每个key的属性值，只是标明各个属性，并不需要有序。

上面为了简洁，上面的keys以单行模式写出，如果展开会是

  qwerty:
    keys:
      - {click: q, long_click: "!", swipe_up: 1}
      - {click: w, long_click: "@", swipe_up: 2}
  ...

进一步展开会变成:

  qwerty:
    keys:
      -
        click: q
        long_click: "!"
        swipe_up: 1
      -
        click: w
        long_click: "@"
        swipe_up: 2

从上面，我们可以看出列表和映射的两种表示方法：

列表的单行与展开模式: 单行模式: name: [value1, value2] 展开模式:

name:
  - value1
  - value2

映射的单行与展开模式: 单行模式: name: {p1: n1, p2: n2} 展模式:

name:
  p1: n1
  p2: n2

数据引用方式

打patch时，需要先取得准备修改的属性，然后才能对其进行修改。

参见晓群老师，给我的示例，

"preset_keyboards/qwerty/keys/@31": {label: "英", click: Keyboard_default}

总结如下：

列表数据的引用: 通过@下标，引用 。（这个语法的详细介绍，我没有查到，是我们自己内部的约定吗？）

映射数据的引用: "/"一层一层的引用

另外，网上还有数据引用和合并的介绍，但是我还没有验证，在我们程序中是否可行。

可以使用&符号定义一个引用标签，使用符号*引用这个标签的数据，使用符号<<进行hash值合并操作，例如：

# sequencer protocols for Laser eye surgery
---
- step:  &id001                  # defines anchor label &id001
    instrument:      Lasik 2000
    pulseEnergy:     5.4
    pulseDuration:   12
    repetition:      1000
    spotSize:        1mm
- step:
     <<: *id001                  # merges key:value pairs defined in step1 anchor
     spotSize:       2mm         # overrides "spotSize" key's value
- step:
     <<: *id001                  # merges key:value pairs defined in step1 anchor
     pulseEnergy:    500.0       # overrides key
     alert: >                    # adds additional key
           warn patient of
           audible pop

1. &id001定义了一个id001的引用标签（引用文档中第一个step元素的所有属性）；
2. 第二个step元素引用id001后，重写spotSize属性；
3. 第三个step元素引用id001后，重写pulseEnergy属性，并添加alert属性