simien_ops 0.1.1

// Copyright 2018-2026 the Deno authors. MIT license.

use proc_macro2::Ident;
use proc_macro2::TokenStream;

#[derive(Clone)]
pub struct GeneratorState {
  pub name: Ident,
  /// Identifiers for each of the arguments of the original function
  pub args: Vec<Ident>,
  /// The result of the `call` function
  pub result: Ident,
  /// Whether the op should wrap the result in a [`std::future::ready`]
  pub is_fake_async: bool,

  /// The `v8::CallbackScope` used if necessary for the function.
  pub scope: Ident,
  /// The `v8::FunctionCallbackInfo` used to pass args into the slow function.
  pub info: Ident,
  /// The fused `v8::FunctionCallbackInfoParts` snapshot read once at the
  /// start of a slow callback. Subsequent scope/retval/args helpers reuse
  /// this instead of re-reading the same values from V8 individually.
  pub parts: Ident,
  /// The `v8::FunctionCallbackArguments` used to pass args into the slow function.
  pub fn_args: Ident,
  /// The `OpCtx` used for various information required for some ops.
  pub opctx: Ident,
  /// The `OpState` used for storing op state.
  pub opstate: Ident,
  /// The `JsRuntimeState` used for storing the `Rc<JsRuntimeState>``.
  pub js_runtime_state: Ident,
  /// The `FastApiCallbackOptions` used in fast calls for fallback returns.
  pub fast_api_callback_options: Ident,
  /// The `v8::ReturnValue` used in the slow function
  pub retval: Ident,
  /// The "slow" function (ie: the one that isn't a fastcall)
  pub slow_function: Ident,
  /// The "fast" function (ie: a fastcall)
  pub fast_function: Ident,
  /// The "fast" function (ie: a fastcall)
  pub fast_function_metrics: Ident,
  /// The async function promise ID argument
  pub promise_id: Ident,
  /// Type of the self argument
  pub self_ty: Ident,

  pub moves: Vec<TokenStream>,

  pub needs_args: bool,
  pub needs_retval: bool,
  pub needs_scope: bool,
  /// Set whenever a helper that relies on `FunctionCallbackInfoParts`
  /// (scope/retval/args) is emitted. Drives the single `info.get_parts()`
  /// shim at the top of the slow callback so each helper avoids a separate
  /// FFI call.
  pub needs_parts: bool,
  pub needs_fast_isolate: bool,
  pub needs_isolate: bool,
  pub needs_opstate: bool,
  pub needs_opctx: bool,
  pub needs_stack_trace: bool,
  pub needs_js_runtime_state: bool,
  pub needs_fast_api_callback_options: bool,
  pub needs_self: bool,
  /// Wrap the `this` with cppgc object
  pub use_this_cppgc: bool,
  pub try_unwrap_cppgc: Ident,
}

/// Quotes a set of generator_state fields, along with variables captured from
/// the local environment.
///
/// Example: this will extract `simien_core`, `info` and `scope` from `generator_state`
/// before invoking the [`quote!`] macro.
///
/// ```nocompile
///  gs_quote!(generator_state(info, scope) =>
///    (let mut #scope = unsafe { simien_core::v8::CallbackScope::new(&*#info) };)
///  )
/// ```
macro_rules! gs_quote {
  ($generator_state:ident( $($idents:ident),* ) => $quotable:tt) => {
    {
      $(
        let $idents = &$generator_state.$idents;
      )*
      quote! $quotable
    }
  }
}

/// Extracts GeneratorState vars into the local scope.
///
/// Example:
///
/// Extracts `simien_core` from `generator_state` into a local variable. Equivalent to `let simien_core = &generator_state.simien_core`.
///
/// ```nocompile
/// gs_extract!(generator_state(simien_core))
/// ```
macro_rules! gs_extract {
  ($generator_state:ident( $($idents:ident),* )) => {
    $(
      let $idents = &$generator_state.$idents;
    )*
  }
}

pub(crate) use gs_extract;
pub(crate) use gs_quote;