/**
 *    Copyright (C) 2018-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.
 */

#pragma once

#include "mongo/bson/bsontypes.h"

namespace mongo {

class BSONElement;
class BSONObjBuilder;
class CollatorInterface;

/**
 * Provides functionality related to the mapping of user data to collator-generated comparison keys
 * in index keys.
 */
class CollationIndexKey {
public:
    /**
     * Returns true if type can be affected in comparison or sort order by collation.
     */
    static bool isCollatableType(BSONType type) {
        return type == BSONType::String || type == BSONType::Object || type == BSONType::Array;
    }

    /**
     * Appends 'elt' to 'out' with an empty field name, converting strings to comparison keys
     * generated by 'collator' if necessary.
     */
    static void collationAwareIndexKeyAppend(BSONElement elt,
                                             const CollatorInterface* collator,
                                             BSONObjBuilder* out);
};

}  // namespace mongo