uriloader/exthandler/nsLocalHandlerApp.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim:expandtab:shiftwidth=2:tabstop=2:cin:
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Mozilla browser.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * the Mozilla Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 2007
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Dan Mosedale <dmose@mozilla.org>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef __nsLocalHandlerAppImpl_h__
  41 #define __nsLocalHandlerAppImpl_h__
  42
  43 #include "nsString.h"
  44 #include "nsIMIMEInfo.h"
  45 #include "nsIFile.h"
  46 #include "nsTArray.h"
  47
  48 class nsLocalHandlerApp : public nsILocalHandlerApp
  49 {
  50 public:
  51   NS_DECL_ISUPPORTS
  52   NS_DECL_NSIHANDLERAPP
  53   NS_DECL_NSILOCALHANDLERAPP
  54
  55   nsLocalHandlerApp() { }
  56
  57   nsLocalHandlerApp(const PRUnichar *aName, nsIFile *aExecutable)
  58     : mName(aName), mExecutable(aExecutable) { }
  59
  60   nsLocalHandlerApp(const nsAString & aName, nsIFile *aExecutable)
  61     : mName(aName), mExecutable(aExecutable) { }
  62   virtual ~nsLocalHandlerApp() { }
  63
  64 protected:
  65   nsString mName;
  66   nsString mDetailedDescription;
  67   nsTArray<nsString> mParameters;
  68   nsCOMPtr<nsIFile> mExecutable;
  69
  70   /**
  71    * Launches this application with a single argument (typically either
  72    * a file path or a URI spec).  This is meant as a helper method for
  73    * implementations of (e.g.) LaunchWithURI.
  74    *
  75    * @param aApp The application to launch (may not be null)
  76    * @param aArg The argument to pass on the command line
  77    */
  78   NS_HIDDEN_(nsresult) LaunchWithIProcess(const nsCString &aArg);
  79 };
  80
  81 // any platforms that need a platform-specific class instead of just
  82 // using nsLocalHandlerApp need to add an include and a typedef here.
  83 #ifdef XP_MACOSX
  84 # ifndef NSLOCALHANDLERAPPMAC_H_
  85 # include "mac/nsLocalHandlerAppMac.h"
  86 typedef nsLocalHandlerAppMac PlatformLocalHandlerApp_t;
  87 # endif
  88 #else
  89 typedef nsLocalHandlerApp PlatformLocalHandlerApp_t;
  90 #endif
  91
  92 #endif //  __nsLocalHandlerAppImpl_h__