aboutsummaryrefslogtreecommitdiffstats
path: root/frontends/verilog/preproc.h
blob: 673d633c0b6b9ac8e59b4677362b5ada7e6044e7 (plain)
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
/*
 *  yosys -- Yosys Open SYnthesis Suite
 *
 *  Copyright (C) 2012  Clifford Wolf <clifford@clifford.at>
 *
 *  Permission to use, copy, modify, and/or distribute this software for any
 *  purpose with or without fee is hereby granted, provided that the above
 *  copyright notice and this permission notice appear in all copies.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 *  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 *  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 *  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 *  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 *  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 *  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 *  ---
 *
 *  The Verilog preprocessor.
 *
 */
#ifndef VERILOG_PREPROC_H
#define VERILOG_PREPROC_H

#include "kernel/yosys.h"

#include <iosfwd>
#include <list>
#include <memory>
#include <string>

YOSYS_NAMESPACE_BEGIN

struct define_body_t;
struct arg_map_t;

struct define_map_t
{
	define_map_t();
	~ define_map_t();

	// Add a definition, overwriting any existing definition for name.
	void add(const std::string &name, const std::string &txt, const arg_map_t *args = nullptr);

	// Merge in another map of definitions (which take precedence
	// over anything currently defined).
	void merge(const define_map_t &map);

	// Find a definition by name. If no match, returns null.
	const define_body_t *find(const std::string &name) const;

	// Erase a definition by name (no effect if not defined).
	void erase(const std::string &name);

	// Clear any existing definitions
	void clear();

	// Print a list of definitions, using the log function
	void log() const;

	std::map<std::string, std::unique_ptr<define_body_t>> defines;
};


struct define_map_t;

std::string
frontend_verilog_preproc(std::istream                 &f,
                         std::string                   filename,
                         const define_map_t           &pre_defines,
                         define_map_t                 &global_defines_cache,
                         const std::list<std::string> &include_dirs);

YOSYS_NAMESPACE_END

#endif
"o">::string toString() const = 0; protected: /** \brief Virtual protected deconstructor. * (Will only be called by \ref ref) */ virtual ~Object() { print_destroyed(this); } private: mutable std::atomic<int> m_refCount { 0 }; }; // Tag class used to track constructions of ref objects. When we track constructors, below, we // track and print out the actual class (e.g. ref<MyObject>), and *also* add a fake tracker for // ref_tag. This lets us check that the total number of ref<Anything> constructors/destructors is // correct without having to check each individual ref<Whatever> type individually. class ref_tag {}; /** * \brief Reference counting helper * * The \a ref refeference template is a simple wrapper to store a * pointer to an object. It takes care of increasing and decreasing * the reference count of the object. When the last reference goes * out of scope, the associated object will be deallocated. * * \ingroup libcore */ template <typename T> class ref { public: /// Create a nullptr reference ref() : m_ptr(nullptr) { print_default_created(this); track_default_created((ref_tag*) this); } /// Construct a reference from a pointer ref(T *ptr) : m_ptr(ptr) { if (m_ptr) ((Object *) m_ptr)->incRef(); print_created(this, "from pointer", m_ptr); track_created((ref_tag*) this, "from pointer"); } /// Copy constructor ref(const ref &r) : m_ptr(r.m_ptr) { if (m_ptr) ((Object *) m_ptr)->incRef(); print_copy_created(this, "with pointer", m_ptr); track_copy_created((ref_tag*) this); } /// Move constructor ref(ref &&r) : m_ptr(r.m_ptr) { r.m_ptr = nullptr; print_move_created(this, "with pointer", m_ptr); track_move_created((ref_tag*) this); } /// Destroy this reference ~ref() { if (m_ptr) ((Object *) m_ptr)->decRef(); print_destroyed(this); track_destroyed((ref_tag*) this); } /// Move another reference into the current one ref& operator=(ref&& r) { print_move_assigned(this, "pointer", r.m_ptr); track_move_assigned((ref_tag*) this); if (*this == r) return *this; if (m_ptr) ((Object *) m_ptr)->decRef(); m_ptr = r.m_ptr; r.m_ptr = nullptr; return *this; } /// Overwrite this reference with another reference ref& operator=(const ref& r) { print_copy_assigned(this, "pointer", r.m_ptr); track_copy_assigned((ref_tag*) this); if (m_ptr == r.m_ptr) return *this; if (m_ptr) ((Object *) m_ptr)->decRef(); m_ptr = r.m_ptr; if (m_ptr) ((Object *) m_ptr)->incRef(); return *this; } /// Overwrite this reference with a pointer to another object ref& operator=(T *ptr) { print_values(this, "assigned pointer"); track_values((ref_tag*) this, "assigned pointer"); if (m_ptr == ptr) return *this; if (m_ptr) ((Object *) m_ptr)->decRef(); m_ptr = ptr; if (m_ptr) ((Object *) m_ptr)->incRef(); return *this; } /// Compare this reference with another reference bool operator==(const ref &r) const { return m_ptr == r.m_ptr; } /// Compare this reference with another reference bool operator!=(const ref &r) const { return m_ptr != r.m_ptr; } /// Compare this reference with a pointer bool operator==(const T* ptr) const { return m_ptr == ptr; } /// Compare this reference with a pointer bool operator!=(const T* ptr) const { return m_ptr != ptr; } /// Access the object referenced by this reference T* operator->() { return m_ptr; } /// Access the object referenced by this reference const T* operator->() const { return m_ptr; } /// Return a C++ reference to the referenced object T& operator*() { return *m_ptr; } /// Return a const C++ reference to the referenced object const T& operator*() const { return *m_ptr; } /// Return a pointer to the referenced object operator T* () { return m_ptr; } /// Return a const pointer to the referenced object T* get_ptr() { return m_ptr; } /// Return a pointer to the referenced object const T* get_ptr() const { return m_ptr; } private: T *m_ptr; }; #endif /* __OBJECT_H */