File: hyphenation.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (80 lines) | stat: -rw-r--r-- 3,308 bytes parent folder | download | duplicates (8)
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
// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_TEXT_HYPHENATION_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_TEXT_HYPHENATION_H_

#include "base/gtest_prod_util.h"
#include "third_party/blink/renderer/platform/platform_export.h"
#include "third_party/blink/renderer/platform/wtf/forward.h"
#include "third_party/blink/renderer/platform/wtf/ref_counted.h"
#include "third_party/blink/renderer/platform/wtf/text/atomic_string_hash.h"
#include "third_party/blink/renderer/platform/wtf/text/string_hash.h"
#include "third_party/blink/renderer/platform/wtf/text/unicode.h"
#include "third_party/blink/renderer/platform/wtf/wtf_size_t.h"

namespace blink {

class PLATFORM_EXPORT Hyphenation : public RefCounted<Hyphenation> {
 public:
  virtual ~Hyphenation() = default;

  // Find the last hyphenation location before |before_index|.
  // Returns 0 if no hyphenation locations were found.
  virtual wtf_size_t LastHyphenLocation(const StringView&,
                                        wtf_size_t before_index) const = 0;

  // Find the first hyphenation location after |after_index|.
  // Returns 0 if no hyphenation locations were found.
  virtual wtf_size_t FirstHyphenLocation(const StringView&,
                                         wtf_size_t after_index) const;

  // Find all hyphenation locations in the reverse order.
  virtual Vector<wtf_size_t, 8> HyphenLocations(const StringView&) const;

  // The minimum number of characters in the word / before the hyphen / after
  // the hyphen. `0` means that the UA chooses a value.
  wtf_size_t MinPrefixLength() const { return min_prefix_length_; }
  wtf_size_t MinSuffixLength() const { return min_suffix_length_; }
  wtf_size_t MinWordLength() const { return min_word_length_; }
  void SetLimits(wtf_size_t min_prefix_length,
                 wtf_size_t min_suffix_length,
                 wtf_size_t min_word_length);
  void ResetLimits() { SetLimits(0, 0, 0); }

 protected:
  void Initialize(const AtomicString& locale);

  bool ShouldHyphenateWord(const StringView& word) const {
    DCHECK_GE(MinWordLength(), 1u);
    if (word.length() < MinWordLength())
      return false;
    // Avoid hyphenating capitalized words.
    return hyphenate_capitalized_word_ || !WTF::unicode::IsUpper(word[0]);
  }

 private:
  friend class LayoutLocale;
  FRIEND_TEST_ALL_PREFIXES(HyphenationTest, SetLimits);

  static scoped_refptr<Hyphenation> PlatformGetHyphenation(
      const AtomicString& locale);

  // The default values suggested by the spec:
  // https://drafts.csswg.org/css-text-4/#propdef-hyphenate-limit-chars
  static constexpr unsigned kDefaultMinPrefixLength = 2;
  static constexpr unsigned kDefaultMinSuffixLength = 2;
  static constexpr unsigned kDefaultMinWordLength = 5;
  static_assert(kDefaultMinWordLength >=
                kDefaultMinPrefixLength + kDefaultMinSuffixLength);
  wtf_size_t min_word_length_ = kDefaultMinWordLength;
  wtf_size_t min_prefix_length_ = kDefaultMinPrefixLength;
  wtf_size_t min_suffix_length_ = kDefaultMinSuffixLength;

  bool hyphenate_capitalized_word_ = false;
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_PLATFORM_TEXT_HYPHENATION_H_