feat: add flag set/unset method

[dwpeng]

#107

[jguhlin]

Thanks! I'll give this a deeper look in a few days, but should have no problems. Next release might be awhile unless you need this sooner?

Anyway to auto generate docs for the functions from macros? No worries if not, but it'd be nice if there was a mapping or something. I'll dig around for it too

[dwpeng]

Thanks! I'll give this a deeper look in a few days, but should have no problems. Next release might be awhile unless you need this sooner?

Anyway to auto generate docs for the functions from macros? No worries if not, but it'd be nice if there was a mapping or something. I'll dig around for it too

Thanks for your code review. I found a post on stackoverflow: https://stackoverflow.com/questions/65426621/is-there-any-way-to-inline-a-const-inside-a-doc-comment-rendered-by-cargo-doc.

I tried concat! in #[doc = concat!(..)], but it didn't work. And then, I tried to use paste to implement doc, it's worked!

diff --git a/minimap2-sys/Cargo.toml b/minimap2-sys/Cargo.toml
index 82e45af..1649a83 100644
--- a/minimap2-sys/Cargo.toml
+++ b/minimap2-sys/Cargo.toml
@@ -34,6 +34,7 @@ crate-type = ["staticlib", "cdylib", "rlib"]
 
 [dependencies]
 libz-sys = { version = "1.1", default-features = false, features = ["libc"] }
+paste = "1.0.15"
 
 [build-dependencies]
 pkg-config = "0.3"
diff --git a/minimap2-sys/src/lib.rs b/minimap2-sys/src/lib.rs
index b8216f7..70ac12d 100644
--- a/minimap2-sys/src/lib.rs
+++ b/minimap2-sys/src/lib.rs
@@ -12,6 +12,8 @@ unsafe impl Send for mm_idx_t {}
 unsafe impl Send for mm_idx_reader_t {}
 unsafe impl Send for mm_mapopt_t {}
 
+use paste::paste;
+
 impl Drop for mm_idx_t {
     fn drop(&mut self) {
         unsafe { mm_idx_destroy(self) };
@@ -30,18 +32,23 @@ impl Default for mm_mapopt_t {
     }
 }
 
+
 macro_rules! add_flag_methods {
     ($ty:ty, $struct_name:ident, $(($set_name:ident, $unset_name:ident, $flag:expr)),+) => {
         impl $struct_name {
             $(
-                #[inline(always)]
-                pub fn $set_name(&mut self) {
-                    self.flag |= $flag as $ty;
-                }
-
-                #[inline(always)]
-                pub fn $unset_name(&mut self) {
-                    self.flag &= !$flag as $ty;
+                paste! {
+                    #[inline(always)]
+                    #[doc = "Set the " $flag " flag"]
+                    pub fn $set_name(&mut self) {
+                        self.flag |= $flag as $ty;
+                    }
+
+                    #[inline(always)]
+                    #[doc = "Unset the " $flag " flag"]
+                    pub fn $unset_name(&mut self) {
+                        self.flag &= !$flag as $ty;
+                    }
                 }
             )*
         }

[dwpeng]

In fact, these method that start with set/unset already have a better name, and can give user to clear information. Is it really necessary to add doc.

If necessary, how should these documents be written? Do you need to explain the behavior of each flag in minimap2? Or simply write 'set/user XXX flag'

[jguhlin]

Simply set / unset flag. Would be nice, not absolutely necessary

…

On Fri, 13 Dec 2024, 1:01 am dwpeng, ***@***.***> wrote: ***@***.**** commented on this pull request. In fact, these method that start with set/unset already have a better name, and can give user to clear information. Is it really necessary to add doc. If necessary, how should these documents be written? Do you need to explain the behavior of each flag in minimap2? Or simply write 'set/user XXX flag' — Reply to this email directly, view it on GitHub <#108 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAOA2CGMRJSSNDMWEM5ZQFD2FF3IRAVCNFSM6AAAAABTID2GM6VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDIOJZGIYDINRQGU> . You are receiving this because you commented.Message ID: ***@***.***>

[dwpeng]

Hi, @jguhlin, follow your advice, I have add auto doc generation support for functions from macros. Please give a code review.

By the way, if a function named is_set_FLAG is needed. This function can test if one flag is set or unset.

For example:

let aligner = ...
let is_cigar = aligner.mapopt.is_set_cigar();
assert_eq!(is_cigar, true);