codeql/javascript/ql/lib/semmle/javascript/Tokens.qll

/**
 * Provides classes for working with the token-based representation of JavaScript programs.
 */
overlay[local?]
module;

import javascript

pragma[nomagic]
private predicate adjacentTokens(Token token1, Token token2) {
  exists(TopLevel top, int index |
    tokeninfo(token1, _, top, index, _) and
    tokeninfo(token2, _, top, index + 1, _)
  )
}

/**
 * A token occurring in a piece of JavaScript source code.
 *
 * Examples:
 *
 * ```
 * x
 * /\w+/
 * 12.3
 * ;
 * ```
 */
class Token extends Locatable, @token {
  /** Gets the toplevel syntactic structure to which this token belongs. */
  TopLevel getTopLevel() { tokeninfo(this, _, result, _, _) }

  /** Gets the index of the token inside its toplevel structure. */
  int getIndex() { tokeninfo(this, _, _, result, _) }

  /** Gets the source text of this token. */
  string getValue() { tokeninfo(this, _, _, _, result) }

  /** Gets the token following this token inside the same toplevel structure, if any. */
  Token getNextToken() { adjacentTokens(this, result) }

  /** Gets the token preceding this token inside the same toplevel structure, if any. */
  Token getPreviousToken() { result.getNextToken() = this }

  override string toString() { result = this.getValue() }
}

/** An end-of-file token. */
class EOFToken extends Token, @token_eof { }

/**
 * A null literal token.
 *
 * Example:
 *
 * ```
 * null
 * ```
 */
class NullLiteralToken extends Token, @token_null_literal { }

/**
 * A Boolean literal token.
 *
 * Examples:
 *
 * ```
 * true
 * false
 * ```
 */
class BooleanLiteralToken extends Token, @token_boolean_literal { }

/**
 * A numeric literal token.
 *
 * Examples:
 *
 * ```
 * 1
 * 2.3
 * ```
 */
class NumericLiteralToken extends Token, @token_numeric_literal { }

/**
 * A string literal token.
 *
 * Examples:
 *
 * ```
 * "hello"
 * 'world!'
 * ```
 */
class StringLiteralToken extends Token, @token_string_literal { }

/**
 * A regular expression literal token.
 *
 * Example:
 *
 * ```
 * /\w+/
 * ```
 */
class RegularExpressionToken extends Token, @token_regular_expression { }

/**
 * An identifier token.
 *
 * Example:
 *
 * ```
 * x
 * ```
 */
class IdentifierToken extends Token, @token_identifier { }

/**
 * A keyword token.
 *
 * Examples:
 *
 * ```
 * function
 * this
 * ```
 */
class KeywordToken extends Token, @token_keyword { }

/**
 * A punctuator token.
 *
 * Examples:
 *
 * ```
 * ;
 * +
 * ```
 */
class PunctuatorToken extends Token, @token_punctuator { }