Source: diff/delta/EditOperation.js

  1. import {DomHelper} from '../../util/DomHelper.js';
  2. import {Node} from '../../tree/Node.js';
  3. import xmldom from '@xmldom/xmldom';
  4. import {Dsl} from '../../config/Dsl.js';
  5. import {DiffConfig} from '../../config/DiffConfig.js';
  6. import vkbeautify from 'vkbeautify';
  8. /**
  9.  * Data class for a single edit operation. Every edit operation in the CpeeDiff
  10.  * change model is quadruple, although not all values must be present to
  11.  * successfully apply an edit operation.
  12.  *
  13.  * @implements {XmlSerializable<EditOperation>}
  14.  */
  15. export class EditOperation {
  16.   /**
  17.    * The type of edit operation.
  18.    * @type {String}
  19.    * @const
  20.    */
  21.   type;
  22.   /**
  23.    * The path of the node affected by this edit operation *before* it was
  24.    * applied.
  25.    * @type {?String}
  26.    * @const
  27.    */
  28.   oldPath;
  29.   /**
  30.    * The path of the node affected by this edit operation *after* it was
  31.    * applied.
  32.    * @type {?String}
  33.    * @const
  34.    */
  35.   newPath;
  36.   /**
  37.    * The new content added by this edit operation.
  38.    * @type {?Node}
  39.    * @const
  40.    */
  41.   newContent;
  43.   /**
  44.    * Construct a new EditOperation instance.
  45.    * @param {String} type The type of edit operation.
  46.    * @param {?String} oldPath The path of the node affected by this edit
  47.    *     operation *before* it was applied.
  48.    * @param {?String} newPath The path of the node affected by this edit
  49.    *     operation *after* it was applied.
  50.    * @param {?Node} newContent The new content added by this edit operation.
  51.    */
  52.   constructor(
  53.       type,
  54.       oldPath = null,
  55.       newPath = null,
  56.       newContent = null,
  57.   ) {
  58.     this.type = type;
  59.     this.oldPath = oldPath;
  60.     this.newPath = newPath;
  61.     this.newContent = newContent;
  62.   }
  64.   /**
  65.    * @param {Object} xmlElement The XML DOM object.
  66.    * @return {EditOperation}
  67.    */
  68.   static fromXmlDom(xmlElement) {
  69.     let newContent;
  70.     const xmlContent = DomHelper.firstChildElement(xmlElement);
  71.     if (xmlContent != null) {
  72.       newContent = Node.fromXmlDom(xmlContent);
  73.     }
  74.     return new EditOperation(
  75.         xmlElement.localName,
  76.         xmlElement.getAttribute('oldPath').slice(1), // Drop root slash
  77.         xmlElement.getAttribute('newPath').slice(1),
  78.         newContent,
  79.     );
  80.   }
  82.   /**
  83.    * @param {String} xml The XML document.
  84.    * @return {EditOperation}
  85.    */
  86.   static fromXmlString(xml) {
  87.     return this.fromXmlDom(DomHelper.firstChildElement(
  88.         new xmldom
  89.             .DOMParser()
  90.             .parseFromString(xml, 'text/xml')));
  91.   }
  93.   /** @return {Boolean} */
  94.   isDeletion() {
  95.     return this.type === Dsl.CHANGE_MODEL.DELETION.label;
  96.   }
  98.   /** @return {Boolean} */
  99.   isInsertion() {
  100.     return this.type === Dsl.CHANGE_MODEL.INSERTION.label;
  101.   }
  103.   /** @return {Boolean} */
  104.   isMove() {
  105.     return this.type === Dsl.CHANGE_MODEL.MOVE.label;
  106.   }
  108.   /** @return {Boolean} */
  109.   isUpdate() {
  110.     return this.type === Dsl.CHANGE_MODEL.UPDATE.label;
  111.   }
  113.   /**
  114.    * @return {String} A string representation of this edit operation.
  115.    */
  116.   toString() {
  117.     return this.type + ' ' +
  118.         (this.oldPath !== null ? this.oldPath + ' ' : '') +
  119.         (this.oldPath !== null && this.newPath !== null ? '-> ' : '') +
  120.         (this.newPath !== null ? this.newPath + ' ' : '') +
  121.         (this.newContent !== null ? this.newContent + ' ' : '');
  122.   }
  124.   /**
  125.    * @param {Object} ownerDocument The owner document of the generated XML
  126.    *     element.
  127.    * @return {Object} The XML DOM object for this edit operation.
  128.    */
  129.   toXmlDom(ownerDocument = xmldom
  130.       .DOMImplementation
  131.       .prototype
  132.       .createDocument(Dsl.DEFAULT_NAMESPACE)) {
  133.     const xmlNode = ownerDocument.createElement(this.type);
  134.     if (this.oldPath != null) {
  135.       // Add root slash
  136.       xmlNode.setAttribute('oldPath', '/' + this.oldPath);
  137.     }
  138.     if (this.newPath != null) {
  139.       // Add root slash
  140.       xmlNode.setAttribute('newPath', '/' + this.newPath);
  141.     }
  142.     if (this.newContent != null) {
  143.       xmlNode.appendChild(this.newContent.toXmlDom(ownerDocument));
  144.     }
  146.     return xmlNode;
  147.   }
  149.   /**
  150.    * @return {String} The XML document for this edit operation.
  151.    */
  152.   toXmlString() {
  153.     const str = new xmldom.XMLSerializer().serializeToString(this.toXmlDom());
  154.     if (DiffConfig.PRETTY_XML) {
  155.       return vkbeautify.xml(str);
  156.     } else {
  157.       return str;
  158.     }
  159.   }
  160. }