m + m fixes + doc

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

1 files changed, 50 insertions, 40 deletions

diff --git a/src/lib/gamma-quartz-cg.c b/src/lib/gamma-quartz-cg.c
index 3832ca5..b623303 100644
--- a/src/lib/gamma-quartz-cg.c
+++ b/src/lib/gamma-quartz-cg.c
@@ -41,20 +41,30 @@
  */
 void libgamma_quartz_cg_method_capabilities(libgamma_method_capabilities_t* restrict this)
 {
+  /* Gamma ramps size and depth can be queried. */
   this->crtc_information = LIBGAMMA_CRTC_INFO_GAMMA_SIZE
 			 | LIBGAMMA_CRTC_INFO_GAMMA_DEPTH;
+  /* Quartz/CoreGraphics does not support sites or partitions. */
   this->default_site_known = 1;
   this->multiple_sites = 0;
   this->multiple_partitions = 0;
+  /* Quartz/CoreGraphics does support CRTC:s. */
   this->multiple_crtcs = 1;
+  /* Partitions are not support... */
   this->partitions_are_graphics_cards = 0;
+  /* CoreGraphics have support for system restore. */
   this->site_restore = 1;
   this->partition_restore = 1;
+  /* But not for individual CRTC:s. */
   this->crtc_restore = 0;
+  /* Gamma ramp sizes are identifical but not fixed. */
   this->identical_gamma_sizes = 1;
   this->fixed_gamma_size = 0;
+  /* Gamma ramp depths are fixed. */
   this->fixed_gamma_depth = 1;
+  /* Quartz/CoreGraphics is a real adjustment method that can be faked. */
 #ifdef FAKE_LIBGAMMA_METHOD_QUARTZ_CORE_GRAPHICS
+  /* It is considered real but fake if it is translated to X RandR. */
   this->fake = 1;
 # ifdef HAVE_LIBGAMMA_METHOD_X_RANDR
   this->real = 1;
@@ -62,6 +72,7 @@ void libgamma_quartz_cg_method_capabilities(libgamma_method_capabilities_t* rest
   this->real = 0;
 # endif
 #else
+  /* It is real and not fake if we are running on Mac OS X. */
   this->fake = 0;
   this->real = 1;
 #endif
@@ -84,11 +95,8 @@ void libgamma_quartz_cg_method_capabilities(libgamma_method_capabilities_t* rest
 int libgamma_quartz_cg_site_initialise(libgamma_site_state_t* restrict this,
 				       char* restrict site)
 {
-  if (site != NULL)
-    return LIBGAMMA_NO_SUCH_SITE;
-  
   this->partitions_available = 1;
-  return 0;
+  return site != NULL ? LIBGAMMA_NO_SUCH_SITE : 0;
 }
 
 
@@ -135,7 +143,6 @@ int libgamma_quartz_cg_partition_initialise(libgamma_partition_state_t* restrict
   uint32_t cap = 4, n;
   CGDirectDisplayID* crtcs;
   CGDirectDisplayID* crtcs_old;
-  CGError r;
   
   (void) site;
   
@@ -144,34 +151,31 @@ int libgamma_quartz_cg_partition_initialise(libgamma_partition_state_t* restrict
   if (partition != 0)
     return LIBGAMMA_NO_SUCH_PARTITION;
   
-  crtcs = malloc((size_t)cap * sizeof(CGDirectDisplayID));
-  if (crtcs == NULL)
+  /* Allocate array of CRTC ID:s. */
+  if ((crtcs = malloc((size_t)cap * sizeof(CGDirectDisplayID))) == NULL)
     return LIBGAMMA_ERRNO_SET;
   
+  /* It is not possible to ask CoreGraphics how many CRTC:s
+     are available. We have to ask it to give us a ID:s of
+     a number of CRTC:s and ask for more if we got as many
+     as we asked for. */
   for (;;)
     {
-      r = CGGetOnlineDisplayList(cap, crtcs, &n);
-      if (r != kCGErrorSuccess)
-	{
-	  free(crtcs);
-	  return LIBGAMMA_LIST_CRTCS_FAILED;
-	}
+      /* Ask for CRTC ID:s */
+      if (CGGetOnlineDisplayList(cap, crtcs, &n) != kCGErrorSuccess)
+	return free(crtcs), LIBGAMMA_LIST_CRTCS_FAILED;
+      /* If we did not get as many as we asked for then we have all. */
       if (n < cap)
 	break;
-      if (cap == 0) /* We could also test ~0, but it is still too many. */
-	{
-	  free(crtcs);
-	  return LIBGAMMA_IMPOSSIBLE_AMOUNT;
-	}
-      crtcs_old = crtcs;
-      crtcs = realloc(crtcs, (size_t)cap * sizeof(CGDirectDisplayID));
-      if (crtcs)
-	{
-	  free(crtcs_old);
-	  return LIBGAMMA_ERRNO_SET;
-	}
+      /* Increase the number CRTC ID:s to ask for. */
+      if ((cap <<= 1) == 0) /* We could also test ~0, but it is still too many. */
+	return free(crtcs), LIBGAMMA_IMPOSSIBLE_AMOUNT;
+      /* Grow the array of CRTC ID:s so that it can fit all we are asking for. */
+      if ((crtcs = realloc(crtcs_old = crtcs, (size_t)cap * sizeof(CGDirectDisplayID))) == NULL)
+	return free(crtcs_old), LIBGAMMA_ERRNO_SET;
     }
   
+  /* Store CRTC ID:s and CRTC count. */
   this->data = crtcs;
   this->crtcs_available = (size_t)n;
   return 0;
@@ -216,9 +220,7 @@ int libgamma_quartz_cg_crtc_initialise(libgamma_crtc_state_t* restrict this,
 				       libgamma_partition_state_t* restrict partition, size_t crtc)
 {
   (void) this;
-  if (crtc >= partition->crtcs_available)
-    return LIBGAMMA_NO_SUCH_CRTC;
-  return 0;
+  return crtc >= partition->crtcs_available ? LIBGAMMA_NO_SUCH_CRTC : 0;
 }
 
 
@@ -260,39 +262,40 @@ int libgamma_quartz_cg_get_crtc_information(libgamma_crtc_information_t* restric
 					    libgamma_crtc_state_t* restrict crtc, int32_t fields)
 {
 #define SUPPORTED_FIELDS  (LIBGAMMA_CRTC_INFO_GAMMA_SIZE | LIBGAMMA_CRTC_INFO_GAMMA_DEPTH)
-   
 #define _E(FIELD)  ((fields & FIELD) ? LIBGAMMA_CRTC_INFO_NOT_SUPPORTED : 0)
   
+  /* Quartz/CoreGraphics does not support EDID or monitor dimensions. */
   this->edid_error = _E(LIBGAMMA_CRTC_INFO_EDID);
   this->width_mm_error = _E(LIBGAMMA_CRTC_INFO_WIDTH_MM);
   this->height_mm_error = _E(LIBGAMMA_CRTC_INFO_HEIGHT_MM);
   this->width_mm_edid_error = _E(LIBGAMMA_CRTC_INFO_WIDTH_MM_EDID);
   this->height_mm_edid_error = _E(LIBGAMMA_CRTC_INFO_HEIGHT_MM_EDID);
+  /* Quartz/CoreGraphics does support gamma ramp size query.
+     The gamma ramps are identical but not fixed, and the query can fail. */
+  this->gamma_size_error = 0;
   if ((fields & LIBGAMMA_CRTC_INFO_GAMMA_SIZE))
     {
-      CGDirectDisplayID* crtcs = crtc->partition->data;
-      CGDirectDisplayID crtc_id = crtcs[crtc->crtc];
-      size_t gamma_size = CGDisplayGammaTableCapacity(crtc_id);;
-      this->red_gamma_size = (size_t)gamma_size;
-      this->green_gamma_size = this->red_gamma_size;
-      this->blue_gamma_size = this->red_gamma_size;
+      CGDirectDisplayID* restrict crtcs = crtc->partition->data;
+      size_t gamma_size = CGDisplayGammaTableCapacity(crtcs[crtc->crtc]);
+      this->red_gamma_size = this->green_gamma_size = this->blue_gamma_size = (size_t)gamma_size;
       this->gamma_size_error = gamma_size < 2 ? LIBGAMMA_SINGLETON_GAMMA_RAMP : 0;
     }
-  else
-    this->gamma_size_error = 0;
+  /* Quartz/CoreGraphics uses `float` ramps. */
   this->gamma_depth = -1;
   this->gamma_depth_error = 0;
+  /* Quartz/CoreGraphics does not support gamma ramp support queries. */
   this->gamma_support_error = _E(LIBGAMMA_CRTC_INFO_GAMMA_SUPPORT);
+  /* Quartz/CoreGraphics does not support EDID or connector information. */
   this->subpixel_order_error = _E(LIBGAMMA_CRTC_INFO_SUBPIXEL_ORDER);
   this->active_error = _E(LIBGAMMA_CRTC_INFO_ACTIVE);
   this->connector_name_error = _E(LIBGAMMA_CRTC_INFO_CONNECTOR_NAME);
   this->connector_type_error = _E(LIBGAMMA_CRTC_INFO_CONNECTOR_TYPE);
   this->gamma_error = _E(LIBGAMMA_CRTC_INFO_GAMMA);
   
-#undef _E
-  
-  return this->gamma_size_error ? -1 : (fields & ~SUPPORTED_FIELDS) ? -1 : 0;
+  /* We failed if gamma ramp size query failed or if an unsupport field was queried. */
+  return this->gamma_size_error || (fields & ~SUPPORTED_FIELDS) ? -1 : 0;
   
+#undef _E
 #undef SUPPORTED_FIELDS
 }
 
@@ -313,14 +316,19 @@ int libgamma_quartz_cg_crtc_get_gamma_rampsf(libgamma_crtc_state_t* restrict thi
   uint32_t gamma_size_out;
   CGError r;
 #ifdef DEBUG
+  /* Gamma ramps sizes are identical but not fixed. */
   if ((ramps->red_size != ramps->green_size) ||
       (ramps->red_size != ramps->blue_size))
     return LIBGAMMA_MIXED_GAMMA_RAMP_SIZE;
 #endif
+  /* Read current gamma ramps. */
   r = CGGetDisplayTransferByTable(crtc_id, (uint32_t)(ramps->red_size),
 				  ramps->red, ramps->green, ramps->blue, &gamma_size_out);
   if (r != kCGErrorSuccess)
     return LIBGAMMA_GAMMA_RAMP_READ_FAILED;
+  /* I hope that it will not actually ever change,
+     but it does return the the gamma ramp size despite
+     that it can be queried without querying for more. */
   if (gamma_size_out != ramps->red_size)
     return LIBGAMMA_GAMMA_RAMP_SIZE_CHANGED;
   return 0;
@@ -342,10 +350,12 @@ int libgamma_quartz_cg_crtc_set_gamma_rampsf(libgamma_crtc_state_t* restrict thi
   CGDirectDisplayID crtc_id = crtcs[this->crtc];
   CGError r;
 #ifdef DEBUG
+  /* Gamma ramps sizes are identical but not fixed. */
   if ((ramps.red_size != ramps.green_size) ||
       (ramps.red_size != ramps.blue_size))
     return LIBGAMMA_MIXED_GAMMA_RAMP_SIZE;
 #endif
+  /* Apply gamma ramps. */
   r = CGSetDisplayTransferByTable(crtc_id, (uint32_t)(ramps.red_size),
 				  ramps.red, ramps.green, ramps.blue);
   return r == kCGErrorSuccess ? 0 : LIBGAMMA_GAMMA_RAMP_WRITE_FAILED;