6922215b97760e689fdc2a0a50c29c4f6274833d
[WebKit-https.git] / Source / WebKit / mac / WebCoreSupport / PopupMenuMac.mm
1 /*
2  * Copyright (C) 2006, 2008, 2010, 2011 Apple Inc. All rights reserved.
3  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #import "PopupMenuMac.h"
22
23 #import "WebDelegateImplementationCaching.h"
24 #import "WebFrameInternal.h"
25 #import <WebCore/IntRect.h>
26 #import <WebCore/AXObjectCache.h>
27 #import <WebCore/BlockExceptions.h>
28 #import <WebCore/Chrome.h>
29 #import <WebCore/ChromeClient.h>
30 #import <WebCore/EventHandler.h>
31 #import <WebCore/Frame.h>
32 #import <WebCore/FrameView.h>
33 #import <WebCore/Page.h>
34 #import <WebCore/PopupMenuClient.h>
35 #import <WebCore/SimpleFontData.h>
36 #import <WebCore/WebCoreSystemInterface.h>
37
38 using namespace WebCore;
39
40 PopupMenuMac::PopupMenuMac(PopupMenuClient* client)
41     : m_client(client)
42 {
43 }
44
45 PopupMenuMac::~PopupMenuMac()
46 {
47     [m_popup setControlView:nil];
48 }
49
50 void PopupMenuMac::clear()
51 {
52     [m_popup removeAllItems];
53 }
54
55 void PopupMenuMac::populate()
56 {
57     if (m_popup)
58         clear();
59     else {
60         m_popup = adoptNS([[NSPopUpButtonCell alloc] initTextCell:@"" pullsDown:!m_client->shouldPopOver()]);
61         [m_popup setUsesItemFromMenu:NO];
62         [m_popup setAutoenablesItems:NO];
63     }
64     
65     // For pullDown menus the first item is hidden.
66     if (!m_client->shouldPopOver())
67         [m_popup addItemWithTitle:@""];
68
69     TextDirection menuTextDirection = m_client->menuStyle().textDirection();
70     [m_popup setUserInterfaceLayoutDirection:menuTextDirection == LTR ? NSUserInterfaceLayoutDirectionLeftToRight : NSUserInterfaceLayoutDirectionRightToLeft];
71
72     ASSERT(m_client);
73     int size = m_client->listSize();
74
75     for (int i = 0; i < size; i++) {
76         if (m_client->itemIsSeparator(i)) {
77             [[m_popup menu] addItem:[NSMenuItem separatorItem]];
78             continue;
79         }
80
81         PopupMenuStyle style = m_client->itemStyle(i);
82         RetainPtr<NSMutableDictionary> attributes = adoptNS([[NSMutableDictionary alloc] init]);
83         if (style.font() != Font()) {
84             NSFont *font = style.font().primaryFont()->getNSFont();
85             if (!font) {
86                 CGFloat size = style.font().primaryFont()->platformData().size();
87                 font = style.font().weight() < FontWeightBold ? [NSFont systemFontOfSize:size] : [NSFont boldSystemFontOfSize:size];
88             }
89             [attributes setObject:font forKey:NSFontAttributeName];
90         }
91
92         RetainPtr<NSMutableParagraphStyle> paragraphStyle = adoptNS([[NSParagraphStyle defaultParagraphStyle] mutableCopy]);
93         [paragraphStyle setAlignment:menuTextDirection == LTR ? NSLeftTextAlignment : NSRightTextAlignment];
94         NSWritingDirection writingDirection = style.textDirection() == LTR ? NSWritingDirectionLeftToRight : NSWritingDirectionRightToLeft;
95         [paragraphStyle setBaseWritingDirection:writingDirection];
96         if (style.hasTextDirectionOverride()) {
97             RetainPtr<NSNumber> writingDirectionValue = adoptNS([[NSNumber alloc] initWithInteger:writingDirection + NSTextWritingDirectionOverride]);
98             RetainPtr<NSArray> writingDirectionArray = adoptNS([[NSArray alloc] initWithObjects:writingDirectionValue.get(), nil]);
99             [attributes setObject:writingDirectionArray.get() forKey:NSWritingDirectionAttributeName];
100         }
101         [attributes setObject:paragraphStyle.get() forKey:NSParagraphStyleAttributeName];
102
103         // FIXME: Add support for styling the foreground and background colors.
104         // FIXME: Find a way to customize text color when an item is highlighted.
105         RetainPtr<NSAttributedString> string = adoptNS([[NSAttributedString alloc] initWithString:m_client->itemText(i) attributes:attributes.get()]);
106
107         [m_popup addItemWithTitle:@""];
108         NSMenuItem *menuItem = [m_popup lastItem];
109         [menuItem setAttributedTitle:string.get()];
110         // We set the title as well as the attributed title here. The attributed title will be displayed in the menu,
111         // but typeahead will use the non-attributed string that doesn't contain any leading or trailing whitespace.
112         [menuItem setTitle:[[string string] stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]]];
113         [menuItem setEnabled:m_client->itemIsEnabled(i)];
114         [menuItem setToolTip:m_client->itemToolTip(i)];
115
116 #pragma clang diagnostic push
117 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
118         // Allow the accessible text of the item to be overriden if necessary.
119         if (AXObjectCache::accessibilityEnabled()) {
120             NSString *accessibilityOverride = m_client->itemAccessibilityText(i);
121             if ([accessibilityOverride length])
122                 [menuItem accessibilitySetOverrideValue:accessibilityOverride forAttribute:NSAccessibilityDescriptionAttribute];
123         }
124 #pragma clang diagnostic pop
125     }
126 }
127
128 void PopupMenuMac::show(const IntRect& r, FrameView* v, int index)
129 {
130     populate();
131     int numItems = [m_popup numberOfItems];
132     if (numItems <= 0) {
133         if (m_client)
134             m_client->popupDidHide();
135         return;
136     }
137     ASSERT(numItems > index);
138
139     // Workaround for crazy bug where a selected index of -1 for a menu with only 1 item will cause a blank menu.
140     if (index == -1 && numItems == 2 && !m_client->shouldPopOver() && ![[m_popup itemAtIndex:1] isEnabled])
141         index = 0;
142
143     NSView* view = v->documentView();
144
145     [m_popup attachPopUpWithFrame:r inView:view];
146     [m_popup selectItemAtIndex:index];
147
148     NSMenu* menu = [m_popup menu];
149     
150     NSPoint location;
151     NSFont* font = m_client->menuStyle().font().primaryFont()->getNSFont();
152
153     // These values were borrowed from AppKit to match their placement of the menu.
154     const int popOverHorizontalAdjust = -10;
155     const int popUnderHorizontalAdjust = 6;
156     const int popUnderVerticalAdjust = 6;
157     if (m_client->shouldPopOver()) {
158         NSRect titleFrame = [m_popup titleRectForBounds:r];
159         if (titleFrame.size.width <= 0 || titleFrame.size.height <= 0)
160             titleFrame = r;
161         float vertOffset = roundf((NSMaxY(r) - NSMaxY(titleFrame)) + NSHeight(titleFrame));
162         // Adjust for fonts other than the system font.
163         NSFont* defaultFont = [NSFont systemFontOfSize:[font pointSize]];
164         vertOffset += [font descender] - [defaultFont descender];
165         vertOffset = fminf(NSHeight(r), vertOffset);
166     
167         location = NSMakePoint(NSMinX(r) + popOverHorizontalAdjust, NSMaxY(r) - vertOffset);
168     } else
169         location = NSMakePoint(NSMinX(r) + popUnderHorizontalAdjust, NSMaxY(r) + popUnderVerticalAdjust);    
170
171     // Save the current event that triggered the popup, so we can clean up our event
172     // state after the NSMenu goes away.
173     Ref<Frame> frame(v->frame());
174     RetainPtr<NSEvent> event = frame->eventHandler().currentNSEvent();
175     
176     Ref<PopupMenuMac> protector(*this);
177
178     RetainPtr<NSView> dummyView = adoptNS([[NSView alloc] initWithFrame:r]);
179     [view addSubview:dummyView.get()];
180     location = [dummyView convertPoint:location fromView:view];
181     
182     if (Page* page = frame->page()) {
183         WebView* webView = kit(page);
184         BEGIN_BLOCK_OBJC_EXCEPTIONS;
185         CallUIDelegate(webView, @selector(webView:willPopupMenu:), menu);
186         END_BLOCK_OBJC_EXCEPTIONS;
187     }
188
189     NSControlSize controlSize;
190     switch (m_client->menuStyle().menuSize()) {
191     case PopupMenuStyle::PopupMenuSizeNormal:
192         controlSize = NSRegularControlSize;
193         break;
194     case PopupMenuStyle::PopupMenuSizeSmall:
195         controlSize = NSSmallControlSize;
196         break;
197     case PopupMenuStyle::PopupMenuSizeMini:
198         controlSize = NSMiniControlSize;
199         break;
200     }
201
202     wkPopupMenu(menu, location, roundf(NSWidth(r)), dummyView.get(), index, font, controlSize, !m_client->menuStyle().hasDefaultAppearance());
203
204     [m_popup dismissPopUp];
205     [dummyView removeFromSuperview];
206
207     if (!m_client)
208         return;
209
210     int newIndex = [m_popup indexOfSelectedItem];
211     m_client->popupDidHide();
212
213     // Adjust newIndex for hidden first item.
214     if (!m_client->shouldPopOver())
215         newIndex--;
216
217     if (index != newIndex && newIndex >= 0)
218         m_client->valueChanged(newIndex);
219
220     // Give the frame a chance to fix up its event state, since the popup eats all the
221     // events during tracking.
222     frame->eventHandler().sendFakeEventsAfterWidgetTracking(event.get());
223 }
224
225 void PopupMenuMac::hide()
226 {
227     [m_popup dismissPopUp];
228 }
229     
230 void PopupMenuMac::updateFromElement()
231 {
232 }
233
234 void PopupMenuMac::disconnectClient()
235 {
236     m_client = 0;
237 }