[menu] Add optional allocator for ui menu classes #5

MatthewMArnold · 2020-11-10T23:00:42Z

This allows us to in-place allocate menus (whereas previously we were forced to use new). The main change I had to make was add an IAbstractView that isn't templated that is a parent of the AbstractView class to avoid circular template parameter dependencies. I'm not sure if there is a better way to do this.

annawng · 2021-05-01T20:51:13Z

src/modm/ui/menu/abstract_menu.hpp

@@ -30,12 +30,17 @@ namespace modm{
 	 * \author Thorsten Lajewski
 	 * \ingroup modm_ui_menu
 	 */
-	class AbstractMenu: public AbstractView
+	template<typename Allocator = allocator::Dynamic<IAbstractView> >


I might be misunderstanding this but why do you need a template here? Is this sort of like using Allocator as an alias for allocator::Dynamic<IAbstractView>?

This is a templated class. So it allows us to specify the type of Allocator we want the class to use at compile time. The part Allocator = allocator::Dynamic<IAbstractView> is a default template parameter. If no template parameter is supplied the object will use allocator::Dynamic<IAbstractView> for the allocator.

src/modm/ui/menu/choice_menu.hpp

annawng · 2021-05-01T21:01:15Z

src/modm/ui/menu/choice_menu.hpp

@@ -112,4 +114,6 @@ namespace modm{
 	};
 }

+#include "choice_menu_impl.hpp"


Why is this being included at the end of the file?

Doing this is a way of creating a template class with separate files for declaration/definition. Since you can't put template stuff in a .cpp file you put it in a _impl.hpp file and then include it at the bottom of the normal .hpp file. Then you can add a preprocessor statement at the top of the _impl.hpp file that makes it so your code won't compile if you try and include the _impl.hpp file in your own code (since you should be including the .hpp file instead).

src/modm/ui/menu/choice_menu_impl.hpp

src/modm/ui/menu/iabstract_view.hpp

annawng · 2021-05-01T21:48:06Z

src/modm/ui/menu/standard_menu_impl.hpp

 {
-	modm::GraphicDisplay* display = &getViewStack()->getDisplay();
+	typename modm::GraphicDisplay* display = &this->getViewStack()->getDisplay();


I'm confused what typename is used here for.

The gist is that since getViewStack returns a template object, we need to add typename before the type so the compiler knows this is actually a modm::GraphicDisplay.

Read a complete answer here: https://stackoverflow.com/questions/610245/where-and-why-do-i-have-to-put-the-template-and-typename-keywords

…g AbstractViews

This is because the gui stuff requires colored menus but the menu code should not have to have colored menus. This wouldn't be an issue if we could dynamic cast but on certain devices you can't do this.

* [menu] Add optional allocator for ui menu classes, used for destroying AbstractViews * [menu] remove coupling between modm gui and modm menu view and menu This is because the gui stuff requires colored menus but the menu code should not have to have colored menus. This wouldn't be an issue if we could dynamic cast but on certain devices you can't do this.

…cs#5) * [menu] Add optional allocator for ui menu classes, used for destroying AbstractViews * [menu] remove coupling between modm gui and modm menu view and menu This is because the gui stuff requires colored menus but the menu code should not have to have colored menus. This wouldn't be an issue if we could dynamic cast but on certain devices you can't do this.

MatthewMArnold requested a review from WasabiFan November 13, 2020 07:12

annawng reviewed May 1, 2021

View reviewed changes

MatthewMArnold force-pushed the viewstack-custom-allocator branch 2 times, most recently from 074aacc to 0056490 Compare May 2, 2021 17:28

[menu] Add optional allocator for ui menu classes, used for destroyin…

05badc4

…g AbstractViews

MatthewMArnold force-pushed the viewstack-custom-allocator branch from 0056490 to 05badc4 Compare May 3, 2021 17:55

[menu] remove coupling between modm gui and modm menu view and menu

89640a1

This is because the gui stuff requires colored menus but the menu code should not have to have colored menus. This wouldn't be an issue if we could dynamic cast but on certain devices you can't do this.

MatthewMArnold force-pushed the viewstack-custom-allocator branch from 76e5a09 to 89640a1 Compare May 4, 2021 22:15

MatthewMArnold merged commit 875b674 into develop Jun 2, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[menu] Add optional allocator for ui menu classes #5

[menu] Add optional allocator for ui menu classes #5

MatthewMArnold commented Nov 10, 2020

annawng May 1, 2021

MatthewMArnold May 2, 2021

annawng May 1, 2021

MatthewMArnold May 2, 2021

annawng May 1, 2021

MatthewMArnold May 2, 2021

[menu] Add optional allocator for ui menu classes #5

[menu] Add optional allocator for ui menu classes #5

Conversation

MatthewMArnold commented Nov 10, 2020

annawng May 1, 2021

Choose a reason for hiding this comment

MatthewMArnold May 2, 2021

Choose a reason for hiding this comment

annawng May 1, 2021

Choose a reason for hiding this comment

MatthewMArnold May 2, 2021

Choose a reason for hiding this comment

annawng May 1, 2021

Choose a reason for hiding this comment

MatthewMArnold May 2, 2021

Choose a reason for hiding this comment