common.h 24.4 KB
Newer Older
Kenton Varda's avatar
Kenton Varda committed
1 2
// Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
// Licensed under the MIT License:
3
//
Kenton Varda's avatar
Kenton Varda committed
4 5 6 7 8 9
// 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:
10
//
Kenton Varda's avatar
Kenton Varda committed
11 12
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
13
//
Kenton Varda's avatar
Kenton Varda committed
14 15 16 17 18 19 20
// 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.
21

22 23 24 25 26 27 28 29 30 31 32 33 34 35
// Parser combinator framework!
//
// This file declares several functions which construct parsers, usually taking other parsers as
// input, thus making them parser combinators.
//
// A valid parser is any functor which takes a reference to an input cursor (defined below) as its
// input and returns a Maybe.  The parser returns null on parse failure, or returns the parsed
// result on success.
//
// An "input cursor" is any type which implements the same interface as IteratorInput, below.  Such
// a type acts as a pointer to the current input location.  When a parser returns successfully, it
// will have updated the input cursor to point to the position just past the end of what was parsed.
// On failure, the cursor position is unspecified.

36 37
#ifndef KJ_PARSE_COMMON_H_
#define KJ_PARSE_COMMON_H_
38

39 40 41 42
#if defined(__GNUC__) && !KJ_HEADER_WARNINGS
#pragma GCC system_header
#endif

43 44 45 46 47
#include "../common.h"
#include "../memory.h"
#include "../array.h"
#include "../tuple.h"
#include "../vector.h"
48 49 50 51 52 53

namespace kj {
namespace parse {

template <typename Element, typename Iterator>
class IteratorInput {
54 55
  // A parser input implementation based on an iterator range.

56 57 58
public:
  IteratorInput(Iterator begin, Iterator end)
      : parent(nullptr), pos(begin), end(end), best(begin) {}
59
  explicit IteratorInput(IteratorInput& parent)
60 61 62 63 64 65
      : parent(&parent), pos(parent.pos), end(parent.end), best(parent.pos) {}
  ~IteratorInput() {
    if (parent != nullptr) {
      parent->best = kj::max(kj::max(pos, best), parent->best);
    }
  }
66
  KJ_DISALLOW_COPY(IteratorInput);
67 68 69 70

  void advanceParent() {
    parent->pos = pos;
  }
71 72 73
  void forgetParent() {
    parent = nullptr;
  }
74 75

  bool atEnd() { return pos == end; }
76
  auto current() -> decltype(*instance<Iterator>()) {
77 78 79
    KJ_IREQUIRE(!atEnd());
    return *pos;
  }
80
  auto consume() -> decltype(*instance<Iterator>()) {
81
    KJ_IREQUIRE(!atEnd());
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
    return *pos++;
  }
  void next() {
    KJ_IREQUIRE(!atEnd());
    ++pos;
  }

  Iterator getBest() { return kj::max(pos, best); }

  Iterator getPosition() { return pos; }

private:
  IteratorInput* parent;
  Iterator pos;
  Iterator end;
  Iterator best;  // furthest we got with any sub-input
};

100 101 102 103 104
template <typename T> struct OutputType_;
template <typename T> struct OutputType_<Maybe<T>> { typedef T Type; };
template <typename Parser, typename Input>
using OutputType = typename OutputType_<decltype(instance<Parser&>()(instance<Input&>()))>::Type;
// Synonym for the output type of a parser, given the parser type and the input type.
105 106 107 108

// =======================================================================================

template <typename Input, typename Output>
109 110 111 112 113
class ParserRef {
  // Acts as a reference to some other parser, with simplified type.  The referenced parser
  // is polymorphic by virtual call rather than templates.  For grammars of non-trivial size,
  // it is important to inject refs into the grammar here and there to prevent the parser types
  // from becoming ridiculous.  Using too many of them can hurt performance, though.
114 115

public:
116 117 118 119 120 121
  ParserRef(): parser(nullptr), wrapper(nullptr) {}
  ParserRef(const ParserRef&) = default;
  ParserRef(ParserRef&&) = default;
  ParserRef& operator=(const ParserRef& other) = default;
  ParserRef& operator=(ParserRef&& other) = default;

122
  template <typename Other>
123 124 125 126 127 128 129 130 131 132 133 134
  constexpr ParserRef(Other&& other)
      : parser(&other), wrapper(&WrapperImplInstance<Decay<Other>>::instance) {
    static_assert(kj::isReference<Other>(), "ParseRef should not be assigned to a temporary.");
  }

