Merge lp:~brandontschaefer/mir/replace-mir-supported-with-bool into lp:mir

[Brandon Schaefer]

Replace MirGammaSupported enum with a bool.

Replace MirGammaSupported enum with a bool.

This code is unreleased.

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3775
https://mir-jenkins.ubuntu.com/job/mir-ci/2017/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/2585/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2648
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2640
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2640
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2640
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2614/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2614/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2614/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2614/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2614/console
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2614/console

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/2017/rebuild

review: Needs Fixing (continuous-integration)

[Mir CI Bot (mir-ci-bot)]

FAILED: Continuous integration, rev:3776
https://mir-jenkins.ubuntu.com/job/mir-ci/2019/
Executed test runs:
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-mir/2588/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2651
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2643
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2643
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2643
    FAILURE: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2617/console
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2617
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2617/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2617
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2617/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2617
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2617/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2617
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2617/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2617
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2617/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/2019/rebuild

review: Needs Fixing (continuous-integration)

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:3776
https://mir-jenkins.ubuntu.com/job/mir-ci/2024/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/2593
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2656
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2648
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2648
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2648
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2622
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2622/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2622
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2622/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2622
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2622/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2622
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2622/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2622
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2622/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2622
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2622/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/2024/rebuild

review: Approve (continuous-integration)

[Cemil Azizoglu (cemil-azizoglu)]

+ * \returns ture if gamma is supported on the hardwise, otherwise not supported
11

"ture", "hardwise"
-----------------------

Ok otherwise, so just marking approved.

review: Approve

[Alan Griffiths (alan-griffiths)]

I don't object to is_supported() returning a bool, but...

- mir_output_gamma_unsupported
+ false

This slippery slope leads to the madness of long sequences of 0s, nullptrs and false that mean nothing to the reader.

review: Needs Fixing

[Daniel van Vugt (vanvugt)]

(1) What Cemil said (actually needs fixing):
ture if gamma is supported on the hardwise, otherwise not supported

(2) You might also consider using a bit flag. Its absence is zero but presence is a named flag rather than "true".

review: Needs Fixing

[Chris Halse Rogers (raof)]

Concur with Alan - we don't actually want to remove MirOutputGammaSupported, because it's used in non-output positions.

The only change we wanted was
MirOutputGammaSupported mir_output_is_gamma_supported() → bool mir_output_is_gamma_supported().

review: Needs Fixing

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:3778
https://mir-jenkins.ubuntu.com/job/mir-ci/2031/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-mir/2601
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/2664
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=vivid+overlay/2656
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial+overlay/2656
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=yakkety/2656
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2630
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=clang,platform=mesa,release=yakkety/2630/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2630
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=xenial+overlay/2630/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2630
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=amd64,compiler=gcc,platform=mesa,release=yakkety/2630/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2630
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=cross-armhf,compiler=gcc,platform=android,release=vivid+overlay/2630/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2630
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=android,release=vivid+overlay/2630/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2630
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-mir/arch=i386,compiler=gcc,platform=mesa,release=xenial+overlay/2630/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/mir-ci/2031/rebuild

review: Approve (continuous-integration)

[Daniel van Vugt (vanvugt)]

Is this now an opportunity to privatise the type MirOutputGammaSupported ?

review: Needs Information

[Alan Griffiths (alan-griffiths)]

OK

review: Approve

[Chris Halse Rogers (raof)]

On Fri, Oct 21, 2016 at 10:01 AM, Daniel van Vugt
<email address hidden> wrote:
> Review: Needs Information
>
> Is this now an opportunity to privatise the type
> MirOutputGammaSupported ?

I believe the answer is yes.

There's no reason not to land this now and do that in a second thing.

[Chris Halse Rogers (raof)]

Yes.

review: Approve

[Alan Griffiths (alan-griffiths)]

> Is this now an opportunity to privatise the type MirOutputGammaSupported ?

No. I wish DisplayConfigurationOutput wasn't public, but it is.

[Chris Halse Rogers (raof)]

For now!

[Brandon Schaefer (brandontschaefer)]

Ill propose an change to remove that from the public API

[Alan Griffiths (alan-griffiths)]

On 21/10/16 12:23, Brandon Schaefer wrote:
> Ill propose an change to remove that from the public API

Only do that after fixing QtMir

--
Alan Griffiths [phone]
Octopull Ltd http://www.octopull.co.uk/

[Brandon Schaefer (brandontschaefer)]

Hmm this should be unreleased? Ill double check

=== modified file 'include/client/mir_toolkit/mir_display_configuration.h'
--- include/client/mir_toolkit/mir_display_configuration.h	2016-10-12 06:03:15 +0000
+++ include/client/mir_toolkit/mir_display_configuration.h	2016-10-20 15:08:14 +0000
@@ -477,10 +477,9 @@
 /** Gets if the platform supports gamma correction
  *
  * \param [in]  output  The MirOutput to query
- * \returns     The MirOutputGammaSupported mir_display_gamma_supported otherwise,
- *               mir_display_gamma_unsupported
+ * \returns     true if gamma is supported on the hardware, otherwise not supported
  */
-MirOutputGammaSupported mir_output_is_gamma_supported(MirOutput const* client_output);
+bool mir_output_is_gamma_supported(MirOutput const* client_output);
 
 /** Gets the gamma size
  *

=== modified file 'src/client/display_configuration_api.cpp'
--- src/client/display_configuration_api.cpp	2016-10-12 06:03:15 +0000
+++ src/client/display_configuration_api.cpp	2016-10-20 15:08:14 +0000
@@ -360,11 +360,11 @@
     return (output->gamma_red().size() / (sizeof(uint16_t) / sizeof(char)));
 }
 
-MirOutputGammaSupported mir_output_is_gamma_supported(MirOutput const* client_output)
+bool mir_output_is_gamma_supported(MirOutput const* client_output)
 {
     auto output = client_to_output(client_output);
 
-    return static_cast<MirOutputGammaSupported>(output->gamma_supported());
+    return output->gamma_supported();
 }
 
 void mir_output_get_gamma(MirOutput const* client_output,