Skip to content

Remove useless Variant, use Option instead #496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 1, 2021
Merged

Remove useless Variant, use Option instead #496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
62ab920
format
burrbull Mar 27, 2021
a93762e
empty impl R
burrbull Mar 27, 2021
e980af9
use Option<ENUM> instead of Variant
burrbull Mar 27, 2021
b79a586
rm unnecessary parentheses
burrbull Mar 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).

### Changed

- [breaking-change] remove `Variant<U, ENUM_A>`, use `Option<ENUM_A>` instead

- split out register size type (`RawType`) from `ResetValue` trait

- `anyhow` crate is used for error handling
Expand Down
9 changes: 0 additions & 9 deletions src/generate/generic.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,15 +223,6 @@ impl<REG: RegisterSpec> W<REG> {
}
}

/// Used if enumerated values cover not the whole range.
#[derive(Clone, Copy, PartialEq)]
pub enum Variant<U, T> {
/// Expected variant.
Val(T),
/// Raw bits.
Res(U),
}

/// Field reader.
///
/// Result of the `read` methods of fields.
Expand Down
102 changes: 47 additions & 55 deletions src/generate/register.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,14 +145,10 @@ pub fn render(
let open = Punct::new('{', Spacing::Alone);
let close = Punct::new('}', Spacing::Alone);

if can_read {
if can_read && !r_impl_items.is_empty() {
mod_items.extend(quote! {
impl R #open
impl R #open #r_impl_items #close
});

mod_items.extend(r_impl_items);

close.to_tokens(&mut mod_items);
}

if can_write {
Expand All @@ -163,11 +159,11 @@ pub fn render(
mod_items.extend(w_impl_items);

mod_items.extend(quote! {
#[doc = "Writes raw bits to the register."]
pub unsafe fn bits(&mut self, bits: #rty) -> &mut Self {
self.0.bits(bits);
self
}
#[doc = "Writes raw bits to the register."]
pub unsafe fn bits(&mut self, bits: #rty) -> &mut Self {
self.0.bits(bits);
self
}
});

close.to_tokens(&mut mod_items);
Expand Down Expand Up @@ -455,7 +451,7 @@ pub fn fields(
let pc = &v.pc;

if has_reserved_variant {
quote! { #i => Val(#name_pc_a::#pc), }
quote! { #i => Some(#name_pc_a::#pc), }
} else {
quote! { #i => #name_pc_a::#pc, }
}
Expand All @@ -465,35 +461,33 @@ pub fn fields(

if has_reserved_variant {
arms.extend(quote! {
i => Res(i),
});
_ => None,
});
} else if 1 << width.to_ty_width()? != variants.len() {
arms.extend(quote! {
_ => unreachable!(),
});
_ => unreachable!(),
});
}

if has_reserved_variant {
enum_items.extend(quote! {
///Get enumerated values variant
#inline
pub fn variant(&self) -> crate::Variant<#fty, #name_pc_a> {
use crate::Variant::*;
match self.bits {
#arms
}
}
});
///Get enumerated values variant
#inline
pub fn variant(&self) -> Option<#name_pc_a> {
match self.bits {
#arms
}
}
});
} else {
enum_items.extend(quote! {
///Get enumerated values variant
#inline
pub fn variant(&self) -> #name_pc_a {
match self.bits {
#arms
}
}
});
match self.bits {
#arms
}
}});
}

for v in &variants {
Expand All @@ -511,12 +505,12 @@ pub fn fields(

let doc = format!("Checks if the value of the field is `{}`", pc);
enum_items.extend(quote! {
#[doc = #doc]
#inline
pub fn #is_variant(&self) -> bool {
**self == #name_pc_a::#pc
}
});
#[doc = #doc]
#inline
pub fn #is_variant(&self) -> bool {
**self == #name_pc_a::#pc
}
});
}
}

Expand Down Expand Up @@ -595,21 +589,19 @@ pub fn fields(
if !variants.is_empty() {
if unsafety.is_some() {
proxy_items.extend(quote! {
///Writes `variant` to the field
#inline
pub fn variant(self, variant: #name_pc_aw) -> &'a mut W {
unsafe {
self.#bits(variant.into())
///Writes `variant` to the field
#inline
pub fn variant(self, variant: #name_pc_aw) -> &'a mut W {
unsafe { self.#bits(variant.into()) }
}
}
});
} else {
proxy_items.extend(quote! {
///Writes `variant` to the field
#inline
pub fn variant(self, variant: #name_pc_aw) -> &'a mut W {
self.#bits(variant.into())
}
///Writes `variant` to the field
#inline
pub fn variant(self, variant: #name_pc_aw) -> &'a mut W {
self.#bits(variant.into())
}
});
}

Expand All @@ -619,11 +611,11 @@ pub fn fields(

let doc = util::escape_brackets(util::respace(&v.doc).as_ref());
proxy_items.extend(quote! {
#[doc = #doc]
#inline
pub fn #sc(self) -> &'a mut W {
self.variant(#name_pc_aw::#pc)
}
#[doc = #doc]
#inline
pub fn #sc(self) -> &'a mut W {
self.variant(#name_pc_aw::#pc)
}
});
}
}
Expand All @@ -650,7 +642,7 @@ pub fn fields(
///Writes raw bits to the field
#inline
pub #unsafety fn #bits(self, value: #fty) -> &'a mut W {
self.w.bits = (self.w.bits & !(#hexmask << self.offset)) | (((value as #rty) & #hexmask) << self.offset);
self.w.bits = (self.w.bits & !(#hexmask << self.offset)) | ((value as #rty & #hexmask) << self.offset);
self.w
}
}
Expand All @@ -660,7 +652,7 @@ pub fn fields(
///Writes raw bits to the field
#inline
pub #unsafety fn #bits(self, value: #fty) -> &'a mut W {
self.w.bits = (self.w.bits & !(#hexmask << #offset)) | (((value as #rty) & #hexmask) << #offset);
self.w.bits = (self.w.bits & !(#hexmask << #offset)) | ((value as #rty & #hexmask) << #offset);
self.w
}
}
Expand All @@ -669,7 +661,7 @@ pub fn fields(
///Writes raw bits to the field
#inline
pub #unsafety fn #bits(self, value: #fty) -> &'a mut W {
self.w.bits = (self.w.bits & !#hexmask) | ((value as #rty) & #hexmask);
self.w.bits = (self.w.bits & !#hexmask) | (value as #rty & #hexmask);
self.w
}
}
Expand Down