1 /* ***** BEGIN LICENSE BLOCK *****
2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3 *
4 * The contents of this file are subject to the Mozilla Public License Version
5 * 1.1 (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
7 * http://www.mozilla.org/MPL/
8 *
9 * Software distributed under the License is distributed on an "AS IS" basis,
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 * for the specific language governing rights and limitations under the
12 * License.
13 *
14 * The Original Code is the Mozilla toolkit.
15 *
16 * The Initial Developer of the Original Code is
17 * Robert Strong <robert.bugzilla@gmail.com>
18 * Portions created by the Initial Developer are Copyright (C) 2007
19 * the Initial Developer. All Rights Reserved.
20 *
21 * Contributor(s):
22 *
23 * Alternatively, the contents of this file may be used under the terms of
24 * either the GNU General Public License Version 2 or later (the "GPL"), or
25 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26 * in which case the provisions of the GPL or the LGPL are applicable instead
27 * of those above. If you wish to allow use of your version of this file only
28 * under the terms of either the GPL or the LGPL, and not to allow others to
29 * use your version of this file under the terms of the MPL, indicate your
30 * decision by deleting the provisions above and replace them with the notice
31 * and other provisions required by the GPL or the LGPL. If you do not delete
32 * the provisions above, a recipient may use your version of this file under
33 * the terms of any one of the MPL, the GPL or the LGPL.
34 *
35 * ***** END LICENSE BLOCK ***** */
36
37 #include "nsISupports.idl"
38
39 interface nsICommandLine;
40
41 /**
42 * Validates arguments on the command line of an XUL application.
43 *
44 * Each validator is registered in the category "command-line-validator".
45 * The entries in this category are read in alphabetical order, and each
46 * category value is treated as a service contractid implementing this
47 * interface.
48 *
49 * By convention, validator with ordinary priority should begin with "m".
50 *
51 * Example:
52 * Category Entry Value
53 * command-line-validator b-browser @mozilla.org/browser/clh;1
54 * command-line-validator m-edit @mozilla.org/composer/clh;1
55 * command-line-validator m-irc @mozilla.org/chatzilla/clh;1
56 *
57 */
58
59 [scriptable, uuid(5ecaa593-7660-4a3a-957a-92d5770671c7)]
60 interface nsICommandLineValidator : nsISupports
61 {
62 /**
63 * Process the command-line validators in the proper order, calling
64 * "validate()" on each.
65 *
66 * @throws NS_ERROR_ABORT if any validator throws NS_ERROR_ABORT. All other
67 * errors thrown by validators will be silently ignored.
68 */
69 void validate(in nsICommandLine aCommandLine);
70 };