APValue.h revision 65639284118d54ddf2e51a05d2ffccda567fe246 
1//===--- APValue.h - Union class for APFloat/APSInt/Complex -----*- C++ -*-===//
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 defines the APValue class.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CLANG_AST_APVALUE_H
15#define LLVM_CLANG_AST_APVALUE_H
16
17#include "clang/Basic/LLVM.h"
18#include "llvm/ADT/APSInt.h"
19#include "llvm/ADT/APFloat.h"
20#include "llvm/ADT/PointerIntPair.h"
21#include "llvm/ADT/PointerUnion.h"
22
23namespace clang {
24  class AddrLabelExpr;
25  class ASTContext;
26  class CharUnits;
27  class DiagnosticBuilder;
28  class Expr;
29  class FieldDecl;
30  class Decl;
31  class ValueDecl;
32  class CXXRecordDecl;
33  class QualType;
34
35/// APValue - This class implements a discriminated union of [uninitialized]
36/// [APSInt] [APFloat], [Complex APSInt] [Complex APFloat], [Expr + Offset],
37/// [Vector: N * APValue], [Array: N * APValue]
38class APValue {
39  typedef llvm::APSInt APSInt;
40  typedef llvm::APFloat APFloat;
41public:
42  enum ValueKind {
43    Uninitialized,
44    Int,
45    Float,
46    ComplexInt,
47    ComplexFloat,
48    LValue,
49    Vector,
50    Array,
51    Struct,
52    Union,
53    MemberPointer,
54    AddrLabelDiff
55  };
56  typedef llvm::PointerUnion<const ValueDecl *, const Expr *> LValueBase;
57  typedef llvm::PointerIntPair<const Decl *, 1, bool> BaseOrMemberType;
58  union LValuePathEntry {
59    /// BaseOrMember - The FieldDecl or CXXRecordDecl indicating the next item
60    /// in the path. An opaque value of type BaseOrMemberType.
61    void *BaseOrMember;
62    /// ArrayIndex - The array index of the next item in the path.
63    uint64_t ArrayIndex;
64  };
65  struct NoLValuePath {};
66  struct UninitArray {};
67  struct UninitStruct {};
68private:
69  ValueKind Kind;
70
71  struct ComplexAPSInt {
72    APSInt Real, Imag;
73    ComplexAPSInt() : Real(1), Imag(1) {}
74  };
75  struct ComplexAPFloat {
76    APFloat Real, Imag;
77    ComplexAPFloat() : Real(0.0), Imag(0.0) {}
78  };
79  struct LV;
80  struct Vec {
81    APValue *Elts;
82    unsigned NumElts;
83    Vec() : Elts(0), NumElts(0) {}
84    ~Vec() { delete[] Elts; }
85  };
86  struct Arr {
87    APValue *Elts;
88    unsigned NumElts, ArrSize;
89    Arr(unsigned NumElts, unsigned ArrSize);
90    ~Arr();
91  };
92  struct StructData {
93    APValue *Elts;
94    unsigned NumBases;
95    unsigned NumFields;
96    StructData(unsigned NumBases, unsigned NumFields);
97    ~StructData();
98  };
99  struct UnionData {
100    const FieldDecl *Field;
101    APValue *Value;
102    UnionData();
103    ~UnionData();
104  };
105  struct AddrLabelDiffData {
106    const AddrLabelExpr* LHSExpr;
107    const AddrLabelExpr* RHSExpr;
108  };
109  struct MemberPointerData;
110
111  enum {
112    MaxSize = (sizeof(ComplexAPSInt) > sizeof(ComplexAPFloat) ?
113               sizeof(ComplexAPSInt) : sizeof(ComplexAPFloat))
114  };
115
116  union {
117    void *Aligner;
118    char Data[MaxSize];
119  };
120
121public:
122  APValue() : Kind(Uninitialized) {}
123  explicit APValue(const APSInt &I) : Kind(Uninitialized) {
124    MakeInt(); setInt(I);
125  }
126  explicit APValue(const APFloat &F) : Kind(Uninitialized) {
127    MakeFloat(); setFloat(F);
128  }
129  explicit APValue(const APValue *E, unsigned N) : Kind(Uninitialized) {
130    MakeVector(); setVector(E, N);
131  }
132  APValue(const APSInt &R, const APSInt &I) : Kind(Uninitialized) {
133    MakeComplexInt(); setComplexInt(R, I);
134  }
135  APValue(const APFloat &R, const APFloat &I) : Kind(Uninitialized) {
136    MakeComplexFloat(); setComplexFloat(R, I);
137  }
138  APValue(const APValue &RHS) : Kind(Uninitialized) {
139    *this = RHS;
140  }
141  APValue(LValueBase B, const CharUnits &O, NoLValuePath N)
142      : Kind(Uninitialized) {
143    MakeLValue(); setLValue(B, O, N);
144  }
145  APValue(LValueBase B, const CharUnits &O, ArrayRef<LValuePathEntry> Path,
146          bool OnePastTheEnd)
147      : Kind(Uninitialized) {
148    MakeLValue(); setLValue(B, O, Path, OnePastTheEnd);
149  }
150  APValue(UninitArray, unsigned InitElts, unsigned Size) : Kind(Uninitialized) {
151    MakeArray(InitElts, Size);
152  }
153  APValue(UninitStruct, unsigned B, unsigned M) : Kind(Uninitialized) {
154    MakeStruct(B, M);
155  }
156  explicit APValue(const FieldDecl *D, const APValue &V = APValue())
157      : Kind(Uninitialized) {
158    MakeUnion(); setUnion(D, V);
159  }
160  APValue(const ValueDecl *Member, bool IsDerivedMember,
161          ArrayRef<const CXXRecordDecl*> Path) : Kind(Uninitialized) {
162    MakeMemberPointer(Member, IsDerivedMember, Path);
163  }
164  APValue(const AddrLabelExpr* LHSExpr, const AddrLabelExpr* RHSExpr)
165      : Kind(Uninitialized) {
166    MakeAddrLabelDiff(); setAddrLabelDiff(LHSExpr, RHSExpr);
167  }
168
169  ~APValue() {
170    MakeUninit();
171  }
172
173  ValueKind getKind() const { return Kind; }
174  bool isUninit() const { return Kind == Uninitialized; }
175  bool isInt() const { return Kind == Int; }
176  bool isFloat() const { return Kind == Float; }
177  bool isComplexInt() const { return Kind == ComplexInt; }
178  bool isComplexFloat() const { return Kind == ComplexFloat; }
179  bool isLValue() const { return Kind == LValue; }
180  bool isVector() const { return Kind == Vector; }
181  bool isArray() const { return Kind == Array; }
182  bool isStruct() const { return Kind == Struct; }
183  bool isUnion() const { return Kind == Union; }
184  bool isMemberPointer() const { return Kind == MemberPointer; }
185  bool isAddrLabelDiff() const { return Kind == AddrLabelDiff; }
186
187  void dump() const;
188  void dump(raw_ostream &OS) const;
189
190  void printPretty(raw_ostream &OS, ASTContext &Ctx, QualType Ty) const;
191  std::string getAsString(ASTContext &Ctx, QualType Ty) const;
192
193  APSInt &getInt() {
194    assert(isInt() && "Invalid accessor");
195    return *(APSInt*)(char*)Data;
196  }
197  const APSInt &getInt() const {
198    return const_cast<APValue*>(this)->getInt();
199  }
200
201  APFloat &getFloat() {
202    assert(isFloat() && "Invalid accessor");
203    return *(APFloat*)(char*)Data;
204  }
205  const APFloat &getFloat() const {
206    return const_cast<APValue*>(this)->getFloat();
207  }
208
209  APSInt &getComplexIntReal() {
210    assert(isComplexInt() && "Invalid accessor");
211    return ((ComplexAPSInt*)(char*)Data)->Real;
212  }
213  const APSInt &getComplexIntReal() const {
214    return const_cast<APValue*>(this)->getComplexIntReal();
215  }
216
217  APSInt &getComplexIntImag() {
218    assert(isComplexInt() && "Invalid accessor");
219    return ((ComplexAPSInt*)(char*)Data)->Imag;
220  }
221  const APSInt &getComplexIntImag() const {
222    return const_cast<APValue*>(this)->getComplexIntImag();
223  }
224
225  APFloat &getComplexFloatReal() {
226    assert(isComplexFloat() && "Invalid accessor");
227    return ((ComplexAPFloat*)(char*)Data)->Real;
228  }
229  const APFloat &getComplexFloatReal() const {
230    return const_cast<APValue*>(this)->getComplexFloatReal();
231  }
232
233  APFloat &getComplexFloatImag() {
234    assert(isComplexFloat() && "Invalid accessor");
235    return ((ComplexAPFloat*)(char*)Data)->Imag;
236  }
237  const APFloat &getComplexFloatImag() const {
238    return const_cast<APValue*>(this)->getComplexFloatImag();
239  }
240
241  const LValueBase getLValueBase() const;
242  CharUnits &getLValueOffset();
243  const CharUnits &getLValueOffset() const {
244    return const_cast<APValue*>(this)->getLValueOffset();
245  }
246  bool isLValueOnePastTheEnd() const;
247  bool hasLValuePath() const;
248  ArrayRef<LValuePathEntry> getLValuePath() const;
249
250  APValue &getVectorElt(unsigned I) {
251    assert(isVector() && "Invalid accessor");
252    assert(I < getVectorLength() && "Index out of range");
253    return ((Vec*)(char*)Data)->Elts[I];
254  }
255  const APValue &getVectorElt(unsigned I) const {
256    return const_cast<APValue*>(this)->getVectorElt(I);
257  }
258  unsigned getVectorLength() const {
259    assert(isVector() && "Invalid accessor");
260    return ((const Vec*)(const void *)Data)->NumElts;
261  }
262
263  APValue &getArrayInitializedElt(unsigned I) {
264    assert(isArray() && "Invalid accessor");
265    assert(I < getArrayInitializedElts() && "Index out of range");
266    return ((Arr*)(char*)Data)->Elts[I];
267  }
268  const APValue &getArrayInitializedElt(unsigned I) const {
269    return const_cast<APValue*>(this)->getArrayInitializedElt(I);
270  }
271  bool hasArrayFiller() const {
272    return getArrayInitializedElts() != getArraySize();
273  }
274  APValue &getArrayFiller() {
275    assert(isArray() && "Invalid accessor");
276    assert(hasArrayFiller() && "No array filler");
277    return ((Arr*)(char*)Data)->Elts[getArrayInitializedElts()];
278  }
279  const APValue &getArrayFiller() const {
280    return const_cast<APValue*>(this)->getArrayFiller();
281  }
282  unsigned getArrayInitializedElts() const {
283    assert(isArray() && "Invalid accessor");
284    return ((const Arr*)(const void *)Data)->NumElts;
285  }
286  unsigned getArraySize() const {
287    assert(isArray() && "Invalid accessor");
288    return ((const Arr*)(const void *)Data)->ArrSize;
289  }
290
291  unsigned getStructNumBases() const {
292    assert(isStruct() && "Invalid accessor");
293    return ((const StructData*)(const char*)Data)->NumBases;
294  }
295  unsigned getStructNumFields() const {
296    assert(isStruct() && "Invalid accessor");
297    return ((const StructData*)(const char*)Data)->NumFields;
298  }
299  APValue &getStructBase(unsigned i) {
300    assert(isStruct() && "Invalid accessor");
301    return ((StructData*)(char*)Data)->Elts[i];
302  }
303  APValue &getStructField(unsigned i) {
304    assert(isStruct() && "Invalid accessor");
305    return ((StructData*)(char*)Data)->Elts[getStructNumBases() + i];
306  }
307  const APValue &getStructBase(unsigned i) const {
308    return const_cast<APValue*>(this)->getStructBase(i);
309  }
310  const APValue &getStructField(unsigned i) const {
311    return const_cast<APValue*>(this)->getStructField(i);
312  }
313
314  const FieldDecl *getUnionField() const {
315    assert(isUnion() && "Invalid accessor");
316    return ((const UnionData*)(const char*)Data)->Field;
317  }
318  APValue &getUnionValue() {
319    assert(isUnion() && "Invalid accessor");
320    return *((UnionData*)(char*)Data)->Value;
321  }
322  const APValue &getUnionValue() const {
323    return const_cast<APValue*>(this)->getUnionValue();
324  }
325
326  const ValueDecl *getMemberPointerDecl() const;
327  bool isMemberPointerToDerivedMember() const;
328  ArrayRef<const CXXRecordDecl*> getMemberPointerPath() const;
329
330  const AddrLabelExpr* getAddrLabelDiffLHS() const {
331    assert(isAddrLabelDiff() && "Invalid accessor");
332    return ((AddrLabelDiffData*)(char*)Data)->LHSExpr;
333  }
334  const AddrLabelExpr* getAddrLabelDiffRHS() const {
335    assert(isAddrLabelDiff() && "Invalid accessor");
336    return ((AddrLabelDiffData*)(char*)Data)->RHSExpr;
337  }
338
339  void setInt(const APSInt &I) {
340    assert(isInt() && "Invalid accessor");
341    *(APSInt*)(char*)Data = I;
342  }
343  void setFloat(const APFloat &F) {
344    assert(isFloat() && "Invalid accessor");
345    *(APFloat*)(char*)Data = F;
346  }
347  void setVector(const APValue *E, unsigned N) {
348    assert(isVector() && "Invalid accessor");
349    ((Vec*)(char*)Data)->Elts = new APValue[N];
350    ((Vec*)(char*)Data)->NumElts = N;
351    for (unsigned i = 0; i != N; ++i)
352      ((Vec*)(char*)Data)->Elts[i] = E[i];
353  }
354  void setComplexInt(const APSInt &R, const APSInt &I) {
355    assert(R.getBitWidth() == I.getBitWidth() &&
356           "Invalid complex int (type mismatch).");
357    assert(isComplexInt() && "Invalid accessor");
358    ((ComplexAPSInt*)(char*)Data)->Real = R;
359    ((ComplexAPSInt*)(char*)Data)->Imag = I;
360  }
361  void setComplexFloat(const APFloat &R, const APFloat &I) {
362    assert(&R.getSemantics() == &I.getSemantics() &&
363           "Invalid complex float (type mismatch).");
364    assert(isComplexFloat() && "Invalid accessor");
365    ((ComplexAPFloat*)(char*)Data)->Real = R;
366    ((ComplexAPFloat*)(char*)Data)->Imag = I;
367  }
368  void setLValue(LValueBase B, const CharUnits &O, NoLValuePath);
369  void setLValue(LValueBase B, const CharUnits &O,
370                 ArrayRef<LValuePathEntry> Path, bool OnePastTheEnd);
371  void setUnion(const FieldDecl *Field, const APValue &Value) {
372    assert(isUnion() && "Invalid accessor");
373    ((UnionData*)(char*)Data)->Field = Field;
374    *((UnionData*)(char*)Data)->Value = Value;
375  }
376  void setAddrLabelDiff(const AddrLabelExpr* LHSExpr,
377                        const AddrLabelExpr* RHSExpr) {
378    ((AddrLabelDiffData*)(char*)Data)->LHSExpr = LHSExpr;
379    ((AddrLabelDiffData*)(char*)Data)->RHSExpr = RHSExpr;
380  }
381
382  const APValue &operator=(const APValue &RHS);
383
384private:
385  void MakeUninit();
386  void MakeInt() {
387    assert(isUninit() && "Bad state change");
388    new ((void*)Data) APSInt(1);
389    Kind = Int;
390  }
391  void MakeFloat() {
392    assert(isUninit() && "Bad state change");
393    new ((void*)(char*)Data) APFloat(0.0);
394    Kind = Float;
395  }
396  void MakeVector() {
397    assert(isUninit() && "Bad state change");
398    new ((void*)(char*)Data) Vec();
399    Kind = Vector;
400  }
401  void MakeComplexInt() {
402    assert(isUninit() && "Bad state change");
403    new ((void*)(char*)Data) ComplexAPSInt();
404    Kind = ComplexInt;
405  }
406  void MakeComplexFloat() {
407    assert(isUninit() && "Bad state change");
408    new ((void*)(char*)Data) ComplexAPFloat();
409    Kind = ComplexFloat;
410  }
411  void MakeLValue();
412  void MakeArray(unsigned InitElts, unsigned Size);
413  void MakeStruct(unsigned B, unsigned M) {
414    assert(isUninit() && "Bad state change");
415    new ((void*)(char*)Data) StructData(B, M);
416    Kind = Struct;
417  }
418  void MakeUnion() {
419    assert(isUninit() && "Bad state change");
420    new ((void*)(char*)Data) UnionData();
421    Kind = Union;
422  }
423  void MakeMemberPointer(const ValueDecl *Member, bool IsDerivedMember,
424                         ArrayRef<const CXXRecordDecl*> Path);
425  void MakeAddrLabelDiff() {
426    assert(isUninit() && "Bad state change");
427    new ((void*)(char*)Data) AddrLabelDiffData();
428    Kind = AddrLabelDiff;
429  }
430};
431
432} // end namespace clang.
433
434#endif
435