ValueScript/valuescript_vm/src/string_methods.rs

use std::{rc::Rc, str::Chars};

use crate::{
  format_err,
  helpers::{to_wrapping_index, to_wrapping_index_clamped},
  native_function::{NativeFunction, ThisWrapper},
  vs_array::VsArray,
  vs_value::Val,
  ValTrait,
};

pub fn op_sub_string(string_data: &Rc<String>, subscript: &Val) -> Val {
  let right_index = match subscript.to_index() {
    None => {
      let method = subscript.val_to_string();
      let method_str = method.as_str();

      return match method_str {
        "length" => Val::Number(string_data.as_bytes().len() as f64),
        _ => get_string_method(method_str),
      };
    }
    Some(i) => i,
  };

  let string_bytes = string_data.as_bytes();

  if right_index >= string_bytes.len() {
    return Val::Undefined;
  }

  match unicode_at(string_bytes, string_bytes.len(), right_index) {
    Some(char) => Val::String(Rc::new(char.to_string())),
    None => Val::String(Rc::new(String::from(""))),
  }
}

pub fn get_string_method(method: &str) -> Val {
  // Not supported: charAt, charCodeAt.
  //
  // These methods are inherently about utf16, which is not how strings work in ValueScript. They
  // also have some particularly strange behavior, like:
  //
  //     "foo".charAt(NaN) // "f"
  //
  // Usually we include JavaScript behavior as much as possible, but since ValueScript strings are
  // utf8, there's more license to reinterpret strings and leave out things like this which aren't
  // desirable.

  match method {
    "at" => Val::Static(&AT),
    // "charAt" => Val::Static(&CHAR_AT),
    // "charCodeAt" => Val::Static(&CHAR_CODE_AT),
    "codePointAt" => Val::Static(&CODE_POINT_AT),
    "concat" => Val::Static(&CONCAT),
    "endsWith" => Val::Static(&ENDS_WITH),
    "includes" => Val::Static(&INCLUDES),
    "indexOf" => Val::Static(&INDEX_OF),
    "lastIndexOf" => Val::Static(&LAST_INDEX_OF),
    "localeCompare" => Val::Static(&TODO_LOCALE), // (TODO)
    "match" => Val::Static(&TODO_REGEXES),        // (TODO: regex)
    "matchAll" => Val::Static(&TODO_REGEXES),     // (TODO: regex)
    "normalize" => Val::Static(&NORMALIZE),       // (TODO)
    "padEnd" => Val::Static(&PAD_END),
    "padStart" => Val::Static(&PAD_START),
    "repeat" => Val::Static(&REPEAT),
    "replace" => Val::Static(&TODO_REGEXES), // (TODO: regex)
    "replaceAll" => Val::Static(&TODO_REGEXES), // (TODO: regex)
    "search" => Val::Static(&TODO_REGEXES),  // (TODO: regex)
    "slice" => Val::Static(&SLICE),
    "split" => Val::Static(&SPLIT),
    "startsWith" => Val::Static(&STARTS_WITH),
    "substring" => Val::Static(&SUBSTRING),
    "toLocaleLowerCase" => Val::Static(&TODO_LOCALE),
    "toLocaleUpperCase" => Val::Static(&TODO_LOCALE),
    "toLowerCase" => Val::Static(&TO_LOWER_CASE),
    "toString" => Val::Static(&TO_STRING),
    "toUpperCase" => Val::Static(&TO_UPPER_CASE),
    "trim" => Val::Static(&TRIM),
    "trimEnd" => Val::Static(&TRIM_END),
    "trimStart" => Val::Static(&TRIM_START),
    "valueOf" => Val::Static(&VALUE_OF),
    _ => Val::Undefined,
  }
}

