lib/AsmParser/ParserInternals.h

   1 //===-- ParserInternals.h - Definitions internal to the parser ---*- C++ -*--=//
   2 //
   3 //  This header file defines the various variables that are shared among the
   4 //  different components of the parser...
   5 //
   6 //===----------------------------------------------------------------------===//
   7
   8 #ifndef PARSER_INTERNALS_H
   9 #define PARSER_INTERNALS_H
  10
  11 #define __STDC_LIMIT_MACROS
  12 #include "llvm/BasicBlock.h"
  13 #include "llvm/Constants.h"
  14 #include "llvm/iOther.h"
  15 #include "llvm/Function.h"
  16 #include "llvm/DerivedTypes.h"
  17 #include "llvm/Assembly/Parser.h"
  18 #include "Support/StringExtras.h"
  19
  20 class Module;
  21
  22 // Global variables exported from the lexer...
  23 extern std::FILE *llvmAsmin;
  24 extern int llvmAsmlineno;
  25
  26 // Globals exported by the parser...
  27 extern std::string CurFilename;
  28 Module *RunVMAsmParser(const std::string &Filename, FILE *F);
  29
  30 extern char* llvmAsmtext;
  31 extern int   llvmAsmleng;
  32
  33 // UnEscapeLexed - Run through the specified buffer and change \xx codes to the
  34 // appropriate character.  If AllowNull is set to false, a \00 value will cause
  35 // an exception to be thrown.
  36 //
  37 // If AllowNull is set to true, the return value of the function points to the
  38 // last character of the string in memory.
  39 //
  40 char *UnEscapeLexed(char *Buffer, bool AllowNull = false);
  41
  42
  43 // ThrowException - Wrapper around the ParseException class that automatically
  44 // fills in file line number and column number and options info.
  45 //
  46 // This also helps me because I keep typing 'throw new ParseException' instead
  47 // of just 'throw ParseException'... sigh...
  48 //
  49 static inline void ThrowException(const std::string &message,
  50                                   int LineNo = -1) {
  51   if (LineNo == -1) LineNo = llvmAsmlineno;
  52   // TODO: column number in exception
  53   throw ParseException(CurFilename, message, LineNo);
  54 }
  55
  56 // ValID - Represents a reference of a definition of some sort.  This may either
  57 // be a numeric reference or a symbolic (%var) reference.  This is just a
  58 // discriminated union.
  59 //
  60 // Note that I can't implement this class in a straight forward manner with
  61 // constructors and stuff because it goes in a union, and GCC doesn't like
  62 // putting classes with ctor's in unions.  :(
  63 //
  64 struct ValID {
  65   enum {
  66     NumberVal, NameVal, ConstSIntVal, ConstUIntVal, ConstFPVal, ConstNullVal
  67   } Type;
  68
  69   union {
  70     int      Num;         // If it's a numeric reference
  71     char    *Name;        // If it's a named reference.  Memory must be free'd.
  72     int64_t  ConstPool64; // Constant pool reference.  This is the value
  73     uint64_t UConstPool64;// Unsigned constant pool reference.
  74     double   ConstPoolFP; // Floating point constant pool reference
  75   };
  76
  77   static ValID create(int Num) {
  78     ValID D; D.Type = NumberVal; D.Num = Num; return D;
  79   }
  80
  81   static ValID create(char *Name) {
  82     ValID D; D.Type = NameVal; D.Name = Name; return D;
  83   }
  84
  85   static ValID create(int64_t Val) {
  86     ValID D; D.Type = ConstSIntVal; D.ConstPool64 = Val; return D;
  87   }
  88
  89   static ValID create(uint64_t Val) {
  90     ValID D; D.Type = ConstUIntVal; D.UConstPool64 = Val; return D;
  91   }
  92
  93   static ValID create(double Val) {
  94     ValID D; D.Type = ConstFPVal; D.ConstPoolFP = Val; return D;
  95   }
  96
  97   static ValID createNull() {
  98     ValID D; D.Type = ConstNullVal; return D;
  99   }
 100
 101   inline void destroy() const {
 102     if (Type == NameVal)
 103       free(Name);    // Free this strdup'd memory...
 104   }
 105
 106   inline ValID copy() const {
 107     if (Type != NameVal) return *this;
 108     ValID Result = *this;
 109     Result.Name = strdup(Name);
 110     return Result;
 111   }
 112
 113   inline std::string getName() const {
 114     switch (Type) {
 115     case NumberVal     : return std::string("#") + itostr(Num);
 116     case NameVal       : return Name;
 117     case ConstFPVal    : return ftostr(ConstPoolFP);
 118     case ConstNullVal  : return "null";
 119     case ConstUIntVal  :
 120     case ConstSIntVal  : return std::string("%") + itostr(ConstPool64);
 121     default:
 122       assert(0 && "Unknown value!");
 123       abort();
 124       return "";
 125     }
 126   }
 127
 128   bool operator<(const ValID &V) const {
 129     if (Type != V.Type) return Type < V.Type;
 130     switch (Type) {
 131     case NumberVal:     return Num < V.Num;
 132     case NameVal:       return strcmp(Name, V.Name) < 0;
 133     case ConstSIntVal:  return ConstPool64  < V.ConstPool64;
 134     case ConstUIntVal:  return UConstPool64 < V.UConstPool64;
 135     case ConstFPVal:    return ConstPoolFP  < V.ConstPoolFP;
 136     case ConstNullVal:  return false;
 137     default:  assert(0 && "Unknown value type!"); return false;
 138     }
 139   }
 140 };
 141
 142
 143
 144 template<class SuperType>
 145 class PlaceholderValue : public SuperType {
 146   ValID D;
 147   int LineNum;
 148 public:
 149   PlaceholderValue(const Type *Ty, const ValID &d) : SuperType(Ty), D(d) {
 150     LineNum = llvmAsmlineno;
 151   }
 152   ValID &getDef() { return D; }
 153   int getLineNum() const { return LineNum; }
 154 };
 155
 156 struct InstPlaceHolderHelper : public Instruction {
 157   InstPlaceHolderHelper(const Type *Ty) : Instruction(Ty, UserOp1, "") {}
 158
 159   virtual Instruction *clone() const { abort(); return 0; }
 160   virtual const char *getOpcodeName() const { return "placeholder"; }
 161 };
 162
 163 struct BBPlaceHolderHelper : public BasicBlock {
 164   BBPlaceHolderHelper(const Type *Ty) : BasicBlock() {
 165     assert(Ty == Type::LabelTy);
 166   }
 167 };
 168
 169 struct MethPlaceHolderHelper : public Function {
 170   MethPlaceHolderHelper(const Type *Ty)
 171     : Function(cast<FunctionType>(Ty), true) {}
 172 };
 173
 174 typedef PlaceholderValue<InstPlaceHolderHelper>  ValuePlaceHolder;
 175 typedef PlaceholderValue<BBPlaceHolderHelper>    BBPlaceHolder;
 176
 177 static inline ValID &getValIDFromPlaceHolder(const Value *Val) {
 178   const Type *Ty = Val->getType();
 179   if (isa<PointerType>(Ty) &&
 180       isa<FunctionType>(cast<PointerType>(Ty)->getElementType()))
 181     Ty = cast<PointerType>(Ty)->getElementType();
 182
 183   switch (Ty->getPrimitiveID()) {
 184   case Type::LabelTyID:  return ((BBPlaceHolder*)Val)->getDef();
 185   default:               return ((ValuePlaceHolder*)Val)->getDef();
 186   }
 187 }
 188
 189 static inline int getLineNumFromPlaceHolder(const Value *Val) {
 190   const Type *Ty = Val->getType();
 191   if (isa<PointerType>(Ty) &&
 192       isa<FunctionType>(cast<PointerType>(Ty)->getElementType()))
 193     Ty = cast<PointerType>(Ty)->getElementType();
 194
 195   switch (Ty->getPrimitiveID()) {
 196   case Type::LabelTyID:  return ((BBPlaceHolder*)Val)->getLineNum();
 197   default:               return ((ValuePlaceHolder*)Val)->getLineNum();
 198   }
 199 }
 200
 201 #endif