package mozc.commands

Get desktop application:
View/edit binary Protocol Buffers messages

Annotation against a candidate.

Used in: CandidateWindow.Candidate, CandidateWord

• optional string prefix = 1

  Annotation prepended to the value.

• optional string suffix = 2

  Annotation appended to the value.

• optional string description = 3

  Type of the candidate such as [HALF][KATAKANA], [GREEK], [Black square], etc...

• optional string shortcut = 4

  Shortcut key to select this candidate.

• optional bool deletable = 5

  Set to true if this candidate can be deleted from history.

• optional string a11y_description = 6

  Description of the candidate for A11y support. One of the example usage of this field is android:contentDescription in Android.

Note there is another ApplicationInfo inside RendererCommand. Since Input is not using nested message, define ApplicationInfo here.

Used in: Input

• optional uint32 process_id = 1

• optional uint32 thread_id = 2

CandidateAttribute indicates how the candidate was generated.

Used in: CandidateWord

• DEFAULT_ATTRIBUTE = 0

• USER_DICTIONARY = 1

• USER_HISTORY = 2

• SPELLING_CORRECTION = 3

  "ふいんき"→"雰囲気"

• TYPING_CORRECTION = 4

  "やんしょん"(with 12-key)→"マンション"

Used in: Output

• optional uint32 focused_index = 1

  This value represents the focused position of the next |candidates|. If the |candidates| is a part of the whole candidate words (as a result of paging), this value indicates the position from the beginning of that part. (ex. where |candidates| contains 10th to 18th candidates, focused_index=0 means the 10th candidate, but not 1st candidate. The existense of |focused_index| does not represents whether this candidate list is a 'suggestion' or not. |category| represents it.

• repeated CandidateWord candidates = 2

• optional Category category = 3

  Category of the candidates.

Used in: Output, protocol.SessionState

• optional uint32 focused_index = 1

  TODO(komatsu): Use CandidateList. When has_focused_index() is true, this message contains predicted and normally converted candidates. Otherwise, when the field is not set, this message contains a 'suggestion'.

• required uint32 size = 2

  The size of the total candidates in this candidate list. The value does not include the size of subcandidate lists. Note, the next repeated-Candidate=3 may not contain all candidates. all_candidates contains the values of subcandidate lists.

• repeated group mozc.commands.CandidateWindow.Candidate = 3

• required uint32 position = 6

  The position on the composition in character counted by Util::CharsLen. The number represents the left edge of the candidate window. For example, if the composition is "あいう" and the cursor is the position is between "あ" and "い" (e.g. "あ|いう"), the number should be 1. Note, Util::CharsLen does not take care of IVS or combining character so much. Thus CharsLen's behavior on those characters might be changed.

• optional CandidateWindow sub_candidate_window = 8

  Nested candidates aka cascading window.

• optional InformationList usages = 10

  Usages of candidates.

• optional Category category = 11

  TODO(komatsu): Use CandidateList. Category of the candidates

• optional DisplayType display_type = 12

  Information to be used for rendering.

• optional Footer footer = 13

  Footer of the GUI window.

• optional CandidateWindow.Direction direction = 14

• optional uint32 page_size = 18

  The number of candidates per page.

TODO(komatsu): Use CandidateList.

Used in: CandidateWindow

• required uint32 index = 4

  The first index should be zero and index numbers should increase by one.

• required string value = 5

• optional int32 id = 9

  Unique number specifing the candidate.

• optional Annotation annotation = 7

• optional int32 information_id = 10

The direction of candidates in the window. This is just a suggestion from the server and client does not have to follow.

Used in: CandidateWindow

• VERTICAL = 0

• HORIZONTAL = 1

Used in: CandidateList

• optional int32 id = 1

  Unique number specifying the candidate. This may be a negative value.

• optional uint32 index = 2

  The first index should be zero and index numbers should increase by one.

• optional string key = 3

  Reading of the value. The value is only used when the key is different from the input composition (e.g. suggestion/prediction).

• optional string value = 4

  Converted value. (e.g. Kanji value).

• optional Annotation annotation = 5

• repeated CandidateAttribute attributes = 6

  Attributes of this candidate. Can set multiple attributes.

• optional int32 num_segments_in_candidate = 7

  The number of segments for logging. If the candidate is "今日は|晴れ", the number of segments is 2.

• optional string log = 100

  Debug log for this candidate word.

Clients' capability. Users cannot modify this. The server has to obey this capability.

Used in: Input

• optional Capability.TextDeletionCapabilityType text_deletion = 1

Bit fields to notify what the client can do.

Used in: Capability

• NO_TEXT_DELETION_CAPABILITY = 0

• DELETE_PRECEDING_TEXT = 1

  Can delete preceding text which is adjacent to preedit.

Category describes the attribute of the words.

Used in: CandidateList, CandidateWindow, InformationList

• CONVERSION = 0

• PREDICTION = 1

• SUGGESTION = 2

• TRANSLITERATION = 3

• USAGE = 4

Used in: CommandList, MozcCommands

• required Input input = 1

• optional Output output = 2

• repeated Command commands = 1

  This message is used for unittest.

This enum is used by SessionCommand::input_mode with CHANGE_INPUT_MODE and Output::mode.

Used in: KeyEvent, Output, SessionCommand, Status

• DIRECT = 0

• HIRAGANA = 1

• FULL_KATAKANA = 2

• HALF_ASCII = 3

• FULL_ASCII = 4

• HALF_KATAKANA = 5

• NUM_OF_COMPOSITIONS = 6

Used in: Input

• optional string preceding_text = 1

  Former part of surrounding text.

• optional string following_text = 2

  Latter part of surrounding text.

• optional bool suppress_suggestion = 3

  If this is true, suggestion feature is disabled regardless the configuration. If this is false, suggestion feature is followed by the user's configuration. If you want to omit interim suggestions during the key typing, you might want to use request_suggestion.

• optional Context.InputFieldType input_field_type = 4

  Type of the input field being focused.

• optional int32 revision = 5

  An unique revision ID to specify one specific typing session. A client can use arbitrary value for this field. The converter is expected to clear its internal history segments whenever this value is changed. A client should use the same revision ID whenever the converter should keep it internal history segments. In order to avoid unexpected history learnings, a client should update the revision whenever the input focus is changed.

• repeated string experimental_features = 100

  Repeated fields to be used for experimental features.

Input field type. The types are based on the input types defined in HTML5. http://dev.w3.org/html5/spec/Overview.html#attr-input-type Other types are to be added later.

Used in: Context, protocol.SessionState

• NORMAL = 1

  No restrictions nor special functions. The IME operates as usual.

• PASSWORD = 2

  Password field. Text is hidden after input. For Android, In order to make the last character visible to the user, the IME must not hold more than 2 characters in preedit.

• TEL = 3

  Telephone number

• NUMBER = 4

  Number

Next ID: 108 Bundles together some Android experiment flags so that they can be easily retrieved throughout the native code. These flags are generally specific to the decoder, and are made available when the decoder is initialized.

Used in: Request

• optional int32 mobile_history_prediction_size = 2

• optional uint32 variation_character_types = 8

  Bitmap of enabled variation character types.

• optional int32 typing_correction_result_reranker_mode = 95

  Enables final results reranking against literal results. If zero, the previous implementation is used.

• optional float typing_correction_result_reranker_interpolation_weight = 100

  Promote TC/Literal if w * tc_reranker_score + (1.0 - w) lm_diff > 0.0.

• optional float typing_correction_result_reranker_literal_on_top_weight = 101

  Runs Literal-at-least second when original_tc_score + w * tc_reranker_score > 0.0. otherwise, runs literal-on-top.

• optional int32 typing_correction_apply_user_history_size = 85

  Uses the typing correction in user history predictor. The size specifies the maximum number of typing corrections used for query lookup. When zero, typing_correction is not used.

• optional bool disable_zero_query_suffix_prediction = 36

• optional bool enable_findability_oriented_order = 42

• optional int32 findability_oriented_order_top_size = 43

• optional int32 user_history_prediction_max_char_coverage = 82

  Changes the size of history with character coverage.

• optional int32 english_variation_space_insertion_mode = 55

  Parameter for space-insertion for English compounds value 0: no insertion. Candidates will be like this. - "Google" - "GOOGLE" - "google" value 1: expand for all English candidates This mode adds space-prefixed candidates for three style, like this. - "Google" - " Google" - "GOOGLE" - " GOOGLE" - "google" - " google"

• optional int32 candidate_consistency_cost_max_diff = 63

• optional int32 max_composition_event_to_process = 64

• optional int32 katakana_promotion_offset = 83

  Offset to promote Katakana candidates in rewriter. The promotion will be disabled if the value is negative.

• optional int32 handwriting_conversion_candidate_cost_offset = 102

  Cost offset for handwriting conversion candidate. default_value: 10*log(500)

• optional bool apply_single_inner_segment_boundary = 105

  Apply inner segment boundary information to the single segment candidate.

• optional int32 bigram_nwp_filtering_mode = 106

• optional int32 suffix_nwp_transition_cost_threshold = 107

  Threshold for suffix NWP transition cost. If the transition cost is greater than this value, the candidate will be filtered. The candidate will not be filtered if this value is zero.

• DEFAULT = 0

  Control implementation is used. For example, - Kanji + Katakana will not be filtered. - If cost(prefix) > cost(original_entry), the candidate will be filtered. - The reading of the target candidate should be in the dictionary. - ,etc

• FILTER_SAME_CTYPE = 1

  In addition to the default filtering, filter entry if the character script type does not change from the prefix.

• FILTER_ALL = 2

  Filter all bigram candidates.

• NO_VARIATION = 0

• SVS_JAPANESE = 1

  Standardized variation sequences for Japanese. https://unicode.org/Public/UNIDATA/StandardizedVariants.txt It specifies to use SVS characters instead of CJK compatibility ideographs for Japanese.

This message contains which characters are to be deleted by client. E.g. if current composition and surrounding text are "この感じは[漢字は]" ("漢字は" is the composition) and we send DeletionRange with offset == -3 and length == 3, then they will be rendered like: "この[漢字は]"

Used in: Output

• optional int32 offset = 1

  Offset of start of the deletion range. Right now, - Only nagative value is expected. In this case, the offset is counted from the beginning of the composition (see the message comment right above). - Positive or 0 value is not sent. But not forbidden. Though its expectation is not decided yet, the client implementation should be prepared (at least, don't crash).

• optional int32 length = 2

  Length of the range. Right now offset==abs(length) is expected. The expectation where the above condition doesn't meet is not defined yet. This may be defined in future (when positive offset becomes supported?).

DisplayType is a hint to UI renderers describing how the words are displayed.

Used in: CandidateWindow, InformationList

• MAIN = 0

• CASCADE = 1

Message representing the footer part of the candidate window.

Used in: CandidateWindow

• optional string label = 1

  Message shown like a status bar.

• optional bool index_visible = 2

  Whether index (e.g. 10/120) is visible or not.

• optional bool logo_visible = 3

  Whether the logo image is visible or not.

• optional string sub_label = 4

  Message modestly shown. It is used for displaying the version on dev-channel now.

Additional information to a candidate word. This message is used for describing a word usage for instance.

Used in: InformationList

• optional int32 id = 1

  Unique number specifying the information.

• optional string title = 2

  Title string of the information. For usage, this value is probably equal to Candidate::value or its canonicalized value.

• optional string description = 3

  The content of the information. For usage, this value actually describes how to use the word.

• repeated int32 candidate_id = 4

  The IDs of candidates which connect with the information.

Used in: CandidateWindow

• optional uint32 focused_index = 1

• repeated Information information = 2

• optional Category category = 3

  Category of the infolist.

• optional DisplayType display_type = 4

  Information to be used for rendering.

• optional uint32 delay = 5

  How long rendere needs to wait before the infolist is displayed. the default setting is 500 msec.

Used in: Command

• required Input.CommandType type = 1

• optional uint64 id = 2

  Session ID created by CREATE_SESSION.

• optional KeyEvent key = 3

  Key combinations used for SEND_KEY or TEST_SEND_KEY.

• optional SessionCommand command = 4

  Command sent to the session layer used with SEND_COMMAND.

• optional config.Config config = 5

  Input config

• optional Context context = 6

  Context data

• optional Capability capability = 7

  Client capability

• optional ApplicationInfo application_info = 8

  Application information, like process id. Server may be able to change the behavior by seeing the the program name.

• optional Request request = 9

  Client request

• repeated Input.TouchEvent touch_events = 12

• optional user_dictionary.UserDictionaryCommand user_dictionary_command = 13

• optional bool request_suggestion = 14

  A flag to control if the server should return suggest-results or not. If this is set to false, regardless of other configurations, the server won't return suggestion results. This is set to true by default. Note that even if this flag is set to false, when a suggestion is shown in the previous phase, it is possible from the client to submit it. This works only for suggestions for the key insertion, but not for others commands, such as predictions or conversions. This flag is used for the performance improvement in terms of the latency. If you want to suppress the suggestions for the UX improment, you may want to use suppress_suggestion in the Context message.

• optional EngineReloadRequest engine_reload_request = 15

Used in: Input

• NONE = 0

• CREATE_SESSION = 1

• DELETE_SESSION = 2

• SEND_KEY = 3

• TEST_SEND_KEY = 4

  Check only if the key event will be consumed. This command is for TSF on Windows. You do not need to use this command, if it is not necessary.

• SEND_COMMAND = 5

  Evaluate the command specified by SessionCommand. The output format should be the same with an output of a SEND_KEY command.

• GET_CONFIG = 6

  Config accessors.

• SET_CONFIG = 7

• SET_REQUEST = 17

  Set client's request

• SYNC_DATA = 8

  sync dictionary/history data to local file

• SHUTDOWN = 9

  shutdowon server safely

• RELOAD = 10

  reload mutable data (like config, user-dic, history)

• RELOAD_AND_WAIT = 15

  realod mutable data and wait for finish Note: Reloading of user dictionary data is async so that it will not block the typing. This command wait for the reloader.

• CLEAR_USER_HISTORY = 11

  clear user history data

• CLEAR_USER_PREDICTION = 12

  clear user prediction data

• CLEAR_UNUSED_USER_PREDICTION = 16

  clear unused prediction

• CLEANUP = 13

  clean up sessions shutdwon if session is empty and mozc_server is launched with timeout mode

• NO_OPERATION = 14

  no operation can be used for pinging the server

• SEND_USER_DICTIONARY_COMMAND = 26

  Send a command for user dictionary session.

• SEND_ENGINE_RELOAD_REQUEST = 27

  Send an engine_reload_request (ID: 15) to reload the engine.

• RELOAD_SUPPLEMENTAL_MODEL = 30

  Sends reload supplemental model

• GET_SERVER_VERSION = 19

• NUM_OF_COMMANDS = 31

  Number of commands. When new command is added, the command should use below number and NUM_OF_COMMANDS should be incremented.

Used in: TouchPosition

• TOUCH_DOWN = 1

• TOUCH_MOVE = 2

• TOUCH_UP = 3

TouchEvent contains source_id and stroke. Touch_events contain all key touch event. Statistical information are collected for each source_id by SessionUsageObserver.

Used in: Input

• optional uint32 source_id = 1

  source_id specifies the user action such as "X button pressed". It must be unique within the same keyboard_name, which is set in Request message.

• repeated TouchPosition stroke = 2

Used in: TouchEvent

• optional TouchAction action = 1

• optional float x = 2

  x, y potision: keyboard left-top is (0, 0), right-bottom is (1, 1).

• optional float y = 3

• optional int64 timestamp = 4

  timestamp (in ms) is set to zero when the touch event starts.

Used in: Input, Output

• optional uint32 key_code = 1

  Printable key in UCS4. If key_code is empty, key_string is used as a raw input.

• optional uint32 modifiers = 2

  Going to be obsolete.

• optional KeyEvent.SpecialKey special_key = 3

  Unprintable key listed above.

• repeated KeyEvent.ModifierKey modifier_keys = 4

  ModifierKeys

• optional string key_string = 5

  String used for preedit. Kana characters and strings typed from a software keyboard are supposed to be stored here. If key_code is also set, key_code is treated as the raw input and key_string is treated as the composition input. For example, to set Kana value, when key_string is "ち", key_code should be 'a' (97). If key_code is empty, key_string is also treated as the raw input.

• optional KeyEvent.InputStyle input_style = 6

• optional CompositionMode mode = 7

  Input mode For histrical reasons, this field expects a temporary conversion mode rather than comeback input mode.

• repeated KeyEvent.ProbableKeyEvent probable_key_event = 8

  Probable key events Even if you can fill this field, don't omit Input.key_code and so on because preedit string is composed based on them.

• optional bool activated = 9

  IME on/off mode You can use this field to change the IME on/off mode indirectly without sending SpecialKey:ON or SpecialKey:OFF events. If the internal ImeContext::State is DIRECT and this field is true, the converter will change the state to PRECONPOSITION and then handles this key event. If the internal ImeContext::State is not DIRECT and this field is false, the converter will change the state to DIRECT and then handles this key event. Implementation note: We need both |mode| and |activated| to support indirect IME off, where |mode| should contain the next mode. If this field is not set, the server will act as if indirect on/off was not supported.

• optional int64 timestamp_msec = 10

  Timestamp of this key event in millisecond.

Used in: KeyEvent

• FOLLOW_MODE = 0

  Follow the current input mode (default).

• AS_IS = 1

  Do not transliterate key_string and use it as-is.

• DIRECT_INPUT = 2

  Immediately output key_string on the precomposition mode. Same with AS_IS on the preedit mode.

Used in: KeyEvent, ProbableKeyEvent

• CTRL = 1

• ALT = 2

• SHIFT = 4

• KEY_DOWN = 8

• KEY_UP = 16

• LEFT_CTRL = 32

• LEFT_ALT = 64

• LEFT_SHIFT = 128

• RIGHT_CTRL = 256

• RIGHT_ALT = 512

• RIGHT_SHIFT = 1024

• CAPS = 2048

Probable key event, mainly for touch screen. User's input has ambiguity (e.g. the touch position is merginal) so this message expresses the probable event.

Used in: KeyEvent

• optional uint32 key_code = 1

  message ID is the same as Input message.

• optional SpecialKey special_key = 3

  Unprintable key listed above.

• repeated ModifierKey modifier_keys = 4

  ModifierKeys

• optional double probability = 10

  Sum of probabilities must be lesser or equal than 1. 0<= probability <= 1

LINT.IfChange

Used in: KeyEvent, ProbableKeyEvent

• NO_SPECIALKEY = 0

• DIGIT = 1

• ON = 2

  On Windows, SpecialKey::On and SpecialKey::OFF are obsolete. Use TURN_ON_IME session command should be used instead. See b/10216365. On other platforms, especially on Mac, please note that client/client.cc still relies on SpecialKey::On for session playback. We need to fix b/10250883 first. TODO(team): Unsupport SpecialKey::On and SpecialKey::OFF.

• OFF = 3

• SPACE = 4

• ENTER = 5

• LEFT = 6

• RIGHT = 7

• UP = 8

• DOWN = 9

• ESCAPE = 10

• DEL = 11

  Not DELETE because DELETE is reserved in MSVC.

  GUI label is "Delete".

• BACKSPACE = 12

• HENKAN = 13

• MUHENKAN = 14

• KANA = 15

  VK_DBE_HIRAGANA(Win), kVK_JIS_Kana(Mac) The "Katakana Hiragana Romaji" key (w/o modifiers) returns this key code.

  GUI label is "Hiragana".

• HOME = 16

• END = 17

• TAB = 18

• F1 = 19

• F2 = 20

• F3 = 21

• F4 = 22

• F5 = 23

• F6 = 24

• F7 = 25

• F8 = 26

• F9 = 27

• F10 = 28

• F11 = 29

• F12 = 30

• PAGE_UP = 31

• PAGE_DOWN = 32

• INSERT = 33

• F13 = 34

• F14 = 35

• F15 = 36

• F16 = 37

• F17 = 38

• F18 = 39

• F19 = 40

• F20 = 41

• F21 = 42

• F22 = 43

• F23 = 44

• F24 = 45

• EISU = 46

  alphanumeric VK_DBE_ALPHANUMERIC(Win), kVK_JIS_Eisu(Mac)

• NUMPAD0 = 47

• NUMPAD1 = 48

• NUMPAD2 = 49

• NUMPAD3 = 50

• NUMPAD4 = 51

• NUMPAD5 = 52

• NUMPAD6 = 53

• NUMPAD7 = 54

• NUMPAD8 = 55

• NUMPAD9 = 56

• MULTIPLY = 57

  Numpad [*]

• ADD = 58

  Numpad [+]

• SEPARATOR = 59

  Numpad [enter]

• SUBTRACT = 60

  Numpad [-]

• DECIMAL = 61

  Numpad [.]

• DIVIDE = 62

  Numpad [/]

• EQUALS = 63

  Numpad [=]

• TEXT_INPUT = 64

  Meta key event representing any text input.

• HANKAKU = 65

  GUI label is "Hankaku/Zenkaku".

• KANJI = 66

• KATAKANA = 67

  The "Katakana Hiragana Romaji" key with Shift returns this key code.

  VK_DBE_KATAKANA(Win)

• CAPS_LOCK = 68

• UNDEFINED_KEY = 69

  Unsupported keys (e.g. PrtSc, Pause) fall back to UNDEFINED_KEY.

• COMMA = 70

  Numpad [,]

• CLEAR = 71

  Numpad [5] without NUMLOCK

• VIRTUAL_LEFT = 72

  Left key on virtual (software) keyboard

• VIRTUAL_RIGHT = 73

  Right key on virtual (software) keyboard

• VIRTUAL_ENTER = 74

  Enter key on virtual (software) keyboard

• VIRTUAL_UP = 75

  Up key on virtual (software) keyboard

• VIRTUAL_DOWN = 76

  Down key on virtual (software) keyboard

• NUM_SPECIALKEYS = 77

Message used by ProtoXDB as "mozc_commands".

• repeated Command commands = 1

Next ID: 27

Used in: Command, RendererCommand

• optional uint64 id = 1

• optional CompositionMode mode = 2

  This variable is going to be obsolete. Please use status(13) instead.

• optional bool consumed = 3

• optional Result result = 4

• optional Preedit preedit = 5

• optional CandidateWindow candidate_window = 6

• optional KeyEvent key = 7

• optional string url = 8

  when URL is non empty, UI can open the page with a browser, after finishing the all rendering part. We are using this feature for bug-report system.

• optional config.Config config = 9

  Output config

• optional Output.PreeditMethod preedit_method = 10

• optional Output.ErrorCode error_code = 11

• optional Status status = 13

  The current IME status.

• optional CandidateList all_candidate_words = 14

  All flatten candidate words stored in 1D array. This value is filled only when the content is changed.

• optional DeletionRange deletion_range = 16

  Range of characters to be deleted by client.

• optional Output.ToolMode launch_tool_mode = 17

• optional Output.Callback callback = 18

• optional user_dictionary.UserDictionaryCommandStatus user_dictionary_command_status = 21

• optional EngineReloadResponse engine_reload_response = 22

• optional CandidateList removed_candidate_words_for_debug = 23

  For debug. Candidate words removed throuth the conversion process.

• optional CandidateList incognito_candidate_words = 25

  Candidate words stored in 1D array. The field should be filled without using any personal data.

• optional Output.VersionInfo server_version = 26

Callback request to the client.

Used in: Output

• optional SessionCommand session_command = 1

  Callback command to be sent from the client to the server. The optional values such as id and composition_mode can be modified or added by the client.

• optional uint32 delay_millisec = 2

  Callback command should be sent after this delay.

ErrorCode: if SessionHandler::EvalCommand() returns false, return output with error_code = SESSION_FAILURE;

Used in: Output

• SESSION_SUCCESS = 0

• SESSION_FAILURE = 1

PreeditMethod: this is the default input mode of the session. If the user's config is "kana-input", it returns KANA. Only CreateSession response will have this field.

Used in: Output

• ASCII = 0

• KANA = 1

if launch_tool_mode is set, MozcTool is supposed to be launched by client.

Used in: Output

• NO_TOOL = 0

  no need to launch tool

• CONFIG_DIALOG = 1

• DICTIONARY_TOOL = 2

• WORD_REGISTER_DIALOG = 3

Used in: Output

• optional string mozc_version = 1

• optional string data_version = 2

Preedit represents a composition data, which is rendered on the host application by the ime client. On Japanese IME, the both Preedit and Conversion statuses are represented by this message.

Used in: Output, protocol.SessionState

• required uint32 cursor = 1

• repeated group mozc.commands.Preedit.Segment = 2

• optional uint32 highlighted_position = 3

  The position of the first segment whose annotation is 'HIGHLIGHT'. Not set if there are no such segments.

• optional bool is_toggleable = 4

  This flag is set to true if the character at the cursor position is in toggleable state. For example, when the table is TOGGLE_FLICK_TO_HIRAGANA and key event '1' is received repeatedly, the preedit toggles like あ -> い -> う -> .... This flag is true during this cycle. This state is reset when user types another key or SessionCommand::STOP_KEY_TOGGLING is received.

The string data of Preedit is separated into Segment messages presenting the ime server's status. On Preedit status of Japanese IME, there are up to three segments; left side chars of cursor, forcused char, right side chars of cursor. On Conversion status of Japanese IME, the messages literally represent the segments of the conversion.

Used in: Preedit

• required Segment.Annotation annotation = 3

• required string value = 4

• required uint32 value_length = 5

  The length of value in characters. This is NOT a number in bytes or logical character units. So, the length of "abc" and "あいう" should be 3, "ヴ" should be 1 and "ｳﾞ" and "う゛" should be 2.

• optional string key = 6

  Source of the value. It is almost always the reading of the value.

Used in: Segment

• NONE = 0

• UNDERLINE = 1

• HIGHLIGHT = 2

• optional RendererCommand.CommandType type = 1

• optional bool visible = 2

  set visibility if visible is false, the content of output is basically ignored.

• optional Output output = 3

• optional RendererCommand.Rectangle preedit_rectangle = 4

  Preedit rectangle

• optional RendererCommand.ApplicationInfo application_info = 5

Application information Mozc UI is attaching

Used in: RendererCommand

• optional uint32 process_id = 1

• optional uint32 thread_id = 2

• optional uint32 receiver_handle = 3

  used in Windows: WHND of the message-only window:

• optional uint32 target_window_handle = 4

  used in Windows: HWND of the window where composition is displayed.

• optional ApplicationInfo.InputFrameworkType input_framework = 6

  Specifies which IM Framework is used in the client.

• optional int32 ui_visibilities = 9

  used in Windows:

  ShowUIDefault

• optional CharacterPosition composition_target = 10

  used in Windows: Specifies the target position in composition window.

• optional string pango_font_description = 13

  A string representation of PangoFontDescription http://developer.gnome.org/pango/stable/pango-Fonts.html#pango-font-description-from-string This field is not application specific information but temporaly locate here. TODO(nona): Make new message if necessary.

• optional IndicatorInfo indicator_info = 14

  used in Windows:

Represents IM Framework used in the client. Currently only Windows IM frameworks are supported.

Used in: ApplicationInfo

• UNKNOWN_FRAMEWORK = 0

  Default. For backward compatibility.

• TSF = 1

• IMKit = 3

• IBus = 4

used in Windows: Indicates if a UI element is expected to be displayed or not. Note that |RendererCommand::visible| should be prior to these flags, that is, you should hide all UI elements if |RendererCommand::visible| is false regardless of the visibility specified in this field.

• ShowUIDefault = 0

• ShowCandidateWindow = 2

• ShowSuggestWindow = 4

An equivalent to IMECHARPOSITION in IMM32. (For Windows only) TODO(yukawa): make a common candidate form format for all platforms.

Used in: ApplicationInfo

• optional uint32 position = 1

• optional Point top_left = 2

• optional uint32 line_height = 3

• optional Rectangle document_area = 4

• optional bool vertical_writing = 5

  A quick solution for vertical writing support. Strictly speaking, this is not part of IMECHARPOSITION in IMM32.

Used in: RendererCommand

• NOOP = 0

  No operation

• UPDATE = 1

  Update the current window

• SHUTDOWN = 2

  shutdown renderer

Visual information about mode indicator.

Used in: ApplicationInfo

• optional Status status = 1

Used in: CharacterPosition

• optional int32 x = 1

• optional int32 y = 2

Used in: RendererCommand, CharacterPosition

• optional int32 left = 1

• optional int32 top = 2

• optional int32 right = 3

• optional int32 bottom = 4

Clients' request to the server. Users cannot modify this. In the future each request may be able to be overwritten by Config. The server does not have to obey this request. Next ID: 24

Used in: Input, protocol.SessionState

• optional bool zero_query_suggestion = 1

  Enable zero query suggestion.

  true for android

• optional bool mixed_conversion = 2

  Conversion's candidate includes suggestion, prediction and conversion.

  true for android

• optional Request.SpecialRomanjiTable special_romanji_table = 4

  Use special Romanji table.

  TWELVE_KEYS_TO_HIRAGANA for android.

• optional Request.SpaceOnAlphanumeric space_on_alphanumeric = 6

• optional string keyboard_name = 7

  Keyboard name for touch devices. For example, "TWELVE_KEY_TOGGLE_KANA", "QWERTY_KANA_NUMBER". It is used to analyze touch event usage stats.

• optional bool update_input_mode_from_surrounding_text = 8

  Enables Composer's input mode auto updating by using surrounding text. For example, when a composition string is "ad", a carret is at the end, and a user selects HIRAGANA mode, if the user moves the carret to between "a" and "d" the mode will be automatically switch to ASCII (temporarily). See details in the Composer::UpdateInputMode.

• optional bool kana_modifier_insensitive_conversion = 9

  Enables Kana-modifier-insensitive conversion as follows: 1) Voiced/Semi-voiced kana will be hit by non-modified kana. e.g.) "ば" and "ぱ" will be hit by key "は". 2) Geminate consonant "っ" will be hit by non-modified kana "つ". 3) Palatalized kana will be hit by non-modified kana. e.g.) "ゃ" will be hit by key "や". Here is an example of the search: "学校" ("がっこう") will be hit by "かつこう".

