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
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"
interface nsIFile;
interface nsIURI;
/**
* Represents the command line used to invoke a XUL application. This may be the
* original command-line of this instance, or a command line remoted from another
* instance of the application.
*
* DEFINITIONS:
* "arguments" are any values found on the command line.
* "flags" are switches. In normalized form they are preceded by a single dash.
* Some flags may take "parameters", e.g. "--url <param>".
*/
[scriptable, uuid(bc3173bd-aa46-46a0-9d25-d9867a9659b6)]
interface nsICommandLine : nsISupports
{
/**
* Number of arguments in the command line. The application name is not
* part of the command line.
*/
readonly attribute long length;
/**
* Get an argument from the array of command-line arguments.
*
* On windows, flags of the form /flag are normalized to -flag. /flag:param
* are normalized to -flag param.
*
* On *nix and mac flags of the form --flag are normalized to -flag. --flag=param
* are normalized to the form -flag param.
*
* @param aIndex The argument to retrieve. This index is 0-based, and does
* not include the application name.
* @return The indexth argument.
* @throws NS_ERROR_ILLEGAL_VALUE if aIndex is out of bounds.
*/
AString getArgument(in long aIndex);
/**
* Find a command-line flag.
*
* @param aFlag The flag name to locate. Do not include the initial
* hyphen.
* @param aCaseSensitive Whether to do case-sensitive comparisons.
* @return The position of the flag in the command line.
*/
long findFlag(in AString aFlag, in boolean aCaseSensitive);
/**
* Remove arguments from the command line. This normally occurs after
* a handler has processed the arguments.
*
* @param aStart Index to begin removing.
* @param aEnd Index to end removing, inclusive.
*/
void removeArguments(in long aStart, in long aEnd);
/**
* A helper method which will find a flag and remove it in one step.
*
* @param aFlag The flag name to find and remove.
* @param aCaseSensitive Whether to do case-sensitive comparisons.
* @return Whether the flag was found.
*/
boolean handleFlag(in AString aFlag, in boolean aCaseSensitive);
/**
* Find a flag with a parameter and remove both. This is a helper
* method that combines "findFlag" and "removeArguments" in one step.
*
* @return null (a void astring) if the flag is not found. The parameter value
* if found. Note that null and the empty string are not the same.
* @throws NS_ERROR_INVALID_ARG if the flag exists without a parameter
*
* @param aFlag The flag name to find and remove.
* @param aCaseSensitive Whether to do case-sensitive flag search.
*/
AString handleFlagWithParam(in AString aFlag, in boolean aCaseSensitive);
/**
* The type of command line being processed.
*
* STATE_INITIAL_LAUNCH is the first launch of the application instance.
* STATE_REMOTE_AUTO is a remote command line automatically redirected to
* this instance.
* STATE_REMOTE_EXPLICIT is a remote command line explicitly redirected to
* this instance using xremote/windde/appleevents.
*/
readonly attribute unsigned long state;
const unsigned long STATE_INITIAL_LAUNCH = 0;
const unsigned long STATE_REMOTE_AUTO = 1;
const unsigned long STATE_REMOTE_EXPLICIT = 2;
/**
* There may be a command-line handler which performs a default action if
* there was no explicit action on the command line (open a default browser
* window, for example). This flag allows the default action to be prevented.
*/
attribute boolean preventDefault;
/**
* The working directory for this command line. Use this property instead
* of the working directory for the current process, since a redirected
* command line may have had a different working directory.
*
* @throws NS_ERROR_NOT_INITIALIZED if the working directory was not specified.
*/
readonly attribute nsIFile workingDirectory;
/**
* Resolve a file-path argument into an nsIFile. This method gracefully
* handles relative or absolute file paths, according to the working
* directory of this command line.
* If the path is relative and there is no working directory available,
* this may return null.
*
* @param aArgument The path to resolve.
*
*/
nsIFile resolveFile(in AString aArgument);
/**
* Resolves a URI argument into a URI. This method has platform-specific
* logic for converting an absolute URI or a relative file-path into the
* appropriate URI object; it gracefully handles win32 C:\ paths which would
* confuse the ioservice if passed directly.
*
* @param aArgument The command-line argument to resolve.
*/
nsIURI resolveURI(in AString aArgument);
};
|
