summaryrefslogtreecommitdiffstatshomepage
path: root/src/lib/netlist/nl_factory.h
blob: 4c9a47cc74983777199d658d7b99459f4130fa11 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
// license:GPL-2.0+
// copyright-holders:Couriersud

///
/// \file nl_factory.h
///

#ifndef NLFACTORY_H_
#define NLFACTORY_H_

#include "nltypes.h"
#include "plib/palloc.h"
#include "plib/ptypes.h"
#include "plib/putil.h"

#include <tuple>
#include <utility>
#include <vector>

#define NETLIB_DEVICE_IMPL_ALIAS(p_alias, chip, p_name, p_def_param) \
	NETLIB_DEVICE_IMPL_BASE(devices, p_alias, chip, p_name, p_def_param) \

#define NETLIB_DEVICE_IMPL(chip, p_name, p_def_param) \
	NETLIB_DEVICE_IMPL_NS(devices, chip, p_name, p_def_param)

#define NETLIB_DEVICE_IMPL_NS(ns, chip, p_name, p_def_param) \
	NETLIB_DEVICE_IMPL_BASE(ns, chip, chip, p_name, p_def_param) \

#define NETLIB_DEVICE_IMPL_BASE(ns, p_alias, chip, p_name, p_def_param) \
	static factory::element_t::uptr NETLIB_NAME(p_alias ## _c) () \
	{ \
		using devtype = factory::device_element_t<ns :: NETLIB_NAME(chip)>; \
		factory::properties sl(p_def_param, PSOURCELOC()); \
		return devtype::create(p_name, std::move(sl)); \
	} \
	\
	extern factory::constructor_ptr_t decl_ ## p_alias; \
	factory::constructor_ptr_t decl_ ## p_alias = NETLIB_NAME(p_alias ## _c);

namespace netlist {
	class core_device_t;
	class netlist_state_t;

namespace factory {

	enum class element_type
	{
		BUILTIN,
		MACRO
	};

	struct properties
	{
		properties(const pstring &defparam, plib::source_location &&sourceloc)
		: m_defparam(defparam)
		, m_sourceloc(std::move(sourceloc))
		, m_type(element_type::BUILTIN)
		{ }

		~properties() = default;
		PCOPYASSIGNMOVE(properties, default)

		pstring defparam() const noexcept
		{
			return m_defparam;
		}

		plib::source_location source() const noexcept
		{
			return m_sourceloc;
		}

		element_type type() const noexcept { return m_type; }

		properties &set_type(element_type t) noexcept
		{
			m_type = t;
			return *this;
		}
	private:
		pstring m_defparam;
		plib::source_location m_sourceloc;
		element_type m_type;
	};

	// -----------------------------------------------------------------------------
	// net_dev class factory
	// -----------------------------------------------------------------------------

	class element_t
	{
	public:

		using dev_uptr = device_arena::unique_ptr<core_device_t>;
		using uptr = host_arena::unique_ptr<element_t>;
		using pointer = element_t *;

		element_t(const pstring &name, properties &&props);
		virtual ~element_t() = default;

		PCOPYASSIGNMOVE(element_t, default)

		virtual dev_uptr make_device(device_arena &pool,
			netlist_state_t &anetlist,
			const pstring &name) = 0;

		pstring name() const noexcept { return m_name; }
		pstring param_desc() const noexcept { return m_properties.defparam(); }
		plib::source_location source() const noexcept { return m_properties.source(); }
		element_type type() const noexcept { return m_properties.type(); }
	private:
		pstring m_name;                             ///< device name
		properties m_properties;                    ///< source file and other information and settings
	};

	template <class C, typename... Args>
	class device_element_t : public element_t
	{
	public:

		device_element_t(const pstring &name, properties &&props, Args&&... args)
		: element_t(name, std::move(props))
		, m_args(std::forward<Args>(args)...)
		{ }


	    template <std::size_t... Is>
	    dev_uptr make_device(device_arena &pool,
	    	    			netlist_state_t &anetlist,
	    	    			const pstring &name, std::tuple<Args...>& args, std::index_sequence<Is...>)
	    {
	    	return pool.make_unique<C>(anetlist, name, std::forward<Args>(std::get<Is>(args))...);
	    }

	    dev_uptr make_device(device_arena &pool,
	    			netlist_state_t &anetlist,
	    			const pstring &name, std::tuple<Args...>& args)
	    {
	        return make_device(pool, anetlist, name, args, std::index_sequence_for<Args...>{});
	    }

		dev_uptr make_device(device_arena &pool,
			netlist_state_t &anetlist,
			const pstring &name) override
		{
			return make_device(pool, anetlist, name, m_args);
			//return pool.make_unique<C>(anetlist, name);
		}

		static uptr create(const pstring &name, properties &&props, Args&&... args)
		{
			return host_arena::make_unique<device_element_t<C, Args...>>(name,
				std::move(props), std::forward<Args>(args)...);
		}
	private:
		std::tuple<Args...> m_args;
	};

	class list_t : public std::vector<element_t::uptr>
	{
	public:
		explicit list_t(log_type &alog);
		~list_t() = default;

		PCOPYASSIGNMOVE(list_t, delete)

		template<class device_class, typename... Args>
		void add(const pstring &name, properties &&props, Args&&... args)
		{
			add(device_element_t<device_class, Args...>::create(name, std::move(props),
				std::forward<Args>(args)...));
		}

		void add(element_t::uptr &&factory) noexcept(false);

		element_t::pointer factory_by_name(const pstring &devname) noexcept(false);

		template <class C>
		bool is_class(element_t::pointer f) noexcept
		{
			return dynamic_cast<device_element_t<C> *>(f) != nullptr;
		}

	private:
		log_type &m_log;
	};

	// -----------------------------------------------------------------------------
	// factory_creator_ptr_t
	// -----------------------------------------------------------------------------

	using constructor_ptr_t = element_t::uptr (*const)();

	template <typename T>
	element_t::uptr constructor_t(const pstring &name, properties &&props)
	{
		return host_arena::make_unique<device_element_t<T>>(name, std::move(props));
	}

	// -----------------------------------------------------------------------------
	// library_element_t: factory class to wrap macro based chips/elements
	// -----------------------------------------------------------------------------

	class library_element_t : public element_t
	{
	public:

		library_element_t(const pstring &name, properties &&props);

		dev_uptr make_device(device_arena &pool,
			netlist_state_t &anetlist,
			const pstring &name) override;
	};

	} // namespace factory

	namespace devices {
		void initialize_factory(factory::list_t &factory);
	} // namespace devices
} // namespace netlist

#endif // NLFACTORY_H_