aboutsummaryrefslogtreecommitdiff
path: root/icing/query/advanced_query_parser/param.h
blob: 9ea191520e892b8368f9315e8531441f1374f86f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
// Copyright (C) 2023 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_ADVANCED_QUERY_PARSER_PARAM_H_
#define ICING_QUERY_ADVANCED_QUERY_PARSER_PARAM_H_

#include "icing/text_classifier/lib3/utils/base/status.h"
#include "icing/absl_ports/canonical_errors.h"
#include "icing/query/advanced_query_parser/pending-value.h"
#include "icing/util/status-macros.h"

namespace icing {
namespace lib {

enum class Cardinality {
  kRequired,
  kOptional,
  kVariable,
};

struct Param {
  explicit Param(DataType data_type,
                 Cardinality cardinality = Cardinality::kRequired)
      : data_type(data_type), cardinality(cardinality) {}

  libtextclassifier3::Status Matches(PendingValue& arg) const {
    bool matches = arg.data_type() == data_type;
    // Values of type kText could also potentially be valid kLong or kDouble
    // values. If we're expecting a kLong or kDouble and we have a kText, try to
    // parse it as what we expect.
    if (!matches && data_type == DataType::kLong &&
        arg.data_type() == DataType::kText) {
      ICING_RETURN_IF_ERROR(arg.ParseInt());
      matches = true;
    }
    if (!matches && data_type == DataType::kDouble &&
        arg.data_type() == DataType::kText) {
      ICING_RETURN_IF_ERROR(arg.ParseDouble());
      matches = true;
    }
    return matches ? libtextclassifier3::Status::OK
                   : absl_ports::InvalidArgumentError(
                         "Provided arg doesn't match required param type.");
  }

  DataType data_type;
  Cardinality cardinality;
};

}  // namespace lib
}  // namespace icing

#endif  // ICING_QUERY_ADVANCED_QUERY_PARSER_PARAM_H_