source: src/AST/Node.hpp @ 9e1d485

ADTarm-ehast-experimentalcleanup-dtorsenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprpthread-emulationqualifiedEnum
Last change on this file since 9e1d485 was 9e1d485, checked in by Aaron Moss <a3moss@…>, 5 years ago

First draft of ast::Type with subclasses

  • Property mode set to 100644
File size: 4.0 KB
RevLine 
[2bb4a01]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
[cedb545]16#pragma once
17
[2bb4a01]18#include <cassert>
19#include <iosfwd>
[cedb545]20
21namespace ast {
[2bb4a01]22
23class Visitor;
24
25/// Base class for all AST nodes.
26/// Keeps both strong and weak reference counts.
[f47f887]27class Node {
28public:
[14cebb7a]29        // override defaults to ensure assignment doesn't
[2bb4a01]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;
[f47f887]36        virtual ~Node() = default;
[cedb545]37
[2bb4a01]38        virtual Node* accept( Visitor& v ) = 0;
39
40        /// Types of node references
[f47f887]41        enum class ref_type {
42                strong,
43                weak
44        };
[cedb545]45
[f47f887]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;
[cedb545]50                }
[f47f887]51        }
[cedb545]52
[f47f887]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;
[cedb545]57                }
58
[f47f887]59                if(!strong_ref && !weak_ref) {
60                        delete this;
[6a625de]61                }
[f47f887]62        }
[6a625de]63
[f47f887]64        template<typename node_t>
65        friend auto mutate(const node_t * node);
66
67private:
[2bb4a01]68        /// Make a copy of this node; should be overridden in subclass with more precise return type
69        virtual Node* clone() const = 0;
70
[f47f887]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);
[6a625de]85        }
86
[f47f887]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
[2bb4a01]94std::ostream& operator<< ( std::ostream& out, const Node* node );
95
[9e1d485]96/// Base class for the smart pointer types
97/// should never really be used.
98template< typename node_t, enum Node::ref_type ref_t >
[f47f887]99class ptr_base {
100public:
101        ptr_base() : node(nullptr) {}
[9e1d485]102        ptr_base( const node_t * n ) : node(n) { if( node ) node->increment(ref_t); }
[f47f887]103        ~ptr_base() { if( node ) node->decrement(ref_t); }
104
[9e1d485]105        template< enum Node::ref_type o_ref_t >
[f47f887]106        ptr_base( const ptr_base<node_t, o_ref_t> & o ) : node(o.node) {
[9e1d485]107                if( node ) node->increment(ref_t);
[6a625de]108        }
109
[9e1d485]110        template< enum Node::ref_type o_ref_t >
[f47f887]111        ptr_base( ptr_base<node_t, o_ref_t> && o ) : node(o.node) {
112                if( node ) node->increment(ref_t);
113        }
[cedb545]114
[9e1d485]115        template< enum Node::ref_type o_ref_t >
[f47f887]116        ptr_base & operator=( const ptr_base<node_t, o_ref_t> & o ) {
117                assign(o.node);
118                return *this;
119        }
[cedb545]120
[9e1d485]121        template< enum Node::ref_type o_ref_t >
[f47f887]122        ptr_base & operator=( ptr_base<node_t, o_ref_t> && o ) {
123                assign(o.node);
124                return *this;
125        }
[cedb545]126
[f47f887]127        const node_t * get() const { return  node; }
128        const node_t * operator->() const { return  node; }
129        const node_t & operator* () const { return *node; }
130        explicit operator bool() const { return node; }
131        operator const node_t * const() const { return node; }
[cedb545]132
[fdbd4fd]133        template<typename o_node_t>
[9e1d485]134        const o_node_t * as() const { return dynamic_cast<const o_node_t *>(node); }
[fdbd4fd]135
[f47f887]136        using ptr = const node_t *;
[cedb545]137
[f47f887]138private:
[9e1d485]139        void assign( const node_t * other ) {
[f47f887]140                if( other ) other->increment(ref_t);
141                if( node  ) node ->decrement(ref_t);
142                node = other;
143        }
[cedb545]144
[f47f887]145protected:
[9e1d485]146        const node_t * node;
[f47f887]147};
[cedb545]148
[2bb4a01]149/// Owning pointer to node
[f47f887]150template< typename node_t >
151using ptr = ptr_base< node_t, Node::ref_type::strong >;
[cedb545]152
[2bb4a01]153/// Observing pointer to node
[f47f887]154template< typename node_t >
155using readonly = ptr_base< node_t, Node::ref_type::weak >;
[2bb4a01]156}
157
158// Local Variables: //
159// tab-width: 4 //
160// mode: c++ //
161// compile-command: "make install" //
162// End: //
Note: See TracBrowser for help on using the repository browser.