file_system.h

Go to the documentation of this file.

// Copyright 2017 Google LLC
//
// 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
//
//     https://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 SHAKA_EMBEDDED_UTIL_FILE_SYSTEM_H_
#define SHAKA_EMBEDDED_UTIL_FILE_SYSTEM_H_

#include <string>
#include <vector>

#include "src/util/macros.h"

namespace shaka {
namespace util {

class FileSystem {
 public:
  FileSystem();
  virtual ~FileSystem();


  static std::string PathJoin(const std::string& a, const std::string& b);

  static std::string DirName(const std::string& path);

  static std::string GetPathForStaticFile(const std::string& static_data_dir,
                                          bool is_bundle_relative,
                                          const std::string& file);

  static std::string GetPathForDynamicFile(const std::string& dynamic_data_dir,
                                           const std::string& file);


  virtual bool FileExists(const std::string& path) const;

  virtual bool DirectoryExists(const std::string& path) const;

  virtual ssize_t FileSize(const std::string& path) const;

  MUST_USE_RESULT virtual bool DeleteFile(const std::string& path) const;

  MUST_USE_RESULT virtual bool CreateDirectory(const std::string& path) const;

  MUST_USE_RESULT virtual bool ListFiles(const std::string& path,
                                         std::vector<std::string>* files) const;


  MUST_USE_RESULT virtual bool ReadFile(const std::string& path,
                                        std::vector<uint8_t>* data) const;

  MUST_USE_RESULT virtual bool WriteFile(
      const std::string& path, const std::vector<uint8_t>& data) const;
};

}  // namespace util
}  // namespace shaka

#endif  // SHAKA_EMBEDDED_UTIL_FILE_SYSTEM_H_