sbFileUtils.h

Go to the documentation of this file.

/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2010 POTI, Inc.
 * http://www.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 SBFILEUTILS_H_
#define SBFILEUTILS_H_

#include <nsCOMPtr.h>
#include <nsCRT.h>
#include <nsIFile.h>
#include <nsIInputStream.h>
#include <nsIOutputStream.h>
#include <nsStringGlue.h>
#include <sbMemoryUtils.h>

class nsIInputStream;
class nsIOutputStream;
class nsIURI;

nsresult sbOpenInputStream(nsAString const & aPath, nsIInputStream ** aStream);

nsresult sbOpenInputStream(nsIURI * aURI, nsIInputStream ** aStream);

nsresult sbOpenInputStream(nsIFile * aFile, nsIInputStream ** aStream);

nsresult sbOpenOutputStream(nsIFile * aFile, nsIOutputStream ** aStream);

nsresult sbOpenOutputStream(nsAString const & aPath,
                            nsIOutputStream ** aStream);
nsresult sbReadFile(nsIFile * aFile, nsACString &aBuffer);

nsresult
sbConsumeStream(nsIInputStream *aSource, PRUint32 aMaxCount,
                nsACString &aBuffer);

nsresult sbNewFileURI(nsIFile* aFile,
                      nsIURI** aURI);

void RemoveBadFileNameCharacters(nsAString& aFileName,
                                 PRBool     aAllPlatforms);


//
// Auto-disposal class wrappers.
//
//   sbAutoInputStream          Wrapper to auto-close an input stream.
//   sbAutoOutputStream         Wrapper to auto-close an output stream.
//   sbAutoRemoveFile           Warpper to auto-remove an nsIFile.
//

SB_AUTO_NULL_CLASS(sbAutoInputStream,
                   nsCOMPtr<nsIInputStream>,
                   mValue->Close());
SB_AUTO_NULL_CLASS(sbAutoOutputStream,
                   nsCOMPtr<nsIOutputStream>,
                   mValue->Close());
SB_AUTO_NULL_CLASS(sbAutoRemoveFile,
                   nsCOMPtr<nsIFile>,
                   mValue->Remove(PR_FALSE));


//
// Default file and directory permissions.
//

#define SB_DEFAULT_FILE_PERMISSIONS      0644
#define SB_DEFAULT_DIRECTORY_PERMISSIONS 0755


//
// Bad file name characters.
//
//   SB_FILE_BAD_CHARACTERS     Bad file name characters, including file path
//                              separators.
//   SB_FILE_BAD_CHARACTERS_ALL_PLATFORMS
//                              Bad file name characters for all platforms,
//                              including file path separators for all
//                              platforms.
//

#define SB_FILE_BAD_CHARACTERS FILE_ILLEGAL_CHARACTERS FILE_PATH_SEPARATOR
#define SB_FILE_BAD_CHARACTERS_ALL_PLATFORMS CONTROL_CHARACTERS "/\\:*?\"<>|"

#endif /* SBFILEUTILS_H_ */