gecko-dev/xpcom/io/nsLocalFileUnix.h

139 lines
3.3 KiB
C
Raw Normal View History

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
2012-05-21 11:12:37 +00:00
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/*
* Implementation of nsIFile for ``Unixy'' systems.
*/
#ifndef _nsLocalFileUNIX_H_
#define _nsLocalFileUNIX_H_
#include <sys/stat.h>
2004-04-16 19:46:05 +00:00
#include <sys/types.h>
#include <unistd.h>
#include "nscore.h"
#include "nsString.h"
#include "nsReadableUtils.h"
#include "nsIHashable.h"
#include "nsIClassInfoImpl.h"
#include "mozilla/Attributes.h"
#ifdef MOZ_WIDGET_COCOA
#include "nsILocalFileMac.h"
#endif
/**
* we need these for statfs()
*/
#ifdef HAVE_SYS_STATVFS_H
#if defined(__osf__) && defined(__DECCXX)
extern "C" int statvfs(const char *, struct statvfs *);
#endif
#include <sys/statvfs.h>
#endif
#ifdef HAVE_SYS_STATFS_H
#include <sys/statfs.h>
#endif
#ifdef HAVE_SYS_VFS_H
#include <sys/vfs.h>
#endif
#ifdef HAVE_SYS_MOUNT_H
#include <sys/param.h>
#include <sys/mount.h>
#endif
#if defined(HAVE_STATVFS64) && (!defined(LINUX) && !defined(__osf__))
#define STATFS statvfs64
#define F_BSIZE f_frsize
#elif defined(HAVE_STATVFS) && (!defined(LINUX) && !defined(__osf__))
#define STATFS statvfs
#define F_BSIZE f_frsize
#elif defined(HAVE_STATFS64)
#define STATFS statfs64
#define F_BSIZE f_bsize
#elif defined(HAVE_STATFS)
#define STATFS statfs
#define F_BSIZE f_bsize
#endif
// stat64 and lstat64 are deprecated on OS X. Normal stat and lstat are
// 64-bit by default on OS X 10.6+.
#if defined(HAVE_STAT64) && defined(HAVE_LSTAT64) && !defined(XP_DARWIN)
#if defined (AIX)
#if defined STAT
#undef STAT
#endif
#endif
#define STAT stat64
#define LSTAT lstat64
#define HAVE_STATS64 1
#else
#define STAT stat
#define LSTAT lstat
#endif
class nsLocalFile final
#ifdef MOZ_WIDGET_COCOA
: public nsILocalFileMac
#else
: public nsILocalFile
#endif
, public nsIHashable
{
public:
NS_DEFINE_STATIC_CID_ACCESSOR(NS_LOCAL_FILE_CID)
nsLocalFile();
static nsresult nsLocalFileConstructor(nsISupports* aOuter,
const nsIID& aIID,
void** aInstancePtr);
NS_DECL_THREADSAFE_ISUPPORTS
NS_DECL_NSIFILE
NS_DECL_NSILOCALFILE
#ifdef MOZ_WIDGET_COCOA
NS_DECL_NSILOCALFILEMAC
#endif
NS_DECL_NSIHASHABLE
public:
static void GlobalInit();
static void GlobalShutdown();
private:
nsLocalFile(const nsLocalFile& aOther);
~nsLocalFile()
{
}
protected:
// This stat cache holds the *last stat* - it does not invalidate.
// Call "FillStatCache" whenever you want to stat our file.
struct STAT mCachedStat;
nsCString mPath;
void LocateNativeLeafName(nsACString::const_iterator&,
nsACString::const_iterator&);
nsresult CopyDirectoryTo(nsIFile* aNewParent);
nsresult CreateAllAncestors(uint32_t aPermissions);
nsresult GetNativeTargetPathName(nsIFile* aNewParent,
const nsACString& aNewName,
nsACString& aResult);
bool FillStatCache();
nsresult CreateAndKeepOpen(uint32_t aType, int aFlags,
uint32_t aPermissions, PRFileDesc** aResult);
};
Fixes to use atomic rename(2) if possible in nsLocalFile::MoveTo (33098, r=?), plus a bunch of other fixes and cleanups: - Fix comment misstatements of fact in nsIFile.idl, improve style slightly. - Fix typo in comment in nsILocalFile.idl. - Avoid gratuitous nsCString and nsXPIDLCString copy-constructions, which entail malloc'ing, in nsLocalFileUnix.cpp's CopyTo and GetParent methods. But do use nsXPIDLCString instead of raw nsMemory::Alloc/Free. - Get rid of unnecessary mLL_II2L and mLL_L2II macros, use "prlong.h" API only. Also use the LL_* macros consistently in case a Unix lacking long long type support wants to use this code. * BTW, the "Date" methods should be renamed to use "Time" instead -- after all PRTime is the type, and traditionally "time" refers to the time-number, a scalar independent of one's position on the surface of the earth, while "date" refers to a struct full of locale-specific information derived from time and some "environment" variables such as DST. Can we rename these nsIFile methods before Mozilla 0.9 / Netscape 6? - Use CHECK_mPath consistently and first, before any assertions relating to arguments (which logically come after the 'this' parameter CHECK_mPath is making assertions about). - Use nsCOMPtr for singly-inheriting implementations of XPCOM interfaces, to avoid scary-when-scaled 0-refcnt instances from being handled (these all got a ref via QI or equivalent soon enough, but you never know). This also removed some naked deletes. - Canonize all paths copied into mPath to lack trailing slashes, so we don't need to strip trailing slashes elsewhere, in higher-frequency methods (you set path less often than you get it or a substring of it). - ssize_t for strlen return values. - Since shaver used a function pointer to consolidate creat/mkdir logic, but didn't fold the necessary close of the new fd returned by non-failing creat into the pointed-at function, I did that. - AppendRelativePath forbids .. as a component (bounded by / or beginning or end of string on either side), not just in the middle of fragment (so that foo..bar is not an illegal relative pathname -- it should not be). BTW, what the heck is the difference between NS_ERROR_FILE_UNRECOGNIZED_PATH and ...INVALID_PATH? - SetLeafName was overallocating the new pathname buffer by failing to subtract the old leafname's length. - CopyTo was failing to return an NSRESULT_FOR_ERRNO(), it just called that macro on a line by itself -- eek! It also contained redundant if (newFD == nsnull) {...} cleanup code, it did a useless PR_GetFileInfo call, and it leaked FDs on read or write error. - Implemented CopyToFollowingLinks as a forwarded call to CopyTo, Unix does not support "copying" a symlink via normal file i/o. Should we instead lstat in CopyTo and if a link is the source of the copy, do readlink and then symlink? - Fixed the readlink method (GetTarget) to null-terminate the link string in the out parameter (readlink does not do that for you). - Lots of little nsnull vs. NULL vs. 0, == and != applied to boolean or null literals, white-space, indentation, bracing, comment, and sloppy code order (e.g., declaring an initialized variable that's not used till after early returns) fixes. Also invert some return logic so that NS_OK is the normal, least indented, final return.
2000-09-19 00:22:41 +00:00
#endif /* _nsLocalFileUNIX_H_ */