sbProcess.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2009 POTI, Inc.
// http://songbirdnest.com
//
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
//
// Software distributed under the License is distributed
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
// express or implied. See the GPL for the specific language
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// END SONGBIRD GPL
//
*/

#ifndef __SB_PROCESS_H__
#define __SB_PROCESS_H__

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
//
// Songbird process services defs.
//
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
//
// Songbird process imported services.
//
//------------------------------------------------------------------------------

// Songbird imports.
#include <sbMemoryUtils.h>

// Mozilla imports.
#include <nsCOMPtr.h>
#include <nsIThread.h>
#include <nsStringGlue.h>
#include <nsTArray.h>
#include <prmon.h>
#include <prproces.h>


//------------------------------------------------------------------------------
//
// Songbird process services classes.
//
//------------------------------------------------------------------------------

class sbProcess : public nsISupports
{
  //----------------------------------------------------------------------------
  //
  // Public interface.
  //
  //----------------------------------------------------------------------------

public :

  //
  // Interface implementations.
  //

  NS_DECL_ISUPPORTS


  //
  // Public services.
  //

  static nsresult New(sbProcess** aProcess);

  nsresult Run();

  nsresult Kill();

  virtual ~sbProcess();

  nsresult GetArgList(nsTArray<nsString>& aArgList);
  nsresult SetArgList(const nsTArray<nsString>& aArgList);

  nsresult GetStdinString(nsAString& aStdinString);
  nsresult SetStdinString(const nsAString& aStdinString);

  nsresult GetStdoutString(nsAString& aStdoutString);

  nsresult GetPipeStdoutString(PRBool* aPipeStdoutString);
  nsresult SetPipeStdoutString(PRBool aPipeStdoutString);

  nsresult GetDoneMonitor(PRMonitor** aDoneMonitor);
  nsresult SetDoneMonitor(PRMonitor* aDoneMonitor);

  nsresult GetIsDone(PRBool* aIsDone);

  nsresult GetDoneResult(nsresult* aDoneResult);

  nsresult GetExitCode(PRInt32* aExitCode);


  //----------------------------------------------------------------------------
  //
  // Private interface.
  //
  //----------------------------------------------------------------------------

private:

  //
  // Private fields.
  //
  //   mProcessLock             Lock used to serialize access to fields.
  //   mArgList                 List of process command line arguments.
  //   mPipeStdinString         If true, pipe string to process stdin.
  //   mStdinString             String to pipe to process stdin.
  //   mPipeStdoutString        If true, pipe process stdout to string.
  //   mStdoutString            String containing content of process stdout.
  //   mDoneResult              Final result of process when it's done.
  //   mExitCode                Process exit code.
  //   mBaseProcess             Base process object.
  //   mStdinReadFD             File descriptor for reading the process stdin.
  //   mStdoutReadFD            File descriptor for reading the process stdout.
  //   mStdoutWriteFD           File descriptor for writing the process stdout.
  //   mWaitForDoneThread       Thread used to wait for the process to be done.
  //   mHasBeenKilled           If true, process has been killed.
  //
  //   mDoneMonitor             Monitor to notify when process is done.
  //   mIsDone                  True if process is done.
  //

  PRLock*                       mProcessLock;
  nsTArray<nsString>            mArgList;
  PRBool                        mPipeStdinString;
  nsString                      mStdinString;
  PRBool                        mPipeStdoutString;
  nsString                      mStdoutString;
  nsresult                      mDoneResult;
  PRInt32                       mExitCode;
  PRProcess*                    mBaseProcess;
  PRFileDesc*                   mStdinReadFD;
  PRFileDesc*                   mStdoutReadFD;
  PRFileDesc*                   mStdoutWriteFD;
  nsCOMPtr<nsIThread>           mWaitForDoneThread;
  PRBool                        mHasBeenKilled;

  PRMonitor*                    mDoneMonitor;
  PRBool                        mIsDone;


  //
  // Private process services.
  //

  sbProcess();

  void WaitForDone();

  nsresult HandleDone();
};


//
// Auto-disposal class wrappers.
//
//   sbAutoPRProcessAttr        Wrapper to auto-destroy process attributes.
//   sbAutoPRFileDesc           Wrapper to auto-close an NSPR file descriptor.
//   sbAutoKillProcess          Wrapper to auto-kill a Songbird process.
//

SB_AUTO_NULL_CLASS(sbAutoPRProcessAttr,
                   PRProcessAttr*,
                   PR_DestroyProcessAttr(mValue));
SB_AUTO_NULL_CLASS(sbAutoPRFileDesc,
                   PRFileDesc*,
                   PR_Close(mValue));
SB_AUTO_NULL_CLASS(sbAutoKillProcess,
                   sbProcess*,
                   mValue->Kill());


//------------------------------------------------------------------------------
//
// Songbird process services.
//
//------------------------------------------------------------------------------

nsresult SB_RunProcess(sbProcess**         aProcess,
                       nsTArray<nsString>& aArgList,
                       const nsAString*    aStdin = nsnull,
                       PRBool              aPipeStdoutString = PR_FALSE,
                       PRMonitor*          aDoneMonitor = nsnull);


#endif // __SB_PROCESS_H__