• optional bool auto_partial_suggestion = 10

  Enables Auto partial suggestion (prefix candidates). For Auto partial suggestion, we can see candidates that match the prefix of the input reading. If we commit that candidate, we will show suggestions for remaining part of key. Note: This feature can be enabled only for mobile due to UX design.

• optional int32 emoji_rewriter_capability = 12

  By default, Emoji rewriter works on conversion mode only.

• optional Request.CrossingEdgeBehavior crossing_edge_behavior = 13

• optional Request.LanguageAwareInputBehavior language_aware_input = 14

• optional int32 candidate_page_size = 15

  Page size of the candidate list.

• optional int32 candidates_size_limit = 16

  The maximum limit of the candidates size. If not set, converter doesn't limit the size. NOTE: Each segment has at least one candidate and meta candidates even if this value is set to 0.

• optional DecoderExperimentParams decoder_experiment_params = 17

  Experimentally changes the decoder's behavior. This flag is usually populated through the phenotype flags.

• optional bool fill_incognito_candidate_words = 18

  Fills incognito_candidate_words filed of output.

• optional bool enable_a11y_description = 20

  Enables a11y support for candidates. If this field is set to true, a11y description is set to each candidate.

• repeated Request.AdditionalRenderableCharacterGroup additional_renderable_character_groups = 21

  Characters in the union of this list of groups can be contained in candidates. This feature is distinct from user preference. Do not make these option user selectable.

