/**
 *    Copyright (C) 2023-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    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
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#include "mongo/db/exec/sbe/values/value.h"
#include "mongo/db/query/optimizer/index_bounds.h"

namespace mongo::optimizer::ce {

/**
 * Helper function to extract a tag & value from an ABT node if it turns out to be a Constant node
 * with constant bounds (or boost::none if not).
 */
boost::optional<std::pair<sbe::value::TypeTags, sbe::value::Value>> getConstTypeVal(const ABT& abt);

/**
 * Helper function to extract a tag from 'abt' if it turns out to be a Constant node with constant
 * bounds (or boost::none if not).
 */
boost::optional<sbe::value::TypeTags> getConstTypeTag(const ABT& abt);

/**
 * Helper function to extract an sbe tag & value from the given 'boundReq' if possible, or
 * boost::none if not.
 */
boost::optional<std::pair<sbe::value::TypeTags, sbe::value::Value>> getBound(
    const BoundRequirement& boundReq);

/**
 * Helper function to extract the TypeTag from the given 'boundReq' or boost::none if not.
 */
boost::optional<sbe::value::TypeTags> getBoundReqTypeTag(const BoundRequirement& boundReq);

/**
 * Helper function to return the interval corresponding to a given 'type'.
 */
IntervalRequirement getMinMaxIntervalForType(sbe::value::TypeTags type);

/**
 * Helper function to determine if the given 'interval' is a subset of the given 'type'.
 */
bool isIntervalSubsetOfType(const IntervalRequirement& interval, sbe::value::TypeTags type);

}  // namespace mongo::optimizer::ce