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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
/*
* Copyright (c) 2016, Ford Motor Company
* 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 the Ford Motor Company 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 HOLDER 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.
*/
#ifndef SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_HMI_LANGUAGE_HANDLER_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_HMI_LANGUAGE_HANDLER_H_
#include "application_manager/event_engine/event_observer.h"
#include "interfaces/HMI_API.h"
#include "resumption/last_state_wrapper.h"
#include "smart_objects/smart_object.h"
#include "utils/lock.h"
namespace application_manager {
class ApplicationManager;
/**
* Class is used to handle edge case with slow HMI responses for current
* languages. Main idea is to cache values within some persistent storage and
* respond to applications with these values. In case app registered before
* responses are gotten and after responses were received their language(s)
* mismatch to current on HMI - apps have to be unregistered.
**/
class HMILanguageHandler : public event_engine::EventObserver {
public:
typedef std::map<uint32_t, bool> Apps;
/**
* @brief System interfaces
*/
enum Interface { INTERFACE_UI, INTERFACE_VR, INTERFACE_TTS };
/**
* @brief Class constructor
*/
HMILanguageHandler(ApplicationManager& application_manager);
/**
* @brief Sets language for interface
* @param interface Interface
* @param language Language
*/
void set_language_for(Interface interface,
hmi_apis::Common_Language::eType language);
/**
* @brief Gets language for interface
* @param interface Interface
* @return Language
*/
hmi_apis::Common_Language::eType get_language_for(Interface interface) const;
void on_event(const event_engine::Event& event) OVERRIDE;
/**
* @brief Trigger waiting for response
* @param request Request object
*/
void set_handle_response_for(const smart_objects::SmartObject& request);
/**
* @brief Sets default languages from HMI capabilities
* @param ui UI language
* @param vr VR language
* @param tts TTS language
*/
void set_default_capabilities_languages(hmi_apis::Common_Language::eType ui,
hmi_apis::Common_Language::eType vr,
hmi_apis::Common_Language::eType tts);
DEPRECATED
void Init(resumption::LastState*);
void Init(resumption::LastStateWrapperPtr value);
/**
* @brief Removes application from container after
* removing application from core
* @param app_id id application for removing
*/
void OnUnregisterApplication(uint32_t app_id);
private:
void SendOnLanguageChangeToMobile(uint32_t connection_key);
/**
* @brief Verifies languages gotten from HMI with persisted languages
*/
void VerifyWithPersistedLanguages();
/**
* @brief Handles applications registered before actual HMI languages
* have been received
* @param app_id Application id
*/
void HandleWrongLanguageApp(const Apps::value_type& app_id);
/**
* @brief Checks if application needs to be handled because of language(s)
* mismatch
* @param app Application
*/
void CheckApplication(const Apps::value_type app);
sync_primitives::Lock apps_lock_;
/**
* @brief Applications, which needs to be handled
*/
Apps apps_;
/**
* @brief UI language persisted from previous ignition cycle
*/
hmi_apis::Common_Language::eType persisted_ui_language_;
/**
* @brief VR language persisted from previous ignition cycle
*/
hmi_apis::Common_Language::eType persisted_vr_language_;
/**
* @brief TTS language persisted from previous ignition cycle
*/
hmi_apis::Common_Language::eType persisted_tts_language_;
/**
* @brief Default UI language from HMI capabilitites
*/
hmi_apis::Common_Language::eType capabilities_ui_language_;
/**
* @brief Default VR language from HMI capabilitites
*/
hmi_apis::Common_Language::eType capabilities_vr_language_;
/**
* @brief Default TTS language from HMI capabilitites
*/
hmi_apis::Common_Language::eType capabilities_tts_language_;
/**
* @brief Indicates if current UI language has been received from HMI
*/
bool is_ui_language_received_;
/**
* @brief Indicates if current VR language has been received from HMI
*/
bool is_vr_language_received_;
/**
* @brief Indicates if current TTS language has been received from HMI
*/
bool is_tts_language_received_;
resumption::LastStateWrapperPtr last_state_wrapper_;
ApplicationManager& application_manager_;
};
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_HMI_LANGUAGE_HANDLER_H_
|