static AT: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let string_bytes = string_data.as_bytes();

        let index = match to_wrapping_index(params.get(0), string_bytes.len()) {
          None => return Ok(Val::Undefined),
          Some(i) => i,
        };

        match unicode_at(string_bytes, string_bytes.len(), index) {
          Some(char) => Val::String(Rc::new(char.to_string())),
          None => Val::String(Rc::new(String::from(""))),
        }
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static CODE_POINT_AT: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let string_bytes = string_data.as_bytes();

        let index = match params.get(0) {
          Some(i) => match i.to_index() {
            None => return Ok(Val::Undefined),
            Some(i) => i,
          },
          _ => return Ok(Val::Undefined),
        };

        match code_point_at(string_bytes, string_bytes.len(), index) {
          Some(code_point) => Val::Number(code_point as f64),
          None => Val::Undefined,
        }
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static CONCAT: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let mut result = string_data.as_str().to_string();

        for param in params {
          result.push_str(param.val_to_string().as_str());
        }

        Val::String(Rc::new(result))
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static ENDS_WITH: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let string_bytes = string_data.as_bytes();

        let search_string = match params.get(0) {
          Some(s) => s.val_to_string(),
          _ => return Ok(Val::Bool(false)),
        };

        let end_pos = match params.get(1) {
          Some(p) => match p.to_index() {
            // FIXME: Using to_index for end_pos is not quite right (eg -1 should be 0)
            None => return Ok(Val::Bool(false)),
            Some(i) => std::cmp::min(i, string_bytes.len()),
          },
          _ => string_bytes.len(),
        };

        let search_bytes = search_string.as_bytes();

        let search_length = search_bytes.len();

        if search_length > end_pos {
          return Ok(Val::Bool(false));
        }

        let start_index = end_pos - search_length;

        for i in 0..search_length {
          if string_bytes[start_index + i] != search_bytes[i] {
            return Ok(Val::Bool(false));
          }
        }

        Val::Bool(true)
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static INCLUDES: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let string_bytes = string_data.as_bytes();

        let search_string = match params.get(0) {
          Some(s) => s.val_to_string(),
          _ => return Ok(Val::Bool(false)),
        };

        let search_bytes = search_string.as_bytes();

        let start_pos = match params.get(1) {
          Some(p) => match p.to_index() {
            // FIXME: to_index isn't quite right here
            Some(i) => i,
            None => return Ok(Val::Bool(false)),
          },
          _ => 0,
        };

        match index_of(string_bytes, search_bytes, start_pos) {
          Some(_) => Val::Bool(true),
          None => Val::Bool(false),
        }
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static INDEX_OF: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let string_bytes = string_data.as_bytes();

        let search_string = match params.get(0) {
          Some(s) => s.val_to_string(),
          _ => return Ok(Val::Number(-1.0)),
        };

        let search_bytes = search_string.as_bytes();

        let start_pos = match params.get(1) {
          Some(p) => match p.to_index() {
            // FIXME: to_index isn't quite right here
            Some(i) => i,
            None => return Ok(Val::Number(-1.0)),
          },
          _ => 0,
        };

        match index_of(string_bytes, search_bytes, start_pos) {
          Some(i) => Val::Number(i as f64),
          None => Val::Number(-1.0),
        }
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static LAST_INDEX_OF: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let string_bytes = string_data.as_bytes();

        let search_string = match params.get(0) {
          Some(s) => s.val_to_string(),
          _ => return Ok(Val::Number(-1.0)),
        };

        let search_bytes = search_string.as_bytes();

        let at_least_pos = match params.get(1) {
          Some(p) => match p.to_index() {
            // FIXME: to_index isn't quite right here
            Some(i) => i,
            None => return Ok(Val::Number(-1.0)),
          },
          _ => 0,
        };

        match last_index_of(string_bytes, search_bytes, at_least_pos) {
          Some(i) => Val::Number(i as f64),
          None => Val::Number(-1.0),
        }
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static TODO_LOCALE: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, _params: Vec<Val>| -> Result<Val, Val> {
    // TODO: Ok(...)
    match this.get() {
      Val::String(_string_data) => {
        return format_err!("TODO: locale");
      }
      _ => return format_err!("string indirection"),
    }
  },
};

