/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * License); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

#ifndef FILE_WRITE_FILE_H
#define FILE_WRITE_FILE_H

#include <string>

#include "utils/storage_utils.h"
#include "utils/util_define.h"

namespace storage {

class WriteFile {
   public:
    WriteFile() : path_(), fd_(-1) {}
    // Release the OS file handle on destruction.  Without this, a writer left
    // in an unrecoverable state (whose close() refuses to finalize) would leak
    // the fd — harmless on POSIX (unlink works on open files) but on Windows it
    // keeps the file locked so a subsequent remove() fails.  close() is
    // idempotent, so this is a no-op when the file was already closed normally.
    ~WriteFile() { close(); }
    int create(const std::string& file_name, int flags, mode_t mode);
    bool file_opened() const { return fd_ > 0; }
    int write(const char* buf, uint32_t len);
    FORCE_INLINE int get_fd() const { return fd_; }
    int sync();
    int close();
    /** Truncate file to the given size (bytes). File must be open. */
    int truncate(int64_t size);
    /** Seek to end of file. Used after open to position for append. */
    int seek_to_end();
    FORCE_INLINE std::string get_file_path() { return path_; }
    /** Current file offset. After seek_to_end(), equals file size (for
     * recovery). */
    int64_t get_position();

   private:
    int do_create(int flags, mode_t mode);
    std::string path_;
    int fd_;
};

}  // end namespace storage
#endif  // FILE_WRITE_FILE_H