gzip.hpp

Go to the documentation of this file.

#ifndef GENESIS_UTILS_IO_GZIP_H_
#define GENESIS_UTILS_IO_GZIP_H_
 
/*
    Genesis - A toolkit for working with phylogenetic data.
    Copyright (C) 2014-2023 Lucas Czech
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
    Contact:
    Lucas Czech <lczech@carnegiescience.edu>
    Department of Plant Biology, Carnegie Institution For Science
    260 Panama Street, Stanford, CA 94305, USA
*/
 
#include "genesis/utils/core/exception.hpp"
 
#include <stdexcept>
#include <string>
 
namespace genesis {
namespace utils {
 
// ================================================================================================
//     General gzip/zlib Functions
// ================================================================================================
 
bool is_gzip_compressed_file( std::string const& file_name );
 
// ================================================================================================
//     Gzip Exception Class
// ================================================================================================
 
class GzipError
    : public IOError
{
public:
 
    GzipError( std::string const& z_stream_message, int error_code );
 
    GzipError( std::string const msg )
        : IOError(msg)
    {}
 
};
 
} // namespace utils
} // namespace genesis
 
#endif // include guard