source: src/AST/Node.hpp @ 2bb4a01

arm-ehcleanup-dtorsenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprpthread-emulation
Last change on this file since 2bb4a01 was 2bb4a01, checked in by Aaron Moss <a3moss@…>, 3 years ago

Start on new AST

  • Property mode set to 100644
File size: 3.9 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2015 University of Waterloo
3//
4// The contents of this file are covered under the licence agreement in the
5// file "LICENCE" distributed with Cforall.
6//
7// Node.hpp --
8//
9// Author           : Thierry Delisle
10// Created On       : Wed May 8 10:27:04 2019
11// Last Modified By : Aaron B. Moss
12// Last Modified On : Wed May 8 11:00:00 2019
13// Update Count     : 2
14//
15
16#pragma once
17
18#include <cassert>
19#include <iosfwd>
20
21namespace ast {
22
23class Visitor;
24
25/// Base class for all AST nodes.
26/// Keeps both strong and weak reference counts.
27class Node {
28public:
29        // override defaults to ensure assignment doesn't
30        // change/share reference counts
31        Node() = default;
32        Node(const Node&) : strong_ref(0), weak_ref(0) {}
33        Node(Node&&) : strong_ref(0), weak_ref(0) {}
34        Node& operator= (const Node&) = delete;
35        Node& operator= (Node&&) = delete;
36        virtual ~Node() = default;
37
38        virtual Node* accept( Visitor& v ) = 0;
39
40        /// Types of node references
41        enum class ref_type {
42                strong,
43                weak
44        };
45
46        inline void increment(ref_type ref) const {
47                switch (ref) {
48                        case ref_type::strong: strong_ref++; break;
49                        case ref_type::weak  : weak_ref  ++; break;
50                }
51        }
52
53        inline void decrement(ref_type ref) const {
54                switch (ref) {
55                        case ref_type::strong: strong_ref--; break;
56                        case ref_type::weak  : weak_ref  --; break;
57                }
58
59                if(!strong_ref && !weak_ref) {
60                        delete this;
61                }
62        }
63
64        template<typename node_t>
65        friend auto mutate(const node_t * node);
66
67private:
68        /// Make a copy of this node; should be overridden in subclass with more precise return type
69        virtual Node* clone() const = 0;
70
71        mutable size_t strong_ref = 0;
72        mutable size_t weak_ref = 0;
73};
74
75// Mutate a node, non-member function to avoid static type
76// problems and be able to use auto return
77template<typename node_t>
78auto mutate(const node_t * node) {
79        assertf(
80                node->strong_count >= 1,
81                "Error: attempting to mutate a node that appears to have been linked"
82        );
83        if (node->strong_count == 1) {
84                return const_cast<node_t *>(node);
85        }
86
87        assertf(
88                node->weak_count == 0,
89                "Error: mutating node with weak references to it will invalided some references"
90        );
91        return node->clone();
92}
93
94std::ostream& operator<< ( std::ostream& out, const Node* node );
95
96// Base class for the smart pointer types
97// should never really be used.
98template< typename node_t, enum Node::ref_type ref_t>
99class ptr_base {
100public:
101        ptr_base() : node(nullptr) {}
102        ptr_base( node_t * n ) : node(n) { if( !node ) node->increment(ref_t); }
103        ~ptr_base() { if( node ) node->decrement(ref_t); }
104
105        template< enum  Node::ref_type o_ref_t >
106        ptr_base( const ptr_base<node_t, o_ref_t> & o ) : node(o.node) {
107                if( !node ) return;
108                node->increment(ref_t);
109        }
110
111        template< enum  Node::ref_type o_ref_t >
112        ptr_base( ptr_base<node_t, o_ref_t> && o ) : node(o.node) {
113                if( node ) node->increment(ref_t);
114        }
115
116        template< enum  Node::ref_type o_ref_t >
117        ptr_base & operator=( const ptr_base<node_t, o_ref_t> & o ) {
118                assign(o.node);
119                return *this;
120        }
121
122        template< enum  Node::ref_type o_ref_t >
123        ptr_base & operator=( ptr_base<node_t, o_ref_t> && o ) {
124                if(o.node == node) return *this;
125                assign(o.node);
126                return *this;
127        }
128
129        const node_t * get() const { return  node; }
130        const node_t * operator->() const { return  node; }
131        const node_t & operator* () const { return *node; }
132        explicit operator bool() const { return node; }
133        operator const node_t * const() const { return node; }
134
135        using ptr = const node_t *;
136
137private:
138        void assign(node_t * other ) {
139                if( other ) other->increment(ref_t);
140                if( node  ) node ->decrement(ref_t);
141                node = other;
142        }
143
144protected:
145        node_t * node;
146};
147
148/// Owning pointer to node
149template< typename node_t >
150using ptr = ptr_base< node_t, Node::ref_type::strong >;
151
152/// Observing pointer to node
153template< typename node_t >
154using readonly = ptr_base< node_t, Node::ref_type::weak >;
155}
156
157// Local Variables: //
158// tab-width: 4 //
159// mode: c++ //
160// compile-command: "make install" //
161// End: //
Note: See TracBrowser for help on using the repository browser.