TokenKinds.h revision 360784
118334Speter//===--- TokenKinds.h - Enum values for C Token Kinds -----------*- C++ -*-===// 252284Sobrien// 318334Speter// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 418334Speter// See https://llvm.org/LICENSE.txt for license information. 518334Speter// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 618334Speter// 718334Speter//===----------------------------------------------------------------------===// 818334Speter/// 918334Speter/// \file 1018334Speter/// Defines the clang::TokenKind enum and support functions. 1118334Speter/// 1218334Speter//===----------------------------------------------------------------------===// 1318334Speter 1418334Speter#ifndef LLVM_CLANG_BASIC_TOKENKINDS_H 1518334Speter#define LLVM_CLANG_BASIC_TOKENKINDS_H 1618334Speter 1718334Speter#include "llvm/Support/Compiler.h" 1818334Speter 1918334Speternamespace clang { 2018334Speter 2150397Sobriennamespace tok { 2250397Sobrien 2318334Speter/// Provides a simple uniform namespace for tokens from all C languages. 2418334Speterenum TokenKind : unsigned short { 2552284Sobrien#define TOK(X) X, 2618334Speter#include "clang/Basic/TokenKinds.def" 2718334Speter NUM_TOKENS 2818334Speter}; 2918334Speter 3050397Sobrien/// Provides a namespace for preprocessor keywords which start with a 3150397Sobrien/// '#' at the beginning of the line. 3250397Sobrienenum PPKeywordKind { 3350397Sobrien#define PPKEYWORD(X) pp_##X, 3450397Sobrien#include "clang/Basic/TokenKinds.def" 3550397Sobrien NUM_PP_KEYWORDS 3650397Sobrien}; 3750397Sobrien 3850397Sobrien/// Provides a namespace for Objective-C keywords which start with 3918334Speter/// an '@'. 4018334Speterenum ObjCKeywordKind { 4118334Speter#define OBJC_AT_KEYWORD(X) objc_##X, 4218334Speter#include "clang/Basic/TokenKinds.def" 4318334Speter NUM_OBJC_KEYWORDS 4418334Speter}; 4518334Speter 4618334Speter/// Defines the possible values of an on-off-switch (C99 6.10.6p2). 4718334Speterenum OnOffSwitch { 4818334Speter OOS_ON, OOS_OFF, OOS_DEFAULT 4918334Speter}; 5018334Speter 5118334Speter/// Determines the name of a token as used within the front end. 5218334Speter/// 5318334Speter/// The name of a token will be an internal name (such as "l_square") 5418334Speter/// and should not be used as part of diagnostic messages. 5518334Speterconst char *getTokenName(TokenKind Kind) LLVM_READNONE; 5618334Speter 5718334Speter/// Determines the spelling of simple punctuation tokens like 5818334Speter/// '!' or '%', and returns NULL for literal and annotation tokens. 5918334Speter/// 6050397Sobrien/// This routine only retrieves the "simple" spelling of the token, 6118334Speter/// and will not produce any alternative spellings (e.g., a 6218334Speter/// digraph). For the actual spelling of a given Token, use 6318334Speter/// Preprocessor::getSpelling(). 6418334Speterconst char *getPunctuatorSpelling(TokenKind Kind) LLVM_READNONE; 6518334Speter 6618334Speter/// Determines the spelling of simple keyword and contextual keyword 6718334Speter/// tokens like 'int' and 'dynamic_cast'. Returns NULL for other token kinds. 6818334Speterconst char *getKeywordSpelling(TokenKind Kind) LLVM_READNONE; 6950397Sobrien 7018334Speter/// Return true if this is a raw identifier or an identifier kind. 7118334Speterinline bool isAnyIdentifier(TokenKind K) { 7218334Speter return (K == tok::identifier) || (K == tok::raw_identifier); 7318334Speter} 7418334Speter 7518334Speter/// Return true if this is a C or C++ string-literal (or 7618334Speter/// C++11 user-defined-string-literal) token. 7718334Speterinline bool isStringLiteral(TokenKind K) { 7818334Speter return K == tok::string_literal || K == tok::wide_string_literal || 7918334Speter K == tok::utf8_string_literal || K == tok::utf16_string_literal || 8018334Speter K == tok::utf32_string_literal; 8118334Speter} 8250397Sobrien 8350397Sobrien/// Return true if this is a "literal" kind, like a numeric 8450397Sobrien/// constant, string, etc. 8550397Sobrieninline bool isLiteral(TokenKind K) { 8650397Sobrien return K == tok::numeric_constant || K == tok::char_constant || 8718334Speter K == tok::wide_char_constant || K == tok::utf8_char_constant || 8818334Speter K == tok::utf16_char_constant || K == tok::utf32_char_constant || 8918334Speter isStringLiteral(K) || K == tok::header_name; 9050397Sobrien} 9118334Speter 9218334Speter/// Return true if this is any of tok::annot_* kinds. 9318334Speterbool isAnnotation(TokenKind K); 9418334Speter 9550397Sobrien/// Return true if this is an annotation token representing a pragma. 9618334Speterbool isPragmaAnnotation(TokenKind K); 9718334Speter 9818334Speter} // end namespace tok 9918334Speter} // end namespace clang 10018334Speter 10118334Speter#endif 10218334Speter