From e42580e65a3fa5cadb87c5d7e18cd9d94585d853 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Wed, 4 Jun 2014 20:09:26 +0200 Subject: split out and doc adjustment method functions from test.c MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- src/test/methods.h | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 src/test/methods.h (limited to 'src/test/methods.h') diff --git a/src/test/methods.h b/src/test/methods.h new file mode 100644 index 0000000..fcce69b --- /dev/null +++ b/src/test/methods.h @@ -0,0 +1,69 @@ +/** + * libgamma — Display server abstraction layer for gamma ramp adjustments + * 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 . + */ +#ifndef LIBGAMMA_TEST_METHODS_H +#define LIBGAMMA_TEST_METHODS_H + + +/** + * Get the name representation of an + * adjustment method by its identifier. + * + * @param method The identifier of the adjustment method. + * @return The name of the adjustment method, should not be `free`:d. + */ +const char* method_name(int method) __attribute__((const)); + +/** + * Print a list of adjustment methods. + * + * @param description Precursory text for the list. + * @param methods An array allocated to fit all adjustment methods. + * @param operation See the `operation` parameter for `libgamma_list_methods`. + */ +void list_methods(const char* description, int* methods, int operation); + +/** + * Print all lists, of adjustments methods, that + * are made available by `libgamma_list_methods`. + */ +void list_methods_lists(void); + +/** + * Test the availability (determined + * at compile-time) of all adjustment + * methods and one that does not exist. + */ +void method_availability(void); + +/** + * List the default site and the environment + * variable, if any, that determines the + * default site, for all availiable adjustment + * methods. + */ +void list_default_sites(void); + +/** + * Print the capabilities of all availiable + * adjustment methods. + */ +void method_capabilities(void); + + +#endif + -- cgit v1.2.3-70-g09d2