Use renderer_style.textproto file to specify the design of candidate window.

* Support the --as_string_view flag to embed_file.py
* Embed the textproto data from renderer_style.textproto instead of hard-coding.

#codehealth

PiperOrigin-RevId: 923207099

Author: hiroyuki-komatsu

src/build_tools/embed_file.bzl

@@ -31,15 +31,17 @@
 
 load("//bazel:run_build_tool.bzl", "mozc_run_build_tool")
 
-def mozc_embed_file(name, srcs, out, var_name, **kwargs):
+def mozc_embed_file(name, srcs, out, var_name, as_string_view = False, **kwargs):
+    args = ["--name=" + var_name]
+    if as_string_view:
+        args.append("--as_string_view")
+
     mozc_run_build_tool(
         name = name,
         srcs = {
             "--input": srcs,
         },
-        args = [
-            "--name=" + var_name,
-        ],
+        args = args,
         outs = {"--output": out},
         tool = "//build_tools:embed_file",
         **kwargs

src/build_tools/embed_file.py

@@ -31,6 +31,7 @@
 """Generate a C++ array definition for file embedding."""
 import argparse
 import os
+import sys
 
 
 def _ParseArgs():
@@ -41,9 +42,54 @@ def _ParseArgs():
   parser.add_argument(
       '--output', type=argparse.FileType(mode='w', encoding='utf-8')
   )
+  parser.add_argument('--as_string_view', action='store_true')
   return parser.parse_args()
 
 
+def _EmbedAsStringView(input_path, name, output_file):
+  """Embed file as absl::string_view using Raw String Literal."""
+  # Load input file as binary to validate UTF-8 and Null bytes
+  with open(input_path, 'rb') as infile:
+    data = infile.read()
+
+  # 1. Validate invalid UTF-8 byte sequence
+  try:
+    content = data.decode('utf-8', errors='strict')
+  except UnicodeDecodeError as e:
+    sys.stderr.write(
+        f'Error: {input_path} contains invalid UTF-8 byte sequence: {e}\n'
+    )
+    sys.exit(1)
+
+  # 2. Validate Null byte
+  if '\0' in content:
+    sys.stderr.write(
+        f'Error: {input_path} contains a null byte (\\0), which is not'
+        ' allowed in as_string_view mode.\n'
+    )
+    sys.exit(1)
+
+  # 3. Validate delimiter conflict
+  delimiter_conflict = f'){name}'
+  if delimiter_conflict in content:
+    sys.stderr.write(
+        f'Error: {input_path} contains the delimiter string'
+        f" '{delimiter_conflict}', which conflicts with the C++ Raw String"
+        ' delimiter.\n'
+    )
+    sys.exit(1)
+
+  output_file.write("""\
+#ifdef MOZC_EMBEDDED_FILE_%(name)s
+#error "%(name)s was already included or defined elsewhere"
+#else
+#define MOZC_EMBEDDED_FILE_%(name)s
+constexpr absl::string_view %(name)s = R"%(name)s(
+%(content)s)%(name)s";
+#endif  // MOZC_EMBEDDED_FILE_%(name)s
+""" % {'name': name, 'content': content})
+
+
 def _EmbedAsUint64Array(input_path, name, output_file):
   """Embed file as uint64_t array using EmbeddedFile struct."""
 
@@ -81,7 +127,10 @@ def _EmbedAsUint64Array(input_path, name, output_file):
 
 def main():
   args = _ParseArgs()
-  _EmbedAsUint64Array(args.input, args.name, args.output)
+  if args.as_string_view:
+    _EmbedAsStringView(args.input, args.name, args.output)
+  else:
+    _EmbedAsUint64Array(args.input, args.name, args.output)
 
 
 if __name__ == '__main__':

src/renderer/BUILD.bazel

@@ -40,6 +40,10 @@ load(
     "BRANDING",
     "MACOS_BUNDLE_ID_PREFIX",
 )
+load(
+    "//build_tools:embed_file.bzl",
+    "mozc_embed_file",
+)
 
 package(default_visibility = ["//visibility:private"])
 
@@ -229,9 +233,20 @@ mozc_cc_test(
     ],
 )
 
