DocumentElement.h

/*
 * Copyright (C) 2026, Robert Patterson
 *
 * 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.
 */
#pragma once
 
#include <cassert>
#include <memory>
#include <stdexcept>
 
#include "musx/dom/Fundamentals.h"
 
namespace musx {
namespace dom {
 
class Document;
using DocumentPtr = std::shared_ptr<Document>;
using DocumentWeakPtr = std::weak_ptr<Document>;
 
class DocumentElement
{
public:
    virtual ~DocumentElement() noexcept(false) = default;
 
    DocumentPtr getDocument() const
    {
        auto document = m_document.lock();
        MUSX_ASSERT_IF(!document) {
            throw std::logic_error("Document pointer is no longer valid.");
        }
        return document;
    }
 
    Cmper getPartId() const { return m_partId; }
 
protected:
    DocumentElement(const DocumentWeakPtr& document, Cmper partId)
        : m_document(document), m_partId(partId) {}
 
    DocumentElement(const DocumentElement&) = default;        
    DocumentElement(DocumentElement&&) noexcept = default;    
 
    DocumentElement& operator=(const DocumentElement&) { return *this; }
 
    DocumentElement& operator=(DocumentElement&&) noexcept { return *this; }
 
private:
    const DocumentWeakPtr m_document{};
    const Cmper m_partId{};
};
 
class DocumentElementNoPart : public DocumentElement
{
    Cmper getPartId() const = delete;
 
public:
    DocumentElementNoPart(const DocumentWeakPtr& document)
        : DocumentElement(document, SCORE_PARTID) {}
};
 
} // namespace dom
} // namespace musx