//===--- TokenKinds.h - Enum values for C Token Kinds -----------*- C++ -*-===//

//

// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.

// See https://llvm.org/LICENSE.txt for license information.

// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

//

//===----------------------------------------------------------------------===//

///

/// \file

/// Defines the clang::TokenKind enum and support functions.

///

//===----------------------------------------------------------------------===//

#ifndef LLVM_CLANG_BASIC_TOKENKINDS_H

#define LLVM_CLANG_BASIC_TOKENKINDS_H

#include "llvm/ADT/DenseMapInfo.h"

#include "llvm/Support/Compiler.h"

namespace clang {

namespace tok {

/// Provides a simple uniform namespace for tokens from all C languages.

enum TokenKind : unsigned short {

#define TOK(X) X,

#include "clang/Basic/TokenKinds.def"

  NUM_TOKENS

};

/// Provides a namespace for preprocessor keywords which start with a

/// '#' at the beginning of the line.

enum PPKeywordKind {

#define PPKEYWORD(X) pp_##X,

#include "clang/Basic/TokenKinds.def"

  NUM_PP_KEYWORDS

};

/// Provides a namespace for Objective-C keywords which start with

/// an '@'.

enum ObjCKeywordKind {

#define OBJC_AT_KEYWORD(X) objc_##X,

#include "clang/Basic/TokenKinds.def"

  NUM_OBJC_KEYWORDS

};

/// Defines the possible values of an on-off-switch (C99 6.10.6p2).

enum OnOffSwitch {

  OOS_ON, OOS_OFF, OOS_DEFAULT

};

/// Determines the name of a token as used within the front end.

///

/// The name of a token will be an internal name (such as "l_square")

/// and should not be used as part of diagnostic messages.

const char *getTokenName(TokenKind Kind) LLVM_READNONE;

/// Determines the spelling of simple punctuation tokens like

/// '!' or '%', and returns NULL for literal and annotation tokens.

///

/// This routine only retrieves the "simple" spelling of the token,

/// and will not produce any alternative spellings (e.g., a

/// digraph). For the actual spelling of a given Token, use

/// Preprocessor::getSpelling().

const char *getPunctuatorSpelling(TokenKind Kind) LLVM_READNONE;

/// Determines the spelling of simple keyword and contextual keyword

/// tokens like 'int' and 'dynamic_cast'. Returns NULL for other token kinds.

const char *getKeywordSpelling(TokenKind Kind) LLVM_READNONE;

/// Returns the spelling of preprocessor keywords, such as "else".

const char *getPPKeywordSpelling(PPKeywordKind Kind) LLVM_READNONE;

/// Return true if this is a raw identifier or an identifier kind.

inline bool isAnyIdentifier(TokenKind K) {

  return (K == tok::identifier) || 
(K == tok::raw_identifier)2.02M
;

}

/// Return true if this is a C or C++ string-literal (or

/// C++11 user-defined-string-literal) token.

inline bool isStringLiteral(TokenKind K) {

  return K == tok::string_literal || 
K == tok::wide_string_literal3.29G
 ||

         
K == tok::utf8_string_literal3.29G
 || 
K == tok::utf16_string_literal3.29G
 ||

         
K == tok::utf32_string_literal3.29G
;

}

/// Return true if this is a "literal" kind, like a numeric

/// constant, string, etc.

inline bool isLiteral(TokenKind K) {

  return K == tok::numeric_constant || 
K == tok::char_constant2.67G
 ||

         
K == tok::wide_char_constant2.67G
 || 
K == tok::utf8_char_constant2.67G
 ||

         
K == tok::utf16_char_constant2.67G
 || 
K == tok::utf32_char_constant2.67G
 ||

         
isStringLiteral(K)2.67G
 || 
K == tok::header_name2.59G
;

}

/// Return true if this is any of tok::annot_* kinds.

bool isAnnotation(TokenKind K);

/// Return true if this is an annotation token representing a pragma.

bool isPragmaAnnotation(TokenKind K);

} // end namespace tok

} // end namespace clang

namespace llvm {

template <> struct DenseMapInfo<clang::tok::PPKeywordKind> {

  static inline clang::tok::PPKeywordKind getEmptyKey() {

    return clang::tok::PPKeywordKind::pp_not_keyword;

  }

  static inline clang::tok::PPKeywordKind getTombstoneKey() {

    return clang::tok::PPKeywordKind::NUM_PP_KEYWORDS;

  }

  static unsigned getHashValue(const clang::tok::PPKeywordKind &Val) {

    return static_cast<unsigned>(Val);

  }

  static bool isEqual(const clang::tok::PPKeywordKind &LHS,

                      const clang::tok::PPKeywordKind &RHS) {

    return LHS == RHS;

  }

};

} // namespace llvm

#endif