wip: wlxml formatting support - first test passing
[fnpeditor.git] / src / wlxml / wlxml.js
1 define([
2     'smartxml/smartxml'
3 ], function(smartxml) {
4     
5 'use strict';
6
7 // utils
8
9 var isMetaAttribute = function(attrName) {
10     return attrName.substr(0, 5) === 'meta-';
11 };
12
13 //
14
15 var WLXMLElementNode = function(nativeNode, document) {
16     smartxml.ElementNode.call(this, nativeNode, document);
17 };
18 WLXMLElementNode.prototype = Object.create(smartxml.ElementNode.prototype);
19
20 $.extend(WLXMLElementNode.prototype, smartxml.ElementNode.prototype, {
21     getClass: function() {
22         return this.getAttr('class');
23     },
24     setClass: function(klass) {
25         return this.setAttr('class', klass);
26     },
27     getMetaAttributes: function() {
28         var toret = [];
29         this.getAttrs().forEach(function(attr) {
30             if(isMetaAttribute(attr.name)) {
31                 toret.push({name: attr.name.substr(5), value: attr.value});
32             }
33         });
34         return toret;
35     },
36     getOtherAttributes: function() {
37         var toret = {};
38         this.getAttrs().forEach(function(attr) {
39             if(attr.name !== 'class' && !isMetaAttribute(attr.name)) {
40                 toret[attr.name] = attr.value;
41             }
42         });
43         return toret;
44     },
45
46     _getXMLDOMToDump: function() {
47         var DOM = this._$.clone(true, true);
48
49         DOM.find('*').addBack().each(function() {
50             var el = $(this),
51                 parent = el.parent(),
52                 contents = parent.contents(),
53                 idx = contents.index(el),
54                 data = el.data();
55
56
57             var txt;
58
59             if(data[formatter_prefix+ 'orig_before']) {
60                 txt = idx > 0 && contents[idx-1].nodeType === Node.TEXT_NODE ? contents[idx-1] : null;
61                 if(txt && txt.data === data[formatter_prefix + 'orig_before_transformed']) {
62                     txt.data = data[formatter_prefix+ 'orig_before_original'];
63                 } else {
64                     el.before(data[formatter_prefix+ 'orig_before']);
65                 }
66             }
67             if(data[formatter_prefix+ 'orig_after']) {
68                 txt = idx < contents.length-1 && contents[idx+1].nodeType === Node.TEXT_NODE ? contents[idx+1] : null;
69                 if(txt && txt.data === data[formatter_prefix + 'orig_after_transformed']) {
70                     txt.data = data[formatter_prefix+ 'orig_after_original'];
71                 } else {
72                     el.after(data[formatter_prefix+ 'orig_after']);
73                 }
74             }
75             if(data[formatter_prefix+ 'orig_begin']) {
76                 el.prepend(data[formatter_prefix+ 'orig_begin']);
77             }
78             if(data[formatter_prefix+ 'orig_end']) {
79                 contents = el.contents();
80                 txt = (contents.length && contents[contents.length-1].nodeType === Node.TEXT_NODE) ? contents[contents.length-1] : null;
81                 if(txt && txt.data === data[formatter_prefix + 'orig_end_transformed']) {
82                     txt.data = data[formatter_prefix+ 'orig_end_original'];
83                 } else {
84                     el.append(data[formatter_prefix+ 'orig_end']);
85                 }
86             }
87         });
88
89         return DOM;
90     }
91 });
92
93
94
95
96
97 var WLXMLDocument = function(xml) {
98     smartxml.Document.call(this, xml);
99
100     $(this.dom).find(':not(iframe)').addBack().contents()
101     .filter(function() {return this.nodeType === Node.TEXT_NODE;})
102     .each(function() {
103         var el = $(this),
104             text = {original: el.text(), trimmed: $.trim(el.text())},
105             elParent = el.parent(),
106             hasSpanParent = elParent.prop('tagName') === 'SPAN',
107             hasSpanBefore = el.prev().length && $(el.prev()).prop('tagName') === 'SPAN',
108             hasSpanAfter = el.next().length && $(el.next()).prop('tagName') === 'SPAN';
109
110
111         var addInfo = function(toAdd, where, transformed, original) {
112             var parentContents = elParent.contents(),
113                 idx = parentContents.index(el[0]),
114                 prev = idx > 0 ? parentContents[idx-1] : null,
115                 next = idx < parentContents.length - 1 ? parentContents[idx+1] : null,
116                 target, key;
117
118             if(where === 'above') {
119                 target = prev ? $(prev) : elParent;
120                 key = prev ? 'orig_after' : 'orig_begin';
121             } else if(where === 'below') {
122                 target = next ? $(next) : elParent;
123                 key = next ? 'orig_before' : 'orig_end';
124             } else { throw new Object;}
125
126             target.data(formatter_prefix + key, toAdd);
127             if(transformed !== undefined) {
128                 target.data(formatter_prefix + key + '_transformed', transformed);
129             }
130             if(original !== undefined) {
131                 target.data(formatter_prefix + key + '_original', original);   
132             }
133         }
134
135         text.transformed = text.trimmed;
136
137         if(hasSpanParent || hasSpanBefore || hasSpanAfter) {
138             var startSpace = /\s/g.test(text.original.substr(0,1)),
139                 endSpace = /\s/g.test(text.original.substr(-1)) && text.original.length > 1;
140             text.transformed = (startSpace && (hasSpanParent || hasSpanBefore) ? ' ' : '');
141             text.transformed += text.trimmed;
142             text.transformed += (endSpace && (hasSpanParent || hasSpanAfter) ? ' ' : '');
143         } else {
144             if(text.trimmed.length === 0 && text.original.length > 0 && elParent.contents().length === 1) {
145                 text.transformed = ' ';
146             }
147         }
148
149         if(!text.transformed) {
150             addInfo(text.original, 'below');
151             el.remove();
152             return true; // continue
153         }
154
155         if(text.transformed !== text.original) {
156             // if(!text.trimmed) {
157             //     addInfo(text.original, 'below');
158             // } else {
159                 var startingMatch = text.original.match(/^\s+/g),
160                     endingMatch = text.original.match(/\s+$/g),
161                     startingWhiteSpace = startingMatch ? startingMatch[0] : null,
162                     endingWhiteSpace = endingMatch ? endingMatch[0] : null;
163
164                 if(endingWhiteSpace) {
165                     if(text.transformed[text.transformed.length - 1] === ' ' && endingWhiteSpace[0] === ' ')
166                         endingWhiteSpace = endingWhiteSpace.substr(1);
167                     addInfo(endingWhiteSpace, 'below', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
168                 }
169
170                 if(startingWhiteSpace && text.trimmed) {
171                     if(text.transformed[0] === ' ' && startingWhiteSpace[startingWhiteSpace.length-1] === ' ')
172                         startingWhiteSpace = startingWhiteSpace.substr(0, startingWhiteSpace.length -1);
173                     addInfo(startingWhiteSpace, 'above', !text.trimmed ? text.transformed : undefined, !text.trimmed ? text.original : undefined);
174                 }
175             //}
176         }
177
178         el.replaceWith(document.createTextNode(text.transformed));
179     });
180 };
181
182 var formatter_prefix = '_wlxml_formatter_';
183
184 WLXMLDocument.prototype = Object.create(smartxml.Document.prototype);
185 $.extend(WLXMLDocument.prototype, {
186     ElementNodeFactory: WLXMLElementNode,
187 });
188
189
190 return {
191     WLXMLDocumentFromXML: function(xml) {
192         return new WLXMLDocument(xml);
193     },
194
195     WLXMLElementNodeFromXML: function(xml) {
196         return this.WLXMLDocumentFromXML(xml).root;
197     }
198 };
199
200 });