annotate foosdk/sdk/foobar2000/foo_sample/mainmenu-dynamic.cpp @ 1:20d02a178406 default tip

*: check in everything else yay
author Paper <paper@tflc.us>
date Mon, 05 Jan 2026 02:15:46 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
1 #include "stdafx.h"
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
2 #include <vector>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
3
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
4 namespace { // anon namespace everything, it's not accessible by means other than the service factory
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
5
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
6 // The command ID.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
7 // Generate a new GUID when reusing code.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
8 static const GUID guid_menucommand = { 0xab754b0b, 0x204, 0x4471, { 0xb5, 0x29, 0xff, 0x73, 0xae, 0x51, 0x5d, 0xe9 } };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
9
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
10 // Shared with mainmenu.cpp
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
11 static const GUID guid_mainmenu_group_id = { 0x44963e7a, 0x4b2a, 0x4588, { 0xb0, 0x17, 0xa8, 0x69, 0x18, 0xcb, 0x8a, 0xa5 } };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
12
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
13 class sample_command : public mainmenu_node_command {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
14 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
15 sample_command( size_t index ) : m_index(index) {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
16 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
17 void get_display(pfc::string_base & text, t_uint32 & flags) override {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
18 flags = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
19 text = PFC_string_formatter() << "Test dynamic item #" << m_index;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
20 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
21 void execute(service_ptr_t<service_base> callback) override {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
22 popup_message::g_show(PFC_string_formatter() << "Invoked test menu item #" << m_index, "Information");
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
23 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
24 GUID get_guid() override {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
25 // This method returns our subcommand ID.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
26 // Dynamic commands are identified by a pair of GUIDs:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
27 // - command ID ( see: mainmenu_commands interface )
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
28 // - subcommand ID ( identifier of one of the dynamic items )
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
29 // Subcommand identifiers don't have to be actually globally unique,
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
30 // as long as they're unique among the subcommand identifiers for this command ID.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
31
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
32 // In our case, we'll just create a makeshift GUID from a hash of the index.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
33 // This is perfectly okay for production code - as long as your command ID is a proper GUID!
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
34
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
35 // Don't ever hash size_t which varies with CPU architecture
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
36 // Integer endianness intentionally disregarded
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
37 uint32_t hashme = (uint32_t) m_index;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
38
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
39 auto api = hasher_md5::get();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
40 hasher_md5_state state;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
41 api->initialize( state );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
42 api->process( state, &hashme, sizeof(hashme) );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
43
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
44 // fb2k hasher_md5 API even provides a convenient method to return MD5 hashes cast to GUIDs for this.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
45 return api->get_result_guid( state );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
46 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
47 bool get_description(pfc::string_base & out) override {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
48 out = PFC_string_formatter() << "This is a test menu item #" << m_index << ".";
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
49 return true;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
50 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
51 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
52 const size_t m_index;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
53 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
54 class sample_group : public mainmenu_node_group {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
55 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
56 sample_group() {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
57 m_children.resize(11);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
58 for( size_t walk = 0; walk < m_children.size(); ++ walk ) {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
59 mainmenu_node::ptr node;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
60 // Insert separators for odd items, commands for even
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
61 if ( walk % 2 ) {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
62 node = fb2k::service_new<mainmenu_node_separator>();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
63 } else {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
64 auto cmdIndex = walk/2 + 1;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
65 node = fb2k::service_new<sample_command>( cmdIndex );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
66 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
67 m_children[walk] = std::move(node);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
68 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
69 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
70 void get_display(pfc::string_base & text, t_uint32 & flags) override {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
71 flags = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
72 text = "Dynamic menu test group";
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
73 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
74 t_size get_children_count() override {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
75 return m_children.size();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
76 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
77 mainmenu_node::ptr get_child(t_size index) override {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
78 PFC_ASSERT( index < m_children.size() );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
79 return m_children[index];
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
80 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
81 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
82 std::vector<mainmenu_node::ptr> m_children;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
83
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
84 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
85
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
86 class mainmenu_sample_dynamic : public mainmenu_commands_v2 {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
87 typedef mainmenu_commands_v2 super_t;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
88 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
89 // mainmenu_commands_v2 methods
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
90 t_uint32 get_command_count() override { return 1; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
91 GUID get_command(t_uint32 p_index) override {return guid_menucommand;}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
92 void get_name(t_uint32 p_index,pfc::string_base & p_out) override {p_out = "Dynamic menu test";}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
93
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
94 bool get_description(t_uint32 p_index,pfc::string_base & p_out) override {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
95 // Should not get here much
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
96 p_out = "This is a dynamic menu command test.";
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
97 return true;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
98 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
99 GUID get_parent() override {return guid_mainmenu_group_id; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
100 void execute(t_uint32 p_index,service_ptr_t<service_base> p_callback) override {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
101 // Should not get here, someone not aware of our dynamic status tried to invoke us?
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
102 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
103
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
104 bool is_command_dynamic(t_uint32 index) override { return true; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
105 mainmenu_node::ptr dynamic_instantiate(t_uint32 index) override {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
106 return fb2k::service_new<sample_group>();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
107 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
108
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
109 bool dynamic_execute(t_uint32 index, const GUID & subID, service_ptr_t<service_base> callback) override {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
110 // If your component provides a more efficient way to execute the command,
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
111 // than doing full dynamic_instantiate() and walking all the dynamic items to find one with the matching identifier,
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
112 // please implement it here.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
113
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
114 // ... or just skip implementing this method entirely.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
115 return super_t::dynamic_execute( index, subID, callback );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
116 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
117 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
118
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
119 static service_factory_single_t<mainmenu_sample_dynamic> g_mainmenu_sample_dynamic;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
120
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
121 } // namespace