zipios  2.2.0
Zipios -- a small C++ library that provides easy access to .zip files.
zipendofcentraldirectory.hpp
Go to the documentation of this file.
1 #pragma once
2 #ifndef ENDOFCENTRALDIRECTORY_HPP
3 #define ENDOFCENTRALDIRECTORY_HPP
4 
5 /*
6  Zipios -- a small C++ library that provides easy access to .zip files.
7 
8  Copyright (C) 2000-2007 Thomas Sondergaard
9  Copyright (C) 2015-2019 Made to Order Software Corporation
10 
11  This library is free software; you can redistribute it and/or
12  modify it under the terms of the GNU Lesser General Public
13  License as published by the Free Software Foundation; either
14  version 2.1 of the License, or (at your option) any later version.
15 
16  This library is distributed in the hope that it will be useful,
17  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  Lesser General Public License for more details.
20 
21  You should have received a copy of the GNU Lesser General Public
22  License along with this library; if not, write to the Free Software
23  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 */
25 
36 #include "zipios_common.hpp"
37 
38 #include <string>
39 
40 
41 namespace zipios
42 {
43 
44 
46 {
47 public:
48  ZipEndOfCentralDirectory(std::string const& zip_comment = "");
49 
50  size_t getCentralDirectorySize() const;
51  size_t getCount() const;
52  offset_t getOffset() const;
53  void setCentralDirectorySize(size_t size);
54  void setCount(size_t c);
55  void setOffset(offset_t new_offset);
56 
57  bool read(::zipios::buffer_t const& buf, size_t pos);
58  void write(std::ostream& os);
59 
60 private:
61  // some of the fields found in a Zip archive ZipEndOfCentralDirectory
65  std::string m_zip_comment;
66 };
67 
68 
69 } // zipios namespace
70 
71 // Local Variables:
72 // mode: cpp
73 // indent-tabs-mode: nil
74 // c-basic-offset: 4
75 // tab-width: 4
76 // End:
77 
78 // vim: ts=4 sw=4 et
79 #endif
zipios::ZipEndOfCentralDirectory::setOffset
void setOffset(offset_t new_offset)
Offset of the Central Directory.
Definition: zipendofcentraldirectory.cpp:200
zipios::ZipEndOfCentralDirectory::ZipEndOfCentralDirectory
ZipEndOfCentralDirectory(std::string const &zip_comment="")
Initialize an ZipEndOfCentralDirectory object.
Definition: zipendofcentraldirectory.cpp:82
zipios::ZipEndOfCentralDirectory::getCentralDirectorySize
size_t getCentralDirectorySize() const
Retrieve the size of the Central Directory in bytes.
Definition: zipendofcentraldirectory.cpp:102
zipios::ZipEndOfCentralDirectory::m_central_directory_size
size_t m_central_directory_size
Definition: zipendofcentraldirectory.hpp:63
zipios::ZipEndOfCentralDirectory::m_central_directory_offset
offset_t m_central_directory_offset
Definition: zipendofcentraldirectory.hpp:64
zipios_common.hpp
Various functions used throughout the library.
zipios::ZipEndOfCentralDirectory::write
void write(std::ostream &os)
Write the ZipEndOfCentralDirectory structure to a stream.
Definition: zipendofcentraldirectory.cpp:307
zipios::ZipEndOfCentralDirectory::m_central_directory_entries
size_t m_central_directory_entries
Definition: zipendofcentraldirectory.hpp:62
zipios::ZipEndOfCentralDirectory::getCount
size_t getCount() const
Retrieve the number of entries.
Definition: zipendofcentraldirectory.cpp:121
zipios::ZipEndOfCentralDirectory::setCentralDirectorySize
void setCentralDirectorySize(size_t size)
Define the size of the central directory.
Definition: zipendofcentraldirectory.cpp:160
zipios::ZipEndOfCentralDirectory::m_zip_comment
std::string m_zip_comment
Definition: zipendofcentraldirectory.hpp:65
zipios::buffer_t
std::vector< unsigned char > buffer_t
A buffer of characters.
Definition: zipios_common.hpp:98
zipios::ZipEndOfCentralDirectory::read
bool read(::zipios::buffer_t const &buf, size_t pos)
Attempt to read an ZipEndOfCentralDirectory structure.
Definition: zipendofcentraldirectory.cpp:228
zipios::ZipEndOfCentralDirectory::setCount
void setCount(size_t c)
Set the number of entries.
Definition: zipendofcentraldirectory.cpp:179
zipios::offset_t
std::streamoff offset_t
Definition: zipios-config.hpp.in:59
zipios::ZipEndOfCentralDirectory
Marker at the end of a Zip archive file.
Definition: zipendofcentraldirectory.hpp:45
zipios::ZipEndOfCentralDirectory::getOffset
offset_t getOffset() const
Retrieve the offset of the Central Directory.
Definition: zipendofcentraldirectory.cpp:142
zipios
The zipios namespace includes the Zipios library definitions.
Definition: backbuffer.cpp:35