io.qt.core.QScopedPointer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qtjambi-jre8 Show documentation
There is a newer version: 6.3.0
/****************************************************************************
**
** Copyright (C) 2009-2021 Dr. Peter Droste, Omix Visualization GmbH & Co. KG. All rights reserved.
**
** This file is part of Qt Jambi.
**
** ** $BEGIN_LICENSE$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
** 
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
** $END_LICENSE$

**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
****************************************************************************/
package io.qt.core;

import java.util.Objects;
import java.util.function.Consumer;

import io.qt.QtUninvokable;
import io.qt.QtObjectInterface;

/**
 * Java wrapper for Qt class QScopedPointer
 * to be used inside a try-with-resource block.
 * Example:
 * 
 * try(var pointer = QScopedPointer.disposing(new QDialog())){

 *     QDialog dialog = pointer.get();

 *     dialog.exec();

 * }

 * // dialog is disposed
 * 
 */
public final class QScopedPointer implements AutoCloseable {
	
	private static class Data{
		private O data;
		private Consumer cleanup;
		
	    @QtUninvokable
		void close(){
			if(cleanup!=null) {
				try{
					if(data!=null)
						cleanup.accept(data);
				}finally{
					cleanup = null;
				}
			}
			data = null;
		}
	}

	private final Data data = new Data<>();
	
	private QScopedPointer(O data, Consumer cleanup) {
		this.data.data = data;
		this.data.cleanup = Objects.requireNonNull(cleanup);
		QtJambi_LibraryUtilities.internal.registerCleaner(this, this.data::close);
	}

    @QtUninvokable
	public O data() {
		return data.data;
	}

    @QtUninvokable
	public O get() {
		return data.data;
	}

    @QtUninvokable
	public O take() {
		O oldData = data.data;
		data.data = null;
		return oldData;
	}

    @QtUninvokable
	public void reset(O other) {
		if(data.cleanup!=null) {
			O oldData = data.data;
			data.data = other;
			data.cleanup.accept(oldData);
		}
	}
	
    @QtUninvokable
	public boolean isNull(){
		return data.data==null;
	}
	
    @QtUninvokable
	public void swap(QScopedPointer other){
		O oldData = data.data;
		Consumer oldCleanup = data.cleanup;
		this.data.data = other.data.data;
		this.data.cleanup = other.data.cleanup;
		other.data.data = oldData;
		other.data.cleanup = oldCleanup;
	}

	@Override
    @QtUninvokable
	public void close(){
		data.close();
	}
	
    @QtUninvokable
	private static void dispose(QtObjectInterface data) {
		if(QtJambi_LibraryUtilities.internal.nativeId(data)!=0)
			data.dispose();
	}
	
    @QtUninvokable
	private static void disposeLater(QObject data) {
		if(QtJambi_LibraryUtilities.internal.nativeId(data)!=0)
			data.disposeLater();
	}
	
    @QtUninvokable
	public static  QScopedPointer disposing(O data){
		return new QScopedPointer<>(data, QScopedPointer::dispose);
	}
	
    @QtUninvokable
	public static  QScopedPointer disposingLater(O data){
		return new QScopedPointer<>(data, QScopedPointer::disposeLater);
	}
	
    @QtUninvokable
	public static  QScopedPointer cleanup(O data, Consumer cleanup){
		return new QScopedPointer<>(data, cleanup);
	}
}