compute_kernel_writer/prototype/examples/common/ExampleScopedKernelWriter.h

/*
 * Copyright (c) 2023 Arm Limited.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef CKW_PROTOTYPE_EXAMPLES_COMMON_EXAMPLESCOPEDKERNELWRITER_H
#define CKW_PROTOTYPE_EXAMPLES_COMMON_EXAMPLESCOPEDKERNELWRITER_H

#include <cstdint>

class ExampleKernelWriter;

/** Helper to automatically manage kernel writer ID space. */
class ExampleScopedKernelWriter
{
public:
    /** Initialize a new instance of @ref ExampleScopedKernelWriter class. */
    explicit ExampleScopedKernelWriter(ExampleKernelWriter *writer);

    /** Create a new scope from the specified scoped kernel writer. */
    ExampleScopedKernelWriter(const ExampleScopedKernelWriter &other);

    /** Assignment is disallowed. */
    ExampleScopedKernelWriter &operator=(const ExampleScopedKernelWriter &) = delete;

    /** Access the underlying kernel writer. */
    ExampleKernelWriter *operator->();

    /** Access the underlying kernel writer. */
    const ExampleKernelWriter *operator->() const;

    /** Get the kernel writer. */
    ExampleKernelWriter *writer();

    /** Get the kernel writer. */
    const ExampleKernelWriter *writer() const;

private:
    ExampleKernelWriter *_writer;
    int32_t              _parent_id_space;
};

#endif // CKW_PROTOTYPE_EXAMPLES_COMMON_EXAMPLESCOPEDKERNELWRITER_H