Skip to content

Commit

Permalink
Rename functions of Converter.
Browse files Browse the repository at this point in the history 
Since the functions with ForRequest (e.g. StartConversionForRequest) are main functions, rename them to the shorter one.

* StartConversionForRequest(request, *segments) → StartConversion(request, *segments)
* StartConversion(*segments, key) → StartConversionWithKey(*segments, key)

This is a preparation for the main issue (b/326840183).

#codehealth

PiperOrigin-RevId: 610773962
  • Loading branch information
@hiroyuki-komatsu
hiroyuki-komatsu committed Feb 27, 2024
1 parent 03d3c24 commit cf6fcf7
Show file tree
Hide file tree
Showing 16 changed files with 366 additions and 360 deletions.
7 changes: 6 additions & 1 deletion src/converter/BUILD.bazel
View file
Original file line number Diff line number Diff line change
Expand Up @@ -422,7 +422,6 @@ mozc_cc_library(
":immutable_converter_interface",
":segments",
"//base:japanese_util",
"//base:logging",
"//base:util",
"//base:vlog",
"//base/strings:assign",
Expand All @@ -438,6 +437,8 @@ mozc_cc_library(
"//transliteration",
"//usage_stats",
"@com_google_absl//absl/base:core_headers",
"@com_google_absl//absl/log",
"@com_google_absl//absl/log:check",
"@com_google_absl//absl/strings",
"@com_google_absl//absl/types:span",
],
Expand Down Expand Up @@ -644,7 +645,11 @@ mozc_cc_library(
hdrs = ["converter_mock.h"],
deps = [
":converter_interface",
":segments",
"//request:conversion_request",
"//testing:gunit",
"@com_google_absl//absl/strings",
"@com_google_absl//absl/types:span",
],
)

Expand Down
43 changes: 22 additions & 21 deletions src/converter/converter.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,11 @@
#include <utility>
#include <vector>

#include "absl/log/check.h"
#include "absl/log/log.h"
#include "absl/strings/string_view.h"
#include "absl/types/span.h"
#include "base/japanese_util.h"
#include "base/logging.h"
#include "base/strings/assign.h"
#include "base/util.h"
#include "base/vlog.h"
Expand Down Expand Up @@ -273,8 +274,8 @@ void Converter::Init(const engine::Modules &modules,
general_noun_id_ = pos_matcher_->GetGeneralNounId();
}

bool Converter::StartConversionForRequest(
const ConversionRequest &original_request, Segments *segments) const {
bool Converter::StartConversion(const ConversionRequest &original_request,
Segments *segments) const {
ConversionRequest request = CreateConversionRequestWithType(
original_request, ConversionRequest::CONVERSION);
if (!request.has_composer()) {
Expand All @@ -300,8 +301,8 @@ bool Converter::StartConversionForRequest(
return Convert(request, conversion_key, segments);
}

bool Converter::StartConversion(Segments *segments,
const absl::string_view key) const {
bool Converter::StartConversionWithKey(Segments *segments,
const absl::string_view key) const {
if (key.empty()) {
return false;
}
Expand Down Expand Up @@ -425,8 +426,8 @@ bool Converter::Predict(const ConversionRequest &request,
return IsValidSegments(request, *segments);
}

bool Converter::StartPredictionForRequest(
const ConversionRequest &original_request, Segments *segments) const {
bool Converter::StartPrediction(const ConversionRequest &original_request,
Segments *segments) const {
ConversionRequest request = CreateConversionRequestWithType(
original_request, ConversionRequest::PREDICTION);
if (!request.has_composer()) {
Expand All @@ -438,44 +439,44 @@ bool Converter::StartPredictionForRequest(
return Predict(request, prediction_key, segments);
}

bool Converter::StartPrediction(Segments *segments,
const absl::string_view key) const {
bool Converter::StartPredictionWithKey(Segments *segments,
const absl::string_view key) const {
ConversionRequest default_request;
default_request.set_request_type(ConversionRequest::PREDICTION);
return Predict(default_request, key, segments);
}

bool Converter::StartSuggestion(Segments *segments,
const absl::string_view key) const {
bool Converter::StartSuggestionWithKey(Segments *segments,
const absl::string_view key) const {
ConversionRequest default_request;
default_request.set_request_type(ConversionRequest::SUGGESTION);
return Predict(default_request, key, segments);
}

bool Converter::StartSuggestionForRequest(
const ConversionRequest &original_request, Segments *segments) const {
bool Converter::StartSuggestion(const ConversionRequest &original_request,
Segments *segments) const {
ConversionRequest request = CreateConversionRequestWithType(
original_request, ConversionRequest::SUGGESTION);
DCHECK(request.has_composer());
std::string prediction_key = request.composer().GetQueryForPrediction();
return Predict(request, prediction_key, segments);
}

bool Converter::StartPartialSuggestion(Segments *segments,
const absl::string_view key) const {
bool Converter::StartPartialSuggestionWithKey(
Segments *segments, const absl::string_view key) const {
ConversionRequest default_request;
default_request.set_request_type(ConversionRequest::PARTIAL_SUGGESTION);
return Predict(default_request, key, segments);
}

bool Converter::StartPartialSuggestionForRequest(
bool Converter::StartPartialSuggestion(
const ConversionRequest &original_request, Segments *segments) const {
ConversionRequest request = CreateConversionRequestWithType(
original_request, ConversionRequest::PARTIAL_SUGGESTION);
DCHECK(request.has_composer());
const size_t cursor = request.composer().GetCursor();
if (cursor == 0 || cursor == request.composer().GetLength()) {
return StartSuggestionForRequest(request, segments);
return StartSuggestion(request, segments);
}

std::string conversion_key = request.composer().GetQueryForConversion();
Expand All @@ -484,21 +485,21 @@ bool Converter::StartPartialSuggestionForRequest(
return Predict(request, conversion_key, segments);
}

bool Converter::StartPartialPrediction(Segments *segments,
const absl::string_view key) const {
bool Converter::StartPartialPredictionWithKey(
Segments *segments, const absl::string_view key) const {
ConversionRequest default_request;
default_request.set_request_type(ConversionRequest::PARTIAL_PREDICTION);
return Predict(default_request, key, segments);
}

bool Converter::StartPartialPredictionForRequest(
bool Converter::StartPartialPrediction(
const ConversionRequest &original_request, Segments *segments) const {
ConversionRequest request = CreateConversionRequestWithType(
original_request, ConversionRequest::PARTIAL_PREDICTION);
DCHECK(request.has_composer());
const size_t cursor = request.composer().GetCursor();
if (cursor == 0 || cursor == request.composer().GetLength()) {
return StartPredictionForRequest(request, segments);
return StartPrediction(request, segments);
}

std::string conversion_key = request.composer().GetQueryForConversion();
Expand Down
40 changes: 20 additions & 20 deletions src/converter/converter.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,38 +64,38 @@ class Converter final : public ConverterInterface {
ImmutableConverterInterface *immutable_converter);

ABSL_MUST_USE_RESULT
bool StartConversionForRequest(const ConversionRequest &request,
Segments *segments) const override;
bool StartConversion(const ConversionRequest &request,
Segments *segments) const override;
ABSL_MUST_USE_RESULT
bool StartConversion(Segments *segments,
absl::string_view key) const override;
bool StartConversionWithKey(Segments *segments,
absl::string_view key) const override;
ABSL_MUST_USE_RESULT
bool StartReverseConversion(Segments *segments,
absl::string_view key) const override;
ABSL_MUST_USE_RESULT
bool StartPredictionForRequest(const ConversionRequest &request,
Segments *segments) const override;
bool StartPrediction(const ConversionRequest &request,
Segments *segments) const override;
ABSL_MUST_USE_RESULT
bool StartPrediction(Segments *segments,
absl::string_view key) const override;
bool StartPredictionWithKey(Segments *segments,
absl::string_view key) const override;
ABSL_MUST_USE_RESULT
bool StartSuggestionForRequest(const ConversionRequest &request,
Segments *segments) const override;
bool StartSuggestion(const ConversionRequest &request,
Segments *segments) const override;
ABSL_MUST_USE_RESULT
bool StartSuggestion(Segments *segments,
absl::string_view key) const override;
bool StartSuggestionWithKey(Segments *segments,
absl::string_view key) const override;
ABSL_MUST_USE_RESULT
bool StartPartialPredictionForRequest(const ConversionRequest &request,
Segments *segments) const override;
bool StartPartialPrediction(const ConversionRequest &request,
Segments *segments) const override;
ABSL_MUST_USE_RESULT
bool StartPartialPrediction(Segments *segments,
absl::string_view key) const override;
bool StartPartialPredictionWithKey(Segments *segments,
absl::string_view key) const override;
ABSL_MUST_USE_RESULT
bool StartPartialSuggestionForRequest(const ConversionRequest &request,
Segments *segments) const override;
bool StartPartialSuggestion(const ConversionRequest &request,
Segments *segments) const override;
ABSL_MUST_USE_RESULT
bool StartPartialSuggestion(Segments *segments,
absl::string_view key) const override;
bool StartPartialSuggestionWithKey(Segments *segments,
absl::string_view key) const override;

void FinishConversion(const ConversionRequest &request,
Segments *segments) const override;
Expand Down
40 changes: 20 additions & 20 deletions src/converter/converter_interface.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,14 @@ class ConverterInterface {

// Starts conversion for given request.
ABSL_MUST_USE_RESULT
virtual bool StartConversionForRequest(const ConversionRequest &request,
Segments *segments) const = 0;
virtual bool StartConversion(const ConversionRequest &request,
Segments *segments) const = 0;

// Start conversion with key.
// key is a request written in Hiragana sequence
ABSL_MUST_USE_RESULT
virtual bool StartConversion(Segments *segments,
absl::string_view key) const = 0;
virtual bool StartConversionWithKey(Segments *segments,
absl::string_view key) const = 0;

// Start reverse conversion with key.
ABSL_MUST_USE_RESULT
Expand All @@ -72,43 +72,43 @@ class ConverterInterface {

// Starts prediction for given request.
ABSL_MUST_USE_RESULT
virtual bool StartPredictionForRequest(const ConversionRequest &request,
Segments *segments) const = 0;
virtual bool StartPrediction(const ConversionRequest &request,
Segments *segments) const = 0;

// Start prediction with key (request_type = PREDICTION)
ABSL_MUST_USE_RESULT
virtual bool StartPrediction(Segments *segments,
absl::string_view key) const = 0;
virtual bool StartPredictionWithKey(Segments *segments,
absl::string_view key) const = 0;

// Starts suggestion for given request.
ABSL_MUST_USE_RESULT
virtual bool StartSuggestionForRequest(const ConversionRequest &request,
Segments *segments) const = 0;
virtual bool StartSuggestion(const ConversionRequest &request,
Segments *segments) const = 0;

// Start suggestion with key (request_type = SUGGESTION)
ABSL_MUST_USE_RESULT
virtual bool StartSuggestion(Segments *segments,
absl::string_view key) const = 0;
virtual bool StartSuggestionWithKey(Segments *segments,
absl::string_view key) const = 0;

// Starts partial prediction for given request.
ABSL_MUST_USE_RESULT
virtual bool StartPartialPredictionForRequest(
const ConversionRequest &request, Segments *segments) const = 0;
virtual bool StartPartialPrediction(const ConversionRequest &request,
Segments *segments) const = 0;

// Start prediction with key (request_type = PARTIAL_PREDICTION)
ABSL_MUST_USE_RESULT
virtual bool StartPartialPrediction(Segments *segments,
absl::string_view key) const = 0;
virtual bool StartPartialPredictionWithKey(Segments *segments,
absl::string_view key) const = 0;

// Starts partial suggestion for given request.
ABSL_MUST_USE_RESULT
virtual bool StartPartialSuggestionForRequest(
const ConversionRequest &request, Segments *segments) const = 0;
virtual bool StartPartialSuggestion(const ConversionRequest &request,
Segments *segments) const = 0;

// Start suggestion with key (request_type = PARTIAL_SUGGESTION)
ABSL_MUST_USE_RESULT
virtual bool StartPartialSuggestion(Segments *segments,
absl::string_view key) const = 0;
virtual bool StartPartialSuggestionWithKey(Segments *segments,
absl::string_view key) const = 0;

// Finish conversion.
// Segments are cleared. Context is not cleared
Expand Down
12 changes: 6 additions & 6 deletions src/converter/converter_main.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -296,14 +296,14 @@ bool ExecCommand(const ConverterInterface &converter, const std::string &line,
if (func == "startconversion" || func == "start" || func == "s") {
CHECK_FIELDS_LENGTH(2);
composer.SetPreeditTextForTestOnly(fields[1]);
return converter.StartConversionForRequest(*conversion_request, segments);
return converter.StartConversion(*conversion_request, segments);
} else if (func == "convertwithnodeinfo" || func == "cn") {
CHECK_FIELDS_LENGTH(5);
Lattice::SetDebugDisplayNode(
NumberUtil::SimpleAtoi(fields[2]), // begin pos
NumberUtil::SimpleAtoi(fields[3]), // end pos
fields[4]);
const bool result = converter.StartConversion(segments, fields[1]);
const bool result = converter.StartConversionWithKey(segments, fields[1]);
Lattice::ResetDebugDisplayNode();
return result;
} else if (func == "reverseconversion" || func == "reverse" || func == "r") {
Expand All @@ -312,16 +312,16 @@ bool ExecCommand(const ConverterInterface &converter, const std::string &line,
} else if (func == "startprediction" || func == "predict" || func == "p") {
if (fields.size() >= 2) {
composer.SetPreeditTextForTestOnly(fields[1]);
return converter.StartPredictionForRequest(*conversion_request, segments);
return converter.StartPrediction(*conversion_request, segments);
} else {
return converter.StartPredictionForRequest(*conversion_request, segments);
return converter.StartPrediction(*conversion_request, segments);
}
} else if (func == "startsuggestion" || func == "suggest") {
if (fields.size() >= 2) {
composer.SetPreeditTextForTestOnly(fields[1]);
return converter.StartSuggestionForRequest(*conversion_request, segments);
return converter.StartSuggestion(*conversion_request, segments);
} else {
return converter.StartSuggestionForRequest(*conversion_request, segments);
return converter.StartSuggestion(*conversion_request, segments);
}
} else if (func == "finishconversion" || func == "finish") {
converter.FinishConversion(*conversion_request, segments);
Expand Down
28 changes: 18 additions & 10 deletions src/converter/converter_mock.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,15 @@
#ifndef MOZC_CONVERTER_CONVERTER_MOCK_H_
#define MOZC_CONVERTER_CONVERTER_MOCK_H_

#include <cstddef>
#include <cstdint>
#include <vector>

#include "absl/strings/string_view.h"
#include "absl/types/span.h"
#include "converter/converter_interface.h"
#include "converter/segments.h"
#include "request/conversion_request.h"
#include "testing/gmock.h"

namespace mozc {
Expand All @@ -40,32 +48,32 @@ class StrictMockConverter : public ConverterInterface {
StrictMockConverter() = default;
~StrictMockConverter() override = default;

MOCK_METHOD(bool, StartConversionForRequest,
MOCK_METHOD(bool, StartConversion,
(const ConversionRequest &request, Segments *segments),
(const, override));
MOCK_METHOD(bool, StartConversion,
MOCK_METHOD(bool, StartConversionWithKey,
(Segments * segments, absl::string_view key), (const, override));
MOCK_METHOD(bool, StartReverseConversion,
(Segments * segments, absl::string_view key), (const, override));
MOCK_METHOD(bool, StartPredictionForRequest,
MOCK_METHOD(bool, StartPrediction,
(const ConversionRequest &request, Segments *segments),
(const, override));
MOCK_METHOD(bool, StartPrediction,
MOCK_METHOD(bool, StartPredictionWithKey,
(Segments * segments, absl::string_view key), (const, override));
MOCK_METHOD(bool, StartSuggestionForRequest,
MOCK_METHOD(bool, StartSuggestion,
(const ConversionRequest &request, Segments *segments),
(const, override));
MOCK_METHOD(bool, StartSuggestion,
MOCK_METHOD(bool, StartSuggestionWithKey,
(Segments * segments, absl::string_view key), (const, override));
MOCK_METHOD(bool, StartPartialPredictionForRequest,
MOCK_METHOD(bool, StartPartialPrediction,
(const ConversionRequest &request, Segments *segments),
(const, override));
MOCK_METHOD(bool, StartPartialPrediction,
MOCK_METHOD(bool, StartPartialPredictionWithKey,
(Segments * segments, absl::string_view key), (const, override));
MOCK_METHOD(bool, StartPartialSuggestionForRequest,
MOCK_METHOD(bool, StartPartialSuggestion,
(const ConversionRequest &request, Segments *segments),
(const, override));
MOCK_METHOD(bool, StartPartialSuggestion,
MOCK_METHOD(bool, StartPartialSuggestionWithKey,
(Segments * segments, absl::string_view key), (const, override));
MOCK_METHOD(void, FinishConversion,
(const ConversionRequest &request, Segments *segments),
Expand Down
Loading

0 comments on commit cf6fcf7

Please sign in to comment.