Source/JavaScriptCore/heap/HeapFinalizerCallback.h

/*
 * Copyright (C) 2017 Apple Inc.  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 APPLE INC. ``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 APPLE INC. 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. 
 */

#pragma once

#include "JSHeapFinalizerPrivate.h"
#include <wtf/PrintStream.h>

namespace JSC {

class VM;

class HeapFinalizerCallback {
public:
    HeapFinalizerCallback(JSHeapFinalizer finalizer = nullptr, void *userData = nullptr)
        : m_finalizer(finalizer)
        , m_userData(userData)
    {
    }
    
    bool operator==(const HeapFinalizerCallback& other) const
    {
        return m_finalizer == other.m_finalizer
            && m_userData == other.m_userData;
    }
    
    bool operator!=(const HeapFinalizerCallback& other) const
    {
        return !(*this == other);
    }
    
    explicit operator bool() const
    {
        return *this != HeapFinalizerCallback();
    }
    
    void dump(PrintStream&) const;
    
    void run(VM&) const;
    
private:
    JSHeapFinalizer m_finalizer;
    void *m_userData;
};

} // namespace JSC