-
Notifications
You must be signed in to change notification settings - Fork 928
/
common.h
2233 lines (1933 loc) · 81.2 KB
/
common.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
// Licensed under the MIT License:
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
// Header that should be #included by everyone.
//
// This defines very simple utilities that are widely applicable.
#pragma once
#if defined(__GNUC__) || defined(__clang__)
#define KJ_BEGIN_SYSTEM_HEADER _Pragma("GCC system_header")
#elif defined(_MSC_VER)
#define KJ_BEGIN_SYSTEM_HEADER __pragma(warning(push, 0))
#define KJ_END_SYSTEM_HEADER __pragma(warning(pop))
#endif
#ifndef KJ_BEGIN_SYSTEM_HEADER
#define KJ_BEGIN_SYSTEM_HEADER
#endif
#ifndef KJ_END_SYSTEM_HEADER
#define KJ_END_SYSTEM_HEADER
#endif
#if !defined(KJ_HEADER_WARNINGS) || !KJ_HEADER_WARNINGS
#define KJ_BEGIN_HEADER KJ_BEGIN_SYSTEM_HEADER
#define KJ_END_HEADER KJ_END_SYSTEM_HEADER
#else
#define KJ_BEGIN_HEADER
#define KJ_END_HEADER
#endif
#ifdef __has_cpp_attribute
#define KJ_HAS_CPP_ATTRIBUTE(x) __has_cpp_attribute(x)
#else
#define KJ_HAS_CPP_ATTRIBUTE(x) 0
#endif
#ifdef __has_feature
#define KJ_HAS_COMPILER_FEATURE(x) __has_feature(x)
#else
#define KJ_HAS_COMPILER_FEATURE(x) 0
#endif
KJ_BEGIN_HEADER
#ifndef KJ_NO_COMPILER_CHECK
#if __cplusplus < 202002L && !__CDT_PARSER__
#error "This code requires C++20. Either your compiler does not support it or it is not enabled."
#ifdef __GNUC__
// Compiler claims compatibility with GCC, so presumably supports -std.
#error "Pass -std=c++20 on the compiler command line to enable C++20."
#endif
#endif
#ifdef __GNUC__
#if __clang__
#if __clang_major__ < 14
#warning "This library requires at least Clang 14.0."
#endif
#if __cplusplus >= 202002L && !(__has_include(<coroutine>) || __has_include(<experimental/coroutine>))
#warning "Your compiler supports C++20 but your C++ standard library does not. If your "\
"system has libc++ installed (as should be the case on e.g. Mac OSX), try adding "\
"-stdlib=libc++ to your CXXFLAGS."
#endif
#else
#error "This library does not currently support GCC due to https://gcc.gnu.org/bugzilla/show_bug.cgi?id=102051."
// #if __GNUC__ < 10
// #warning "This library requires at least GCC 10.0."
// #endif
#endif
#elif defined(_MSC_VER)
#if _MSC_VER < 1930 && !defined(__clang__)
#error "You need Visual Studio 2022 or better to compile this code."
#endif
#else
#warning "I don't recognize your compiler. As of this writing, Clang, GCC, and Visual Studio "\
"are the only known compilers with enough C++20 support for this library. "\
"#define KJ_NO_COMPILER_CHECK to make this warning go away."
#endif
#endif
#include <stddef.h>
#include <cstring>
#include <initializer_list>
#include <string.h>
#if _WIN32
// Windows likes to define macros for min() and max(). We just can't deal with this.
// If windows.h was included already, undef these.
#undef min
#undef max
// If windows.h was not included yet, define the macro that prevents min() and max() from being
// defined.
#ifndef NOMINMAX
#define NOMINMAX 1
#endif
#endif
#if defined(_MSC_VER)
#include <intrin.h> // __popcnt
#endif
// =======================================================================================
namespace kj {
typedef unsigned int uint;
typedef unsigned char byte;
// =======================================================================================
// Common macros, especially for common yet compiler-specific features.
// Detect whether RTTI and exceptions are enabled, assuming they are unless we have specific
// evidence to the contrary. Clients can always define KJ_NO_RTTI explicitly to override the
// check. As of version 2, exceptions are required, so this produces an error otherwise.
// TODO: Ideally we'd use __cpp_exceptions/__cpp_rtti not being defined as the first pass since
// that is the standard compliant way. However, it's unclear how to use those macros (or any
// others) to distinguish between the compiler supporting feature detection and the feature being
// disabled vs the compiler not supporting feature detection at all.
#if defined(__has_feature)
#if !defined(KJ_NO_RTTI) && !__has_feature(cxx_rtti)
#define KJ_NO_RTTI 1
#endif
#if !__has_feature(cxx_exceptions)
#error "KJ requires C++ exceptions, please enable them"
#endif
#elif defined(__GNUC__)
#if !defined(KJ_NO_RTTI) && !__GXX_RTTI
#define KJ_NO_RTTI 1
#endif
#if !__EXCEPTIONS
#error "KJ requires C++ exceptions, please enable them"
#endif
#elif defined(_MSC_VER)
#if !defined(KJ_NO_RTTI) && !defined(_CPPRTTI)
#define KJ_NO_RTTI 1
#endif
#if !defined(_CPPUNWIND)
#error "KJ requires C++ exceptions, please enable them"
#endif
#endif
#if !defined(KJ_DEBUG) && !defined(KJ_NDEBUG)
// Heuristically decide whether to enable debug mode. If DEBUG or NDEBUG is defined, use that.
// Otherwise, fall back to checking whether optimization is enabled.
#if defined(DEBUG) || defined(_DEBUG)
#define KJ_DEBUG
#elif defined(NDEBUG)
#define KJ_NDEBUG
#elif __OPTIMIZE__
#define KJ_NDEBUG
#else
#define KJ_DEBUG
#endif
#endif
#define KJ_DISALLOW_COPY(classname) \
classname(const classname&) = delete; \
classname& operator=(const classname&) = delete
// Deletes the implicit copy constructor and assignment operator. This inhibits the compiler from
// generating the implicit move constructor and assignment operator for this class, but allows the
// code author to supply them, if they make sense to implement.
//
// This macro should not be your first choice. Instead, prefer using KJ_DISALLOW_COPY_AND_MOVE, and only use
// this macro when you have determined that you must implement move semantics for your type.
#define KJ_DISALLOW_COPY_AND_MOVE(classname) \
classname(const classname&) = delete; \
classname& operator=(const classname&) = delete; \
classname(classname&&) = delete; \
classname& operator=(classname&&) = delete
// Deletes the implicit copy and move constructors and assignment operators. This is useful in cases
// where the code author wants to provide an additional compile-time guard against subsequent
// maintainers casually adding move operations. This is particularly useful when implementing RAII
// classes that are intended to be completely immobile.
#ifdef __GNUC__
#define KJ_LIKELY(condition) __builtin_expect(condition, true)
#define KJ_UNLIKELY(condition) __builtin_expect(condition, false)
// Branch prediction macros. Evaluates to the condition given, but also tells the compiler that we
// expect the condition to be true/false enough of the time that it's worth hard-coding branch
// prediction.
#else
#define KJ_LIKELY(condition) (condition)
#define KJ_UNLIKELY(condition) (condition)
#endif
#if defined(KJ_DEBUG) || __NO_INLINE__
#define KJ_ALWAYS_INLINE(...) inline __VA_ARGS__
// Don't force inline in debug mode.
#else
#if defined(_MSC_VER) && !defined(__clang__)
#define KJ_ALWAYS_INLINE(...) __forceinline __VA_ARGS__
#else
#define KJ_ALWAYS_INLINE(...) inline __VA_ARGS__ __attribute__((always_inline))
#endif
// Force a function to always be inlined. Apply only to the prototype, not to the definition.
#endif
#if defined(_MSC_VER) && !defined(__clang__)
#define KJ_NOINLINE __declspec(noinline)
#else
#define KJ_NOINLINE __attribute__((noinline))
#endif
#if defined(_MSC_VER) && !__clang__
#define KJ_NORETURN(prototype) __declspec(noreturn) prototype
#define KJ_UNUSED
#define KJ_WARN_UNUSED_RESULT
// TODO(msvc): KJ_WARN_UNUSED_RESULT can use _Check_return_ on MSVC, but it's a prefix, so
// wrapping the whole prototype is needed. http://msdn.microsoft.com/en-us/library/jj159529.aspx
// Similarly, KJ_UNUSED could use __pragma(warning(suppress:...)), but again that's a prefix.
#else
#define KJ_NORETURN(prototype) prototype __attribute__((noreturn))
#define KJ_UNUSED __attribute__((unused))
#define KJ_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
#endif
#if KJ_HAS_CPP_ATTRIBUTE(clang::lifetimebound)
// If this is generating too many false-positives, the user is responsible for disabling the
// problematic warning at the compiler switch level or by suppressing the place where the
// false-positive is reported through compiler-specific pragmas if available.
#define KJ_LIFETIMEBOUND [[clang::lifetimebound]]
#else
#define KJ_LIFETIMEBOUND
#endif
// Annotation that indicates the returned value is referencing a resource owned by this type (e.g.
// cStr() on a std::string). Unfortunately this lifetime can only be superficial currently & cannot
// track further. For example, there's no way to get `array.asPtr().slice(5, 6))` to warn if the
// last slice exceeds the lifetime of `array`. That's because in the general case `ArrayPtr::slice`
// can't have the lifetime bound annotation since it's not wrong to do something like:
// ArrayPtr<char> doSomething(ArrayPtr<char> foo) {
// ...
// return foo.slice(5, 6);
// }
// If `ArrayPtr::slice` had a lifetime bound then the compiler would warn about this perfectly
// legitimate method. Really there needs to be 2 more annotations. One to inherit the lifetime bound
// and another to inherit the lifetime bound from a parameter (which really could be the same thing
// by allowing a syntax like `[[clang::lifetimebound(*this)]]`.
// https://clang.llvm.org/docs/AttributeReference.html#lifetimebound
#if KJ_HAS_CPP_ATTRIBUTE(clang::musttail)
#define KJ_MUSTTAIL [[clang::musttail]]
#else
#define KJ_MUSTTAIL
#endif
// Annotation for "return" statements to require that they be compiled as tail calls.
// https://clang.llvm.org/docs/AttributeReference.html#musttail
#if __clang__
#define KJ_UNUSED_MEMBER __attribute__((unused))
// Inhibits "unused" warning for member variables. Only Clang produces such a warning, while GCC
// complains if the attribute is set on members.
#else
#define KJ_UNUSED_MEMBER
#endif
#define KJ_NO_UNIQUE_ADDRESS [[no_unique_address]]
#if KJ_HAS_COMPILER_FEATURE(thread_sanitizer) || defined(__SANITIZE_THREAD__)
#define KJ_DISABLE_TSAN __attribute__((no_sanitize("thread"), noinline))
#else
#define KJ_DISABLE_TSAN
#endif
#if __clang__
#define KJ_DEPRECATED(reason) \
__attribute__((deprecated(reason)))
#define KJ_UNAVAILABLE(reason) \
__attribute__((unavailable(reason)))
#elif __GNUC__
#define KJ_DEPRECATED(reason) \
__attribute__((deprecated))
#define KJ_UNAVAILABLE(reason) = delete
// If the `unavailable` attribute is not supported, just mark the method deleted, which at least
// makes it a compile-time error to try to call it. Note that on Clang, marking a method deleted
// *and* unavailable unfortunately defeats the purpose of the unavailable annotation, as the
// generic "deleted" error is reported instead.
#else
#define KJ_DEPRECATED(reason)
#define KJ_UNAVAILABLE(reason) = delete
// TODO(msvc): Again, here, MSVC prefers a prefix, __declspec(deprecated).
#endif
#if KJ_TESTING_KJ // defined in KJ's own unit tests; others should not define this
#undef KJ_DEPRECATED
#define KJ_DEPRECATED(reason)
#endif
namespace _ { // private
KJ_NORETURN(void inlineRequireFailure(
const char* file, int line, const char* expectation, const char* macroArgs,
const char* message = nullptr));
KJ_NORETURN(void unreachable());
} // namespace _ (private)
#ifdef KJ_DEBUG
#if _MSC_VER && !defined(__clang__) && (!defined(_MSVC_TRADITIONAL) || _MSVC_TRADITIONAL)
#define KJ_MSVC_TRADITIONAL_CPP 1
#endif
#if KJ_MSVC_TRADITIONAL_CPP
#define KJ_IREQUIRE(condition, ...) \
if (KJ_LIKELY(condition)); else ::kj::_::inlineRequireFailure( \
__FILE__, __LINE__, #condition, "" #__VA_ARGS__, __VA_ARGS__)
// Version of KJ_DREQUIRE() which is safe to use in headers that are #included by users. Used to
// check preconditions inside inline methods. KJ_IREQUIRE is particularly useful in that
// it will be enabled depending on whether the application is compiled in debug mode rather than
// whether libkj is.
#else
#define KJ_IREQUIRE(condition, ...) \
if (KJ_LIKELY(condition)); else ::kj::_::inlineRequireFailure( \
__FILE__, __LINE__, #condition, #__VA_ARGS__, ##__VA_ARGS__)
// Version of KJ_DREQUIRE() which is safe to use in headers that are #included by users. Used to
// check preconditions inside inline methods. KJ_IREQUIRE is particularly useful in that
// it will be enabled depending on whether the application is compiled in debug mode rather than
// whether libkj is.
#endif
#else
#define KJ_IREQUIRE(condition, ...)
#endif
#define KJ_IASSERT KJ_IREQUIRE
#define KJ_UNREACHABLE ::kj::_::unreachable();
// Put this on code paths that cannot be reached to suppress compiler warnings about missing
// returns.
#if __clang__
#define KJ_CLANG_KNOWS_THIS_IS_UNREACHABLE_BUT_GCC_DOESNT
#else
#define KJ_CLANG_KNOWS_THIS_IS_UNREACHABLE_BUT_GCC_DOESNT KJ_UNREACHABLE
#endif
#if __clang__
#define KJ_KNOWN_UNREACHABLE(code) \
do { \
_Pragma("clang diagnostic push") \
_Pragma("clang diagnostic ignored \"-Wunreachable-code\"") \
code; \
_Pragma("clang diagnostic pop") \
} while (false)
// Suppress "unreachable code" warnings on intentionally unreachable code.
#else
// TODO(someday): Add support for non-clang compilers.
#define KJ_KNOWN_UNREACHABLE(code) do {code;} while(false)
#endif
#if KJ_HAS_CPP_ATTRIBUTE(fallthrough)
#define KJ_FALLTHROUGH [[fallthrough]]
#else
#define KJ_FALLTHROUGH
#endif
// #define KJ_STACK_ARRAY(type, name, size, minStack, maxStack)
//
// Allocate an array, preferably on the stack, unless it is too big. On GCC this will use
// variable-sized arrays. For other compilers we could just use a fixed-size array. `minStack`
// is the stack array size to use if variable-width arrays are not supported. `maxStack` is the
// maximum stack array size if variable-width arrays *are* supported.
#if __GNUC__ && !__clang__
#define KJ_STACK_ARRAY(type, name, size, minStack, maxStack) \
size_t name##_size = (size); \
bool name##_isOnStack = name##_size <= (maxStack); \
type name##_stack[kj::max(1, name##_isOnStack ? name##_size : 0)]; \
::kj::Array<type> name##_heap = name##_isOnStack ? \
nullptr : kj::heapArray<type>(name##_size); \
::kj::ArrayPtr<type> name = name##_isOnStack ? \
kj::arrayPtr(name##_stack, name##_size) : name##_heap
#else
#define KJ_STACK_ARRAY(type, name, size, minStack, maxStack) \
size_t name##_size = (size); \
bool name##_isOnStack = name##_size <= (minStack); \
type name##_stack[minStack]; \
::kj::Array<type> name##_heap = name##_isOnStack ? \
nullptr : kj::heapArray<type>(name##_size); \
::kj::ArrayPtr<type> name = name##_isOnStack ? \
kj::arrayPtr(name##_stack, name##_size) : name##_heap
#endif
#define KJ_CONCAT_(x, y) x##y
#define KJ_CONCAT(x, y) KJ_CONCAT_(x, y)
#define KJ_UNIQUE_NAME(prefix) KJ_CONCAT(prefix, __LINE__)
// Create a unique identifier name. We use concatenate __LINE__ rather than __COUNTER__ so that
// the name can be used multiple times in the same macro.
#if _MSC_VER && !defined(__clang__)
#define KJ_CONSTEXPR(...) __VA_ARGS__
// Use in cases where MSVC barfs on constexpr. A replacement keyword (e.g. "const") can be
// provided, or just leave blank to remove the keyword entirely.
//
// TODO(msvc): Remove this hack once MSVC fully supports constexpr.
#ifndef __restrict__
#define __restrict__ __restrict
// TODO(msvc): Would it be better to define a KJ_RESTRICT macro?
#endif
#pragma warning(disable: 4521 4522)
// This warning complains when there are two copy constructors, one for a const reference and
// one for a non-const reference. It is often quite necessary to do this in wrapper templates,
// therefore this warning is dumb and we disable it.
#pragma warning(disable: 4458)
// Warns when a parameter name shadows a class member. Unfortunately my code does this a lot,
// since I don't use a special name format for members.
#else // _MSC_VER
#define KJ_CONSTEXPR(...) constexpr
#endif
// =======================================================================================
// Template metaprogramming helpers.
#define KJ_HAS_TRIVIAL_CONSTRUCTOR __is_trivially_constructible
#if __GNUC__ && !__clang__
#define KJ_HAS_NOTHROW_CONSTRUCTOR __has_nothrow_constructor
#define KJ_HAS_TRIVIAL_DESTRUCTOR __has_trivial_destructor
#else
#define KJ_HAS_NOTHROW_CONSTRUCTOR __is_nothrow_constructible
#define KJ_HAS_TRIVIAL_DESTRUCTOR __is_trivially_destructible
#endif
template <typename T> struct NoInfer_ { typedef T Type; };
template <typename T> using NoInfer = typename NoInfer_<T>::Type;
// Use NoInfer<T>::Type in place of T for a template function parameter to prevent inference of
// the type based on the parameter value.
template <typename T> struct RemoveConst_ { typedef T Type; };
template <typename T> struct RemoveConst_<const T> { typedef T Type; };
template <typename T> using RemoveConst = typename RemoveConst_<T>::Type;
template <typename> struct IsLvalueReference_ { static constexpr bool value = false; };
template <typename T> struct IsLvalueReference_<T&> { static constexpr bool value = true; };
template <typename T>
inline constexpr bool isLvalueReference() { return IsLvalueReference_<T>::value; }
template <typename T> struct Decay_ { typedef T Type; };
template <typename T> struct Decay_<T&> { typedef typename Decay_<T>::Type Type; };
template <typename T> struct Decay_<T&&> { typedef typename Decay_<T>::Type Type; };
template <typename T> struct Decay_<T[]> { typedef typename Decay_<T*>::Type Type; };
template <typename T> struct Decay_<const T[]> { typedef typename Decay_<const T*>::Type Type; };
template <typename T, size_t s> struct Decay_<T[s]> { typedef typename Decay_<T*>::Type Type; };
template <typename T, size_t s> struct Decay_<const T[s]> { typedef typename Decay_<const T*>::Type Type; };
template <typename T> struct Decay_<const T> { typedef typename Decay_<T>::Type Type; };
template <typename T> struct Decay_<volatile T> { typedef typename Decay_<T>::Type Type; };
template <typename T> using Decay = typename Decay_<T>::Type;
template <bool b> struct EnableIf_;
template <> struct EnableIf_<true> { typedef void Type; };
template <bool b> using EnableIf = typename EnableIf_<b>::Type;
// Use like:
//
// template <typename T, typename = EnableIf<isValid<T>()>>
// void func(T&& t);
template <typename...> struct VoidSfinae_ { using Type = void; };
template <typename... Ts> using VoidSfinae = typename VoidSfinae_<Ts...>::Type;
// Note: VoidSfinae is std::void_t from C++17.
template <typename T>
T instance() noexcept;
// Like std::declval, but doesn't transform T into an rvalue reference. If you want that, specify
// instance<T&&>().
struct DisallowConstCopy {
// Inherit from this, or declare a member variable of this type, to prevent the class from being
// copyable from a const reference -- instead, it will only be copyable from non-const references.
// This is useful for enforcing transitive constness of contained pointers.
//
// For example, say you have a type T which contains a pointer. T has non-const methods which
// modify the value at that pointer, but T's const methods are designed to allow reading only.
// Unfortunately, if T has a regular copy constructor, someone can simply make a copy of T and
// then use it to modify the pointed-to value. However, if T inherits DisallowConstCopy, then
// callers will only be able to copy non-const instances of T. Ideally, there is some
// parallel type ImmutableT which is like a version of T that only has const methods, and can
// be copied from a const T.
//
// Note that due to C++ rules about implicit copy constructors and assignment operators, any
// type that contains or inherits from a type that disallows const copies will also automatically
// disallow const copies. Hey, cool, that's exactly what we want.
#if CAPNP_DEBUG_TYPES
// Alas! Declaring a defaulted non-const copy constructor tickles a bug which causes GCC and
// Clang to disagree on ABI, using different calling conventions to pass this type, leading to
// immediate segfaults. See:
// https://bugs.llvm.org/show_bug.cgi?id=23764
// https://gcc.gnu.org/bugzilla/show_bug.cgi?id=58074
//
// Because of this, we can't use this technique. We guard it by CAPNP_DEBUG_TYPES so that it
// still applies to the Cap'n Proto developers during internal testing.
DisallowConstCopy() = default;
DisallowConstCopy(DisallowConstCopy&) = default;
DisallowConstCopy(DisallowConstCopy&&) = default;
DisallowConstCopy& operator=(DisallowConstCopy&) = default;
DisallowConstCopy& operator=(DisallowConstCopy&&) = default;
#endif
};
#if _MSC_VER && !defined(__clang__)
#define KJ_CPCAP(obj) obj=::kj::cp(obj)
// TODO(msvc): MSVC refuses to invoke non-const versions of copy constructors in by-value lambda
// captures. Wrap your captured object in this macro to force the compiler to perform a copy.
// Example:
//
// struct Foo: DisallowConstCopy {};
// Foo foo;
// auto lambda = [KJ_CPCAP(foo)] {};
#else
#define KJ_CPCAP(obj) obj
// Clang and gcc both already perform copy capturing correctly with non-const copy constructors.
#endif
template <typename T>
struct DisallowConstCopyIfNotConst: public DisallowConstCopy {
// Inherit from this when implementing a template that contains a pointer to T and which should
// enforce transitive constness. If T is a const type, this has no effect. Otherwise, it is
// an alias for DisallowConstCopy.
};
template <typename T>
struct DisallowConstCopyIfNotConst<const T> {};
template <typename T> struct IsConst_ { static constexpr bool value = false; };
template <typename T> struct IsConst_<const T> { static constexpr bool value = true; };
template <typename T> constexpr bool isConst() { return IsConst_<T>::value; }
template <typename T> struct EnableIfNotConst_ { typedef T Type; };
template <typename T> struct EnableIfNotConst_<const T>;
template <typename T> using EnableIfNotConst = typename EnableIfNotConst_<T>::Type;
template <typename T> struct EnableIfConst_;
template <typename T> struct EnableIfConst_<const T> { typedef T Type; };
template <typename T> using EnableIfConst = typename EnableIfConst_<T>::Type;
template <typename T> struct RemoveConstOrDisable_ { struct Type; };
template <typename T> struct RemoveConstOrDisable_<const T> { typedef T Type; };
template <typename T> using RemoveConstOrDisable = typename RemoveConstOrDisable_<T>::Type;
template <typename T> struct IsReference_ { static constexpr bool value = false; };
template <typename T> struct IsReference_<T&> { static constexpr bool value = true; };
template <typename T> constexpr bool isReference() { return IsReference_<T>::value; }
template <typename From, typename To>
struct PropagateConst_ { typedef To Type; };
template <typename From, typename To>
struct PropagateConst_<const From, To> { typedef const To Type; };
template <typename From, typename To>
using PropagateConst = typename PropagateConst_<From, To>::Type;
namespace _ { // private
template <typename T>
T refIfLvalue(T&&);
} // namespace _ (private)
#define KJ_DECLTYPE_REF(exp) decltype(::kj::_::refIfLvalue(exp))
// Like decltype(exp), but if exp is an lvalue, produces a reference type.
//
// int i;
// decltype(i) i1(i); // i1 has type int.
// KJ_DECLTYPE_REF(i + 1) i2(i + 1); // i2 has type int.
// KJ_DECLTYPE_REF(i) i3(i); // i3 has type int&.
// KJ_DECLTYPE_REF(kj::mv(i)) i4(kj::mv(i)); // i4 has type int.
template <typename T, typename U> struct IsSameType_ { static constexpr bool value = false; };
template <typename T> struct IsSameType_<T, T> { static constexpr bool value = true; };
template <typename T, typename U> constexpr bool isSameType() { return IsSameType_<T, U>::value; }
template <typename T> constexpr bool isIntegral() { return false; }
template <> constexpr bool isIntegral<char>() { return true; }
template <> constexpr bool isIntegral<signed char>() { return true; }
template <> constexpr bool isIntegral<short>() { return true; }
template <> constexpr bool isIntegral<int>() { return true; }
template <> constexpr bool isIntegral<long>() { return true; }
template <> constexpr bool isIntegral<long long>() { return true; }
template <> constexpr bool isIntegral<unsigned char>() { return true; }
template <> constexpr bool isIntegral<unsigned short>() { return true; }
template <> constexpr bool isIntegral<unsigned int>() { return true; }
template <> constexpr bool isIntegral<unsigned long>() { return true; }
template <> constexpr bool isIntegral<unsigned long long>() { return true; }
template <typename T>
struct CanConvert_ {
static int sfinae(T);
static char sfinae(...);
};
template <typename T, typename U>
constexpr bool canConvert() {
return sizeof(CanConvert_<U>::sfinae(instance<T>())) == sizeof(int);
}
#if __GNUC__ && !__clang__ && __GNUC__ < 5
template <typename T>
constexpr bool canMemcpy() {
// Returns true if T can be copied using memcpy instead of using the copy constructor or
// assignment operator.
// GCC 4 does not have __is_trivially_constructible and friends, and there doesn't seem to be
// any reliable alternative. __has_trivial_copy() and __has_trivial_assign() return the right
// thing at one point but later on they changed such that a deleted copy constructor was
// considered "trivial" (apparently technically correct, though useless). So, on GCC 4 we give up
// and assume we can't memcpy() at all, and must explicitly copy-construct everything.
return false;
}
#define KJ_ASSERT_CAN_MEMCPY(T)
#else
template <typename T>
constexpr bool canMemcpy() {
// Returns true if T can be copied using memcpy instead of using the copy constructor or
// assignment operator.
return __is_trivially_constructible(T, const T&) && __is_trivially_assignable(T, const T&);
}
#define KJ_ASSERT_CAN_MEMCPY(T) \
static_assert(kj::canMemcpy<T>(), "this code expects this type to be memcpy()-able");
#endif
template <typename T>
class Badge {
// A pattern for marking individual methods such that they can only be called from a specific
// caller class: Make the method public but give it a parameter of type `Badge<Caller>`. Only
// `Caller` can construct one, so only `Caller` can call the method.
//
// // We only allow calls from the class `Bar`.
// void foo(Badge<Bar>)
//
// The call site looks like:
//
// foo({});
//
// This pattern also works well for declaring private constructors, but still being able to use
// them with `kj::heap()`, etc.
//
// Idea from: https://awesomekling.github.io/Serenity-C++-patterns-The-Badge/
//
// Note that some forms of this idea make the copy constructor private as well, in order to
// prohibit `Badge<NotMe>(*(Badge<NotMe>*)nullptr)`. However, that would prevent badges from
// being passed through forwarding functions like `kj::heap()`, which would ruin one of the main
// use cases for this pattern in KJ. In any case, dereferencing a null pointer is UB; there are
// plenty of other ways to get access to private members if you're willing to go UB. For one-off
// debugging purposes, you might as well use `#define private public` at the top of the file.
private:
Badge() {}
friend T;
};
// =======================================================================================
// Equivalents to std::move() and std::forward(), since these are very commonly needed and the
// std header <utility> pulls in lots of other stuff.
//
// We use abbreviated names mv and fwd because these helpers (especially mv) are so commonly used
// that the cost of typing more letters outweighs the cost of being slightly harder to understand
// when first encountered.
template<typename T> constexpr T&& mv(T& t) noexcept { return static_cast<T&&>(t); }
template<typename T> constexpr T&& fwd(NoInfer<T>& t) noexcept { return static_cast<T&&>(t); }
template<typename T> constexpr T cp(T& t) noexcept { return t; }
template<typename T> constexpr T cp(const T& t) noexcept { return t; }
// Useful to force a copy, particularly to pass into a function that expects T&&.
template <typename T, typename U, bool takeT, bool uOK = true> struct ChooseType_;
template <typename T, typename U> struct ChooseType_<T, U, true, true> { typedef T Type; };
template <typename T, typename U> struct ChooseType_<T, U, true, false> { typedef T Type; };
template <typename T, typename U> struct ChooseType_<T, U, false, true> { typedef U Type; };
template <typename T, typename U>
using WiderType = typename ChooseType_<T, U, sizeof(T) >= sizeof(U)>::Type;
template <typename T, typename U>
inline constexpr auto min(T&& a, U&& b) -> WiderType<Decay<T>, Decay<U>> {
return a < b ? WiderType<Decay<T>, Decay<U>>(a) : WiderType<Decay<T>, Decay<U>>(b);
}
template <typename T, typename U>
inline constexpr auto max(T&& a, U&& b) -> WiderType<Decay<T>, Decay<U>> {
return a > b ? WiderType<Decay<T>, Decay<U>>(a) : WiderType<Decay<T>, Decay<U>>(b);
}
template <typename T, size_t s>
inline constexpr size_t size(T (&arr)[s]) { return s; }
template <typename T>
inline constexpr size_t size(T&& arr) { return arr.size(); }
// Returns the size of the parameter, whether the parameter is a regular C array or a container
// with a `.size()` method.
class MaxValue_ {
private:
template <typename T>
inline constexpr T maxSigned() const {
return (1ull << (sizeof(T) * 8 - 1)) - 1;
}
template <typename T>
inline constexpr T maxUnsigned() const {
return ~static_cast<T>(0u);
}
public:
#define _kJ_HANDLE_TYPE(T) \
inline constexpr operator signed T() const { return MaxValue_::maxSigned < signed T>(); } \
inline constexpr operator unsigned T() const { return MaxValue_::maxUnsigned<unsigned T>(); }
_kJ_HANDLE_TYPE(char)
_kJ_HANDLE_TYPE(short)
_kJ_HANDLE_TYPE(int)
_kJ_HANDLE_TYPE(long)
_kJ_HANDLE_TYPE(long long)
#undef _kJ_HANDLE_TYPE
inline constexpr operator char() const {
// `char` is different from both `signed char` and `unsigned char`, and may be signed or
// unsigned on different platforms. Ugh.
return char(-1) < 0 ? MaxValue_::maxSigned<char>()
: MaxValue_::maxUnsigned<char>();
}
};
class MinValue_ {
private:
template <typename T>
inline constexpr T minSigned() const {
return 1ull << (sizeof(T) * 8 - 1);
}
template <typename T>
inline constexpr T minUnsigned() const {
return 0u;
}
public:
#define _kJ_HANDLE_TYPE(T) \
inline constexpr operator signed T() const { return MinValue_::minSigned < signed T>(); } \
inline constexpr operator unsigned T() const { return MinValue_::minUnsigned<unsigned T>(); }
_kJ_HANDLE_TYPE(char)
_kJ_HANDLE_TYPE(short)
_kJ_HANDLE_TYPE(int)
_kJ_HANDLE_TYPE(long)
_kJ_HANDLE_TYPE(long long)
#undef _kJ_HANDLE_TYPE
inline constexpr operator char() const {
// `char` is different from both `signed char` and `unsigned char`, and may be signed or
// unsigned on different platforms. Ugh.
return char(-1) < 0 ? MinValue_::minSigned<char>()
: MinValue_::minUnsigned<char>();
}
};
static KJ_CONSTEXPR(const) MaxValue_ maxValue = MaxValue_();
// A special constant which, when cast to an integer type, takes on the maximum possible value of
// that type. This is useful to use as e.g. a parameter to a function because it will be robust
// in the face of changes to the parameter's type.
static KJ_CONSTEXPR(const) MinValue_ minValue = MinValue_();
// A special constant which, when cast to an integer type, takes on the minimum possible value
// of that type. This is useful to use as e.g. a parameter to a function because it will be robust
// in the face of changes to the parameter's type.
template <typename T>
inline bool operator==(T t, MaxValue_) { return t == Decay<T>(maxValue); }
template <typename T>
inline bool operator==(T t, MinValue_) { return t == Decay<T>(minValue); }
template <uint bits>
inline constexpr unsigned long long maxValueForBits() {
// Get the maximum integer representable in the given number of bits.
// 1ull << 64 is unfortunately undefined.
return (bits == 64 ? 0 : (1ull << bits)) - 1;
}
struct ThrowOverflow {
// Functor which throws an exception complaining about integer overflow. Usually this is used
// with the interfaces in units.h, but is defined here because Cap'n Proto wants to avoid
// including units.h when not using CAPNP_DEBUG_TYPES.
[[noreturn]] void operator()() const;
};
#if __GNUC__ || __clang__ || _MSC_VER
inline constexpr float inf() { return __builtin_huge_valf(); }
inline constexpr float nan() { return __builtin_nanf(""); }
#else
#error "Not sure how to support your compiler."
#endif
inline constexpr bool isNaN(float f) { return f != f; }
inline constexpr bool isNaN(double f) { return f != f; }
inline int popCount(unsigned int x) {
#if defined(_MSC_VER) && !defined(__clang__)
return __popcnt(x);
// Note: __popcnt returns unsigned int, but the value is clearly guaranteed to fit into an int
#else
return __builtin_popcount(x);
#endif
}
// =======================================================================================
// Useful fake containers
template <typename T>
class Range {
public:
inline constexpr Range(const T& begin, const T& end): begin_(begin), end_(end) {}
inline explicit constexpr Range(const T& end): begin_(0), end_(end) {}
class Iterator {
public:
Iterator() = default;
inline Iterator(const T& value): value(value) {}
inline const T& operator* () const { return value; }
inline const T& operator[](size_t index) const { return value + index; }
inline Iterator& operator++() { ++value; return *this; }
inline Iterator operator++(int) { return Iterator(value++); }
inline Iterator& operator--() { --value; return *this; }
inline Iterator operator--(int) { return Iterator(value--); }
inline Iterator& operator+=(ptrdiff_t amount) { value += amount; return *this; }
inline Iterator& operator-=(ptrdiff_t amount) { value -= amount; return *this; }
inline Iterator operator+ (ptrdiff_t amount) const { return Iterator(value + amount); }
inline Iterator operator- (ptrdiff_t amount) const { return Iterator(value - amount); }
inline ptrdiff_t operator- (const Iterator& other) const { return value - other.value; }
inline bool operator==(const Iterator& other) const { return value == other.value; }
inline bool operator<=(const Iterator& other) const { return value <= other.value; }
inline bool operator>=(const Iterator& other) const { return value >= other.value; }
inline bool operator< (const Iterator& other) const { return value < other.value; }
inline bool operator> (const Iterator& other) const { return value > other.value; }
private:
T value;
};
inline Iterator begin() const { return Iterator(begin_); }
inline Iterator end() const { return Iterator(end_); }
inline auto size() const -> decltype(instance<T>() - instance<T>()) { return end_ - begin_; }
private:
T begin_;
T end_;
};
template <typename T, typename U>
inline constexpr Range<WiderType<Decay<T>, Decay<U>>> range(T begin, U end) {
return Range<WiderType<Decay<T>, Decay<U>>>(begin, end);
}
template <typename T>
inline constexpr Range<Decay<T>> range(T begin, T end) { return Range<Decay<T>>(begin, end); }
// Returns a fake iterable container containing all values of T from `begin` (inclusive) to `end`
// (exclusive). Example:
//
// // Prints 1, 2, 3, 4, 5, 6, 7, 8, 9.
// for (int i: kj::range(1, 10)) { print(i); }
template <typename T>
inline constexpr Range<Decay<T>> zeroTo(T end) { return Range<Decay<T>>(end); }
// Returns a fake iterable container containing all values of T from zero (inclusive) to `end`
// (exclusive). Example:
//
// // Prints 0, 1, 2, 3, 4, 5, 6, 7, 8, 9.
// for (int i: kj::zeroTo(10)) { print(i); }
template <typename T>
inline constexpr Range<size_t> indices(T&& container) {
// Shortcut for iterating over the indices of a container:
//
// for (size_t i: kj::indices(myArray)) { handle(myArray[i]); }
return range<size_t>(0, kj::size(container));
}
template <typename T>
class Repeat {
public:
inline constexpr Repeat(const T& value, size_t count): value(value), count(count) {}
class Iterator {
public:
Iterator() = default;
inline Iterator(const T& value, size_t index): value(value), index(index) {}
inline const T& operator* () const { return value; }
inline const T& operator[](ptrdiff_t index) const { return value; }
inline Iterator& operator++() { ++index; return *this; }
inline Iterator operator++(int) { return Iterator(value, index++); }
inline Iterator& operator--() { --index; return *this; }
inline Iterator operator--(int) { return Iterator(value, index--); }
inline Iterator& operator+=(ptrdiff_t amount) { index += amount; return *this; }
inline Iterator& operator-=(ptrdiff_t amount) { index -= amount; return *this; }
inline Iterator operator+ (ptrdiff_t amount) const { return Iterator(value, index + amount); }
inline Iterator operator- (ptrdiff_t amount) const { return Iterator(value, index - amount); }
inline ptrdiff_t operator- (const Iterator& other) const { return index - other.index; }
inline bool operator==(const Iterator& other) const { return index == other.index; }
inline bool operator<=(const Iterator& other) const { return index <= other.index; }
inline bool operator>=(const Iterator& other) const { return index >= other.index; }
inline bool operator< (const Iterator& other) const { return index < other.index; }
inline bool operator> (const Iterator& other) const { return index > other.index; }
private:
T value;
size_t index;
};
inline Iterator begin() const { return Iterator(value, 0); }
inline Iterator end() const { return Iterator(value, count); }
inline size_t size() const { return count; }
inline const T& operator[](ptrdiff_t) const { return value; }
private:
T value;
size_t count;
};
template <typename T>
inline constexpr Repeat<Decay<T>> repeat(T&& value, size_t count) {
// Returns a fake iterable which contains `count` repeats of `value`. Useful for e.g. creating
// a bunch of spaces: `kj::repeat(' ', indent * 2)`
return Repeat<Decay<T>>(value, count);
}
template <typename Inner, class Mapping>
class MappedIterator: private Mapping {
// An iterator that wraps some other iterator and maps the values through a mapping function.
// The type `Mapping` must define a method `map()` which performs this mapping.
public:
template <typename... Params>
MappedIterator(Inner inner, Params&&... params)
: Mapping(kj::fwd<Params>(params)...), inner(inner) {}
inline auto operator->() const { return &Mapping::map(*inner); }
inline decltype(auto) operator* () const { return Mapping::map(*inner); }
inline decltype(auto) operator[](size_t index) const { return Mapping::map(inner[index]); }
inline MappedIterator& operator++() { ++inner; return *this; }
inline MappedIterator operator++(int) { return MappedIterator(inner++, *this); }
inline MappedIterator& operator--() { --inner; return *this; }
inline MappedIterator operator--(int) { return MappedIterator(inner--, *this); }
inline MappedIterator& operator+=(ptrdiff_t amount) { inner += amount; return *this; }
inline MappedIterator& operator-=(ptrdiff_t amount) { inner -= amount; return *this; }
inline MappedIterator operator+ (ptrdiff_t amount) const {
return MappedIterator(inner + amount, *this);
}
inline MappedIterator operator- (ptrdiff_t amount) const {
return MappedIterator(inner - amount, *this);
}
inline ptrdiff_t operator- (const MappedIterator& other) const { return inner - other.inner; }
inline bool operator==(const MappedIterator& other) const { return inner == other.inner; }
inline bool operator<=(const MappedIterator& other) const { return inner <= other.inner; }
inline bool operator>=(const MappedIterator& other) const { return inner >= other.inner; }
inline bool operator< (const MappedIterator& other) const { return inner < other.inner; }
inline bool operator> (const MappedIterator& other) const { return inner > other.inner; }
private:
Inner inner;
};
template <typename Inner, typename Mapping>
class MappedIterable: private Mapping {
// An iterable that wraps some other iterable and maps the values through a mapping function.
// The type `Mapping` must define a method `map()` which performs this mapping.
public:
template <typename... Params>
MappedIterable(Inner inner, Params&&... params)