org.freedesktop.wayland.server.Display Maven / Gradle / Ivy

Go to download
//Copyright 2015 Erik De Rijcke
//
//Licensed under the Apache License,Version2.0(the"License");
//you may not use this file except in compliance with the License.
//You may obtain a copy of the License at
//
//http://www.apache.org/licenses/LICENSE-2.0
//
//Unless required by applicable law or agreed to in writing,software
//distributed under the License is distributed on an"AS IS"BASIS,
//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,either express or implied.
//See the License for the specific language governing permissions and
//limitations under the License.
package org.freedesktop.wayland.server;

import com.sun.jna.Memory;
import com.sun.jna.Pointer;
import org.freedesktop.wayland.HasNative;
import org.freedesktop.wayland.server.jna.WaylandServerLibrary;
import org.freedesktop.wayland.util.ObjectCache;

public class Display implements HasNative {

    private final Pointer pointer;
    private       boolean valid;

    protected Display(final Pointer pointer) {
        this.pointer = pointer;
        this.valid = true;
        addDestroyListener(new Listener() {
            @Override
            public void handle() {
                remove();
                Display.this.valid = false;
                ObjectCache.remove(Display.this.getNative());
            }
        });
        ObjectCache.store(getNative(),
                          this);
    }

    /**
     * Create Wayland display object.
     * 
     * This creates the wl_display object.
     *
     * @return The Wayland display object. Null if failed to create
     */
    public static Display create() {
        return Display.get(WaylandServerLibrary.INSTANCE()
                                               .wl_display_create());
    }

    public static Display get(final Pointer pointer) {
        Display display = ObjectCache.from(pointer);
        if (display == null) {
            display = new Display(pointer);
        }
        return display;
    }

    public int addSocket(final String name) {
        final Pointer m = new Memory(name.length() + 1);
        m.setString(0,
                    name);
        return WaylandServerLibrary.INSTANCE()
                                   .wl_display_add_socket(getNative(),
                                                          m);
    }

    public void terminate() {
        WaylandServerLibrary.INSTANCE()
                            .wl_display_terminate(getNative());
    }

    public void run() {
        WaylandServerLibrary.INSTANCE()
                            .wl_display_run(getNative());
    }

    public void flushClients() {
        WaylandServerLibrary.INSTANCE()
                            .wl_display_flush_clients(getNative());
    }

    /**
     * Get the current serial number
     * 

     * This function returns the most recent serial number, but does not
     * increment it.
     */
    public int getSerial() {
        return WaylandServerLibrary.INSTANCE()
                                   .wl_display_get_serial(getNative());
    }

    /**
     * Get the next serial number
     * 

     * This function increments the display serial number and returns the
     * new value.
     */
    public int nextSerial() {
        return WaylandServerLibrary.INSTANCE()
                                   .wl_display_next_serial(getNative());
    }

    public EventLoop getEventLoop() {
        return EventLoop.get(WaylandServerLibrary.INSTANCE()
                                                 .wl_display_get_event_loop(getNative()));
    }

    @Override
    public boolean isValid() {
        return this.valid;
    }

    public void destroy() {
        if (isValid()) {
            WaylandServerLibrary.INSTANCE()
                                .wl_display_destroy(getNative());
        }
    }

    public void addDestroyListener(final Listener listener) {
        WaylandServerLibrary.INSTANCE()
                            .wl_display_add_destroy_listener(getNative(),
                                                             listener.getNative());
    }

    public int initShm() {
        return WaylandServerLibrary.INSTANCE()
                                   .wl_display_init_shm(getNative());
    }

    /**
     * Add support for a wl_shm pixel format
     * 

     * Add the specified wl_shm format to the list of formats the wl_shm
     * object advertises when a client binds to it.  Adding a format to
     * the list means that clients will know that the compositor supports
     * this format and may use it for creating wl_shm buffers.  The
     * compositor must be able to handle the pixel format when a client
     * requests it.
     * 

     * The compositor by default supports WL_SHM_FORMAT_ARGB8888 and
     * WL_SHM_FORMAT_XRGB8888.
     * 
     *
     * @param format The wl_shm pixel format to advertise
     *
     * @return A pointer to the wl_shm format that was added to the list or NULL if adding it to the list failed.
     */
    public int addShmFormat(final int format) {
        return WaylandServerLibrary.INSTANCE()
                                   .wl_display_add_shm_format(getNative(),
                                                              format)
                                   .getValue();
    }

    public Pointer getNative() {
        return this.pointer;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        final Display display = (Display) o;

        return getNative().equals(display.getNative());
    }

    @Override
    public int hashCode() {
        return getNative().hashCode();
    }

    @Override
    protected void finalize() throws Throwable {
        destroy();
        super.finalize();
    }
}