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