source: src/Common/utility.h @ 2298f728

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since 2298f728 was 2298f728, checked in by Peter A. Buhr <pabuhr@…>, 6 years ago

more refactoring of parser code

  • Property mode set to 100644
File size: 6.8 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// utility.h --
8//
9// Author           : Richard C. Bilson
10// Created On       : Mon May 18 07:44:20 2015
11// Last Modified By : Peter A. Buhr
12// Last Modified On : Fri Sep 23 11:46:47 2016
13// Update Count     : 28
14//
15
16#ifndef _UTILITY_H
17#define _UTILITY_H
18
19#include <cctype>
20#include <algorithm>
21#include <iostream>
22#include <iterator>
23#include <list>
24#include <memory>
25#include <sstream>
26#include <string>
27#include <cassert>
28
29template< typename T >
30static inline T * maybeClone( const T *orig ) {
31        if ( orig ) {
32                return orig->clone();
33        } else {
34                return 0;
35        } // if
36}
37
38template<typename T, typename U>
39struct maybeBuild_t {
40        static T * doit( const U *orig ) {
41                if ( orig ) {
42                        return orig->build();
43                } else {
44                        return 0;
45                } // if
46        }
47};
48
49template< typename T, typename U >
50static inline T * maybeBuild( const U *orig ) {
51        return maybeBuild_t<T,U>::doit(orig);
52}
53
54template< typename T, typename U >
55static inline T * maybeMoveBuild( const U *orig ) {
56        T* ret = maybeBuild<T>(orig);
57        delete orig;
58        return ret;
59}
60
61template< typename Input_iterator >
62void printEnums( Input_iterator begin, Input_iterator end, const char * const *name_array, std::ostream &os ) {
63        for ( Input_iterator i = begin; i != end; ++i ) {
64                os << name_array[ *i ] << ' ';
65        } // for
66}
67
68template< typename Container >
69void deleteAll( Container &container ) {
70        for ( typename Container::iterator i = container.begin(); i != container.end(); ++i ) {
71                delete *i;
72        } // for
73}
74
75template< typename Container >
76void printAll( const Container &container, std::ostream &os, int indent = 0 ) {
77        for ( typename Container::const_iterator i = container.begin(); i != container.end(); ++i ) {
78                if ( *i ) {
79                        os << std::string( indent,  ' ' );
80                        (*i)->print( os, indent + 2 );
81                        // need an endl after each element because it's not easy to know when each individual item should end
82                        os << std::endl;
83                } // if
84        } // for
85}
86
87template< typename SrcContainer, typename DestContainer >
88void cloneAll( const SrcContainer &src, DestContainer &dest ) {
89        typename SrcContainer::const_iterator in = src.begin();
90        std::back_insert_iterator< DestContainer > out( dest );
91        while ( in != src.end() ) {
92                *out++ = (*in++)->clone();
93        } // while
94}
95
96template< typename Container >
97void assertAll( const Container &container ) {
98        int count = 0;
99        for ( typename Container::const_iterator i = container.begin(); i != container.end(); ++i ) {
100                if ( !(*i) ) {
101                        std::cerr << count << " is null" << std::endl;
102                } // if
103        } // for
104}
105
106template < typename T >
107std::list<T> tail( std::list<T> l ) {
108        if ( ! l.empty() ) {
109                std::list<T> ret(++(l.begin()), l.end());
110                return ret;
111        } // if
112}
113
114template < typename T >
115std::list<T> flatten( std::list < std::list<T> > l) {
116        typedef std::list <T> Ts;
117
118        Ts ret;
119
120        switch ( l.size() ) {
121          case 0:
122                return ret;
123          case 1:
124                return l.front();
125          default:
126                ret = flatten(tail(l));
127                ret.insert(ret.begin(), l.front().begin(), l.front().end());
128                return ret;
129        } // switch
130}
131
132template < typename T >
133void toString_single( std::ostream & os, const T & value ) {
134        os << value;
135}
136
137template < typename T, typename... Params >
138void toString_single( std::ostream & os, const T & value, const Params & ... params ) {
139        os << value;
140        toString_single( os, params ... );
141}
142
143template < typename ... Params >
144std::string toString( const Params & ... params ) {
145        std::ostringstream os;
146        toString_single( os, params... );
147        return os.str();
148}
149
150template< typename T >
151void replace( std::list< T > &org, typename std::list< T >::iterator pos, std::list< T > &with ) {
152        typename std::list< T >::iterator next = pos; advance( next, 1 );
153
154        //if ( next != org.end() ) {
155        org.erase( pos );
156        org.splice( next, with );
157        //}
158
159        return;
160}
161
162template< typename... Args >
163auto filter(Args&&... args) -> decltype(std::copy_if(std::forward<Args>(args)...)) {
164  return std::copy_if(std::forward<Args>(args)...);
165}
166
167template< typename... Args >
168auto zip(Args&&... args) -> decltype(zipWith(std::forward<Args>(args)..., std::make_pair)) {
169  return zipWith(std::forward<Args>(args)..., std::make_pair);
170}
171
172template< class InputIterator1, class InputIterator2, class OutputIterator, class BinFunction >
173void zipWith( InputIterator1 b1, InputIterator1 e1, InputIterator2 b2, InputIterator2 e2, OutputIterator out, BinFunction func ) {
174        while ( b1 != e1 && b2 != e2 )
175                *out++ = func(*b1++, *b2++);
176}
177
178// it's nice to actually be able to increment iterators by an arbitrary amount
179template< class InputIt, class Distance >
180InputIt operator+( InputIt it, Distance n ) {
181        advance(it, n);
182        return it;
183}
184
185template< typename T >
186void warn_single( const T & arg ) {
187        std::cerr << arg << std::endl;
188}
189
190template< typename T, typename... Params >
191void warn_single(const T & arg, const Params & ... params ) {
192        std::cerr << arg;
193        warn_single( params... );
194}
195
196template< typename... Params >
197void warn( const Params & ... params ) {
198        std::cerr << "Warning: ";
199        warn_single( params... );
200}
201
202// -----------------------------------------------------------------------------
203// Ref Counted Singleton class
204// Objects that inherit from this class will have at most one reference to it
205// but if all references die, the object will be deleted.
206
207template< typename ThisType >
208class RefCountSingleton {
209  public:
210        static std::shared_ptr<ThisType> get() {
211                if( global_instance.expired() ) {
212                        std::shared_ptr<ThisType> new_instance = std::make_shared<ThisType>();
213                        global_instance = new_instance;
214                        return std::move(new_instance);
215                }
216                return global_instance.lock();
217        }
218  private:
219        static std::weak_ptr<ThisType> global_instance;
220};
221
222template< typename ThisType >
223std::weak_ptr<ThisType> RefCountSingleton<ThisType>::global_instance;
224
225// -----------------------------------------------------------------------------
226// RAII object to regulate "save and restore" behaviour, e.g.
227// void Foo::bar() {
228//   ValueGuard<int> guard(var); // var is a member of type Foo
229//   var = ...;
230// } // var's original value is restored
231template< typename T >
232struct ValueGuard {
233        T old;
234        T& ref;
235
236        ValueGuard(T& inRef) : old(inRef), ref(inRef) {}
237        ~ValueGuard() { ref = old; }
238};
239
240// -----------------------------------------------------------------------------
241// Helper struct and function to support
242// for ( val : reverseIterate( container ) ) {}
243// syntax to have a for each that iterates backwards
244
245template< typename T >
246struct reverseIterate_t {
247        T& ref;
248
249        reverseIterate_t( T & ref ) : ref(ref) {}
250
251        typedef typename T::reverse_iterator iterator;
252        iterator begin() { return ref.rbegin(); }
253        iterator end() { return ref.rend(); }
254};
255
256template< typename T >
257reverseIterate_t< T > reverseIterate( T & ref ) {
258        return reverseIterate_t< T >( ref );
259}
260
261#endif // _UTILITY_H
262
263// Local Variables: //
264// tab-width: 4 //
265// mode: c++ //
266// compile-command: "make install" //
267// End: //
Note: See TracBrowser for help on using the repository browser.