Gambas Documentation
Application Repository
Code Snippets
Compilation & Installation from source code
Components
gb
gb.args
gb.cairo
gb.chart
gb.clipper
gb.complex
gb.compress
Compress
Uncompress
gb.crypt
gb.data
gb.db
gb.db.form
gb.db.mysql
gb.db.odbc
gb.db.postgresql
gb.db.sqlite2
gb.db.sqlite3
gb.db2
gb.db2.form
gb.dbus
gb.dbus.trayicon
gb.debug
gb.desktop
gb.desktop.gnome.keyring
gb.desktop.x11
gb.eval
gb.eval.highlight
gb.form
gb.form.dialog
gb.form.editor
gb.form.htmlview
gb.form.mdi
gb.form.print
gb.form.stock
gb.form.terminal
gb.gmp
gb.gsl
gb.gtk
gb.gtk.opengl
gb.gtk3
gb.gtk3.opengl
gb.gtk3.webview
gb.gui
gb.gui.opengl
gb.gui.qt
gb.gui.qt.ext
gb.gui.qt.opengl
gb.gui.qt.webkit
gb.gui.trayicon
gb.gui.webview
gb.hash
gb.highlight
gb.image
gb.image.effect
gb.image.imlib
gb.image.io
gb.inotify
gb.jit
gb.libxml
gb.logging
gb.map
gb.markdown
gb.media
gb.media.form
gb.memcached
gb.mime
gb.mongodb
gb.mysql
gb.ncurses
gb.net
gb.net.curl
gb.net.pop3
gb.net.smtp
gb.openal
gb.opengl
gb.opengl.glsl
gb.opengl.glu
gb.opengl.sge
gb.openssl
gb.option
gb.pcre
gb.pdf
gb.poppler
gb.qt4
gb.qt4.ext
gb.qt4.opengl
gb.qt4.webkit
gb.qt4.webview
gb.qt5
gb.qt5.ext
gb.qt5.opengl
gb.qt5.webkit
gb.qt5.webview
gb.qt6
gb.qt6.ext
gb.qt6.opengl
gb.qt6.webview
gb.report
gb.report2
gb.scanner
gb.sdl
gb.sdl.sound
gb.sdl2
gb.sdl2.audio
gb.settings
gb.signal
gb.term
gb.test
gb.util
gb.util.web
gb.v4l
gb.vb
gb.web
gb.web.feed
gb.web.form
gb.web.gui
gb.xml
gb.xml.html
gb.xml.rpc
gb.xml.xslt
Controls pictures
Deprecated components
Developer Documentation
Development Environment Documentation
Documents
Error Messages
Gambas Playground
How To's
Language Index
Language Overviews
Last Changes
Lexicon
README
Search the wiki
To Do
Topics
Tutorials
Wiki License
Wiki Manual

gb.compress

This component allows you to compress and uncompress Files, and to read and write compressed files using standard stream methods. It allows you to compress and uncompress strings in memory, too.

Currently it can use two algorithms, provided by zlib and libbzip2. The more known programs using these algorithms are the command line tools "gzip" and "bzip2", so you can handle the files generated by these programs.

This component internally uses the "libz" and "libbz2" libraries, so you need to install these libraries onto the computers that are going to use the compression component. If you plan to use just one of these algorithms, you don't need to install both libraries.

More information about internals at:

http://www.gzip.org/zlib/

http://sources.redhat.com/bzip2/

All common GNU/Linux distributions include packages for these libraries, FreeBSD and other Unixes too. Both data compressors are patent-free, and currently can be used even in not open source programs, if you follow all the instructions contained in their licenses. (read them carefully for the version you plan to use)

Since 3.16

Support for zstd compression has been added by Laurent Carlier in Gambas 3.16.

More information about this compression format at https://github.com/facebook/zstd.

Authors Daniel Campos Fernández, Laurent Carlier.

Class Description
Compress This class allows Gambas to use compression algorithms, in order to compress files, strings in memory, and to write a compressed file using standard Stream methods.
Uncompress This class allows Gambas to use compression algorithms, in order to uncompress files, strings in memory, and to read a compressed file using standard Stream methods.

Note:

This class is for dealing with single files only and cannot be used as an archiver/unarchiver of multiple files inside an archive.

For accessing archive contents you must use system command line tools like tar, zip/unzip, etc