1/*
2 * Copyright (C) 2014 The Libphonenumber Authors
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef I18N_PHONENUMBERS_MATCHER_API_H_
18#define I18N_PHONENUMBERS_MATCHER_API_H_
19
20#include <string>
21
22namespace i18n {
23namespace phonenumbers {
24
25using std::string;
26
27class PhoneNumberDesc;
28
29// Internal phonenumber matching API used to isolate the underlying
30// implementation of the matcher and allow different implementations to be
31// swapped in easily.
32class MatcherApi {
33 public:
34  virtual ~MatcherApi() {}
35
36  // Returns whether the given national number (a string containing only decimal
37  // digits) matches the national number pattern defined in the given
38  // PhoneNumberDesc message.
39  virtual bool MatchNationalNumber(const string& number,
40                                   const PhoneNumberDesc& number_desc,
41                                   bool allow_prefix_match) const = 0;
42};
43
44}  // namespace phonenumbers
45}  // namespace i18n
46
47#endif  // I18N_PHONENUMBERS_MATCHER_API_H_
48