aboutsummaryrefslogtreecommitdiffstats
path: root/fsa/src/vespa/fsa/wordchartokenizer.h
blob: 82491cbd51cee1854d2c2cd899139e6378f31c24 (plain) (blame)
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
/**
 * @author  Peter Boros
 * @date    2004/08/20
 * @version $Id$
 * @file    wordchartokenizer.h
 * @brief   Tokenizer based on the unicode WORDCHAR property.
 */

#pragma once

#include "tokenizer.h"

#include <iostream>
#include <vector>
#include <string>
#include <algorithm>


namespace fsa {

// {{{ class WordCharTokenizer

/**
 * @class WordCharTokenizer
 * @brief Tokenizer based on the Unicode WORDCHAR property.
 */
class WordCharTokenizer : public Tokenizer {

public:
  /**
   * @brief Enumareted type for specifying puctuation removal strategy.
   *
   * Enumareted type for specifying puctuation removal strategy. The
   * following strategies are currently supported:
   *   - PUNCTUATION_DISCARD: discard all punctuation.
   *   - PUNCTUATION_FULL: honour all punctuation and insert
   *     punctuation token.
   *   - PUNCTUATION_SMART: same as PUNCTUATION_FULL, with some
   *     heuristics to not break acronyms and names.
   *   - PUNCTUATION_WHITESPACEONLY: treat everything (including
   *     punctuation) as word characters, except white space.
   */
  enum Punctuation {
    PUNCTUATION_DISCARD = 0,
    PUNCTUATION_FULL,
    PUNCTUATION_SMART,
    PUNCTUATION_WHITESPACEONLY
  };

private:

  static const bool _punctuation_table[];   /**< Table used for punctuation tests.              */

  std::vector<std::string>  _tokens;        /**< Vector holding the tokens.                     */
  unsigned int _current;                    /**< Index of current token.                        */
  Punctuation _punctuation;                 /**< Punctuation strategy.                          */
  std::string _punctuation_token;           /**< Special token for marking punctuation.         */
  bool _lowercase;                          /**< Indicator whether tokens should be lowercased. */

public:

  WordCharTokenizer(Punctuation punct = PUNCTUATION_DISCARD, const std::string &punct_token = ".") :
    _tokens(),
    _current(0),
    _punctuation(punct),
    _punctuation_token(punct_token),
    _lowercase(true)
  {}

  virtual ~WordCharTokenizer() {}

  Punctuation getPunctuation() const { return _punctuation; }
  void setPunctuation(Punctuation punct) { _punctuation=punct; }
  std::string getPunctuationToken() const { return _punctuation_token; }
  void setPunctuationToken(const std::string &punct_token) { _punctuation_token=punct_token; }
  void rewind() { _current=0; }
  void setLowerCase(bool lc) { _lowercase = lc; }
  bool getLowerCase() const { return _lowercase; }

  /**
   * @brief Initialize the tokenizer.
   *
   * @param text Input text.
   * @return True on success.
   */
  bool         init(const std::string &text) override;


  /**
   * @brief Check if there are more tokens available.
   *
   * @return True if there are more tokens.
   */
  bool         hasMore() override;

  /**
   * @brief Get next token.
   *
   * @return Next token, or empty string if there are no more tokens left.
   */
  std::string  getNext() override;

};

// }}}

} // namespace fsa