• optional bool is_handwriting = 22

  Whether the request is from handwriting. Candidates can be optimized differently for handwriting. For example, we support 混ぜ書き conversion ("かん字" → "漢字") for handwriting.

• optional bool is_incognito_mode = 23

  Whether the conversion is performed in incognito mode. In incognito mode, the conversion is performed without using user history and user dictionary. When any of this value and Config::incognito_mode are true, incognito mode is enabled. Clients needs to check ConversionRequest::incognito_mode() instead of this value directly, as the incognito mode can be set in other ways.

Additional Character Group represents certain group of characters, that can be additionaly requested from the client side, based on font-availability information. This enum is not intended to be used for user preference. 'Additional' cases can change as time advances. For example, when KANA_SUPPLEMENT_6_0 becomes enough available among environments, this option becomes default and the case will be removed. WARNING: Although cases are mutually exclusive now, they are not necessarily mutually exclusive. However, the current implementation in NormalizationRewriter assumes they are mutually exclusive. LINT.IfChange Next ID: 14

Used in: Request

• EMPTY = 0

  Do not use this case. This case is reserved for future usage. Because 0th element in enum is used as default value, in order to prevend having unexpected additional group, this case represents empty set of characters.

• KANA_SUPPLEMENT_6_0 = 2

  Additional Hiragana, Katakana, and Hentaigana. It only contains KATAKANA / HIRAGANA LETTER ARCHAIC YE (U+1B000 and U+1B001) since Unicode 6.0. Some fonts including M+ fonts only support this letter.

