#ifndef FS_OFD_LINEARPACKAGE_H_
#define FS_OFD_LINEARPACKAGE_H_

#include "common/fs_common.h"

/**
 * @brief Foxit 命名空间。
 *
 * @details Foxit PDF SDK 的所有定义和类都在此命名空间内定义。
 */
namespace foxit {
/**
* @brief ofd 命名空间。
*/
namespace ofd {
/** 此类表示和OFD线性包相关的操作。*/
class OFDLinearPackage FS_FINAL : public Base {
 public:
  /**
   * @brief 带参数的构造函数。
   *
   * @param[in] path OFD线性包文件路径。
   */
  explicit OFDLinearPackage(const char* path);

  /**
   * @brief 带参数的构造函数。
   *
   * @param[in] path OFD线性包文件路径。
   */
  explicit OFDLinearPackage(const wchar_t* path);

  /** @brief 析构函数。 */
  ~OFDLinearPackage();

  /**
   * @brief 构造函数，通过另一个OFD线性包对象。
   *
   * @param[in] other 另一个OFD线性包对象。
   */

  /**  * @brief 赋值操作符。
   *
   * @param[in] other 另一个OFD线性包对象，其值将被赋给当前对象。
   *
   * @return 当前对象自身的引用。
   */
  OFDLinearPackage(const OFDLinearPackage& other);

  /**  * @brief 赋值操作符。
   *
   * @param[in] other 另一个OFD线性包对象，其值将被赋给当前对象。
   *
   * @return 当前对象自身的引用。
   */
  OFDLinearPackage& operator = (const OFDLinearPackage& other);

  /**
   * @brief 相等操作符。
   *
   * @param[in] other 另一个OFD线性包对象。此函数将检查当前对象是否等于这个对象。
   *
   * @return <b>true</b> 表示相等，<b>false</b> 表示不相等。
   */
  bool operator == (const OFDLinearPackage& other) const;

  /**
   * @brief 不相等操作符。
   *
   * @param[in] other 另一个OFD线性包对象。此函数将检查当前对象是否不等于这个对象。
   *
   * @return <b>true</b> 表示不相等，<b>false</b> 表示相等。
   */
  bool operator != (const OFDLinearPackage& other) const;

  /**
   * @brief 检查当前对象是否为空。
   *
   * @details 当前对象为空时，表示当前对象是无用的。
   *
   * @return <b>true</b> 表示当前对象为空，<b>false</b> 表示不为空。
   */
  bool IsEmpty() const;

  /**
   * @brief 获取指定路径的文件内容。
   *
   * @param[in] path 指定的文件路径。
   *
   * @return 指定路径的文件内容。
   */
  String GetFileContent(const String& path);

  /**
   * @brief 获取指定路径的文件内容。
   *
   * @param[in] path 指定的文件路径。
   *
   * @return 指定路径的文件内容。
   */
  String GetFileContent(const WString& path);

  explicit OFDLinearPackage(FS_HANDLE handle);
};

}  // namespace ofd
}  // namespace foxit

#endif  // FS_OFD_LINEARPACKAGE_H_
