ZipUtils.h

Go to the documentation of this file.

// Copyright (C) 2002-2020, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2020 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _ZIP_UTILS_H
#define _ZIP_UTILS_H
 
#include "OdPlatformSettings.h"
#include "StringArray.h"
 
#include <cstdint>
 
namespace ZipUtils
{
 
#define FILE_BUFFER_SIZE 1024
 
  OdAnsiString OdStringToUtf8(const OdString &sUnicode);
 
  OdString formatPath(const OdString &path);
 
  OdString formatDir(const OdString &dir);
 
  bool containsDir(const OdString &dir);
 
  bool isDir(const OdString &dir);
 
  OdString getFileExtension(const OdString &path);
 
  OdString getFile(const OdString &path);
 
  OdString getDir(const OdString &path);
 
  int createFile(const OdString &path, const char *data, unsigned int size);
 
  int copyFile(const OdString &existingFileName, const OdString &newFileName);
 
  int removeFile(const OdString &path);
 
  bool dirExists(const OdString &dir);
 
  int createDir(const OdString &dir);
 
  int removeEmptyDir(const OdString &dir);
 
  int removeDir(const OdString &dir);
 
  OdStringArray getFileList(const OdString &dir);
 
  OdStringArray getDirList(const OdString &dir);
 
  uintmax_t getProcessId();
 
  OdString getUniqueDirName();
 
  OdResult unzipFile(const OdString &filePath, const OdString &targetDir, bool overwriteTargetDir = true);
 
  OdResult zipToFile(const OdString &targetFile, const OdString &filesDir, bool overwriteTargetFile = true);
 
} //namespace ZipUtils
 
#endif // _ZIP_UTILS_H