• KANA_SUPPLEMENT_AND_KANA_EXTENDED_A_10_0 = 3

  It contains 285 Hentaigana characters supported in KANA_SUPPLEMENT and KANA_EXTENDED_A (U+1B002 ~ U+1B11E) since Unicode 10.0.

• KANA_EXTENDED_A_14_0 = 4

  It contains four archaic hiraganas/katakanas (U+1B11F ~ U+1B122) since Unicode 14.0.

• EMOJI_12_1 = 5

  Additional Emoji Emoji in enum can be removed and become default several years passed after the introduction. Emoji 12.1, released October 2019

• EMOJI_13_0 = 6

  Emoji 13.0, released March 2020

• EMOJI_13_1 = 7

  Emoji 13.1, released September 2020

• EMOJI_14_0 = 8

  Emoji 14.0, released September 2021

• EMOJI_15_0 = 9

  Emoji 15.0, released September 2022

• EMOJI_15_1 = 12

  Emoji 15.1, released September 2023

• EMOJI_16_0 = 13

  Emoji 16.0, released September 2024

• EGYPTIAN_HIEROGLYPH_5_2 = 10

  Additional Hieroglyphs (U+13000 ~ U+1342E) Unicode 5.2, released October 2009

• IVS_CHARACTER = 11

  IVS characters in Adobe-Japan1 (U+E0100 ~ U+E010E)

