source: src/Common/utility.h @ 43db35e

ADTast-experimental
Last change on this file since 43db35e was 1b65595, checked in by Thierry Delisle <tdelisle@…>, 2 years ago

Implemented move semantics for ValueGuardPtr?

  • Property mode set to 100644
File size: 17.2 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 : Andrew Beach
12// Last Modified On : Mon Apr 25 14:26:00 2022
13// Update Count     : 51
14//
15
16#pragma once
17
18#include <cassert>
19#include <cctype>
20#include <algorithm>
21#include <functional>
22#include <iostream>
23#include <iterator>
24#include <list>
25#include <memory>
26#include <sstream>
27#include <string>
28#include <type_traits>
29#include <utility>
30#include <vector>
31#include <cstring>                                                                              // memcmp
32
33#include "Common/Indenter.h"
34
35class Expression;
36
37/// bring std::move into global scope
38using std::move;
39
40/// partner to move that copies any copyable type
41template<typename T>
42T copy( const T & x ) { return x; }
43
44template< typename T >
45static inline T * maybeClone( const T *orig ) {
46        if ( orig ) {
47                return orig->clone();
48        } else {
49                return 0;
50        } // if
51}
52
53template< typename T, typename U >
54struct maybeBuild_t {
55        static T * doit( const U *orig ) {
56                if ( orig ) {
57                        return orig->build();
58                } else {
59                        return 0;
60                } // if
61        }
62};
63
64template< typename T, typename U >
65static inline T * maybeBuild( const U *orig ) {
66        return maybeBuild_t<T,U>::doit(orig);
67}
68
69template< typename T, typename U >
70static inline T * maybeMoveBuild( const U *orig ) {
71        T* ret = maybeBuild<T>(orig);
72        delete orig;
73        return ret;
74}
75
76template< typename Input_iterator >
77void printEnums( Input_iterator begin, Input_iterator end, const char * const *name_array, std::ostream &os ) {
78        for ( Input_iterator i = begin; i != end; ++i ) {
79                os << name_array[ *i ] << ' ';
80        } // for
81}
82
83template< typename Container >
84void deleteAll( const Container &container ) {
85        for ( const auto &i : container ) {
86                delete i;
87        } // for
88}
89
90template< typename Container >
91void printAll( const Container &container, std::ostream &os, Indenter indent = {} ) {
92        for ( typename Container::const_iterator i = container.begin(); i != container.end(); ++i ) {
93                if ( *i ) {
94                        os << indent;
95                        (*i)->print( os, indent );
96                        // need an endl after each element because it's not easy to know when each individual item should end
97                        os << std::endl;
98                } // if
99        } // for
100}
101
102template< typename SrcContainer, typename DestContainer >
103void cloneAll( const SrcContainer &src, DestContainer &dest ) {
104        typename SrcContainer::const_iterator in = src.begin();
105        std::back_insert_iterator< DestContainer > out( dest );
106        while ( in != src.end() ) {
107                *out++ = (*in++)->clone();
108        } // while
109}
110
111template< typename SrcContainer, typename DestContainer, typename Predicate >
112void cloneAll_if( const SrcContainer &src, DestContainer &dest, Predicate pred ) {
113        std::back_insert_iterator< DestContainer > out( dest );
114        for ( auto x : src ) {
115                if ( pred(x) ) {
116                        *out++ = x->clone();
117                }
118        } // while
119}
120
121template< typename Container >
122void assertAll( const Container &container ) {
123        int count = 0;
124        for ( typename Container::const_iterator i = container.begin(); i != container.end(); ++i ) {
125                if ( !(*i) ) {
126                        std::cerr << count << " is null" << std::endl;
127                } // if
128        } // for
129}
130
131template < typename T >
132std::list<T> tail( std::list<T> l ) {
133        if ( ! l.empty() ) {
134                std::list<T> ret(++(l.begin()), l.end());
135                return ret;
136        } // if
137}
138
139template < typename T >
140std::list<T> flatten( std::list < std::list<T> > l) {
141        typedef std::list <T> Ts;
142
143        Ts ret;
144
145        switch ( l.size() ) {
146          case 0:
147                return ret;
148          case 1:
149                return l.front();
150          default:
151                ret = flatten(tail(l));
152                ret.insert(ret.begin(), l.front().begin(), l.front().end());
153                return ret;
154        } // switch
155}
156
157/// Splice src onto the end of dst, clearing src
158template< typename T >
159void splice( std::vector< T > & dst, std::vector< T > & src ) {
160        dst.reserve( dst.size() + src.size() );
161        for ( T & x : src ) { dst.emplace_back( std::move( x ) ); }
162        src.clear();
163}
164
165/// Splice src onto the begining of dst, clearing src
166template< typename T >
167void spliceBegin( std::vector< T > & dst, std::vector< T > & src ) {
168        splice( src, dst );
169        dst.swap( src );
170}
171
172template < typename T >
173void toString_single( std::ostream & os, const T & value ) {
174        os << value;
175}
176
177template < typename T, typename... Params >
178void toString_single( std::ostream & os, const T & value, const Params & ... params ) {
179        os << value;
180        toString_single( os, params ... );
181}
182
183template < typename ... Params >
184std::string toString( const Params & ... params ) {
185        std::ostringstream os;
186        toString_single( os, params... );
187        return os.str();
188}
189
190#define toCString( ... ) toString( __VA_ARGS__ ).c_str()
191
192// replace element of list with all elements of another list
193template< typename T >
194void replace( std::list< T > &org, typename std::list< T >::iterator pos, std::list< T > &with ) {
195        typename std::list< T >::iterator next = pos; advance( next, 1 );
196
197        //if ( next != org.end() ) {
198        org.erase( pos );
199        org.splice( next, with );
200        //}
201
202        return;
203}
204
205// replace range of a list with a single element
206template< typename T >
207void replace( std::list< T > &org, typename std::list< T >::iterator begin, typename std::list< T >::iterator end, const T & with ) {
208        org.insert( begin, with );
209        org.erase( begin, end );
210}
211
212template< typename... Args >
213auto filter(Args&&... args) -> decltype(std::copy_if(std::forward<Args>(args)...)) {
214  return std::copy_if(std::forward<Args>(args)...);
215}
216
217template <typename E, typename UnaryPredicate, template< typename, typename...> class Container, typename... Args >
218void filter( Container< E *, Args... > & container, UnaryPredicate pred, bool doDelete ) {
219        auto i = begin( container );
220        while ( i != end( container ) ) {
221                auto it = next( i );
222                if ( pred( *i ) ) {
223                        if ( doDelete ) {
224                                delete *i;
225                        } // if
226                        container.erase( i );
227                } // if
228                i = it;
229        } // while
230}
231
232template<typename Container, typename Pred>
233void erase_if( Container & cont, Pred && pred ) {
234        auto keep_end = std::remove_if( cont.begin(), cont.end(), pred );
235        cont.erase( keep_end, cont.end() );
236}
237
238template< typename... Args >
239auto zip(Args&&... args) -> decltype(zipWith(std::forward<Args>(args)..., std::make_pair)) {
240  return zipWith(std::forward<Args>(args)..., std::make_pair);
241}
242
243template< class InputIterator1, class InputIterator2, class OutputIterator, class BinFunction >
244void zipWith( InputIterator1 b1, InputIterator1 e1, InputIterator2 b2, InputIterator2 e2, OutputIterator out, BinFunction func ) {
245        while ( b1 != e1 && b2 != e2 )
246                *out++ = func(*b1++, *b2++);
247}
248
249// it's nice to actually be able to increment iterators by an arbitrary amount
250template< class InputIt, class Distance >
251InputIt operator+( InputIt it, Distance n ) {
252        advance(it, n);
253        return it;
254}
255
256template< typename T >
257void warn_single( const T & arg ) {
258        std::cerr << arg << std::endl;
259}
260
261template< typename T, typename... Params >
262void warn_single(const T & arg, const Params & ... params ) {
263        std::cerr << arg;
264        warn_single( params... );
265}
266
267template< typename... Params >
268void warn( const Params & ... params ) {
269        std::cerr << "Warning: ";
270        warn_single( params... );
271}
272
273// determines if pref is a prefix of str
274static inline bool isPrefix( const std::string & str, const std::string & pref, unsigned int start = 0 ) {
275        if ( pref.size() > str.size() ) return false;
276    return 0 == memcmp( str.c_str() + start, pref.c_str(), pref.size() );
277        // return prefix == full.substr(0, prefix.size()); // for future, requires c++17
278}
279
280// -----------------------------------------------------------------------------
281// Ref Counted Singleton class
282// Objects that inherit from this class will have at most one reference to it
283// but if all references die, the object will be deleted.
284
285template< typename ThisType >
286class RefCountSingleton {
287  public:
288        static std::shared_ptr<ThisType> get() {
289                if( global_instance.expired() ) {
290                        std::shared_ptr<ThisType> new_instance = std::make_shared<ThisType>();
291                        global_instance = new_instance;
292                        return std::move(new_instance);
293                }
294                return global_instance.lock();
295        }
296  private:
297        static std::weak_ptr<ThisType> global_instance;
298};
299
300template< typename ThisType >
301std::weak_ptr<ThisType> RefCountSingleton<ThisType>::global_instance;
302
303// -----------------------------------------------------------------------------
304// RAII object to regulate "save and restore" behaviour, e.g.
305// void Foo::bar() {
306//   ValueGuard<int> guard(var); // var is a member of type Foo
307//   var = ...;
308// } // var's original value is restored
309template< typename T >
310struct ValueGuard {
311        T old;
312        T& ref;
313
314        ValueGuard(T& inRef) : old(inRef), ref(inRef) {}
315        ~ValueGuard() { ref = old; }
316};
317
318template< typename T >
319struct ValueGuardPtr {
320        T old;
321        T* ref;
322
323        ValueGuardPtr(T * inRef) : old( inRef ? *inRef : T() ), ref(inRef) {}
324        ValueGuardPtr(const ValueGuardPtr& other) = delete;
325        ValueGuardPtr(ValueGuardPtr&& other) : old(other.old), ref(other.ref) { other.ref = nullptr; }
326        ~ValueGuardPtr() { if( ref ) *ref = old; }
327};
328
329template< typename aT >
330struct FuncGuard {
331        aT m_after;
332
333        template< typename bT >
334        FuncGuard( bT before, aT after ) : m_after( after ) {
335                before();
336        }
337
338        ~FuncGuard() {
339                m_after();
340        }
341};
342
343template< typename bT, typename aT >
344FuncGuard<aT> makeFuncGuard( bT && before, aT && after ) {
345        return FuncGuard<aT>( std::forward<bT>(before), std::forward<aT>(after) );
346}
347
348template< typename T >
349struct ValueGuardPtr< std::list< T > > {
350        std::list< T > old;
351        std::list< T >* ref;
352
353        ValueGuardPtr( std::list< T > * inRef) : old(), ref(inRef) {
354                if( ref ) { swap( *ref, old ); }
355        }
356        ~ValueGuardPtr() { if( ref ) { swap( *ref, old ); } }
357};
358
359// -----------------------------------------------------------------------------
360// Helper struct and function to support
361// for ( val : reverseIterate( container ) ) {}
362// syntax to have a for each that iterates backwards
363
364template< typename T >
365struct reverse_iterate_t {
366        T& ref;
367
368        reverse_iterate_t( T & ref ) : ref(ref) {}
369
370        // this does NOT work on const T!!!
371        // typedef typename T::reverse_iterator iterator;
372        auto begin() { return ref.rbegin(); }
373        auto end() { return ref.rend(); }
374};
375
376template< typename T >
377reverse_iterate_t< T > reverseIterate( T & ref ) {
378        return reverse_iterate_t< T >( ref );
379}
380
381template< typename T >
382struct enumerate_t {
383        template<typename val_t>
384        struct value_t {
385                val_t & val;
386                size_t idx;
387        };
388
389        template< typename iter_t, typename val_t >
390        struct iterator_t {
391                iter_t it;
392                size_t idx;
393
394                iterator_t( iter_t _it, size_t _idx ) : it(_it), idx(_idx) {}
395
396                value_t<val_t> operator*() const { return value_t<val_t>{ *it, idx }; }
397
398                bool operator==(const iterator_t & o) const { return o.it == it; }
399                bool operator!=(const iterator_t & o) const { return o.it != it; }
400
401                iterator_t & operator++() {
402                        it++;
403                        idx++;
404                        return *this;
405                }
406
407                using difference_type   = typename std::iterator_traits< iter_t >::difference_type;
408                using value_type        = value_t<val_t>;
409                using pointer           = value_t<val_t> *;
410                using reference         = value_t<val_t> &;
411                using iterator_category = std::forward_iterator_tag;
412        };
413
414        T & ref;
415
416        using iterator = iterator_t< typename T::iterator, typename T::value_type >;
417        using const_iterator = iterator_t< typename T::const_iterator, const typename T::value_type >;
418
419        iterator begin() { return iterator( ref.begin(), 0 ); }
420        iterator end()   { return iterator( ref.end(), ref.size() ); }
421
422        const_iterator begin() const { return const_iterator( ref.cbegin(), 0 ); }
423        const_iterator end()   const { return const_iterator( ref.cend(), ref.size() ); }
424
425        const_iterator cbegin() const { return const_iterator( ref.cbegin(), 0 ); }
426        const_iterator cend()   const { return const_iterator( ref.cend(), ref.size() ); }
427};
428
429template< typename T >
430enumerate_t<T> enumerate( T & ref ) {
431        return enumerate_t< T >{ ref };
432}
433
434template< typename T >
435const enumerate_t< const T > enumerate( const T & ref ) {
436        return enumerate_t< const T >{ ref };
437}
438
439template< typename OutType, typename Range, typename Functor >
440OutType map_range( const Range& range, Functor&& functor ) {
441        OutType out;
442
443        std::transform(
444                begin( range ),
445                end( range ),
446                std::back_inserter( out ),
447                std::forward< Functor >( functor )
448        );
449
450        return out;
451}
452
453// -----------------------------------------------------------------------------
454// Helper struct and function to support
455// for ( val : group_iterate( container1, container2, ... ) ) {}
456// syntax to have a for each that iterates multiple containers of the same length
457// TODO: update to use variadic arguments
458
459template< typename T1, typename T2 >
460struct group_iterate_t {
461private:
462        std::tuple<T1, T2> args;
463public:
464        group_iterate_t( bool skipBoundsCheck, const T1 & v1, const T2 & v2 ) : args(v1, v2) {
465                assertf(skipBoundsCheck || v1.size() == v2.size(), "group iteration requires containers of the same size: <%zd, %zd>.", v1.size(), v2.size());
466        };
467
468        typedef std::tuple<decltype(*std::get<0>(args).begin()), decltype(*std::get<1>(args).begin())> value_type;
469        typedef decltype(std::get<0>(args).begin()) T1Iter;
470        typedef decltype(std::get<1>(args).begin()) T2Iter;
471
472        struct iterator {
473                typedef std::tuple<T1Iter, T2Iter> IterTuple;
474                IterTuple it;
475                iterator( T1Iter i1, T2Iter i2 ) : it( i1, i2 ) {}
476                iterator operator++() {
477                        return iterator( ++std::get<0>(it), ++std::get<1>(it) );
478                }
479                bool operator!=( const iterator &other ) const { return it != other.it; }
480                value_type operator*() const { return std::tie( *std::get<0>(it), *std::get<1>(it) ); }
481        };
482
483        iterator begin() { return iterator( std::get<0>(args).begin(), std::get<1>(args).begin() ); }
484        iterator end() { return iterator( std::get<0>(args).end(), std::get<1>(args).end() ); }
485};
486
487/// performs bounds check to ensure that all arguments are of the same length.
488template< typename... Args >
489group_iterate_t<Args...> group_iterate( Args &&... args ) {
490        return group_iterate_t<Args...>(false, std::forward<Args>( args )...);
491}
492
493/// does not perform a bounds check - requires user to ensure that iteration terminates when appropriate.
494template< typename... Args >
495group_iterate_t<Args...> unsafe_group_iterate( Args &&... args ) {
496        return group_iterate_t<Args...>(true, std::forward<Args>( args )...);
497}
498
499// -----------------------------------------------------------------------------
500// Helper struct and function to support
501// for ( val : lazy_map( container1, f ) ) {}
502// syntax to have a for each that iterates a container, mapping each element by applying f
503template< typename T, typename Func >
504struct lambda_iterate_t {
505        const T & ref;
506        std::function<Func> f;
507
508        struct iterator {
509                typedef decltype(begin(ref)) Iter;
510                Iter it;
511                std::function<Func> f;
512                iterator( Iter it, std::function<Func> f ) : it(it), f(f) {}
513                iterator & operator++() {
514                        ++it; return *this;
515                }
516                bool operator!=( const iterator &other ) const { return it != other.it; }
517                auto operator*() const -> decltype(f(*it)) { return f(*it); }
518        };
519
520        lambda_iterate_t( const T & ref, std::function<Func> f ) : ref(ref), f(f) {}
521
522        auto begin() const -> decltype(iterator(std::begin(ref), f)) { return iterator(std::begin(ref), f); }
523        auto end() const   -> decltype(iterator(std::end(ref), f)) { return iterator(std::end(ref), f); }
524};
525
526template< typename... Args >
527lambda_iterate_t<Args...> lazy_map( const Args &... args ) {
528        return lambda_iterate_t<Args...>( args...);
529}
530
531// -----------------------------------------------------------------------------
532// O(1) polymorphic integer ilog2, using clz, which returns the number of leading 0-bits, starting at the most
533// significant bit (single instruction on x86)
534
535template<typename T>
536inline
537#if defined(__GNUC__) && __GNUC__ > 4
538constexpr
539#endif
540T ilog2(const T & t) {
541        if(std::is_integral<T>::value) {
542                const constexpr int r = sizeof(t) * __CHAR_BIT__ - 1;
543                if( sizeof(T) == sizeof(unsigned       int) ) return r - __builtin_clz  ( t );
544                if( sizeof(T) == sizeof(unsigned      long) ) return r - __builtin_clzl ( t );
545                if( sizeof(T) == sizeof(unsigned long long) ) return r - __builtin_clzll( t );
546        }
547        assert(false);
548        return -1;
549} // ilog2
550
551// -----------------------------------------------------------------------------
552/// evaluates expr as a long long int. If second is false, expr could not be evaluated
553std::pair<long long int, bool> eval(const Expression * expr);
554
555namespace ast {
556        class Expr;
557}
558
559std::pair<long long int, bool> eval(const ast::Expr * expr);
560
561// -----------------------------------------------------------------------------
562/// Reorders the input range in-place so that the minimal-value elements according to the
563/// comparator are in front;
564/// returns the iterator after the last minimal-value element.
565template<typename Iter, typename Compare>
566Iter sort_mins( Iter begin, Iter end, Compare& lt ) {
567        if ( begin == end ) return end;
568
569        Iter min_pos = begin;
570        for ( Iter i = begin + 1; i != end; ++i ) {
571                if ( lt( *i, *min_pos ) ) {
572                        // new minimum cost; swap into first position
573                        min_pos = begin;
574                        std::iter_swap( min_pos, i );
575                } else if ( ! lt( *min_pos, *i ) ) {
576                        // duplicate minimum cost; swap into next minimum position
577                        ++min_pos;
578                        std::iter_swap( min_pos, i );
579                }
580        }
581        return ++min_pos;
582}
583
584template<typename Iter, typename Compare>
585inline Iter sort_mins( Iter begin, Iter end, Compare&& lt ) {
586        return sort_mins( begin, end, lt );
587}
588
589/// sort_mins defaulted to use std::less
590template<typename Iter>
591inline Iter sort_mins( Iter begin, Iter end ) {
592        return sort_mins( begin, end, std::less<typename std::iterator_traits<Iter>::value_type>{} );
593}
594
595// Local Variables: //
596// tab-width: 4 //
597// mode: c++ //
598// compile-command: "make install" //
599// End: //
Note: See TracBrowser for help on using the repository browser.