1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
|
/* Highlight module for wikiEditor */
( function ( $ ) {
$.wikiEditor.modules.highlight = {
/**
* Core Requirements
*/
req: [ 'iframe' ],
/**
* Configuration
*/
cfg: {
styleVersion: 3
},
/**
* Internally used event handlers
*/
evt: {
/**
* @param context
* @param event
*/
delayedChange: function ( context, event ) {
if ( event.data.scope === 'realchange' ) {
$.wikiEditor.modules.highlight.fn.scan( context );
$.wikiEditor.modules.highlight.fn.mark( context, event.data.scope );
}
},
/**
* @param context
* @param event
*/
ready: function ( context ) {
$.wikiEditor.modules.highlight.fn.scan( context );
$.wikiEditor.modules.highlight.fn.mark( context, 'ready' );
}
},
/**
* Internally used functions
*/
fn: {
/**
* Creates a highlight module within a wikiEditor
*
* @param context
* @param config Configuration object to create module from
*/
create: function ( context ) {
context.modules.highlight.markersStr = '';
},
/**
* Scans text division for tokens
*
* @param context
* @param division
*/
scan: function ( context ) {
var tokenArray, text, module, exp,
left, right, match,
regex, label, markAfter, offset;
/*jshint eqnull: true */
// Remove all existing tokens
tokenArray = context.modules.highlight.tokenArray = [];
// Scan text for new tokens
text = context.fn.getContents();
// Perform a scan for each module which provides any expressions to scan for
// FIXME: This traverses the entire string once for every regex. Investigate
// whether |-concatenating regexes then traversing once is faster.
for ( module in context.modules ) {
if ( module in $.wikiEditor.modules && 'exp' in $.wikiEditor.modules[module] ) {
for ( exp in $.wikiEditor.modules[module].exp ) {
// Prepare configuration
regex = $.wikiEditor.modules[module].exp[exp].regex;
label = $.wikiEditor.modules[module].exp[exp].label;
markAfter = $.wikiEditor.modules[module].exp[exp].markAfter || false;
// Search for tokens
offset = 0;
while ( ( match = text.substr( offset ).match( regex ) ) != null ) {
right = ( left = offset + match.index ) + match[0].length;
tokenArray[tokenArray.length] = {
offset: markAfter ? right : left,
label: label,
tokenStart: left,
match: match
};
// Move to the right of this match
offset = right;
}
}
}
}
// Sort by start
tokenArray.sort( function ( a, b ) {
return a.tokenStart - b.tokenStart;
} );
// Let the world know, a scan just happened!
context.fn.trigger( 'scan' );
},
/**
* Marks up text with HTML
*
* @param context
* @param division
* @param tokens
*/
// FIXME: What do division and tokens do?
// TODO: Document the scan() and mark() APIs somewhere
mark: function ( context, division ) {
/*jshint eqeqeq:false, onevar:false */
var i, subtracted, oldLength, j, o,
markers;
// Reset markers
markers = [];
// Recycle markers that will be skipped in this run
if ( context.modules.highlight.markers && division !== '' ) {
for ( i = 0; i < context.modules.highlight.markers.length; i++ ) {
if ( context.modules.highlight.markers[i].skipDivision == division ) {
markers.push( context.modules.highlight.markers[i] );
}
}
}
context.modules.highlight.markers = markers;
// Get all markers
context.fn.trigger( 'mark' );
markers.sort( function ( a, b ) {
return a.start - b.start || a.end - b.end;
} );
// Serialize the markers array to a string and compare it with the one stored in the previous run - if they're
// equal, there's no markers to change
var markersStr = '';
for ( i = 0; i < markers.length; i++ ) {
markersStr += markers[i].start + ',' + markers[i].end + ',' + markers[i].type + ',';
}
if ( context.modules.highlight.markersStr == markersStr ) {
// No change, bail out
return;
}
context.modules.highlight.markersStr = markersStr;
// Traverse the iframe DOM, inserting markers where they're needed - store visited markers here so we know which
// markers should be removed
var visited = [], v = 0;
for ( i = 0; i < markers.length; i++ ) {
if ( typeof markers[i].skipDivision !== 'undefined' && ( division == markers[i].skipDivision ) ) {
continue;
}
// We want to isolate each marker, so we may need to split textNodes if a marker starts or ends halfway one.
var start = markers[i].start;
var s = context.fn.getOffset( start );
if ( !s ) {
// This shouldn't happen
continue;
}
var startNode = s.node;
// Don't wrap leading BRs, produces undesirable results
// FIXME: It's also possible that the offset is a bit high because getOffset() has incremented .length to
// fake the newline caused by startNode being in a P. In this case, prevent the textnode splitting below
// from making startNode an empty textnode, IE barfs on that
while ( startNode.nodeName === 'BR' || s.offset === startNode.nodeValue.length ) {
start++;
s = context.fn.getOffset( start );
startNode = s.node;
}
// The next marker starts somewhere in this textNode or at this BR
if ( s.offset > 0 && s.node.nodeName == '#text' ) {
// Split off the prefix - this leaves the prefix in the current node and puts the rest in a new node
// which is our start node
var newStartNode = startNode.splitText( s.offset < s.node.nodeValue.length ?
s.offset : s.node.nodeValue.length - 1
);
var oldStartNode = startNode;
startNode = newStartNode;
// Update offset objects. We don't need purgeOffsets(), simply manipulating the existing offset objects
// will suffice
// FIXME: This manipulates context.offsets directly, which is ugly, but the performance improvement vs.
// purgeOffsets() is worth it - this code doesn't set lastTextNode to newStartNode for offset objects
// with lastTextNode == oldStartNode, but that doesn't really matter
subtracted = s.offset;
oldLength = s.length;
// Update offset objects referring to oldStartNode
for ( j = start - subtracted; j < start; j++ ) {
if ( j in context.offsets ) {
o = context.offsets[j];
o.node = oldStartNode;
o.length = subtracted;
}
}
// Update offset objects referring to newStartNode
for ( j = start; j < start - subtracted + oldLength; j++ ) {
if ( j in context.offsets ) {
o = context.offsets[j];
o.node = newStartNode;
o.offset -= subtracted;
o.length -= subtracted;
o.lastTextNode = oldStartNode;
}
}
}
var end = markers[i].end;
// To avoid ending up at the first char of the next node, we grab the offset for end - 1 and add one to the
// offset
var e = context.fn.getOffset( end - 1 );
if ( !e ) {
// This shouldn't happen
continue;
}
var endNode = e.node;
if ( e.offset + 1 < e.length - 1 && endNode.nodeName == '#text' ) {
// Split off the suffix. This puts the suffix in a new node and leaves the rest in endNode
var oldEndNode = endNode;
var newEndNode = endNode.splitText( e.offset + 1 );
// Update offset objects
subtracted = e.offset + 1;
oldLength = e.length;
// Update offset objects referring to oldEndNode
for ( j = end - subtracted; j < end; j++ ) {
if ( j in context.offsets ) {
o = context.offsets[j];
o.node = oldEndNode;
o.length = subtracted;
}
}
// We have to insert this one, as it might not exist: we didn't call getOffset( end )
context.offsets[end] = {
'node': newEndNode,
'offset': 0,
'length': oldLength - subtracted,
'lastTextNode': oldEndNode
};
// Update offset objects referring to newEndNode
for ( j = end + 1; j < end - subtracted + oldLength; j++ ) {
if ( j in context.offsets ) {
o = context.offsets[j];
o.node = newEndNode;
o.offset -= subtracted;
o.length -= subtracted;
o.lastTextNode = oldEndNode;
}
}
}
// Don't wrap trailing BRs, doing that causes weird issues
if ( endNode.nodeName == 'BR' ) {
endNode = e.lastTextNode;
}
// If startNode and endNode have different parents, we need to pull endNode and all textnodes in between
// into startNode's parent and replace </p><p> with <br>
if ( startNode.parentNode !== endNode.parentNode ) {
var startP = $( startNode ).closest( 'p' ).get( 0 );
var t = new context.fn.rawTraverser( startNode, startP, context.$content.get( 0 ), false );
var afterStart = startNode.nextSibling;
var lastP = startP;
var nextT = t.next();
while ( nextT && t.node !== endNode ) {
t = nextT;
nextT = t.next();
// If t.node has a different parent, merge t.node.parentNode with startNode.parentNode
if ( t.node.parentNode !== startNode.parentNode ) {
var oldParent = t.node.parentNode;
if ( afterStart ) {
if ( lastP !== t.inP ) {
// We're entering a new <p>, insert a <br>
startNode.parentNode.insertBefore(
startNode.ownerDocument.createElement( 'br' ),
afterStart
);
}
// A <p> with just a <br> in it is an empty line, so let's not bother with unwrapping it
if ( !( oldParent.childNodes.length == 1 && oldParent.firstChild.nodeName == 'BR' ) ) {
// Move all children of oldParent into startNode's parent
while ( oldParent.firstChild ) {
startNode.parentNode.insertBefore( oldParent.firstChild, afterStart );
}
}
} else {
if ( lastP !== t.inP ) {
// We're entering a new <p>, insert a <br>
startNode.parentNode.appendChild(
startNode.ownerDocument.createElement( 'br' )
);
}
// A <p> with just a <br> in it is an empty line, so let's not bother with unwrapping it
if ( !( oldParent.childNodes.length == 1 && oldParent.firstChild.nodeName == 'BR' ) ) {
// Move all children of oldParent into startNode's parent
while ( oldParent.firstChild ) {
startNode.parentNode.appendChild( oldParent.firstChild );
}
}
}
// Remove oldParent, which is now empty
oldParent.parentNode.removeChild( oldParent );
}
lastP = t.inP;
}
// Moving nodes around like this invalidates offset objects
// TODO: Update offset objects ourselves for performance. Requires rewriting this code block to be
// offset-based rather than traverser-based
}
// Now wrap everything between startNode and endNode (may be equal).
var ca1 = startNode, ca2 = endNode;
if ( ca1 && ca2 && ca1.parentNode ) {
var anchor = markers[i].getAnchor( ca1, ca2 );
if ( !anchor ) {
var commonAncestor = ca1.parentNode;
if ( markers[i].anchor == 'wrap') {
// We have to store things like .parentNode and .nextSibling because appendChild() changes these
var newNode = ca1.ownerDocument.createElement( 'span' );
var nextNode = ca2.nextSibling;
// Append all nodes between ca1 and ca2 (inclusive) to newNode
var n = ca1;
while ( n !== nextNode ) {
var ns = n.nextSibling;
newNode.appendChild( n );
n = ns;
}
// Insert newNode in the right place
if ( nextNode ) {
commonAncestor.insertBefore( newNode, nextNode );
} else {
commonAncestor.appendChild( newNode );
}
anchor = newNode;
} else if ( markers[i].anchor == 'tag' ) {
anchor = commonAncestor;
}
$( anchor ).data( 'marker', markers[i] ).addClass( 'wikiEditor-highlight' );
// Allow the module adding this marker to manipulate it
markers[i].afterWrap( anchor, markers[i] );
} else {
// Update the marker object
$( anchor ).data( 'marker', markers[i] );
if ( typeof markers[i].onSkip == 'function' ) {
markers[i].onSkip( anchor );
}
}
visited[v++] = anchor;
}
}
// Remove markers that were previously inserted but weren't passed to this function - visited[] contains the
// visited elements in order and find() and each() preserve order
j = 0;
context.$content.find( '.wikiEditor-highlight' ).each( function () {
if ( visited[j] == this ) {
// This marker is legit, leave it in
j++;
return true;
}
// Remove this marker
var marker = $(this).data( 'marker' );
if ( marker && typeof marker.skipDivision !== 'undefined' && ( division === marker.skipDivision ) ) {
// Don't remove these either
return true;
}
if ( marker && typeof marker.beforeUnwrap === 'function' ) {
marker.beforeUnwrap( this );
}
if ( ( marker && marker.anchor === 'tag' ) || $(this).is( 'p' ) ) {
// Remove all classes
$(this).removeAttr( 'class' );
} else {
// Assume anchor == 'wrap'
$(this).replaceWith( this.childNodes );
}
context.fn.purgeOffsets();
});
}
}
};
}( jQuery ) );
|