Controls the behavior when a user types the left/right key at the edge of the preedit string (in more precise, the left key at the beginning of the preedit string, or the right key at the end).

Used in: Request

• DO_NOTHING = 0

  This is the default behavior. The cursor movement at the edge will make nothing, i.e., keeping the current cursor position (at the edge), consume the key event.

• COMMIT_WITHOUT_CONSUMING = 1

  This is the behavior, especially designed for alphabet keyboards on mobile devices. Assuming the following text: XXXXabcde|YYYYY where XXXX is preceding text, abcde is composing text, YYYYY is following text and '|' is the caret, when a user sends "RIGHT" cursor key, we'd like to commit the abcde and move the caret to right. So the user will get: XXXXabcdeY|YYYY Here, what we need is committing the "abcde" with the appropriate caret position. (Note that we need to handle the left cursor key, too). Also, we should *NOT* consume the key, so that the key event will be handled appropriately by the target application.

Controls the behavior of language aware input. Language aware input guesses the actual language regardless the input mode. For example, if user type "てｓｔ" it will be treated as "test".

Used in: Request

• DEFAULT_LANGUAGE_AWARE_BEHAVIOR = 0

  Performs the default behavior considering the platform and channel.

• NO_LANGUAGE_AWARE_INPUT = 1

  Does not perform this functionarity.

