patch.ts 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  1. /**
  2. * Virtual DOM patching
  3. * Modified from snabbdom https://github.com/snabbdom/snabbdom/blob/master/src/init.ts
  4. *
  5. * The design has been simplified to focus on the purpose in SVG rendering in SVG.
  6. *
  7. * Licensed under the MIT License
  8. * https://github.com/paldepind/snabbdom/blob/master/LICENSE
  9. */
  10. import { isArray, isObject } from '../core/util';
  11. import { createElement, createVNode, SVGVNode, XMLNS, XML_NAMESPACE, XLINKNS } from './core';
  12. import * as api from './domapi';
  13. const colonChar = 58;
  14. const xChar = 120;
  15. const emptyNode = createVNode('', '');
  16. type NonUndefined<T> = T extends undefined ? never : T;
  17. function isUndef(s: any): boolean {
  18. return s === undefined;
  19. }
  20. function isDef<A>(s: A): s is NonUndefined<A> {
  21. return s !== undefined;
  22. }
  23. function createKeyToOldIdx(
  24. children: SVGVNode[],
  25. beginIdx: number,
  26. endIdx: number
  27. ): KeyToIndexMap {
  28. const map: KeyToIndexMap = {};
  29. for (let i = beginIdx; i <= endIdx; ++i) {
  30. const key = children[i].key;
  31. if (key !== undefined) {
  32. if (process.env.NODE_ENV !== 'production') {
  33. if (map[key] != null) {
  34. console.error(`Duplicate key ${key}`);
  35. }
  36. }
  37. map[key] = i;
  38. }
  39. }
  40. return map;
  41. }
  42. function sameVnode(vnode1: SVGVNode, vnode2: SVGVNode): boolean {
  43. const isSameKey = vnode1.key === vnode2.key;
  44. const isSameTag = vnode1.tag === vnode2.tag;
  45. return isSameTag && isSameKey;
  46. }
  47. type KeyToIndexMap = { [key: string]: number };
  48. function createElm(vnode: SVGVNode): Node {
  49. let i: any;
  50. const children = vnode.children;
  51. const tag = vnode.tag;
  52. // if (tag === '!') {
  53. // if (isUndef(vnode.text)) {
  54. // vnode.text = '';
  55. // }
  56. // vnode.elm = api.createComment(vnode.text!);
  57. // }
  58. // else
  59. if (isDef(tag)) {
  60. const elm = (vnode.elm = createElement(tag));
  61. updateAttrs(emptyNode, vnode);
  62. if (isArray(children)) {
  63. for (i = 0; i < children.length; ++i) {
  64. const ch = children[i];
  65. if (ch != null) {
  66. api.appendChild(elm, createElm(ch));
  67. }
  68. }
  69. }
  70. else if (isDef(vnode.text) && !isObject(vnode.text)) {
  71. api.appendChild(elm, api.createTextNode(vnode.text));
  72. }
  73. }
  74. else {
  75. vnode.elm = api.createTextNode(vnode.text!);
  76. }
  77. return vnode.elm;
  78. }
  79. function addVnodes(
  80. parentElm: Node,
  81. before: Node | null,
  82. vnodes: SVGVNode[],
  83. startIdx: number,
  84. endIdx: number
  85. ) {
  86. for (; startIdx <= endIdx; ++startIdx) {
  87. const ch = vnodes[startIdx];
  88. if (ch != null) {
  89. api.insertBefore(parentElm, createElm(ch), before);
  90. }
  91. }
  92. }
  93. function removeVnodes(parentElm: Node, vnodes: SVGVNode[], startIdx: number, endIdx: number): void {
  94. for (; startIdx <= endIdx; ++startIdx) {
  95. const ch = vnodes[startIdx];
  96. if (ch != null) {
  97. if (isDef(ch.tag)) {
  98. const parent = api.parentNode(ch.elm);
  99. api.removeChild(parent, ch.elm);
  100. }
  101. else {
  102. // Text node
  103. api.removeChild(parentElm, ch.elm!);
  104. }
  105. }
  106. }
  107. }
  108. export function updateAttrs(oldVnode: SVGVNode, vnode: SVGVNode): void {
  109. let key: string;
  110. const elm = vnode.elm as SVGElement;
  111. const oldAttrs = oldVnode && oldVnode.attrs || {};
  112. const attrs = vnode.attrs || {};
  113. if (oldAttrs === attrs) {
  114. return;
  115. }
  116. // update modified attributes, add new attributes
  117. // eslint-disable-next-line
  118. for (key in attrs) {
  119. const cur = attrs[key];
  120. const old = oldAttrs[key];
  121. if (old !== cur) {
  122. if (cur === true) {
  123. elm.setAttribute(key, '');
  124. }
  125. else if (cur === false) {
  126. elm.removeAttribute(key);
  127. }
  128. else {
  129. if (key === 'style') {
  130. elm.style.cssText = cur as string;
  131. }
  132. else if (key.charCodeAt(0) !== xChar) {
  133. elm.setAttribute(key, cur as any);
  134. }
  135. // TODO
  136. else if (key === 'xmlns:xlink' || key === 'xmlns') {
  137. elm.setAttributeNS(XMLNS, key, cur as any);
  138. }
  139. else if (key.charCodeAt(3) === colonChar) {
  140. // Assume xml namespace
  141. elm.setAttributeNS(XML_NAMESPACE, key, cur as any);
  142. }
  143. else if (key.charCodeAt(5) === colonChar) {
  144. // Assume xlink namespace
  145. elm.setAttributeNS(XLINKNS, key, cur as any);
  146. }
  147. else {
  148. elm.setAttribute(key, cur as any);
  149. }
  150. }
  151. }
  152. }
  153. // remove removed attributes
  154. // use `in` operator since the previous `for` iteration uses it (.i.e. add even attributes with undefined value)
  155. // the other option is to remove all attributes with value == undefined
  156. for (key in oldAttrs) {
  157. if (!(key in attrs)) {
  158. elm.removeAttribute(key);
  159. }
  160. }
  161. }
  162. function updateChildren(parentElm: Node, oldCh: SVGVNode[], newCh: SVGVNode[]) {
  163. let oldStartIdx = 0;
  164. let newStartIdx = 0;
  165. let oldEndIdx = oldCh.length - 1;
  166. let oldStartVnode = oldCh[0];
  167. let oldEndVnode = oldCh[oldEndIdx];
  168. let newEndIdx = newCh.length - 1;
  169. let newStartVnode = newCh[0];
  170. let newEndVnode = newCh[newEndIdx];
  171. let oldKeyToIdx: KeyToIndexMap | undefined;
  172. let idxInOld: number;
  173. let elmToMove: SVGVNode;
  174. let before: any;
  175. while (oldStartIdx <= oldEndIdx && newStartIdx <= newEndIdx) {
  176. if (oldStartVnode == null) {
  177. oldStartVnode = oldCh[++oldStartIdx]; // Vnode might have been moved left
  178. }
  179. else if (oldEndVnode == null) {
  180. oldEndVnode = oldCh[--oldEndIdx];
  181. }
  182. else if (newStartVnode == null) {
  183. newStartVnode = newCh[++newStartIdx];
  184. }
  185. else if (newEndVnode == null) {
  186. newEndVnode = newCh[--newEndIdx];
  187. }
  188. else if (sameVnode(oldStartVnode, newStartVnode)) {
  189. patchVnode(oldStartVnode, newStartVnode);
  190. oldStartVnode = oldCh[++oldStartIdx];
  191. newStartVnode = newCh[++newStartIdx];
  192. }
  193. else if (sameVnode(oldEndVnode, newEndVnode)) {
  194. patchVnode(oldEndVnode, newEndVnode);
  195. oldEndVnode = oldCh[--oldEndIdx];
  196. newEndVnode = newCh[--newEndIdx];
  197. }
  198. else if (sameVnode(oldStartVnode, newEndVnode)) {
  199. // Vnode moved right
  200. patchVnode(oldStartVnode, newEndVnode);
  201. api.insertBefore(parentElm, oldStartVnode.elm!, api.nextSibling(oldEndVnode.elm!));
  202. oldStartVnode = oldCh[++oldStartIdx];
  203. newEndVnode = newCh[--newEndIdx];
  204. }
  205. else if (sameVnode(oldEndVnode, newStartVnode)) {
  206. // Vnode moved left
  207. patchVnode(oldEndVnode, newStartVnode);
  208. api.insertBefore(parentElm, oldEndVnode.elm!, oldStartVnode.elm!);
  209. oldEndVnode = oldCh[--oldEndIdx];
  210. newStartVnode = newCh[++newStartIdx];
  211. }
  212. else {
  213. if (isUndef(oldKeyToIdx)) {
  214. oldKeyToIdx = createKeyToOldIdx(oldCh, oldStartIdx, oldEndIdx);
  215. }
  216. idxInOld = oldKeyToIdx[newStartVnode.key];
  217. if (isUndef(idxInOld)) {
  218. // New element
  219. api.insertBefore(parentElm, createElm(newStartVnode), oldStartVnode.elm!);
  220. }
  221. else {
  222. elmToMove = oldCh[idxInOld];
  223. if (elmToMove.tag !== newStartVnode.tag) {
  224. api.insertBefore(parentElm, createElm(newStartVnode), oldStartVnode.elm!);
  225. }
  226. else {
  227. patchVnode(elmToMove, newStartVnode);
  228. oldCh[idxInOld] = undefined;
  229. api.insertBefore(parentElm, elmToMove.elm!, oldStartVnode.elm!);
  230. }
  231. }
  232. newStartVnode = newCh[++newStartIdx];
  233. }
  234. }
  235. if (oldStartIdx <= oldEndIdx || newStartIdx <= newEndIdx) {
  236. if (oldStartIdx > oldEndIdx) {
  237. before = newCh[newEndIdx + 1] == null ? null : newCh[newEndIdx + 1].elm;
  238. addVnodes(parentElm, before, newCh, newStartIdx, newEndIdx);
  239. }
  240. else {
  241. removeVnodes(parentElm, oldCh, oldStartIdx, oldEndIdx);
  242. }
  243. }
  244. }
  245. function patchVnode(oldVnode: SVGVNode, vnode: SVGVNode) {
  246. const elm = (vnode.elm = oldVnode.elm)!;
  247. const oldCh = oldVnode.children;
  248. const ch = vnode.children;
  249. if (oldVnode === vnode) {
  250. return;
  251. }
  252. updateAttrs(oldVnode, vnode);
  253. if (isUndef(vnode.text)) {
  254. if (isDef(oldCh) && isDef(ch)) {
  255. if (oldCh !== ch) {
  256. updateChildren(elm, oldCh, ch);
  257. }
  258. }
  259. else if (isDef(ch)) {
  260. if (isDef(oldVnode.text)) {
  261. api.setTextContent(elm, '');
  262. }
  263. addVnodes(elm, null, ch, 0, ch.length - 1);
  264. }
  265. else if (isDef(oldCh)) {
  266. removeVnodes(elm, oldCh, 0, oldCh.length - 1);
  267. }
  268. else if (isDef(oldVnode.text)) {
  269. api.setTextContent(elm, '');
  270. }
  271. }
  272. else if (oldVnode.text !== vnode.text) {
  273. if (isDef(oldCh)) {
  274. removeVnodes(elm, oldCh, 0, oldCh.length - 1);
  275. }
  276. api.setTextContent(elm, vnode.text!);
  277. }
  278. }
  279. export default function patch(oldVnode: SVGVNode, vnode: SVGVNode): SVGVNode {
  280. if (sameVnode(oldVnode, vnode)) {
  281. patchVnode(oldVnode, vnode);
  282. }
  283. else {
  284. const elm = oldVnode.elm!;
  285. const parent = api.parentNode(elm);
  286. createElm(vnode);
  287. if (parent !== null) {
  288. api.insertBefore(parent, vnode.elm!, api.nextSibling(elm));
  289. removeVnodes(parent, [oldVnode], 0, 0);
  290. }
  291. }
  292. return vnode;
  293. }