deno_ops 0.274.0

Proc macro for writing Deno Ops
Documentation
// Copyright 2018-2026 the Deno authors. MIT license.

use proc_macro2::Ident;
use proc_macro2::TokenStream;
use quote::format_ident;
use quote::quote;

use super::V8MappingError;
use super::signature::Arg;
use super::signature::BufferType;
use super::signature::NumericArg;
use super::signature::RefType;
use super::signature::V8Arg;

/// Given an [`Arg`] containing a V8 value, converts this value to its final argument form.
pub fn v8_intermediate_to_arg(i: &Ident, arg: &Arg) -> TokenStream {
  let arg = match arg {
    Arg::V8Ref(RefType::Ref, _) => quote!(&#i),
    Arg::V8Ref(RefType::Mut, _) => quote!(::std::ops::DerefMut::deref_mut(#i)),
    Arg::V8Local(_) => quote!(#i),
    Arg::OptionV8Ref(RefType::Ref, _) => {
      quote!(match &#i { None => None, Some(v) => Some(::std::ops::Deref::deref(v)) })
    }
    Arg::OptionV8Ref(RefType::Mut, _) => {
      quote!(match &#i { None => None, Some(v) => Some(::std::ops::DerefMut::deref_mut(v)) })
    }
    Arg::OptionV8Local(_) => quote!(#i),
    _ => unreachable!("Not a v8 local/ref arg: {arg:?}"),
  };
  quote!(let #i = #arg;)
}

/// Generates a [`v8::Value`] of the correct type for the required V8Arg, throwing an exception if the
/// type cannot be cast.
pub fn v8_to_arg(
  v8: &V8Arg,
  arg_ident: &Ident,
  arg: &Arg,
  mut throw_type_error: impl FnMut() -> Result<TokenStream, V8MappingError>,
  extract_intermediate: TokenStream,
) -> Result<TokenStream, V8MappingError> {
  let try_convert = format_ident!(
    "{}",
    if arg.is_option() {
      "v8_try_convert_option"
    } else {
      "v8_try_convert"
    }
  );
  let throw_type_error_block = if *v8 == V8Arg::Value {
    quote!(unreachable!())
  } else {
    throw_type_error()?
  };
  Ok(quote! {
    let Ok(mut #arg_ident) = deno_core::_ops::#try_convert::<deno_core::v8::#v8>(#arg_ident) else {
      #throw_type_error_block
    };
    #extract_intermediate
  })
}

/// Given a `V8Slice` in `v8slice`, turns it into the appropriate buffer type in `arg_ident`.
pub fn v8slice_to_buffer(
  arg_ident: &Ident,
  v8slice: &Ident,
  buffer: BufferType,
) -> Result<TokenStream, V8MappingError> {
  let make_arg = match buffer {
    BufferType::V8Slice(..) => {
      quote!(let #arg_ident = #arg_ident;)
    }
    BufferType::Slice(
      RefType::Ref,
      NumericArg::u8 | NumericArg::u32 | NumericArg::f32 | NumericArg::f64,
    ) => {
      quote!(let #arg_ident = #v8slice.as_ref();)
    }
    BufferType::Slice(
      RefType::Mut,
      NumericArg::u8 | NumericArg::u32 | NumericArg::f32 | NumericArg::f64,
    ) => {
      quote!(let #arg_ident = #v8slice.as_mut();)
    }
    BufferType::Ptr(
      RefType::Ref,
      NumericArg::u8 | NumericArg::u32 | NumericArg::f32 | NumericArg::f64,
    ) => {
      quote!(let #arg_ident = if #v8slice.len() == 0 { std::ptr::null() } else { #v8slice.as_ref().as_ptr() };)
    }
    BufferType::Ptr(
      RefType::Mut,
      NumericArg::u8 | NumericArg::u32 | NumericArg::f32 | NumericArg::f64,
    ) => {
      quote!(let #arg_ident = if #v8slice.len() == 0 { std::ptr::null_mut() } else { #v8slice.as_mut().as_mut_ptr() };)
    }
    BufferType::Vec(
      NumericArg::u8 | NumericArg::u32 | NumericArg::f32 | NumericArg::f64,
    ) => {
      quote!(let #arg_ident = #v8slice.to_vec();)
    }
    BufferType::BoxSlice(
      NumericArg::u8 | NumericArg::u32 | NumericArg::f32 | NumericArg::f64,
    ) => {
      quote!(let #arg_ident = #v8slice.to_boxed_slice();)
    }
    BufferType::Bytes => {
      quote!(let #arg_ident = #v8slice.to_vec().into();)
    }
    BufferType::JsBuffer => {
      quote!(let #arg_ident = deno_core::serde_v8::JsBuffer::from_parts(#v8slice);)
    }
    _ => return Err("a v8slice argument"),
  };
  Ok(make_arg)
}

// Given a `&[u8]` in `buf`, turns it into the appropriate buffer type in `arg_ident`.
pub fn byte_slice_to_buffer(
  arg_ident: &Ident,
  buf: &Ident,
  buffer: BufferType,
) -> Result<TokenStream, V8MappingError> {
  let res = match buffer {
    BufferType::Slice(
      _,
      NumericArg::u8 | NumericArg::u32 | NumericArg::f32 | NumericArg::f64,
    ) => {
      quote!(let #arg_ident = #buf;)
    }
    BufferType::Ptr(
      _,
      NumericArg::u8 | NumericArg::u32 | NumericArg::f32 | NumericArg::f64,
    ) => {
      quote!(let #arg_ident = if #buf.len() == 0 { ::std::ptr::null_mut() } else { #buf.as_mut_ptr() as _ };)
    }
    BufferType::Vec(
      NumericArg::u8 | NumericArg::u32 | NumericArg::f32 | NumericArg::f64,
    ) => {
      quote!(let #arg_ident = #buf.to_vec();)
    }
    BufferType::BoxSlice(
      NumericArg::u8 | NumericArg::u32 | NumericArg::f32 | NumericArg::f64,
    ) => {
      quote!(let #arg_ident = #buf.to_vec().into_boxed_slice();)
    }
    BufferType::Bytes => {
      quote!(let #arg_ident = #buf.to_vec().into();)
    }
    _ => return Err("a fast typed array buffer argument"),
  };

  Ok(res)
}