Mike-Solar
295ea1bfe5
- OakUndoCommand/OakUndoStack become neutral by-value handles
{ctx, addref, release, abi_version}; a handle is a shared_ptr
equivalent at the ABI level, internals untouched (box owns/observes
flag; containers adopt, boxes created by factories own)
- oaknode command factories and undoable variants return/write value
handles; timeline command classes hold value handles; task import
take_command returns a value handle
- tests updated everywhere; suites green: oakundo 22, oaktimeline 117,
oaktask 106, oaknode 96, oakrender 44, oakcodec 18, oakcommon 193,
oakaudio 36
138 lines
4.3 KiB
C
138 lines
4.3 KiB
C
/***
|
|
|
|
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/>.
|
|
|
|
***/
|
|
|
|
#ifndef OAK_EDITOR_NODE_FOLDER_H
|
|
#define OAK_EDITOR_NODE_FOLDER_H
|
|
|
|
#include "node/error.h"
|
|
#include "undo/undocommand.h"
|
|
#include "node/project.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @file folder.h
|
|
* @brief C ABI for olive::Folder (oaknode)
|
|
*
|
|
* A folder is a project node that organizes item children (footage,
|
|
* sequences, subfolders). Folder handles are borrowed from the owning
|
|
* project; they become invalid when the project is freed or cleared.
|
|
*
|
|
* Child add/remove/move operations execute the underlying undo commands
|
|
* live (redo_now); wiring them onto an undo stack is the oakundo /
|
|
* facade layer's job, not this layer's.
|
|
*/
|
|
|
|
/**
|
|
* @brief Create a folder node owned by `project`.
|
|
*
|
|
* The folder is added to the project's graph (Project::add_node()) but is
|
|
* NOT attached under any parent folder; use oaknode_folder_add_child() to
|
|
* place it. The handle is borrowed: the project owns the folder.
|
|
*
|
|
* @return Folder handle, or NULL on failure.
|
|
*/
|
|
OakNodeFolder *oaknode_folder_create(OakNodeProject *project);
|
|
|
|
/**
|
|
* @brief Number of direct item children (Folder::item_child_count()).
|
|
* Negative OAKNODE_E_* code on NULL.
|
|
*/
|
|
int oaknode_folder_child_count(const OakNodeFolder *folder);
|
|
|
|
/**
|
|
* @brief Borrowed node handle of the item child at `index`
|
|
* (Folder::item_child()). NULL when out of range.
|
|
*/
|
|
OakNodeNode *oaknode_folder_child_at(const OakNodeFolder *folder, int index);
|
|
|
|
/**
|
|
* @brief Add `child` as a direct item child of `folder` (live, non-undoable;
|
|
* executes FolderAddChild::redo()).
|
|
*
|
|
* @return OAKNODE_OK, OAKNODE_E_STATE if `child` already belongs to a
|
|
* folder, or another negative OAKNODE_E_* error code.
|
|
*/
|
|
int oaknode_folder_add_child(OakNodeFolder *folder, OakNodeNode *child);
|
|
|
|
/**
|
|
* @brief Borrowed cast from a folder handle to its node handle.
|
|
* NULL for NULL.
|
|
*/
|
|
OakNodeNode *oaknode_folder_as_node(OakNodeFolder *folder);
|
|
|
|
/**
|
|
* @brief Create an undoable FolderAddChild command. Owned; free with
|
|
* oakundo_command_free().
|
|
*/
|
|
OakUndoCommand oaknode_command_create_folder_add_child(
|
|
OakNodeFolder *folder, OakNodeNode *child);
|
|
|
|
/**
|
|
* @brief Remove `child` from `folder` without deleting it (live,
|
|
* non-undoable; executes Folder::RemoveElementCommand::redo()).
|
|
*
|
|
* @return OAKNODE_OK, OAKNODE_E_NOT_FOUND if `child` is not a direct child,
|
|
* or another negative OAKNODE_E_* error code.
|
|
*/
|
|
int oaknode_folder_remove_child(OakNodeFolder *folder, OakNodeNode *child);
|
|
|
|
/**
|
|
* @brief Move several nodes into `dest_folder` (live, non-undoable).
|
|
*
|
|
* Each node is removed from its current folder (if any) and appended to
|
|
* `dest_folder`. Nodes already directly inside `dest_folder` are skipped.
|
|
*
|
|
* @return OAKNODE_OK or a negative OAKNODE_E_* error code.
|
|
*/
|
|
int oaknode_folder_move_children(OakNodeNode *const *nodes, int count,
|
|
OakNodeFolder *dest_folder);
|
|
|
|
/**
|
|
* @brief 1 if `folder` recursively contains `child`, 0 otherwise
|
|
* (Folder::has_child_recursive()). Negative OAKNODE_E_* code on NULL args.
|
|
*/
|
|
int oaknode_folder_has_child_recursive(const OakNodeFolder *folder,
|
|
const OakNodeNode *child);
|
|
|
|
/**
|
|
* @brief Index of `child` in `folder`'s direct children
|
|
* (Folder::index_of_child()).
|
|
*
|
|
* @return The index, OAKNODE_E_NOT_FOUND if not a direct child, or
|
|
* OAKNODE_E_INVALID on NULL args.
|
|
*/
|
|
int oaknode_folder_index_of_child(const OakNodeFolder *folder,
|
|
const OakNodeNode *child);
|
|
|
|
/**
|
|
* @brief Borrowed handle of the folder a node currently belongs to
|
|
* (Node::folder()), or NULL if the node is not in any folder.
|
|
*/
|
|
OakNodeFolder *oaknode_folder_parent_of(const OakNodeNode *node);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif //OAK_EDITOR_NODE_FOLDER_H
|