Issue #1186 - Change names that appear in the custom action

installer/src/installer-lib/interaction.h

 /**
-* \file interaction.h User interaction classes. Message boxes and translations.
-*/
+ * \file interaction.h User interaction classes. Message boxes and translations.
+ */
 
 #ifndef INTERACTION_H
 #define INTERACTION_H
 
 #include <string>
 
 #include "session.h"
 
 #include <Windows.h>
 #include <Msi.h>
 #include <MsiQuery.h>
 
 /**
-* A modal dialog box as displayable from within a custom action.
-*
-* The only fully user interface element that the Windows Installer supports for use within custom actions is a small set of modal dialog boxes.
-* The Windows Installer provides the call MsiProcessMessage, overloaded by a set of message type constants.
-* This class represents those messages with user-provided messages; these ultimately call MessageBox.
-*
-* \sa 
-*    * MSDN [MsiProcessMessage function](http://msdn.microsoft.com/en-us/library/windows/desktop/aa370354%28v=vs.85%29.aspx)
-*    * MSDN [Sending Messages to Windows Installer Using MsiProcessMessage](http://msdn.microsoft.com/en-us/library/windows/desktop/aa371614%28v=vs.85%29.aspx)
-*/
+ * A modal dialog box as displayable from within a custom action.
+ *
+ * The only fully user interface element that the Windows Installer supports for use within custom actions is a small set of modal dialog boxes.
+ * The Windows Installer provides the call MsiProcessMessage, overloaded by a set of message type constants.
+ * This class represents those messages with user-provided messages; these ultimately call MessageBox.
+ *
+ * \sa 
+ *    * MSDN [MsiProcessMessage function](http://msdn.microsoft.com/en-us/library/windows/desktop/aa370354%28v=vs.85%29.aspx)
+ *    * MSDN [Sending Messages to Windows Installer Using MsiProcessMessage](http://msdn.microsoft.com/en-us/library/windows/desktop/aa371614%28v=vs.85%29.aspx)
+ */
 class InstallerMessageBox
   : public Message
 {
 public:
-  typedef enum 
+  enum class Box : long
   {
     defaultBox = 0,

[Felix Dahlke, 2014/10/15 02:46:57]

Enum values should be all uppercase and with underscores, and also include the
enum name, e.g.:

enum BoxType
{
  BOX_TYPE_DEFAULT_BOX,
  BOX_TYPE_ERROR_BOX,
  ...
}

(I'll also point out that there's no need to use a typedef in C++, we never do
it - but that's a separate issue.)

[Eric, 2014/10/15 15:30:44]

I will first point out that our coding style documents are silent about enum
values, both https://adblockplus.org/en/coding-style and
https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style .

All caps with underscores is the naming convention for preprocessor variables.
It would be better to keep such names referring only to these variables, simply
because there's less and less reason to use the preprocessor as the language
progresses.

There is, however, a hint in the Mozilla coding style about the right kind of
name. There's a name prefix 'k' listed for enumeration values for JavaScript,
but these names are otherwise CamelCase. I would rather use CamelCase for
enumerations than make them look like preprocessor variables.
I'm changing this to 'enum class', since I now know that we've got this C++11
feature in the compiler. Because 'enum class' is properly scoped, it means that
there's no longer a reason to use a prefix the enumerations, since instead the
scoping operator '::' is used.

In any case, take a look at how these enumeration constants appear in the calls.
It's better than before, and much more readable that a preprocessor-style name
would be.

-    errorBox = INSTALLMESSAGE::INSTALLMESSAGE_ERROR,
-    warningBox = INSTALLMESSAGE::INSTALLMESSAGE_WARNING,
-    userBox = INSTALLMESSAGE::INSTALLMESSAGE_USER
-  }
-  box_type ;
+    error = INSTALLMESSAGE::INSTALLMESSAGE_ERROR,
+    warning = INSTALLMESSAGE::INSTALLMESSAGE_WARNING,
+    user = INSTALLMESSAGE::INSTALLMESSAGE_USER
+  } ;
 
-  typedef enum
+  enum class ButtonSet : long
   {
-    defaultButtonset = 0,
+    defaultButtonSet = 0,
     ok = MB_OK, 
     okCancel = MB_OKCANCEL, 
     abortRetryIgnore = MB_ABORTRETRYIGNORE, 
     yesNoCancel = MB_YESNOCANCEL, 
     yesNo = MB_YESNO, 
     retryCancel = MB_RETRYCANCEL
-  }
-  buttonset_type ;
+  } ;
 
-  typedef enum
+  enum class DefaultButton : long
   {
-    defaultDefaultButton = 0, ///< use the default button
-    defaultButtonOne = MB_DEFBUTTON1,
-    defaultButtonTwo = MB_DEFBUTTON2,
-    defaultButtonThree = MB_DEFBUTTON3
-  }
-  default_button_type ;
+    defaultButton = 0, ///< use the default button
+    one = MB_DEFBUTTON1,
+    two = MB_DEFBUTTON2,
+    three = MB_DEFBUTTON3
+  } ;
 
-  typedef enum
+  enum class Icon : long
   {
-    defaultIcon = 0,                        ///< use the default icon associated with the box_type
-    warningIcon = MB_ICONWARNING,           ///< exclamation point
-    informationIcon = MB_ICONINFORMATION,  ///< lowercase letter "i" in a circle
-    errorIcon = MB_ICONERROR                ///< stop sign
-  }
-  icon_type ;
+    defaultIcon = 0,                        ///< use the default icon associated with the box_type
+    warningIcon = MB_ICONWARNING,           ///< exclamation point
+    informationIcon = MB_ICONINFORMATION,   ///< lowercase letter "i" in a circle
+    errorIcon = MB_ICONERROR                ///< stop sign
+  } ;
 
   /**
-  * Ordinary constructor, wide string
-  */
+   * Ordinary constructor, wide string
+   */
   InstallerMessageBox(
     std::wstring message, 
-    box_type box = box_type::userBox, 
-    buttonset_type buttonset = buttonset_type::defaultButtonset, 
-    default_button_type default_button = default_button_type::defaultDefaultButton,
-    icon_type icon = icon_type::defaultIcon
+    Box box = Box::user, 
+    ButtonSet buttonset = ButtonSet::defaultButtonSet, 
+    DefaultButton defaultButton = DefaultButton::defaultButton,
+    Icon icon = Icon::defaultIcon
     ) ;
 
   /**
-  * Ordinary constructor, regular string
-  */
+   * Ordinary constructor, regular string
+   */
   InstallerMessageBox(
     std::string message, 
-    box_type box = box_type::userBox, 
-    buttonset_type buttonset = buttonset_type::defaultButtonset, 
-    default_button_type default_button = default_button_type::defaultDefaultButton,
-    icon_type icon = icon_type::defaultIcon
+    Box box = Box::user, 
+    ButtonSet buttonset = ButtonSet::defaultButtonSet, 
+    DefaultButton defaultButton = DefaultButton::defaultButton,
+    Icon icon = Icon::defaultIcon
     ) ;
 } ;
 
 /**
-* Error for any non-handled return value from Session.write_message().
-*/
+ * Error for any non-handled return value from Session.write_message().
+ */
 struct UnexpectedReturnValueFromMessageBox
   : std::logic_error
 {
   UnexpectedReturnValueFromMessageBox()
     : std::logic_error( "Unexpected return value from message box." )
   {}
 } ;
 
 #endif