home *** CD-ROM | disk | FTP | other *** search
/ Amiga Times / AmigaTimes.iso / system / MUI / developer / extclasses / mcc_tron / source / mui / mccheader.c next >
Encoding:
C/C++ Source or Header  |  1998-10-06  |  12.1 KB  |  495 lines
  1. /*****************************************************************************
  2.  
  3. This code serves as a basis for writing a library-based MUI custom class
  4. (xyz.mcc) and its preferences editor (xyz.mcp).
  5.  
  6. You need to define a few things in your main source file, then include
  7. this file and then continue with your classes methods. The order is
  8. important, mccheader.c must be the first code-generating module.
  9.  
  10. Things to be defined before mccheader.c is included:
  11.  
  12. (1)  UserLibID     - version string for your class. must follow normal $VER: string conventions.
  13. (2)  VERSION       - version number of the class. must match the one given in the $VER: string.
  14. (3)  REVISION      - revision number of the class. must match the one given in the $VER: string.
  15. (4)  CLASS         - Name of your class, ".mcc" or ".mcp" must always be appended.
  16.  
  17. (5)  SUPERCLASS    - superclass of your class.
  18. (6)  struct Data   - instance data structure.
  19. (7)  _Dispatcher   - your dispatcher function.
  20.  
  21. (8)  SUPERCLASSP   - Superclass of the preferences class, must be MUIC_Mccprefs or a subclass.
  22. (9)  struct DataP  - instance data structure of preferences class.
  23. (10) _DispatcherP  - dispatcher for the preferences class.
  24.  
  25. Items (1) to (4) must always be defined. If you create a stand-alone
  26. custom class (*.mcc) without preferences editor, also define (5), (6)
  27. and (7). Name your class and the resulting ouptut file "Myclass.mcc".
  28.  
  29. If you create a preferences class (*.mcp) for a custom class, define
  30. (8), (9) and (10) instead of (5), (6) and (7). Name your class and the
  31. resulting output file "Myclass.mcp".
  32.  
  33. If you create a custom class with included preferences editor, define
  34. all the above. Note that in this case, the name of your class and the
  35. resulting output file is always "Myclass.mcc". MUI will automatically
  36. recognize that there's also a "Myclass.mcp" included. Having a builtin
  37. preferences class reduces the need for a second file but increases the
  38. size and memory consuption of the class.
  39.  
  40. If your class needs custom initialization (e.g. opening other
  41. libraries), you can define
  42.     ClassInit
  43.     ClassExit
  44. to point to custom functions. These functions need to have the prototypes
  45.     BOOL ClassInitFunc(struct Library *base);
  46.     VOID ClassExitFunc(struct Library *base);
  47. and will be called right after the class has been created and right
  48. before the class is being deleted. If your init func returns FALSE,
  49. the custom class will be unloaded immediately.
  50.  
  51. Define the minimum version of muimaster.libray in MASTERVERSION. If you
  52. don't define MASTERVERSION, it will default to MUIMASTER_VMIN from the
  53. mui.h include file.
  54.  
  55. This code automatically defines and initializes the following variables:
  56.     struct Library *MUIMasterBase;
  57.     struct Library *SysBase;
  58.     struct Library *UtilityBase;
  59.     struct Library *DOSBase;
  60.     struct Library *GfxBase;
  61.     struct Library *IntuitionBase;
  62.     struct Library *MUIClassBase;       /* your classes library base */
  63.     struct MUI_CustomClass *ThisClass;  /* your custom class */
  64.     struct MUI_CustomClass *ThisClassP; /* your preferences class */
  65.  
  66. Example: Myclass.c
  67.     #define CLASS      MUIC_Myclass // name of class, e.g. "Myclass.mcc"
  68.     #define SUPERCLASS MUIC_Area    // name of superclass
  69.     struct Data
  70.     {
  71.         LONG          MyData;
  72.         struct Foobar MyData2;
  73.         // ...
  74.     };
  75.     #define UserLibID "$VER: Myclass.mcc 17.53 (11.11.96)"
  76.     #define VERSION   17
  77.     #define REVISION  53
  78.     #include "mccheader.c"
  79.     ULONG ASM SAVEDS _Dispatcher(REG(a0) struct IClass *cl,
  80.                                  REG(a2) Object *obj,
  81.                                  REG(a1) Msg msg)
  82.     {
  83.         // ...
  84.     }
  85.  
  86. Compiling and linking with SAS-C can look like this:
  87.     Myclass.mcc: Myclass.c
  88.         sc $(CFLAGS) $*.c OBJNAME $*.o
  89.         slink to $@ from $*.o lib $(LINKERLIBS) $(LINKERFLAGS)
  90.  
  91. Note well that we don't use SAS library creation feature here, it simply
  92. sucks too much. It's not much more complicated to do the library
  93. initialziation ourselves and we have better control over everything.
  94.  
  95. Make sure to read the whole source to get some interesting comments
  96. and some understanding on how libraries are created!
  97.  
  98. *****************************************************************************/
  99.  
  100.  
  101. /* a few includes... */
  102.  
  103. #include <exec/types.h>
  104. #include <exec/memory.h>
  105. #include <exec/libraries.h>
  106. #include <exec/semaphores.h>
  107. #include <exec/resident.h>
  108. #include <dos/dos.h>
  109. #include <clib/exec_protos.h>
  110. #include <pragmas/exec_sysbase_pragmas.h>
  111.  
  112.  
  113. /* The name of the class will also become the name of the library. */
  114. /* We need a pointer to this string in our ROMTag (see below). */
  115.  
  116. static const char UserLibName[] = CLASS;
  117.  
  118.  
  119. /* Here's our global data, described above. */
  120.  
  121. struct Library *MUIClassBase;
  122. struct Library *MUIMasterBase;
  123. struct Library *SysBase;
  124. struct Library *UtilityBase;
  125. struct Library *DOSBase;
  126. struct Library *GfxBase;
  127. struct Library *IntuitionBase;
  128.  
  129. #ifdef SUPERCLASS
  130. struct MUI_CustomClass *ThisClass;
  131. #endif
  132.  
  133. #ifdef SUPERCLASSP
  134. struct MUI_CustomClass *ThisClassP;
  135. #endif
  136.  
  137. #ifdef _DCC
  138. #define REG(x) __ ## x
  139. #define ASM
  140. #define SAVEDS __geta4
  141. #else
  142. #define REG(x) register __ ## x
  143. #define ASM    __asm
  144. #define SAVEDS __saveds
  145. #endif
  146.  
  147.  
  148. /* Our library structure, consisting of a struct Library, a segment pointer */
  149. /* and a semaphore. We need the semaphore to protect init/exit stuff in our */
  150. /* open/close functions */
  151.  
  152. struct LibraryHeader
  153. {
  154.     struct Library         lh_Library;
  155.     BPTR                   lh_Segment;
  156.     struct SignalSemaphore lh_Semaphore;
  157. };
  158.  
  159.  
  160. /* Prototypes for all library functions */
  161.  
  162. struct LibraryHeader * ASM LibInit   (REG(a0) BPTR Segment);
  163. BPTR                   ASM LibExpunge(REG(a6) struct LibraryHeader *base);
  164. struct LibraryHeader * ASM LibOpen   (REG(a6) struct LibraryHeader *base);
  165. BPTR                   ASM LibClose  (REG(a6) struct LibraryHeader *base);
  166. LONG                   ASM LibNull   (VOID);
  167. ULONG           SAVEDS ASM MCC_Query (REG(d0) LONG which);
  168.  
  169.  
  170. /* Prototypes for a few sub-functions */
  171.  
  172. BOOL ASM UserLibInit   (REG(a6) struct Library *base);
  173. BOOL ASM UserLibExpunge(REG(a6) struct Library *base);
  174. BOOL ASM UserLibOpen   (REG(a6) struct Library *base);
  175. BOOL ASM UserLibClose  (REG(a6) struct Library *base);
  176.  
  177.  
  178. /* This is the librarie's jump table */
  179.  
  180. static const APTR LibVectors[] =
  181. {
  182.     LibOpen,
  183.     LibClose,
  184.     LibExpunge,
  185.     LibNull,
  186.     MCC_Query,
  187.     (APTR)-1
  188. };
  189.  
  190.  
  191. /* Dummy entry point and LibNull() function all in one */
  192.  
  193. LONG ASM LibNull(VOID)
  194. {
  195.     return(NULL);
  196. }
  197.  
  198.  
  199. /* Here's what makes us a library. */
  200.  
  201. static const struct Resident ROMTag =
  202. {
  203.     RTC_MATCHWORD,
  204.     &ROMTag,
  205.     &ROMTag + 1,
  206.     0,
  207.     VERSION,
  208.     NT_LIBRARY,
  209.     0,
  210.     UserLibName,
  211.     UserLibID,
  212.     LibInit
  213. };
  214.  
  215.  
  216. #undef D
  217. #undef bug
  218. #undef bugg
  219.  
  220. #ifdef DEBUG
  221.  
  222. extern void kprintf(const char *, ...);
  223. #define D(flags,x) { ##x; }
  224. #define bug kprintf("%-12.12s %-17.17s: ",__FILE__,__FUNC__); kprintf
  225. #define bugg kprintf
  226.  
  227. #else
  228.  
  229. #define D(flags,x)
  230. #define bug
  231. #define bugg
  232.  
  233. #endif /* DEBUG */
  234.  
  235.  
  236.  
  237. /******************************************************************************/
  238. /* Standard Library Functions, all of them are called in Forbid() state.      */
  239. /******************************************************************************/
  240.  
  241. struct LibraryHeader * ASM SAVEDS LibInit(REG(a0) BPTR Segment)
  242. {
  243.     struct LibraryHeader *base;
  244.  
  245.     SysBase = *((struct Library **)4);
  246.  
  247.     D(DBF_LIB,bug("start...\n"));
  248.  
  249.     #ifdef __SASC
  250.     #ifdef _M68040
  251.     if (!(((struct ExecBase *)SysBase)->AttnFlags & AFF_68040)) return(NULL);
  252.     #endif
  253.     #ifdef _M68030
  254.     if (!(((struct ExecBase *)SysBase)->AttnFlags & AFF_68030)) return(NULL);
  255.     #endif
  256.     #ifdef _M68020
  257.     if (!(((struct ExecBase *)SysBase)->AttnFlags & AFF_68020)) return(NULL);
  258.     #endif
  259.     #endif
  260.  
  261.     if (base = (struct LibraryHeader *)MakeLibrary((APTR)LibVectors,NULL,NULL,sizeof(struct LibraryHeader),NULL))
  262.     {
  263.         base->lh_Library.lib_Node.ln_Type = NT_LIBRARY;
  264.         base->lh_Library.lib_Node.ln_Name = (char *)UserLibName;
  265.         base->lh_Library.lib_Flags        = LIBF_CHANGED | LIBF_SUMUSED;
  266.         base->lh_Library.lib_Version      = VERSION;
  267.         base->lh_Library.lib_Revision     = REVISION;
  268.         base->lh_Library.lib_IdString     = (char *)UserLibID;
  269.  
  270.         base->lh_Segment  = Segment;
  271.  
  272.         InitSemaphore(&base->lh_Semaphore);
  273.  
  274.         AddLibrary((struct Library *)base);
  275.     }
  276.     else
  277.     {
  278.         D(DBF_LIB,bug("\7MakeLibrary() failed\n"));
  279.     }
  280.  
  281.     return(base);
  282. }
  283.  
  284.  
  285. BPTR ASM SAVEDS LibExpunge(REG(a6) struct LibraryHeader *base)
  286. {
  287.     struct Library *SysBase = *((struct Library **)4);
  288.     BPTR rc;
  289.  
  290.     D(DBF_LIB,bug("OpenCount=%ld\n",base->lh_Library.lib_OpenCnt));
  291.  
  292.     if (base->lh_Library.lib_OpenCnt)
  293.     {
  294.         base->lh_Library.lib_Flags |= LIBF_DELEXP;
  295.         D(DBF_LIB,bug("Setting LIBF_DELEXP\n"));
  296.         return(NULL);
  297.     }
  298.  
  299.     Remove((struct Node *)base);
  300.     rc = base->lh_Segment;
  301.     FreeMem((BYTE *)base - base->lh_Library.lib_NegSize,base->lh_Library.lib_NegSize + base->lh_Library.lib_PosSize);
  302.  
  303.     return(rc);
  304. }
  305.  
  306.  
  307. struct LibraryHeader * ASM SAVEDS LibOpen(REG(a6) struct LibraryHeader *base)
  308. {
  309.     struct Library *SysBase = *((struct Library **)4);
  310.     struct LibraryHeader *rc;
  311.  
  312.     base->lh_Library.lib_OpenCnt++;
  313.     base->lh_Library.lib_Flags &= ~LIBF_DELEXP;
  314.  
  315.     D(DBF_LIB,bug("OpenCount=%ld\n",base->lh_Library.lib_OpenCnt));
  316.  
  317.     ObtainSemaphore(&base->lh_Semaphore);
  318.  
  319.     if (UserLibOpen((struct Library *)base))
  320.     {
  321.         rc = base;
  322.     }
  323.     else
  324.     {
  325.         rc = NULL;
  326.         base->lh_Library.lib_OpenCnt--;
  327.         D(DBF_LIB,bug("\7UserLibOpen() failed\n"));
  328.     }
  329.  
  330.     ReleaseSemaphore(&base->lh_Semaphore);
  331.  
  332.     return(rc);
  333. }
  334.  
  335.  
  336. BPTR ASM SAVEDS LibClose(REG(a6) struct LibraryHeader *base)
  337. {
  338.     struct Library *SysBase = *((struct Library **)4);
  339.     BPTR rc = NULL;
  340.  
  341.     D(DBF_LIB,bug("OpenCount=%ld %s\n",base->lh_Library.lib_OpenCnt,base->lh_Library.lib_OpenCnt==0 ? "\7ERROR" : ""));
  342.  
  343.     ObtainSemaphore(&base->lh_Semaphore);
  344.     UserLibClose((struct Library *)base);
  345.     ReleaseSemaphore(&base->lh_Semaphore);
  346.  
  347.     if (--base->lh_Library.lib_OpenCnt == 0)
  348.     {
  349.         if (base->lh_Library.lib_Flags & LIBF_DELEXP)
  350.         {
  351.             rc = LibExpunge(base);
  352.         }
  353.     }
  354.  
  355.     return(rc);
  356. }
  357.  
  358.  
  359. BOOL ASM SAVEDS UserLibOpen(REG(a6) struct Library *base)
  360. {
  361.     ULONG ASM _Dispatcher(REG(a0) struct IClass *cl, REG(a2) Object *obj, REG(a1) Msg msg);
  362.     ULONG ASM _DispatcherP(REG(a0) struct IClass *cl, REG(a2) Object *obj, REG(a1) Msg msg);
  363.     BOOL ClassInitFunc(struct Library *base);
  364.  
  365.     D(DBF_CLASS,bug("%ld\n",base->lib_OpenCnt));
  366.  
  367.     if (base->lib_OpenCnt!=1)
  368.         return(TRUE);
  369.  
  370.     #ifndef MASTERVERSION
  371.     #define MASTERVERSION MUIMASTER_VMIN
  372.     #endif
  373.  
  374.     if (MUIMasterBase = OpenLibrary("muimaster.library",MASTERVERSION))
  375.     {
  376.         #ifdef SUPERCLASS
  377.         if (ThisClass = MUI_CreateCustomClass(base,SUPERCLASS,NULL,sizeof(struct Data),_Dispatcher))
  378.         #endif
  379.         {
  380.             #ifdef SUPERCLASSP
  381.             if (ThisClassP = MUI_CreateCustomClass(base,SUPERCLASSP,NULL,sizeof(struct DataP),_DispatcherP))
  382.             #endif
  383.             {
  384.                 #ifdef SUPERCLASS
  385.                 #define THISCLASS ThisClass
  386.                 #else
  387.                 #define THISCLASS ThisClassP
  388.                 #endif
  389.  
  390.                 UtilityBase   = THISCLASS->mcc_UtilityBase;
  391.                 DOSBase       = THISCLASS->mcc_DOSBase;
  392.                 GfxBase       = THISCLASS->mcc_GfxBase;
  393.                 IntuitionBase = THISCLASS->mcc_IntuitionBase;
  394.  
  395.                 #ifndef ClassInit
  396.                 return(TRUE);
  397.                 #else
  398.                 if (ClassInitFunc(base))
  399.                 {
  400.                     return(TRUE);
  401.                 }
  402.  
  403.                 #ifdef SUPERCLASSP
  404.                 MUI_DeleteCustomClass(ThisClassP);
  405.                 ThisClassP = NULL;
  406.                 #endif
  407.  
  408.                 #endif
  409.             }
  410.             #ifdef SUPERCLASSP
  411.             #ifdef SUPERCLASS
  412.             MUI_DeleteCustomClass(ThisClass);
  413.             ThisClass = NULL;
  414.             #endif
  415.             #endif
  416.         }
  417.         CloseLibrary(MUIMasterBase);
  418.         MUIMasterBase = NULL;
  419.     }
  420.  
  421.     D(DBF_CLASS,bug("fail.: %08lx %s\n",base,base->lib_Node.ln_Name));
  422.  
  423.     return(FALSE);
  424. }
  425.  
  426.  
  427. BOOL ASM SAVEDS UserLibClose(REG(a6) struct Library *base)
  428. {
  429.     VOID ClassExitFunc(struct Library *base);
  430.  
  431.     D(DBF_CLASS,bug("%ld\n",base->lib_OpenCnt));
  432.  
  433.     if (base->lib_OpenCnt==1)
  434.     {
  435.         #ifdef ClassExit
  436.         ClassExitFunc(base);
  437.         #endif
  438.  
  439.         #ifdef SUPERCLASSP
  440.         if (ThisClassP)
  441.         {
  442.             MUI_DeleteCustomClass(ThisClassP);
  443.             ThisClassP = NULL;
  444.         }
  445.         #endif
  446.  
  447.         #ifdef SUPERCLASS
  448.         if (ThisClass)
  449.         {
  450.             MUI_DeleteCustomClass(ThisClass);
  451.             ThisClass = NULL;
  452.         }
  453.         #endif
  454.  
  455.         if (MUIMasterBase)
  456.         {
  457.             CloseLibrary(MUIMasterBase);
  458.             MUIMasterBase = NULL;
  459.         }
  460.     }
  461.  
  462.     return(TRUE);
  463. }
  464.  
  465.  
  466. ULONG SAVEDS ASM MCC_Query(REG(d0) LONG which)
  467. {
  468.     switch (which)
  469.     {
  470.         #ifdef SUPERCLASS
  471.         case 0: return((ULONG)ThisClass);
  472.         #endif
  473.  
  474.         #ifdef SUPERCLASSP
  475.         case 1: return((ULONG)ThisClassP);
  476.         #endif
  477.  
  478.         #ifdef PREFSIMAGEOBJECT
  479.         case 2:
  480.         {
  481.             Object *obj = PREFSIMAGEOBJECT;
  482.             return((ULONG)obj);
  483.         }
  484.         #endif
  485.  
  486.         #ifdef ONLYGLOBAL
  487.         case 3:
  488.         {
  489.             return(TRUE);
  490.         }
  491.         #endif
  492.     }
  493.     return(NULL);
  494. }
  495.