static TODO_REGEXES: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, _params: Vec<Val>| -> Result<Val, Val> {
    // TODO: Ok(...)
    match this.get() {
      Val::String(_string_data) => {
        return format_err!("TODO: regexes");
      }
      _ => return format_err!("string indirection"),
    }
  },
};

static NORMALIZE: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, _params: Vec<Val>| -> Result<Val, Val> {
    // TODO: Ok(...)
    match this.get() {
      Val::String(_string_data) => {
        // Consider https://docs.rs/unicode-normalization/latest/unicode_normalization/
        return format_err!("TODO: normalize");
      }
      _ => return format_err!("string indirection"),
    }
  },
};

// TODO: JS has some locale-specific behavior, not sure yet how we should deal with that
static PAD_END: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let target_length = match params.get(0) {
          Some(p) => match p.to_index() {
            Some(i) => i,
            None => return Ok(Val::String(string_data.clone())),
          },
          _ => return Ok(Val::String(string_data.clone())),
        };

        if target_length <= string_data.as_bytes().len() {
          return Ok(Val::String(string_data.clone()));
        }

        let mut string = string_data.to_string();

        let pad_string = match params.get(1) {
          Some(s) => s.val_to_string(),
          _ => " ".to_string(),
        };

        let mut length_deficit = target_length - string.as_bytes().len();

        let whole_copies = length_deficit / pad_string.as_bytes().len();

        for _ in 0..whole_copies {
          string.push_str(&pad_string);
        }

        length_deficit -= whole_copies * pad_string.as_bytes().len();

        if length_deficit > 0 {
          for c in pad_string.chars() {
            let c_len = c.len_utf8();

            if c_len > length_deficit {
              break;
            }

            string.push(c);
            length_deficit -= c_len;
          }
        }

        Val::String(Rc::new(string))
      }
      _ => return format_err!("string indirection"),
    })
  },
};

