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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
|
// Copyright (c) 2010 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#import <Cocoa/Cocoa.h>
#include "base/logging.h" // for NOTREACHED()
#include "base/mac_util.h"
#include "base/sys_string_conversions.h"
#import "chrome/browser/cocoa/animatable_view.h"
#include "chrome/browser/cocoa/event_utils.h"
#include "chrome/browser/cocoa/infobar.h"
#import "chrome/browser/cocoa/infobar_container_controller.h"
#import "chrome/browser/cocoa/infobar_controller.h"
#include "chrome/browser/tab_contents/infobar_delegate.h"
#include "chrome/browser/tab_contents/tab_contents.h"
#include "skia/ext/skia_utils_mac.h"
#include "third_party/GTM/AppKit/GTMUILocalizerAndLayoutTweaker.h"
#include "webkit/glue/window_open_disposition.h"
namespace {
// Durations set to match the default SlideAnimation duration.
const float kAnimateOpenDuration = 0.12;
const float kAnimateCloseDuration = 0.12;
}
// This simple subclass of |NSTextView| just doesn't show the (text) cursor
// (|NSTextView| displays the cursor with full keyboard accessibility enabled).
@interface InfoBarTextView : NSTextView
- (void)fixupCursor;
@end
@implementation InfoBarTextView
// Never draw the insertion point (otherwise, it shows up without any user
// action if full keyboard accessibility is enabled).
- (BOOL)shouldDrawInsertionPoint {
return NO;
}
- (NSRange)selectionRangeForProposedRange:(NSRange)proposedSelRange
granularity:(NSSelectionGranularity)granularity {
// Do not allow selections.
return NSMakeRange(0, 0);
}
// Convince NSTextView to not show an I-Beam cursor when the cursor is over the
// text view but not over actual text.
//
// http://www.mail-archive.com/cocoa-dev@lists.apple.com/msg10791.html
// "NSTextView sets the cursor over itself dynamically, based on considerations
// including the text under the cursor. It does so in -mouseEntered:,
// -mouseMoved:, and -cursorUpdate:, so those would be points to consider
// overriding."
- (void)mouseMoved:(NSEvent*)e {
[super mouseMoved:e];
[self fixupCursor];
}
- (void)mouseEntered:(NSEvent*)e {
[super mouseEntered:e];
[self fixupCursor];
}
- (void)cursorUpdate:(NSEvent*)e {
[super cursorUpdate:e];
[self fixupCursor];
}
- (void)fixupCursor {
if ([[NSCursor currentCursor] isEqual:[NSCursor IBeamCursor]])
[[NSCursor arrowCursor] set];
}
@end
@interface InfoBarController (PrivateMethods)
// Sets |label_| based on |labelPlaceholder_|, sets |labelPlaceholder_| to nil.
- (void)initializeLabel;
// Asks the container controller to remove the infobar for this delegate. This
// call will trigger a notification that starts the infobar animating closed.
- (void)removeInfoBar;
// Performs final cleanup after an animation is finished or stopped, including
// notifying the InfoBarDelegate that the infobar was closed and removing the
// infobar from its container, if necessary.
- (void)cleanUpAfterAnimation:(BOOL)finished;
// Sets the info bar message to the specified |message|, with a hypertext
// style link. |link| will be inserted into message at |linkOffset|.
- (void)setLabelToMessage:(NSString*)message
withLink:(NSString*)link
atOffset:(NSUInteger)linkOffset;
@end
@implementation InfoBarController
@synthesize containerController = containerController_;
@synthesize delegate = delegate_;
- (id)initWithDelegate:(InfoBarDelegate*)delegate {
DCHECK(delegate);
if ((self = [super initWithNibName:@"InfoBar"
bundle:mac_util::MainAppBundle()])) {
delegate_ = delegate;
}
return self;
}
// All infobars have an icon, so we set up the icon in the base class
// awakeFromNib.
- (void)awakeFromNib {
DCHECK(delegate_);
if (delegate_->GetIcon()) {
[image_ setImage:gfx::SkBitmapToNSImage(*(delegate_->GetIcon()))];
} else {
// No icon, remove it from the view and grow the textfield to include the
// space.
NSRect imageFrame = [image_ frame];
NSRect labelFrame = [labelPlaceholder_ frame];
labelFrame.size.width += NSMinX(imageFrame) - NSMinX(labelFrame);
labelFrame.origin.x = imageFrame.origin.x;
[image_ removeFromSuperview];
[labelPlaceholder_ setFrame:labelFrame];
}
[self initializeLabel];
[self addAdditionalControls];
}
// Called when someone clicks on the embedded link.
- (BOOL) textView:(NSTextView*)textView
clickedOnLink:(id)link
atIndex:(NSUInteger)charIndex {
if ([self respondsToSelector:@selector(linkClicked)])
[self performSelector:@selector(linkClicked)];
return YES;
}
// Called when someone clicks on the ok button.
- (void)ok:(id)sender {
// Subclasses must override this method if they do not hide the ok button.
NOTREACHED();
}
// Called when someone clicks on the cancel button.
- (void)cancel:(id)sender {
// Subclasses must override this method if they do not hide the cancel button.
NOTREACHED();
}
// Called when someone clicks on the close button.
- (void)dismiss:(id)sender {
[self removeInfoBar];
}
- (AnimatableView*)animatableView {
return static_cast<AnimatableView*>([self view]);
}
- (void)open {
// Simply reset the frame size to its opened size, forcing a relayout.
CGFloat finalHeight = [[self view] frame].size.height;
[[self animatableView] setHeight:finalHeight];
}
- (void)animateOpen {
// Force the frame size to be 0 and then start an animation.
NSRect frame = [[self view] frame];
CGFloat finalHeight = frame.size.height;
frame.size.height = 0;
[[self view] setFrame:frame];
[[self animatableView] animateToNewHeight:finalHeight
duration:kAnimateOpenDuration];
}
- (void)close {
// Stop any running animations.
[[self animatableView] stopAnimation];
infoBarClosing_ = YES;
[self cleanUpAfterAnimation:YES];
}
- (void)animateClosed {
// Start animating closed. We will receive a notification when the animation
// is done, at which point we can remove our view from the hierarchy and
// notify the delegate that the infobar was closed.
[[self animatableView] animateToNewHeight:0 duration:kAnimateCloseDuration];
// The above call may trigger an animationDidStop: notification for any
// currently-running animations, so do not set |infoBarClosing_| until after
// starting the animation.
infoBarClosing_ = YES;
}
- (void)addAdditionalControls {
// Default implementation does nothing.
}
- (void)setLabelToMessage:(NSString*)message {
NSMutableDictionary* attributes = [NSMutableDictionary dictionary];
NSFont* font = [NSFont labelFontOfSize:
[NSFont systemFontSizeForControlSize:NSRegularControlSize]];
[attributes setObject:font
forKey:NSFontAttributeName];
[attributes setObject:[NSCursor arrowCursor]
forKey:NSCursorAttributeName];
scoped_nsobject<NSAttributedString> attributedString(
[[NSAttributedString alloc] initWithString:message
attributes:attributes]);
[[label_.get() textStorage] setAttributedString:attributedString];
}
- (void)removeButtons {
// Extend the label all the way across.
NSRect labelFrame = [label_.get() frame];
labelFrame.size.width = NSMaxX([cancelButton_ frame]) - NSMinX(labelFrame);
[okButton_ removeFromSuperview];
[cancelButton_ removeFromSuperview];
[label_.get() setFrame:labelFrame];
}
@end
@implementation InfoBarController (PrivateMethods)
- (void)initializeLabel {
// Replace the label placeholder NSTextField with the real label NSTextView.
// The former doesn't show links in a nice way, but the latter can't be added
// in IB without a containing scroll view, so create the NSTextView
// programmatically.
label_.reset([[InfoBarTextView alloc]
initWithFrame:[labelPlaceholder_ frame]]);
[label_.get() setAutoresizingMask:[labelPlaceholder_ autoresizingMask]];
[[labelPlaceholder_ superview]
replaceSubview:labelPlaceholder_ with:label_.get()];
labelPlaceholder_ = nil; // Now released.
[label_.get() setDelegate:self];
[label_.get() setEditable:NO];
[label_.get() setDrawsBackground:NO];
[label_.get() setHorizontallyResizable:NO];
[label_.get() setVerticallyResizable:NO];
}
- (void)removeInfoBar {
// TODO(rohitrao): This method can be called even if the infobar has already
// been removed and |delegate_| is NULL. Is there a way to rewrite the code
// so that inner event loops don't cause us to try and remove the infobar
// twice? http://crbug.com/54253
[containerController_ removeDelegate:delegate_];
}
- (void)cleanUpAfterAnimation:(BOOL)finished {
// Don't need to do any cleanup if the bar was animating open.
if (!infoBarClosing_)
return;
// Notify the delegate that the infobar was closed. The delegate may delete
// itself as a result of InfoBarClosed(), so we null out its pointer.
if (delegate_) {
delegate_->InfoBarClosed();
delegate_ = NULL;
}
// If the animation ran to completion, then we need to remove ourselves from
// the container. If the animation was interrupted, then the container will
// take care of removing us.
// TODO(rohitrao): UGH! This works for now, but should be cleaner.
if (finished)
[containerController_ removeController:self];
}
- (void)animationDidStop:(NSAnimation*)animation {
[self cleanUpAfterAnimation:NO];
}
- (void)animationDidEnd:(NSAnimation*)animation {
[self cleanUpAfterAnimation:YES];
}
// TODO(joth): This method factors out some common functionality between the
// various derived infobar classes, however the class hierarchy itself could
// use refactoring to reduce this duplication. http://crbug.com/38924
- (void)setLabelToMessage:(NSString*)message
withLink:(NSString*)link
atOffset:(NSUInteger)linkOffset {
if (linkOffset == std::wstring::npos) {
// linkOffset == std::wstring::npos means the link should be right-aligned,
// which is not supported on Mac (http://crbug.com/47728).
NOTIMPLEMENTED();
linkOffset = [message length];
}
// Create an attributes dictionary for the entire message. We have
// to expicitly set the font the control's font. We also override
// the cursor to give us the normal cursor rather than the text
// insertion cursor.
NSMutableDictionary* linkAttributes = [NSMutableDictionary dictionary];
[linkAttributes setObject:[NSCursor arrowCursor]
forKey:NSCursorAttributeName];
NSFont* font = [NSFont labelFontOfSize:
[NSFont systemFontSizeForControlSize:NSRegularControlSize]];
[linkAttributes setObject:font
forKey:NSFontAttributeName];
// Create the attributed string for the main message text.
scoped_nsobject<NSMutableAttributedString> infoText(
[[NSMutableAttributedString alloc] initWithString:message]);
[infoText.get() addAttributes:linkAttributes
range:NSMakeRange(0, [infoText.get() length])];
// Add additional attributes to style the link text appropriately as
// well as linkify it.
[linkAttributes setObject:[NSColor blueColor]
forKey:NSForegroundColorAttributeName];
[linkAttributes setObject:[NSNumber numberWithBool:YES]
forKey:NSUnderlineStyleAttributeName];
[linkAttributes setObject:[NSCursor pointingHandCursor]
forKey:NSCursorAttributeName];
[linkAttributes setObject:[NSNumber numberWithInt:NSSingleUnderlineStyle]
forKey:NSUnderlineStyleAttributeName];
[linkAttributes setObject:[NSString string] // dummy value
forKey:NSLinkAttributeName];
// Insert the link text into the string at the appropriate offset.
scoped_nsobject<NSAttributedString> attributedString(
[[NSAttributedString alloc] initWithString:link
attributes:linkAttributes]);
[infoText.get() insertAttributedString:attributedString.get()
atIndex:linkOffset];
// Update the label view with the new text.
[[label_.get() textStorage] setAttributedString:infoText];
}
@end
/////////////////////////////////////////////////////////////////////////
// AlertInfoBarController implementation
@implementation AlertInfoBarController
// Alert infobars have a text message.
- (void)addAdditionalControls {
// No buttons.
[self removeButtons];
// Insert the text.
AlertInfoBarDelegate* delegate = delegate_->AsAlertInfoBarDelegate();
DCHECK(delegate);
[self setLabelToMessage:base::SysUTF16ToNSString(delegate->GetMessageText())];
}
@end
/////////////////////////////////////////////////////////////////////////
// LinkInfoBarController implementation
@implementation LinkInfoBarController
// Link infobars have a text message, of which part is linkified. We
// use an NSAttributedString to display styled text, and we set a
// NSLink attribute on the hyperlink portion of the message. Infobars
// use a custom NSTextField subclass, which allows us to override
// textView:clickedOnLink:atIndex: and intercept clicks.
//
- (void)addAdditionalControls {
// No buttons.
[self removeButtons];
LinkInfoBarDelegate* delegate = delegate_->AsLinkInfoBarDelegate();
DCHECK(delegate);
size_t offset = std::wstring::npos;
string16 message = delegate->GetMessageTextWithOffset(&offset);
[self setLabelToMessage:base::SysUTF16ToNSString(message)
withLink:base::SysUTF16ToNSString(delegate->GetLinkText())
atOffset:offset];
}
// Called when someone clicks on the link in the infobar. This method
// is called by the InfobarTextField on its delegate (the
// LinkInfoBarController).
- (void)linkClicked {
WindowOpenDisposition disposition =
event_utils::WindowOpenDispositionFromNSEvent([NSApp currentEvent]);
if (delegate_ && delegate_->AsLinkInfoBarDelegate()->LinkClicked(disposition))
[self removeInfoBar];
}
@end
/////////////////////////////////////////////////////////////////////////
// ConfirmInfoBarController implementation
@implementation ConfirmInfoBarController
// Called when someone clicks on the "OK" button.
- (IBAction)ok:(id)sender {
if (delegate_ && delegate_->AsConfirmInfoBarDelegate()->Accept())
[self removeInfoBar];
}
// Called when someone clicks on the "Cancel" button.
- (IBAction)cancel:(id)sender {
if (delegate_ && delegate_->AsConfirmInfoBarDelegate()->Cancel())
[self removeInfoBar];
}
// Confirm infobars can have OK and/or cancel buttons, depending on
// the return value of GetButtons(). We create each button if
// required and position them to the left of the close button.
- (void)addAdditionalControls {
ConfirmInfoBarDelegate* delegate = delegate_->AsConfirmInfoBarDelegate();
DCHECK(delegate);
int visibleButtons = delegate->GetButtons();
NSRect okButtonFrame = [okButton_ frame];
NSRect cancelButtonFrame = [cancelButton_ frame];
DCHECK(NSMaxX(okButtonFrame) < NSMinX(cancelButtonFrame))
<< "Cancel button expected to be on the right of the Ok button in nib";
CGFloat rightEdge = NSMaxX(cancelButtonFrame);
CGFloat spaceBetweenButtons =
NSMinX(cancelButtonFrame) - NSMaxX(okButtonFrame);
CGFloat spaceBeforeButtons =
NSMinX(okButtonFrame) - NSMaxX([label_.get() frame]);
// Update and position the Cancel button if needed. Otherwise, hide it.
if (visibleButtons & ConfirmInfoBarDelegate::BUTTON_CANCEL) {
[cancelButton_ setTitle:base::SysUTF16ToNSString(
delegate->GetButtonLabel(ConfirmInfoBarDelegate::BUTTON_CANCEL))];
[GTMUILocalizerAndLayoutTweaker sizeToFitView:cancelButton_];
cancelButtonFrame = [cancelButton_ frame];
// Position the cancel button to the left of the Close button.
cancelButtonFrame.origin.x = rightEdge - cancelButtonFrame.size.width;
[cancelButton_ setFrame:cancelButtonFrame];
// Update the rightEdge
rightEdge = NSMinX(cancelButtonFrame);
} else {
[cancelButton_ removeFromSuperview];
}
// Update and position the OK button if needed. Otherwise, hide it.
if (visibleButtons & ConfirmInfoBarDelegate::BUTTON_OK) {
[okButton_ setTitle:base::SysUTF16ToNSString(
delegate->GetButtonLabel(ConfirmInfoBarDelegate::BUTTON_OK))];
[GTMUILocalizerAndLayoutTweaker sizeToFitView:okButton_];
okButtonFrame = [okButton_ frame];
// If we had a Cancel button, leave space between the buttons.
if (visibleButtons & ConfirmInfoBarDelegate::BUTTON_CANCEL) {
rightEdge -= spaceBetweenButtons;
}
// Position the OK button on our current right edge.
okButtonFrame.origin.x = rightEdge - okButtonFrame.size.width;
[okButton_ setFrame:okButtonFrame];
// Update the rightEdge
rightEdge = NSMinX(okButtonFrame);
} else {
[okButton_ removeFromSuperview];
}
// If we had either button, leave space before the edge of the textfield.
if ((visibleButtons & ConfirmInfoBarDelegate::BUTTON_CANCEL) ||
(visibleButtons & ConfirmInfoBarDelegate::BUTTON_OK)) {
rightEdge -= spaceBeforeButtons;
}
NSRect frame = [label_.get() frame];
DCHECK(rightEdge > NSMinX(frame))
<< "Need to make the xib larger to handle buttons with text this long";
frame.size.width = rightEdge - NSMinX(frame);
[label_.get() setFrame:frame];
// Set the text and link.
NSString* message = base::SysUTF16ToNSString(delegate->GetMessageText());
string16 link = delegate->GetLinkText();
if (link.empty()) {
// Simple case: no link, so just set the message directly.
[self setLabelToMessage:message];
} else {
// Inserting the link unintentionally causes the text to have a slightly
// different result to the simple case above: text is truncated on word
// boundaries (if needed) rather than elided with ellipses.
// Add spacing between the label and the link.
message = [message stringByAppendingString:@" "];
[self setLabelToMessage:message
withLink:base::SysUTF16ToNSString(link)
atOffset:[message length]];
}
}
// Called when someone clicks on the link in the infobar. This method
// is called by the InfobarTextField on its delegate (the
// LinkInfoBarController).
- (void)linkClicked {
WindowOpenDisposition disposition =
event_utils::WindowOpenDispositionFromNSEvent([NSApp currentEvent]);
if (delegate_ &&
delegate_->AsConfirmInfoBarDelegate()->LinkClicked(disposition))
[self removeInfoBar];
}
@end
//////////////////////////////////////////////////////////////////////////
// CreateInfoBar() implementations
InfoBar* AlertInfoBarDelegate::CreateInfoBar() {
AlertInfoBarController* controller =
[[AlertInfoBarController alloc] initWithDelegate:this];
return new InfoBar(controller);
}
InfoBar* LinkInfoBarDelegate::CreateInfoBar() {
LinkInfoBarController* controller =
[[LinkInfoBarController alloc] initWithDelegate:this];
return new InfoBar(controller);
}
InfoBar* ConfirmInfoBarDelegate::CreateInfoBar() {
ConfirmInfoBarController* controller =
[[ConfirmInfoBarController alloc] initWithDelegate:this];
return new InfoBar(controller);
}
|