platform_file.h - mozsearch

Enable keyboard shortcuts

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* vim: set ts=8 sts=2 et sw=2 tw=80: */

// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.

// Use of this source code is governed by a BSD-style license that can be

// found in the LICENSE file.

#ifndef BASE_PLATFORM_FILE_H_

#define BASE_PLATFORM_FILE_H_

#if defined(XP_WIN)

#  include <windows.h>

#endif

#include <string>

namespace base {

#if defined(XP_WIN)

typedef HANDLE PlatformFile;

const PlatformFile kInvalidPlatformFileValue = INVALID_HANDLE_VALUE;

#else

typedef int PlatformFile;

const PlatformFile kInvalidPlatformFileValue = -1;

#endif

enum PlatformFileFlags {

  PLATFORM_FILE_OPEN = 1,

  PLATFORM_FILE_CREATE = 2,

  PLATFORM_FILE_OPEN_ALWAYS = 4,    // May create a new file.

  PLATFORM_FILE_CREATE_ALWAYS = 8,  // May overwrite an old file.

  PLATFORM_FILE_READ = 16,

  PLATFORM_FILE_WRITE = 32,

  PLATFORM_FILE_EXCLUSIVE_READ = 64,  // EXCLUSIVE is opposite of Windows SHARE

  PLATFORM_FILE_EXCLUSIVE_WRITE = 128,

  PLATFORM_FILE_ASYNC = 256

};

// Creates or open the given file. If PLATFORM_FILE_OPEN_ALWAYS is used, and

// |created| is provided, |created| will be set to true if the file was created

// or to false in case the file was just opened.

PlatformFile CreatePlatformFile(const std::wstring& name, int flags,

                                bool* created);

}  // namespace base

#endif  // BASE_PLATFORM_FILE_H_