diff options
Diffstat (limited to 'rust/src/backgroundtask.rs')
| -rw-r--r-- | rust/src/backgroundtask.rs | 128 |
1 files changed, 0 insertions, 128 deletions
diff --git a/rust/src/backgroundtask.rs b/rust/src/backgroundtask.rs deleted file mode 100644 index e5fa6e77..00000000 --- a/rust/src/backgroundtask.rs +++ /dev/null @@ -1,128 +0,0 @@ -// Copyright 2021-2024 Vector 35 Inc. -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -//! Background tasks provide plugins the ability to run tasks in the background so they don't hand the UI - -use binaryninjacore_sys::*; - -use std::result; - -use crate::rc::*; -use crate::string::*; - -pub type Result<R> = result::Result<R, ()>; - -#[derive(PartialEq, Eq, Hash)] -pub struct BackgroundTask { - pub(crate) handle: *mut BNBackgroundTask, -} - -impl BackgroundTask { - pub(crate) unsafe fn from_raw(handle: *mut BNBackgroundTask) -> Self { - debug_assert!(!handle.is_null()); - - Self { handle } - } - - pub fn new<S: BnStrCompatible>(initial_text: S, can_cancel: bool) -> Result<Ref<Self>> { - let text = initial_text.into_bytes_with_nul(); - - let handle = unsafe { BNBeginBackgroundTask(text.as_ref().as_ptr() as *mut _, can_cancel) }; - - if handle.is_null() { - return Err(()); - } - - unsafe { Ok(Ref::new(Self { handle })) } - } - - pub fn can_cancel(&self) -> bool { - unsafe { BNCanCancelBackgroundTask(self.handle) } - } - - pub fn is_cancelled(&self) -> bool { - unsafe { BNIsBackgroundTaskCancelled(self.handle) } - } - - pub fn is_finished(&self) -> bool { - unsafe { BNIsBackgroundTaskFinished(self.handle) } - } - - pub fn get_progress_text(&self) -> BnString { - unsafe { BnString::from_raw(BNGetBackgroundTaskProgressText(self.handle)) } - } - - pub fn cancel(&self) { - unsafe { BNCancelBackgroundTask(self.handle) } - } - - pub fn finish(&self) { - unsafe { BNFinishBackgroundTask(self.handle) } - } - - pub fn set_progress_text<S: BnStrCompatible>(&self, text: S) { - let progress_text = text.into_bytes_with_nul(); - - unsafe { - BNSetBackgroundTaskProgressText(self.handle, progress_text.as_ref().as_ptr() as *mut _) - } - } - - pub fn running_tasks() -> Array<BackgroundTask> { - unsafe { - let mut count = 0; - let handles = BNGetRunningBackgroundTasks(&mut count); - - Array::new(handles, count, ()) - } - } -} - -unsafe impl RefCountable for BackgroundTask { - unsafe fn inc_ref(handle: &Self) -> Ref<Self> { - Ref::new(Self { - handle: BNNewBackgroundTaskReference(handle.handle), - }) - } - - unsafe fn dec_ref(handle: &Self) { - BNFreeBackgroundTask(handle.handle); - } -} - -impl CoreArrayProvider for BackgroundTask { - type Raw = *mut BNBackgroundTask; - type Context = (); - type Wrapped<'a> = Guard<'a, BackgroundTask>; -} - -unsafe impl CoreArrayProviderInner for BackgroundTask { - unsafe fn free(raw: *mut *mut BNBackgroundTask, count: usize, _context: &()) { - BNFreeBackgroundTaskList(raw, count); - } - unsafe fn wrap_raw<'a>(raw: &'a *mut BNBackgroundTask, context: &'a ()) -> Self::Wrapped<'a> { - Guard::new(BackgroundTask::from_raw(*raw), context) - } -} - -impl ToOwned for BackgroundTask { - type Owned = Ref<Self>; - - fn to_owned(&self) -> Self::Owned { - unsafe { RefCountable::inc_ref(self) } - } -} - -unsafe impl Send for BackgroundTask {} -unsafe impl Sync for BackgroundTask {} |
