OLD | NEW |
1 // Copyright 2016 The Chromium Authors. All rights reserved. | 1 // Copyright 2016 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef SERVICES_SHELL_PUBLIC_CPP_NAMES_H_ | 5 #ifndef SERVICES_SHELL_PUBLIC_CPP_NAMES_H_ |
6 #define SERVICES_SHELL_PUBLIC_CPP_NAMES_H_ | 6 #define SERVICES_SHELL_PUBLIC_CPP_NAMES_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 | 9 |
10 namespace shell { | 10 namespace shell { |
11 | 11 |
12 extern const char kNameType_Mojo[]; | 12 extern const char kNameType_Mojo[]; |
13 extern const char kNameType_Exe[]; | 13 extern const char kNameType_Exe[]; |
14 | 14 |
15 // Mojo services and applications are identified by structured "names", of the | 15 // Mojo services and applications are identified by structured "names", of the |
16 // form: | 16 // form: |
17 // | 17 // |
18 // type:path. | 18 // type:path. |
19 // | 19 // |
20 // The type field tells the shell how to load the application. Two types are | 20 // The type field tells the shell how to load the application. Two types are |
21 // currently recognized: | 21 // currently recognized: |
22 // | 22 // |
23 // mojo | 23 // mojo |
24 // Represents an application packaged as a .mojo, launched from the | 24 // Represents an application packaged as a .mojo, launched from the |
25 // NativeRunner launch path. .mojo files are assumed to live alongside the | 25 // NativeRunner launch path. .mojo files are assumed to live alongside the |
26 // shell executable at a path matching <path>/<path>.mojo. .mojo applications | 26 // shell executable at a path matching <path>/<path>.mojo. .mojo applications |
27 // have a MojoMain() entrypoint that receives a handle to a ShellClientRequest | 27 // have a MojoMain() entrypoint that receives a handle to a ServiceRequest |
28 // that must be bound to enable further communication with the shell. | 28 // that must be bound to enable further communication with the shell. |
29 // | 29 // |
30 // exe | 30 // exe |
31 // Represents a native executable on the host platform, expected to live | 31 // Represents a native executable on the host platform, expected to live |
32 // alongside the shell executable. Executables launched via this mechanism are | 32 // alongside the shell executable. Executables launched via this mechanism are |
33 // passed a handle to the shell on the command line and are expected to bind | 33 // passed a handle to the shell on the command line and are expected to bind |
34 // a ShellClientRequest enabling further communication with the shell. The | 34 // a ServiceRequest enabling further communication with the shell. The |
35 // path component contains the executable name, minus any platform-specific | 35 // path component contains the executable name, minus any platform-specific |
36 // extension. | 36 // extension. |
37 // | 37 // |
38 // Other types may be supplied but are not recognized by any of the | 38 // Other types may be supplied but are not recognized by any of the |
39 // NativeRunners, and as such custom loaders must be specified for such names. | 39 // NativeRunners, and as such custom loaders must be specified for such names. |
40 // | 40 // |
41 // Any name type may serve as an alias for any other name type. Aliasing is | 41 // Any name type may serve as an alias for any other name type. Aliasing is |
42 // resolved implicitly by the Shell. | 42 // resolved implicitly by the Shell. |
43 | 43 |
44 // Returns true if the name is a valid form, i.e. type:path. path cannot start | 44 // Returns true if the name is a valid form, i.e. type:path. path cannot start |
45 // with a "//" sequence. These are _not_ urls. | 45 // with a "//" sequence. These are _not_ urls. |
46 bool IsValidName(const std::string& name); | 46 bool IsValidName(const std::string& name); |
47 | 47 |
48 // Get the type component of the specified name. | 48 // Get the type component of the specified name. |
49 std::string GetNameType(const std::string& name); | 49 std::string GetNameType(const std::string& name); |
50 | 50 |
51 // Get the path component of the specified name. | 51 // Get the path component of the specified name. |
52 std::string GetNamePath(const std::string& name); | 52 std::string GetNamePath(const std::string& name); |
53 | 53 |
54 } // namespace shell | 54 } // namespace shell |
55 | 55 |
56 #endif // SERVICES_SHELL_PUBLIC_CPP_NAMES_H_ | 56 #endif // SERVICES_SHELL_PUBLIC_CPP_NAMES_H_ |
OLD | NEW |