• LANGUAGE_AWARE_SUGGESTION = 2

  Adds a language aware candidate to the suggestion.

For emoji rewriter, it is necessary to control when the rewriter runs based on the clients. The following bit set is sync'ed to RewriterInterface::CapabilityType (see rewriter_interface.h, too), so that clients can fill the value.

• NOT_AVAILABLE = 0

• CONVERSION = 1

• PREDICTION = 2

• SUGGESTION = 4

• ALL = 7

  CONVERSION | PREDICTION | SUGGESTION.

Used in: Request

• SPACE_OR_CONVERT_KEEPING_COMPOSITION = 0

  The first input is treated as a space, double input is treated as a conversion. If a character is input after the first input, the composition will remain. For example, "ab<space>dc" becomes "ab dc" as a single composition.

• SPACE_OR_CONVERT_COMMITTING_COMPOSITION = 1

  The first input is treated as a space, double input is treated as a conversion. If a character is input after the first input, the previous composition will be committed. For example, "ab<space>dc" results "ab " as a committed string and "dc" as a composition.

• COMMIT = 2

  Commit the composition and a space.

Next ID: 51

Used in: Request

• DEFAULT_TABLE = 0

  Do not use special table. Romanji table is selected based on Config.

• TWELVE_KEYS_TO_HIRAGANA = 10

  Use special table for 12keys (to hiragana).

