SafelyAccessShared.h

Go to the documentation of this file.

/*
 * This file is a part of the Biology project by eons LLC.
 * Biology (aka Develop Biology) is a framework for approaching software
 * development from a natural sciences perspective.
 *
 * Copyright (C) 2026 Séon O'Shannon & eons LLC
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
#pragma once
 
#include "bio/common/macro/Macros.h"
#include "bio/common/wrapper/Pointer.h"
 
namespace bio
{
 
template < class CLASS >
class SafelyAccessShared
{
public:
    SafelyAccessShared() :
        mClass(&CLASS::Instance())
    {
        this->CommonConstructor();
    }
 
    SafelyAccessShared(Pointer< CLASS > toAccess) :
        mClass(toAccess)
    {
        this->CommonConstructor();
    }
 
    ~SafelyAccessShared()
    {
        this->mClass->UnlockMutexShared();
    }
 
    Pointer< const CLASS > operator->() const
    {
        return this->mClass;
    }
 
    Pointer< const CLASS > operator*() const
    {
        return mClass;
    }
 
private:
    Pointer< CLASS > mClass;
 
    void CommonConstructor()
    {
        BIO_ASSERT(this->mClass)
        this->mClass->LockMutexShared();
    }
 
    // Non-copyable; matches SafelyAccess<T>.
    SafelyAccessShared(SafelyAccessShared const &);
    void operator=(SafelyAccessShared const &);
};
 
} // bio namespace