Skip to content

Always display NA as unquoted in the Variables pane #432

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.

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 7 commits into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 11 additions & 2 deletions crates/harp/src/vector/character_vector.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ use libr::STRSXP;

use crate::object::RObject;
use crate::utils::r_str_to_owned_utf8_unchecked;
use crate::vector::FormatOptions;
use crate::vector::Vector;

#[harp_macros::vector]
Expand Down Expand Up @@ -80,8 +81,16 @@ impl Vector for CharacterVector {
r_str_to_owned_utf8_unchecked(*x)
}

fn format_one(&self, x: Self::Type) -> String {
x
fn format_one(&self, x: Self::Type, options: Option<&FormatOptions>) -> String {
if let Some(&FormatOptions { quote, .. }) = options {
if quote {
format!(r#""{}""#, x.replace('"', r#"\""#))
} else {
x
}
} else {
x
}
}
}

Expand Down
3 changes: 2 additions & 1 deletion crates/harp/src/vector/complex_vector.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ use libr::DATAPTR;
use libr::SEXP;

use crate::object::RObject;
use crate::vector::FormatOptions;
use crate::vector::Vector;

#[derive(Debug, PartialEq, Clone, Copy)]
Expand Down Expand Up @@ -81,7 +82,7 @@ impl Vector for ComplexVector {
*x
}

fn format_one(&self, x: Self::Type) -> String {
fn format_one(&self, x: Self::Type, _option: Option<&FormatOptions>) -> String {
format!("{}+{}i", x.r.to_string(), x.i.to_string())
}
}
3 changes: 2 additions & 1 deletion crates/harp/src/vector/factor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ use libr::SEXP;

use crate::object::RObject;
use crate::r_symbol;
use crate::vector::FormatOptions;
use crate::vector::CharacterVector;
use crate::vector::Vector;

Expand Down Expand Up @@ -73,7 +74,7 @@ impl Vector for Factor {
*x
}

fn format_one(&self, x: Self::Type) -> String {
fn format_one(&self, x: Self::Type, _option: Option<&FormatOptions>) -> String {
self.levels.get_unchecked((x - 1) as isize).unwrap()
}
}
62 changes: 22 additions & 40 deletions crates/harp/src/vector/formatted_vector.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ use crate::utils::r_typeof;
use crate::vector::CharacterVector;
use crate::vector::ComplexVector;
use crate::vector::Factor;
use crate::vector::FormatOptions;
use crate::vector::IntegerVector;
use crate::vector::LogicalVector;
use crate::vector::NumericVector;
Expand All @@ -47,7 +48,7 @@ pub enum FormattedVector {
},
Character {
vector: CharacterVector,
options: FormattedVectorCharacterOptions,
options: FormatOptions,
},
Complex {
vector: ComplexVector,
Expand All @@ -58,25 +59,18 @@ pub enum FormattedVector {
},
FormattedVector {
vector: CharacterVector,
options: FormattedVectorCharacterOptions,
options: FormatOptions,
},
}

// Formatting options for character vectors
pub struct FormattedVectorCharacterOptions {
// Wether to quote the strings or not (defaults to `true`)
// If `true`, elements will be quoted during format so, eg: c("a", "b") becomes ("\"a\"", "\"b\"") in Rust
pub quote: bool,
}

// Formatting options for vectors
#[derive(Default)]
pub struct FormattedVectorOptions {
// Formatting options for character vectors
pub character: FormattedVectorCharacterOptions,
pub character: FormatOptions,
}

impl Default for FormattedVectorCharacterOptions {
impl Default for FormatOptions {
fn default() -> Self {
Self { quote: true }
}
Expand Down Expand Up @@ -139,35 +133,21 @@ impl FormattedVector {

pub fn get_unchecked(&self, index: isize) -> String {
match self {
FormattedVector::Raw { vector } => vector.format_elt_unchecked(index),
FormattedVector::Logical { vector } => vector.format_elt_unchecked(index),
FormattedVector::Integer { vector } => vector.format_elt_unchecked(index),
FormattedVector::Numeric { vector } => vector.format_elt_unchecked(index),
FormattedVector::Raw { vector } => vector.format_elt_unchecked(index, None),
FormattedVector::Logical { vector } => vector.format_elt_unchecked(index, None),
FormattedVector::Integer { vector } => vector.format_elt_unchecked(index, None),
FormattedVector::Numeric { vector } => vector.format_elt_unchecked(index, None),
FormattedVector::Character { vector, options } => {
let value = vector.format_elt_unchecked(index);
self.format_with_string_options(value, options)
vector.format_elt_unchecked(index, Some(options))
},
FormattedVector::Complex { vector } => vector.format_elt_unchecked(index),
FormattedVector::Factor { vector } => vector.format_elt_unchecked(index),
FormattedVector::Complex { vector } => vector.format_elt_unchecked(index, None),
FormattedVector::Factor { vector } => vector.format_elt_unchecked(index, None),
FormattedVector::FormattedVector { vector, options } => {
let value = vector.format_elt_unchecked(index);
self.format_with_string_options(value, options)
vector.format_elt_unchecked(index, Some(options))
},
}
}

fn format_with_string_options(
&self,
value: String,
options: &FormattedVectorCharacterOptions,
) -> String {
if options.quote {
format!("\"{}\"", value.replace("\"", "\\\""))
} else {
value
}
}

pub fn len(&self) -> isize {
unsafe { Rf_xlength(self.data()) }
}
Expand Down Expand Up @@ -244,14 +224,14 @@ mod tests {
use libr::STRSXP;

use crate::environment::Environment;
use crate::environment::R_ENVS;
use crate::eval::r_parse_eval0;
use crate::modules::HARP_ENV;
use crate::object::RObject;
use crate::r_assert_type;
use crate::test::r_test;
use crate::vector::formatted_vector::FormattedVector;
use crate::vector::formatted_vector::FormattedVectorCharacterOptions;
use crate::vector::formatted_vector::FormattedVectorOptions;
use crate::vector::FormatOptions;

#[test]
fn test_unconforming_format_method() {
Expand Down Expand Up @@ -283,24 +263,26 @@ mod tests {
#[test]
fn test_formatting_option() {
r_test(|| {
let x = RObject::from(vec![String::from("1"), String::from("2")]);
let x =
r_parse_eval0(r#"c("1", "2", '"a"', "NA", NA_character_)"#, R_ENVS.base).unwrap();
r_assert_type(x.sexp, &[STRSXP]).unwrap();

let formatted = FormattedVector::new_with_options(x.sexp, FormattedVectorOptions {
character: FormattedVectorCharacterOptions { quote: false },
character: FormatOptions { quote: false },
})
.unwrap();

let out = formatted.iter().join(" ");
assert_eq!(out, String::from("1 2"));
assert_eq!(out, String::from(r#"1 2 "a" NA NA"#));

let formatted = FormattedVector::new_with_options(x.sexp, FormattedVectorOptions {
character: FormattedVectorCharacterOptions { quote: true },
character: FormatOptions { quote: true },
})
.unwrap();

// NA is always unquoted regardless of the quote option
let out = formatted.iter().join(" ");
assert_eq!(out, String::from("\"1\" \"2\""));
assert_eq!(out, String::from(r#""1" "2" "\"a\"" "NA" NA"#));
})
}
}
3 changes: 2 additions & 1 deletion crates/harp/src/vector/integer_vector.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ use libr::INTSXP;
use libr::SEXP;

use crate::object::RObject;
use crate::vector::FormatOptions;
use crate::vector::Vector;

#[harp_macros::vector]
Expand Down Expand Up @@ -68,7 +69,7 @@ impl Vector for IntegerVector {
*x
}

fn format_one(&self, x: Self::Type) -> String {
fn format_one(&self, x: Self::Type, _option: Option<&FormatOptions>) -> String {
x.to_string()
}
}
3 changes: 2 additions & 1 deletion crates/harp/src/vector/logical_vector.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ use libr::LOGICAL_ELT;
use libr::SEXP;

use crate::object::RObject;
use crate::vector::FormatOptions;
use crate::vector::Vector;

#[harp_macros::vector]
Expand Down Expand Up @@ -68,7 +69,7 @@ impl Vector for LogicalVector {
*x == 1
}

fn format_one(&self, x: Self::Type) -> String {
fn format_one(&self, x: Self::Type, _option: Option<&FormatOptions>) -> String {
if x {
String::from("TRUE")
} else {
Expand Down
14 changes: 11 additions & 3 deletions crates/harp/src/vector/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@ pub use raw_vector::RawVector;
pub mod formatted_vector;
pub mod names;

// Formatting options for character vectors
pub struct FormatOptions {
// Wether to quote the strings or not (defaults to `true`)
// If `true`, elements will be quoted during format so, eg: c("a", "b") becomes ("\"a\"", "\"b\"") in Rust
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should document that the quote option only affects character vectors.

// Currently, this option is meaningful only for a character vector and is ignored on other types
pub quote: bool,
}

pub trait Vector {
type Type;
type Item: ?Sized;
Expand Down Expand Up @@ -100,11 +108,11 @@ pub trait Vector {
Rf_xlength(self.data()) as usize
}

fn format_one(&self, x: Self::Type) -> String;
fn format_one(&self, x: Self::Type, options: Option<&FormatOptions>) -> String;

fn format_elt_unchecked(&self, index: isize) -> String {
fn format_elt_unchecked(&self, index: isize, options: Option<&FormatOptions>) -> String {
match self.get_unchecked(index) {
Some(x) => self.format_one(x),
Some(x) => self.format_one(x, options),
None => String::from("NA"),
}
}
Expand Down
3 changes: 2 additions & 1 deletion crates/harp/src/vector/numeric_vector.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ use libr::REAL_ELT;
use libr::SEXP;

use crate::object::RObject;
use crate::vector::FormatOptions;
use crate::vector::Vector;

#[harp_macros::vector]
Expand Down Expand Up @@ -68,7 +69,7 @@ impl Vector for NumericVector {
*x
}

fn format_one(&self, x: Self::Type) -> String {
fn format_one(&self, x: Self::Type, _option: Option<&FormatOptions>) -> String {
x.to_string()
}
}
3 changes: 2 additions & 1 deletion crates/harp/src/vector/raw_vector.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ use libr::RAW_ELT;
use libr::SEXP;

use crate::object::RObject;
use crate::vector::FormatOptions;
use crate::vector::Vector;

#[harp_macros::vector]
Expand Down Expand Up @@ -67,7 +68,7 @@ impl Vector for RawVector {
*x
}

fn format_one(&self, x: Self::Type) -> String {
fn format_one(&self, x: Self::Type, _option: Option<&FormatOptions>) -> String {
format!("{:02x}", x)
}
}
Loading