• TWELVE_KEYS_TO_HIRAGANA_INTUITIVE = 10000

  This is a temporary romaji table that is to be used instead of the current 12keys-to-hiragana table. TODO(noriyukit): Replace TWELVE_KEYS_TO_HIRAGANA by this.

• TWELVE_KEYS_TO_HALFWIDTHASCII = 11

  Use special table for 12keys (to half-width ascii).

• FLICK_TO_HIRAGANA = 13

  Use special table for flick (to hiragana).

• FLICK_TO_HIRAGANA_INTUITIVE = 10002

  This is a temporary romaji table that is to be used instead of the current flick-to-hiragana table. TODO(noriyukit): Replace FLICK_TO_HIRAGANA by this.

• FLICK_TO_HALFWIDTHASCII = 14

  Use special table for flick (to half-width ascii).

• FLICK_TO_HALFWIDTHASCII_IOS = 44

  Use special table for flick (to alphabet).

• FLICK_TO_NUMBER = 43

  Use special table for flick (to number).

• TOGGLE_FLICK_TO_HIRAGANA = 16

  Use special table for both toggle and flick (to hiragana).

• TOGGLE_FLICK_TO_HIRAGANA_INTUITIVE = 10001

  This is a temporary romaji table that is to be used instead of the current toggle_flick_hiragana table. TODO(noriyukit): Replace TOGGLE_FLICK_HIRAGANA by this.

• TOGGLE_FLICK_TO_NUMBER = 42

  Use special table for both toggle and flick (to number).

• TOGGLE_FLICK_TO_HALFWIDTHASCII_IOS = 45

  Use special table for both toggle and flick (to alphabet).

• TOGGLE_FLICK_TO_HALFWIDTHASCII = 17

  Use special table for both toggle and flick (to half-width ascii).

• QWERTY_MOBILE_TO_HIRAGANA = 20

  Use special table for Qwerty (for Mobile) (to hiragana).

• QWERTY_MOBILE_TO_HALFWIDTHASCII = 22

  Use special table for Qwerty (for Mobile) (to half-width ascii).

• GODAN_TO_HIRAGANA = 30

  Use special table for Godan (to hiragana).

• GODAN_TO_HALFWIDTHASCII = 31

  Use special table for Godan (to half-width ascii).

• NOTOUCH_TO_HIRAGANA = 40

  Use special table for Notouch (to hiragana).

• NOTOUCH_TO_HALFWIDTHASCII = 41

  Use special table for Notouch (to half-width ascii).

• FIFTY_KEYS_TO_HIRAGANA = 46

  Use special table for 50keys keyboard.

Result contains data to be submitted to the host application by the ime client.

Used in: Output, protocol.SessionState

• required Result.ResultType type = 1

• required string value = 2

  The result of conversion.

• optional string key = 3

  Source of the value. It is almost always the reading of the value.

• optional int32 cursor_offset = 4

  The caret position after the result submission. "0" means the end of the result, and a positive value means moving forward and a negative value backward. e.g.) "-s", where s is the length of value, means the caret position after the committing should be the beginning of the committed value.

• repeated ResultToken tokens = 5

  Additional information propagated from the internal status.

Used in: Result

• NONE = 0

• STRING = 1

Detailed information of Result.

Used in: Result

