mariadb-columnstore-engine/dbcon/execplan/predicateoperator.h

/* Copyright (C) 2014 InfiniDB, Inc.
   Copyright (C) 2019 MariaDB Corporation

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License
   as published by the Free Software Foundation; version 2 of
   the License.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
   MA 02110-1301, USA. */

/***********************************************************************
 *   $Id: predicateoperator.h 9667 2013-07-08 16:37:10Z bpaul $
 *
 *
 ***********************************************************************/
/** @file */

#pragma once

#include <string>
#include <sstream>
#if defined(__FreeBSD__)
#include <cstdlib>
#else
#include <alloca.h>
#endif
#include <cstring>
#include <cmath>

#include "expressionparser.h"
#include "returnedcolumn.h"
#include "dataconvert.h"

#include "collation.h"  // CHARSET_INFO

namespace messageqcpp
{
class ByteStream;
}

namespace execplan
{
class PredicateOperator : public Operator
{
 public:
  PredicateOperator();
  explicit PredicateOperator(const std::string& operatorName);
  PredicateOperator(const PredicateOperator& rhs);
  ~PredicateOperator() override;

  /** return a copy of this pointer
   *
   * deep copy of this pointer and return the copy
   */
  inline PredicateOperator* clone() const override
  {
    return new PredicateOperator(*this);
  }

  /**
   * The serialization interface
   */
  void serialize(messageqcpp::ByteStream&) const override;
  void unserialize(messageqcpp::ByteStream&) override;

  /** @brief Do a deep, strict (as opposed to semantic) equivalence test
   *
   * Do a deep, strict (as opposed to semantic) equivalence test.
   * @return true iff every member of t is a duplicate copy of every member of this; false otherwise
   */
  bool operator==(const TreeNode* t) const override;

  /** @brief Do a deep, strict (as opposed to semantic) equivalence test
   *
   * Do a deep, strict (as opposed to semantic) equivalence test.
   * @return true iff every member of t is a duplicate copy of every member of this; false otherwise
   */
  bool operator==(const PredicateOperator& t) const;

  /** @brief Do a deep, strict (as opposed to semantic) equivalence test
   *
   * Do a deep, strict (as opposed to semantic) equivalence test.
   * @return false iff every member of t is a duplicate copy of every member of this; true otherwise
   */
  bool operator!=(const TreeNode* t) const override;

  /** @brief Do a deep, strict (as opposed to semantic) equivalence test
   *
   * Do a deep, strict (as opposed to semantic) equivalence test.
   * @return false iff every member of t is a duplicate copy of every member of this; true otherwise
   */
  bool operator!=(const PredicateOperator& t) const;

  const CHARSET_INFO* getCharset() const
  {
    return cs;
  }
  /***********************************************************
   *                  F&E framework                          *
   ***********************************************************/
  using Operator::getBoolVal;
  bool getBoolVal(rowgroup::Row& row, bool& isNull, ReturnedColumn* lop, ReturnedColumn* rop) override;
  void setOpType(Type& l, Type& r) override;

  inline std::string toCppCode(IncludeSet& includes) const override
  {
    includes.insert("predicateoperator.h");
    std::stringstream ss;
    ss << "PredicateOperator(" << std::quoted(fData) << ")";

    return ss.str();
  }

 private:
  inline bool numericCompare(const IDB_Decimal& op1, const IDB_Decimal& op2);
  template <typename result_t>
  inline bool numericCompare(const result_t op1, const result_t op2);
  inline bool strTrimCompare(const std::string& op1, const std::string& op2);

  const CHARSET_INFO* cs;
};

inline bool PredicateOperator::numericCompare(const IDB_Decimal& op1, const IDB_Decimal& op2)
{
  switch (fOp)
  {
    case OP_EQ: return op1 == op2;

    case OP_NE: return op1 != op2;

    case OP_GT: return op1 > op2;

    case OP_GE: return op1 >= op2;

    case OP_LT: return op1 < op2;

    case OP_LE: return op1 <= op2;

    default:
    {
      std::ostringstream oss;
      oss << "invalid predicate operation: " << fOp;
      throw logging::InvalidOperationExcept(oss.str());
    }
  }
}

template <typename result_t>
inline bool PredicateOperator::numericCompare(const result_t op1, const result_t op2)
{
  switch (fOp)
  {
    case OP_EQ: return op1 == op2;

    case OP_NE: return op1 != op2;

    case OP_GT: return op1 > op2;

    case OP_GE: return op1 >= op2;

    case OP_LT: return op1 < op2;

    case OP_LE: return op1 <= op2;

    default:
    {
      std::ostringstream oss;
      oss << "invalid predicate operation: " << fOp;
      throw logging::InvalidOperationExcept(oss.str());
    }
  }
}

std::ostream& operator<<(std::ostream& os, const PredicateOperator& rhs);
}  // namespace execplan