lib/CodeGen/MIRParser/MILexer.h

   1 //===- MILexer.h - Lexer for machine instructions -------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file declares the function that lexes the machine instruction source
  11 // string.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_LIB_CODEGEN_MIRPARSER_MILEXER_H
  16 #define LLVM_LIB_CODEGEN_MIRPARSER_MILEXER_H
  17
  18 #include "llvm/ADT/APSInt.h"
  19 #include "llvm/ADT/StringRef.h"
  20 #include "llvm/ADT/STLExtras.h"
  21 #include <functional>
  22
  23 namespace llvm {
  24
  25 class Twine;
  26
  27 /// A token produced by the machine instruction lexer.
  28 struct MIToken {
  29   enum TokenKind {
  30     // Markers
  31     Eof,
  32     Error,
  33
  34     // Tokens with no info.
  35     comma,
  36     equal,
  37     underscore,
  38
  39     // Keywords
  40     kw_implicit,
  41     kw_implicit_define,
  42     kw_dead,
  43     kw_killed,
  44     kw_undef,
  45
  46     // Identifier tokens
  47     Identifier,
  48     NamedRegister,
  49     MachineBasicBlock,
  50     NamedGlobalValue,
  51     GlobalValue,
  52
  53     // Other tokens
  54     IntegerLiteral,
  55     VirtualRegister
  56   };
  57
  58 private:
  59   TokenKind Kind;
  60   unsigned StringOffset;
  61   StringRef Range;
  62   APSInt IntVal;
  63
  64 public:
  65   MIToken(TokenKind Kind, StringRef Range, unsigned StringOffset = 0)
  66       : Kind(Kind), StringOffset(StringOffset), Range(Range) {}
  67
  68   MIToken(TokenKind Kind, StringRef Range, const APSInt &IntVal,
  69           unsigned StringOffset = 0)
  70       : Kind(Kind), StringOffset(StringOffset), Range(Range), IntVal(IntVal) {}
  71
  72   TokenKind kind() const { return Kind; }
  73
  74   bool isError() const { return Kind == Error; }
  75
  76   bool isRegister() const {
  77     return Kind == NamedRegister || Kind == underscore ||
  78            Kind == VirtualRegister;
  79   }
  80
  81   bool isRegisterFlag() const {
  82     return Kind == kw_implicit || Kind == kw_implicit_define ||
  83            Kind == kw_dead || Kind == kw_killed || Kind == kw_undef;
  84   }
  85
  86   bool is(TokenKind K) const { return Kind == K; }
  87
  88   bool isNot(TokenKind K) const { return Kind != K; }
  89
  90   StringRef::iterator location() const { return Range.begin(); }
  91
  92   StringRef stringValue() const { return Range.drop_front(StringOffset); }
  93
  94   const APSInt &integerValue() const { return IntVal; }
  95
  96   bool hasIntegerValue() const {
  97     return Kind == IntegerLiteral || Kind == MachineBasicBlock ||
  98            Kind == GlobalValue || Kind == VirtualRegister;
  99   }
 100 };
 101
 102 /// Consume a single machine instruction token in the given source and return
 103 /// the remaining source string.
 104 StringRef lexMIToken(
 105     StringRef Source, MIToken &Token,
 106     function_ref<void(StringRef::iterator, const Twine &)> ErrorCallback);
 107
 108 } // end namespace llvm
 109
 110 #endif