2 * LZ Decompression functions
4 * Copyright 1996 Marcus Meissner
7 * FIXME: return values might be wrong
14 #include <sys/types.h>
20 #include "wine/unicode.h"
21 #include "wine/winbase16.h"
23 #include "debugtools.h"
25 DEFAULT_DEBUG_CHANNEL(file);
27 /* The readahead length of the decompressor. Reading single bytes
28 * using _lread() would be SLOW.
32 /* Format of first 14 byte of LZ compressed file */
39 static BYTE LZMagic[8]={'S','Z','D','D',0x88,0xf0,0x27,0x33};
42 HFILE realfd; /* the real filedescriptor */
43 CHAR lastchar; /* the last char of the filename */
45 DWORD reallength; /* the decompressed length of the file */
46 DWORD realcurrent; /* the position the decompressor currently is */
47 DWORD realwanted; /* the position the user wants to read from */
49 BYTE table[0x1000]; /* the rotating LZ table */
50 UINT curtabent; /* CURrent TABle ENTry */
52 BYTE stringlen; /* length and position of current string */
53 DWORD stringpos; /* from stringtable */
56 WORD bytetype; /* bitmask within blocks */
58 BYTE *get; /* GETLEN bytes */
59 DWORD getcur; /* current read */
60 DWORD getlen; /* length last got */
63 #define MAX_LZSTATES 16
64 static struct lzstate *lzstates[MAX_LZSTATES];
66 #define IS_LZ_HANDLE(h) (((h) >= 0x400) && ((h) < 0x400+MAX_LZSTATES))
67 #define GET_LZ_STATE(h) (IS_LZ_HANDLE(h) ? lzstates[(h)-0x400] : NULL)
69 /* reads one compressed byte, including buffering */
70 #define GET(lzs,b) _lzget(lzs,&b)
71 #define GET_FLUSH(lzs) lzs->getcur=lzs->getlen;
74 _lzget(struct lzstate *lzs,BYTE *b) {
75 if (lzs->getcur<lzs->getlen) {
76 *b = lzs->get[lzs->getcur++];
79 int ret = _lread(lzs->realfd,lzs->get,GETLEN);
90 /* internal function, reads lzheader
91 * returns BADINHANDLE for non filedescriptors
92 * return 0 for file not compressed using LZ
93 * return UNKNOWNALG for unknown algorithm
94 * returns lzfileheader in *head
96 static INT read_header(HFILE fd,struct lzfileheader *head)
100 if (_llseek(fd,0,SEEK_SET)==-1)
101 return LZERROR_BADINHANDLE;
103 /* We can't directly read the lzfileheader struct due to
104 * structure element alignment
106 if (_lread(fd,buf,14)<14)
108 memcpy(head->magic,buf,8);
109 memcpy(&(head->compressiontype),buf+8,1);
110 memcpy(&(head->lastchar),buf+9,1);
112 /* FIXME: consider endianess on non-intel architectures */
113 memcpy(&(head->reallength),buf+10,4);
115 if (memcmp(head->magic,LZMagic,8))
117 if (head->compressiontype!='A')
118 return LZERROR_UNKNOWNALG;
122 /***********************************************************************
123 * LZStart (LZEXPAND.7)
125 INT16 WINAPI LZStart16(void)
132 /***********************************************************************
135 INT WINAPI LZStart(void)
142 /***********************************************************************
143 * LZInit (LZEXPAND.3)
145 HFILE16 WINAPI LZInit16( HFILE16 hfSrc )
147 HFILE ret = LZInit( DosFileHandleToWin32Handle(hfSrc) );
148 if (IS_LZ_HANDLE(ret)) return ret;
149 if ((INT)ret <= 0) return ret;
154 /***********************************************************************
157 * initializes internal decompression buffers, returns lzfiledescriptor.
158 * (return value the same as hfSrc, if hfSrc is not compressed)
159 * on failure, returns error code <0
160 * lzfiledescriptors range from 0x400 to 0x410 (only 16 open files per process)
162 * since _llseek uses the same types as libc.lseek, we just use the macros of
165 HFILE WINAPI LZInit( HFILE hfSrc )
168 struct lzfileheader head;
173 TRACE("(%d)\n",hfSrc);
174 ret=read_header(hfSrc,&head);
176 _llseek(hfSrc,0,SEEK_SET);
177 return ret?ret:hfSrc;
179 for (i = 0; i < MAX_LZSTATES; i++) if (!lzstates[i]) break;
180 if (i == MAX_LZSTATES) return LZERROR_GLOBALLOC;
181 lzstates[i] = lzs = HeapAlloc( GetProcessHeap(), 0, sizeof(struct lzstate) );
182 if(lzs == NULL) return LZERROR_GLOBALLOC;
184 memset(lzs,'\0',sizeof(*lzs));
186 lzs->lastchar = head.lastchar;
187 lzs->reallength = head.reallength;
189 lzs->get = HeapAlloc( GetProcessHeap(), 0, GETLEN );
193 if(lzs->get == NULL) {
194 HeapFree(GetProcessHeap(), 0, lzs);
196 return LZERROR_GLOBALLOC;
199 /* Yes, preinitialize with spaces */
200 memset(lzs->table,' ',0x1000);
201 /* Yes, start 16 byte from the END of the table */
202 lzs->curtabent = 0xff0;
207 /***********************************************************************
208 * LZDone (LZEXPAND.9)
211 void WINAPI LZDone(void)
217 /***********************************************************************
218 * GetExpandedName (LZEXPAND.10)
220 INT16 WINAPI GetExpandedName16( LPCSTR in, LPSTR out )
222 return (INT16)GetExpandedNameA( in, out );
226 /***********************************************************************
227 * GetExpandedNameA (LZ32.@)
229 * gets the full filename of the compressed file 'in' by opening it
230 * and reading the header
232 * "file." is being translated to "file"
233 * "file.bl_" (with lastchar 'a') is being translated to "file.bla"
234 * "FILE.BL_" (with lastchar 'a') is being translated to "FILE.BLA"
237 INT WINAPI GetExpandedNameA( LPCSTR in, LPSTR out )
239 struct lzfileheader head;
242 INT fnislowercased,ret,len;
246 fd=OpenFile(in,&ofs,OF_READ);
248 return (INT)(INT16)LZERROR_BADINHANDLE;
250 ret=read_header(fd,&head);
252 /* not a LZ compressed file, so the expanded name is the same
253 * as the input name */
259 /* look for directory prefix and skip it. */
261 while (NULL!=(t=strpbrk(s,"/\\:")))
264 /* now mangle the basename */
266 /* FIXME: hmm. shouldn't happen? */
267 WARN("Specified a directory or what? (%s)\n",in);
271 /* see if we should use lowercase or uppercase on the last char */
279 fnislowercased=islower(*t);
282 if (isalpha(head.lastchar)) {
284 head.lastchar=tolower(head.lastchar);
286 head.lastchar=toupper(head.lastchar);
289 /* now look where to replace the last character */
290 if (NULL!=(t=strchr(s,'.'))) {
296 t[len]=head.lastchar;
298 } /* else no modification necessary */
304 /***********************************************************************
305 * GetExpandedNameW (LZ32.@)
307 INT WINAPI GetExpandedNameW( LPCWSTR in, LPWSTR out )
310 DWORD len = WideCharToMultiByte( CP_ACP, 0, in, -1, NULL, 0, NULL, NULL );
311 char *xin = HeapAlloc( GetProcessHeap(), 0, len );
312 char *xout = HeapAlloc( GetProcessHeap(), 0, len+3 );
313 WideCharToMultiByte( CP_ACP, 0, in, -1, xin, len, NULL, NULL );
314 if ((ret = GetExpandedNameA( xin, xout )) > 0)
315 MultiByteToWideChar( CP_ACP, 0, xout, -1, out, strlenW(in)+4 );
316 HeapFree( GetProcessHeap(), 0, xin );
317 HeapFree( GetProcessHeap(), 0, xout );
322 /***********************************************************************
323 * LZRead (LZEXPAND.5)
325 INT16 WINAPI LZRead16( HFILE16 fd, LPVOID buf, UINT16 toread )
327 if (IS_LZ_HANDLE(fd)) return LZRead( fd, buf, toread );
328 return _lread( DosFileHandleToWin32Handle(fd), buf, toread );
332 /***********************************************************************
335 INT WINAPI LZRead( HFILE fd, LPVOID vbuf, UINT toread )
342 TRACE("(%d,%p,%d)\n",fd,buf,toread);
344 if (!(lzs = GET_LZ_STATE(fd))) return _lread(fd,buf,toread);
346 /* The decompressor itself is in a define, cause we need it twice
347 * in this function. (the decompressed byte will be in b)
349 #define DECOMPRESS_ONE_BYTE \
350 if (lzs->stringlen) { \
351 b = lzs->table[lzs->stringpos]; \
352 lzs->stringpos = (lzs->stringpos+1)&0xFFF; \
355 if (!(lzs->bytetype&0x100)) { \
357 return toread-howmuch; \
358 lzs->bytetype = b|0xFF00; \
360 if (lzs->bytetype & 1) { \
362 return toread-howmuch; \
366 if (1!=GET(lzs,b1)) \
367 return toread-howmuch; \
368 if (1!=GET(lzs,b2)) \
369 return toread-howmuch; \
373 * where CAB is the stringoffset in the table\
374 * and D+3 is the len of the string \
376 lzs->stringpos = b1|((b2&0xf0)<<4); \
377 lzs->stringlen = (b2&0xf)+2; \
378 /* 3, but we use a byte already below ... */\
379 b = lzs->table[lzs->stringpos];\
380 lzs->stringpos = (lzs->stringpos+1)&0xFFF;\
384 /* store b in table */ \
385 lzs->table[lzs->curtabent++]= b; \
386 lzs->curtabent &= 0xFFF; \
389 /* if someone has seeked, we have to bring the decompressor
392 if (lzs->realcurrent!=lzs->realwanted) {
393 /* if the wanted position is before the current position
394 * I see no easy way to unroll ... We have to restart at
395 * the beginning. *sigh*
397 if (lzs->realcurrent>lzs->realwanted) {
398 /* flush decompressor state */
399 _llseek(lzs->realfd,14,SEEK_SET);
404 memset(lzs->table,' ',0x1000);
405 lzs->curtabent = 0xFF0;
407 while (lzs->realcurrent<lzs->realwanted) {
419 #undef DECOMPRESS_ONE_BYTE
423 /***********************************************************************
424 * LZSeek (LZEXPAND.4)
426 LONG WINAPI LZSeek16( HFILE16 fd, LONG off, INT16 type )
428 if (IS_LZ_HANDLE(fd)) return LZSeek( fd, off, type );
429 return _llseek( DosFileHandleToWin32Handle(fd), off, type );
433 /***********************************************************************
436 LONG WINAPI LZSeek( HFILE fd, LONG off, INT type )
441 TRACE("(%d,%ld,%d)\n",fd,off,type);
442 /* not compressed? just use normal _llseek() */
443 if (!(lzs = GET_LZ_STATE(fd))) return _llseek(fd,off,type);
444 newwanted = lzs->realwanted;
446 case 1: /* SEEK_CUR */
449 case 2: /* SEEK_END */
450 newwanted = lzs->reallength-off;
452 default:/* SEEK_SET */
456 if (newwanted>lzs->reallength)
457 return LZERROR_BADVALUE;
459 return LZERROR_BADVALUE;
460 lzs->realwanted = newwanted;
465 /***********************************************************************
466 * LZCopy (LZEXPAND.1)
469 LONG WINAPI LZCopy16( HFILE16 src, HFILE16 dest )
471 /* already a LZ handle? */
472 if (IS_LZ_HANDLE(src)) return LZCopy( src, DosFileHandleToWin32Handle(dest) );
474 /* no, try to open one */
476 if ((INT16)src <= 0) return 0;
477 if (IS_LZ_HANDLE(src))
479 LONG ret = LZCopy( src, DosFileHandleToWin32Handle(dest) );
483 /* it was not a compressed file */
484 return LZCopy( DosFileHandleToWin32Handle(src), DosFileHandleToWin32Handle(dest) );
488 /***********************************************************************
491 * Copies everything from src to dest
492 * if src is a LZ compressed file, it will be uncompressed.
493 * will return the number of bytes written to dest or errors.
495 LONG WINAPI LZCopy( HFILE src, HFILE dest )
497 int usedlzinit=0,ret,wret;
502 /* we need that weird typedef, for i can't seem to get function pointer
503 * casts right. (Or they probably just do not like WINAPI in general)
505 typedef UINT WINAPI (*_readfun)(HFILE,LPVOID,UINT);
509 TRACE("(%d,%d)\n",src,dest);
510 if (!IS_LZ_HANDLE(src)) {
512 if ((INT)src <= 0) return 0;
513 if (src != oldsrc) usedlzinit=1;
516 /* not compressed? just copy */
517 if (!IS_LZ_HANDLE(src))
520 xread=(_readfun)LZRead;
523 ret=xread(src,buf,BUFLEN);
532 wret = _lwrite(dest,buf,ret);
534 return LZERROR_WRITE;
542 /* reverses GetExpandedPathname */
543 static LPSTR LZEXPAND_MangleName( LPCSTR fn )
546 char *mfn = (char *)HeapAlloc( GetProcessHeap(), 0,
547 strlen(fn) + 3 ); /* "._" and \0 */
548 if(mfn == NULL) return NULL;
550 if (!(p = strrchr( mfn, '\\' ))) p = mfn;
551 if ((p = strchr( p, '.' )))
554 if (strlen(p) < 3) strcat( p, "_" ); /* append '_' */
555 else p[strlen(p)-1] = '_'; /* replace last character */
557 else strcat( mfn, "._" ); /* append "._" */
562 /***********************************************************************
563 * LZOpenFile (LZEXPAND.2)
565 HFILE16 WINAPI LZOpenFile16( LPCSTR fn, LPOFSTRUCT ofs, UINT16 mode )
567 HFILE hfret = LZOpenFileA( fn, ofs, mode );
568 /* return errors and LZ handles unmodified */
569 if ((INT)hfret <= 0) return hfret;
570 if (IS_LZ_HANDLE(hfret)) return hfret;
571 /* but allocate a dos handle for 'normal' files */
572 return Win32HandleToDosFileHandle(hfret);
576 /***********************************************************************
577 * LZOpenFileA (LZ32.@)
579 * Opens a file. If not compressed, open it as a normal file.
581 HFILE WINAPI LZOpenFileA( LPCSTR fn, LPOFSTRUCT ofs, UINT mode )
585 TRACE("(%s,%p,%d)\n",fn,ofs,mode);
586 /* 0x70 represents all OF_SHARE_* flags, ignore them for the check */
587 fd=OpenFile(fn,ofs,mode);
590 LPSTR mfn = LZEXPAND_MangleName(fn);
591 fd = OpenFile(mfn,ofs,mode);
592 HeapFree( GetProcessHeap(), 0, mfn );
594 if ((mode&~0x70)!=OF_READ)
599 if ((INT)cfd <= 0) return fd;
604 /***********************************************************************
605 * LZOpenFileW (LZ32.@)
607 HFILE WINAPI LZOpenFileW( LPCWSTR fn, LPOFSTRUCT ofs, UINT mode )
610 DWORD len = WideCharToMultiByte( CP_ACP, 0, fn, -1, NULL, 0, NULL, NULL );
611 LPSTR xfn = HeapAlloc( GetProcessHeap(), 0, len );
612 WideCharToMultiByte( CP_ACP, 0, fn, -1, xfn, len, NULL, NULL );
613 ret = LZOpenFileA(xfn,ofs,mode);
614 HeapFree( GetProcessHeap(), 0, xfn );
619 /***********************************************************************
620 * LZClose (LZEXPAND.6)
622 void WINAPI LZClose16( HFILE16 fd )
624 if (IS_LZ_HANDLE(fd)) LZClose( fd );
625 else DisposeLZ32Handle( DosFileHandleToWin32Handle(fd) );
629 /***********************************************************************
632 void WINAPI LZClose( HFILE fd )
637 if (!(lzs = GET_LZ_STATE(fd))) _lclose(fd);
640 if (lzs->get) HeapFree( GetProcessHeap(), 0, lzs->get );
641 CloseHandle(lzs->realfd);
642 lzstates[fd - 0x400] = NULL;
643 HeapFree( GetProcessHeap(), 0, lzs );
647 /***********************************************************************
648 * CopyLZFile (LZEXPAND.8)
650 LONG WINAPI CopyLZFile16( HFILE16 src, HFILE16 dest )
652 TRACE("(%d,%d)\n",src,dest);
653 return LZCopy16(src,dest);
657 /***********************************************************************
658 * CopyLZFile (LZ32.@)
660 * Copy src to dest (including uncompressing src).
661 * NOTE: Yes. This is exactly the same function as LZCopy.
663 LONG WINAPI CopyLZFile( HFILE src, HFILE dest )
665 TRACE("(%d,%d)\n",src,dest);
666 return LZCopy(src,dest);