MIR Serialization: Serialize the jump table index operands.
[oota-llvm.git] / 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     colon,
39
40     // Keywords
41     kw_implicit,
42     kw_implicit_define,
43     kw_dead,
44     kw_killed,
45     kw_undef,
46
47     // Identifier tokens
48     Identifier,
49     NamedRegister,
50     MachineBasicBlock,
51     NamedGlobalValue,
52     GlobalValue,
53
54     // Other tokens
55     IntegerLiteral,
56     VirtualRegister,
57     JumpTableIndex
58   };
59
60 private:
61   TokenKind Kind;
62   unsigned StringOffset;
63   StringRef Range;
64   APSInt IntVal;
65
66 public:
67   MIToken(TokenKind Kind, StringRef Range, unsigned StringOffset = 0)
68       : Kind(Kind), StringOffset(StringOffset), Range(Range) {}
69
70   MIToken(TokenKind Kind, StringRef Range, const APSInt &IntVal,
71           unsigned StringOffset = 0)
72       : Kind(Kind), StringOffset(StringOffset), Range(Range), IntVal(IntVal) {}
73
74   TokenKind kind() const { return Kind; }
75
76   bool isError() const { return Kind == Error; }
77
78   bool isRegister() const {
79     return Kind == NamedRegister || Kind == underscore ||
80            Kind == VirtualRegister;
81   }
82
83   bool isRegisterFlag() const {
84     return Kind == kw_implicit || Kind == kw_implicit_define ||
85            Kind == kw_dead || Kind == kw_killed || Kind == kw_undef;
86   }
87
88   bool is(TokenKind K) const { return Kind == K; }
89
90   bool isNot(TokenKind K) const { return Kind != K; }
91
92   StringRef::iterator location() const { return Range.begin(); }
93
94   StringRef stringValue() const { return Range.drop_front(StringOffset); }
95
96   const APSInt &integerValue() const { return IntVal; }
97
98   bool hasIntegerValue() const {
99     return Kind == IntegerLiteral || Kind == MachineBasicBlock ||
100            Kind == GlobalValue || Kind == VirtualRegister ||
101            Kind == JumpTableIndex;
102   }
103 };
104
105 /// Consume a single machine instruction token in the given source and return
106 /// the remaining source string.
107 StringRef lexMIToken(
108     StringRef Source, MIToken &Token,
109     function_ref<void(StringRef::iterator, const Twine &)> ErrorCallback);
110
111 } // end namespace llvm
112
113 #endif