Remove ! from todo!() in comments (#8643)

This practice makes it difficult to locate todo!s in my code when I'm
working. Let's take out the bang if we want to keep doing this.

Release Notes:

- N/A
This commit is contained in:
Nathan Sobo 2024-02-29 18:19:05 -07:00 committed by GitHub
parent dab886f479
commit 4cc4f08a53
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
39 changed files with 116 additions and 116 deletions

View file

@ -96,7 +96,7 @@ objc = "0.2"
flume = "0.11"
open = "5.0.1"
ashpd = "0.7.0"
# todo!(linux) - Technically do not use `randr`, but it doesn't compile otherwise
# todo(linux) - Technically do not use `randr`, but it doesn't compile otherwise
xcb = { version = "1.3", features = ["as-raw-xcb-connection", "present", "randr", "xkb"] }
wayland-client= { version = "0.31.2" }
wayland-protocols = { version = "0.31.2", features = ["client", "staging", "unstable"] }

View file

@ -1,6 +1,6 @@
// todo!(linux): remove
// todo(linux): remove
#![cfg_attr(target_os = "linux", allow(dead_code))]
// todo!("windows"): remove
// todo("windows"): remove
#![cfg_attr(windows, allow(dead_code))]
mod app_menu;
@ -63,7 +63,7 @@ pub(crate) fn current_platform() -> Rc<dyn Platform> {
pub(crate) fn current_platform() -> Rc<dyn Platform> {
Rc::new(LinuxPlatform::new())
}
// todo!("windows")
// todo("windows")
#[cfg(target_os = "windows")]
pub(crate) fn current_platform() -> Rc<dyn Platform> {
unimplemented!()

View file

@ -564,7 +564,7 @@ impl BladeRenderer {
}
PrimitiveBatch::Paths(paths) => {
let mut encoder = pass.with(&self.pipelines.paths);
//todo!(linux): group by texture ID
// todo(linux): group by texture ID
for path in paths {
let tile = &self.path_tiles[&path.id];
let tex_info = self.atlas.get_texture_info(tile.texture_id);

View file

@ -1,7 +1,7 @@
#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
//todo!(linux): remove
// todo(linux): remove
#![allow(unused_variables)]
use crate::{PlatformDispatcher, TaskLabel};

View file

@ -141,19 +141,19 @@ impl Platform for LinuxPlatform {
self.inner.loop_signal.stop();
}
//todo!(linux)
// todo(linux)
fn restart(&self) {}
//todo!(linux)
// todo(linux)
fn activate(&self, ignoring_other_apps: bool) {}
//todo!(linux)
// todo(linux)
fn hide(&self) {}
//todo!(linux)
// todo(linux)
fn hide_other_apps(&self) {}
//todo!(linux)
// todo(linux)
fn unhide_other_apps(&self) {}
fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>> {
@ -164,7 +164,7 @@ impl Platform for LinuxPlatform {
self.client.display(id)
}
//todo!(linux)
// todo(linux)
fn active_window(&self) -> Option<AnyWindowHandle> {
None
}
@ -328,7 +328,7 @@ impl Platform for LinuxPlatform {
unimplemented!()
}
//todo!(linux)
// todo(linux)
fn set_menus(&self, menus: Vec<Menu>, keymap: &Keymap) {}
fn local_timezone(&self) -> UtcOffset {
@ -339,18 +339,18 @@ impl Platform for LinuxPlatform {
unimplemented!()
}
//todo!(linux)
// todo(linux)
fn set_cursor_style(&self, style: CursorStyle) {}
//todo!(linux)
// todo(linux)
fn should_auto_hide_scrollbars(&self) -> bool {
false
}
//todo!(linux)
// todo(linux)
fn write_to_clipboard(&self, item: ClipboardItem) {}
//todo!(linux)
// todo(linux)
fn read_from_clipboard(&self) -> Option<ClipboardItem> {
None
}

View file

@ -32,7 +32,7 @@ impl LinuxTextSystem {
pub(crate) fn new() -> Self {
let mut font_system = FontSystem::new();
// todo!(linux) make font loading non-blocking
// todo(linux) make font loading non-blocking
font_system.db_mut().load_system_fonts();
Self(RwLock::new(LinuxTextSystemState {
@ -59,7 +59,7 @@ impl PlatformTextSystem for LinuxTextSystem {
self.0.write().add_fonts(fonts)
}
// todo!(linux) ensure that this integrates with platform font loading
// todo(linux) ensure that this integrates with platform font loading
// do we need to do more than call load_system_fonts()?
fn all_font_names(&self) -> Vec<String> {
self.0
@ -71,13 +71,13 @@ impl PlatformTextSystem for LinuxTextSystem {
.collect()
}
// todo!(linux)
// todo(linux)
fn all_font_families(&self) -> Vec<String> {
Vec::new()
}
fn font_id(&self, font: &Font) -> Result<FontId> {
// todo!(linux): Do we need to use CosmicText's Font APIs? Can we consolidate this to use font_kit?
// todo(linux): Do we need to use CosmicText's Font APIs? Can we consolidate this to use font_kit?
let lock = self.0.upgradable_read();
if let Some(font_id) = lock.font_selections.get(font) {
Ok(*font_id)
@ -127,13 +127,13 @@ impl PlatformTextSystem for LinuxTextSystem {
FontMetrics {
units_per_em: metrics.units_per_em as u32,
ascent: metrics.ascent,
descent: -metrics.descent, // todo!(linux) confirm this is correct
descent: -metrics.descent, // todo(linux) confirm this is correct
line_gap: metrics.leading,
underline_position: metrics.underline_offset,
underline_thickness: metrics.stroke_size,
cap_height: metrics.cap_height,
x_height: metrics.x_height,
// todo!(linux): Compute this correctly
// todo(linux): Compute this correctly
bounding_box: Bounds {
origin: point(0.0, 0.0),
size: size(metrics.max_width, metrics.ascent + metrics.descent),
@ -146,7 +146,7 @@ impl PlatformTextSystem for LinuxTextSystem {
let metrics = lock.fonts[font_id.0].as_swash().metrics(&[]);
let glyph_metrics = lock.fonts[font_id.0].as_swash().glyph_metrics(&[]);
let glyph_id = glyph_id.0 as u16;
// todo!(linux): Compute this correctly
// todo(linux): Compute this correctly
// see https://github.com/servo/font-kit/blob/master/src/loaders/freetype.rs#L614-L620
Ok(Bounds {
origin: point(0.0, 0.0),
@ -181,7 +181,7 @@ impl PlatformTextSystem for LinuxTextSystem {
self.0.write().layout_line(text, font_size, runs)
}
// todo!(linux) Confirm that this has been superseded by the LineWrapper
// todo(linux) Confirm that this has been superseded by the LineWrapper
fn wrap_line(
&self,
text: &str,
@ -256,7 +256,7 @@ impl LinuxTextSystemState {
}
fn is_emoji(&self, font_id: FontId) -> bool {
// todo!(linux): implement this correctly
// todo(linux): implement this correctly
self.postscript_names_by_font_id
.get(&font_id)
.map_or(false, |postscript_name| {
@ -264,7 +264,7 @@ impl LinuxTextSystemState {
})
}
// todo!(linux) both raster functions have problems because I am not sure this is the correct mapping from cosmic text to gpui system
// todo(linux) both raster functions have problems because I am not sure this is the correct mapping from cosmic text to gpui system
fn raster_bounds(&mut self, params: &RenderGlyphParams) -> Result<Bounds<DevicePixels>> {
let font = &self.fonts[params.font_id.0];
let font_system = &mut self.font_system;
@ -297,7 +297,7 @@ impl LinuxTextSystemState {
if glyph_bounds.size.width.0 == 0 || glyph_bounds.size.height.0 == 0 {
Err(anyhow!("glyph bounds are empty"))
} else {
// todo!(linux) handle subpixel variants
// todo(linux) handle subpixel variants
let bitmap_size = glyph_bounds.size;
let font = &self.fonts[params.font_id.0];
let font_system = &mut self.font_system;
@ -320,13 +320,13 @@ impl LinuxTextSystemState {
}
}
// todo!(linux) This is all a quick first pass, maybe we should be using cosmic_text::Buffer
// todo(linux) This is all a quick first pass, maybe we should be using cosmic_text::Buffer
#[profiling::function]
fn layout_line(&mut self, text: &str, font_size: Pixels, font_runs: &[FontRun]) -> LineLayout {
let mut attrs_list = AttrsList::new(Attrs::new());
let mut offs = 0;
for run in font_runs {
// todo!(linux) We need to check we are doing utf properly
// todo(linux) We need to check we are doing utf properly
let font = &self.fonts[run.font_id.0];
let font = self.font_system.db().face(font.id()).unwrap();
attrs_list.add_span(
@ -343,11 +343,11 @@ impl LinuxTextSystemState {
let layout = line.layout(
&mut self.font_system,
font_size.0,
f32::MAX, // todo!(linux) we don't have a width cause this should technically not be wrapped I believe
f32::MAX, // todo(linux) we don't have a width cause this should technically not be wrapped I believe
cosmic_text::Wrap::None,
);
let mut runs = Vec::new();
// todo!(linux) what I think can happen is layout returns possibly multiple lines which means we should be probably working with it higher up in the text rendering
// todo(linux) what I think can happen is layout returns possibly multiple lines which means we should be probably working with it higher up in the text rendering
let layout = layout.first().unwrap();
for glyph in &layout.glyphs {
let font_id = glyph.font_id;
@ -358,7 +358,7 @@ impl LinuxTextSystemState {
.unwrap(),
);
let mut glyphs = SmallVec::new();
// todo!(linux) this is definitely wrong, each glyph in glyphs from cosmic-text is a cluster with one glyph, ShapedRun takes a run of glyphs with the same font and direction
// todo(linux) this is definitely wrong, each glyph in glyphs from cosmic-text is a cluster with one glyph, ShapedRun takes a run of glyphs with the same font and direction
glyphs.push(ShapedGlyph {
id: GlyphId(glyph.glyph_id as u32),
position: point((glyph.x).into(), glyph.y.into()),

View file

@ -1,4 +1,4 @@
//todo!(linux): remove this once the relevant functionality has been implemented
// todo(linux): remove this once the relevant functionality has been implemented
#![allow(unused_variables)]
pub(crate) use client::*;

View file

@ -183,7 +183,7 @@ impl Client for WaylandClient {
let decoration =
decoration_manager.get_toplevel_decoration(&toplevel, &self.qh, xdg_surface.id());
// todo!(linux) - options.titlebar is lacking information required for wayland.
// todo(linux) - options.titlebar is lacking information required for wayland.
// Especially, whether a titlebar is wanted in itself.
//
// Removing the titlebar also removes the entire window frame (ie. the ability to
@ -482,7 +482,7 @@ impl Dispatch<wl_keyboard::WlKeyboard, ()> for WaylandClientState {
wl_keyboard::KeyState::Pressed => {
let input = PlatformInput::KeyDown(KeyDownEvent {
keystroke: Keystroke::from_xkb(keymap_state, state.modifiers, keycode),
is_held: false, // todo!(linux)
is_held: false, // todo(linux)
});
focused_window.handle_input(input.clone());

View file

@ -8,17 +8,17 @@ use crate::{Bounds, DisplayId, GlobalPixels, PlatformDisplay, Size};
pub(crate) struct WaylandDisplay {}
impl PlatformDisplay for WaylandDisplay {
// todo!(linux)
// todo(linux)
fn id(&self) -> DisplayId {
DisplayId(123) // return some fake data so it doesn't panic
}
// todo!(linux)
// todo(linux)
fn uuid(&self) -> anyhow::Result<Uuid> {
Ok(Uuid::from_bytes([0; 16])) // return some fake data so it doesn't panic
}
// todo!(linux)
// todo(linux)
fn bounds(&self) -> Bounds<GlobalPixels> {
Bounds {
origin: Default::default(),

View file

@ -132,7 +132,7 @@ impl WaylandWindowState {
size: Size {
width: 500,
height: 500,
}, //todo!(implement)
}, // todo(implement)
},
WindowBounds::Fixed(bounds) => bounds.map(|p| p.0 as i32),
};
@ -200,7 +200,7 @@ impl WaylandWindowState {
pub fn set_decoration_state(&self, state: WaylandDecorationState) {
self.inner.borrow_mut().decoration_state = state;
log::trace!("Window decorations are now handled by {:?}", state);
// todo!(linux) - Handle this properly
// todo(linux) - Handle this properly
}
pub fn close(&self) {
@ -250,7 +250,7 @@ impl HasDisplayHandle for WaylandWindow {
}
impl PlatformWindow for WaylandWindow {
//todo!(linux)
// todo(linux)
fn bounds(&self) -> WindowBounds {
WindowBounds::Maximized
}
@ -267,32 +267,32 @@ impl PlatformWindow for WaylandWindow {
self.0.inner.borrow_mut().scale
}
//todo!(linux)
// todo(linux)
fn titlebar_height(&self) -> Pixels {
unimplemented!()
}
// todo!(linux)
// todo(linux)
fn appearance(&self) -> WindowAppearance {
WindowAppearance::Light
}
// todo!(linux)
// todo(linux)
fn display(&self) -> Rc<dyn PlatformDisplay> {
Rc::new(WaylandDisplay {})
}
// todo!(linux)
// todo(linux)
fn mouse_position(&self) -> Point<Pixels> {
Point::default()
}
//todo!(linux)
// todo(linux)
fn modifiers(&self) -> Modifiers {
crate::Modifiers::default()
}
//todo!(linux)
// todo(linux)
fn as_any_mut(&mut self) -> &mut dyn Any {
unimplemented!()
}
@ -305,7 +305,7 @@ impl PlatformWindow for WaylandWindow {
self.0.inner.borrow_mut().input_handler.take()
}
//todo!(linux)
// todo(linux)
fn prompt(
&self,
level: PromptLevel,
@ -317,7 +317,7 @@ impl PlatformWindow for WaylandWindow {
}
fn activate(&self) {
//todo!(linux)
// todo(linux)
}
fn set_title(&mut self, title: &str) {
@ -325,23 +325,23 @@ impl PlatformWindow for WaylandWindow {
}
fn set_edited(&mut self, edited: bool) {
//todo!(linux)
// todo(linux)
}
fn show_character_palette(&self) {
//todo!(linux)
// todo(linux)
}
fn minimize(&self) {
//todo!(linux)
// todo(linux)
}
fn zoom(&self) {
//todo!(linux)
// todo(linux)
}
fn toggle_full_screen(&self) {
//todo!(linux)
// todo(linux)
}
fn on_request_frame(&self, callback: Box<dyn FnMut()>) {
@ -361,7 +361,7 @@ impl PlatformWindow for WaylandWindow {
}
fn on_fullscreen(&self, callback: Box<dyn FnMut(bool)>) {
//todo!(linux)
// todo(linux)
}
fn on_moved(&self, callback: Box<dyn FnMut()>) {
@ -377,10 +377,10 @@ impl PlatformWindow for WaylandWindow {
}
fn on_appearance_changed(&self, callback: Box<dyn FnMut()>) {
//todo!(linux)
// todo(linux)
}
// todo!(linux)
// todo(linux)
fn is_topmost_for_position(&self, position: Point<Pixels>) -> bool {
false
}

View file

@ -1,4 +1,4 @@
//todo!(linux): remove
// todo(linux): remove
#![allow(unused)]
use crate::{
@ -99,7 +99,7 @@ pub(crate) struct X11WindowState {
#[derive(Clone)]
pub(crate) struct X11Window(pub(crate) Rc<X11WindowState>);
//todo!(linux): Remove other RawWindowHandle implementation
// todo(linux): Remove other RawWindowHandle implementation
unsafe impl blade_rwh::HasRawWindowHandle for RawWindow {
fn raw_window_handle(&self) -> blade_rwh::RawWindowHandle {
let mut wh = blade_rwh::XcbWindowHandle::empty();
@ -301,7 +301,7 @@ impl X11WindowState {
let mut inner = self.inner.borrow_mut();
let old_bounds = mem::replace(&mut inner.bounds, bounds);
do_move = old_bounds.origin != bounds.origin;
//todo!(linux): use normal GPUI types here, refactor out the double
// todo(linux): use normal GPUI types here, refactor out the double
// viewport check and extra casts ( )
let gpu_size = query_render_extent(&self.xcb_connection, self.x_window);
if inner.renderer.viewport_size() != gpu_size {
@ -377,12 +377,12 @@ impl PlatformWindow for X11Window {
self.0.inner.borrow_mut().scale_factor
}
//todo!(linux)
// todo(linux)
fn titlebar_height(&self) -> Pixels {
unimplemented!()
}
//todo!(linux)
// todo(linux)
fn appearance(&self) -> WindowAppearance {
WindowAppearance::Light
}
@ -402,7 +402,7 @@ impl PlatformWindow for X11Window {
)
}
//todo!(linux)
// todo(linux)
fn modifiers(&self) -> Modifiers {
Modifiers::default()
}
@ -419,7 +419,7 @@ impl PlatformWindow for X11Window {
self.0.inner.borrow_mut().input_handler.take()
}
//todo!(linux)
// todo(linux)
fn prompt(
&self,
_level: PromptLevel,
@ -447,10 +447,10 @@ impl PlatformWindow for X11Window {
});
}
//todo!(linux)
// todo(linux)
fn set_edited(&mut self, edited: bool) {}
//todo!(linux), this corresponds to `orderFrontCharacterPalette` on macOS,
// todo(linux), this corresponds to `orderFrontCharacterPalette` on macOS,
// but it looks like the equivalent for Linux is GTK specific:
//
// https://docs.gtk.org/gtk3/signal.Entry.insert-emoji.html
@ -460,17 +460,17 @@ impl PlatformWindow for X11Window {
unimplemented!()
}
//todo!(linux)
// todo(linux)
fn minimize(&self) {
unimplemented!()
}
//todo!(linux)
// todo(linux)
fn zoom(&self) {
unimplemented!()
}
//todo!(linux)
// todo(linux)
fn toggle_full_screen(&self) {
unimplemented!()
}
@ -511,7 +511,7 @@ impl PlatformWindow for X11Window {
self.0.callbacks.borrow_mut().appearance_changed = Some(callback);
}
//todo!(linux)
// todo(linux)
fn is_topmost_for_position(&self, _position: Point<Pixels>) -> bool {
unimplemented!()
}

View file

@ -126,7 +126,7 @@ impl Platform for TestPlatform {
#[cfg(target_os = "macos")]
return Arc::new(crate::platform::mac::MacTextSystem::new());
// todo!("windows")
// todo("windows")
#[cfg(target_os = "windows")]
unimplemented!()
}

View file

@ -7,7 +7,7 @@ use std::borrow::Cow;
pub(crate) struct TestTextSystem {}
//todo!(linux)
// todo(linux)
#[allow(unused)]
impl PlatformTextSystem for TestTextSystem {
fn add_fonts(&self, fonts: Vec<Cow<'static, [u8]>>) -> Result<()> {

View file

@ -1,4 +1,4 @@
// todo!("windows"): remove
// todo("windows"): remove
#![cfg_attr(windows, allow(dead_code))]
use crate::{

View file

@ -208,7 +208,7 @@ impl Default for TextStyle {
fn default() -> Self {
TextStyle {
color: black(),
// todo!(linux) make this configurable or choose better default
// todo(linux) make this configurable or choose better default
font_family: if cfg!(target_os = "linux") {
"FreeMono".into()
} else {