Ladybird: Implement an AppKit chrome for macOS :^)

This adds an alternative Ladybird chrome for macOS using the AppKit framework. Just about everything needed for normal web browsing has been implemented. This includes: * Tabbed, scrollable navigation * History navigation (back, forward, reload) * Keyboard / mouse events * Favicons * Context menus * Cookies * Dialogs (alert, confirm, prompt) * WebDriver support This does not include debugging tools like the JavaScript console and inspector, nor theme support. The Qt chrome is still used by default. To use the AppKit chrome, set the ENABLE_QT CMake option to OFF.
2025-07-27 14:17:36 +00:00 · 2023-08-20 16:14:31 -04:00 · 2023-08-20 16:14:31 -04:00 · 5722d0025b
commit 5722d0025b
parent 66a89bd695
28 changed files with 3248 additions and 3 deletions
--- a/Ladybird/AppKit/UI/Tab.mm
+++ b/Ladybird/AppKit/UI/Tab.mm
@ -0,0 +1,170 @@
+/*
+ * Copyright (c) 2023, Tim Flynn <trflynn89@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#import <UI/LadybirdWebView.h>
+#import <UI/Tab.h>
+#import <UI/TabController.h>
+#import <Utilities/Conversions.h>
+
+#include <Ladybird/Utilities.h>
+
+#if !__has_feature(objc_arc)
+#    error "This project requires ARC"
+#endif
+
+static constexpr CGFloat const WINDOW_WIDTH = 1000;
+static constexpr CGFloat const WINDOW_HEIGHT = 800;
+
+@interface Tab ()
+
+@property (nonatomic, strong) NSString* title;
+@property (nonatomic, strong) NSImage* favicon;
+
+@end
+
+@implementation Tab
+
+@dynamic title;
+
+ (NSImage*)defaultFavicon
+{
+    static NSImage* default_favicon;
+    static dispatch_once_t token;
+
+    dispatch_once(&token, ^{
+        auto default_favicon_path = MUST(String::formatted("{}/res/icons/16x16/app-browser.png", s_serenity_resource_root));
+        auto* ns_default_favicon_path = Ladybird::string_to_ns_string(default_favicon_path);
+
+        default_favicon = [[NSImage alloc] initWithContentsOfFile:ns_default_favicon_path];
+    });
+
+    return default_favicon;
+}
+
+- (instancetype)init
+{
+    auto screen_rect = [[NSScreen mainScreen] frame];
+    auto position_x = (NSWidth(screen_rect) - WINDOW_WIDTH) / 2;
+    auto position_y = (NSHeight(screen_rect) - WINDOW_HEIGHT) / 2;
+
+    auto window_rect = NSMakeRect(position_x, position_y, WINDOW_WIDTH, WINDOW_HEIGHT);
+    auto style_mask = NSWindowStyleMaskTitled | NSWindowStyleMaskClosable | NSWindowStyleMaskMiniaturizable | NSWindowStyleMaskResizable;
+
+    self = [super initWithContentRect:window_rect
+                            styleMask:style_mask
+                              backing:NSBackingStoreBuffered
+                                defer:NO];
+
+    if (self) {
+        self.web_view = [[LadybirdWebView alloc] init];
+        [self.web_view setPostsBoundsChangedNotifications:YES];
+
+        self.favicon = [Tab defaultFavicon];
+        self.title = @"New Tab";
+        [self updateTabTitleAndFavicon];
+
+        [self setTitleVisibility:NSWindowTitleHidden];
+        [self setIsVisible:YES];
+
+        auto* scroll_view = [[NSScrollView alloc] initWithFrame:[self frame]];
+        [scroll_view setHasVerticalScroller:YES];
+        [scroll_view setHasHorizontalScroller:YES];
+        [scroll_view setLineScroll:24];
+
+        [scroll_view setContentView:self.web_view];
+        [scroll_view setDocumentView:[[NSView alloc] init]];
+
+        [[NSNotificationCenter defaultCenter]
+            addObserver:self
+               selector:@selector(onContentScroll:)
+                   name:NSViewBoundsDidChangeNotification
+                 object:[scroll_view contentView]];
+
+        [self setContentView:scroll_view];
+    }
+
+    return self;
+}
+
+#pragma mark - Public methods
+
+- (void)onLoadStart:(URL const&)url
+{
+    self.title = Ladybird::string_to_ns_string(url.serialize());
+    self.favicon = [Tab defaultFavicon];
+    [self updateTabTitleAndFavicon];
+}
+
+- (void)onTitleChange:(NSString*)title
+{
+    self.title = title;
+    [self updateTabTitleAndFavicon];
+}
+
+- (void)onFaviconChange:(NSImage*)favicon
+{
+    self.favicon = favicon;
+    [self updateTabTitleAndFavicon];
+}
+
+#pragma mark - Private methods
+
+- (void)updateTabTitleAndFavicon
+{
+    auto* favicon_attachment = [[NSTextAttachment alloc] init];
+    favicon_attachment.image = self.favicon;
+
+    // By default, the image attachment will "automatically adapt to the surrounding font and color
+    // attributes in attributed strings". Therefore, we specify a clear color here to prevent the
+    // favicon from having a weird tint.
+    auto* favicon_attribute = (NSMutableAttributedString*)[NSMutableAttributedString attributedStringWithAttachment:favicon_attachment];
+    [favicon_attribute addAttribute:NSForegroundColorAttributeName
+                              value:[NSColor clearColor]
+                              range:NSMakeRange(0, [favicon_attribute length])];
+
+    // By default, the text attachment will be aligned to the bottom of the string. We have to manually
+    // try to center it vertically.
+    // FIXME: Figure out a way to programmatically arrive at a good NSBaselineOffsetAttributeName. Using
+    //        half the distance between the font's line height and the height of the favicon produces a
+    //        value that results in the title being aligned too low still.
+    auto* title_attributes = @{
+        NSForegroundColorAttributeName : [NSColor textColor],
+        NSBaselineOffsetAttributeName : @3
+    };
+
+    auto* title_attribute = [[NSAttributedString alloc] initWithString:self.title
+                                                            attributes:title_attributes];
+
+    auto* spacing_attribute = [[NSAttributedString alloc] initWithString:@"  "];
+
+    auto* title_and_favicon = [[NSMutableAttributedString alloc] init];
+    [title_and_favicon appendAttributedString:favicon_attribute];
+    [title_and_favicon appendAttributedString:spacing_attribute];
+    [title_and_favicon appendAttributedString:title_attribute];
+
+    [[self tab] setAttributedTitle:title_and_favicon];
+}
+
+- (void)onContentScroll:(NSNotification*)notification
+{
+    [[self web_view] handleScroll];
+}
+
+#pragma mark - NSWindow
+
+- (void)setIsVisible:(BOOL)flag
+{
+    [[self web_view] handleVisibility:flag];
+    [super setIsVisible:flag];
+}
+
+- (void)setIsMiniaturized:(BOOL)flag
+{
+    [[self web_view] handleVisibility:!flag];
+    [super setIsMiniaturized:flag];
+}
+
+@end