Skip to content

feat: Add keep_list arg to allow not to generate arrays #562

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 1 commit into from
Jan 17, 2022
Merged

feat: Add keep_list arg to allow not to generate arrays #562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Fix ValidateLevel usage in lib.rs
- Parenthesizing `#offset_calc` to avoid clippy's warning of operator precedence

### Added

- `keep_list` option

## [v0.20.0] - 2021-12-07

### Fixed
Expand Down
20 changes: 18 additions & 2 deletions src/generate/peripheral.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -712,7 +712,15 @@ fn expand_cluster(
.eq((0..array_info.dim).map(Ok))
});

let array_convertible = sequential_indexes && sequential_addresses;
let convert_list = match config.keep_list {
true => match &array_info.dim_name {
Some(dim_name) => dim_name.contains("[%s]"),
None => info.name.contains("[%s]"),
},
false => true,
};

let array_convertible = sequential_indexes && sequential_addresses && convert_list;

if array_convertible {
cluster_expanded.push(RegisterBlockField {
Expand Down Expand Up @@ -776,7 +784,15 @@ fn expand_register(
.eq((0..array_info.dim).map(Ok))
});

let array_convertible = sequential_indexes && sequential_addresses;
let convert_list = match config.keep_list {
true => match &array_info.dim_name {
Some(dim_name) => dim_name.contains("[%s]"),
None => info.name.contains("[%s]"),
},
false => true,
};

let array_convertible = sequential_indexes && sequential_addresses && convert_list;

if array_convertible {
register_expanded.push(RegisterBlockField {
Expand Down
175 changes: 91 additions & 84 deletions src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,91 +19,95 @@ fn run() -> Result<()> {
use clap_conf::prelude::*;
use std::io::Read;

let matches =
App::new("svd2rust")
.about("Generate a Rust API from SVD files")
.arg(
Arg::with_name("input")
.help("Input SVD file")
.short("i")
.takes_value(true)
.value_name("FILE"),
)
.arg(
Arg::with_name("output")
.long("output-dir")
.help("Directory to place generated files")
.short("o")
.takes_value(true)
.value_name("PATH"),
)
.arg(
Arg::with_name("config")
.long("config")
.help("Config TOML file")
.short("c")
.takes_value(true)
.value_name("TOML_FILE"),
)
.arg(
Arg::with_name("target")
.long("target")
.help("Target architecture")
.takes_value(true)
.value_name("ARCH"),
)
.arg(
Arg::with_name("nightly_features")
.long("nightly")
.help("Enable features only available to nightly rustc"),
)
.arg(Arg::with_name("const_generic").long("const_generic").help(
let matches = App::new("svd2rust")
.about("Generate a Rust API from SVD files")
.arg(
Arg::with_name("input")
.help("Input SVD file")
.short("i")
.takes_value(true)
.value_name("FILE"),
)
.arg(
Arg::with_name("output")
.long("output-dir")
.help("Directory to place generated files")
.short("o")
.takes_value(true)
.value_name("PATH"),
)
.arg(
Arg::with_name("config")
.long("config")
.help("Config TOML file")
.short("c")
.takes_value(true)
.value_name("TOML_FILE"),
)
.arg(
Arg::with_name("target")
.long("target")
.help("Target architecture")
.takes_value(true)
.value_name("ARCH"),
)
.arg(
Arg::with_name("nightly_features")
.long("nightly")
.help("Enable features only available to nightly rustc"),
)
.arg(
Arg::with_name("const_generic").long("const_generic").help(
"Use const generics to generate writers for same fields with different offsets",
))
.arg(
Arg::with_name("ignore_groups")
.long("ignore_groups")
.help("Don't add alternateGroup name as prefix to register name"),
)
.arg(
Arg::with_name("generic_mod")
.long("generic_mod")
.short("g")
.help("Push generic mod in separate file"),
)
.arg(
Arg::with_name("make_mod")
.long("make_mod")
.short("m")
.help("Create mod.rs instead of lib.rs, without inner attributes"),
)
.arg(
Arg::with_name("strict")
.long("strict")
.short("s")
.help("Make advanced checks due to parsing SVD"),
)
.arg(
Arg::with_name("source_type")
.long("source_type")
.help("Specify file/stream format"),
)
.arg(
Arg::with_name("log_level")
.long("log")
.short("l")
.help(&format!(
"Choose which messages to log (overrides {})",
env_logger::DEFAULT_FILTER_ENV
))
.takes_value(true)
.possible_values(&["off", "error", "warn", "info", "debug", "trace"]),
)
.version(concat!(
env!("CARGO_PKG_VERSION"),
include_str!(concat!(env!("OUT_DIR"), "/commit-info.txt"))
))
.get_matches();
),
)
.arg(
Arg::with_name("ignore_groups")
.long("ignore_groups")
.help("Don't add alternateGroup name as prefix to register name"),
)
.arg(Arg::with_name("keep_list").long("keep_list").help(
"Keep lists when generating code of dimElement, instead of trying to generate arrays",
))
.arg(
Arg::with_name("generic_mod")
.long("generic_mod")
.short("g")
.help("Push generic mod in separate file"),
)
.arg(
Arg::with_name("make_mod")
.long("make_mod")
.short("m")
.help("Create mod.rs instead of lib.rs, without inner attributes"),
)
.arg(
Arg::with_name("strict")
.long("strict")
.short("s")
.help("Make advanced checks due to parsing SVD"),
)
.arg(
Arg::with_name("source_type")
.long("source_type")
.help("Specify file/stream format"),
)
.arg(
Arg::with_name("log_level")
.long("log")
.short("l")
.help(&format!(
"Choose which messages to log (overrides {})",
env_logger::DEFAULT_FILTER_ENV
))
.takes_value(true)
.possible_values(&["off", "error", "warn", "info", "debug", "trace"]),
)
.version(concat!(
env!("CARGO_PKG_VERSION"),
include_str!(concat!(env!("OUT_DIR"), "/commit-info.txt"))
))
.get_matches();

let input = &mut String::new();
match matches.value_of("input") {
Expand Down Expand Up @@ -148,6 +152,8 @@ fn run() -> Result<()> {
cfg.bool_flag("const_generic", Filter::Arg) || cfg.bool_flag("const_generic", Filter::Conf);
let ignore_groups =
cfg.bool_flag("ignore_groups", Filter::Arg) || cfg.bool_flag("ignore_groups", Filter::Conf);
let keep_list =
cfg.bool_flag("keep_list", Filter::Arg) || cfg.bool_flag("keep_list", Filter::Conf);
let strict = cfg.bool_flag("strict", Filter::Arg) || cfg.bool_flag("strict", Filter::Conf);

let mut source_type = cfg
Expand All @@ -169,6 +175,7 @@ fn run() -> Result<()> {
make_mod,
const_generic,
ignore_groups,
keep_list,
strict,
output_dir: path.clone(),
source_type,
Expand Down
2 changes: 2 additions & 0 deletions src/util.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ pub struct Config {
pub make_mod: bool,
pub const_generic: bool,
pub ignore_groups: bool,
pub keep_list: bool,
pub strict: bool,
pub output_dir: PathBuf,
pub source_type: SourceType,
Expand All @@ -38,6 +39,7 @@ impl Default for Config {
make_mod: false,
const_generic: false,
ignore_groups: false,
keep_list: false,
strict: false,
output_dir: PathBuf::from("."),
source_type: SourceType::default(),
Expand Down