lupin/LupinFramework/LupinPluginProtocol.h

/*
 * Copyright (c) 2004-2005 The Lupin Project. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are permitted 
 * provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions 
 *    and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of 
 *    conditions and the following disclaimer in the documentation and/or other materials provided 
 *    with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE LUPIN PROJECT ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, 
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE LUPIN PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 */

#import "LPCompress.h"
#import "LPFile.h"

typedef enum {
        LPErrorUnknown = -1,
        LPErrorNoError = 0,
        LPErrorWarning = 1,
        LPErrorNotImplementMethod = 2,
        LPErrorBadArgument = 3,
        LPErrorNotExist = 4,
        LPErrorBrokenArchive = 5,
        LPErrorLockedArchive = 6,
        LPErrorNotSupportFormat = 7,
        LPErrorRequestPassword = 8,
        LPErrorBadPassword = 9,
        LPErrorFileOpening = 10,
        LPErrorFileReading = 11,
        LPErrorFileWriting = 12,
        LPErrorFailureAllocateMemory = 13,
} LPError;


@protocol LupinPluginProtocol

+ (id)alloc;
- (void)dealloc;
- (NSArray*)acceptableExtensions;
- (id)initWithFile:(NSString*)path;
#pragma mark Plugin Information
- (NSString*)pluginName;
- (NSString*)pluginAuthorName;
- (NSString*)pluginVersion;
- (NSString*)pluginURI;
- (NSString*)pluginEmail;
- (NSAttributedString*)pluginCopyright;
#pragma mark Archive Managing
- (LPFile*)buildArchiveInfoDict:(BOOL)hierarchy password:(NSString*)password;
- (BOOL)archiveAllUncompress:(NSString*)path exclude:(NSArray*)exclude password:(NSString*)password delegate:(id)delegate selector:(SEL)selector;
- (BOOL)archiveUncompress:(NSString*)path files:(NSArray*)files password:(NSString*)password delegate:(id)delegate selector:(SEL)selector;
- (BOOL)archiveCompress:(NSString*)path files:(NSArray*)files exclude:(NSArray*)exclude currentPath:(NSString*)currentPath compress:(LPCompress*)compress option:(NSDictionary*)option delegate:(id)delegate selector:(SEL)selector;
- (NSMutableData*)archiveUncompressToMemory:(LPFile*)file password:(NSString*)password;
- (BOOL)pauseProcess;
- (BOOL)continueProcess;
- (BOOL)stopProcess;
#pragma mark Process Information
- (BOOL)isProgressTraversable;
- (NSNumber*)processInfo:(NSString**)title;
#pragma mark Compress Information
- (NSArray*)compressInfo:(int)index;

@end