libmspack 0.0.1

data/ext/libmspack/README

@@ -0,0 +1,130 @@
+libmspack 0.4alpha
+
+The purpose of libmspack is to provide compressors and decompressors,
+archivers and dearchivers for Microsoft compression formats: CAB, CHM, WIM,
+LIT, HLP, KWAJ and SZDD. It is also designed to be easily embeddable,
+stable, robust and resource-efficient.
+
+The library is not intended as a generalised "any archiver" interface.
+Users of the library must explicitly choose the format they intend to work
+with.
+
+All special features of the above formats will be covered as fully as
+possible -- for example, CAB's multi-part cabinet sets, or CHM's fast
+lookup indices. All compression methods used by the formats will be
+implemented as completely as possible.
+
+However, other than what is required for access to these formats and their
+features, no other functionality is intended. There is no file metadata
+translation functionality. All file I/O is abstracted, although a default
+implementation using the standard C library is provided.
+
+
+DOCUMENTATION
+
+The API documentation is stored in the doc/ directory. It is generated
+automatically from mspack.h with doxygen. It is also available online at
+http://www.cabextract.org.uk/libmspack/doc/
+
+
+BUILDING / INSTALLING
+
+./configure
+make
+make install
+
+This will install the main libmspack library and mspack.h header file.
+Some other libraries and executables are built, but not installed.
+
+If building from the Subversion repository, running rebuild.sh will create
+all the automatically generated files like the configure script, and will
+then ./configure, make and make distcheck. Running cleanup.sh will perform
+a thorough clean, deleting all automatically generated files.
+
+In addition to gcc, you also need the following for building from Subversion:
+
+- at least autoconf 2.57
+- at least automake 1.7
+- libtool
+
+This is an alpha release. Unless you are in a position to package the
+libmspack library for the environment you intend to run your application,
+it is recommended that you do not rely on users of your software having
+the binary library installed and instead you should include the libmspack
+source files directly in your application's build environment.
+
+
+LEGAL ISSUES
+
+The the best of my knowledge, libmspack does not infringe on any
+compression or decompression patents. However, this is not legal
+advice, and it is recommended that you perform your own patent search.
+
+libmspack is licensed under the LGPL - see COPYING.LIB in this directory.
+
+The LGPL requires you to build libmspack as a stand alone library then link
+your code to it using a linker. I personally grant you some extra rights:
+you can incorporate libmspack's source code wholly or partially in your own
+code, without having to build and link libmspack as an independent library,
+provided you meet ALL of the following conditions:
+
+1. ANY modifications to the existing libmspack source code are published and
+   distributed under the LGPL license.
+2. You MUST NOT use libmspack function calls, structures or definitions unless
+   they are defined in the public library interface "mspack.h".
+3. When distributing your code, you MUST make clear your code uses libmspack,
+   and either include the full libmspack distribution with your code, or
+   provide access to it as per clause 4 of the LGPL.
+
+EXAMPLE CODE
+
+There are a number of useful programs in the test/ directory which
+exercise and demonstrate libmspack's features.
+
+cabd_c10       - Tests the CAB decompressor on the C10 collection.
+cabd_compare   - Compares the CAB decompressor with Microsoft's EXTRACT.EXE
+cabd_md5       - Prints the MD5 checksums of all files within a CAB file/set.
+cabd_memory    - An mspack_system implementation that reads/writes to memory.
+cabd_test      - Regression tests for libmspack's CAB decompression.
+cabrip         - Extracts any CAB files embedded in another file.
+chmd_compare   - Compares the CHM decompressor to Microsoft's HH.EXE
+chmd_find      - Fast-finds a file within a CHM file.
+chmd_md5       - Prints the MD5 checksums of all files within a CHM file.
+chmd_order     - Tests extracting files in a CHM file in four different ways.
+chminfo        - Prints verbose information about CHM file structures.
+chmx           - Extracts all files in a CHM file to disk.
+expand         - Extracts an SZDD or KWAJ file.
+msdecompile_md5- Runs Microsoft's HH.EXE -DECOMPILE via WINE.
+msexpand_md5   - Runs Microsoft's EXTRACT.EXE via WINE.
+multifh        - An mspack_system implementation that can simultaneously work
+                 on in-memory images, raw file descriptors, open file handles
+                 and regular disk files.
+
+Here is a simple example of usage, which will create a CAB decompressor,
+then use that to open an existing Microsoft CAB file called "example.cab",
+and list the names of all the files contained in that cab.
+
+#include <stdio.h>
+#include <unistd.h>
+#include <mspack.h>
+
+int main() {
+  struct mscab_decompressor *cabd;
+  struct mscabd_cabinet *cab;
+  struct mscabd_file *file;
+  int test;
+
+  MSPACK_SYS_SELFTEST(test);
+  if (test != MSPACK_ERR_OK) exit(0);
+
+  if ((cabd = mspack_create_cab_decompressor(NULL))) {
+    if ((cab = cabd->open(cabd, "example.cab"))) {
+      for (file = cab->files; file; file = file->next) {
+        printf("%s\n", file->filename);
+      }
+      cabd->close(cabd, cab);
+    }
+    mspack_destroy_cab_decompressor(cabd);
+  }
+  return 0;
+}

