Menu Manager #36

Mistrick · 2018-07-28T14:54:41Z

Description

Implementation of menu manager

Motivation and Context

Fixes #28

How has this been tested?

#include <spmod>

public PluginInfo pluginInfo =
{
	name = "test",
    version = "0.0.0",
	author = "author",
	url = "https://github.com/Amaroq7/SPMod"
};

Menu m, m2, m3, m4, m5;
bool hide = false;

public void OnPluginInit()
{
	Command("^say /m", MenuTest);
	Command("^say /m2", MenuTest2);
	Command("^say /m3", MenuTest5);
	Command("^say /m4", MenuTest6);
	Command("^say /m5", MenuTest7);
	Command("^say /cm", MenuTest3);
	Command("^say /h", MenuTest4);

	m = Menu(TestHandler, MenuItemStyle, true);
	m.SetTitle("Title");
	m.AddItem("one");
	m.AddItem("two");
	m.AddItem("three");
	m.AddItem("four", 0, ItemHandler);
	m.AddItem("5");
	m.AddItem("6");
	m.AddItem("7");
	m.AddItem("8");
	m.AddItem("9", 0, ItemHandler);
	m.AddItem("10");
	m.AddItem("11");
	
	m2 = Menu(TestHandler, MenuItemStyle, true);
	
	m2.SetTitle("Test 2");
	m2.AddItem("one", 1);
	m2.AddItem("two", 2);
	m2.AddItem("three", 3);
	m2.AddItem("four", 4);
	m2.AddItem("5", 5, ItemHandler3);
	m2.AddItem("6", 6, ItemHandler3);
	m2.AddItem("7", 7, ItemHandler3);
	m2.AddItem("8", 9, ItemHandler3);
	m2.AddItem("9", 10);
	m2.AddItem("10", 10);
	m2.AddItem("11", 10);
	m2.AddItem("12", 10);

	m2.SetProp(MProp_NumberFormat, "\\r[#num]");
	m2.ItemsPerPage = 4;

	m3 = Menu(TestHandler, MenuItemStyle, true);
	
	m3.SetTitle("Test 3");
	m3.AddItem("one");
	m3.AddItem("two");
	m3.AddItem("three");
	m3.AddItem("four");
	m3.AddItem("5", 0, ItemHandler3);
	m3.AddItem("6", 3, ItemHandler3);
	m3.AddItem("7");

	m3.AddStaticItem(0, "static1", 23, ItemHandler2);
	m3.AddStaticItem(5, "static2", 23, ItemHandler2);

	m3.ItemsPerPage = 5;

	m4 = Menu(TestHandler2, MenuTextStyle);

	char text[] = "Title\n\n1. One\n2. Two\n\n3. Exit";
	m4.SetText(text);
	m4.SetKeys((1<<0)|(1<<1)|(1<<2));


	m5 = Menu(TestHandler, MenuItemStyle, true);

	m5.SetTitle("Test 5");
	m5.AddItem("one");
	m5.AddItem("two");
	m5.AddItem("three");
	m5.AddItem("four", 0, ItemHandler);
	m5.AddItem("5");
	m5.AddItem("6");
	m5.InsertItem(0, "7");
	m5.InsertItem(0, "8");
	m5.InsertItem(0, "9", 0, ItemHandler);
	m5.InsertItem(0, "10");
	m5.InsertItem(0, "11");

	m5.RemoveItem(1);
} 

public ItemStatus ItemHandler(Menu menu, MenuItem item, int player)
{
	PrintToServer("Item callback: menu %d, item %d, player %d", menu, item, player);
	item.SetName("changed");
	return ItemDisabled;
}

public ItemStatus ItemHandler2(Menu menu, MenuItem item, int player)
{
	char name[64];
	item.GetName(name, sizeof name);
	PrintToServer("Item callback2: menu %d, item %s[%d], player %d", menu, name, item, player);
	
	return ItemEnabled;
}
public ItemStatus ItemHandler3(Menu menu, MenuItem item, int player)
{
	PrintToServer("Item callback3: menu %d, item %d, player %d", menu, item, player);
	return hide ? ItemHide : ItemEnabled;
}

