Commit: f984959413ee7f0a2b1004730382f3731a1f47ee - xinput_calibrator (git)

A generic touchscreen calibration program for X.Org

Commit MetaInfo

• Revision: f984959413ee7f0a2b1004730382f3731a1f47ee (tree)
• Time: 2010-01-24 07:16:49
• Author: Tias Guns <tias@ulys...>
• Commiter: Tias Guns

Log Message

make finish() and finish_data() return a boolean
also add comments to calibrator.hh

Change Summary

• modified: calibrator.cpp
• modified: calibrator.hh
• modified: calibrators/calibratorEvdev.cpp
• modified: calibrators/calibratorUsbtouchscreen.cpp
• modified: calibrators/calibratorXorgPrint.cpp
• modified: gui_gtkmm.cpp
• modified: gui_x11.cpp

Incremental Difference

--- a/calibrator.cpp
+++ b/calibrator.cpp
@@ -48,8 +48,12 @@ bool Calibrator::add_click(double x, double y)
     return true;
 }
 
-void Calibrator::finish(int width, int height)
+bool Calibrator::finish(int width, int height)
 {
+    if (get_numclicks() != 4) {
+        return false;
+    }
+
     // Should x and y be swapped?
     const bool swap_xy = (abs (clicked_x [UL] - clicked_x [UR]) < abs (clicked_y [UL] - clicked_y [UR]));
     if (swap_xy) {
@@ -83,6 +87,6 @@ void Calibrator::finish(int width, int height)
         std::swap(axys.y_min, axys.x_max);
     }
 
-    // finish the data, driver specific
-    finish_data(axys, swap_xy);
+    // finish the data, driver/calibrator specific
+    return finish_data(axys, swap_xy);
 }

--- a/calibrator.hh
+++ b/calibrator.hh
@@ -28,19 +28,32 @@
 class Calibrator
 {
 public:
+    /* Constructor for a specific calibrator
+     *
+     * The constructor will throw an exception,
+     * if the touchscreen is not of the type it supports
+     */
     Calibrator(const char* const drivername, const XYinfo& axys);
     ~Calibrator() {}
 
+    // get the number of clicks already registered
     int get_numclicks();
+    // add a click with the given coordinates
     bool add_click(double x, double y);
-    void finish(int width, int height);
+    // calculate and apply the calibration
+    bool finish(int width, int height);
 
 protected:
-    virtual void finish_data(const XYinfo new_axys, int swap_xy) =0;
+    // overloaded function that applies the new calibration
+    virtual bool finish_data(const XYinfo new_axys, int swap_xy) =0;
 
+    // name of the device (driver)
     const char* const drivername;
+    // original axys values
     XYinfo old_axys;
+    // nr of clicks registered
     int num_clicks;
+    // click coordinates
     double clicked_x[4], clicked_y[4];
 };
 

--- a/calibrators/calibratorEvdev.cpp
+++ b/calibrators/calibratorEvdev.cpp
@@ -47,7 +47,7 @@ public:
     CalibratorEvdev(const char* const drivername, const XYinfo& axys);
     ~CalibratorEvdev();
 
-    virtual void finish_data(const XYinfo new_axys, int swap_xy);
+    virtual bool finish_data(const XYinfo new_axys, int swap_xy);
 
     static Bool check_driver(const char* const name);
 
@@ -121,13 +121,15 @@ CalibratorEvdev::~CalibratorEvdev () {
     XCloseDisplay(display);
 }
 
-void CalibratorEvdev::finish_data(const XYinfo new_axys, int swap_xy)
+bool CalibratorEvdev::finish_data(const XYinfo new_axys, int swap_xy)
 {
     printf("\nTo make the settings permanent, create add a startup script for your window manager with the following command(s):\n");
     if (swap_xy)
         printf(" xinput set-int-prop \"%s\" \"Evdev Axes Swap\" 8 %d\n", drivername, swap_xy);
     printf(" xinput set-int-prop \"%s\" \"Evdev Axis Calibration\" 32 %d %d %d %d\n", drivername, new_axys.x_min, new_axys.x_max, new_axys.y_min, new_axys.y_max);
 
+    bool success = true;
+
     printf("\nDoing dynamic recalibration:\n");
     // Evdev Axes Swap
     if (swap_xy) {
@@ -142,7 +144,8 @@ void CalibratorEvdev::finish_data(const XYinfo new_axys, int swap_xy)
         sprintf(str_swap_xy, "%d", swap_xy);
         arr_cmd[2] = str_swap_xy;
 
-        do_set_prop(display, XA_INTEGER, 8, 3, arr_cmd);
+        int ret = xinput_do_set_prop(display, XA_INTEGER, 8, 3, arr_cmd);
+        success &= (ret == EXIT_SUCCESS);
     }
 
     // Evdev Axis Calibration
@@ -166,10 +169,13 @@ void CalibratorEvdev::finish_data(const XYinfo new_axys, int swap_xy)
     sprintf(str_max_y, "%d", new_axys.y_max);
     arr_cmd[5] = str_max_y;
 
-    do_set_prop(display, XA_INTEGER, 32, 6, arr_cmd);
+    int ret = xinput_do_set_prop(display, XA_INTEGER, 32, 6, arr_cmd);
+    success &= (ret == EXIT_SUCCESS);
 
     // close
     XSync(display, False);
+
+    return success;
 }
 
 Bool CalibratorEvdev::check_driver(const char *name) {

--- a/calibrators/calibratorUsbtouchscreen.cpp
+++ b/calibrators/calibratorUsbtouchscreen.cpp
@@ -54,7 +54,7 @@ public:
     CalibratorUsbtouchscreen(const char* const drivername, const XYinfo& axys);
     ~CalibratorUsbtouchscreen();
 
-    virtual void finish_data(const XYinfo new_axys, int swap_xy);
+    virtual bool finish_data(const XYinfo new_axys, int swap_xy);
 
 protected:
     // Globals for kernel parameters from startup.
@@ -156,7 +156,7 @@ CalibratorUsbtouchscreen::~CalibratorUsbtouchscreen()
     write_bool_parameter (p_swap_xy, val_swap_xy);
 }
 