data/ext/libmspack/TODO

@@ -0,0 +1,8 @@
+* CAB compression
+* cabd_find(): if many bytes are missing from the end of a cabinet, it should still find it
+* CHM compression
+* HLP: everything
+* LIT: everything
+* SZDD/KWAJ: compression
+* WIM: everything
+* chm: make chunk cache size user-controllable

data/ext/libmspack/cleanup.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+topdir=`pwd`
+for x in . doc test
+do
+  cd $x
+  chmod -R a+rwx `svn pg svn:ignore .` 2>/dev/null
+  rm -vrf `svn pg svn:ignore .`
+  cd $topdir
+done

data/ext/libmspack/configure.ac

@@ -0,0 +1,50 @@
+# -*- Autoconf -*-
+# Process this file with autoconf to produce a configure script.
+AC_PREREQ(2.59)
+AC_INIT([libmspack],[0.4alpha],[kyzer@4u.net])
+AC_CONFIG_MACRO_DIR([m4])
+AM_INIT_AUTOMAKE
+AC_CONFIG_SRCDIR([mspack/mspack.h])
+AC_CONFIG_HEADER([config.h])
+
+dnl Enable silent rules by default (if yet support in automake)
+dnl use 'make V=1' to look at verbose commandline
+m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])])
+
+# --enable-debug option
+AC_ARG_ENABLE(debug,
+  AS_HELP_STRING(--enable-debug,enable debugging),
+  enable_debug=$enableval,
+  enable_debug=no)
+if test x$enable_debug = xyes; then
+  AC_DEFINE(DEBUG, 1, [Turn debugging mode on?])
+fi
+AM_CONDITIONAL(DEBUG, test x$enable_debug = 'xyes')
+
+# Checks for programs.
+AC_PROG_CC
+AM_CONDITIONAL(GCC, test x$GCC = 'xyes')
+AC_PROG_INSTALL
+LT_INIT
+AC_EXEEXT
+
+# Checks for header files.
+AC_HEADER_STDC
+AC_CHECK_HEADERS([ctype.h limits.h stdlib.h wctype.h])
+
+# Checks for typedefs, structures, and compiler characteristics.
+AC_C_CONST
+AC_C_INLINE
+AC_TYPE_MODE_T
+AC_TYPE_OFF_T
+AC_TYPE_SIZE_T
+AC_CHECK_SIZEOF([off_t])
+AC_CHECK_FUNCS([tolower towlower])
+
+# largefile support
+AC_SYS_LARGEFILE
+AC_FUNC_FSEEKO
+
+# Checks for library functions.
+AC_CONFIG_FILES([Makefile doc/Makefile doc/Doxyfile libmspack.pc])
+AC_OUTPUT

data/ext/libmspack/debian/changelog

@@ -0,0 +1,6 @@
+libmspack (0.9-1) stable; urgency=low
+
+  * Initial Release.
+
+ -- Markus Sinner <sinner@herdsoft.com>  Tue, 26 Aug 2003 18:04:14 +0200
+

data/ext/libmspack/debian/control

@@ -0,0 +1,14 @@
+Source: libmspack
+Section: libs
+Priority: optional
+Maintainer: Markus Sinner <sinner@herdsoft.com>
+Build-Depends: debhelper (>> 3.0.0)
+Standards-Version: 3.5.2
+
+Package: libmspack
+Architecture: any
+Depends: ${shlibs:Depends}
+Description: Library that implements different Microsoft-Compressions
+ The purpose of libmspack is to provide both compression and decompression
+ of some loosely related file formats used by Microsoft. Currently the most
+ common formats are implemented.

data/ext/libmspack/debian/rules