+mozc_embed_file(
+    name = "renderer_style_data",
+    srcs = ["renderer_style.textproto"],
+    out = "renderer_style.inc",
+    as_string_view = True,
+    var_name = "kStyleTextProto",
+)
+
 mozc_cc_library(
     name = "renderer_style_handler",
-    srcs = ["renderer_style_handler.cc"],
+    srcs = [
+        "renderer_style_handler.cc",
+        ":renderer_style_data",
+    ],
     hdrs = ["renderer_style_handler.h"],
     visibility = ["//renderer:__subpackages__"],
     deps = [

src/renderer/renderer_style.textproto

@@ -0,0 +1,86 @@
+# Copyright 2010-2021, Google Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+#     * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above
+# copyright notice, this list of conditions and the following disclaimer
+# in the documentation and/or other materials provided with the
+# distribution.
+#     * Neither the name of Google Inc. nor the names of its
+# contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# proto-file: third_party/mozc/src/protocol/renderer_style.proto
+# proto-message: RendererStyle
+window_border: 1
+scrollbar_width: 4
+row_rect_padding: 0
+border_color { r: 150 g: 150 b: 150 }
+# text_style of shortcut
+text_styles {
+  font_size: 14
+  foreground_color { r: 119 g: 119 b: 119 }
+  background_color { r: 243 g: 244 b: 255 }
+  left_padding: 8
+  right_padding: 8
+}
+# text_style of gap1
+text_styles { font_size: 14 }
+# text_style of candidate
+text_styles { font_size: 14 }
+# text_style of description
+text_styles {
+  font_size: 12
+  foreground_color { r: 136 g: 136 b: 136 }
+  right_padding: 8
+}
+# We want to ensure that the candidate window is at least wide
+# enough to render "そのほかの文字種  " as a candidate.
+column_minimum_width_string: "そのほかの文字種  "
+footer_style { font_size: 14 left_padding: 4 right_padding: 4 }
+footer_sub_label_style {
+  font_size: 10
+  foreground_color { r: 167 g: 167 b: 167 }
+  left_padding: 4
+  right_padding: 4
+}
+footer_border_colors { r: 96 g: 96 b: 96 }
+footer_top_color { r: 255 g: 255 b: 255 }
+footer_bottom_color { r: 238 g: 238 b: 238 }
+logo_file_name: "candidate_window_logo.tiff"
+focused_background_color { r: 209 g: 234 b: 255 }
+focused_border_color { r: 127 g: 172 b: 221 }
+scrollbar_background_color { r: 224 g: 224 b: 224 }
+scrollbar_indicator_color { r: 117 g: 144 b: 184 }
+infolist_style {
+  caption_string: "用例"
+  caption_height: 20
+  caption_padding: 1
+  caption_style { font_size: 12 left_padding: 2 }
+  caption_background_color { r: 236 g: 240 b: 250 }
+  window_border: 1
+  row_rect_padding: 2
+  window_width: 300
+  title_style { font_size: 15 left_padding: 5 }
+  description_style { font_size: 12 left_padding: 15 }
+  border_color { r: 150 g: 150 b: 150 }
+  focused_background_color { r: 209 g: 234 b: 255 }
+  focused_border_color { r: 127 g: 172 b: 221 }
+}

src/renderer/renderer_style_handler.cc

@@ -38,65 +38,8 @@ namespace mozc {
 namespace renderer {
 
 namespace {
-constexpr absl::string_view kStyleTextProto = R"pb(
-  # proto-file: protocol/renderer_style.proto
-  # proto-message: RendererStyle
-  window_border: 1
-  scrollbar_width: 4
-  row_rect_padding: 0
-  border_color { r: 150 g: 150 b: 150 }
-  # text_style of shortcut
-  text_styles {
-    font_size: 14
-    foreground_color { r: 119 g: 119 b: 119 }
-    background_color { r: 243 g: 244 b: 255 }
-    left_padding: 8
-    right_padding: 8
-  }
-  # text_style of gap1
-  text_styles { font_size: 14 }
-  # text_style of candidate
-  text_styles { font_size: 14 }
-  # text_style of description
-  text_styles {
-    font_size: 12
-    foreground_color { r: 136 g: 136 b: 136 }
-    right_padding: 8
-  }
-  # We want to ensure that the candidate window is at least wide
-  # enough to render "そのほかの文字種  " as a candidate.
-  column_minimum_width_string: "そのほかの文字種  "
-  footer_style { font_size: 14 left_padding: 4 right_padding: 4 }
-  footer_sub_label_style {
-    font_size: 10
-    foreground_color { r: 167 g: 167 b: 167 }
-    left_padding: 4
-    right_padding: 4
-  }
-  footer_border_colors { r: 96 g: 96 b: 96 }
-  footer_top_color { r: 255 g: 255 b: 255 }
-  footer_bottom_color { r: 238 g: 238 b: 238 }
-  logo_file_name: "candidate_window_logo.tiff"
-  focused_background_color { r: 209 g: 234 b: 255 }
-  focused_border_color { r: 127 g: 172 b: 221 }
-  scrollbar_background_color { r: 224 g: 224 b: 224 }
-  scrollbar_indicator_color { r: 117 g: 144 b: 184 }
-  infolist_style {
-    caption_string: "用例"
-    caption_height: 20
-    caption_padding: 1
-    caption_style { font_size: 12 left_padding: 2 }
-    caption_background_color { r: 236 g: 240 b: 250 }
-    window_border: 1
-    row_rect_padding: 2
-    window_width: 300
-    title_style { font_size: 15 left_padding: 5 }
-    description_style { font_size: 12 left_padding: 15 }
-    border_color { r: 150 g: 150 b: 150 }
-    focused_background_color { r: 209 g: 234 b: 255 }
-    focused_border_color { r: 127 g: 172 b: 221 }
-  }
-)pb";
+// absl::string_view kStyleTextProto is defined in renderer_style.inc.
+#include "renderer/renderer_style.inc"
 }  // namespace
 
 void RendererStyleHandler::GetRendererStyle(RendererStyle* style) {