Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 19d4349e45c96b810ba99f588abdbde5b6c57e5b (plain) (blame)
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
# *****************************************************************************
# * Copyright (c) 2011, 2013 Wind River Systems, Inc. and others.
# * All rights reserved. This program and the accompanying materials
# * are made available under the terms of the Eclipse Public License v1.0
# * which accompanies this distribution, and is available at
# * http://www.eclipse.org/legal/epl-v10.html
# *
# * Contributors:
# *     Wind River Systems - initial API and implementation
# *****************************************************************************

"""
PathMap service manages file path translation across systems.
"""

from .. import services

NAME = "PathMap"

# Path mapping rule property names.

# String, contexts query, see IContextQuery
PROP_CONTEXT_QUERY = "ContextQuery"

# String, destination, or run-time file path
PROP_DESTINATION = "Destination"

# String
PROP_HOST = "Host"

# String, rule ID
PROP_ID = "ID"

# String, file access protocol, see PROTOCOL_*, default is regular file
PROP_PROTOCOL = "Protocol"

# String, source, or compile-time file path
PROP_SOURCE = "Source"

# Deprecated
# String, symbols context group ID or name, deprecated - use ContextQuery
PROP_CONTEXT = "Context"

# PROP_PROTOCOL values.
# Regular file access using system calls
PROTOCOL_FILE = "file"

# File should be accessed using File System service on host
PROTOCOL_HOST = "host"

# File should be accessed using File System service on target
PROTOCOL_TARGET = "target"


class PathMapListener(object):
    """Pathmap event listener is notified when pathmap changes."""

    def changed(self):
        """Called when a pathmap has been changed."""
        pass


class PathMapRule(object):
    """
    PathMapRule represents a single file path mapping rule.
    """
    def __init__(self, props):
        self._props = props or {}

    def __str__(self):
        return str(self._props)

    def __json__(self):
        return self._props

    def getContextQuery(self):
        """Get context query that defines scope of the mapping rule, see
        also IContextQuery.
        Same as getProperties().get(PROP_CONTEXT_QUERY)
        @return context query expression, or None.
        """
        return self._props.get(PROP_CONTEXT_QUERY, None)

    def getProperties(self):
        """
        Get rule properties. See PROP_* definitions for property names.
        Context properties are read only, clients should not try to modify
        them.
        @return Map of rule properties.
        """
        return self._props

    def getID(self):
        """
        Get rule unique ID.
        Same as getProperties().get(PROP_ID)
        @return rule ID.
        """
        return self._props.get(PROP_ID)

    def getSource(self):
        """
        Get compile-time file path.
        Same as getProperties().get(PROP_SOURCE)
        @return compile-time file path.
        """
        return self._props.get(PROP_SOURCE)

    def getDestination(self):
        """
        Get run-time file path.
        Same as getProperties().get(PROP_DESTINATION)
        @return run-time file path.
        """
        return self._props.get(PROP_DESTINATION)

    def getHost(self):
        """
        Get host name of this rule.
        Same as getProperties().get(PROP_HOST)
        @return host name.
        """
        return self._props.get(PROP_HOST)

    def getProtocol(self):
        """
        Get file access protocol name.
        Same as getProperties().get(PROP_PROTOCOL)
        @return protocol name.
        """
        return self._props.get(PROP_PROTOCOL)


class PathMapService(services.Service):
    def getName(self):
        return NAME

    def get(self, done):
        """
        Retrieve file path mapping rules.

        @param done - call back interface called when operation is completed.
        @return - pending command handle.
        """
        return NotImplementedError("Abstract method")

    def set(self, pathMap, done):  # @ReservedAssignment
        """
        Set file path mapping rules.

        @param pathMap - file path mapping rules.
        @param done - call back interface called when operation is completed.
        @return - pending command handle.
        """
        return NotImplementedError("Abstract method")


class DoneGet(object):
    """
    Client call back interface for get().
    """
    def doneGet(self, token, error, pathMap):
        """
        Called when file path mapping retrieval is done.
        @param error - error description if operation failed, None if
                       succeeded.
        @param pathMap - file path mapping data.
        """
        pass


class DoneSet(object):
    """
    Client call back interface for set().
    """
    def doneSet(self, token, error):
        """
        Called when file path mapping transmission is done.
        @param error - error description if operation failed, None if
                       succeeded.
        @param map - memory map data.
        """
        pass

Back to the top