MacroArgs.h revision 23f77e59718385512984d4e2a021bef52b9f6ddf
1e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner//===--- MacroArgs.h - Formal argument info for Macros ----------*- C++ -*-===// 2e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner// 3e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner// The LLVM Compiler Infrastructure 4e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner// 5e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner// This file is distributed under the University of Illinois Open Source 6e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner// License. See LICENSE.TXT for details. 7e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner// 8e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner//===----------------------------------------------------------------------===// 9e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner// 10e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner// This file defines the MacroArgs interface. 11e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner// 12e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner//===----------------------------------------------------------------------===// 13e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner 14e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner#ifndef LLVM_CLANG_MACROARGS_H 15e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner#define LLVM_CLANG_MACROARGS_H 16e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner 17e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner#include <vector> 18e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner 19e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattnernamespace clang { 20e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner class MacroInfo; 21e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner class Preprocessor; 22e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner class Token; 231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 24e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner/// MacroArgs - An instance of this class captures information about 25e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner/// the formal arguments specified to a function-like macro invocation. 26e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattnerclass MacroArgs { 27e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// NumUnexpArgTokens - The number of raw, unexpanded tokens for the 28e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// arguments. All of the actual argument tokens are allocated immediately 29e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// after the MacroArgs object in memory. This is all of the arguments 30e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// concatenated together, with 'EOF' markers at the end of each argument. 31e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner unsigned NumUnexpArgTokens; 32e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner 33561395bead16b9dc9b0d5bfb6b257a9ed4545db6Chris Lattner /// VarargsElided - True if this is a C99 style varargs macro invocation and 34561395bead16b9dc9b0d5bfb6b257a9ed4545db6Chris Lattner /// there was no argument specified for the "..." argument. If the argument 35561395bead16b9dc9b0d5bfb6b257a9ed4545db6Chris Lattner /// was specified (even empty) or this isn't a C99 style varargs function, or 36561395bead16b9dc9b0d5bfb6b257a9ed4545db6Chris Lattner /// if in strict mode and the C99 varargs macro had only a ... argument, this 37561395bead16b9dc9b0d5bfb6b257a9ed4545db6Chris Lattner /// is false. 38561395bead16b9dc9b0d5bfb6b257a9ed4545db6Chris Lattner bool VarargsElided; 39561395bead16b9dc9b0d5bfb6b257a9ed4545db6Chris Lattner 40e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// PreExpArgTokens - Pre-expanded tokens for arguments that need them. Empty 41e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// if not yet computed. This includes the EOF marker at the end of the 42e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// stream. 43e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner std::vector<std::vector<Token> > PreExpArgTokens; 44e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner 45e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// StringifiedArgs - This contains arguments in 'stringified' form. If the 46e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// stringified form of an argument has not yet been computed, this is empty. 47e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner std::vector<Token> StringifiedArgs; 48e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner 4923f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// ArgCache - This is a linked list of MacroArgs objects that the 5023f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// Preprocessor owns which we use to avoid thrashing malloc/free. 5123f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner MacroArgs *ArgCache; 5223f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner 53e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner MacroArgs(unsigned NumToks, bool varargsElided) 5423f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner : NumUnexpArgTokens(NumToks), VarargsElided(varargsElided), ArgCache(0) {} 55e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner ~MacroArgs() {} 56e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattnerpublic: 57e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// MacroArgs ctor function - Create a new MacroArgs object with the specified 58e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// macro and argument info. 59e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner static MacroArgs *create(const MacroInfo *MI, 60e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner const Token *UnexpArgTokens, 61561395bead16b9dc9b0d5bfb6b257a9ed4545db6Chris Lattner unsigned NumArgTokens, bool VarargsElided, 62561395bead16b9dc9b0d5bfb6b257a9ed4545db6Chris Lattner Preprocessor &PP); 631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 64e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// destroy - Destroy and deallocate the memory for this object. 65e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// 66561395bead16b9dc9b0d5bfb6b257a9ed4545db6Chris Lattner void destroy(Preprocessor &PP); 671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 68e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// ArgNeedsPreexpansion - If we can prove that the argument won't be affected 69e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// by pre-expansion, return false. Otherwise, conservatively return true. 70e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner bool ArgNeedsPreexpansion(const Token *ArgTok, Preprocessor &PP) const; 711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 72e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// getUnexpArgument - Return a pointer to the first token of the unexpanded 73e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// token list for the specified formal. 74e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// 75e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner const Token *getUnexpArgument(unsigned Arg) const; 761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 77e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// getArgLength - Given a pointer to an expanded or unexpanded argument, 78e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// return the number of tokens, not counting the EOF, that make up the 79e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// argument. 80e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner static unsigned getArgLength(const Token *ArgPtr); 811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 82e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// getPreExpArgument - Return the pre-expanded form of the specified 83e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// argument. 84e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner const std::vector<Token> & 851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump getPreExpArgument(unsigned Arg, Preprocessor &PP); 861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 87e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// getStringifiedArgument - Compute, cache, and return the specified argument 88e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// that has been 'stringified' as required by the # operator. 89e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner const Token &getStringifiedArgument(unsigned ArgNo, Preprocessor &PP); 901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 91e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// getNumArguments - Return the number of arguments passed into this macro 92e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// invocation. 93e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner unsigned getNumArguments() const { return NumUnexpArgTokens; } 941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 96e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// isVarargsElidedUse - Return true if this is a C99 style varargs macro 97e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// invocation and there was no argument specified for the "..." argument. If 98e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// the argument was specified (even empty) or this isn't a C99 style varargs 99e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// function, or if in strict mode and the C99 varargs macro had only a ... 100e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// argument, this returns false. 101e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner bool isVarargsElidedUse() const { return VarargsElided; } 1021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 103e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// StringifyArgument - Implement C99 6.10.3.2p2, converting a sequence of 104e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// tokens into the literal string token that should be produced by the C # 105e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// preprocessor operator. If Charify is true, then it should be turned into 106e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// a character literal for the Microsoft charize (#@) extension. 107e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner /// 108e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner static Token StringifyArgument(const Token *ArgToks, 109e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner Preprocessor &PP, bool Charify = false); 11023f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner 11123f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner 11223f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// deallocate - This should only be called by the Preprocessor when managing 11323f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner /// its freelist. 11423f77e59718385512984d4e2a021bef52b9f6ddfChris Lattner MacroArgs *deallocate(); 115e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner}; 116e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner 117e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner} // end namespace clang 118e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner 119e5c8ffe09f8fec836b90f23c2a3b996bfc5b09c4Chris Lattner#endif 120