langfingaz/anki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add const for special fields and doc

Browse Source
This commit is contained in:
RumovZ 2021-05-28 11:58:46 +02:00
parent 33bf391114
commit 329f89c093
2 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
rslib/src/notetype/mod.rs
View File

@ -48,6 +48,16 @@ define_newtype!(NotetypeId, i64);
pub(crate) const DEFAULT_CSS: &str = include_str!("styling.css"); pub(crate) const DEFAULT_CSS: &str = include_str!("styling.css");
pub(crate) const DEFAULT_LATEX_HEADER: &str = include_str!("header.tex"); pub(crate) const DEFAULT_LATEX_HEADER: &str = include_str!("header.tex");
pub(crate) const DEFAULT_LATEX_FOOTER: &str = r"\end{document}"; pub(crate) const DEFAULT_LATEX_FOOTER: &str = r"\end{document}";
/// New entries must be handled in render.rs/add_special_fields().
pub(crate) const SPECIAL_FIELDS: [&str; 7] = [
"FrontSide",
"Card",
"CardFlag",
"Deck",
"Subdeck",
"Tags",
"Type",
];
#[derive(Debug, PartialEq, Clone)] #[derive(Debug, PartialEq, Clone)]
pub struct Notetype { pub struct Notetype {
@ -322,25 +332,17 @@ impl Notetype {
} }
} }
/// True if any name in names does not belong to a field of this notetype. /// True if any non-empty name in names does not denote a special field or
/// a field of this notetype.
fn unknown_field_name<T, I>(&self, names: T) -> bool fn unknown_field_name<T, I>(&self, names: T) -> bool
where where
T: IntoIterator<Item = I>, T: IntoIterator<Item = I>,
I: AsRef<str>, I: AsRef<str>,
{ {
let special_fields = [
"FrontSide",
"Card",
"CardFlag",
"Deck",
"Subdeck",
"Tags",
"Type",
];
names.into_iter().any(|name| { names.into_iter().any(|name| {
// The empty field name is allowed as it may be used by add-ons. // The empty field name is allowed as it may be used by add-ons.
!name.as_ref().is_empty() !name.as_ref().is_empty()
&& !special_fields.contains(&name.as_ref()) && !SPECIAL_FIELDS.contains(&name.as_ref())
&& self.fields.iter().all(|field| field.name != name.as_ref()) && self.fields.iter().all(|field| field.name != name.as_ref())
}) })
} }

4
rslib/src/notetype/render.rs
View File

@ -129,7 +129,9 @@ impl Collection {
}) })
} }
// Add special fields if they don't clobber note fields /// Add special fields if they don't clobber note fields.
/// The fields supported here must coincide with SPECIAL_FIELDS in
/// notetype/mod.rs, apart from FrontSide which is handled by Python.
fn add_special_fields( fn add_special_fields(
&mut self, &mut self,
map: &mut HashMap<&str, Cow<str>>, map: &mut HashMap<&str, Cow<str>>,