Conform to coding standards (#63)

* Use underscore_case for variable and function names
* Use _prefix for class attributes
* Braces on same line as block/statement/expression
* Doxygen comments
* Indent 4 spaces

Author: jonblack

MenuSystem.cpp

@@ -29,8 +29,7 @@ class MenuSystem;
 //!
 //! \see Menu
 //! \see MenuItem
-class MenuComponent
-{
+class MenuComponent {
     friend class MenuSystem;
     friend class Menu;
 public:
@@ -186,8 +185,7 @@ class MenuComponent
 //!
 //! \see MenuComponent
 //! \see Menu
-class MenuItem : public MenuComponent
-{
+class MenuItem : public MenuComponent {
 public:
     //! \brief Construct a MenuItem
     //! \param[in] name The name of the menu component that is displayed in
@@ -222,8 +220,7 @@ class MenuItem : public MenuComponent
 
 //! \brief A MenuItem that calls MenuSystem::back() when selected.
 //! \see MenuItem
-class BackMenuItem : public MenuItem
-{
+class BackMenuItem : public MenuItem {
 public:
     BackMenuItem(const char* name, SelectFnPtr select_fn, MenuSystem* ms);
 
@@ -233,12 +230,11 @@ class BackMenuItem : public MenuItem
     virtual Menu* select();
 
 protected:
-    MenuSystem* menu_system;
+    MenuSystem* _menu_system;
 };
 
 
-class NumericMenuItem : public MenuItem
-{
+class NumericMenuItem : public MenuItem {
 public:
     //! \brief Callback for formatting the numeric value into a String.
     //!
@@ -247,39 +243,39 @@ class NumericMenuItem : public MenuItem
     using FormatValueFnPtr = const String (*)(const float value);
 
 public:
-    /// Constructor
-    ///
-    /// @param name The name of the menu item.
-    /// @param select_fn The function to call when this MenuItem is selected.
-    /// @param value Default value.
-    /// @param minValue The minimum value.
-    /// @param maxValue The maximum value.
-    /// @param increment How much the value should be incremented by.
-    /// @param valueFormatter The custom formatter. If nullptr the String float
-    ///                       formatter will be used.
+    //! Constructor
+    //!
+    //! @param name The name of the menu item.
+    //! @param select_fn The function to call when this MenuItem is selected.
+    //! @param value Default value.
+    //! @param min_value The minimum value.
+    //! @param max_value The maximum value.
+    //! @param increment How much the value should be incremented by.
+    //! @param format_value_fn The custom formatter. If nullptr the String
+    //!                        float formatter will be used.
     NumericMenuItem(const char* name, SelectFnPtr select_fn,
-                    float value, float minValue, float maxValue,
+                    float value, float min_value, float max_value,
                     float increment=1.0,
                     FormatValueFnPtr format_value_fn=nullptr);
 
-    /**
-     * Sets the custom number formatter.
-     *
-     * @param numberFormat the custom formatter. If nullptr the String float
-     *                     formatter will be used (2 decimals)
-     */
+    //!
+    //! \brief Sets the custom number formatter.
+    //!
+    //! \param numberFormat the custom formatter. If nullptr the String float
+    //!                     formatter will be used (2 decimals)
+    //!
     void set_number_formatter(FormatValueFnPtr format_value_fn);
 
     float get_value() const;
-    float get_minValue() const;
-    float get_maxValue() const;
+    float get_min_value() const;
+    float get_max_value() const;
 
-    // TODO: get_value_string is a poor name. get_formatted_value maybe?
-    String get_value_string() const;
     void set_value(float value);
     void set_min_value(float value);
     void set_max_value(float value);
 
+    String get_formatted_value() const;
+
     virtual void render(MenuComponentRenderer const& renderer) const;
 
 protected:
@@ -290,20 +286,30 @@ class NumericMenuItem : public MenuItem
 
 protected:
     float _value;
-    float _minValue;
-    float _maxValue;
+    float _min_value;
+    float _max_value;
     float _increment;
     FormatValueFnPtr _format_value_fn;
 };
 
 
-class Menu : public MenuComponent
-{
+//! \brief A MenuComponent that can contain other MenuComponents.
+//!
+//! Menu represents the branch in the composite design pattern (see:
+//! https://en.wikipedia.org/wiki/Composite_pattern). When a Menu is
+//! selected, the user-defined Menu::_select_fn callback is called.
+//!
+//! \see MenuComponent
+//! \see MenuItem
+class Menu : public MenuComponent {
     friend class MenuSystem;
 public:
     Menu(const char* name, SelectFnPtr select_fn=nullptr);
 
+    //! \brief Adds a MenuItem to the Menu
     void add_item(MenuItem* p_item);
+
+    //! \brief Adds a Menu to the Menu
     void add_menu(Menu* p_menu);
 
     MenuComponent const* get_current_component() const;
@@ -313,16 +319,29 @@ class Menu : public MenuComponent
     uint8_t get_current_component_num() const;
     uint8_t get_previous_component_num() const;
 
+    //! \copydoc MenuComponent::render
     void render(MenuComponentRenderer const& renderer) const;
 
 protected:
-    void set_parent(Menu* pParent);
+    void set_parent(Menu* p_parent);
     Menu const* get_parent() const;
 
+    //! \brief Activates the current selection
+    //!
+    //! When a client makes a selection, activate is called on the current menu
+    //! which in turn calls the menu's current item's callback.
     Menu* activate();
+
+    //! \copydoc MenuComponent::next
     virtual bool next(bool loop=false);
+
+    //! \copydoc MenuComponent::prev
     virtual bool prev(bool loop=false);
+
+    //! \copydoc MenuComponent::select
     virtual Menu* select();
+
+    //! \copydoc MenuComponent::reset
     virtual void reset();
 
     void add_component(MenuComponent* p_component);
@@ -337,8 +356,7 @@ class Menu : public MenuComponent
 };
 
 
-class MenuSystem
-{
+class MenuSystem {
 public:
     MenuSystem(MenuComponentRenderer const& renderer);
 
@@ -359,8 +377,7 @@ class MenuSystem
 };
 
 
-class MenuComponentRenderer
-{
+class MenuComponentRenderer {
 public:
     virtual void render(Menu const& menu) const = 0;
 

MenuSystem.h

@@ -11,31 +11,25 @@
 
 // renderer
 
-class MyRenderer : public MenuComponentRenderer
-{
+class MyRenderer : public MenuComponentRenderer {
 public:
-    virtual void render(Menu const& menu) const
-    {
+    void render(Menu const& menu) const {
         menu.get_current_component()->render(*this);
     }
 
-    virtual void render_menu_item(MenuItem const& menu_item) const
-    {
+    void render_menu_item(MenuItem const& menu_item) const {
         Serial.println(menu_item.get_name());
     }
 
-    virtual void render_back_menu_item(BackMenuItem const& menu_item) const
-    {
+    void render_back_menu_item(BackMenuItem const& menu_item) const {
         Serial.println(menu_item.get_name());
     }
 
-    virtual void render_numeric_menu_item(NumericMenuItem const& menu_item) const
-    {
+    void render_numeric_menu_item(NumericMenuItem const& menu_item) const {
         Serial.println(menu_item.get_name());
     }
 
-    virtual void render_menu(Menu const& menu) const
-    {
+    void render_menu(Menu const& menu) const {
         Serial.println(menu.get_name());
     }
 };
@@ -62,52 +56,45 @@ MenuItem mu1_mi2("Level 2 - Item 2 (Item)", &on_item4_selected);
 
 bool bRanCallback = false;
 
-void on_item1_selected(MenuComponent* p_menu_component)
-{
-  Serial.println("Item1 Selected");
-  bRanCallback = true;
+void on_item1_selected(MenuComponent* p_menu_component) {
+    Serial.println("Item1 Selected");
+    bRanCallback = true;
 }
 
-void on_item2_selected(MenuComponent* p_menu_component)
-{
-  Serial.println("Item2 Selected");
-  bRanCallback = true;
+void on_item2_selected(MenuComponent* p_menu_component) {
+    Serial.println("Item2 Selected");
+    bRanCallback = true;
 }
 
-void on_item3_selected(MenuComponent* p_menu_component)
-{
-  Serial.println("Item3 Selected");
-  bRanCallback = true;
+void on_item3_selected(MenuComponent* p_menu_component) {
+    Serial.println("Item3 Selected");
+    bRanCallback = true;
 }
 
-void on_item4_selected(MenuComponent* p_menu_component)
-{
-  Serial.println("Item4 Selected");
-  bRanCallback = false;
-  ms.reset();
+void on_item4_selected(MenuComponent* p_menu_component) {
+    Serial.println("Item4 Selected");
+    bRanCallback = false;
+    ms.reset();
 }
 
 // Standard arduino functions
 
-void setup()
-{
-  Serial.begin(9600);
+void setup() {
+    Serial.begin(9600);
 
-  ms.get_root_menu().add_item(&mm_mi1);
-  ms.get_root_menu().add_item(&mm_mi2);
-  ms.get_root_menu().add_menu(&mu1);
-  mu1.add_item(&mu1_mi1);
-  mu1.add_item(&mu1_mi2);
+    ms.get_root_menu().add_item(&mm_mi1);
+    ms.get_root_menu().add_item(&mm_mi2);
+    ms.get_root_menu().add_menu(&mu1);
+    mu1.add_item(&mu1_mi1);
+    mu1.add_item(&mu1_mi2);
 }
 
-void loop()
-{
-  ms.display();
-  ms.select();
-  if (bRanCallback)
-  {
-      ms.next();
-      bRanCallback = false;
-  }
-  delay(2000);
+void loop() {
+    ms.display();
+    ms.select();
+    if (bRanCallback) {
+        ms.next();
+        bRanCallback = false;
+    }
+    delay(2000);
 }