1 //===--- Builtins.h - Builtin function header -------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines enum values for all the target-independent builtin
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CLANG_BASIC_BUILTINS_H
16 #define LLVM_CLANG_BASIC_BUILTINS_H
20 // VC++ defines 'alloca' as an object-like macro, which interferes with our
25 template <typename T> class SmallVectorImpl;
30 class IdentifierTable;
36 C_LANG = 0x1, // builtin for c only.
37 CXX_LANG = 0x2, // builtin for cplusplus only.
38 OBJC_LANG = 0x4, // builtin for objective-c and objective-c++
39 ALL_LANGUAGES = (C_LANG|CXX_LANG|OBJC_LANG) //builtin is for all languages.
44 NotBuiltin = 0, // This is not a builtin function.
45 #define BUILTIN(ID, TYPE, ATTRS) BI##ID,
46 #include "clang/Basic/Builtins.def"
51 const char *Name, *Type, *Attributes, *HeaderName;
52 LanguageID builtin_lang;
55 bool operator==(const Info &RHS) const {
56 return !strcmp(Name, RHS.Name) &&
57 !strcmp(Type, RHS.Type) &&
58 !strcmp(Attributes, RHS.Attributes);
60 bool operator!=(const Info &RHS) const { return !(*this == RHS); }
63 /// Builtin::Context - This holds information about target-independent and
64 /// target-specific builtins, allowing easy queries by clients.
66 const Info *TSRecords;
67 unsigned NumTSRecords;
69 Context(const TargetInfo &Target);
71 /// InitializeBuiltins - Mark the identifiers for all the builtins with their
72 /// appropriate builtin ID # and mark any non-portable builtin identifiers as
74 void InitializeBuiltins(IdentifierTable &Table, const LangOptions& LangOpts);
76 /// \brief Popular the vector with the names of all of the builtins.
77 void GetBuiltinNames(llvm::SmallVectorImpl<const char *> &Names,
80 /// Builtin::GetName - Return the identifier name for the specified builtin,
81 /// e.g. "__builtin_abs".
82 const char *GetName(unsigned ID) const {
83 return GetRecord(ID).Name;
86 /// GetTypeString - Get the type descriptor string for the specified builtin.
87 const char *GetTypeString(unsigned ID) const {
88 return GetRecord(ID).Type;
91 /// isConst - Return true if this function has no side effects and doesn't
93 bool isConst(unsigned ID) const {
94 return strchr(GetRecord(ID).Attributes, 'c') != 0;
97 /// isNoThrow - Return true if we know this builtin never throws an exception.
98 bool isNoThrow(unsigned ID) const {
99 return strchr(GetRecord(ID).Attributes, 'n') != 0;
102 /// isNoReturn - Return true if we know this builtin never returns.
103 bool isNoReturn(unsigned ID) const {
104 return strchr(GetRecord(ID).Attributes, 'r') != 0;
107 /// isLibFunction - Return true if this is a builtin for a libc/libm function,
108 /// with a "__builtin_" prefix (e.g. __builtin_abs).
109 bool isLibFunction(unsigned ID) const {
110 return strchr(GetRecord(ID).Attributes, 'F') != 0;
113 /// \brief Determines whether this builtin is a predefined libc/libm
114 /// function, such as "malloc", where we know the signature a
116 bool isPredefinedLibFunction(unsigned ID) const {
117 return strchr(GetRecord(ID).Attributes, 'f') != 0;
120 /// \brief Determines whether this builtin has custom typechecking.
121 bool hasCustomTypechecking(unsigned ID) const {
122 return strchr(GetRecord(ID).Attributes, 't') != 0;
125 /// \brief Completely forget that the given ID was ever considered a builtin,
126 /// e.g., because the user provided a conflicting signature.
127 void ForgetBuiltin(unsigned ID, IdentifierTable &Table);
129 /// \brief If this is a library function that comes from a specific
130 /// header, retrieve that header name.
131 const char *getHeaderName(unsigned ID) const {
132 return GetRecord(ID).HeaderName;
135 /// \brief Determine whether this builtin is like printf in its
136 /// formatting rules and, if so, set the index to the format string
137 /// argument and whether this function as a va_list argument.
138 bool isPrintfLike(unsigned ID, unsigned &FormatIdx, bool &HasVAListArg);
140 /// \brief Determine whether this builtin is like scanf in its
141 /// formatting rules and, if so, set the index to the format string
142 /// argument and whether this function as a va_list argument.
143 bool isScanfLike(unsigned ID, unsigned &FormatIdx, bool &HasVAListArg);
145 /// isConstWithoutErrno - Return true if this function has no side
146 /// effects and doesn't read memory, except for possibly errno. Such
147 /// functions can be const when the MathErrno lang option is
149 bool isConstWithoutErrno(unsigned ID) const {
150 return strchr(GetRecord(ID).Attributes, 'e') != 0;
154 const Info &GetRecord(unsigned ID) const;
158 } // end namespace clang