• optional string value = 1

  `value` and `key` represents Segment.Candidate. If the candidante has functional values, they are stored as a sepalate ResultToken. e.g. A candidate of {value="今日は", content_value="今日"} results two ResultToken of {value="今日"} and {value="は"}.

• optional string key = 2

• optional int32 lid = 3

  `lid` and `rid` are copied from Segment.Candidate. -1 is used as a unknown POS. e.g. A candidate of {value="朝は", content_value="朝", lid=2, rid=3} results two ResultToken of {value="朝", lid=2, rid=-1} and {value="は", lid=-1, rid=3}.

• optional int32 rid = 4

Used in: Input, Output.Callback

• required SessionCommand.CommandType type = 1

• optional int32 id = 2

  Unique number specifying a candidate word. Note: This value is NOT an index of the candidate window or the candidate list. This value is a return value of CandidateWord::id().

• optional CompositionMode composition_mode = 3

  This is used with SWITCH_INPUT_MODE, TURN_ON_IME and TURN_OFF_IME.

• optional string text = 4

  Text argument. This is used by CONVERT_REVERSE at this moment.

• optional uint32 cursor_position = 5

  New cursor position in preedit. Used with MOVE_CURSOR.

• repeated SessionCommand.CompositionEvent composition_events = 11

  Assumes that the entries are sorted by the probability. The most probable event should be at the top.

Used in: SessionCommand

• NONE = 0

  Do nothing.

• REVERT = 1

  Revert the session, this is usually similar to type ESC several times.

• SUBMIT = 2

  Commit the session, this is usually similar to type Enter. SUBMIT session command is accepted in any status. Pre-condition: - Any states of IME are acceptable. Post-condition: - Preedit text becomes empty.

• SELECT_CANDIDATE = 3

  Select the specified candidate word by id. This command is usually used with mouse clicking.

• HIGHLIGHT_CANDIDATE = 4

  Set the focus to the candidate by id. This is usually used with mouse dragging or selection of word usage dictionary. The difference from SELECT_CANDIDATE is that HIGHLIGHT_CANDIDATE does not close the candidate window while SELECT_CANDIDATE closes the candidate window.

• SWITCH_INPUT_MODE = 5

  Specify the input mode. This command should be used with composition_mode.

• GET_STATUS = 6

  Return the current status such as composition mode, preedit method, etc.

• SUBMIT_CANDIDATE = 7

  This command is typically used for mobile IME's partial conversion, but currently it is on the way. This description is for current spec. This command requires that candidates exist. If there is a focused candidate (Conversion or Prediction state), the candidate matched with the given id in the first segment is submitted, even though the selected segment is not the first segment (Important thing is whether focused candidate exists or not. Focused index itself is ignored). This behavior should be updated because current cursor position and position of focused segment affects nothing. We should fix this non-intuitive behavior. Intuitive behavior might be submitting segments from first one to focused one (inclusive). If no focused candidate (Suggestion, including ZeroQuery suggestion), first (and only) segment's candidate of which id is equal to id field of Input message is submitted. This behavior should be fixed because current cursor position affects nothing. In future, the characters after the cursor should be kept as preedit. This command's pre- and post- conditions are differenct from SUBMIT command's. Following conditions will be kept after updating the behavior. Pre-condition: - There should be candidate. Post-condition: - No guarantee on preedit text. TODO(yamaguchi): Update corresponding implementation please.

• CONVERT_REVERSE = 8

  Perform reverse conversion.

• UNDO = 9

  Perform Undo.

• RESET_CONTEXT = 10

  Reset convert history and revert current composition. This is usually used by moving cursor with mouse clicking.

• MOVE_CURSOR = 11

  Change cursor position in preedit.

• SWITCH_INPUT_FIELD_TYPE = 12

  Specify the input field type.

• UNDO_OR_REWIND = 14

  This command is used in only Android. Works UNDO or rewind HIRAGANA characters based on the state.

• COMMIT_RAW_TEXT = 19

  Commit the raw text of the composed string.

• CONVERT_PREV_PAGE = 20

  Call ConvertPrevPage session command to show the previous page of candidates.

• CONVERT_NEXT_PAGE = 21

  Call ConvertNextPage session command to show the next page of candidates.

• TURN_ON_IME = 22

  Make sure IME is turned on. Optionally you can also provide new input mode in |composition_mode| (but you must not set DIRECT to it). |composition_mode| is honored even when IME is already turned on.

• TURN_OFF_IME = 23

  Make sure IME is turned off. Optionally you can also provide new input mode in |composition_mode| (but you must not set DIRECT to it). If IME |composition_mode| is honored even when IME is already turned off.

• DELETE_CANDIDATE_FROM_HISTORY = 24

  Delete the candidate specified with |id = 2| from the user history.

• STOP_KEY_TOGGLING = 25

  Stops key toggling of the composer if its table is a toggle-supported layout (e.g., 12-key toggle flick.)

• UPDATE_COMPOSITION = 26

  Update composition with |compoisition_events|. Unlike SEND_KEY command, this command completely replaces the composition rather than appending to the existing composition. The command will be used for supporting handwriting.

Used by UPDATE_COMPOSITION event

Used in: SessionCommand

• optional string composition_string = 1

• optional double probability = 2

  Sum of probabilities must be lesser or equal than 1. 0<= probability <= 1

Used in: Output, RendererCommand.IndicatorInfo

• optional bool activated = 1

  Whether IME is ON or OFF

• optional CompositionMode mode = 2

  Visible composition mode when IME is activated. This mode may come from a temporary composition mode. See |comeback_mode|. TODO(yukawa): Rename this field to "visible_mode".

• optional CompositionMode comeback_mode = 3

  True composition mode that is suitable for system global and permanent composition mode. When a temporary composition mode exists, |comeback_mode| can be different from |mode|. TODO(yukawa): Use more appropriate name.

• optional bool undo_available = 26

  Whether Undo operation is available. The client may enable/disable the Undo key based on this value.