-
Notifications
You must be signed in to change notification settings - Fork 1
/
CHNotebookTextContainer.m
418 lines (335 loc) · 13.9 KB
/
CHNotebookTextContainer.m
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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
//
// CHNotebookTextContainer.m
// Per Se
//
// Created by Philip Dow on 12/25/10.
// Copyright 2010 Philip Dow / Sprouted. All rights reserved.
//
/*
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or other
materials provided with the distribution.
* Neither the name of the author nor the names of its contributors may be used to
endorse or promote products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.
*/
/*
For non-attribution licensing options refer to http://phildow.net/licensing/
*/
#import "CHNotebookTextContainer.h"
enum {
PDCustomLayoutXAxis = 0,
PDCustomLayoutYAxis = 1
};
NSArray* PDArrayOfRectsSortedAlongAxis(NSArray* array, NSInteger axis) {
// sorts the provided array by x- or y-origin
// according to axis
//NSAssert( (axis==0||axis==1), @"axis must be 0 for x-axis or 1 for y-axis");
NSMutableArray *sortedArray = [NSMutableArray array];
for ( NSValue *rectValue in array ) {
NSRect aRect = [rectValue rectValue];
BOOL inserted = NO;
NSInteger i;
for ( i = 0; i < sortedArray.count; i++ ) {
NSRect sortedRect = [[sortedArray objectAtIndex:i] rectValue];
if ( axis == PDCustomLayoutXAxis ) { // x-sort
if ( aRect.origin.x < sortedRect.origin.x ) {
[sortedArray insertObject:rectValue atIndex:i];
inserted = YES;
break;
}
}
else if ( axis == PDCustomLayoutYAxis ) { //y-sort
if ( aRect.origin.y < sortedRect.origin.y ) {
[sortedArray insertObject:rectValue atIndex:i];
inserted = YES;
break;
}
}
}
// if we didn't insert, place it at the end
if ( !inserted) [sortedArray addObject:rectValue];
}
return [[sortedArray copy] autorelease];
}
NSArray* PDArrayOfRectsMergedWithMarginAlongAxis(NSArray* array, CGFloat margin, NSInteger axis) {
// merges contiguous rects in array given a margin of space
// which may occur between them, according to axis
//
// rectangle A is contiguous with rectangle B along the x-axis
// if a.origin.x + a.size.width + margin >= b.origin.x
//
// ** array must already be sorted along axis **
//NSAssert( (axis==0||axis==1), @"axis must be 0 for x-axis or 1 for y-axis");
NSMutableArray *mergedArray = [NSMutableArray array];
NSInteger i;
for ( i = 0; i < array.count; i++ ) {
NSRect aRect = [[array objectAtIndex:i] rectValue];
NSRect mergedRect = aRect;
NSInteger j;
// check every following rect for contiguity
for ( j = i+1; j < array.count; j++ ) {
NSRect nextRect = [[array objectAtIndex:j] rectValue];
if ( axis == PDCustomLayoutXAxis ) {
if ( mergedRect.origin.x + mergedRect.size.width + margin >= nextRect.origin.x ) {
// adjust mergedRect in place so that it is used through the next path
mergedRect = NSUnionRect(mergedRect, nextRect);
}
else {
break;
}
}
else if ( axis == PDCustomLayoutYAxis ) {
if ( mergedRect.origin.y + mergedRect.size.height + margin >= nextRect.origin.y ) {
// adjust mergedRect in place so that it is used through the next path
// note that this may cause problems with layout #9
mergedRect = NSUnionRect(mergedRect, nextRect);
}
else {
break;
}
}
}
// add the merged rect to the array
[mergedArray addObject:[NSValue valueWithRect:mergedRect]];
// advance i as far as j-1
// i is ++ before running through the loop again
// noticed this was required when the last rectangle was not
// being added to the returned array. unintended consequences?
i = j-1;
}
return [[mergedArray copy] autorelease];
}
CGFloat PDNextAvailableYCoordinate(NSArray *array, CGFloat minimumWidth) {
// returns the smallest y coordinate given the rects in array
// ensures that at least an x-span of minimumWidth is available at this y
// TODO: PDNextAvailableYCoordinate: implement minimumWidth
CGFloat nextAvailable = CGFLOAT_MAX;
for ( NSValue *aValue in array ) {
NSRect rect = [aValue rectValue];
if ( NSMaxY(rect) < nextAvailable )
nextAvailable = NSMaxY(rect);
}
return nextAvailable;
}
// setLineFragmentPadding:
@implementation CHNotebookTextContainer
static CGFloat kCHNotebookTextContainerPadding = 20.0f;
static CGFloat kCHNotebookClippingRectMargin = 20.0f;
@synthesize layoutClippings = _layoutClippings;
- (id)initWithContainerSize:(NSSize)aSize {
if ( self = [super initWithContainerSize:aSize] ) {
clipGrouping = NO;
_layoutClippings = [[NSMutableDictionary alloc] init];
}
return self;
}
- (void) dealloc {
//DLog();
[_layoutClippings release], _layoutClippings = nil;
[super dealloc];
}
#pragma mark -
- (void) beginClipGrouping {
clipGrouping = YES;
}
- (void) endClipGrouping {
clipGrouping = NO;
}
#pragma mark -
- (void) removeAllClippingRects {
[_layoutClippings removeAllObjects];
if (!clipGrouping) {
[[self layoutManager] textContainerChangedGeometry:self];
}
}
- (void) setClippingRect:(NSRect)aRect forKey:(id)aKey {
// store the key
// invalidate the area encompassed by this clipping rect
// to force the layout manager to redraw the glyphs
if ( aKey == nil )
return;
// i get a nil key when i add and undo media, simultaneously
// creating a new entry, then add and undo another media
// i should check for a nil key anyway, but this is a
// workaround for another more serious problem
if ( NSEqualRects(aRect, NSZeroRect) )
[_layoutClippings removeObjectForKey:aKey];
else
[_layoutClippings setObject:[NSValue valueWithRect:aRect] forKey:aKey];
if (!clipGrouping) {
[[self layoutManager] textContainerChangedGeometry:self];
}
}
#pragma mark -
#pragma mark Calculating Text Layout
- (BOOL)isSimpleRectangularTextContainer {
return ( [_layoutClippings count] == 0 );
}
- (NSRect)lineFragmentRectForProposedRect:(NSRect)proposedRect
sweepDirection:(NSLineSweepDirection)sweepDirection
movementDirection:(NSLineMovementDirection)movementDirection
remainingRect:(NSRectPointer)remainingRect {
BOOL requiredModification = NO;
NSRect reproposedRect;
NSMutableArray *intersectingRects = [NSMutableArray array];
// defer to super's implementation if vertical exceeds height
if ( proposedRect.origin.y + proposedRect.size.height > self.containerSize.height ) {
return [super lineFragmentRectForProposedRect:proposedRect
sweepDirection:sweepDirection
movementDirection:movementDirection
remainingRect:remainingRect];
}
// first pass: discover every clipping rect which intersects the proposed rect
for ( NSValue *rectValue in [_layoutClippings objectEnumerator] ) {
NSRect clippingRect = [rectValue rectValue];
if ( NSIntersectsRect(proposedRect, clippingRect) ) {
[intersectingRects addObject:rectValue];
}
}
// if no intersections occur, defer to super
if ( intersectingRects.count == 0 ) {
return [super lineFragmentRectForProposedRect:proposedRect
sweepDirection:sweepDirection
movementDirection:movementDirection
remainingRect:remainingRect];
}
else {
// order the intersecting clipping rects along x-axis
NSArray *orderedRects = PDArrayOfRectsSortedAlongAxis(intersectingRects,PDCustomLayoutXAxis);
// merge contiguous rects including margin along x-axis
NSArray *mergedRects = PDArrayOfRectsMergedWithMarginAlongAxis(orderedRects, kCHNotebookClippingRectMargin, PDCustomLayoutXAxis);
// how many rects are we looking at?
// if 1, does the rect cover the entire width of text container
// YES: zero the proposed rect and shift it down to the next available y coordinate
// evaluating not the merged rects but individual rects for the closest y point
// recursively run function on reproposed rect
//
// NO or if > 1
// does the leftmost rect begin at the left edge of the proposed rect, including margin?
// YES: repropose rect from end of leftmost to beginning of next rect or border
// remaining rect is a. from end of next rect to border or b. zero (border)
// NO: width is from left edge of proposed rect to beginning of first rect
// remaining rect is from end of first rect to beginning of next rect or border
//
// at any time if the remaining rect is less than margin, make zero rect
// this same algorithm will be executed recursively with each remaining rect
// and should work fine with it. does not matter if source is original or remaining rect
if ( mergedRects.count == 1 ) {
NSRect theRect = [[mergedRects objectAtIndex:0] rectValue];
if ( theRect.origin.x <= kCHNotebookTextContainerPadding
&& theRect.size.width + theRect.origin.x >= self.containerSize.width - kCHNotebookTextContainerPadding ) {
// preserve the proposed x origin and height
reproposedRect.origin.x = proposedRect.origin.x;
reproposedRect.size.height = proposedRect.size.height;
// maximum available width
reproposedRect.size.width = self.containerSize.width;
// offset the height to the next available y-coordinate
// note that i use the ordered rects and not the merged rects
reproposedRect.origin.y = PDNextAvailableYCoordinate(orderedRects,0);
// and recursively run the reproposed rect through the same function
reproposedRect = [self lineFragmentRectForProposedRect:reproposedRect
sweepDirection:sweepDirection
movementDirection:movementDirection
remainingRect:remainingRect];
requiredModification = YES;
}
}
if ( !requiredModification ) {
// only modification thus far is down shift; if we haven't done this:
// does the leftmost rect begin at the left edge of the proposed rect, including margin?
// YES: reproposed rect from end of leftmost to beginning of next rect or border
// remaining rect is a. zero (border) or b. from end of next rect to border
// NO: width is from left edge of proposed rect to beginning of first rect
// remaining rect is from end of first rect to beginning of next rect or border
// preserve the proposed y origin and height
reproposedRect.origin.y = proposedRect.origin.y;
reproposedRect.size.height = proposedRect.size.height;
NSRect leftmostRect = [[mergedRects objectAtIndex:0] rectValue];
// does the leftmost rect begin at the left edge of the proposed rect, including margin?
if ( leftmostRect.origin.x <= proposedRect.origin.x + kCHNotebookTextContainerPadding ) {
// reproposed rect from end of leftmost...
reproposedRect.origin.x = leftmostRect.origin.x + leftmostRect.size.width;
if ( mergedRects.count == 1 ) {
// ... to the border
reproposedRect.size.width = self.containerSize.width - reproposedRect.origin.x;
// zero the remaining rect
*remainingRect = NSZeroRect;
}
else {
// ... to the beginning of the next rect
NSRect nextRect = [[mergedRects objectAtIndex:1] rectValue];
reproposedRect.size.width = nextRect.origin.x - reproposedRect.origin.x;
// remaining rect is from end of next rect to border
// preserving y-coordinate and height
*remainingRect = NSMakeRect(nextRect.origin.x + nextRect.size.width,
proposedRect.origin.y,
self.containerSize.width - (nextRect.origin.x + nextRect.size.width),
proposedRect.size.height);
}
}
else {
// preserve original x origin
// width is from left edge of proposed rect to beginning of first rect
reproposedRect.origin.x = proposedRect.origin.x;
reproposedRect.size.width = leftmostRect.origin.x - reproposedRect.origin.x;
// remaining rect is from end of first rect to beginning of next rect or border
if ( mergedRects.count == 1 ) {
*remainingRect = NSMakeRect(leftmostRect.origin.x + leftmostRect.size.width,
proposedRect.origin.y,
self.containerSize.width - (leftmostRect.origin.x + leftmostRect.size.width),
proposedRect.size.height);
}
else {
NSRect nextRect = [[mergedRects objectAtIndex:1] rectValue];
*remainingRect = NSMakeRect(leftmostRect.origin.x + leftmostRect.size.width,
proposedRect.origin.y,
nextRect.origin.x - (leftmostRect.origin.x + leftmostRect.size.width),
proposedRect.size.height);
}
}
requiredModification = YES;
}
// at any time if the remaining rect is less than margin, it is zero rect
if ( remainingRect->size.width <= kCHNotebookTextContainerPadding ) {
*remainingRect = NSZeroRect;
}
if ( requiredModification ) {
return reproposedRect;
}
else {
return [super lineFragmentRectForProposedRect:proposedRect
sweepDirection:sweepDirection
movementDirection:movementDirection
remainingRect:remainingRect];
}
}
}
#pragma mark -
#pragma mark Mouse Hit Testing
- (BOOL)containsPoint:(NSPoint)aPoint {
BOOL containsPoint = YES;
for ( NSValue *rectValue in [_layoutClippings objectEnumerator] ) {
NSRect clippingRect = [rectValue rectValue];
if ( NSPointInRect(aPoint, clippingRect) ) {
containsPoint = NO;
break;
}
}
return containsPoint;
}
@end