╭─────────────╮ │scroll to top│ ╰─────────────╯ ╭ ui.zig ───────────────────────────────────────────────────────╮ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ╰───────────────────────────────────────────────────────────────╯
╭────╮ ╭ clone ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ╮ │http│ ssh │ │ ╰────╯ ╰ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ╯
2774 2775 // one option of a radio field, as `radio:<name>=<value>` 2776 pub const radio_prefix = "radio:"; 2777 2778 // the url an `ax:` link points at, or null for anything else. a host that 2779 // suppresses the anchor's own navigation needs this to follow the link. 2780 pub fn rawLink(root_focus: *Focus, focus_id: usize) ?[]const u8 { 2781 const child = root_focus.children.get(focus_id) orelse return null; 2782 const custom = switch (child.focus.kind) { 2783 .custom => |c| c, 2784 else => return null, 2785 }; 2786 if (!std.mem.startsWith(u8, custom, raw_link_prefix)) return null; 2787 return custom[raw_link_prefix.len..]; 2788 } 2789 2790 fn requestRawLink(session: *Session, url: []const u8) !void { 2791 session.host_request = .{ .show_copyable_text = try terminalWebUrl(session.page_arena.allocator(), session, url) }; 2792 } 2793 2794 pub fn terminalWebUrl(allocator: std.mem.Allocator, session: *const Session, path: []const u8) ![]const u8 { 2795 // an absolute url is already complete 2796 if (!std.mem.startsWith(u8, path, "/")) return path; 2797 return if (session.web_port) |port| 2798 try allocator.print("http://localhost:{d}{s}", .{ port, path }) 2799 else 2800 path; 2801 } 2802 2803 // if the focus target at focus_id is an `a:` link that should navigate (a 2804 // different parent page, or a different files directory within the repo page), 2805 // return its route; otherwise null. lets a host turn a click / enter on such a 2806 // link into a navigation rather than a focus change. 2807 pub fn crossPageLink(root_focus: *Focus, focus_id: usize, data: Session.Data) ?RoutablePage { 2808 const current = data.current_page; 2809 const route = pageLink(root_focus, focus_id, data, "a:") orelse return null; 2810 // a link to a different parent page always navigates; within a page, a 2811 // files-directory / commits-page / list-window change navigates while tab 2812 // links stay in-page. 2813 if (route.parent() != current.parent() or RoutablePage.repoPageChanged(route, current) or RoutablePage.forkPageChanged(route, current) or RoutablePage.homePageChanged(route, current) or RoutablePage.userPageChanged(route, current)) return route; 2814 return null; 2815 } 2816 2817 // the page the clicked cell links to, from a link inside a text box's content 2818 fn cellPageLink(root: *Widget, x: usize, y: usize, data: Session.Data) ?RoutablePage { 2819 const grid = root.getGrid() orelse return null; 2820 const cell = grid.cell(x, y) catch return null; 2821 const link = cell.link orelse return null; 2822 if (link.len == 0 or link[0] != '/') return null; 2823 return if (data.host_kind == .local) RoutablePage.fromUrlLocal(link) else RoutablePage.fromUrl(link); 2824 } 2825 2826 // whether the `a:` focus target links to the page already shown, which a click 2827 // leaves alone rather than focusing 2828 pub fn currentPageLink(root_focus: *Focus, focus_id: usize, data: Session.Data) bool { 2829 const route = pageLink(root_focus, focus_id, data, "a:") orelse return false; 2830 return route.eql(data.current_page); 2831 } 2832 2833 // the route carried by an `ai:` focus target, or null for any other target 2834 pub fn inPageLink(root_focus: *Focus, focus_id: usize, data: Session.Data) ?RoutablePage { 2835 return pageLink(root_focus, focus_id, data, in_page_link_prefix); 2836 } 2837 2838 fn pageLink(root_focus: *Focus, focus_id: usize, data: Session.Data, prefix: []const u8) ?RoutablePage { 2839 const child = root_focus.children.get(focus_id) orelse return null; 2840 const custom = switch (child.focus.kind) { 2841 .custom => |c| c, 2842 else => return null, 2843 }; 2844 if (!std.mem.startsWith(u8, custom, prefix)) return null; 2845 const path = custom[prefix.len..]; 2846 // local sessions build (and parse) links with the repo identity elided 2847 return if (data.host_kind == .local) RoutablePage.fromUrlLocal(path) else RoutablePage.fromUrl(path); 2848 } 2849 2850 // an assignee as the detail view shows it: the stored email, and the name of 2851 // the user holding it on this instance when there is one 2852 pub const Assignee = struct { 2853 email: []const u8, 2854 name: ?[]const u8 = null, 2855 2856 pub fn display(self: Assignee) []const u8 { 2857 return self.name orelse self.email; 2858 } 2859 }; 2860 2861 // a display author, resolved against the admin db at read time 2862 pub const Author = union(enum) { 2863 unknown, 2864 email: []const u8, // an email no user matches 2865 user_name: []const u8, 2866 2867 // the commit author line's email, resolved like initFromEmail 2868 pub fn init( 2869 haxy_moment: ?evt.AdminDB.HashMap(.read_only), 2870 arena: *std.heap.ArenaAllocator, 2871 author_line: []const u8, 2872 ) !Author { 2873 return initFromEmail(haxy_moment, arena, evt.authorEmail(author_line)); 2874 } 2875 2876 // from a record's stored author email: it resolves to the user currently 2877 // holding it, else stays the email. the result is allocated in `arena`, 2878 // so the email may borrow transient memory. 2879 pub fn initFromEmail( 2880 haxy_moment: ?evt.AdminDB.HashMap(.read_only), 2881 arena: *std.heap.ArenaAllocator, 2882 author_email: ?[]const u8, 2883 ) !Author { 2884 const email = author_email orelse return .unknown; 2885 if (haxy_moment) |moment| { 2886 if (try evt.User.readByEmail(evt.AdminDB, evt.admin_repo_opts.hash, moment, arena, email)) |user| { 2887 return .{ .user_name = user.name }; 2888 } 2889 } 2890 return .{ .email = try arena.allocator().dupe(u8, email) }; 2891 } 2892 }; 2893 2894 // the "a:" link to user `name`'s page. 2895 pub fn userLink(page_arena: *std.heap.ArenaAllocator, name: []const u8) ![]const u8 { 2896 const parsed = RoutablePage.Array(evt.User.name_max_len).from(name) orelse return error.RouteTooLong; 2897 const url = try (RoutablePage{ .user_repos = .{ .name = parsed } }).toUrl(page_arena); 2898 return page_arena.allocator().print("a:{s}", .{url}); 2899 } 2900 2901 // a focusable " author " box showing `author`, linking to their user page 2902 // when it is a known user 2903 pub fn authorBox(allocator: std.mem.Allocator, page_arena: *std.heap.ArenaAllocator, author: Author) !wgt.TextBox { 2904 const text = switch (author) { 2905 .unknown => "", 2906 .email, .user_name => |t| t, 2907 }; 2908 var tb = try wgt.TextBox.init(allocator, text, .{ .border = .single, .round_corners = true, .wrap_kind = .none, .top_label = .{ .text = " author " } }); 2909 errdefer tb.deinit(allocator); 2910 tb.getFocus().mode = .all; 2911 switch (author) { 2912 .user_name => |name| tb.getFocus().kind = .{ .custom = try userLink(page_arena, name) }, 2913 else => {}, 2914 } 2915 return tb; 2916 } 2917 2918 // native-TUI navigation 2919 pub const Nav = struct { 2920 root: Widget, 2921 // backs the current page (its Page data and the page-scoped strings its 2922 // widgets build). owned here, swapped on each navigation. session.page_arena 2923 // tracks whichever of these is current so widgets allocate into it. 2924 arena: *std.heap.ArenaAllocator, 2925 // the login the current root was built for 2926 user_id: ?[evt.event_id_size]u8, 2927 history: std.ArrayList(Entry), 2928 2929 // each retained page keeps its own arena, freed when the page leaves the 2930 // stack (popped on back, evicted at cap, or on deinit). this is what keeps a 2931 // long-lived session from accumulating every page it ever visited. 2932 const Entry = struct { root: Widget, route: RoutablePage, arena: *std.heap.ArenaAllocator, user_id: ?[evt.event_id_size]u8 }; 2933 2934 // cap on retained back-history so the chain can't grow memory without bound 2935 const max_history: usize = 16; 2936 2937 pub fn init(allocator: std.mem.Allocator, session: *Session) !Nav { 2938 session.back = .unavailable; 2939 const arena = try allocator.create(std.heap.ArenaAllocator); 2940 arena.* = std.heap.ArenaAllocator.init(allocator); 2941 errdefer { 2942 arena.deinit(); 2943 allocator.destroy(arena); 2944 } 2945 2946 return .{ 2947 .root = try initCurrentRoot(allocator, arena, session), 2948 .arena = arena, 2949 .user_id = session.userId(), 2950 .history = .empty, 2951 }; 2952 } 2953 2954 pub fn deinit(self: *Nav, allocator: std.mem.Allocator) void { 2955 self.root.deinit(allocator); 2956 freeArena(allocator, self.arena); 2957 for (self.history.items) |*entry| { 2958 entry.root.deinit(allocator); 2959 freeArena(allocator, entry.arena); 2960 } 2961 self.history.deinit(allocator); 2962 } 2963 2964 // rebuild the current page in place from a current moment 2965 fn rebuild(self: *Nav, allocator: std.mem.Allocator, session: *Session) !void { 2966 if (session.haxy_moment == null and session.local == null) return; 2967 const arena = try allocator.create(std.heap.ArenaAllocator); 2968 arena.* = std.heap.ArenaAllocator.init(allocator); 2969 errdefer freeArena(allocator, arena); 2970 2971 const new_root = try initCurrentRoot(allocator, arena, session); 2972 2973 self.root.deinit(allocator); 2974 freeArena(allocator, self.arena); 2975 self.root = new_root; 2976 self.arena = arena; 2977 self.user_id = session.userId(); 2978 } 2979 2980 // build the current page's root in `arena`, or the not-found page's when 2981 // the route names nothing 2982 fn initCurrentRoot(allocator: std.mem.Allocator, arena: *std.heap.ArenaAllocator, session: *Session) !Widget { 2983 session.page_arena = arena; 2984 const page = try arena.allocator().create(Page); 2985 page.* = Page.init(arena, session, session.data.current_page) catch |err| switch (err) { 2986 error.NotFound => blk: { 2987 session.data.current_page = .not_found; 2988 break :blk .not_found; 2989 }, 2990 else => |e| return e, 2991 }; 2992 return initRoot(allocator, page, session); 2993 } 2994 2995 fn freeArena(allocator: std.mem.Allocator, arena: *std.heap.ArenaAllocator) void { 2996 arena.deinit(); 2997 allocator.destroy(arena); 2998 } 2999 3000 // reconcile the displayed root with the session's navigation state. a 3001 // forward nav (current_page moved to a different parent page) pushes the 3002 // current root and builds the new page in a fresh arena; a back request 3003 // frees the current page and restores the previous one. when escape is 3004 // pressed with no history left we switch to the quit tab instead of quitting. 3005 // returns whether the root was replaced. 3006 pub fn sync(self: *Nav, allocator: std.mem.Allocator, session: *Session) !bool { 3007 // refresh: rebuild the current page in place from a current moment 3008 if (session.refresh_requested) { 3009 session.refresh_requested = false; 3010 try self.rebuild(allocator, session); 3011 return true; 3012 } 3013 3014 if (session.back == .requested) { 3015 if (self.history.pop()) |entry| { 3016 session.back = if (self.history.items.len == 0) .unavailable else .available; 3017 self.root.deinit(allocator); 3018 freeArena(allocator, self.arena); 3019 self.root = entry.root; 3020 self.arena = entry.arena; 3021 self.user_id = entry.user_id; 3022 session.page_arena = entry.arena; 3023 session.data.current_page = entry.route; 3024 // a page built under another login is rebuilt rather than restored 3025 if (!std.meta.eql(entry.user_id, session.userId())) { 3026 try self.rebuild(allocator, session); 3027 return true; 3028 } 3029 chooseAnsiArtForNavigation(session); 3030 return true; 3031 } 3032 session.back = .unavailable; 3033 // nothing to go back to; switch to the quit confirmation 3034 const root_focus = self.root.getFocus(); 3035 var iter = root_focus.children.iterator(); 3036 while (iter.next()) |entry| { 3037 switch (entry.value_ptr.focus.kind) { 3038 .custom => |custom| if (std.mem.eql(u8, custom, Quit.tab_kind)) { 3039 root_focus.setFocus(entry.key_ptr.*); 3040 // a Stack only builds its selected child, so the quit 3041 // button isn't in the focus tree until a build runs with 3042 // the quit tab selected. build once, then send a 3043 // synthetic arrow_down to drop focus from the tab onto 3044 // the button so it's ready to confirm. 3045 try self.root.build(allocator, .{ 3046 .min_size = .{ .width = null, .height = 40 }, 3047 .max_size = .{ .width = 80, .height = null }, 3048 }, root_focus); 3049 try self.root.input(allocator, .arrow_down, root_focus); 3050 break; 3051 }, 3052 else => {}, 3053 } 3054 } 3055 return false; 3056 } 3057 3058 // forward navigation: navigate() set next_page to the page to move to (a 3059 // cross-page link or tab change crossing pages) 3060 if (session.next_page) |route| { 3061 session.next_page = null; 3062 if (session.haxy_moment == null and session.local == null) return false; 3063 const previous_route = session.data.current_page; 3064 // the page we navigated to becomes the current page 3065 session.data.current_page = route; 3066 session.back = .available; 3067 3068 const arena = try allocator.create(std.heap.ArenaAllocator); 3069 arena.* = std.heap.ArenaAllocator.init(allocator); 3070 errdefer freeArena(allocator, arena); 3071 3072 const new_root = try initCurrentRoot(allocator, arena, session); 3073 3074 try self.history.append(allocator, .{ .root = self.root, .route = previous_route, .arena = self.arena, .user_id = self.user_id }); 3075 // drop the oldest entry (freeing its widget tree and arena) once over cap 3076 if (self.history.items.len > max_history) { 3077 var oldest = self.history.orderedRemove(0); 3078 oldest.root.deinit(allocator); 3079 freeArena(allocator, oldest.arena); 3080 } 3081 self.root = new_root; 3082 self.arena = arena; 3083 self.user_id = session.userId(); 3084 return true; 3085 } 3086 return false; 3087 } 3088 }; 3089 3090 pub fn initRoot(allocator: std.mem.Allocator, page: *const Page, session: *Session) !Widget { 3091 const page_widget: Widget = switch (page.*) { 3092 .home => |*p| .{ .home = try .init(allocator, p, session) }, 3093 .user => |*p| .{ .user = try .init(allocator, p, session) }, 3094 .repo => |*p| .{ .repo = try .init(allocator, p, session) }, 3095 .fork => |*p| .{ .fork = try .init(allocator, p, session) }, 3096 .not_found => .{ .not_found = try .init(allocator, session) }, 3097 }; 3098 3099 chooseAnsiArtForNavigation(session); 3100 3101 // on the TUI/SSH, the page sits above a one-row footer showing its web 3102 // url, when there's a web UI to point at 3103 var root = if (session.is_terminal) blk: { 3104 var box = try wgt.Box(Widget).init(allocator, .{ .border = null, .direction = .vert }); 3105 errdefer box.deinit(allocator); 3106 const bg_id = bg_blk: { 3107 var background = try widget.AnsiBackground.init(allocator, page_widget, session); 3108 errdefer background.deinit(allocator); 3109 const id = background.getFocus().id; 3110 try box.children.put(allocator, id, .{ .widget = .{ .background = background }, .rect = null, .min_size = null }); 3111 break :bg_blk id; 3112 }; 3113 if (session.web_port != null) { 3114 var footer = try widget.Footer.init(allocator, session); 3115 errdefer footer.deinit(allocator); 3116 try box.children.put(allocator, footer.getFocus().id, .{ .widget = .{ .footer = footer }, .rect = null, .min_size = .{ .width = null, .height = 1 } }); 3117 } 3118 box.getFocus().child_id = bg_id; 3119 break :blk Widget{ .box = box }; 3120 } else Widget{ .background = try widget.AnsiBackground.init(allocator, page_widget, session) }; 3121 errdefer root.deinit(allocator); 3122 3123 // input-owning views build their TextInputs in init, so reset their 3124 // registrations here 3125 session.text_inputs.clearRetainingCapacity(); 3126 3127 try root.build(allocator, .{ 3128 .min_size = .{ .width = null, .height = 40 }, 3129 .max_size = .{ .width = 100, .height = null }, 3130 }, root.getFocus()); 3131 3132 return root; 3133 } 3134 3135 // native and server-side sessions choose from the embedded collection. WASM 3136 // keeps the art serialized by the server instead. 3137 fn chooseAnsiArtForNavigation(session: *Session) void { 3138 if (comptime ansi_art.art.len == 0) return; 3139 if (session.data.current_page == .not_found) { 3140 session.data.ansi_art = ansi_art.not_found; 3141 return; 3142 } 3143 const io = session.io orelse return; 3144 var random: usize = undefined; 3145 io.random(std.mem.asBytes(&random)); 3146 session.data.ansi_art = ansi_art.art[random % ansi_art.art.len]; 3147 } 3148