// TODO: JS has some locale-specific behavior, not sure yet how we should deal with that
static PAD_START: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let target_length = match params.get(0) {
          Some(p) => match p.to_index() {
            Some(i) => i,
            None => return Ok(Val::String(string_data.clone())),
          },
          _ => return Ok(Val::String(string_data.clone())),
        };

        if target_length <= string_data.as_bytes().len() {
          return Ok(Val::String(string_data.clone()));
        }

        let pad_string = match params.get(1) {
          Some(s) => s.val_to_string(),
          _ => " ".to_string(),
        };

        let mut length_deficit = target_length - string_data.as_bytes().len();

        let whole_copies = length_deficit / pad_string.as_bytes().len();

        let mut prefix = String::new();

        for _ in 0..whole_copies {
          prefix.push_str(&pad_string);
        }

        length_deficit -= whole_copies * pad_string.as_bytes().len();

        if length_deficit > 0 {
          for c in pad_string.chars() {
            let c_len = c.len_utf8();

            if c_len > length_deficit {
              break;
            }

            prefix.push(c);
            length_deficit -= c_len;
          }
        }

        prefix.push_str(string_data);

        Val::String(Rc::new(prefix))
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static REPEAT: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let count = match params.get(0) {
          Some(p) => match p.to_index() {
            Some(i) => i,
            None => return Ok(Val::String(string_data.clone())),
          },
          _ => return Ok(Val::String(string_data.clone())),
        };

        let mut result = String::new();

        for _ in 0..count {
          result.push_str(string_data);
        }

        Val::String(Rc::new(result))
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static SLICE: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let string_bytes = string_data.as_bytes();

        let start = match params.get(0) {
          None => 0,
          Some(v) => to_wrapping_index_clamped(v, string_bytes.len()),
        };

        let end = match params.get(1) {
          None => string_bytes.len() as isize,
          Some(v) => to_wrapping_index_clamped(v, string_bytes.len()),
        };

        let mut new_string = String::new();

        // FIXME: This is a slow way of doing it. Part of the reason is that we're using rust's
        // string type, so we can't just find the relevant byte range and copy it in one go.
        for i in start..end {
          match unicode_at(string_bytes, end as usize, i as usize) {
            Some(c) => new_string.push(c),
            None => {}
          }
        }

        Val::String(Rc::new(new_string))
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static SPLIT: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let separator = match params.get(0) {
          Some(s) => s.val_to_string(), // TODO: Regexes
          None => return Ok(Val::String(string_data.clone())),
        };

        let limit = match params.get(1) {
          // FIXME: to_index isn't quite right
          Some(l) => match l.to_index() {
            Some(i) => i,
            None => string_data.as_bytes().len() + 1,
          },
          None => string_data.as_bytes().len() + 1,
        };

        let mut result = Vec::<Val>::new();

        if limit == 0 {
          return Ok(Val::Array(Rc::new(VsArray::from(result))));
        }

        if separator.is_empty() {
          for c in string_data.chars() {
            result.push(Val::String(Rc::new(c.to_string())));

            if result.len() == limit {
              break;
            }
          }

          return Ok(Val::Array(Rc::new(VsArray::from(result))));
        }

        let mut part = String::new();
        let mut str_chars = string_data.chars();

        loop {
          if match_chars(&mut str_chars, &separator) {
            let mut new_part = String::new();
            std::mem::swap(&mut new_part, &mut part);
            result.push(Val::String(Rc::new(new_part)));

            if result.len() == limit {
              break;
            }
          } else {
            match str_chars.next() {
              Some(c) => part.push(c),
              None => {
                result.push(Val::String(Rc::new(part)));
                break;
              }
            }
          }
        }

        Val::Array(Rc::new(VsArray::from(result)))
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static STARTS_WITH: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let string_bytes = string_data.as_bytes();

        let search_string = match params.get(0) {
          Some(s) => s.val_to_string(),
          _ => return Ok(Val::Bool(false)),
        };

        let pos = match params.get(1) {
          Some(p) => match p.to_index() {
            // FIXME: Using to_index is not quite right
            None => return Ok(Val::Bool(false)),
            Some(i) => std::cmp::min(i, string_bytes.len()),
          },
          _ => 0,
        };

        let search_bytes = search_string.as_bytes();

        let search_length = search_bytes.len();

        if search_length > string_bytes.len() - pos {
          return Ok(Val::Bool(false));
        }

        for i in 0..search_length {
          if string_bytes[pos + i] != search_bytes[i] {
            return Ok(Val::Bool(false));
          }
        }

        Val::Bool(true)
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static SUBSTRING: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let string_bytes = string_data.as_bytes();

        let start = match params.get(0) {
          Some(v) => match v.to_index() {
            Some(i) => std::cmp::min(i, string_bytes.len()),
            None => 0,
          },
          None => 0,
        };

        let end = match params.get(1) {
          Some(v) => match v.to_index() {
            Some(i) => std::cmp::min(i, string_bytes.len()),
            None => string_bytes.len(),
          },
          None => string_bytes.len(),
        };

        let substring_start = std::cmp::min(start, end);
        let substring_end = std::cmp::max(start, end);

        let mut new_string = String::new();

        // FIXME: This is a slow way of doing it. Part of the reason is that we're using rust's
        // string type, so we can't just find the relevant byte range and copy it in one go.
        for i in substring_start..substring_end {
          match unicode_at(string_bytes, substring_end, i) {
            Some(c) => new_string.push(c),
            None => {}
          }
        }

        Val::String(Rc::new(new_string))
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static TO_LOWER_CASE: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, _params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let lowercased_string = string_data.to_lowercase();
        Val::String(Rc::new(lowercased_string))
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static TO_STRING: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, _params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => Val::String(string_data.clone()),
      _ => return format_err!("string indirection"),
    })
  },
};