  template <typename Other>
  inline ParserRef& operator=(Other&& other) {
    static_assert(kj::isReference<Other>(), "ParseRef should not be assigned to a temporary.");
    parser = &other;
    wrapper = &WrapperImplInstance<Decay<Other>>::instance;
    return *this;
  }
135

136 137 138
  KJ_ALWAYS_INLINE(Maybe<Output> operator()(Input& input) const) {
    // Always inline in the hopes that this allows branch prediction to kick in so the virtual call
    // doesn't hurt so much.
139
    return wrapper->parse(parser, input);
140 141 142
  }

private:
143 144 145 146 147 148 149
  struct Wrapper {
    virtual Maybe<Output> parse(const void* parser, Input& input) const = 0;
  };
  template <typename ParserImpl>
  struct WrapperImpl: public Wrapper {
    Maybe<Output> parse(const void* parser, Input& input) const override {
      return (*reinterpret_cast<const ParserImpl*>(parser))(input);
150
    }
Kenton Varda's avatar
Kenton Varda committed
151 152 153 154
  };
  template <typename ParserImpl>
  struct WrapperImplInstance {
    static constexpr WrapperImpl<ParserImpl> instance = WrapperImpl<ParserImpl>();
155 156
  };

157
  const void* parser;
158
  const Wrapper* wrapper;
159 160
};

Kenton Varda's avatar
Kenton Varda committed
161 162
template <typename Input, typename Output>
template <typename ParserImpl>
163
constexpr typename ParserRef<Input, Output>::template WrapperImpl<ParserImpl>
Kenton Varda's avatar
Kenton Varda committed
164 165
ParserRef<Input, Output>::WrapperImplInstance<ParserImpl>::instance;

166
template <typename Input, typename ParserImpl>
Kenton Varda's avatar
Kenton Varda committed
167
constexpr ParserRef<Input, OutputType<ParserImpl, Input>> ref(ParserImpl& impl) {
168 169
  // Constructs a ParserRef.  You must specify the input type explicitly, e.g.
  // `ref<MyInput>(myParser)`.
170

171 172
  return ParserRef<Input, OutputType<ParserImpl, Input>>(impl);
}
173

174
// -------------------------------------------------------------------
175
// any
176 177 178 179 180
// Output = one token

class Any_ {
public:
  template <typename Input>
181
  Maybe<Decay<decltype(instance<Input>().consume())>> operator()(Input& input) const {
182 183 184
    if (input.atEnd()) {
      return nullptr;
    } else {
185
      return input.consume();
186 187 188 189
    }
  }
};

190 191
constexpr Any_ any = Any_();
// A parser which matches any token and simply returns it.
192

193
// -------------------------------------------------------------------
194
// exactly()
195
// Output = Tuple<>
196

197 198
template <typename T>
class Exactly_ {
199
public:
Kenton Varda's avatar
Kenton Varda committed
200
  explicit constexpr Exactly_(T&& expected): expected(expected) {}
201

202 203
  template <typename Input>
  Maybe<Tuple<>> operator()(Input& input) const {
204 205 206 207
    if (input.atEnd() || input.current() != expected) {
      return nullptr;
    } else {
      input.next();
208
      return Tuple<>();
209 210 211 212
    }
  }

private:
213
  T expected;
214 215
};

216
template <typename T>
Kenton Varda's avatar
Kenton Varda committed
217
constexpr Exactly_<T> exactly(T&& expected) {
218 219 220 221
  // Constructs a parser which succeeds when the input is exactly the token specified.  The
  // result is always the empty tuple.

  return Exactly_<T>(kj::fwd<T>(expected));
222 223
}

Kenton Varda's avatar
Kenton Varda committed
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
// -------------------------------------------------------------------
// exactlyConst()
// Output = Tuple<>

template <typename T, T expected>
class ExactlyConst_ {
public:
  explicit constexpr ExactlyConst_() {}

