file.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2018 The Apollo Authors. All Rights Reserved.
 *
 * Licensed 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 CYBER_COMMON_FILE_H_
#define CYBER_COMMON_FILE_H_

#include <dirent.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>

#include <cstdio>
#include <fstream>
#include <string>
#include <vector>

#include "google/protobuf/io/zero_copy_stream_impl.h"
#include "google/protobuf/text_format.h"

#include "cyber/common/log.h"

namespace apollo {
namespace cyber {
namespace common {

// file type: file or directory
enum FileType { TYPE_FILE, TYPE_DIR };

bool SetProtoToASCIIFile(const google::protobuf::Message &message,
                         int file_descriptor);
bool SetProtoToASCIIFile(const google::protobuf::Message &message,
                         const std::string &file_name);

bool GetProtoFromASCIIFile(const std::string &file_name,
                           google::protobuf::Message *message);

bool SetProtoToBinaryFile(const google::protobuf::Message &message,
                          const std::string &file_name);

bool GetProtoFromBinaryFile(const std::string &file_name,
                            google::protobuf::Message *message);

bool GetProtoFromFile(const std::string &file_name,
                      google::protobuf::Message *message);

bool GetContent(const std::string &file_name, std::string *content);

std::string GetAbsolutePath(const std::string &prefix,
                            const std::string &relative_path);

bool PathExists(const std::string &path);

bool DirectoryExists(const std::string &directory_path);

std::vector<std::string> Glob(const std::string &pattern);

bool CopyFile(const std::string &from, const std::string &to);

bool CopyDir(const std::string &from, const std::string &to);

bool Copy(const std::string &from, const std::string &to);

bool EnsureDirectory(const std::string &directory_path);

bool RemoveAllFiles(const std::string &directory_path);

std::vector<std::string> ListSubPaths(const std::string &directory_path,
                                      const unsigned char d_type = DT_DIR);

std::string GetFileName(const std::string &path,
                        const bool remove_extension = false);

std::string GetCurrentPath();

// delete file including file or directory
bool DeleteFile(const std::string &filename);

bool GetType(const std::string &filename, FileType *type);

bool CreateDir(const std::string &dir);
}  // namespace common
}  // namespace cyber
}  // namespace apollo

#endif  // CYBER_COMMON_FILE_H_