Refactoring FApplication::linuxModifierKeyCorrection and FVTerm::updateVTerm

ChangeLog

@@ -1,3 +1,8 @@
+2017-12-02  Markus Gans  <guru.mail@muenster.de>
+	* Refactoring FApplication::linuxModifierKeyCorrection and
+	  FVTerm::updateVTerm
+	* Fix getLinuxModifierKey() subcode value as non-const
+
 2017-11-30  Markus Gans  <guru.mail@muenster.de>
 	* Refactoring FVTerm::updateTerminalLine
 

include/final/fapplication.h

@@ -160,7 +160,14 @@ class FApplication : public FWidget
     ssize_t            readKey();
     void               processKeyboardEvent();
 #if defined(__linux__)
-    int                linuxModifierKeyCorrection (const int&);
+    static int         linuxShiftKeyCorrection (const int&);
+    static int         linuxCtrlKeyCorrection (const int&);
+    static int         linuxAltKeyCorrection (const int&);
+    static int         linuxShiftCtrlKeyCorrection (const int&);
+    static int         linuxShiftAltKeyCorrection (const int&);
+    static int         linuxCtrlAltKeyCorrection (const int&);
+    static int         linuxShiftCtrlAltKeyCorrection (const int&);
+    static int         linuxModifierKeyCorrection (const int&);
 #endif
     bool               processDialogSwitchAccelerator();
     bool               processAccelerator (const FWidget*&);

include/final/fterm.h

@@ -123,6 +123,7 @@ class FTerm
     // Typedefs
     typedef FOptiAttr::char_data  char_data;
 
+#if defined(__linux__)
     static struct modifier_key  // bit field
     {
       uChar shift  : 1;  // 0..1
@@ -131,6 +132,7 @@ class FTerm
       uChar alt    : 1;  // 0..1
       uChar        : 4;  // padding bits
     } mod_key;
+#endif
 
     // Constructor
     explicit FTerm (bool = false);

include/final/fvterm.h

@@ -296,6 +296,16 @@ class FVTerm : public FTerm
     static covered_state isCovered ( int, int
                                    , term_area* );
 
+    static void          updateOverlappedColor ( term_area*
+                                               , int, int, int, int );
+    static void          updateOverlappedCharacter (term_area*, int, int);
+    static void          updateShadedCharacter ( term_area*
+                                               , int, int, int, int );
+    static void          updateInheritBackground ( term_area*
+                                                 , int, int, int, int );
+    static void          updateCharacter ( term_area*
+                                         , int, int, int, int );
+    static void          callPreprocessingHandler (term_area*);
     static void          updateVTerm();
     static void          updateVTerm (term_area*);
     static bool          updateVTermCursor (term_area*);

src/fapplication.cpp

@@ -782,16 +782,7 @@ void FApplication::processKeyboardEvent()
 
 #if defined(__linux__)
 //----------------------------------------------------------------------
