home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / wp_dtp / ispell.lha / minrexx.c < prev    next >
C/C++ Source or Header  |  1990-12-28  |  15KB  |  455 lines
  1. /*
  2.  *   This is an example of how REXX messages might be handled.  This is
  3.  *   a `minimum' example that both accepts asynchronous REXX messages and
  4.  *   can request REXX service.
  5.  *
  6.  *   Read this entire file!  It's short enough.
  7.  *
  8.  *   It is written in such a fashion that it can be attached to a program
  9.  *   with a minimum of fuss.  The only external symbols it makes available
  10.  *   are the seven functions and RexxSysBase.
  11.  *
  12.  *   This code is by Radical Eye Software, but it is put in the public
  13.  *   domain.  I would appreciate it if the following string was left in
  14.  *   both as a version check and as thanks from you for the use of this
  15.  *   code.
  16.  *
  17.  *   If you modify this file for your own use, don't bump the version
  18.  *   number; add a suffix, such as 1.0a or 1.0.3 or something, so we
  19.  *   don't have fake `versions' floating around.
  20.  */
  21. static char *blurb = "Radical Eye MinRexx 0.4ljr";
  22. /*
  23.  *   We read in our own personal little include.
  24.  */
  25. #include <stdio.h>
  26. #include <string.h>
  27. #include <proto/all.h>
  28. #include "minrexx.h"
  29. #include "ispell.h"
  30. struct RexxMsg * __stdargs CreateRexxMsg(struct MsgPort *, char *, char *);
  31. void __stdargs DeleteRexxMsg(struct RexxMsg *);
  32. char * __stdargs CreateArgstring(char *, int);
  33. void __stdargs DeleteArgstring(char *);
  34.  
  35. /*
  36.  *   All of our local globals, hidden from sight.
  37.  */
  38. static struct MsgPort *rexxPort;/* this is *our* rexx port */
  39. static int bringerdown;        /* are we trying to shut down? */
  40. static struct rexxCommandList *globalrcl;    /* our command association list */
  41. static long stillNeedReplies;    /* how many replies are pending? */
  42. static long rexxPortBit;    /* what bit to wait on for Rexx? */
  43. static char *extension;        /* the extension for macros */
  44. static void (*userdisp) (struct RexxMsg *, struct rexxCommandList *, char *);    /* the user's dispatch function */
  45. static struct RexxMsg *oRexxMsg;/* the outstanding Rexx message */
  46. /*
  47.  *   Our library base.  Don't you dare close this!
  48.  */
  49. struct RxsLib *RexxSysBase;
  50. /*
  51.  *   This is the main entry point into this code.
  52.  */
  53. long upRexxPort (char *s, struct rexxCommandList *rcl, char *exten, void(*uf)(struct RexxMsg *, struct rexxCommandList *, char *))
  54. /*
  55.  *   The first argument is the name of your port to be registered;
  56.  *   this will be used, for instance, with the `address' command of ARexx.
  57.  *   The second argument is an association list of command-name/user-data
  58.  *   pairs.  It's an array of struct rexxCommandList, terminated by a
  59.  *   structure with a NULL in the name field. The commands are case
  60.  *   sensitive.  The user-data field can contain anything appropriate,
  61.  *   perhaps a function to call or some other data.
  62.  *   The third argument is the file extension for ARexx macros invoked
  63.  *   by this program.  If you supply this argument, any `primitive' not
  64.  *   in the association list rcl will be sent out to ARexx for
  65.  *   interpretation, thus allowing macro programs to work just like
  66.  *   primitives.  If you do not want this behavior, supply a `NULL'
  67.  *   here, and those commands not understood will be replied with an
  68.  *   error value of RXERRORNOCMD.
  69.  *   The fourth argument is the user dispatch function.  This function
  70.  *   will *only* be called from rexxDisp(), either from the user calling
  71.  *   this function directly, or from dnRexxPort().  Anytime a command
  72.  *   match is found in the association list, this user-supplied function
  73.  *   will be called with two arguments---the Rexx message that was
  74.  *   received, and a pointer to the association pair.  This function
  75.  *   should return a `1' if the message was replied to by the function
  76.  *   and a `0' if the default success code of (0, 0) should be returned.
  77.  *   Note that the user function should never ReplyMsg() the message;
  78.  *   instead he should indicate the return values with replyRexxCmd();
  79.  *   otherwise we lose track of the messages that still lack replies.
  80.  *   upRexxPort() returns the signal bit to wait on for Rexx messages.
  81.  *   If something goes wrong, it simply returns a `0'.  Note that this
  82.  *   function is safe to call multiple times because we check to make
  83.  *   sure we haven't opened already.  It's also a quick way to change
  84.  *   the association list or dispatch function.
  85.  */
  86. {
  87.  
  88. /*
  89.  *   Some basic error checking.
  90.  */
  91.   if (rcl == NULL || uf == NULL)
  92.     return (0L);
  93. /*
  94.  *   If we aren't open, we make sure no one else has opened a port with
  95.  *   this name already.  If that works, and the createport succeeds, we
  96.  *   fill rexxPortBit with the value to return.
  97.  *
  98.  *   Note that rexxPortBit will be 0 iff rexxPort is NULL, so the check
  99.  *   for rexxPort == NULL also insures that our rexxPortBit is 0.
  100.  */
  101.   if (rexxPort == NULL)
  102.     {
  103.       Forbid ();
  104.       if (FindPort (s) == NULL)
  105.     rexxPort = CreatePort (s, 0L);
  106.       Permit ();
  107.       if (rexxPort != NULL)
  108.     rexxPortBit = 1L << rexxPort->mp_SigBit;
  109.     }
  110. /*
  111.  *   Squirrel away these values for our own internal access, and return
  112.  *   the wait bit.
  113.  */
  114.   globalrcl = rcl;
  115.   extension = exten;
  116.   userdisp = uf;
  117.   return (rexxPortBit);
  118. }
  119.  
  120. /*
  121.  *   This function closes the rexx library, but only if it is open
  122.  *   and we aren't expecting further replies from REXX.  It's
  123.  *   *private*, but it doesn't have to be; it's pretty safe to
  124.  *   call anytime.
  125.  */
  126. void closeRexxLib (void)
  127. {
  128.   if (stillNeedReplies == 0 && RexxSysBase)
  129.     {
  130.       CloseLibrary ((struct Library *)RexxSysBase);
  131.       RexxSysBase = NULL;
  132.     }
  133. }
  134.  
  135. /*
  136.  *   This function closes down the Rexx port.  It is always safe to
  137.  *   call, and should *definitely* be made a part of your cleanup
  138.  *   routine.  No arguments and no return.  It removes the Rexx port,
  139.  *   replies to all of the messages and insures that we get replies
  140.  *   to all the ones we sent out, closes the Rexx library, deletes the
  141.  *   port, clears a few flags, and leaves.
  142.  */
  143. void dnRexxPort (void)
  144. {
  145.   if (rexxPort)
  146.     {
  147.       RemPort (rexxPort);
  148.       bringerdown = 1;
  149. /*
  150.  *   A message still hanging around?  We kill it off.
  151.  */
  152.       if (oRexxMsg)
  153.     {
  154.       oRexxMsg->rm_Result1 = RXERRORIMGONE;
  155.       ReplyMsg ((struct Message *)oRexxMsg);
  156.       oRexxMsg = NULL;
  157.     }
  158.       while (stillNeedReplies)
  159.     {
  160.       WaitPort (rexxPort);
  161.       dispRexxPort ();
  162.     }
  163.       closeRexxLib ();
  164.       DeletePort (rexxPort);
  165.       rexxPort = NULL;
  166.     }
  167.   rexxPortBit = 0;
  168. }
  169.  
  170. /*
  171.  *   Here we dispatch any REXX messages that might be outstanding.
  172.  *   This is the main routine for handling Rexx messages.
  173.  *   This function is fast if no messages are outstanding, so it's
  174.  *   pretty safe to call fairly often.
  175.  *
  176.  *   If we are bring the system down and flushing messages, we reply
  177.  *   with a pretty serious return code RXERRORIMGONE.
  178.  *
  179.  *   No arguments, no returns.
  180.  */
  181. void dispRexxPort (void)
  182. {
  183.   register struct RexxMsg *RexxMsg;
  184.   register struct rexxCommandList *rcl;
  185.   register char *p;
  186.   register int dontreply;
  187.  
  188. /*
  189.  *   If there's no rexx port, we're out of here.
  190.  */
  191.   if (rexxPort == NULL)
  192.     return;
  193. /*
  194.  *   Otherwise we have our normal loop on messages.
  195.  */
  196.   while (RexxMsg = (struct RexxMsg *) GetMsg (rexxPort))
  197.     {
  198. /*
  199.  *   If we have a reply to a message we sent, we look at the second
  200.  *   argument.  If it's set, it's a function we are supposed to call
  201.  *   so we call it.  Then, we kill the argstring and the message
  202.  *   itself, decrement the outstanding count, and attempt to close
  203.  *   down the Rexx library.  Note that this call only succeeds if
  204.  *   there are no outstanding messages.  Also, it's pretty quick, so
  205.  *   don't talk to me about efficiency.
  206.  */
  207.       if (RexxMsg->rm_Node.mn_Node.ln_Type == NT_REPLYMSG)
  208.     {
  209.       if (RexxMsg->rm_Args[1])
  210.         {
  211.           ((int (*) (struct RexxMsg *)) (RexxMsg->rm_Args[1])) (RexxMsg);
  212.         }
  213.       DeleteArgstring (RexxMsg->rm_Args[0]);
  214.       DeleteRexxMsg (RexxMsg);
  215.       stillNeedReplies--;
  216.       closeRexxLib ();
  217. /*
  218.  *   The default case is we got a message and we need to check it for
  219.  *   primitives.  We skip past any initial tabs or spaces and initialize
  220.  *   the return code fields.
  221.  */
  222.     }
  223.       else
  224.     {
  225.       p = (char *) RexxMsg->rm_Args[0];
  226.       while (*p > 0 && *p <= ' ')
  227.         p++;
  228.       RexxMsg->rm_Result1 = 0;
  229.       RexxMsg->rm_Result2 = 0;
  230. /*
  231.  *   If somehow the reply is already done or postponed, `dontreply' is
  232.  *   set.
  233.  */
  234.       dontreply = 0;
  235. /*
  236.  *   If the sky is falling, we just blow up and replymsg.
  237.  */
  238.       if (bringerdown)
  239.         {
  240.           RexxMsg->rm_Result1 = RXERRORIMGONE;
  241. /*
  242.  *   Otherwise we cdr down our association list, comparing commands,
  243.  *   until we get a match.  If we get a match, we call the dispatch
  244.  *   function with the appropriate arguments, and break out.
  245.  */
  246.         }
  247.       else
  248.         {
  249.           oRexxMsg = RexxMsg;
  250.           for (rcl = globalrcl; rcl->name; rcl++)
  251.         {
  252.           if (cmdcmp (rcl->name, p) == 0)
  253.             {
  254.               userdisp (RexxMsg, rcl, p + strlen (rcl->name));
  255.               break;
  256.             }
  257.         }
  258. /*
  259.  *   If we broke out, rcl will point to the command we executed; if we
  260.  *   are at the end of the list, we didn't understand the command.  In
  261.  *   this case, if we were supplied an extension in upRexxPort, we know
  262.  *   that we should send the command out, so we do so, synchronously.
  263.  *   The synchronous send takes care of our reply.  If we were given a
  264.  *   NULL extension, we bitch that the command didn't make sense to us.
  265.  */
  266.           if (rcl->name == NULL)
  267.         {
  268.           if (extension)
  269.             {
  270.               syncRexxCmd (RexxMsg->rm_Args[0], RexxMsg);
  271.               dontreply = 1;
  272.             }
  273.           else
  274.             {
  275.               RexxMsg->rm_Result1 = RXERRORNOCMD;
  276.             }
  277.         }
  278.         }
  279. /*
  280.  *   Finally, reply if appropriate.
  281.  */
  282.       oRexxMsg = NULL;
  283.       if (!dontreply)
  284.         ReplyMsg ((struct Message *)RexxMsg);
  285.     }
  286.     }
  287. }
  288.  
  289. /*
  290.  *   This is the function we use to see if the command matches
  291.  *   the command string.  Not case sensitive, and the real command only
  292.  *   need be a prefix of the command string.  Make sure all commands
  293.  *   are given in lower case!
  294.  */
  295. int cmdcmp (char *c, char *m)
  296. {
  297.   while (*c && ((*c == *m) || (*c == *m + 32 && ('a' <= *c && *c <= 'z'))))
  298.     {
  299.       c++;
  300.       m++;
  301.     }
  302.   return ((int) *c);
  303. }
  304.  
  305. /*
  306.  *   Opens the Rexx library if unopened.  Returns success (1) or
  307.  *   failure (0).  This is another function that is *private* but
  308.  *   that doesn't have to be.
  309.  */
  310. int openRexxLib (void)
  311. {
  312.   if (RexxSysBase)
  313.     return (1);
  314.   return ((RexxSysBase = (struct RxsLib *)OpenLibrary (RXSNAME, 0L)) != NULL);
  315. }
  316.  
  317. /*
  318.  *   This is the general ARexx command interface, but is not the one
  319.  *   you will use most of the time; ones defined later are easier to
  320.  *   understand and use.  But they all go through here.
  321.  */
  322. struct RexxMsg *sendRexxCmd (char *s, void (*f)(struct RexxMsg *), STRPTR p1, STRPTR p2, STRPTR p3)
  323. /*
  324.  *   The first parameter is the command to send to Rexx.
  325.  *   The second parameter is either NULL, indicating that the command
  326.  *   should execute asynchronously, or a function to be called when the
  327.  *   message we build up and send out here finally returns.  Please note
  328.  *   that the function supplied here could be called during cleanup after
  329.  *   a fatal error, so make sure it is `safe'.  This function always is
  330.  *   passed one argument, the RexxMsg that is being replied.
  331.  *   These are up to three arguments to be stuffed into the RexxMsg we
  332.  *   are building up, making the values available when the message is
  333.  *   finally replied to.  The values are stuffed into Args[2]..Args[4].
  334.  */
  335. {
  336.   register struct MsgPort *rexxport;
  337.   register struct RexxMsg *RexxMsg;
  338.  
  339. /*
  340.  *   If we have too many replies out there, we just return failure.
  341.  *   Note that you should check the return code to make sure your
  342.  *   message got out!  Then, we forbid, and make sure that:
  343.  *      - we have a rexx port open
  344.  *      - Rexx is out there
  345.  *      - the library is open
  346.  *      - we can create a message
  347.  *      - we can create an argstring
  348.  *
  349.  *   If all of these succeed, we stuff a few values and send the
  350.  *   message, permit, and return.
  351.  */
  352.   if (rexxPort == NULL || stillNeedReplies > MAXRXOUTSTANDING - 1)
  353.     return (NULL);
  354.   RexxMsg = NULL;
  355.   if (openRexxLib () && (RexxMsg =
  356.       CreateRexxMsg (rexxPort, extension, rexxPort->mp_Node.ln_Name)) &&
  357.       (RexxMsg->rm_Args[0] = CreateArgstring (s, (long) strlen (s))))
  358.     {
  359.       RexxMsg->rm_Action = RXCOMM;
  360.       RexxMsg->rm_Args[1] = (STRPTR) f;
  361.       RexxMsg->rm_Args[2] = p1;
  362.       RexxMsg->rm_Args[3] = p2;
  363.       RexxMsg->rm_Args[4] = p3;
  364.       RexxMsg->rm_Node.mn_Node.ln_Name = RXSDIR;
  365.       Forbid ();
  366.       if (rexxport = FindPort (RXSDIR))
  367.     PutMsg (rexxport, (struct Message *)RexxMsg);
  368.       Permit ();
  369.       if (rexxport)
  370.     {
  371.       stillNeedReplies++;
  372.       return (RexxMsg);
  373.     }
  374.       else
  375.     DeleteArgstring (RexxMsg->rm_Args[0]);
  376.     }
  377.   if (RexxMsg)
  378.     DeleteRexxMsg (RexxMsg);
  379.   closeRexxLib ();
  380.   return (NULL);
  381. }
  382.  
  383. /*
  384.  *   This function is used to send out an ARexx message and return
  385.  *   immediately.  Its single parameter is the command to send.
  386.  */
  387. struct RexxMsg *asyncRexxCmd (char *s)
  388. {
  389.   return (sendRexxCmd (s, NULL, NULL, NULL, NULL));
  390. }
  391.  
  392. /*
  393.  *   This function sets things up to reply to the message that caused
  394.  *   it when we get a reply to the message we are sending out here.
  395.  *   But first the function we pass in, which actually handles the reply.
  396.  *   Note how we get the message from the Args[2]; Args[0] is the command,
  397.  *   Args[1] is this function, and Args[2]..Args[4] are any parameters
  398.  *   passed to sendRexxCmd() as p1..p3.  We pass the result codes right
  399.  *   along.
  400.  */
  401. void replytoit (struct RexxMsg *msg)
  402. {
  403.   register struct RexxMsg *omsg;
  404.  
  405.   omsg = (struct RexxMsg *) (msg->rm_Args[2]);
  406.   replyRexxCmd (omsg, msg->rm_Result1, msg->rm_Result2, NULL);
  407.   ReplyMsg ((struct Message *)omsg);
  408. }
  409.  
  410. /*
  411.  *   This function makes use of everything we've put together so far,
  412.  *   and functions as a synchronous Rexx call; as soon as the macro
  413.  *   invoked here returns, we reply to `msg', passing the return codes
  414.  *   back.
  415.  */
  416. struct RexxMsg *syncRexxCmd (char *s, struct RexxMsg *msg)
  417. {
  418.   return (sendRexxCmd (s, &replytoit, (STRPTR)msg, NULL, NULL));
  419. }
  420.  
  421. /*
  422.  *   There are times when you want to pass back return codes or a
  423.  *   return string; call this function when you want to do that,
  424.  *   and return `1' from the user dispatch function so the main
  425.  *   event loop doesn't reply (because we reply here.)  This function
  426.  *   always returns 1.
  427.  */
  428. void replyRexxCmd (struct RexxMsg *msg, long primary, long secondary, char *string)
  429. /*
  430.  *   The first parameter is the message we are replying to.
  431.  *   The next two parameters are the primary and secondary return
  432.  *   codes.
  433.  *   The final parameter is a return string.  This string is only
  434.  *   returned if the primary return code is 0, and a string was
  435.  *   requested.
  436.  *
  437.  *   We also note that we have replied to the message that came in.
  438.  */
  439. {
  440. /*
  441.  *   Note how we make sure the Rexx Library is open before calling
  442.  *   CreateArgstring . . . and we close it down at the end, if possible.
  443.  */
  444.   if (primary == 0 && (msg->rm_Action & (1L << RXFB_RESULT)))
  445.     {
  446.       if (string && openRexxLib ())
  447.     secondary = (long) CreateArgstring (string, (long) strlen (string));
  448.       else
  449.     secondary = 0L;
  450.     }
  451.   msg->rm_Result1 = primary;
  452.   msg->rm_Result2 = secondary;
  453.   closeRexxLib ();
  454. }
  455.