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;
54 bool operator==(const Info &RHS) const {
55 return !strcmp(Name, RHS.Name) &&
56 !strcmp(Type, RHS.Type) &&
57 !strcmp(Attributes, RHS.Attributes);
59 bool operator!=(const Info &RHS) const { return !(*this == RHS); }
62 /// Builtin::Context - This holds information about target-independent and
63 /// target-specific builtins, allowing easy queries by clients.
65 const Info *TSRecords;
66 unsigned NumTSRecords;
68 Context(const TargetInfo &Target);
70 /// InitializeBuiltins - Mark the identifiers for all the builtins with their
71 /// appropriate builtin ID # and mark any non-portable builtin identifiers as
73 void InitializeBuiltins(IdentifierTable &Table, const LangOptions& LangOpts);
75 /// \brief Popular the vector with the names of all of the builtins.
76 void GetBuiltinNames(llvm::SmallVectorImpl<const char *> &Names,
79 /// Builtin::GetName - Return the identifier name for the specified builtin,
80 /// e.g. "__builtin_abs".
81 const char *GetName(unsigned ID) const {
82 return GetRecord(ID).Name;
85 /// GetTypeString - Get the type descriptor string for the specified builtin.
86 const char *GetTypeString(unsigned ID) const {
87 return GetRecord(ID).Type;
90 /// isConst - Return true if this function has no side effects and doesn't
92 bool isConst(unsigned ID) const {
93 return strchr(GetRecord(ID).Attributes, 'c') != 0;
96 /// isNoThrow - Return true if we know this builtin never throws an exception.
97 bool isNoThrow(unsigned ID) const {
98 return strchr(GetRecord(ID).Attributes, 'n') != 0;
101 /// isNoReturn - Return true if we know this builtin never returns.
102 bool isNoReturn(unsigned ID) const {
103 return strchr(GetRecord(ID).Attributes, 'r') != 0;
106 /// isLibFunction - Return true if this is a builtin for a libc/libm function,
107 /// with a "__builtin_" prefix (e.g. __builtin_abs).
108 bool isLibFunction(unsigned ID) const {
109 return strchr(GetRecord(ID).Attributes, 'F') != 0;
112 /// \brief Determines whether this builtin is a predefined libc/libm
113 /// function, such as "malloc", where we know the signature a
115 bool isPredefinedLibFunction(unsigned ID) const {
116 return strchr(GetRecord(ID).Attributes, 'f') != 0;
119 /// \brief Determines whether this builtin has custom typechecking.
120 bool hasCustomTypechecking(unsigned ID) const {
121 return strchr(GetRecord(ID).Attributes, 't') != 0;
124 /// \brief Completely forget that the given ID was ever considered a builtin,
125 /// e.g., because the user provided a conflicting signature.
126 void ForgetBuiltin(unsigned ID, IdentifierTable &Table);
128 /// \brief If this is a library function that comes from a specific
129 /// header, retrieve that header name.
130 const char *getHeaderName(unsigned ID) const {
131 return GetRecord(ID).HeaderName;
134 /// \brief Determine whether this builtin is like printf in its
135 /// formatting rules and, if so, set the index to the format string
136 /// argument and whether this function as a va_list argument.
137 bool isPrintfLike(unsigned ID, unsigned &FormatIdx, bool &HasVAListArg);
139 /// \brief Determine whether this builtin is like scanf in its
140 /// formatting rules and, if so, set the index to the format string
141 /// argument and whether this function as a va_list argument.
142 bool isScanfLike(unsigned ID, unsigned &FormatIdx, bool &HasVAListArg);
144 /// isConstWithoutErrno - Return true if this function has no side
145 /// effects and doesn't read memory, except for possibly errno. Such
146 /// functions can be const when the MathErrno lang option is
148 bool isConstWithoutErrno(unsigned ID) const {
149 return strchr(GetRecord(ID).Attributes, 'e') != 0;
153 const Info &GetRecord(unsigned ID) const;
157 } // end namespace clang