-int FApplication::linuxModifierKeyCorrection (const int& key_id)
+int FApplication::linuxShiftKeyCorrection (const int& key_id)
-{
-  // get the current modifier key state
-  FTerm::modifier_key& m = getLinuxModifierKey();
-
-  if ( ! (m.shift || m.ctrl || m.alt) )
-  {
-    return key_id;
-  }
-  else if ( m.shift && ! m.ctrl && ! m.alt )
 {
   switch ( key_id )
   {
@@ -829,7 +820,9 @@ int FApplication::linuxModifierKeyCorrection (const int& key_id)
       return key_id;
   }
 }
-  else if ( ! m.shift && m.ctrl && ! m.alt )
+
+//----------------------------------------------------------------------
+int FApplication::linuxCtrlKeyCorrection (const int& key_id)
 {
   switch ( key_id )
   {
@@ -867,7 +860,9 @@ int FApplication::linuxModifierKeyCorrection (const int& key_id)
       return key_id;
   }
 }
-  else if ( ! m.shift && ! m.ctrl && m.alt )
+
+//----------------------------------------------------------------------
+int FApplication::linuxAltKeyCorrection (const int& key_id)
 {
   switch ( key_id )
   {
@@ -905,7 +900,9 @@ int FApplication::linuxModifierKeyCorrection (const int& key_id)
       return key_id;
   }
 }
-  else if ( m.shift && m.ctrl && ! m.alt )
+
+//----------------------------------------------------------------------
+int FApplication::linuxShiftCtrlKeyCorrection (const int& key_id)
 {
   switch ( key_id )
   {
@@ -943,7 +940,9 @@ int FApplication::linuxModifierKeyCorrection (const int& key_id)
       return key_id;
   }
 }
-  else if ( m.shift && ! m.ctrl && m.alt )
+
+//----------------------------------------------------------------------
+int FApplication::linuxShiftAltKeyCorrection (const int& key_id)
 {
   switch ( key_id )
   {
@@ -981,7 +980,9 @@ int FApplication::linuxModifierKeyCorrection (const int& key_id)
       return key_id;
   }
 }
-  else if ( ! m.shift &&  m.ctrl && m.alt )
+
+//----------------------------------------------------------------------
+int FApplication::linuxCtrlAltKeyCorrection (const int& key_id)
 {
   switch ( key_id )
   {
@@ -1019,7 +1020,9 @@ int FApplication::linuxModifierKeyCorrection (const int& key_id)
       return key_id;
   }
 }
-  else if ( m.shift &&  m.ctrl && m.alt )
+
+//----------------------------------------------------------------------
+int FApplication::linuxShiftCtrlAltKeyCorrection (const int& key_id)
 {
   switch ( key_id )
   {
@@ -1058,6 +1061,46 @@ int FApplication::linuxModifierKeyCorrection (const int& key_id)
   }
 }
 
+//----------------------------------------------------------------------
+int FApplication::linuxModifierKeyCorrection (const int& key_id)
+{
+  // Get the current modifier key state
+
+  FTerm::modifier_key& m = getLinuxModifierKey();
+
+  if ( ! (m.shift || m.ctrl || m.alt) )
+  {
+    return key_id;
+  }
+  else if ( m.shift && ! m.ctrl && ! m.alt )
+  {
+    return linuxShiftKeyCorrection(key_id);
+  }
+  else if ( ! m.shift && m.ctrl && ! m.alt )
+  {
+    return linuxCtrlKeyCorrection(key_id);
+  }
+  else if ( ! m.shift && ! m.ctrl && m.alt )
+  {
+    return linuxAltKeyCorrection(key_id);
+  }
+  else if ( m.shift && m.ctrl && ! m.alt )
+  {
+    return linuxShiftCtrlKeyCorrection(key_id);
+  }
+  else if ( m.shift && ! m.ctrl && m.alt )
+  {
+    return linuxShiftAltKeyCorrection(key_id);
+  }
+  else if ( ! m.shift && m.ctrl && m.alt )
+  {
+    return linuxCtrlAltKeyCorrection(key_id);
+  }
+  else if ( m.shift &&  m.ctrl && m.alt )
+  {
+    return linuxShiftCtrlAltKeyCorrection(key_id);
+  }
+
   return key_id;
 }
 #endif

src/fterm.cpp

@@ -225,7 +225,9 @@ const FString FTerm::getKeyName (int keynum)
 //----------------------------------------------------------------------
 FTerm::modifier_key& FTerm::getLinuxModifierKey()
 {
-  static const char subcode = 6;
+  // Get Linux console shift state
+
+  char subcode = 6;  // Shift state command + return value
 
   // fill bit field with 0
   std::memset (&mod_key, 0x00, sizeof(mod_key));

src/fvterm.cpp

@@ -1061,6 +1061,8 @@ void FVTerm::restoreVTerm (int x, int y, int w, int h)
 FVTerm::covered_state FVTerm::isCovered ( const FPoint& pos
                                         , term_area* area )
 {
+  // Determines the covered state for the given position
+
   return isCovered (pos.getX(), pos.getY(), area);
 }
 
@@ -1068,6 +1070,8 @@ FVTerm::covered_state FVTerm::isCovered ( const FPoint& pos
 FVTerm::covered_state FVTerm::isCovered ( int x, int y
                                         , term_area* area )
 {
+  // Determines the covered state for the given position
+
   bool found;
   covered_state is_covered;
   FWidget* w;
@@ -1128,6 +1132,151 @@ FVTerm::covered_state FVTerm::isCovered ( int x, int y
   return is_covered;
 }
 
+//----------------------------------------------------------------------
+void FVTerm::updateOverlappedColor ( term_area* area
+                                   , int x, int y, int tx, int ty )
+{
+  // Add the overlapping color to this character
+
+  int& aw  = area->width;
+  int& rsh = area->right_shadow;
+  int line_len = aw + rsh;
+  // Area character
+  char_data* ac = &area->text[y * line_len + x];
+  // Terminal character
+  char_data* tc = &vterm->text[ty * vterm->width + tx];
+  // New character
+  char_data nc;
+  std::memcpy (&nc, ac, sizeof(char_data));
+  // Overlapped character
+  char_data oc = getOverlappedCharacter (tx + 1, ty + 1, area->widget);
+  nc.fg_color = oc.fg_color;
+  nc.bg_color = oc.bg_color;
+  nc.attr.bit.reverse  = false;
+  nc.attr.bit.standout = false;
+
+  if ( nc.code == fc::LowerHalfBlock
+    || nc.code == fc::UpperHalfBlock
+    || nc.code == fc::LeftHalfBlock
+    || nc.code == fc::RightHalfBlock
+    || nc.code == fc::MediumShade
+    || nc.code == fc::FullBlock )
+    nc.code = ' ';
+
+  nc.attr.bit.no_changes = bool(tc->attr.bit.printed && *tc == nc);
+  std::memcpy (tc, &nc, sizeof(char_data));
+}
+
+//----------------------------------------------------------------------
+void FVTerm::updateOverlappedCharacter (term_area* area, int tx, int ty)
+{
+  // Restore one character on vterm
+
+  // Terminal character
+  char_data* tc = &vterm->text[ty * vterm->width + tx];
+  // Overlapped character
+  char_data oc = getCoveredCharacter (tx + 1, ty + 1, area->widget);
+  oc.attr.bit.no_changes = bool(tc->attr.bit.printed && *tc == oc);
+  std::memcpy (tc, &oc, sizeof(char_data));
+}
+
+//----------------------------------------------------------------------
+void FVTerm::updateShadedCharacter ( term_area* area
+                                   , int x, int y, int tx, int ty )
+{
+  // Get covered character + add the current color
+
+  int& aw  = area->width;
+  int& rsh = area->right_shadow;
+  int line_len = aw + rsh;
+  // Area character
+  char_data* ac = &area->text[y * line_len + x];
+  // Terminal character
+  char_data* tc = &vterm->text[ty * vterm->width + tx];
+  // Overlapped character
+  char_data oc = getCoveredCharacter (tx + 1, ty + 1, area->widget);
+  oc.fg_color = ac->fg_color;
+  oc.bg_color = ac->bg_color;
+  oc.attr.bit.reverse  = false;
+  oc.attr.bit.standout = false;
+
+  if ( oc.code == fc::LowerHalfBlock
+    || oc.code == fc::UpperHalfBlock
+    || oc.code == fc::LeftHalfBlock
+    || oc.code == fc::RightHalfBlock
+    || oc.code == fc::MediumShade
+    || oc.code == fc::FullBlock )
+    oc.code = ' ';
+
+  oc.attr.bit.no_changes = bool(tc->attr.bit.printed && *tc == oc);
+  std::memcpy (tc, &oc, sizeof(char_data));
+}
+
+//----------------------------------------------------------------------
+void FVTerm::updateInheritBackground ( term_area* area
+                                     , int x, int y, int tx, int ty )
+{
+  // Add the covered background to this character
+
+  int& aw  = area->width;
+  int& rsh = area->right_shadow;
+  int line_len = aw + rsh;
+  // Area character
+  char_data* ac = &area->text[y * line_len + x];
+  // Terminal character
+  char_data* tc = &vterm->text[ty * vterm->width + tx];
+  // New character
+  char_data nc;
+  std::memcpy (&nc, ac, sizeof(char_data));
+  // Covered character
+  char_data cc = getCoveredCharacter (tx + 1, ty + 1, area->widget);
+  nc.bg_color = cc.bg_color;
+  nc.attr.bit.no_changes = bool(tc->attr.bit.printed && *tc == nc);
+  std::memcpy (tc, &nc, sizeof(char_data));
+}
+
+//----------------------------------------------------------------------
+void FVTerm::updateCharacter ( term_area* area
+                             , int x, int y, int tx, int ty )
+{
+  // Copy a area character to the virtual terminal
+
+  int& aw  = area->width;
+  int& rsh = area->right_shadow;
+  int line_len = aw + rsh;
+  // Area character
+  char_data* ac = &area->text[y * line_len + x];
+  // Terminal character
+  char_data* tc = &vterm->text[ty * vterm->width + tx];
+  std::memcpy (tc, ac, sizeof(char_data));
+
+  if ( tc->attr.bit.printed && *tc == *ac )
+    tc->attr.bit.no_changes = true;
+  else
+    tc->attr.bit.no_changes = false;
+}
+
+//----------------------------------------------------------------------
+void FVTerm::callPreprocessingHandler (term_area* area)
+{
+  // Call preprocessing handler
+
+  if ( ! area->preprocessing_call.empty() )
+  {
+    FPreprocessing::const_iterator iter, end;
+    iter = area->preprocessing_call.begin();
+    end = area->preprocessing_call.end();
+
+    while ( iter != end )
+    {
+      FPreprocessingHandler handler = iter->handler;
+      // call the preprocessing handler
+      (iter->instance->*handler)();
+      ++iter;
+    }
+  }
+}
+
 //----------------------------------------------------------------------
 void FVTerm::updateVTerm()
 {
@@ -1190,7 +1339,6 @@ void FVTerm::updateVTerm (term_area* area)
 {
   // Update area data on VTerm
 
-  char_data* tc;  // terminal character
   char_data* ac;  // area character
 
   if ( ! area )
@@ -1199,21 +1347,8 @@ void FVTerm::updateVTerm (term_area* area)
   if ( ! area->visible )
     return;
 
-  // Call preprocessing handler
+  // Call the processing handler methods
-  if ( ! area->preprocessing_call.empty() )
+  callPreprocessingHandler(area);
-  {
-    FPreprocessing::const_iterator iter, end;
-    iter = area->preprocessing_call.begin();
-    end = area->preprocessing_call.end();
-
-    while ( iter != end )
-    {
-      FPreprocessingHandler handler = iter->handler;
-      // call the preprocessing handler
-      (iter->instance->*handler)();
-      ++iter;
-    }
-  }
 
   int ax  = area->offset_left
     , ay  = area->offset_top
@@ -1266,87 +1401,33 @@ void FVTerm::updateVTerm (term_area* area)
 
         int line_len = aw + rsh;
         ac = &area->text[y * line_len + x];
-        tc = &vterm->text[gy * vterm->width + gx - ol];
+        gx -= ol;
 
-        is_covered = isCovered(gx - ol, gy, area);  // get covered state
+        is_covered = isCovered(gx, gy, area);  // get covered state
 
         if ( is_covered != fully_covered )
         {
           if ( is_covered == half_covered )
           {
-            // add the overlapping color to this character
+            updateOverlappedColor(area, x, y, gx, gy);
-            char_data ch, oc;
-            std::memcpy (&ch, ac, sizeof(char_data));
-            oc = getOverlappedCharacter (gx + 1 - ol, gy + 1, area->widget);
-            ch.fg_color = oc.fg_color;
-            ch.bg_color = oc.bg_color;
-            ch.attr.bit.reverse  = false;
-            ch.attr.bit.standout = false;
-
-            if ( ch.code == fc::LowerHalfBlock
-              || ch.code == fc::UpperHalfBlock
-              || ch.code == fc::LeftHalfBlock
-              || ch.code == fc::RightHalfBlock
-              || ch.code == fc::MediumShade
-              || ch.code == fc::FullBlock )
-              ch.code = ' ';
-
-            ch.attr.bit.no_changes = bool(tc->attr.bit.printed && *tc == ch);
-            std::memcpy (tc, &ch, sizeof(char_data));
           }
           else if ( ac->attr.bit.transparent )   // transparent
           {
-            // restore one character on vterm
+            updateOverlappedCharacter(area, gx, gy);
-            char_data ch;
-            ch = getCoveredCharacter (gx + 1 - ol, gy + 1, area->widget);
-            ch.attr.bit.no_changes = bool(tc->attr.bit.printed && *tc == ch);
-            std::memcpy (tc, &ch, sizeof(char_data));
           }
           else  // not transparent
           {
             if ( ac->attr.bit.trans_shadow )  // transparent shadow
             {
-              // get covered character + add the current color
+              updateShadedCharacter (area, x, y, gx, gy);
-              char_data ch;
-              ch = getCoveredCharacter (gx + 1 - ol, gy + 1, area->widget);
-              ch.fg_color = ac->fg_color;
-              ch.bg_color = ac->bg_color;
-              ch.attr.bit.reverse  = false;
-              ch.attr.bit.standout = false;
-
-              if ( ch.code == fc::LowerHalfBlock
-                || ch.code == fc::UpperHalfBlock
-                || ch.code == fc::LeftHalfBlock
-                || ch.code == fc::RightHalfBlock
-                || ch.code == fc::MediumShade
-                || ch.code == fc::FullBlock )
-                ch.code = ' ';
-
-              ch.attr.bit.no_changes = bool(tc->attr.bit.printed && *tc == ch);
-              std::memcpy (tc, &ch, sizeof(char_data));
             }
             else if ( ac->attr.bit.inherit_bg )
             {
-              // add the covered background to this character
+              updateInheritBackground (area, x, y, gx, gy);
-              char_data ch, cc;
-              std::memcpy (&ch, ac, sizeof(char_data));
-              cc = getCoveredCharacter (gx + 1 - ol, gy + 1, area->widget);
-              ch.bg_color = cc.bg_color;
-              ch.attr.bit.no_changes = bool(tc->attr.bit.printed && *tc == ch);
-              std::memcpy (tc, &ch, sizeof(char_data));
             }
             else  // default
             {
-              if ( tc->attr.bit.printed && *tc == *ac )
+              updateCharacter (area, x, y, gx, gy);
-              {
-                std::memcpy (tc, ac, sizeof(char_data));
-                tc->attr.bit.no_changes = true;
-              }
-              else
-              {
-                std::memcpy (tc, ac, sizeof(char_data));
-                tc->attr.bit.no_changes = false;
-              }
             }
           }