-void CalibratorUsbtouchscreen::finish_data(const XYinfo new_axys, int swap_xy)
+bool CalibratorUsbtouchscreen::finish_data(const XYinfo new_axys, int swap_xy)
 {
     // New ranges
     const int range_x = (new_axys.x_max - new_axys.x_min);
@@ -183,7 +183,7 @@ void CalibratorUsbtouchscreen::finish_data(const XYinfo new_axys, int swap_xy)
     if (fid == NULL) {
         fprintf(stderr, "Error: Can't open '%s' for reading. Make sure you have the necesary rights\n", modprobe_conf_local);
         fprintf(stderr, "New calibration data NOT saved\n");
-        return;
+        return false;
     }
 
     std::string new_contents;
@@ -213,8 +213,10 @@ void CalibratorUsbtouchscreen::finish_data(const XYinfo new_axys, int swap_xy)
     if (fid == NULL) {
         fprintf(stderr, "Error: Can't open '%s' for writing. Make sure you have the necesary rights\n", modprobe_conf_local);
         fprintf(stderr, "New calibration data NOT saved\n");
-        return;
+        return false;
     }
     fprintf(fid, "%s", new_contents.c_str ());
     fclose(fid);
+
+    return true;
 }

--- a/calibrators/calibratorXorgPrint.cpp
+++ b/calibrators/calibratorXorgPrint.cpp
@@ -29,7 +29,7 @@ class CalibratorXorgPrint: public Calibrator
 public:
     CalibratorXorgPrint(const char* const drivername, const XYinfo& axys);
 
-    virtual void finish_data(const XYinfo new_axys, int swap_xy);
+    virtual bool finish_data(const XYinfo new_axys, int swap_xy);
 };
 
 CalibratorXorgPrint::CalibratorXorgPrint(const char* const drivername0, const XYinfo& axys0)
@@ -41,7 +41,7 @@ CalibratorXorgPrint::CalibratorXorgPrint(const char* const drivername0, const XY
     printf("\tIf the current calibration data is estimated wrong then either supply it manually with --precalib <minx> <maxx> <miny> <maxy> or run the 'get_precalib.sh' script to automatically get it from your current Xorg configuration (through hal).\n");
 }
 
-void CalibratorXorgPrint::finish_data(const XYinfo new_axys, int swap_xy)
+bool CalibratorXorgPrint::finish_data(const XYinfo new_axys, int swap_xy)
 {
     // FDI policy output
     printf("\nNew method for making the calibration permanent: create an FDI policy file like /etc/hal/fdi/policy/touchscreen.fdi with:\n\
@@ -67,4 +67,6 @@ void CalibratorXorgPrint::finish_data(const XYinfo new_axys, int swap_xy)
                 new_axys.y_max, old_axys.y_max);
     if (swap_xy != 0)
         printf("\tOption\t\"SwapXY\"\t\"%d\"\n", swap_xy);
+
+    return true;
 }

--- a/gui_gtkmm.cpp
+++ b/gui_gtkmm.cpp
@@ -213,9 +213,15 @@ bool CalibrationArea::on_button_press_event(GdkEventButton *event)
     // Are we done yet?
     if (calibrator->get_numclicks() >= 4) {
         // Recalibrate
-        calibrator->finish(display_width, display_height);
-
-        exit(0);
+        bool success = calibrator->finish(display_width, display_height);
+
+        if (success) {
+            exit(0);
+        } else {
+            // TODO, in GUI ?
+            fprintf(stderr, "Error: unable to apply or save configuration values");
+            exit(1);
+        }
     }
 
     // Force a redraw

--- a/gui_x11.cpp
+++ b/gui_x11.cpp
@@ -265,9 +265,15 @@ bool GuiCalibratorX11::on_button_press_event(XEvent event)
     // Are we done yet?
     if (calibrator->get_numclicks() >= 4) {
         // Recalibrate
-        calibrator->finish(display_width, display_height);
-
-        exit(0);
+        bool success = calibrator->finish(display_width, display_height);
+
+        if (success) {
+            exit(0);
+        } else {
+            // TODO, in GUI ?
+            fprintf(stderr, "Error: unable to apply or save configuration values");
+            exit(1);
+        }
     }
 
     // Force a redraw