Merge branch 'badge'

Author: lgarron

README.md

@@ -18,10 +18,10 @@ pub enum ProgressBarType {
 }
 
 impl ProgressBarType {
-    pub fn num_steps(&self) -> u64 {
+    pub fn num_steps(&self, includes_badge: bool) -> u64 {
         match self {
             ProgressBarType::Input => 1,
-            ProgressBarType::Conversion => 13,
+            ProgressBarType::Conversion => 13 + if includes_badge { 1 } else { 0 },
             ProgressBarType::OutputWithAssignmentDefault => 2,
             ProgressBarType::OutputWithAssignmentUsingRez => 7,
             ProgressBarType::OutputIcns => 1,
@@ -36,9 +36,9 @@ use crate::{
     },
     convert::{density, BlurDown, CommandArgs, CompositingOperation},
     error::{FolderifyError, GeneralError},
-    generic_folder_icon::get_folder_icon,
-    options::{self, ColorScheme, Options, SetIconUsing},
+    options::{Badge, ColorScheme, Options, SetIconUsing},
     primitives::{Dimensions, Extent, Offset, RGBColor},
+    resources::{get_badge_icon, get_folder_icon},
 };
 
 pub struct ScaledMaskInputs {
@@ -77,10 +77,11 @@ impl WorkingDir {
         progress_bar_type: ProgressBarType,
         stage_description: &str,
         multi_progress_bar: Option<MultiProgress>,
+        includes_badge: bool,
     ) -> IconConversion {
         let progress_bar = match multi_progress_bar {
             Some(multi_progress_bar) => {
-                let progress_bar = ProgressBar::new(progress_bar_type.num_steps());
+                let progress_bar = ProgressBar::new(progress_bar_type.num_steps(includes_badge));
                 let progress_bar = match progress_bar_type {
                     ProgressBarType::Conversion => multi_progress_bar.insert(1, progress_bar),
                     _ => multi_progress_bar.insert_from_back(0, progress_bar),
@@ -286,7 +287,7 @@ impl IconConversion {
 
     pub fn full_mask(
         &self,
-        options: &options::Options,
+        options: &Options,
         centering_dimensions: &Dimensions,
     ) -> Result<PathBuf, FolderifyError> {
         self.step_unincremented("Preparing icon mask");
@@ -457,10 +458,25 @@ impl IconConversion {
         args.composite(&CompositingOperation::dissolve);
         args.push_path(output_path);
         run_convert(&args, Some(template_icon))?;
+        Ok(())
+    }
 
-        self.step("");
+    pub fn badge_in_place(
+        &self,
+        icon_path: &Path,
+        badge: Badge,
+        resolution: &IconResolution,
+    ) -> Result<(), FolderifyError> {
+        self.step("Adding badge"); // TODO: increase maximum step counter.
 
-        Ok(())
+        let badge_icon = get_badge_icon(badge, resolution);
+
+        let mut args = CommandArgs::new();
+        args.push_path(icon_path);
+        args.push("-");
+        args.composite(&CompositingOperation::dissolve);
+        args.push_path(icon_path);
+        run_convert(&args, Some(badge_icon))
     }
 
     // TODO
@@ -524,6 +540,12 @@ impl IconConversion {
                 },
             },
         );
+        if let Some(badge) = options.badge {
+            self.badge_in_place(output_path, badge, &inputs.resolution)?;
+        };
+
+        self.step("");
+
         if options.verbose {
             println!("[{}] {}", options.mask_path.display(), inputs.resolution);
         }

src/icon_conversion.rs

@@ -10,11 +10,11 @@ use crate::{output_paths::PotentialOutputPaths, primitives::Dimensions};
 mod command;
 mod convert;
 mod error;
-mod generic_folder_icon;
 mod icon_conversion;
 mod options;
 mod output_paths;
 mod primitives;
+mod resources;
 
 fn main() {
     let options = options::get_options();
@@ -45,6 +45,7 @@ fn main() {
         icon_conversion::ProgressBarType::Input,
         "(Input)",
         multi_progress_bar.clone(),
+        false,
     );
     let full_mask_path = input_icon_conversion
         .full_mask(
@@ -64,6 +65,7 @@ fn main() {
             icon_conversion::ProgressBarType::Conversion,
             &resolution.to_string(),
             multi_progress_bar.clone(),
+            true,
         );
         let options = options.clone();
         let full_mask_path = full_mask_path.clone();
@@ -101,8 +103,12 @@ fn main() {
         }
         (None, _) => icon_conversion::ProgressBarType::OutputWithAssignmentDefault,
     };
-    let output_icon_conversion =
-        working_dir.icon_conversion(output_progress_bar_type, "(Output)", multi_progress_bar);
+    let output_icon_conversion = working_dir.icon_conversion(
+        output_progress_bar_type,
+        "(Output)",
+        multi_progress_bar,
+        false,
+    );
     output_icon_conversion.step_unincremented("Waiting…");
 
     for handle in handles {

src/main.rs

@@ -63,6 +63,10 @@ struct FolderifyArgs {
     #[arg(long, hide(true))]
     set_icon_using: Option<SetIconUsingOrAuto>,
 
+    /// Add a badge to the icon. Currently only supports one badge at a time.
+    #[arg(long)]
+    badge: Option<Badge>,
+
     /// Detailed output. Also sets `--no-progress`.
     #[clap(short, long)]
     verbose: bool,
@@ -82,6 +86,12 @@ pub enum ColorScheme {
     Dark,
 }
 
+#[derive(ValueEnum, Clone, Debug, PartialEq, Copy)]
+pub enum Badge {
+    Alias,
+    Locked,
+}
+
 impl Display for ColorScheme {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         write!(
@@ -127,6 +137,7 @@ pub struct Options {
     pub output_iconset: Option<PathBuf>,
     pub set_icon_using: SetIconUsing,
     pub show_progress: bool,
+    pub badge: Option<Badge>,
     pub reveal: bool,
     pub verbose: bool,
     pub debug: bool,
@@ -202,6 +213,7 @@ pub fn get_options() -> Options {
         target: args.target,
         output_icns: args.output_icns,
         output_iconset: args.output_iconset,
+        badge: args.badge,
         set_icon_using,
         show_progress,
         reveal: args.reveal,

src/options.rs

@@ -2,16 +2,31 @@ use std::path::PathBuf;
 
 use include_dir::{include_dir, Dir};
 
-use crate::{icon_conversion::IconResolution, options::ColorScheme};
+use crate::{
+    icon_conversion::IconResolution,
+    options::{Badge, ColorScheme},
+};
 
 static RESOURCES_DIR: Dir<'_> = include_dir!("$CARGO_MANIFEST_DIR/src/resources");
 
 pub fn get_folder_icon(color_scheme: ColorScheme, resolution: &IconResolution) -> &'static [u8] {
     let mut path = PathBuf::new();
+    path.push("folders");
     path.push(match color_scheme {
         ColorScheme::Light => "GenericFolderIcon.BigSur.iconset",
         ColorScheme::Dark => "GenericFolderIcon.BigSur.dark.iconset",
     });
     path.push(resolution.icon_file());
     RESOURCES_DIR.get_file(&path).unwrap().contents()
 }
+
+pub fn get_badge_icon(badge: Badge, resolution: &IconResolution) -> &'static [u8] {
+    let mut path = PathBuf::new();
+    path.push("badges");
+    path.push(match badge {
+        Badge::Alias => "AliasBadgeIcon.iconset",
+        Badge::Locked => "LockedBadgeIcon.iconset",
+    });
+    path.push(resolution.icon_file());
+    RESOURCES_DIR.get_file(&path).unwrap().contents()
+}