home *** CD-ROM | disk | FTP | other *** search
/ The Best of Mecomp Multimedia 2 / MECOMP-CD-II.iso / amiga / tools / packer / xpk_develop / include / modula2 / xpkmasterd.def next >
Encoding:
Modula Definition  |  1998-02-08  |  13.9 KB  |  317 lines
  1. (*#-- BEGIN AutoRevision header, please do NOT edit!
  2. *
  3. * $VER: XpkMasterD.def 1.1 (27.01.1998)
  4. * Auth: T.B. (tonyiommi@geocities.com)
  5. *
  6. * Desc: XPKMaster Defs for xpk 4.25 (27.01.1998) by SDI
  7. * Reqs: AMIGA OS 2.0
  8. * Lang: MODULA-2
  9. * Comp: Cyclone © by M. Timmermans
  10. * 
  11. *-- END AutoRevision header --*)
  12.  
  13. DEFINITION MODULE XpkMasterD; (*$ Implementation- *)
  14.  
  15. FROM SYSTEM IMPORT ADDRESS;
  16. FROM UtilityD IMPORT tagUser;
  17.  
  18. TYPE  StrPtr = ADDRESS;
  19.  
  20. (* --- The packing/unpacking tags --- *)
  21. (* (TRUE) or (FALSE) mean the default value given by xpkmaster.library *)
  22.  
  23. CONST
  24.  tagBase=tagUser + ORD('X')*256 + ORD('P');
  25.  
  26. (* Caller must supply ONE of these to tell Xpk#?ack where to get data from *)
  27.  inName =tagBase+1; (* Process an entire named file *)
  28.  inFH   =tagBase+2; (* File handle - start from current position. If packing partial file, must also supply InLen *)
  29.  inBuf  =tagBase+3; (* Single unblocked memory buffer. Must also supply InLen *)
  30.  inHook =tagBase+4; (* Call custom Hook to read data. Must also supply InLen, when hook cannot do! (not for XPK unpacking) *)
  31.  
  32. (* Caller must supply ONE of these to tell Xpk#?ackFile where to send data to *)
  33.  outName    =tagBase+10H; (* Write (or overwrite) this data file *)
  34.  outFH      =tagBase+11H; (* File handle - write from current position on *)
  35.  outBuf     =tagBase+12H; (* Unblocked buffer - must also supply OutBufLen *)
  36.  getOutBuf  =tagBase+13H; (* Master allocates OutBuf - ti_Data points to buf ptr *)
  37.  outHook    =tagBase+14H; (* Callback Hook to get output buffers *)
  38.  
  39. (* --- Other tags for Pack/Unpack --- *)
  40.  inLen          =tagBase+20H; (* Length of data in input buffer *)
  41.  outBufLen      =tagBase+21H; (* Length of output buffer *)
  42.  getOutLen      =tagBase+22H; (* ti_Data points to long to receive OutLen *)
  43.  getOutBufLen   =tagBase+23H; (* ti_Data points to long to receive OutBufLen *)
  44.  password       =tagBase+24H; (* Password for de/encoding *)
  45.  getError       =tagBase+25H; (* ti_Data points to buffer for error message *)
  46.  outMemType     =tagBase+26H; (* Memory type for output buffer *)
  47.  passThru       =tagBase+27H; (* Bool: Pass through unrecognized formats on unpack *)
  48.  stepDown       =tagBase+28H; (* Bool: Step down pack method if necessary *)
  49.  chunkHook      =tagBase+29H; (* Call this Hook between chunks *)
  50.  packMethod     =tagBase+2AH; (* Do a FindMethod before packing *)
  51.  chunkSize      =tagBase+2BH; (* Chunk size to try to pack with *)
  52.  packMode       =tagBase+2CH; (* Packing mode for sublib to use *)
  53.  noClobber      =tagBase+2DH; (* Don't overwrite existing files *)
  54.  ignore         =tagBase+2EH; (* Skip this tag *)
  55.  taskPri        =tagBase+2FH; (* Change priority for (un)packing *)
  56.  fileName       =tagBase+30H; (* File name for progress report *)
  57.  shortError     =tagBase+31H; (* !!! obsolete !!! *)
  58.  packersQuery   =tagBase+32H; (* Query available packers *)
  59.  packerQuery    =tagBase+33H; (* Query properties of a packer *)
  60.  modeQuery      =tagBase+34H; (* Query properties of packmode *)
  61.  lossyOK        =tagBase+35H; (* Lossy packing permitted? (FALSE) *)
  62.  noCRC          =tagBase+36H; (* Ignore checksum *)
  63.  
  64. (* tags added for xfdmaster support (version 4 revision 25) *)
  65.  key16        =tagBase+37H; (* 16 bit key (unpack only) *)
  66.  key32        =tagBase+38H; (* 32 bit key (unpack only) *)
  67.  
  68. (* preference depending tags added for version 4 - their default value may depend on preferences, see xpk/xpkprefs.h for more info *)
  69.  useXfdMaster  =tagBase+40H; (* Use xfdmaster.library (FALSE) *)
  70.  useExternals  =tagBase+41H; (* Use packers in extern dir (TRUE) *)
  71.  passRequest   =tagBase+42H; (* automatic password req.? (FALSE) *)
  72.  preferences   =tagBase+43H; (* use prefs semaphore ? (TRUE) *)
  73.  chunkReport   =tagBase+44H; (* automatic chunk report ? (FALSE) *)
  74.  
  75. (* tags tagBase+0x50) to tagBase+0x69) are for XpkPassRequest -- see below *)
  76.  
  77.  margin =256;   (* Safety margin for output buffer  *)
  78.  
  79. (* --- The hook function interface --- *)
  80. (* Message passed to InHook and OutHook as the ParamPacket *)
  81. TYPE
  82.  IOMsgPtr=POINTER TO IOMsg;
  83.  IOMsg=RECORD
  84.   type      :LONGINT;   (* Read/Write/Alloc/Free/Abort*)
  85.   ptr       :ADDRESS;   (* The mem area to read from/write to *)
  86.   size      :LONGINT;   (* The size of the read/write *)
  87.   ioError,  (* The IoErr() that occurred *)
  88.   reserved, (* Reserved for future use *)
  89.   private1, (* Hook specific, will be set to 0 by *)
  90.   private2, (* master library before first use *)
  91.   private3,
  92.   private4  :LONGINT;
  93.  END;
  94.  
  95. (* The values for XpkIoMsg->Type *)
  96. CONST
  97.  ioRead   =1;
  98.  ioWrite  =2;
  99.  ioFree   =3;
  100.  ioAbort  =4;
  101.  ioGetbuf =5;
  102.  ioSeek   =6;
  103.  ioTotSize=7;
  104.  
  105. (* --- The progress report interface --- *)
  106.  
  107. (* Passed to ChunkHook as the ParamPacket *)
  108. TYPE
  109.  ProgressPtr=POINTER TO Progress;
  110.  Progress=RECORD
  111.   type          :LONGINT;   (* Type of report: start/cont/end/abort *)
  112.   packerName,               (* Brief name of packer being used *)
  113.   packerLongName,           (* Descriptive name of packer being used *)
  114.   activity,                 (* Packing/unpacking message *)
  115.   fileName      :StrPtr;    (* Name of file being processed, if available *)
  116.   cCur,                     (* Amount of packed data already processed *)
  117.   uCur,                     (* Amount of unpacked data already processed *)
  118.   uLen,                     (* Amount of unpacked data in file *)
  119.   cf,                       (* Compression factor so far *)
  120.   done,                     (* Percentage done already *)
  121.   speed         :LONGINT;   (* Bytes per second, from beginning of stream *)
  122.   reserved      :ARRAY[1..8] OF LONGINT;    (* For future use *)
  123.  END;
  124.  
  125. CONST
  126.   progStart =1;
  127.   progMID   =2;
  128.   progEnd   =3;
  129.  
  130. (* --- The file info block --- *)
  131. TYPE
  132.  FibPtr = POINTER TO Fib;
  133.  Fib=RECORD
  134.   type,         (* Unpacked, packed, archive? *)
  135.   uLen,         (* Uncompressed length *)
  136.   cLen,         (* Compressed length *)
  137.   nLen,         (* Next chunk len *)
  138.   uCur,         (* Uncompressed bytes so far *)
  139.   cCur,         (* Compressed bytes so far *)
  140.   id            :LONGINT;                   (* 4 letter ID of packer *)
  141.   packer        :ARRAY[0..4] OF CHAR;       (* 4 letter name of packer *)
  142.   subVersion,                               (* Required sublib version *)
  143.   masVersion    :INTEGER;                   (* Required masterlib version *)
  144.   flags         :LONGINT;                   (* Password *)
  145.   head          :ARRAY[0..15] OF SHORTCARD; (* First 16 bytes of orig. file *)
  146.   ratio         :LONGINT;                   (* Compression ratio *)
  147.   reserved      :ARRAY[0..7] OF LONGINT;    (* For future use *)
  148.  END;
  149.  
  150. CONST
  151.  typeUnpacked =0; (* Not packed *)
  152.  typePacked   =1; (* Packed file *)
  153.  typeArchive  =2; (* Archive *)
  154.  
  155.  flagsPassword  = 1; (* Password needed *)
  156.  flagsNoSeek    = 2; (* Chunks are dependent *)
  157.  flagsNonSTD    = 4; (* Nonstandard file format *)
  158.  
  159.  (* defines added for xfdmaster support (version 4 revision 25) *)
  160.  flagsKey16    = 8; (* 16 bit key - for decrunching *)
  161.  flagsKey32    =16; (* 32 bit key - for decrunching *)
  162.  
  163. (* --- The error messages --- *)
  164.   errOK         =0;
  165.   errNoFunc     =-1;    (* This function not implemented *)
  166.   errNoFiles    =-2;    (* No files allowed for this function *)
  167.   errIoErrIn    =-3;    (* Input error happened *)
  168.   errIoErrOut   =-4;    (* Output error happened *)
  169.   errChecksum   =-5;    (* Check sum test failed *)
  170.   errVersion    =-6;    (* Packed file's version newer than lib *)
  171.   errNoMem      =-7;    (* Out of memory *)
  172.   errLibInUse   =-8;    (* For not-reentrant libraries *)
  173.   errWrongForm  =-9;    (* Was not packed with this library *)
  174.   errSmallBuf   =-10;   (* Output buffer too small *)
  175.   errLargeBuf   =-11;   (* Input buffer too large *)
  176.   errWrongMode  =-12;   (* This packing mode not supported *)
  177.   errNeedPassWD =-13;   (* Password needed for decoding *)
  178.   errCorruptPKD =-14;   (* Packed file is corrupt *)
  179.   errMissingLib =-15;   (* Required library is missing *)
  180.   errBadParams  =-16;   (* Caller's TagList was screwed up *)
  181.   errExpansion  =-17;   (* Would have caused data expansion *)
  182.   errNoMethod   =-18;   (* Cannot find requested method *)
  183.   errAborted    =-19;   (* Operation aborted by user *)
  184.   errTruncated  =-20;   (* Input file is truncated *)
  185.   errWrongCPU   =-21;   (* Better CPU required for this library *)
  186.   errPacked     =-22;   (* Data are already XPacked *)
  187.   errNotPacked  =-23;   (* Data not packed *)
  188.   errFileExists =-24;   (* File already exists *)
  189.   errOldMastlib =-25;   (* Master library too old *)
  190.   errOldSUBLIB  =-26;   (* Sub library too old *)
  191.   errNoCrypt    =-27;   (* Cannot encrypt *)
  192.   errNoInfo     =-28;   (* Can't get info on that packer *)
  193.   errLossy      =-29;   (* This compression method is lossy *)
  194.   errNoHardware =-30;   (* Compression hardware required *)
  195.   errBadHardware=-31;   (* Compression hardware failed *)
  196.   errWrongPW    =-32;   (* Password was wrong *)
  197.   errUnknown    =-33;   (* unknown error cause *)
  198.   errReqTimeOut =-34;        (* password request reached time out *)
  199.  
  200.   errMsgSize    =80;    (* Maximum size of an error message *)
  201.  
  202. (* --- The XpkQuery() call --- *)
  203. TYPE
  204.  PackerInfoPtr=POINTER TO PackerInfo;
  205.  PackerInfo=RECORD
  206.   name          :ARRAY[0..23] OF CHAR;  (* Brief name of the packer *)
  207.   longName      :ARRAY[0..31] OF CHAR;  (* Full name of the packer *)
  208.   description   :ARRAY[0..79] OF CHAR;  (* One line description of packer *)
  209.   flags         :LONGINT;               (* Defined below *)
  210.   maxChunk      :LONGINT;               (* Max input chunk size for packing *)
  211.   defChunk      :LONGINT;               (* Default packing chunk size *)
  212.   defMode       :INTEGER;               (* Default mode on 0..100 scale *)
  213.  END;
  214.  
  215. (* --- Defines for Flags --- *)
  216. CONST
  217.   pkChunk   =00001H; (* Library supplies chunk packing *)
  218.   pkStream  =00002H; (* Library supplies stream packing *)
  219.   pkArchive =00004H; (* Library supplies archive packing *)
  220.   upChunk   =00008H; (* Library supplies chunk unpacking *)
  221.   upStream  =00010H; (* Library supplies stream unpacking *)
  222.   upArchive =00020H; (* Library supplies archive unpacking *)
  223.   hookio    =00080H; (* Uses full Hook I/O *)
  224.   checking  =00400H; (* Does its own data checking *)
  225.   prereadhdr=00800H; (* Unpacker pre-reads the next chunkhdr *)
  226.   encryption=02000H; (* Sub library supports encryption *)
  227.   needpasswd=04000H; (* Sub library requires encryption *)
  228.   modes     =08000H; (* Sub library has different modes *)
  229.   lossy     =10000H; (* Sub library does lossy compression *)
  230.  
  231. TYPE
  232.  ModePtr=POINTER TO Mode;
  233.  Mode=RECORD
  234.   next          :ModePtr;   (* Chain to next descriptor for ModeDesc list *)
  235.   upto,                     (* Maximum efficiency handled by this mode *)
  236.   flags,                    (* Defined below *)
  237.   packMemory,               (* Extra memory required during packing *)
  238.   unpackMemory,             (* Extra memory during unpacking *)
  239.   packSpeed,                (* Approx packing speed in K per second *)
  240.   unpackSpeed   :LONGINT;   (* Approx unpacking speed in K per second *)
  241.   ratio,                    (* CF in 0.1% for AmigaVision executable *)
  242.   chunkSize     :INTEGER;   (* Desired chunk size in K (!!) for this mode *)
  243.   description   :ARRAY[0..9] OF CHAR;   (* 7 character mode description *)
  244.  END;
  245.  
  246. (* --- Defines for XpkMode.Flags --- *)
  247. CONST
  248.  a3000Speed =1; (* Timings on A3000/25 *)
  249.  noCPU      =2; (* Packing not heavily CPU dependent *)
  250.  upNoCPU    =4; (* Unpacking... (i.e. hardware modes) *)
  251.  
  252.  MaxPackers =100;
  253.  
  254. TYPE
  255.  PackerListPtr=POINTER TO PackerList;
  256.  PackerList=RECORD
  257.   numPackers:LONGINT;
  258.   packer    :ARRAY[0..MaxPackers-1],[0..5] OF CHAR;
  259.  END;
  260.  
  261. CONST
  262. (* --- The XpkPassRequest() call (library version 4) --- *)
  263.    passChars    =tagBase+50H; (* which chars should be used *)
  264.    passwordBuf  =tagBase+51H; (* buffer to write password to *)
  265.    passBufSize  =tagBase+52H; (* size of password buffer *)
  266.    key16BitPtr  =tagBase+53H; (* pointer to UWORD var for key data *)
  267.    key32BitPtr  =tagBase+54H; (* pointer to ULONG var for key data *)
  268.    pubScreen    =tagBase+55H; (* pointer to struct Screen *)
  269.    passTitle    =tagBase+56H; (* Text shown in Screen title *)
  270.    timeOut      =tagBase+57H; (* Timeout time of requester in seconds *)
  271.  
  272.    (* request position and verify tags (version 4 revision 25) *)
  273.    passWinLeft    =tagBase+58H; (* distance from left screen border *)
  274.    passWinTop    =tagBase+59H; (* distance form top screen border *)
  275.    passWinWidth =tagBase+5AH; (* width of requester window *)
  276.    passWinHeight=tagBase+5BH; (* height of requester window *)
  277.    passCenter   =tagBase+5CH; (* Left and Top are used as center coords *)
  278.    passVerify    =tagBase+5DH; (* force user to verify password *)
  279.  
  280. (* XPKPASSFF defines for  PassChars. Do not use. Use XPKPASSFLG defines *)
  281.   passFF30x39       =0;   (* all numbers      *)
  282.   passFF41x46       =1;   (* chars 'A' to 'F' *)
  283.   passFF61x66       =2;   (* chars 'a' to 'f' *)
  284.   passFF47x5A       =4;   (* chars 'G' to 'Z' *)
  285.   passFF67x7A       =8;   (* chars 'g' to 'z' *)
  286.   passFF20          =16;  (* space character  *)
  287.   passFFSpecial7Bit =32;  (* all chars 0x20 to 0x7E without above defined *)
  288.   passFFC0xDE       =64;  (* upper special chars  *)
  289.   passFFDFxFF       =128; (* lower special chars  *)
  290.   passFFSpecial8Bit =256; (* special 8Bit chars   *) (* all chars 0xA0 to 0xBF *)
  291.  
  292. (* flags for  PassChars, XPKPASSFLG_PRINTABLE is default *)
  293. (*
  294. NUMERIC     :numbers
  295. HEXADECIMAL :hex numbers
  296. ALPHANUMERIC:numbers and letters
  297. INTALPHANUM :numbers and international letters
  298. ASCII7      :7 Bit ASCII
  299. PRINTABLE   :all characters
  300. *)
  301.   passFlgNumeric        =passFF30x39;
  302.   passFlgHexadecimal    =passFF30x39+passFF41x46+passFF61x66;
  303.   passFlgAlphanumeric   =passFlgHexadecimal+passFF47x5A+passFF67x7A;
  304.   passFlgIntAlphanum    =passFlgAlphanumeric+passFFC0xDE+passFFDFxFF;
  305.   passFlgASCII7         =passFlgAlphanumeric+passFFSpecial7Bit;
  306.   passsFLGPrintable     =passFlgIntAlphanum+passFFSpecial7Bit+passFFSpecial8Bit+passFF20;
  307.  
  308. (* The XpkAllocObject() call (library version 4) *)
  309.  
  310. (* use this always with library version >= 4, do NO longer allocate the structures yourself *)
  311.   objFIB        =0; (* XpkFib structure *)
  312.   objPackerinfo =1; (* XpkPackerInfo structure *)
  313.   objMode       =2; (* XpkMode structure *)
  314.   objPackerlist =3; (* XpkPackerList structure *)
  315.  
  316. END XpkMasterD.
  317.