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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*
* Copyright (c) 2015, 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_APPLICATION_STATE_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_APPLICATION_STATE_H_
#include <map>
#include <vector>
#include "application_manager/hmi_state.h"
#include "utils/lock.h"
#include "utils/macro.h"
namespace application_manager {
typedef std::vector<WindowID> WindowIds;
typedef std::vector<HmiStatePtr> HmiStates;
typedef std::map<WindowID, HmiStates> HmiStatesMap;
typedef std::vector<std::string> WindowNames;
typedef std::map<WindowID, std::string> WindowNamesMap;
/*
* Class represents application state, i.e. current HMI level, audio streaming
* state and context
* Current implementation:
* - has regular state, which is default or base state
* - temporary states can be applied on top of regular state
* - on temporary state end it is being removed from states list
* - current state is the consolidated state of all the states, since different
* temporary state can affect one or more parameters (HMI state, audio, context)
* - can have postponed state (comes from resumption process), which is
* not applied on top, but is being added before base and can replace base later
* on
*/
class ApplicationState {
public:
/**
* @brief ApplicationState constructor
*/
ApplicationState();
/**
* @brief Init state
* @param window_id window id for HMI state
* @param window_name name of inited window
* @param state Initial state
*/
void InitState(const WindowID window_id,
const std::string& window_name,
HmiStatePtr state);
/**
* @brief Adds state to states storage
* @param window_id window id for HMI state
* @param state State of application
*/
void AddState(const WindowID window_id, HmiStatePtr state);
/**
* @brief Removes state from states storage
* @param window_id window id for HMI state
* @param state State of application
*/
void RemoveState(const WindowID window_id, HmiState::StateID state);
/**
* @brief Gets state by state id
* @param window_id window id for HMI state
* @param state_id State id
* @return Pointer to application state
*/
HmiStatePtr GetState(const WindowID window_id,
HmiState::StateID state_id) const;
/**
* @brief Gets the list of all states matches provided state id
* @param state_id state id to get
* @return list of all states matches provided state id
*/
HmiStates GetStates(const HmiState::StateID state_id) const;
/**
* @brief Getter for a list of available application windows including the
* main
* @return list of available window ids
*/
WindowIds GetWindowIds() const;
/**
* @brief Getter f0r a list of all existing window names
* @return list of available window names
*/
WindowNames GetWindowNames() const;
private:
/**
* @brief AddHMIState the function that will change application's
* hmi state.
*
* @param window_id window id for HMI state
*
* @param state new hmi state for certain application.
*/
void AddHMIState(const WindowID window_id, HmiStatePtr state);
/**
* @brief RemoveHMIState the function that will turn back hmi_level after end
* of some event
*
* @param window_id window id for HMI state.
*
* @param state_id that should be removed
*/
void RemoveHMIState(const WindowID window_id, HmiState::StateID state_id);
/**
* @brief RemoveWindowHMIStates removes all HMI states related to specified
* window
* @param window_id window ID to remove
*/
void RemoveWindowHMIStates(const WindowID window_id);
/**
* @brief Removes postponed state
* @param window_id window id for HMI state
*/
void RemovePostponedState(const WindowID window_id);
/**
* @brief Sets regular state of application
* @param window_id window id for HMI state
* @param state State of application
*/
void SetRegularState(const WindowID window_id, HmiStatePtr state);
/**
* @brief Sets postponed state of application.
* This state could be set as regular later on
* @param window_id window id for HMI state
* @param state state to setup
*/
void SetPostponedState(const WindowID window_id, HmiStatePtr state);
/**
* @brief HmiState of application within active events PhoneCall, TTS< etc ...
* @param window_id window id for HMI state
* @return Active HmiState of application
*/
HmiStatePtr CurrentHmiState(const WindowID window_id) const;
/**
* @brief RegularHmiState of application without active events VR, TTS etc ...
* @param window_id window id for HMI state
* @return HmiState of application
*/
HmiStatePtr RegularHmiState(const WindowID window_id) const;
/**
* @brief PostponedHmiState returns postponed hmi state of application
* if it's present
* @param window_id window id for HMI state
* @return Postponed hmi state of application
*/
HmiStatePtr PostponedHmiState(const WindowID window_id) const;
/**
* @brief Active states of application
*/
HmiStatesMap hmi_states_map_;
/**
* @brief hmi_states_map_lock_
*/
mutable sync_primitives::Lock hmi_states_map_lock_;
DISALLOW_COPY_AND_ASSIGN(ApplicationState);
};
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_APPLICATION_STATE_H_
|
