Shrink MicroSpinLock.h transitive includes and inline methods
[folly.git] / folly / gen / Base.h
1 /*
2  * Copyright 2017 Facebook, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #pragma once
18 #define FOLLY_GEN_BASE_H_
19
20 #include <algorithm>
21 #include <functional>
22 #include <memory>
23 #include <random>
24 #include <type_traits>
25 #include <unordered_map>
26 #include <unordered_set>
27 #include <utility>
28 #include <vector>
29
30 #include <folly/Conv.h>
31 #include <folly/Optional.h>
32 #include <folly/Range.h>
33 #include <folly/Utility.h>
34 #include <folly/gen/Core.h>
35
36 /**
37  * Generator-based Sequence Comprehensions in C++, akin to C#'s LINQ
38  * @author Tom Jackson <tjackson@fb.com>
39  *
40  * This library makes it possible to write declarative comprehensions for
41  * processing sequences of values efficiently in C++. The operators should be
42  * familiar to those with experience in functional programming, and the
43  * performance will be virtually identical to the equivalent, boilerplate C++
44  * implementations.
45  *
46  * Generator objects may be created from either an stl-like container (anything
47  * supporting begin() and end()), from sequences of values, or from another
48  * generator (see below). To create a generator that pulls values from a vector,
49  * for example, one could write:
50  *
51  *   vector<string> names { "Jack", "Jill", "Sara", "Tom" };
52  *   auto gen = from(names);
53  *
54  * Generators are composed by building new generators out of old ones through
55  * the use of operators. These are reminicent of shell pipelines, and afford
56  * similar composition. Lambda functions are used liberally to describe how to
57  * handle individual values:
58  *
59  *   auto lengths = gen
60  *                | mapped([](const fbstring& name) { return name.size(); });
61  *
62  * Generators are lazy; they don't actually perform any work until they need to.
63  * As an example, the 'lengths' generator (above) won't actually invoke the
64  * provided lambda until values are needed:
65  *
66  *   auto lengthVector = lengths | as<std::vector>();
67  *   auto totalLength = lengths | sum;
68  *
69  * 'auto' is useful in here because the actual types of the generators objects
70  * are usually complicated and implementation-sensitive.
71  *
72  * If a simpler type is desired (for returning, as an example), VirtualGen<T>
73  * may be used to wrap the generator in a polymorphic wrapper:
74  *
75  *  VirtualGen<float> powersOfE() {
76  *    return seq(1) | mapped(&expf);
77  *  }
78  *
79  * To learn more about this library, including the use of infinite generators,
80  * see the examples in the comments, or the docs (coming soon).
81  */
82
83 namespace folly {
84 namespace gen {
85
86 class Less {
87  public:
88   template <class First, class Second>
89   auto operator()(const First& first, const Second& second) const ->
90   decltype(first < second) {
91     return first < second;
92   }
93 };
94
95 class Greater {
96  public:
97   template <class First, class Second>
98   auto operator()(const First& first, const Second& second) const ->
99   decltype(first > second) {
100     return first > second;
101   }
102 };
103
104 template <int n>
105 class Get {
106  public:
107   template <class Value>
108   auto operator()(Value&& value) const ->
109   decltype(std::get<n>(std::forward<Value>(value))) {
110     return std::get<n>(std::forward<Value>(value));
111   }
112 };
113
114 template <class Class, class Result>
115 class MemberFunction {
116  public:
117   typedef Result (Class::*MemberPtr)();
118  private:
119   MemberPtr member_;
120  public:
121   explicit MemberFunction(MemberPtr member)
122     : member_(member)
123   {}
124
125   Result operator()(Class&& x) const {
126     return (x.*member_)();
127   }
128
129   Result operator()(Class& x) const {
130     return (x.*member_)();
131   }
132
133   Result operator()(Class* x) const {
134     return (x->*member_)();
135   }
136 };
137
138 template <class Class, class Result>
139 class ConstMemberFunction{
140  public:
141   typedef Result (Class::*MemberPtr)() const;
142  private:
143   MemberPtr member_;
144  public:
145   explicit ConstMemberFunction(MemberPtr member)
146     : member_(member)
147   {}
148
149   Result operator()(const Class& x) const {
150     return (x.*member_)();
151   }
152
153   Result operator()(const Class* x) const {
154     return (x->*member_)();
155   }
156 };
157
158 template <class Class, class FieldType>
159 class Field {
160  public:
161   typedef FieldType (Class::*FieldPtr);
162  private:
163   FieldPtr field_;
164  public:
165   explicit Field(FieldPtr field)
166     : field_(field)
167   {}
168
169   const FieldType& operator()(const Class& x) const {
170     return x.*field_;
171   }
172
173   const FieldType& operator()(const Class* x) const {
174     return x->*field_;
175   }
176
177   FieldType& operator()(Class& x) const {
178     return x.*field_;
179   }
180
181   FieldType& operator()(Class* x) const {
182     return x->*field_;
183   }
184
185   FieldType&& operator()(Class&& x) const {
186     return std::move(x.*field_);
187   }
188 };
189
190 class Move {
191  public:
192   template <class Value>
193   auto operator()(Value&& value) const ->
194   decltype(std::move(std::forward<Value>(value))) {
195     return std::move(std::forward<Value>(value));
196   }
197 };
198
199 /**
200  * Class and helper function for negating a boolean Predicate
201  */
202 template <class Predicate>
203 class Negate {
204   Predicate pred_;
205
206  public:
207   Negate() = default;
208
209   explicit Negate(Predicate pred)
210     : pred_(std::move(pred))
211   {}
212
213   template <class Arg>
214   bool operator()(Arg&& arg) const {
215     return !pred_(std::forward<Arg>(arg));
216   }
217 };
218 template <class Predicate>
219 Negate<Predicate> negate(Predicate pred) {
220   return Negate<Predicate>(std::move(pred));
221 }
222
223 template <class Dest>
224 class Cast {
225  public:
226   template <class Value>
227   Dest operator()(Value&& value) const {
228     return Dest(std::forward<Value>(value));
229   }
230 };
231
232 template <class Dest>
233 class To {
234  public:
235   template <class Value>
236   Dest operator()(Value&& value) const {
237     return ::folly::to<Dest>(std::forward<Value>(value));
238   }
239 };
240
241 // Specialization to allow String->StringPiece conversion
242 template <>
243 class To<StringPiece> {
244  public:
245   StringPiece operator()(StringPiece src) const {
246     return src;
247   }
248 };
249
250 template <class Key, class Value>
251 class Group;
252
253 namespace detail {
254
255 template <class Self>
256 struct FBounded;
257
258 /*
259  * Type Traits
260  */
261 template <class Container>
262 struct ValueTypeOfRange {
263  public:
264   using RefType = decltype(*std::begin(std::declval<Container&>()));
265   using StorageType = typename std::decay<RefType>::type;
266 };
267
268
269 /*
270  * Sources
271  */
272 template <
273     class Container,
274     class Value = typename ValueTypeOfRange<Container>::RefType>
275 class ReferencedSource;
276
277 template <
278     class Value,
279     class Container = std::vector<typename std::decay<Value>::type>>
280 class CopiedSource;
281
282 template <class Value, class SequenceImpl>
283 class Sequence;
284
285 template <class Value>
286 class RangeImpl;
287
288 template <class Value, class Distance>
289 class RangeWithStepImpl;
290
291 template <class Value>
292 class SeqImpl;
293
294 template <class Value, class Distance>
295 class SeqWithStepImpl;
296
297 template <class Value>
298 class InfiniteImpl;
299
300 template <class Value, class Source>
301 class Yield;
302
303 template <class Value>
304 class Empty;
305
306 template <class Value>
307 class SingleReference;
308
309 template <class Value>
310 class SingleCopy;
311
312 /*
313  * Operators
314  */
315 template <class Predicate>
316 class Map;
317
318 template <class Predicate>
319 class Filter;
320
321 template <class Predicate>
322 class Until;
323
324 class Take;
325
326 class Stride;
327
328 template <class Rand>
329 class Sample;
330
331 class Skip;
332
333 template <class Visitor>
334 class Visit;
335
336 template <class Selector, class Comparer = Less>
337 class Order;
338
339 template <class Selector>
340 class GroupBy;
341
342 template <class Selector>
343 class Distinct;
344
345 template <class Operators>
346 class Composer;
347
348 template <class Expected>
349 class TypeAssertion;
350
351 class Concat;
352
353 class RangeConcat;
354
355 template <bool forever>
356 class Cycle;
357
358 class Batch;
359
360 class Dereference;
361
362 class Indirect;
363
364 /*
365  * Sinks
366  */
367 template <class Seed, class Fold>
368 class FoldLeft;
369
370 class First;
371
372 template <bool result>
373 class IsEmpty;
374
375 template <class Reducer>
376 class Reduce;
377
378 class Sum;
379
380 template <class Selector, class Comparer>
381 class Min;
382
383 template <class Container>
384 class Collect;
385
386 template <
387     template <class, class> class Collection = std::vector,
388     template <class> class Allocator = std::allocator>
389 class CollectTemplate;
390
391 template <class Collection>
392 class Append;
393
394 template <class Value>
395 struct GeneratorBuilder;
396
397 template <class Needle>
398 class Contains;
399
400 template <class Exception, class ErrorHandler>
401 class GuardImpl;
402
403 template <class T>
404 class UnwrapOr;
405
406 class Unwrap;
407
408 }
409
410 /**
411  * Polymorphic wrapper
412  **/
413 template <class Value>
414 class VirtualGen;
415
416 /*
417  * Source Factories
418  */
419 template <
420     class Container,
421     class From = detail::ReferencedSource<const Container>>
422 From fromConst(const Container& source) {
423   return From(&source);
424 }
425
426 template <class Container, class From = detail::ReferencedSource<Container>>
427 From from(Container& source) {
428   return From(&source);
429 }
430
431 template <
432     class Container,
433     class Value = typename detail::ValueTypeOfRange<Container>::StorageType,
434     class CopyOf = detail::CopiedSource<Value>>
435 CopyOf fromCopy(Container&& source) {
436   return CopyOf(std::forward<Container>(source));
437 }
438
439 template <class Value, class From = detail::CopiedSource<Value>>
440 From from(std::initializer_list<Value> source) {
441   return From(source);
442 }
443
444 template <
445     class Container,
446     class From =
447         detail::CopiedSource<typename Container::value_type, Container>>
448 From from(Container&& source) {
449   return From(std::move(source));
450 }
451
452 template <
453     class Value,
454     class Impl = detail::RangeImpl<Value>,
455     class Gen = detail::Sequence<Value, Impl>>
456 Gen range(Value begin, Value end) {
457   return Gen{std::move(begin), Impl{std::move(end)}};
458 }
459
460 template <
461     class Value,
462     class Distance,
463     class Impl = detail::RangeWithStepImpl<Value, Distance>,
464     class Gen = detail::Sequence<Value, Impl>>
465 Gen range(Value begin, Value end, Distance step) {
466   return Gen{std::move(begin), Impl{std::move(end), std::move(step)}};
467 }
468
469 template <
470     class Value,
471     class Impl = detail::SeqImpl<Value>,
472     class Gen = detail::Sequence<Value, Impl>>
473 Gen seq(Value first, Value last) {
474   return Gen{std::move(first), Impl{std::move(last)}};
475 }
476
477 template <
478     class Value,
479     class Distance,
480     class Impl = detail::SeqWithStepImpl<Value, Distance>,
481     class Gen = detail::Sequence<Value, Impl>>
482 Gen seq(Value first, Value last, Distance step) {
483   return Gen{std::move(first), Impl{std::move(last), std::move(step)}};
484 }
485
486 template <
487     class Value,
488     class Impl = detail::InfiniteImpl<Value>,
489     class Gen = detail::Sequence<Value, Impl>>
490 Gen seq(Value first) {
491   return Gen{std::move(first), Impl{}};
492 }
493
494 template <class Value, class Source, class Yield = detail::Yield<Value, Source>>
495 Yield generator(Source&& source) {
496   return Yield(std::forward<Source>(source));
497 }
498
499 /*
500  * Create inline generator, used like:
501  *
502  *  auto gen = GENERATOR(int) { yield(1); yield(2); };
503  */
504 #define GENERATOR(TYPE)                            \
505   ::folly::gen::detail::GeneratorBuilder<TYPE>() + \
506    [=](const std::function<void(TYPE)>& yield)
507
508 /*
509  * empty() - for producing empty sequences.
510  */
511 template <class Value>
512 detail::Empty<Value> empty() {
513   return {};
514 }
515
516 template <
517     class Value,
518     class Just = typename std::conditional<
519         std::is_reference<Value>::value,
520         detail::SingleReference<typename std::remove_reference<Value>::type>,
521         detail::SingleCopy<Value>>::type>
522 Just just(Value&& value) {
523   return Just(std::forward<Value>(value));
524 }
525
526 /*
527  * Operator Factories
528  */
529 template <class Predicate, class Map = detail::Map<Predicate>>
530 Map mapped(Predicate pred = Predicate()) {
531   return Map(std::move(pred));
532 }
533
534 template <class Predicate, class Map = detail::Map<Predicate>>
535 Map map(Predicate pred = Predicate()) {
536   return Map(std::move(pred));
537 }
538
539 /**
540  * mapOp - Given a generator of generators, maps the application of the given
541  * operator on to each inner gen. Especially useful in aggregating nested data
542  * structures:
543  *
544  *   chunked(samples, 256)
545  *     | mapOp(filter(sampleTest) | count)
546  *     | sum;
547  */
548 template <class Operator, class Map = detail::Map<detail::Composer<Operator>>>
549 Map mapOp(Operator op) {
550   return Map(detail::Composer<Operator>(std::move(op)));
551 }
552
553 /*
554  * member(...) - For extracting a member from each value.
555  *
556  *  vector<string> strings = ...;
557  *  auto sizes = from(strings) | member(&string::size);
558  *
559  * If a member is const overridden (like 'front()'), pass template parameter
560  * 'Const' to select the const version, or 'Mutable' to select the non-const
561  * version:
562  *
563  *  auto heads = from(strings) | member<Const>(&string::front);
564  */
565 enum MemberType {
566   Const,
567   Mutable
568 };
569
570 /**
571  * These exist because MSVC has problems with expression SFINAE in templates
572  * assignment and comparisons don't work properly without being pulled out
573  * of the template declaration
574  */
575 template <MemberType Constness>
576 struct ExprIsConst {
577   enum {
578     value = Constness == Const
579   };
580 };
581
582 template <MemberType Constness>
583 struct ExprIsMutable {
584   enum {
585     value = Constness == Mutable
586   };
587 };
588
589 template <
590     MemberType Constness = Const,
591     class Class,
592     class Return,
593     class Mem = ConstMemberFunction<Class, Return>,
594     class Map = detail::Map<Mem>>
595 typename std::enable_if<ExprIsConst<Constness>::value, Map>::type
596 member(Return (Class::*member)() const) {
597   return Map(Mem(member));
598 }
599
600 template <
601     MemberType Constness = Mutable,
602     class Class,
603     class Return,
604     class Mem = MemberFunction<Class, Return>,
605     class Map = detail::Map<Mem>>
606 typename std::enable_if<ExprIsMutable<Constness>::value, Map>::type
607 member(Return (Class::*member)()) {
608   return Map(Mem(member));
609 }
610
611 /*
612  * field(...) - For extracting a field from each value.
613  *
614  *  vector<Item> items = ...;
615  *  auto names = from(items) | field(&Item::name);
616  *
617  * Note that if the values of the generator are rvalues, any non-reference
618  * fields will be rvalues as well. As an example, the code below does not copy
619  * any strings, only moves them:
620  *
621  *  auto namesVector = from(items)
622  *                   | move
623  *                   | field(&Item::name)
624  *                   | as<vector>();
625  */
626 template <
627     class Class,
628     class FieldType,
629     class Field = Field<Class, FieldType>,
630     class Map = detail::Map<Field>>
631 Map field(FieldType Class::*field) {
632   return Map(Field(field));
633 }
634
635 template <class Predicate = Identity, class Filter = detail::Filter<Predicate>>
636 Filter filter(Predicate pred = Predicate()) {
637   return Filter(std::move(pred));
638 }
639
640 template <class Visitor = Ignore, class Visit = detail::Visit<Visitor>>
641 Visit visit(Visitor visitor = Visitor()) {
642   return Visit(std::move(visitor));
643 }
644
645 template <class Predicate, class Until = detail::Until<Predicate>>
646 Until until(Predicate pred = Predicate()) {
647   return Until(std::move(pred));
648 }
649
650 template <
651     class Selector = Identity,
652     class Comparer = Less,
653     class Order = detail::Order<Selector, Comparer>>
654 Order orderBy(Selector selector = Selector(),
655               Comparer comparer = Comparer()) {
656   return Order(std::move(selector),
657                std::move(comparer));
658 }
659
660 template <
661     class Selector = Identity,
662     class Order = detail::Order<Selector, Greater>>
663 Order orderByDescending(Selector selector = Selector()) {
664   return Order(std::move(selector));
665 }
666
667 template <class Selector = Identity, class GroupBy = detail::GroupBy<Selector>>
668 GroupBy groupBy(Selector selector = Selector()) {
669   return GroupBy(std::move(selector));
670 }
671
672 template <
673     class Selector = Identity,
674     class Distinct = detail::Distinct<Selector>>
675 Distinct distinctBy(Selector selector = Selector()) {
676   return Distinct(std::move(selector));
677 }
678
679 template <int n, class Get = detail::Map<Get<n>>>
680 Get get() {
681   return Get();
682 }
683
684 // construct Dest from each value
685 template <class Dest, class Cast = detail::Map<Cast<Dest>>>
686 Cast eachAs() {
687   return Cast();
688 }
689
690 // call folly::to on each value
691 template <class Dest, class To = detail::Map<To<Dest>>>
692 To eachTo() {
693   return To();
694 }
695
696 template <class Value>
697 detail::TypeAssertion<Value> assert_type() {
698   return {};
699 }
700
701 /*
702  * Sink Factories
703  */
704
705 /**
706  * any() - For determining if any value in a sequence satisfies a predicate.
707  *
708  * The following is an example for checking if any computer is broken:
709  *
710  *   bool schrepIsMad = from(computers) | any(isBroken);
711  *
712  * (because everyone knows Schrep hates broken computers).
713  *
714  * Note that if no predicate is provided, 'any()' checks if any of the values
715  * are true when cased to bool. To check if any of the scores are nonZero:
716  *
717  *   bool somebodyScored = from(scores) | any();
718  *
719  * Note: Passing an empty sequence through 'any()' will always return false. In
720  * fact, 'any()' is equivilent to the composition of 'filter()' and 'notEmpty'.
721  *
722  *   from(source) | any(pred) == from(source) | filter(pred) | notEmpty
723  */
724
725 template <
726     class Predicate = Identity,
727     class Filter = detail::Filter<Predicate>,
728     class NotEmpty = detail::IsEmpty<false>,
729     class Composed = detail::Composed<Filter, NotEmpty>>
730 Composed any(Predicate pred = Predicate()) {
731   return Composed(Filter(std::move(pred)), NotEmpty());
732 }
733
734 /**
735  * all() - For determining whether all values in a sequence satisfy a predicate.
736  *
737  * The following is an example for checking if all members of a team are cool:
738  *
739  *   bool isAwesomeTeam = from(team) | all(isCool);
740  *
741  * Note that if no predicate is provided, 'all()'' checks if all of the values
742  * are true when cased to bool.
743  * The following makes sure none of 'pointers' are nullptr:
744  *
745  *   bool allNonNull = from(pointers) | all();
746  *
747  * Note: Passing an empty sequence through 'all()' will always return true. In
748  * fact, 'all()' is equivilent to the composition of 'filter()' with the
749  * reversed predicate and 'isEmpty'.
750  *
751  *   from(source) | all(pred) == from(source) | filter(negate(pred)) | isEmpty
752  */
753 template <
754     class Predicate = Identity,
755     class Filter = detail::Filter<Negate<Predicate>>,
756     class IsEmpty = detail::IsEmpty<true>,
757     class Composed = detail::Composed<Filter, IsEmpty>>
758 Composed all(Predicate pred = Predicate()) {
759   return Composed(Filter(std::move(negate(pred))), IsEmpty());
760 }
761
762 template <class Seed, class Fold, class FoldLeft = detail::FoldLeft<Seed, Fold>>
763 FoldLeft foldl(Seed seed = Seed(),
764                Fold fold = Fold()) {
765   return FoldLeft(std::move(seed),
766                   std::move(fold));
767 }
768
769 template <class Reducer, class Reduce = detail::Reduce<Reducer>>
770 Reduce reduce(Reducer reducer = Reducer()) {
771   return Reduce(std::move(reducer));
772 }
773
774 template <class Selector = Identity, class Min = detail::Min<Selector, Less>>
775 Min minBy(Selector selector = Selector()) {
776   return Min(std::move(selector));
777 }
778
779 template <class Selector, class MaxBy = detail::Min<Selector, Greater>>
780 MaxBy maxBy(Selector selector = Selector()) {
781   return MaxBy(std::move(selector));
782 }
783
784 template <class Collection, class Collect = detail::Collect<Collection>>
785 Collect as() {
786   return Collect();
787 }
788
789 template <
790     template <class, class> class Container = std::vector,
791     template <class> class Allocator = std::allocator,
792     class Collect = detail::CollectTemplate<Container, Allocator>>
793 Collect as() {
794   return Collect();
795 }
796
797 template <class Collection, class Append = detail::Append<Collection>>
798 Append appendTo(Collection& collection) {
799   return Append(&collection);
800 }
801
802 template <
803     class Needle,
804     class Contains = detail::Contains<typename std::decay<Needle>::type>>
805 Contains contains(Needle&& needle) {
806   return Contains(std::forward<Needle>(needle));
807 }
808
809 template <
810     class Exception,
811     class ErrorHandler,
812     class GuardImpl =
813         detail::GuardImpl<Exception, typename std::decay<ErrorHandler>::type>>
814 GuardImpl guard(ErrorHandler&& handler) {
815   return GuardImpl(std::forward<ErrorHandler>(handler));
816 }
817
818 template <
819     class Fallback,
820     class UnwrapOr = detail::UnwrapOr<typename std::decay<Fallback>::type>>
821 UnwrapOr unwrapOr(Fallback&& fallback) {
822   return UnwrapOr(std::forward<Fallback>(fallback));
823 }
824
825 } // namespace gen
826 } // namespace folly
827
828 #include <folly/gen/Base-inl.h>