chrome/common/spellcheck_messages.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // IPC messages for spellcheck.
   6 // Multiply-included message file, hence no include guard.
   7
   8 #include "chrome/common/spellcheck_marker.h"
   9 #include "chrome/common/spellcheck_result.h"
  10 #include "ipc/ipc_message_macros.h"
  11 #include "ipc/ipc_platform_file.h"
  12
  13 #if !defined(ENABLE_SPELLCHECK)
  14 #error "Spellcheck should be enabled"
  15 #endif
  16
  17 #define IPC_MESSAGE_START SpellCheckMsgStart
  18
  19 IPC_ENUM_TRAITS(SpellCheckResult::Decoration)
  20
  21 IPC_STRUCT_TRAITS_BEGIN(SpellCheckResult)
  22   IPC_STRUCT_TRAITS_MEMBER(decoration)
  23   IPC_STRUCT_TRAITS_MEMBER(location)
  24   IPC_STRUCT_TRAITS_MEMBER(length)
  25   IPC_STRUCT_TRAITS_MEMBER(replacement)
  26   IPC_STRUCT_TRAITS_MEMBER(hash)
  27 IPC_STRUCT_TRAITS_END()
  28
  29 IPC_STRUCT_TRAITS_BEGIN(SpellCheckMarker)
  30   IPC_STRUCT_TRAITS_MEMBER(hash)
  31   IPC_STRUCT_TRAITS_MEMBER(offset)
  32 IPC_STRUCT_TRAITS_END()
  33
  34 // Messages sent from the browser to the renderer.
  35
  36 IPC_MESSAGE_CONTROL1(SpellCheckMsg_EnableSpellCheck,
  37                      bool)
  38
  39 // Passes some initialization params from the browser to the renderer's
  40 // spellchecker. This can be called directly after startup or in (async)
  41 // response to a RequestDictionary ViewHost message.
  42 IPC_MESSAGE_CONTROL4(SpellCheckMsg_Init,
  43                      IPC::PlatformFileForTransit /* bdict_file */,
  44                      std::set<std::string> /* custom_dict_words */,
  45                      std::string /* language */,
  46                      bool /* auto spell correct */)
  47
  48 // Words have been added and removed in the custom dictionary; update the local
  49 // custom word list.
  50 IPC_MESSAGE_CONTROL2(SpellCheckMsg_CustomDictionaryChanged,
  51                      std::vector<std::string> /* words_added */,
  52                      std::vector<std::string> /* words_removed */)
  53
  54 // Toggle the auto spell correct functionality.
  55 IPC_MESSAGE_CONTROL1(SpellCheckMsg_EnableAutoSpellCorrect,
  56                      bool /* enable */)
  57
  58 #if !defined(OS_MACOSX)
  59 // Sends text-check results from the Spelling service when the service finishes
  60 // checking text received by a SpellCheckHostMsg_CallSpellingService message.
  61 // If the service is not available, the 4th parameter should be false and the
  62 // 5th parameter should contain the requested sentence.
  63 IPC_MESSAGE_ROUTED4(SpellCheckMsg_RespondSpellingService,
  64                     int             /* request identifier given by WebKit */,
  65                     bool            /* succeeded calling service */,
  66                     base::string16  /* sentence */,
  67                     std::vector<SpellCheckResult>)
  68 #endif
  69
  70 #if defined(OS_MACOSX)
  71 // This message tells the renderer to advance to the next misspelling. It is
  72 // sent when the user clicks the "Find Next" button on the spelling panel.
  73 IPC_MESSAGE_ROUTED0(SpellCheckMsg_AdvanceToNextMisspelling)
  74
  75 // Sends when NSSpellChecker finishes checking text received by a preceding
  76 // SpellCheckHostMsg_RequestTextCheck message.
  77 IPC_MESSAGE_ROUTED2(SpellCheckMsg_RespondTextCheck,
  78                     int        /* request identifier given by WebKit */,
  79                     std::vector<SpellCheckResult>)
  80
  81 IPC_MESSAGE_ROUTED1(SpellCheckMsg_ToggleSpellPanel,
  82                     bool)
  83 #endif
  84
  85 // Messages sent from the renderer to the browser.
  86
  87 // The renderer has tried to spell check a word, but couldn't because no
  88 // dictionary was available to load. Request that the browser find an
  89 // appropriate dictionary and return it.
  90 IPC_MESSAGE_CONTROL0(SpellCheckHostMsg_RequestDictionary)
  91
  92 // Tracks spell checking occurrence to collect histogram.
  93 IPC_MESSAGE_ROUTED2(SpellCheckHostMsg_NotifyChecked,
  94                     base::string16 /* word */,
  95                     bool /* true if checked word is misspelled */)
  96
  97 #if !defined(OS_MACOSX)
  98 // Asks the Spelling service to check text. When the service finishes checking
  99 // the input text, it sends a SpellingCheckMsg_RespondSpellingService with
 100 // text-check results.
 101 IPC_MESSAGE_CONTROL4(SpellCheckHostMsg_CallSpellingService,
 102                      int /* route_id for response */,
 103                      int /* request identifier given by WebKit */,
 104                      base::string16 /* sentence */,
 105                      std::vector<SpellCheckMarker> /* markers */)
 106 #endif
 107
 108 #if defined(OS_MACOSX)
 109 // Tells the browser to display or not display the SpellingPanel
 110 IPC_MESSAGE_ROUTED1(SpellCheckHostMsg_ShowSpellingPanel,
 111                     bool /* if true, then show it, otherwise hide it*/)
 112
 113 // Tells the browser to update the spelling panel with the given word.
 114 IPC_MESSAGE_ROUTED1(SpellCheckHostMsg_UpdateSpellingPanelWithMisspelledWord,
 115                     base::string16 /* the word to update the panel with */)
 116
 117 // TODO(groby): This needs to originate from SpellcheckProvider.
 118 IPC_SYNC_MESSAGE_CONTROL2_1(SpellCheckHostMsg_CheckSpelling,
 119                             base::string16 /* word */,
 120                             int /* route_id */,
 121                             bool /* correct */)
 122
 123 IPC_SYNC_MESSAGE_CONTROL1_1(SpellCheckHostMsg_FillSuggestionList,
 124                             base::string16 /* word */,
 125                             std::vector<base::string16> /* suggestions */)
 126
 127 IPC_MESSAGE_CONTROL4(SpellCheckHostMsg_RequestTextCheck,
 128                      int /* route_id for response */,
 129                      int /* request identifier given by WebKit */,
 130                      base::string16 /* sentence */,
 131                      std::vector<SpellCheckMarker> /* markers */)
 132
 133 IPC_MESSAGE_ROUTED2(SpellCheckHostMsg_ToggleSpellCheck,
 134                     bool /* enabled */,
 135                     bool /* checked */)
 136 #endif  // OS_MACOSX