public PluginReturn MenuTest(int client, Command cid)
{
	m.Display(client, 0, 10);
}
public PluginReturn MenuTest2(int client, Command cid)
{
	m2.Display(client);
}
public PluginReturn MenuTest5(int client, Command cid)
{
	m3.Display(client);
}
public PluginReturn MenuTest6(int client, Command cid)
{
	m4.Display(client);
}
public PluginReturn MenuTest7(int client, Command cid)
{
	m5.Display(client);
}

public PluginReturn MenuTest3(int client, Command cid)
{
	CloseMenu(client);
}

public PluginReturn MenuTest4(int client, Command cid)
{
	hide = !hide;
}

public int TestHandler(Menu menu, MenuItem item, int player)
{
	PrintToServer("menu %d, item %d, item data %d, player %d", menu, item, item.GetData(), player);
	return 0;
}
public int TestHandler2(Menu menu, int key, int player)
{
	PrintToServer("menu %d, key %d, player %d", menu, key, player);
	return 0;
}

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.

Amaroq7

Player class is on its way (#38) I want to merge it later today if there are no objections. Then you can adjust it to suit your needs, I mean removing m_playerMenu and m_playerPage.

Amaroq7 · 2018-07-30T18:39:19Z

include/public/IMenuSystem.hpp

+        MENU_BACK = -1
+    };
+
+    enum ItemStatus


enum class ItemStatus then its options can be named just Enabled, Disabled, Hide.

Amaroq7 · 2018-07-30T18:40:02Z

include/public/IMenuSystem.hpp

+        ItemHide
+    };
+
+    enum MenuStyle


enum class MenuStyle then options Item and Text.

Amaroq7 · 2018-07-30T18:48:07Z

src/MenuSystem.cpp

+        std::size_t slot = 0;
+
+
+        auto addItem = [&](ItemStatus r, std::size_t s, std::string n)


std::string_view

Amaroq7 · 2018-07-31T19:03:07Z

src/MenuSystem.hpp

+    {
+        std::shared_ptr<Menu> menu = std::make_shared<Menu>(m_mid++, std::forward<Args>(args)...);
+        m_menus.push_back(menu);
+        return menu;


This can be changed to emplace_back

Amaroq7 · 2018-08-01T09:36:40Z

src/MenuSystem.cpp

+    while (*n);
+}
+
+std::string replace(const std::string& str, const std::string& from, const std::string& to)


std::string_view for params

Amaroq7 · 2018-08-01T11:03:05Z

src/MenuSystem.cpp

+        return "";
+
+    if(item >= m_items.size())
+        return m_staticSlots[item - m_items.size()].get()->name;


Amaroq7 · 2018-08-01T11:03:14Z

src/MenuSystem.cpp

+        return false;
+
+    if(item >= m_items.size())
+        m_staticSlots[item - m_items.size()].get()->name = name.data();


No need to use .get()

src/MenuSystem.hpp

