add AdjustmentMethod

Signed-off-by: Mattias Andrée <maandree@operamail.com>

1 files changed, 223 insertions, 0 deletions

diff --git a/src/libgamma/AdjustmentMethod.java b/src/libgamma/AdjustmentMethod.java
new file mode 100644
index 0000000..c8efb40
--- /dev/null
+++ b/src/libgamma/AdjustmentMethod.java
@@ -0,0 +1,223 @@
+/**
+ * jlibgamma — Display server abstraction layer for gamma ramp and Java
+ * Copyright © 2014  Mattias Andrée (maandree@member.fsf.org)
+ * 
+ * This library is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This library 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 General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package libgamma;
+
+
+/**
+ * Class of adjustment methods.
+ */
+public enum AdjustmentMethod
+{
+    /**
+     * The identifier for the dummy adjustment method.
+     * This method can be configured and is useful for
+     * testing your program's ability to handle errors.
+     */
+    DUMMY(0),
+    
+    /**
+     * The identifier for the adjustment method with
+     * uses the RandR protocol under the X display server.
+     */
+    X_RANDR(1),
+    
+    /**
+     * The identifier for the adjustment method with
+     * uses the VidMode protocol under the X display server.
+     * This is an older alternative to RandR that can
+     * work on some drivers that are not supported by RandR,
+     * however it can only control the primary CRTC per
+     * screen (partition).
+     */
+    X_VIDMODE(2),
+    
+    /**
+     * The identifier for the Direct Rendering Manager
+     * adjustment method that is available in Linux
+     * (built in to the Linux kernel with a userland
+     * library for access) and is a part of the
+     * Direct Rendering Infrastructure. This adjustment
+     * method all work when you are in non-graphical
+     * mode; however a display server cannnot be
+     * started while this is running, but it can be
+     * started while a display server is running.
+     */
+    LINUX_DRM(3),
+    
+    /**
+     * The identifier for the Graphics Device Interface
+     * adjustment method that is available in Windows.
+     * This method is not well tested; it can be compiled
+     * to be available under X.org using a translation layer.
+     */
+    W32_GDI(4),
+    
+    /**
+     * The identifier for the CoreGraphics adjustment
+     * method that is available in Mac OS X that can
+     * adjust gamma ramps under the Quartz display server.
+     * This method is not well tested; it can be compiled
+     * to be available under X.org using a translation layer.
+     */
+    QUARTZ_CORE_GRAPHICS(5)
+    
+    ;
+    
+    
+    /**
+     * The index of the last gamma method, neither it
+     * nor any index before it may actually be supported
+     * as it could have been disabled at compile-time
+     */
+    public static final int MAX = 5;
+    
+    /**
+     * The number adjustment methods provided by this library.
+     * Note however that this includes adjstment methods that
+     * have been removed at compile-time.
+     */
+    public static final int COUNT = MAX + 1;
+    
+    
+    
+    /**
+     * Constructor.
+     * 
+     * @param  value  The numerical value of the adjustment method.
+     */
+    private AdjustmentMethod(int value)
+    {
+	this.value = value;
+    }
+    
+    
+    /**
+     * The numerical value of the adjustment method.
+     */
+    public final int value;
+    
+    
+    
+    /**
+     * Check whether the adjustment method is available.
+     * 
+     * @return  Whether the adjustment method is available.
+     */
+    public boolean is_available()
+    {
+	return libgamma_is_method_available(this.value) != 0;
+    }
+    
+    /**
+     * Get the default site for the adjustment method.
+     * 
+     * @return  The default site for the adjustment method.
+     */
+    public String default_site()
+    {
+	return libgamma_method_default_site(this.value);
+    }
+    
+    /**
+     * Get the default variable that determines the default
+     * site for the adjustment method.
+     * 
+     * @return  default  variable that determines the default
+     *                   site for the adjustment method.
+     */
+    public String default_site_variable()
+    {
+	return libgamma_method_default_site_variable(this.value);
+    }
+    
+    
+    
+    /**
+     * List available adjustment methods by their order of preference based on the environment.
+     * 
+     * @param   operation  Allowed values:
+     *                       0: Methods that the environment suggests will work, excluding fake.
+     *                       1: Methods that the environment suggests will work, including fake.
+     *                       2: All real non-fake methods.
+     *                       3: All real methods.
+     *                       4: All methods.
+     *                     Other values invoke undefined behaviour.
+     * @return             List available adjustment methods by their order of preference.
+     */
+    public static AdjustmentMethod[] list_methods(int operation)
+    {
+	int[] methods = libgamma_list_methods(operation);
+	AdjustmentMethod[] rc = new AdjustmentMethod[methods.length];
+	for (int i = 0; i < methods.length; i++)
+	{   if      (methods[i] == DUMMY.value)                 rc[i] = DUMMY;
+	    else if (methods[i] == X_RANDR.value)               rc[i] = X_RANDR;
+	    else if (methods[i] == X_VIDMODE.value)             rc[i] = X_VIDMODE;
+	    else if (methods[i] == LINUX_DRM.value)             rc[i] = LINUX_DRM;
+	    else if (methods[i] == W32_GDI.value)               rc[i] = W32_GDI;
+	    else if (methods[i] == QUARTZ_CORE_GRAPHICS.value)  rc[i] = QUARTZ_CORE_GRAPHICS;
+	}
+	return rc;
+    }
+    
+    
+    
+    /**
+     * List available adjustment methods by their order of preference based on the environment.
+     * 
+     * @param   operation  Allowed values:
+     *                       0: Methods that the environment suggests will work, excluding fake.
+     *                       1: Methods that the environment suggests will work, including fake.
+     *                       2: All real non-fake methods.
+     *                       3: All real methods.
+     *                       4: All methods.
+     *                     Other values invoke undefined behaviour.
+     * @return             List available adjustment methods by their order of preference.
+     */
+    private static native int[] libgamma_list_methods(int operation);
+    
+    /**
+     * Check whether an adjustment method is available, non-existing (invalid) methods will be
+     * identified as not available under the rationale that the library may be out of date.
+     * 
+     * @param   method  The adjustment method.
+     * @return          Whether the adjustment method is available.
+     */
+    private static native int libgamma_is_method_available(int method);
+    
+    /**
+     * Return the default site for an adjustment method.
+     * 
+     * @param   method  The adjustment method (display server and protocol.)
+     * @return          The default site, {@code null} if it cannot be determined or
+     *                  if multiple sites are not supported by the adjustment method.
+     */
+    private static native String libgamma_method_default_site(int method);
+    
+    /**
+     * Return the default variable that determines
+     * the default site for an adjustment method.
+     * 
+     * @param   method  The adjustment method (display server and protocol.)
+     * @return          The environ variables that is used to determine the
+     *                  default site. {@code null} if there is none, that is,
+     *                  if the method does not support multiple sites.
+     */
+    private static native String libgamma_method_default_site_variable(int method);
+    
+}
+