codeql/cpp/ql/lib/semmle/code/cpp/exprs/BitwiseOperation.qll

/**
 * Provides classes for modeling bitwise operations such as `~`, `<<`, `&` and
 * `|`.
 */

import semmle.code.cpp.exprs.Expr

/**
 * A C/C++ unary bitwise operation.
 */
class UnaryBitwiseOperation extends UnaryOperation, @un_bitwise_op_expr { }

/**
 * A C/C++ complement expression.
 * ```
 * unsigned c = ~a;
 * ```
 */
class ComplementExpr extends UnaryBitwiseOperation, @complementexpr {
  override string getOperator() { result = "~" }

  override int getPrecedence() { result = 16 }

  override string getAPrimaryQlClass() { result = "ComplementExpr" }
}

/**
 * A C/C++ binary bitwise operation.
 */
class BinaryBitwiseOperation extends BinaryOperation, @bin_bitwise_op_expr { }

/**
 * A C/C++ left shift expression.
 * ```
 * unsigned c = a << b;
 * ```
 */
class LShiftExpr extends BinaryBitwiseOperation, @lshiftexpr {
  override string getOperator() { result = "<<" }

  override int getPrecedence() { result = 12 }

  override string getAPrimaryQlClass() { result = "LShiftExpr" }
}

/**
 * A C/C++ right shift expression.
 * ```
 * unsigned c = a >> b;
 * ```
 */
class RShiftExpr extends BinaryBitwiseOperation, @rshiftexpr {
  override string getOperator() { result = ">>" }

  override int getPrecedence() { result = 12 }

  override string getAPrimaryQlClass() { result = "RShiftExpr" }
}

/**
 * A C/C++ bitwise AND expression.
 * ```
 * unsigned c = a & b;
 * ```
 */
class BitwiseAndExpr extends BinaryBitwiseOperation, @andexpr {
  override string getOperator() { result = "&" }

  override int getPrecedence() { result = 8 }

  override string getAPrimaryQlClass() { result = "BitwiseAndExpr" }
}

/**
 * A C/C++ bitwise OR expression.
 * ```
 * unsigned c = a | b;
 * ```
 */
class BitwiseOrExpr extends BinaryBitwiseOperation, @orexpr {
  override string getOperator() { result = "|" }

  override int getPrecedence() { result = 6 }

  override string getAPrimaryQlClass() { result = "BitwiseOrExpr" }
}

/**
 * A C/C++ bitwise XOR expression.
 * ```
 * unsigned c = a ^ b;
 * ```
 */
class BitwiseXorExpr extends BinaryBitwiseOperation, @xorexpr {
  override string getOperator() { result = "^" }

  override int getPrecedence() { result = 7 }

  override string getAPrimaryQlClass() { result = "BitwiseXorExpr" }
}