home *** CD-ROM | disk | FTP | other *** search
/ ANews 1 / AnewsCD01.iso / Indispensables / Compression / xad / Developer / Sources / ExampleClient.c
C/C++ Source or Header  |  1999-08-09  |  6KB  |  173 lines
  1. #ifndef XADMASTER_EXAMPLE_C
  2. #define XADMASTER_EXAMPLE_C
  3.  
  4. /* Programmheader
  5.  
  6.     Name:        Example.c
  7.     Main:        xadmaster
  8.     Versionstring:    $VER: Example.c 1.2 (29.06.1999)
  9.     Author:        SDI
  10.     Distribution:    Freeware
  11.     Description:    Example disk or file archiver client
  12.  
  13.  1.0   16.02.99 : first version
  14.  1.1   20.06.99 : some little corrections
  15.  1.2   29.06.99 : now uses master free stuff
  16. */
  17.  
  18. #include <proto/xadmaster.h>
  19. #include <dos/dos.h>
  20. #include "SDI_compiler.h"
  21.  
  22. #ifndef XADMASTERFILE
  23. #define Example_Client        FirstClient
  24. #define NEXTCLIENT        0
  25. UBYTE version[] = "$VER: Example 1.2 (29.06.1999)";
  26. #endif
  27. #define EXAMPLE_VERSION        1
  28. #define EXAMPLE_REVISION    2
  29.  
  30. /* This is an empty example client! You should replace all "EXAMPLE"
  31. texts with text related to your own client. */
  32.  
  33. /* NOTE: I normally use SAS-C. This compiler supports local base variables
  34. for library calls, so all function calls to xadmaster.library can be done
  35. using the argument passed in register A6.
  36.  
  37. If your compiler does not support that, insert a global base, rename the
  38. argument of the functions to lower case xadmasterbase and add following
  39. line in Example_GetInfo() function:
  40.  
  41.   xadMasterBase = xadmasterbase;
  42.  
  43. xadMasterBase also has a pointer to DOSBase and SysBase, but normally this
  44. should not be necessary, but it is useful for debug output in test versions.
  45. */
  46.  
  47. /* See the included example clients as well! */
  48.  
  49. ASM(BOOL) Example_RecogData(REG(d0, ULONG size), REG(a0, STRPTR data),
  50. REG(a6, struct xadMasterBase *xadMasterBase))
  51. {
  52.   if(/* do some checks here (headerID, header checksum, ...) */)
  53.     return 1; /* known file */
  54.   else
  55.     return 0; /* unknown file */
  56. }
  57.  
  58. ASM(LONG) Example_GetInfo(REG(a0, struct xadArchiveInfo *ai),
  59. REG(a6, struct xadMasterBase *xadMasterBase))
  60. {
  61.   /* return an error code, as long as function is empty */
  62.   return XADERR_NOTSUPPORTED;
  63.  
  64.   /* Always do this function first (after RecogData). Normally it's the
  65.   easiest one.
  66.   General style for file archivers:
  67.   -Allocate "xadAllocObject(XADOBJ_FILEINFO, ...., TAG_DONE)" the
  68.    xadFileInfo structure for every file and fill it's fields with
  69.    correct values (date, size, protection, crunched size, flags, ...).
  70.   -Add the allocated structure to a linked list, which is assigned to
  71.    ai->xai_FileInfo.
  72.   -If an error occurs set "ai->xai_Flags & XADAIF_FILECORRUPT" or
  73.    return the error if it is really serious. If there are already valid
  74.    entries in linked list, there cannot be that serious!
  75.   -Leave this function.
  76.   General style for disk archivers:
  77.   -Allocate "xadAllocObject(XADOBJ_DISKINFO, ...., TAG_DONE)" the
  78.    xadDiskInfo structure for every file and fill it's fields with
  79.    correct values (tracks, heads, flags, ...).
  80.   -Add the allocated structure to a linked list, which is assigned to
  81.    ai->xai_DiskInfo.
  82.   -If there are information texts, create a linked list with xadTextInfo
  83.    structures. These are allocated with xadAllocObjectA(XADOBJ_TEXTINFO, 0).
  84.   -If an error occurs set "ai->xai_Flags & XADAIF_FILECORRUPT" or
  85.    return the error if it is really serious. If there are already valid
  86.    entries in linked list, there cannot be that serious!
  87.   -Leave this function.
  88.  
  89.   For nearly all archivers it is necessary to store current file position
  90.   (ai->xai_InPos), to be able to find the data in unarchive function.
  91.  
  92.   Get data using "xadHookAccess(XADAC_READ, size, buf, ai)" and seek input
  93.   data using "xadHookAccess(XADAC_INPUTSEEK, size, 0, ai)".
  94.   */
  95. }
  96.  
  97. ASM(LONG) Example_UnArchive(REG(a0, struct xadArchiveInfo *ai),
  98. REG(a6, struct xadMasterBase *xadMasterBase))
  99. {
  100.   /* return an error code, as long as function is empty */
  101.   return XADERR_NOTSUPPORTED;
  102.  
  103.   /*
  104.   -Either use ai->xai_CurDisk or ai->xai_CurFile and seek the input data
  105.    to the position required to access the archived data for the wanted entry:
  106.    "xadHookAccess(XADAC_INPUTSEEK, pos-ai->xai_InPos, 0, ai)".
  107.   -Extract the data using XADAC_READ for reads, XADAC_WRITE for storing data
  108.    or XADAC_COPY for copying the data directly.
  109.   - Leave the function either returning 0 or an errorcode, which occured.
  110.   */ 
  111. }
  112.  
  113.  
  114. ASM(void) Example_Free(REG(a0, struct xadArchiveInfo *ai),
  115. REG(a6, struct xadMasterBase *xadMasterBase))
  116. {
  117.   /* This function needs to free all the stuff allocated in info or
  118.   unarchive function. It may be called multiple times, so clear freed
  119.   entries!
  120.   */
  121.  
  122.   /* The following example frees file and disk archive data. It assumes,
  123.   that disk archive information texts are allocated using xadAllocVec and all
  124.   the other stuff (file names, comments, ...) is allocated using the tags
  125.   of xadAllocObject function.
  126.  
  127.   If you only do that stuff, then set the responding XADCF_FREE flags and
  128.   the master library does the stuff for you. In that case you do not even
  129.   need that function (remove it totally!).
  130.  
  131.   In any other case you should modify that function to meet your special
  132.   requirements. Remember. The function should leave all fields cleared!
  133.   */
  134.  
  135.   struct xadFileInfo *fi, *fi2;
  136.   struct xadDiskInfo *di, *di2;
  137.   struct xadTextInfo *ti, *ti2;
  138.  
  139.   for(fi = ai->xai_FileInfo; fi; fi = fi2)
  140.   {
  141.     fi2 = fi->xfi_Next;
  142.     xadFreeObjectA(fi, 0);
  143.   }
  144.   ai->xai_FileInfo = 0;
  145.  
  146.   for(di = ai->xai_DiskInfo; di; di = di2)
  147.   {
  148.     di2 = di->xdi_Next;
  149.     
  150.     for(ti = di->xdi_TextInfo; ti; ti = ti2)
  151.     {
  152.       ti2 = ti->xti_Next;
  153.       if(ti->xti_Text)
  154.         xadFreeObjectA(ti->xti_Text, 0);
  155.       xadFreeObjectA(ti, 0);
  156.     }
  157.     xadFreeObjectA(di, 0);
  158.   }
  159.   ai->xai_DiskInfo = 0;
  160. }
  161.  
  162. /* You need to complete following structure! */
  163. struct xadClient Example_Client = {
  164. NEXTCLIENT, XADCLIENT_VERSION, 2, EXAMPLE_VERSION, EXAMPLE_REVISION,
  165. /* Here the size the client really needs to detect the filetype must be
  166. inserted */, /* XADCF_DISKARCHIVER and/or XADCF_FILEARCHIVER and some of
  167. XADCF_FREEDISKINFO|XADCF_FREEFILEINFO|XADCF_FREETEXTINFO|XADCF_FREETEXTINFOTEXT */,
  168. 0 /* Type identifier. Normally should be zero */, "Example",
  169. (BOOL (*)()) Example_RecogData, (LONG (*)()) Example_GetInfo,
  170. (LONG (*)()) Example_UnArchive, /* 0 or (void (*)()) Example_Free */};
  171.  
  172. #endif /* XADASTER_EXAMPLE_C */
  173.