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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
// fts_language.h
/**
* Copyright (C) 2013 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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/base/status_with.h"
#include <string>
namespace mongo {
namespace fts {
/**
* A FTSLanguage is a copyable glorified enum representing a language for a text-indexed
* document or a text search. Example of suggested usage:
*
* StatusWithFTSLanguage swl = FTSLanguage::makeFTSLanguage( "en" );
* if ( !swl.getStatus().isOK() ) {
* // Error.
* }
* else {
* const FTSLanguage language = swl.getValue();
* // Use language.
* }
*/
class FTSLanguage {
public:
/** Create an uninitialized language. */
FTSLanguage();
~FTSLanguage();
FTSLanguage( const FTSLanguage& );
FTSLanguage& operator=( const FTSLanguage & );
/**
* Initialize an FTSLanguage from a language string. Language strings are
* case-insensitive, and can be in one of the two following forms:
* - English name, like "spanish".
* - Two-letter code, like "es".
* Returns an error Status if an invalid language string is passed.
*/
Status init( const std::string& lang );
/**
* Returns the language as a string in canonical form (lowercased English name). It is
* an error to call str() on an uninitialized language.
*/
std::string str() const;
/**
* Convenience method for creating an FTSLanguage out of a language string. Caller
* must check getStatus().isOK() on return value.
*/
static StatusWith<const FTSLanguage> makeFTSLanguage( const std::string& lang );
private:
// Pointer to string representation of language. Not owned here.
StringData _lang;
};
typedef StatusWith<const FTSLanguage> StatusWithFTSLanguage;
}
}
|