  template <typename Input>
  Maybe<Tuple<>> operator()(Input& input) const {
    if (input.atEnd() || input.current() != expected) {
      return nullptr;
    } else {
      input.next();
      return Tuple<>();
    }
  }
};

template <typename T, T expected>
constexpr ExactlyConst_<T, expected> exactlyConst() {
  // Constructs a parser which succeeds when the input is exactly the token specified.  The
  // result is always the empty tuple.  This parser is templated on the token value which may cause
  // it to perform better -- or worse.  Be sure to measure.

  return ExactlyConst_<T, expected>();
}

// -------------------------------------------------------------------
// constResult()

template <typename SubParser, typename Result>
class ConstResult_ {
public:
  explicit constexpr ConstResult_(SubParser&& subParser, Result&& result)
      : subParser(kj::fwd<SubParser>(subParser)), result(kj::fwd<Result>(result)) {}

  template <typename Input>
  Maybe<Result> operator()(Input& input) const {
    if (subParser(input) == nullptr) {
      return nullptr;
    } else {
      return result;
    }
  }

private:
  SubParser subParser;
  Result result;
};

template <typename SubParser, typename Result>
constexpr ConstResult_<SubParser, Result> constResult(SubParser&& subParser, Result&& result) {
  // Constructs a parser which returns exactly `result` if `subParser` is successful.
  return ConstResult_<SubParser, Result>(kj::fwd<SubParser>(subParser), kj::fwd<Result>(result));
}

282 283 284 285 286 287
template <typename SubParser>
constexpr ConstResult_<SubParser, Tuple<>> discard(SubParser&& subParser) {
  // Constructs a parser which wraps `subParser` but discards the result.
  return constResult(kj::fwd<SubParser>(subParser), Tuple<>());
}

288
// -------------------------------------------------------------------
289
// sequence()
290 291
// Output = Flattened Tuple of outputs of sub-parsers.

292
template <typename... SubParsers> class Sequence_;
293

294 295
template <typename FirstSubParser, typename... SubParsers>
class Sequence_<FirstSubParser, SubParsers...> {
296 297
public:
  template <typename T, typename... U>
Kenton Varda's avatar
Kenton Varda committed
298
  explicit constexpr Sequence_(T&& firstSubParser, U&&... rest)
299 300
      : first(kj::fwd<T>(firstSubParser)), rest(kj::fwd<U>(rest)...) {}

301
  template <typename Input>
302 303
  auto operator()(Input& input) const ->
      Maybe<decltype(tuple(
304 305
          instance<OutputType<FirstSubParser, Input>>(),
          instance<OutputType<SubParsers, Input>>()...))> {
306 307 308
    return parseNext(input);
  }

309
  template <typename Input, typename... InitialParams>
310 311 312
  auto parseNext(Input& input, InitialParams&&... initialParams) const ->
      Maybe<decltype(tuple(
          kj::fwd<InitialParams>(initialParams)...,
313 314
          instance<OutputType<FirstSubParser, Input>>(),
          instance<OutputType<SubParsers, Input>>()...))> {
315 316 317 318 319 320 321 322 323 324
    KJ_IF_MAYBE(firstResult, first(input)) {
      return rest.parseNext(input, kj::fwd<InitialParams>(initialParams)...,
                            kj::mv(*firstResult));
    } else {
      return nullptr;
    }
  }

private:
  FirstSubParser first;
325
  Sequence_<SubParsers...> rest;
326 327
};

328 329
template <>
class Sequence_<> {
330
public:
331
  template <typename Input>
332
  Maybe<Tuple<>> operator()(Input& input) const {
333 334 335
    return parseNext(input);
  }

336
  template <typename Input, typename... Params>
337 338 339 340 341 342
  auto parseNext(Input& input, Params&&... params) const ->
      Maybe<decltype(tuple(kj::fwd<Params>(params)...))> {
    return tuple(kj::fwd<Params>(params)...);
  }
};

343
template <typename... SubParsers>
Kenton Varda's avatar
Kenton Varda committed
344
constexpr Sequence_<SubParsers...> sequence(SubParsers&&... subParsers) {
345 346
  // Constructs a parser that executes each of the parameter parsers in sequence and returns a
  // tuple of their results.
347

348 349
  return Sequence_<SubParsers...>(kj::fwd<SubParsers>(subParsers)...);
}
350 351

// -------------------------------------------------------------------
352
// many()
353
// Output = Array of output of sub-parser, or just a uint count if the sub-parser returns Tuple<>.
354 355

template <typename SubParser, bool atLeastOne>
356
class Many_ {
357 358
  template <typename Input, typename Output = OutputType<SubParser, Input>>
  struct Impl;
359
public:
Kenton Varda's avatar
Kenton Varda committed
360
  explicit constexpr Many_(SubParser&& subParser)
361
      : subParser(kj::fwd<SubParser>(subParser)) {}
362

363
  template <typename Input>
364 365 366 367 368 369 370 371 372 373 374
  auto operator()(Input& input) const
      -> decltype(Impl<Input>::apply(instance<const SubParser&>(), input));

private:
  SubParser subParser;
};

template <typename SubParser, bool atLeastOne>
template <typename Input, typename Output>
struct Many_<SubParser, atLeastOne>::Impl {
  static Maybe<Array<Output>> apply(const SubParser& subParser, Input& input) {
375
    typedef Vector<OutputType<SubParser, Input>> Results;
376 377 378
    Results results;

    while (!input.atEnd()) {
379
      Input subInput(input);
380 381 382 383 384 385 386 387 388 389 390 391 392

      KJ_IF_MAYBE(subResult, subParser(subInput)) {
        subInput.advanceParent();
        results.add(kj::mv(*subResult));
      } else {
        break;
      }
    }

    if (atLeastOne && results.empty()) {
      return nullptr;
    }

393
    return results.releaseAsArray();
394
  }
395
};
396

397 398 399
template <typename SubParser, bool atLeastOne>
template <typename Input>
struct Many_<SubParser, atLeastOne>::Impl<Input, Tuple<>> {
400 401
  // If the sub-parser output is Tuple<>, just return a count.

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
  static Maybe<uint> apply(const SubParser& subParser, Input& input) {
    uint count = 0;

    while (!input.atEnd()) {
      Input subInput(input);

      KJ_IF_MAYBE(subResult, subParser(subInput)) {
        subInput.advanceParent();
        ++count;
      } else {
        break;
      }
    }

    if (atLeastOne && count == 0) {
      return nullptr;
    }

    return count;
  }
422 423
};

424 425 426 427 428 429 430
template <typename SubParser, bool atLeastOne>
template <typename Input>
auto Many_<SubParser, atLeastOne>::operator()(Input& input) const
    -> decltype(Impl<Input>::apply(instance<const SubParser&>(), input)) {
  return Impl<Input, OutputType<SubParser, Input>>::apply(subParser, input);
}

431
template <typename SubParser>
Kenton Varda's avatar
Kenton Varda committed
432
constexpr Many_<SubParser, false> many(SubParser&& subParser) {
433
  // Constructs a parser that repeatedly executes the given parser until it fails, returning an
434
  // Array of the results (or a uint count if `subParser` returns an empty tuple).
435
  return Many_<SubParser, false>(kj::fwd<SubParser>(subParser));
436 437 438
}

template <typename SubParser>
Kenton Varda's avatar
Kenton Varda committed
439
constexpr Many_<SubParser, true> oneOrMore(SubParser&& subParser) {
440 441
  // Like `many()` but the parser must parse at least one item to be successful.
  return Many_<SubParser, true>(kj::fwd<SubParser>(subParser));
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
// -------------------------------------------------------------------
// times()
// Output = Array of output of sub-parser, or Tuple<> if sub-parser returns Tuple<>.

template <typename SubParser>
class Times_ {
  template <typename Input, typename Output = OutputType<SubParser, Input>>
  struct Impl;
public:
  explicit constexpr Times_(SubParser&& subParser, uint count)
      : subParser(kj::fwd<SubParser>(subParser)), count(count) {}

  template <typename Input>
  auto operator()(Input& input) const
      -> decltype(Impl<Input>::apply(instance<const SubParser&>(), instance<uint>(), input));

private:
  SubParser subParser;
  uint count;
};

template <typename SubParser>
template <typename Input, typename Output>
struct Times_<SubParser>::Impl {
  static Maybe<Array<Output>> apply(const SubParser& subParser, uint count, Input& input) {
    auto results = heapArrayBuilder<OutputType<SubParser, Input>>(count);

    while (results.size() < count) {
      if (input.atEnd()) {
        return nullptr;
      } else KJ_IF_MAYBE(subResult, subParser(input)) {
        results.add(kj::mv(*subResult));
      } else {
        return nullptr;
      }
    }

    return results.finish();
  }
};

template <typename SubParser>
template <typename Input>
struct Times_<SubParser>::Impl<Input, Tuple<>> {
  // If the sub-parser output is Tuple<>, just return a count.

  static Maybe<Tuple<>> apply(const SubParser& subParser, uint count, Input& input) {
    uint actualCount = 0;

    while (actualCount < count) {
      if (input.atEnd()) {
        return nullptr;
      } else KJ_IF_MAYBE(subResult, subParser(input)) {
        ++actualCount;
      } else {
        return nullptr;
      }
    }

    return tuple();
  }
};

template <typename SubParser>
template <typename Input>
auto Times_<SubParser>::operator()(Input& input) const
    -> decltype(Impl<Input>::apply(instance<const SubParser&>(), instance<uint>(), input)) {
  return Impl<Input, OutputType<SubParser, Input>>::apply(subParser, count, input);
}

template <typename SubParser>
constexpr Times_<SubParser> times(SubParser&& subParser, uint count) {
  // Constructs a parser that repeats the subParser exactly `count` times.
  return Times_<SubParser>(kj::fwd<SubParser>(subParser), count);
}

520
// -------------------------------------------------------------------
521
// optional()
522 523 524
// Output = Maybe<output of sub-parser>

template <typename SubParser>
525
class Optional_ {
526
public:
Kenton Varda's avatar
Kenton Varda committed
527
  explicit constexpr Optional_(SubParser&& subParser)
528
      : subParser(kj::fwd<SubParser>(subParser)) {}
529

530 531 532
  template <typename Input>
  Maybe<Maybe<OutputType<SubParser, Input>>> operator()(Input& input) const {
    typedef Maybe<OutputType<SubParser, Input>> Result;
533

534 535
    Input subInput(input);
    KJ_IF_MAYBE(subResult, subParser(subInput)) {
536 537
      subInput.advanceParent();
      return Result(kj::mv(*subResult));
538 539
    } else {
      return Result(nullptr);
540 541 542 543 544 545 546 547
    }
  }

private:
  SubParser subParser;
};

template <typename SubParser>
Kenton Varda's avatar
Kenton Varda committed
548
constexpr Optional_<SubParser> optional(SubParser&& subParser) {
549 550 551
  // Constructs a parser that accepts zero or one of the given sub-parser, returning a Maybe
  // of the sub-parser's result.
  return Optional_<SubParser>(kj::fwd<SubParser>(subParser));
552 553 554
}

// -------------------------------------------------------------------
555
// oneOf()
556 557 558
// All SubParsers must have same output type, which becomes the output type of the
// OneOfParser.

559 560
template <typename... SubParsers>
class OneOf_;
561

562 563
template <typename FirstSubParser, typename... SubParsers>
class OneOf_<FirstSubParser, SubParsers...> {
564
public:
565 566
  explicit constexpr OneOf_(FirstSubParser&& firstSubParser, SubParsers&&... rest)
      : first(kj::fwd<FirstSubParser>(firstSubParser)), rest(kj::fwd<SubParsers>(rest)...) {}
567

568 569
  template <typename Input>
  Maybe<OutputType<FirstSubParser, Input>> operator()(Input& input) const {
570 571
    {
      Input subInput(input);
572
      Maybe<OutputType<FirstSubParser, Input>> firstResult = first(subInput);
573 574 575 576 577 578 579 580 581 582 583 584 585

      if (firstResult != nullptr) {
        subInput.advanceParent();
        return kj::mv(firstResult);
      }
    }

    // Hoping for some tail recursion here...
    return rest(input);
  }

private:
  FirstSubParser first;
586
  OneOf_<SubParsers...> rest;
587 588
};

589 590
template <>
class OneOf_<> {
591
public:
592 593
  template <typename Input>
  decltype(nullptr) operator()(Input& input) const {
594 595 596 597
    return nullptr;
  }
};

598
template <typename... SubParsers>
Kenton Varda's avatar
Kenton Varda committed
599
constexpr OneOf_<SubParsers...> oneOf(SubParsers&&... parsers) {
600 601 602 603
  // Constructs a parser that accepts one of a set of options.  The parser behaves as the first
  // sub-parser in the list which returns successfully.  All of the sub-parsers must return the
  // same type.
  return OneOf_<SubParsers...>(kj::fwd<SubParsers>(parsers)...);
604 605 606
}

// -------------------------------------------------------------------
607
// transform()
608 609 610 611 612 613
// Output = Result of applying transform functor to input value.  If input is a tuple, it is
// unpacked to form the transformation parameters.

template <typename Position>
struct Span {
public:
614 615
  inline const Position& begin() const { return begin_; }
  inline const Position& end() const { return end_; }
616 617

  Span() = default;
Kenton Varda's avatar
Kenton Varda committed
618
  inline constexpr Span(Position&& begin, Position&& end): begin_(mv(begin)), end_(mv(end)) {}
619 620 621 622 623 624

private:
  Position begin_;
  Position end_;
};

625
template <typename Position>
Kenton Varda's avatar
Kenton Varda committed
626
constexpr Span<Decay<Position>> span(Position&& start, Position&& end) {
627 628
  return Span<Decay<Position>>(kj::fwd<Position>(start), kj::fwd<Position>(end));
}
629

630 631 632
template <typename SubParser, typename TransformFunc>
class Transform_ {
public:
Kenton Varda's avatar
Kenton Varda committed
633
  explicit constexpr Transform_(SubParser&& subParser, TransformFunc&& transform)
634 635
      : subParser(kj::fwd<SubParser>(subParser)), transform(kj::fwd<TransformFunc>(transform)) {}

636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
  template <typename Input>
  Maybe<decltype(kj::apply(instance<TransformFunc&>(),
                           instance<OutputType<SubParser, Input>&&>()))>
      operator()(Input& input) const {
    KJ_IF_MAYBE(subResult, subParser(input)) {
      return kj::apply(transform, kj::mv(*subResult));
    } else {
      return nullptr;
    }
  }

private:
  SubParser subParser;
  TransformFunc transform;
};

652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
template <typename SubParser, typename TransformFunc>
class TransformOrReject_ {
public:
  explicit constexpr TransformOrReject_(SubParser&& subParser, TransformFunc&& transform)
      : subParser(kj::fwd<SubParser>(subParser)), transform(kj::fwd<TransformFunc>(transform)) {}

  template <typename Input>
  decltype(kj::apply(instance<TransformFunc&>(), instance<OutputType<SubParser, Input>&&>()))
      operator()(Input& input) const {
    KJ_IF_MAYBE(subResult, subParser(input)) {
      return kj::apply(transform, kj::mv(*subResult));
    } else {
      return nullptr;
    }
  }

private:
  SubParser subParser;
  TransformFunc transform;
};

673 674 675 676 677 678
template <typename SubParser, typename TransformFunc>
class TransformWithLocation_ {
public:
  explicit constexpr TransformWithLocation_(SubParser&& subParser, TransformFunc&& transform)
      : subParser(kj::fwd<SubParser>(subParser)), transform(kj::fwd<TransformFunc>(transform)) {}

679 680 681 682 683
  template <typename Input>
  Maybe<decltype(kj::apply(instance<TransformFunc&>(),
                           instance<Span<Decay<decltype(instance<Input&>().getPosition())>>>(),
                           instance<OutputType<SubParser, Input>&&>()))>
      operator()(Input& input) const {
684 685
    auto start = input.getPosition();
    KJ_IF_MAYBE(subResult, subParser(input)) {
686
      return kj::apply(transform, Span<decltype(start)>(kj::mv(start), input.getPosition()),
687
                       kj::mv(*subResult));
688 689 690 691 692 693 694
    } else {
      return nullptr;
    }
  }

private:
  SubParser subParser;
695
  TransformFunc transform;
696 697
};

698
template <typename SubParser, typename TransformFunc>
Kenton Varda's avatar
Kenton Varda committed
699 700
constexpr Transform_<SubParser, TransformFunc> transform(
    SubParser&& subParser, TransformFunc&& functor) {
701 702 703 704 705
  // Constructs a parser which executes some other parser and then transforms the result by invoking
  // `functor` on it.  Typically `functor` is a lambda.  It is invoked using `kj::apply`,
  // meaning tuples will be unpacked as arguments.
  return Transform_<SubParser, TransformFunc>(
      kj::fwd<SubParser>(subParser), kj::fwd<TransformFunc>(functor));
706 707
}

708 709 710 711 712 713 714 715 716
template <typename SubParser, typename TransformFunc>
constexpr TransformOrReject_<SubParser, TransformFunc> transformOrReject(
    SubParser&& subParser, TransformFunc&& functor) {
  // Like `transform()` except that `functor` returns a `Maybe`.  If it returns null, parsing fails,
  // otherwise the parser's result is the content of the `Maybe`.
  return TransformOrReject_<SubParser, TransformFunc>(
      kj::fwd<SubParser>(subParser), kj::fwd<TransformFunc>(functor));
}

717 718 719
template <typename SubParser, typename TransformFunc>
constexpr TransformWithLocation_<SubParser, TransformFunc> transformWithLocation(
    SubParser&& subParser, TransformFunc&& functor) {
720 721 722
  // Like `transform` except that `functor` also takes a `Span` as its first parameter specifying
  // the location of the parsed content.  The span's position type is whatever the parser input's
  // getPosition() returns.
723 724 725 726 727 728 729 730 731 732 733
  return TransformWithLocation_<SubParser, TransformFunc>(
      kj::fwd<SubParser>(subParser), kj::fwd<TransformFunc>(functor));
}

// -------------------------------------------------------------------
// notLookingAt()
// Fails if the given parser succeeds at the current location.

template <typename SubParser>
class NotLookingAt_ {
public:
734 735
  explicit constexpr NotLookingAt_(SubParser&& subParser)
      : subParser(kj::fwd<SubParser>(subParser)) {}
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758

  template <typename Input>
  Maybe<Tuple<>> operator()(Input& input) const {
    Input subInput(input);
    subInput.forgetParent();
    if (subParser(subInput) == nullptr) {
      return Tuple<>();
    } else {
      return nullptr;
    }
  }

private:
  SubParser subParser;
};

template <typename SubParser>
constexpr NotLookingAt_<SubParser> notLookingAt(SubParser&& subParser) {
  // Constructs a parser which fails at any position where the given parser succeeds.  Otherwise,
  // it succeeds without consuming any input and returns an empty tuple.
  return NotLookingAt_<SubParser>(kj::fwd<SubParser>(subParser));
}

759
// -------------------------------------------------------------------
760
// endOfInput()
761
// Output = Tuple<>, only succeeds if at end-of-input
762

763
class EndOfInput_ {
764
public:
765
  template <typename Input>
766
  Maybe<Tuple<>> operator()(Input& input) const {
767
    if (input.atEnd()) {
768
      return Tuple<>();
769 770 771 772 773 774
    } else {
      return nullptr;
    }
  }
};

775 776
constexpr EndOfInput_ endOfInput = EndOfInput_();
// A parser that succeeds only if it is called with no input.
777 778 779 780

}  // namespace parse
}  // namespace kj

781
#endif  // KJ_PARSE_COMMON_H_