@@ -0,0 +1,101 @@
+#!/usr/bin/make -f
+# Sample debian/rules that uses debhelper.
+# GNU copyright 1997 to 1999 by Joey Hess.
+
+# Uncomment this to turn on verbose mode.
+#export DH_VERBOSE=1
+
+# This is the debhelper compatibility version to use.
+export DH_COMPAT=3
+
+# These are used for cross-compiling and for saving the configure script
+# from having to guess our platform (since we know it already)
+DEB_HOST_GNU_TYPE   ?= $(shell dpkg-architecture -qDEB_HOST_GNU_TYPE)
+DEB_BUILD_GNU_TYPE  ?= $(shell dpkg-architecture -qDEB_BUILD_GNU_TYPE)
+
+
+ifneq (,$(findstring debug,$(DEB_BUILD_OPTIONS)))
+	CFLAGS += -g
+endif
+ifeq (,$(findstring nostrip,$(DEB_BUILD_OPTIONS)))
+	INSTALL_PROGRAM += -s
+endif
+
+config.status: configure
+	dh_testdir
+	# Add here commands to configure the package.
+	./configure --host=$(DEB_HOST_GNU_TYPE) --build=$(DEB_BUILD_GNU_TYPE) --prefix=/usr --mandir=\$${prefix}/share/man --infodir=\$${prefix}/share/info
+
+
+build: build-stamp
+
+build-stamp:  config.status
+	dh_testdir
+
+	# Add here commands to compile the package.
+	$(MAKE)
+	#/usr/bin/docbook-to-man debian/libmspack.sgml > libmspack.1
+
+	touch build-stamp
+
+clean:
+	dh_testdir
+	dh_testroot
+	rm -f build-stamp 
+
+	# Add here commands to clean up after the build process.
+	-$(MAKE) distclean
+	-test -r /usr/share/misc/config.sub && \
+	  cp -f /usr/share/misc/config.sub config.sub
+	-test -r /usr/share/misc/config.guess && \
+	  cp -f /usr/share/misc/config.guess config.guess
+
+
+	dh_clean
+
+install: build
+	dh_testdir
+	dh_testroot
+	dh_clean -k
+	dh_installdirs
+
+	# Add here commands to install the package into debian/libmspack.
+	$(MAKE) install prefix=$(CURDIR)/debian/libmspack/usr
+
+
+# Build architecture-independent files here.
+binary-indep: build install
+# We have nothing to do by default.
+
+# Build architecture-dependent files here.
+binary-arch: build install
+	dh_testdir
+	dh_testroot
+#	dh_installdebconf	
+	dh_installdocs
+	dh_installexamples
+	dh_installmenu
+#	dh_installlogrotate
+#	dh_installemacsen
+#	dh_installpam
+#	dh_installmime
+#	dh_installinit
+	dh_installcron
+	dh_installman
+	dh_installinfo
+#	dh_undocumented
+	dh_installchangelogs ChangeLog
+	dh_link
+	dh_strip
+	dh_compress
+	dh_fixperms
+#	dh_makeshlibs
+	dh_installdeb
+#	dh_perl
+	dh_shlibdeps
+	dh_gencontrol
+	dh_md5sums
+	dh_builddeb
+
+binary: binary-indep binary-arch
+.PHONY: build clean binary-indep binary-arch binary install 

data/ext/libmspack/doc/Doxyfile.in

@@ -0,0 +1,22 @@
+PROJECT_NAME           = libmspack
+OUTPUT_DIRECTORY       = .
+EXTRACT_ALL            = YES
+EXTRACT_LOCAL_CLASSES  = YES
+HIDE_UNDOC_MEMBERS     = YES
+SHOW_INCLUDE_FILES     = YES
+JAVADOC_AUTOBRIEF      = YES
+OPTIMIZE_OUTPUT_FOR_C  = YES
+SHOW_USED_FILES        = YES
+INPUT                  = @top_srcdir@/mspack/mspack.h
+FULL_PATH_NAMES        = NO
+GENERATE_HTML          = YES
+HTML_OUTPUT            = .
+HTML_FILE_EXTENSION    = .html
+HTML_TIMESTAMP         = NO
+GENERATE_HTMLHELP      = NO
+GENERATE_LATEX         = NO
+GENERATE_RTF           = NO
+GENERATE_MAN           = NO
+GENERATE_XML           = NO
+GENERATE_AUTOGEN_DEF   = NO
+CLASS_DIAGRAMS         = NO

data/ext/libmspack/doc/Makefile.in

@@ -0,0 +1,14 @@
+DOCS =	annotated.html classes.html files.html functions*.html globals*.html \
+	jquery.js index.html mspack*.html struct*.html doxygen.* tab* search \
+	*.png
+
+all: index.html
+
+clean:
+	-rm -rf $(DOCS) installdox
+
+index.html: @top_srcdir@/mspack/mspack.h Doxyfile
+	doxygen
+
+mspack_docs.zip: index.html
+	zip -9r $@ $(DOCS)