10b57cec5SDimitry Andric //===--- TokenKinds.h - Enum values for C Token Kinds -----------*- C++ -*-===// 20b57cec5SDimitry Andric // 30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information. 50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 60b57cec5SDimitry Andric // 70b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 80b57cec5SDimitry Andric /// 90b57cec5SDimitry Andric /// \file 100b57cec5SDimitry Andric /// Defines the clang::TokenKind enum and support functions. 110b57cec5SDimitry Andric /// 120b57cec5SDimitry Andric //===----------------------------------------------------------------------===// 130b57cec5SDimitry Andric 140b57cec5SDimitry Andric #ifndef LLVM_CLANG_BASIC_TOKENKINDS_H 150b57cec5SDimitry Andric #define LLVM_CLANG_BASIC_TOKENKINDS_H 160b57cec5SDimitry Andric 170b57cec5SDimitry Andric #include "llvm/Support/Compiler.h" 180b57cec5SDimitry Andric 190b57cec5SDimitry Andric namespace clang { 200b57cec5SDimitry Andric 210b57cec5SDimitry Andric namespace tok { 220b57cec5SDimitry Andric 230b57cec5SDimitry Andric /// Provides a simple uniform namespace for tokens from all C languages. 240b57cec5SDimitry Andric enum TokenKind : unsigned short { 250b57cec5SDimitry Andric #define TOK(X) X, 260b57cec5SDimitry Andric #include "clang/Basic/TokenKinds.def" 270b57cec5SDimitry Andric NUM_TOKENS 280b57cec5SDimitry Andric }; 290b57cec5SDimitry Andric 300b57cec5SDimitry Andric /// Provides a namespace for preprocessor keywords which start with a 310b57cec5SDimitry Andric /// '#' at the beginning of the line. 320b57cec5SDimitry Andric enum PPKeywordKind { 330b57cec5SDimitry Andric #define PPKEYWORD(X) pp_##X, 340b57cec5SDimitry Andric #include "clang/Basic/TokenKinds.def" 350b57cec5SDimitry Andric NUM_PP_KEYWORDS 360b57cec5SDimitry Andric }; 370b57cec5SDimitry Andric 380b57cec5SDimitry Andric /// Provides a namespace for Objective-C keywords which start with 390b57cec5SDimitry Andric /// an '@'. 400b57cec5SDimitry Andric enum ObjCKeywordKind { 410b57cec5SDimitry Andric #define OBJC_AT_KEYWORD(X) objc_##X, 420b57cec5SDimitry Andric #include "clang/Basic/TokenKinds.def" 430b57cec5SDimitry Andric NUM_OBJC_KEYWORDS 440b57cec5SDimitry Andric }; 450b57cec5SDimitry Andric 460b57cec5SDimitry Andric /// Defines the possible values of an on-off-switch (C99 6.10.6p2). 470b57cec5SDimitry Andric enum OnOffSwitch { 480b57cec5SDimitry Andric OOS_ON, OOS_OFF, OOS_DEFAULT 490b57cec5SDimitry Andric }; 500b57cec5SDimitry Andric 510b57cec5SDimitry Andric /// Determines the name of a token as used within the front end. 520b57cec5SDimitry Andric /// 530b57cec5SDimitry Andric /// The name of a token will be an internal name (such as "l_square") 540b57cec5SDimitry Andric /// and should not be used as part of diagnostic messages. 550b57cec5SDimitry Andric const char *getTokenName(TokenKind Kind) LLVM_READNONE; 560b57cec5SDimitry Andric 570b57cec5SDimitry Andric /// Determines the spelling of simple punctuation tokens like 580b57cec5SDimitry Andric /// '!' or '%', and returns NULL for literal and annotation tokens. 590b57cec5SDimitry Andric /// 600b57cec5SDimitry Andric /// This routine only retrieves the "simple" spelling of the token, 610b57cec5SDimitry Andric /// and will not produce any alternative spellings (e.g., a 620b57cec5SDimitry Andric /// digraph). For the actual spelling of a given Token, use 630b57cec5SDimitry Andric /// Preprocessor::getSpelling(). 640b57cec5SDimitry Andric const char *getPunctuatorSpelling(TokenKind Kind) LLVM_READNONE; 650b57cec5SDimitry Andric 660b57cec5SDimitry Andric /// Determines the spelling of simple keyword and contextual keyword 670b57cec5SDimitry Andric /// tokens like 'int' and 'dynamic_cast'. Returns NULL for other token kinds. 680b57cec5SDimitry Andric const char *getKeywordSpelling(TokenKind Kind) LLVM_READNONE; 690b57cec5SDimitry Andric 700b57cec5SDimitry Andric /// Return true if this is a raw identifier or an identifier kind. 710b57cec5SDimitry Andric inline bool isAnyIdentifier(TokenKind K) { 720b57cec5SDimitry Andric return (K == tok::identifier) || (K == tok::raw_identifier); 730b57cec5SDimitry Andric } 740b57cec5SDimitry Andric 750b57cec5SDimitry Andric /// Return true if this is a C or C++ string-literal (or 760b57cec5SDimitry Andric /// C++11 user-defined-string-literal) token. 770b57cec5SDimitry Andric inline bool isStringLiteral(TokenKind K) { 780b57cec5SDimitry Andric return K == tok::string_literal || K == tok::wide_string_literal || 790b57cec5SDimitry Andric K == tok::utf8_string_literal || K == tok::utf16_string_literal || 800b57cec5SDimitry Andric K == tok::utf32_string_literal; 810b57cec5SDimitry Andric } 820b57cec5SDimitry Andric 830b57cec5SDimitry Andric /// Return true if this is a "literal" kind, like a numeric 840b57cec5SDimitry Andric /// constant, string, etc. 850b57cec5SDimitry Andric inline bool isLiteral(TokenKind K) { 860b57cec5SDimitry Andric return K == tok::numeric_constant || K == tok::char_constant || 870b57cec5SDimitry Andric K == tok::wide_char_constant || K == tok::utf8_char_constant || 880b57cec5SDimitry Andric K == tok::utf16_char_constant || K == tok::utf32_char_constant || 890b57cec5SDimitry Andric isStringLiteral(K) || K == tok::header_name; 900b57cec5SDimitry Andric } 910b57cec5SDimitry Andric 920b57cec5SDimitry Andric /// Return true if this is any of tok::annot_* kinds. 93a7dea167SDimitry Andric bool isAnnotation(TokenKind K); 94a7dea167SDimitry Andric 95a7dea167SDimitry Andric /// Return true if this is an annotation token representing a pragma. 96a7dea167SDimitry Andric bool isPragmaAnnotation(TokenKind K); 970b57cec5SDimitry Andric 980b57cec5SDimitry Andric } // end namespace tok 990b57cec5SDimitry Andric } // end namespace clang 1000b57cec5SDimitry Andric 1010b57cec5SDimitry Andric #endif 102