lib/AsmParser/ParserInternals.h

   1 //===-- ParserInternals.h - Definitions internal to the parser --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This header file defines the various variables that are shared among the
  11 //  different components of the parser...
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef PARSER_INTERNALS_H
  16 #define PARSER_INTERNALS_H
  17
  18 #include "llvm/Constants.h"
  19 #include "llvm/DerivedTypes.h"
  20 #include "llvm/Function.h"
  21 #include "llvm/Instructions.h"
  22 #include "llvm/Assembly/Parser.h"
  23 #include "Support/StringExtras.h"
  24
  25 // Global variables exported from the lexer...
  26 extern std::FILE *llvmAsmin;
  27 extern int llvmAsmlineno;
  28
  29 // Globals exported by the parser...
  30 extern char* llvmAsmtext;
  31 extern int   llvmAsmleng;
  32
  33 namespace llvm {
  34
  35 // Globals exported by the parser...
  36 extern std::string CurFilename;
  37
  38 class Module;
  39 Module *RunVMAsmParser(const std::string &Filename, FILE *F);
  40
  41
  42 // UnEscapeLexed - Run through the specified buffer and change \xx codes to the
  43 // appropriate character.  If AllowNull is set to false, a \00 value will cause
  44 // an exception to be thrown.
  45 //
  46 // If AllowNull is set to true, the return value of the function points to the
  47 // last character of the string in memory.
  48 //
  49 char *UnEscapeLexed(char *Buffer, bool AllowNull = false);
  50
  51
  52 // ThrowException - Wrapper around the ParseException class that automatically
  53 // fills in file line number and column number and options info.
  54 //
  55 // This also helps me because I keep typing 'throw new ParseException' instead
  56 // of just 'throw ParseException'... sigh...
  57 //
  58 static inline void ThrowException(const std::string &message,
  59                                   int LineNo = -1) {
  60   if (LineNo == -1) LineNo = llvmAsmlineno;
  61   // TODO: column number in exception
  62   throw ParseException(CurFilename, message, LineNo);
  63 }
  64
  65 // ValID - Represents a reference of a definition of some sort.  This may either
  66 // be a numeric reference or a symbolic (%var) reference.  This is just a
  67 // discriminated union.
  68 //
  69 // Note that I can't implement this class in a straight forward manner with
  70 // constructors and stuff because it goes in a union.
  71 //
  72 struct ValID {
  73   enum {
  74     NumberVal, NameVal, ConstSIntVal, ConstUIntVal, ConstFPVal, ConstNullVal,
  75     ConstantVal,
  76   } Type;
  77
  78   union {
  79     int      Num;         // If it's a numeric reference
  80     char    *Name;        // If it's a named reference.  Memory must be free'd.
  81     int64_t  ConstPool64; // Constant pool reference.  This is the value
  82     uint64_t UConstPool64;// Unsigned constant pool reference.
  83     double   ConstPoolFP; // Floating point constant pool reference
  84     Constant *ConstantValue; // Fully resolved constant for ConstantVal case.
  85   };
  86
  87   static ValID create(int Num) {
  88     ValID D; D.Type = NumberVal; D.Num = Num; return D;
  89   }
  90
  91   static ValID create(char *Name) {
  92     ValID D; D.Type = NameVal; D.Name = Name; return D;
  93   }
  94
  95   static ValID create(int64_t Val) {
  96     ValID D; D.Type = ConstSIntVal; D.ConstPool64 = Val; return D;
  97   }
  98
  99   static ValID create(uint64_t Val) {
 100     ValID D; D.Type = ConstUIntVal; D.UConstPool64 = Val; return D;
 101   }
 102
 103   static ValID create(double Val) {
 104     ValID D; D.Type = ConstFPVal; D.ConstPoolFP = Val; return D;
 105   }
 106
 107   static ValID createNull() {
 108     ValID D; D.Type = ConstNullVal; return D;
 109   }
 110
 111   static ValID create(Constant *Val) {
 112     ValID D; D.Type = ConstantVal; D.ConstantValue = Val; return D;
 113   }
 114
 115   inline void destroy() const {
 116     if (Type == NameVal)
 117       free(Name);    // Free this strdup'd memory...
 118   }
 119
 120   inline ValID copy() const {
 121     if (Type != NameVal) return *this;
 122     ValID Result = *this;
 123     Result.Name = strdup(Name);
 124     return Result;
 125   }
 126
 127   inline std::string getName() const {
 128     switch (Type) {
 129     case NumberVal     : return std::string("#") + itostr(Num);
 130     case NameVal       : return Name;
 131     case ConstFPVal    : return ftostr(ConstPoolFP);
 132     case ConstNullVal  : return "null";
 133     case ConstUIntVal  :
 134     case ConstSIntVal  : return std::string("%") + itostr(ConstPool64);
 135     case ConstantVal:
 136       if (ConstantValue == ConstantBool::True) return "true";
 137       if (ConstantValue == ConstantBool::False) return "false";
 138       return "<constant expression>";
 139     default:
 140       assert(0 && "Unknown value!");
 141       abort();
 142       return "";
 143     }
 144   }
 145
 146   bool operator<(const ValID &V) const {
 147     if (Type != V.Type) return Type < V.Type;
 148     switch (Type) {
 149     case NumberVal:     return Num < V.Num;
 150     case NameVal:       return strcmp(Name, V.Name) < 0;
 151     case ConstSIntVal:  return ConstPool64  < V.ConstPool64;
 152     case ConstUIntVal:  return UConstPool64 < V.UConstPool64;
 153     case ConstFPVal:    return ConstPoolFP  < V.ConstPoolFP;
 154     case ConstNullVal:  return false;
 155     case ConstantVal:   return ConstantValue < V.ConstantValue;
 156     default:  assert(0 && "Unknown value type!"); return false;
 157     }
 158   }
 159 };
 160
 161 } // End llvm namespace
 162
 163 #endif