Files
oak-editor/crates/oaknode/src/id.rs
T
Mike-Solar 013a175707 refactor: workspace layout — crates/, app at root, legacy C++ removed
Single mechanical restructure commit:
- root Cargo.toml = oakapp bin + workspace; one cargo build produces
  oakapp, oak-cli, oak-worker, liboakengine.dylib
- app/rust/src -> src/ (app at repo root, no rust/ nesting)
- src/<mod>/rust -> crates/oak<mod>; src/oakcore-rs -> crates/oakcore;
  src/bindings/oakotio -> crates/oakotio; src/engine/rust ->
  crates/oakengine (keeps cdylib+staticlib+rlib)
- public C headers include/<mod>/ -> crates/oakengine/include/<mod>/
- OFX SDK headers vendored into crates/oakplugin/ofx/ (HostSupport gone)
- legacy deleted: old src/ C++ modules, engine/, core/, ffmpeg_bridge/,
  app/ (Qt), cli/worker C++, root CMakeLists, third_party/KDDockWidgets
  submodule, otio-install, all build-* output (~40GB)
- oakstorage kept but excluded from the workspace (skeleton w/ todos);
  gpui excluded (own workspace)
- verified: cargo build green, cargo test --workspace 1845/0
  (with the documented OCIO_RS_* env override for the homebrew OCIO)
2026-08-10 20:24:25 +08:00

79 lines
2.6 KiB
Rust

// Oak Video Editor - Non-Linear Video Editor
// Copyright (C) 2026 Oak Team
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//! Generational identifiers for arena-stored graph objects.
//!
//! The public C ABI hands out opaque refcounted handle boxes; inside
//! the crate, a handle boxes `(Arc<Mutex<Project>>, NodeId)`. The
//! generation counter makes a stale `NodeId` (whose slot was reused)
//! fail loudly instead of aliasing a different node — this replaces
//! the C++ design's dangling-pointer failure mode with a checked one.
/// Id of a node inside a [`crate::graph::Graph`] arena.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct NodeId {
index: u32,
generation: u32,
}
impl NodeId {
/// Sentinel marking "no node" (project without a root folder, empty
/// references). Not a valid arena slot: the arena never produces this
/// value (an index of `u32::MAX` is rejected by [`NodeId::valid`]).
pub const INVALID: NodeId = NodeId {
index: u32::MAX,
generation: 0,
};
/// Construct from raw parts (arena-internal use).
pub(crate) fn new(index: u32, generation: u32) -> NodeId {
NodeId { index, generation }
}
/// True when this id names a real arena slot (not [`NodeId::INVALID`]).
pub fn valid(self) -> bool {
self.index != u32::MAX
}
/// Slot index.
pub fn index(self) -> u32 {
self.index
}
/// Generation counter.
pub fn generation(self) -> u32 {
self.generation
}
/// Stable identity integer for registry keys and XML cross-
/// references (replaces the C++ raw-pointer `uintptr_t` identity;
/// NOT an address, safe to persist within a session).
pub fn identity(self) -> u64 {
((self.generation as u64) << 32) | self.index as u64
}
/// Inverse of [`NodeId::identity`]: rebuild an id from its packed
/// form. `None` for the invalid sentinel.
pub fn from_identity(id: u64) -> Option<NodeId> {
let index = (id & 0xffff_ffff) as u32;
let generation = (id >> 32) as u32;
if index == u32::MAX {
return None;
}
Some(NodeId { index, generation })
}
}