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