static TO_UPPER_CASE: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, _params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let uppercased_string = string_data.to_uppercase();
        Val::String(Rc::new(uppercased_string))
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static TRIM: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, _params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let trimmed_string = string_data.trim();
        Val::String(Rc::new(trimmed_string.to_owned()))
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static TRIM_END: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, _params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let trimmed_string = string_data.trim_end();
        Val::String(Rc::new(trimmed_string.to_owned()))
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static TRIM_START: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, _params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => {
        let trimmed_string = string_data.trim_start();
        Val::String(Rc::new(trimmed_string.to_owned()))
      }
      _ => return format_err!("string indirection"),
    })
  },
};

static VALUE_OF: NativeFunction = NativeFunction {
  fn_: |this: ThisWrapper, _params: Vec<Val>| -> Result<Val, Val> {
    Ok(match this.get() {
      Val::String(string_data) => Val::String(string_data.clone()),
      _ => return format_err!("string indirection"),
    })
  },
};

/**
 * Tries to match str_chars_param against matcher.
 * - Successful match: Advances str_chars_param and returns true.
 * - Unsuccessful match: Does not advance str_chars_param and returns false.
 */
fn match_chars(str_chars_param: &mut Chars, matcher: &String) -> bool {
  let mut str_chars = str_chars_param.clone();
  let mut matcher_chars = matcher.chars();

  loop {
    let matcher_char = match matcher_chars.next() {
      Some(c) => c,
      None => {
        *str_chars_param = str_chars;
        return true;
      }
    };

    let str_char = match str_chars.next() {
      Some(c) => c,
      None => return false,
    };

    if str_char != matcher_char {
      return false;
    }
  }
}

fn index_of(string_bytes: &[u8], search_bytes: &[u8], start_pos: usize) -> Option<usize> {
  let search_length = search_bytes.len();

  if start_pos + search_length > string_bytes.len() {
    // TODO: If search_length is 0, we should apparently return the length of the string instead of
    // returning none (why??)
    return None;
  }

  if search_length == 0 {
    return Some(0);
  }

  'outer: for i in start_pos..=(string_bytes.len() - search_length) {
    for j in 0..search_length {
      if string_bytes[i + j] != search_bytes[j] {
        continue 'outer;
      }
    }

    return Some(i);
  }

  None
}

fn last_index_of(string_bytes: &[u8], search_bytes: &[u8], at_least_pos: usize) -> Option<usize> {
  let search_length = search_bytes.len();

  if search_length > string_bytes.len() {
    return None;
  }

  if search_length == 0 {
    return Some(string_bytes.len());
  }

  'outer: for i in (at_least_pos..=string_bytes.len() - search_length).rev() {
    for j in 0..search_length {
      if string_bytes[i + j] != search_bytes[j] {
        continue 'outer;
      }
    }

    return Some(i);
  }

  None
}

fn unicode_at(bytes: &[u8], len: usize, index: usize) -> Option<char> {
  match code_point_at(bytes, len, index) {
    Some(code_point) => Some(
      std::char::from_u32(code_point).expect("Invalid code point"), // TODO: Find out if this is reachable and what to do about it
    ),
    None => None,
  }
}

fn code_point_at(bytes: &[u8], len: usize, index: usize) -> Option<u32> {
  if index >= len {
    return None;
  }

  let byte = bytes[index];

  let leading_ones = byte.leading_ones() as usize;

  if leading_ones == 0 {
    return Some(byte as u32);
  }

  if leading_ones == 1 || leading_ones > 4 || index + leading_ones > len {
    return None;
  }

  let mut value = (byte & (0x7F >> leading_ones)) as u32;

  for i in 1..leading_ones {
    let next_byte = bytes[index + i];

    if next_byte.leading_ones() != 1 {
      return None;
    }

    value = (value << 6) | (next_byte & 0x3F) as u32;
  }

  Some(value)
}