icing/query/query-terms.h

// Copyright (C) 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef ICING_QUERY_QUERY_TERMS_H_
#define ICING_QUERY_QUERY_TERMS_H_

#include <memory>
#include <string>
#include <unordered_map>
#include <unordered_set>

#include "icing/index/iterator/doc-hit-info-iterator.h"

namespace icing {
namespace lib {

// A map from section names to sets of terms restricted to those sections.
// Query terms that are not restricted are found at the entry with key "".
using SectionRestrictQueryTermsMap =
    std::unordered_map<std::string, std::unordered_set<std::string>>;

// A map from query terms to a DocHitInfoIterator for that term.
using QueryTermIteratorsMap =
    std::unordered_map<std::string, std::unique_ptr<DocHitInfoIterator>>;

}  // namespace lib
}  // namespace icing

#endif  // ICING_QUERY_QUERY_TERMS_H_