193 lines
4.7 KiB
C++
Raw Normal View History

//
// GLD.CPP
//
// Source file for ArchiveLib 2.0
//
// Copyright (c) Greenleaf Software, Inc. 1994-1996
// All Rights Reserved
//
// CONTENTS
//
// GlDecompressTools()
// newALListGlDecompressTools()
//
// DESCRIPTION
//
// The functions needed to create Entry Lists that use
// the greenleaf decompressor.
//
// REVISION HISTORY
//
// February 14, 1996 2.0A : New release
//
#include "arclib.h"
#if !defined( AL_IBM )
#pragma hdrstop
#endif
#include "glengn.h"
#include "copyengn.h"
#include "filestor.h"
#include "memstore.h"
//
// NAME
//
// GlDecompressTools()
//
// PLATFORMS/ENVIRONMENTS
//
// Console Windows PM
// C++
//
// SHORT DESCRIPTION
//
// Create a toolkit that supports Greenleaf decompressors.
//
// C++ SYNOPSIS
//
// #include "arclib.h"
//
// ALToolKit GlDecompressTools();
//
// C SYNOPSIS
//
// None, C programmers should use the shortcut helper function
// newALListGlDecompressTools() to create an entry list with this toolkit.
//
// VB SYNOPSIS
//
// None, VB programmers should use the shortcut helper function
// newALListGlDecompressTools() to create an entry list with this toolkit.
//
// DELPHI SYNOPSIS
//
// None, Delphi programmers should use the shortcut helper function
// newALListGlDecompressTools() to create an entry list with this toolkit.
//
// ARGUMENTS
//
// None, we have to get the compression level from the archive, so there
// isn't any point in defining it here.
//
// DESCRIPTION
//
// An ALToolKit is a factory that things in the ALArchive class can use
// to clone new objects. GlDecompressTools() creates a toolkit that can
// build Greenleaf decompressors. If your app is only going to be
// decompressing some type of objects, you can use the toolkit returned
// by this function in your ALEntryList, and avoid linking in support for
// compression objects.
//
// This toolkit will clone ALFile() and ALMemory() objects. If you don't
// want to support ALMemory objects, try GlDecompressFileTools().
//
// RETURNS
//
// A new toolkit.
//
// EXAMPLE
//
// SEE ALSO
//
// REVISION HISTORY
//
// February 14, 1996 2.0A : New Release
//
AL_LINKAGE ALToolKit AL_FUNCTION
GlDecompressTools() /* Tag public function */
{
return ALGlDecompressor() +
ALCopyDecompressor() +
ALFile() +
#if defined( AL_WINDOWS ) && !defined( AL_FLAT_MODEL )
ALWinMemory();
#else
ALMemory();
#endif
}
//
// NAME
//
// newALListGlDecompressTools()
//
// PLATFORMS/ENVIRONMENTS
//
// Console Windows PM
// C VB Delphi
//
// SHORT DESCRIPTION
//
// Create an entry list that uses the Greenleaf decompressors toolkit.
//
// C++ SYNOPSIS
//
// None. C++ programmers can create and manipulate toolkits easily.
// This isn't the case for C/VB/Delphi programmers, so we give them
// a special function.
//
// C SYNOPSIS
//
// #include "arclib.h"
//
// hALEntryList newALListGlDecompressTools( hALMonitor monitor );
//
// VB SYNOPSIS
//
// Declare Function newALListGlDecompressTools Lib "AL20LW"
// (ByVal monitor&, ByVal compression_level%) As Long
//
// DELPHI SYNOPSIS
//
// function newALListGlDecompressTools( monitor : hALMonitor ) : hALEntryList;
//
// ARGUMENTS
//
// monitor : A pointer to a monitor that will be used whenever we are
// processing objects in the list.
//
// Note that we have to get the compression level from the archive,
// so there isn't any point in defining it as an argument here.
//
// DESCRIPTION
//
// C++ programmers pass a toolkit argument to the ALEntryList constructor,
// which determines what sort of decompressors and storage objects they are
// expecting to use. C/VB/Delphi programmers can do the same thing as well,
// but it's a little bit harder for them. They have to manually create
// a toolkit, get its handle, then pass that handle to the constructor.
// After that, they need to destroy the toolkit.
//
// As a shortcut way to bypass all that work, we provide this function that
// creates an ALEntryList with the appropriate toolkit.
//
// RETURNS
//
// A handle to the newly created ALEntryList object.
//
// EXAMPLE
//
// SEE ALSO
//
// REVISION HISTORY
//
// February 14, 1996 2.0A : New Release
//
#if !defined( AL_NO_C )
extern "C" AL_LINKAGE hALEntryList AL_FUNCTION
newALListGlDecompressTools( hALMonitor monitor ) /* Tag public function */
{
if ( monitor )
AL_ASSERT_OBJECT( monitor, ALMonitor, "newALListGlDecompressTools" );
return (hALEntryList) new ALEntryList( (ALMonitor *) monitor,
GlDecompressTools() );
}
#endif