src/ascension/behavior.h

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * Copyright 2025 Mike Becker. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


#ifndef ASC_BEHAVIOR_H
#define ASC_BEHAVIOR_H

#include "scene_node.h"

typedef struct asc_behavior_s AscBehavior;

typedef void(*asc_behavior_func)(AscBehavior*);
typedef void(*asc_behavior_destroy_func)(AscBehavior*);

struct asc_behavior_s {
    AscSceneNode *node;
    asc_behavior_func func;
    asc_behavior_destroy_func destroy_func;
    void *data;
    uint64_t last_execution;
    uint64_t interval;
    cxmutstr name;
    bool enabled;
    bool killed;
    // TODO: more useful attributes
};

struct asc_behavior_create_args {
    /**
     * The function that is invoked when the behavior is triggered.
     */
    asc_behavior_func func;
    /**
     * The function that is invoked when the behavior is destroyed.
     */
    asc_behavior_destroy_func destroy_func;
    /**
     * Pointer to additional custom data.
     */
    void *data;
    /**
     * Minimum delay between two successive executions in nanoseconds.
     */
    uint64_t interval;
    /**
     * Optional name of the behavior.
     */
    const char *name;
};

AscBehavior *asc_behavior_add_(AscSceneNode *node, struct asc_behavior_create_args args);
#define asc_behavior_add(node,...) asc_behavior_add_(node, (struct asc_behavior_create_args){__VA_ARGS__})

/**
 * Removes and destroys a behavior.
 *
 * If you just want to temporarily pause a behavior, use asc_behavior_disable().
 *
 * @param behavior the behavior to remove
 * @see asc_behavior_disable()
 */
void asc_behavior_remove(AscBehavior *behavior);

/**
 * Used internally. Do not invoke manually.
 *
 * @param behavior the behavior
 */
void asc_behavior_trigger(AscBehavior *behavior);

/**
 * Assigns a name to a behavior.
 *
 * @param behavior the behavior
 * @param name the new name
 */
void asc_behavior_name(AscBehavior *behavior, const char *name);

/**
 * Returns the name of a behavior.
 *
 * @param behavior the behavior
 * @return the name of the behavior
 */
cxstring asc_behavior_get_name(const AscBehavior *behavior);

/**
 * Enables a behavior
 *
 * Has no effect on killed behaviors.
 *
 * @param behavior the behavior to enable
 */
static inline void asc_behavior_enable(AscBehavior *behavior) {
    behavior->enabled = !behavior->killed;
}

/**
 * Disables a behavior.
 *
 * @param behavior the behavior to disable
 */
static inline void asc_behavior_disable(AscBehavior *behavior) {
    behavior->enabled = false;
}

#endif