+public:
+    struct MenuItem
+    {
+        MenuItem(std::string n,


Amaroq7 · 2018-08-01T11:32:39Z

src/MenuSystem.hpp

+    int m_time;
+    std::size_t m_itemsPerPage;
+    int m_keys;
+    int m_slots[10];


Amaroq7 · 2018-08-01T11:33:00Z

src/MenuSystem.hpp

+    std::size_t m_itemsPerPage;
+    int m_keys;
+    int m_slots[10];
+    std::unique_ptr<MenuItem> m_staticSlots[10];


Amaroq7 · 2018-08-02T11:28:11Z

src/MenuSystem.cpp

+        plr = plrMngr->getPlayerCore(i);
+
+        if(!plr->isInGame()
+            || !plrMngr->getPlayerCore(i)->getMenu()


You could use plr as well

Amaroq7 · 2018-08-02T11:28:45Z

src/MenuSystem.cpp

+
+        if(!plr->isInGame()
+            || !plrMngr->getPlayerCore(i)->getMenu()
+            || plrMngr->getPlayerCore(i)->getMenu()->getId() == index)


I think you meant !=

Amaroq7 · 2018-08-02T11:56:00Z

src/MenuSystem.cpp

+int gmsgShowMenu = 0;
+int gmsgVGUIMenu = 0;
+
+Menu::MenuItem::MenuItem(std::string n,


std::string_view

Amaroq7 · 2018-08-02T12:02:20Z

scripts/include/menus.inc

+    );
+};
+
+typedef CallbackHandler = function ItemStatus (Menu menu, MenuItem item, int player);


I think you can use Player

Amaroq7 · 2018-08-02T12:06:09Z

include/public/IMenuSystem.hpp

+    public:
+        using MenuHandler = void (*)(IMenu *const menu, std::size_t item, int player);
+        virtual IMenu *registerMenu(MenuHandler handler, MenuStyle style, bool global) = 0;
+        virtual IMenu *registerMenu(SourcePawn::IPluginFunction *func, MenuStyle style, bool global) = 0;


Is there any use case registering menu in module and have callback in plugin?

include/public/IMenuSystem.hpp

+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+


include/public/IMenuSystem.hpp

+    {
+    public:
+        using MenuItemCallback = ItemStatus (*)(IMenu *const menu, std::size_t item, int player);
+        using MenuHandler = void (*)(IMenu *const menu, std::size_t item, int player);


Amaroq7 · 2018-08-02T16:14:15Z

scripts/include/menus.inc

+    /*
+     * @brief Sets a item data.
+     *
+     * @param data          Item datar.


Amaroq7 · 2018-08-02T16:45:39Z

include/public/IMenuSystem.hpp

+
+        virtual int getTime() const = 0;
+        virtual int getKeys() const = 0;
+        virtual int keyToSlot(int key) const = 0;


Is it need to be exported?

Amaroq7 · 2018-08-02T16:46:30Z

include/public/IMenuSystem.hpp

+
+        virtual void setHandler(MenuHandler func) = 0;
+
+        virtual void execHandler(int player,


I don't think these execHandler and setHandler need to be in api

Amaroq7 · 2018-08-03T21:10:19Z

src/MenuSystem.hpp

+
+    void setNumberFormat(std::string_view format);
+
+    void setHandler(std::variant<SourcePawn::IPluginFunction *, MenuHandler> &&func);


I think this can be removed

Amaroq7 · 2018-08-03T21:17:26Z

src/PlayerSystem.hpp

@@ -61,6 +66,9 @@ class Player : public IPlayer
    std::string m_name;
    std::string m_ip;
    std::string m_steamID;
+
+    std::shared_ptr<Menu> m_menu;


std::weak_ptr

Amaroq7 · 2018-08-03T21:45:05Z

src/MenuSystem.hpp

+                        std::variant<SourcePawn::IPluginFunction *, MenuItemCallback> &&callback,
+                        std::variant<cell_t, void *> &&data);
+
+    bool setStaticItem(std::size_t positon,


Shouldn't this be exported to modules api?

Amaroq7 · 2018-08-03T21:50:51Z

src/MenuSystem.hpp

+                       std::variant<SourcePawn::IPluginFunction *, MenuItemCallback> &&callback,
+                       std::variant<cell_t, void *> &&data);
+
+    bool setItemName(std::size_t item,


Ditto. This could be useful to change name of item menu in item callback

Amaroq7

Sorry for the lack of input recently, been busy lately.

src/MenuSystem.hpp

+    std::shared_ptr<Menu> findMenuCore(std::size_t index) const;
+
+    void destroyMenu(std::size_t index);
+    void clearMenus();


Amaroq7 · 2018-08-05T14:55:07Z

include/public/IMenuSystem.hpp

+    public:
+        using MenuHandler = void (*)(IMenu *const menu, std::size_t item, int player);
+        virtual IMenu *registerMenu(MenuHandler handler, MenuStyle style, bool global) = 0;
+        virtual IMenu *findMenu(std::size_t mid) const = 0;


I don't think modules need this exported. Also destroyMenu(IMenu *menu) is missing here.

src/MenuSystem.cpp

+                             std::variant<SourcePawn::IPluginFunction *, MenuItemCallback> &&callback,
+                             std::variant<cell_t, void *> &&data)
+{
+    if(position >= m_itemsPerPage)


Amaroq7 · 2018-08-09T12:33:36Z

include/public/IMenuSystem.hpp

+    {
+    public:
+        using MenuItemCallback = ItemStatus (*)(IMenu *const menu, std::size_t item, int player);
+        using MenuHandler = void (*)(IMenu *const menu, std::size_t item, int player);


IMenuItem class could be created and all related item's funcs move there from IMenu
int Player could be IPlayer player

Amaroq7

I think it's the last review and it should be good to go.

src/MenuSystem.hpp

+                    MenuItemCallback callback,
+                    void *data) override;
+
+    bool setStaticItem(std::size_t position,


Fix typo in exit item

Mistrick added 3 commits July 28, 2018 20:17

Add menu manager

31acd42

Use utils for string copy

16b3538

Add menu natives

fd141ef

Mistrick force-pushed the menus branch from 025fe5f to fd141ef Compare July 28, 2018 15:01

Mistrick added 2 commits July 28, 2018 22:01

Missed code for messages

3cce22d

Fix linux compile

c3c4ec7

Mistrick force-pushed the menus branch from a83f267 to c3c4ec7 Compare July 28, 2018 15:23

Amaroq7 added the enhancement label Jul 29, 2018

Amaroq7 added this to the v0.2.0-alpha milestone Jul 29, 2018

Missed code

608bdd4

Amaroq7 added the under-review label Aug 1, 2018

Amaroq7 requested changes Aug 1, 2018

View reviewed changes

Amaroq7 added requires-changes and removed under-review labels Aug 1, 2018

Mistrick added 2 commits August 2, 2018 09:11

Merge remote-tracking branch 'upstream/master' into menus

5c5e93b

Move player menu info to player class

221f069

Amaroq7 requested changes Aug 2, 2018

View reviewed changes

Amaroq7 requested changes Aug 4, 2018

View reviewed changes

Mistrick force-pushed the menus branch from 690be24 to 607e238 Compare August 4, 2018 23:28

Fixes for review

a768b62

Mistrick force-pushed the menus branch from 607e238 to a768b62 Compare August 4, 2018 23:29

Amaroq7 requested changes Aug 9, 2018

View reviewed changes

Mistrick added 3 commits August 10, 2018 21:12

Refactor code for using Player class and MenuItem class

15661e0

Fix crash after open same menu

c6cb0bd

Remove cast

1f01c9c

Amaroq7 requested changes Aug 11, 2018

View reviewed changes

src/MenuSystem.hpp

MenuItemCallback callback,

void *data) override;

bool setStaticItem(std::size_t position,

This comment was marked as resolved.

Sign in to view

Mistrick added 2 commits August 12, 2018 11:27

Add missed method in IMenu

9557c49

Fix typo in exit item

Missed code

5eb5520

Amaroq7 removed the requires-changes label Aug 14, 2018

Amaroq7 approved these changes Aug 14, 2018

View reviewed changes

Amaroq7 merged commit 4be32ea into Amaroq7:master Aug 14, 2018

Mistrick deleted the menus branch August 14, 2018 14:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Menu Manager #36

Menu Manager #36

Mistrick commented Jul 28, 2018

Amaroq7 left a comment

Amaroq7 Jul 30, 2018

Amaroq7 Jul 30, 2018

Amaroq7 Jul 30, 2018

Amaroq7 Jul 31, 2018

Amaroq7 Aug 1, 2018

Amaroq7 Aug 1, 2018

Amaroq7 Aug 1, 2018

This comment was marked as resolved.

Amaroq7 Aug 1, 2018

Amaroq7 Aug 1, 2018

Amaroq7 Aug 2, 2018

Amaroq7 Aug 2, 2018

Amaroq7 Aug 2, 2018

Amaroq7 Aug 2, 2018

Amaroq7 Aug 2, 2018

This comment was marked as resolved.

This comment was marked as resolved.

Amaroq7 Aug 2, 2018

Amaroq7 Aug 2, 2018

Amaroq7 Aug 2, 2018

Amaroq7 Aug 3, 2018

Amaroq7 Aug 3, 2018

Amaroq7 Aug 3, 2018

Amaroq7 Aug 3, 2018

Amaroq7 left a comment

This comment was marked as resolved.

This comment was marked as resolved.

Amaroq7 Aug 5, 2018

This comment was marked as resolved.

Amaroq7 Aug 9, 2018

Amaroq7 left a comment

This comment was marked as resolved.

		std::size_t slot = 0;


		auto addItem = [&](ItemStatus r, std::size_t s, std::string n)


		virtual void setHandler(MenuHandler func) = 0;

		virtual void execHandler(int player,


		void setNumberFormat(std::string_view format);

		void setHandler(std::variant<SourcePawn::IPluginFunction *, MenuHandler> &&func);

Menu Manager #36

Menu Manager #36

Conversation

Mistrick commented Jul 28, 2018

Description

Motivation and Context

How has this been tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Amaroq7 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Amaroq7 left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

Amaroq7 left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.