WebSVN – filter_foundry – Diff – /trunk/scripting.c

 #include "dbg.h"
 //extern FilterRecordPtr gpb;
-OSErr put_cstring(PIWriteDescriptor token,DescriptorKeyID key,char *s){
+OSErr put_cstring(PIWriteDescriptor token, DescriptorKeyID key, char* s) {
+        OSErr e;
         size_t n = strlen(s);
         Ptr p;
         Handle h = PINEWHANDLE((int32)n);
-        p = PILOCKHANDLE(h,false);
+        p = PILOCKHANDLE(h, false);
-        memcpy(p,s,n);
+        memcpy(p, s, n);
         PIUNLOCKHANDLE(h);
-        return PIPutText(token,key,h);
+        e = PIPutText(token, key, h);
-        /* FIXME: not sure if we are supposed to dispose of handle */
+        PIDISPOSEHANDLE(h); /* Not 100% sure if we are supposed to dispose of handle. It doesn't crash though */
+        return e;
+}
-char *get_cstring(PIReadDescriptor token){
+char* get_cstring(PIReadDescriptor token) {
         int n;
         Ptr p;
-        OSErr e = PIGetText(token,&h);
+        OSErr e = PIGetText(token, &h);
-        if(!e && h){
+        if (!e && h) {
                 n = PIGETHANDLESIZE(h);
-                p = PILOCKHANDLE(h,false);
+                p = PILOCKHANDLE(h, false);
-                //sprintf(str,"get_cstring: token=%#x s=%#x h=%#x p=%#x n=%d",token,s,h,p,n); dbg(str);
-                if( (str = (char*)malloc(n+1)) ){
+                if ((str = (char*)malloc(n + 1))) {
-                        memcpy(str,p,n);
+                        memcpy(str, p, n);
                         str[n] = 0;
+                }
                 PIUNLOCKHANDLE(h);
-                /* FIXME: not sure if we are supposed to dispose of handle */
+                PIDISPOSEHANDLE(h); /* Not 100% sure if we are supposed to dispose of handle. It doesn't crash though */
+        }
         return str;
+}
 // If parm is NULL, then it is standalone, otherwise it is the main plugin
                         INPLACEP2CSTR(parm->title),
                         c);
                 hash = printablehash(djb2(data));
                 free(data);
                 return hash;
+        }
-        } else {
+        else {
                 // char* debug = malloc(2000);
                 // sprintf(debug, "getAeteKey %c in MAIN PLUGIN", c);
                 // simplealert(debug);
-                                // Attention: AETE keys (xpr#, cTl#) must be equal in scripting.r, scripting.rc and scripting.c(getAeteKey)!
+                // Attention: AETE keys (xpr#, cTl#) must be equal in scripting.r, scripting.rc and scripting.c(getAeteKey)!
                 token = OpenReader(array);
                 if (token) {
                         while (PIGetKey(token, &key, &type, &flags)) {
                                 if (key == getAeteKey('R', gdata->standalone ? &gdata->parm : NULL)) {
                                         expr[0] = get_cstring(token);
+                                }
-                                } else if (key == getAeteKey('G', gdata->standalone ? &gdata->parm : NULL)) {
+                                else if (key == getAeteKey('G', gdata->standalone ? &gdata->parm : NULL)) {
                                         expr[1] = get_cstring(token);
+                                }
-                                } else if (key == getAeteKey('B', gdata->standalone ? &gdata->parm : NULL)) {
+                                else if (key == getAeteKey('B', gdata->standalone ? &gdata->parm : NULL)) {
                                         expr[2] = get_cstring(token);
+                                }
-                                } else if (key == getAeteKey('A', gdata->standalone ? &gdata->parm : NULL)) {
+                                else if (key == getAeteKey('A', gdata->standalone ? &gdata->parm : NULL)) {
                                         expr[3] = get_cstring(token);
+                                }
-                                } else {
+                                else {
                                         int i;
-                                        for (i=0; i<=7; ++i) {
+                                        for (i = 0; i <= 7; ++i) {
-                                                if (key == getAeteKey('0'+i, gdata->standalone ? &gdata->parm : NULL)) {
+                                                if (key == getAeteKey('0' + i, gdata->standalone ? &gdata->parm : NULL)) {
                                                         PIGetInt(token, &v);
                                                         slider[i] = v;
                         // all Filter Foundry parameters are optional,
                         // so we needn't worry if any are missing
+                }
                 return gpb->descriptorParameters->playInfo == plugInDialogDisplay ? SCR_SHOW_DIALOG : SCR_HIDE_DIALOG;
+        }
-        } else {
+        else {
                 return SCR_NO_SCRIPT;
+        }
+}
 OSErr WriteScriptParamsOnRead(void)
         OSErr gotErr = noErr;
-        extern int ctls[],maps[],nplanes;
+        extern int ctls[], maps[], nplanes;
-        int i,allctls;
+        int i, allctls;
-        if (DescriptorAvailable(NULL)){ /* recording.  Do our thing. */
+        if (DescriptorAvailable(NULL)) { /* recording.  Do our thing. */
+                // 1. Call openWriteDescriptorProc which will return a PIWriteDescriptor token, such as writeToken.
                 token = OpenWriter();
-                if (token){
+                if (token) {
+                        // 2. Call various Put routines such as PutIntegerProc, PutFloatProc, etc., to add key/value pairs to writeToken. The keys and value types must correspond to those in your terminology resource.
                         // write keys here
-                        if(!gdata->standalone){
+                        if (!gdata->standalone) {
                                 if (nplanes > 0) put_cstring(token, getAeteKey('R', gdata->standalone ? &gdata->parm : NULL), expr[0]);
                                 if (nplanes > 1) put_cstring(token, getAeteKey('G', gdata->standalone ? &gdata->parm : NULL), expr[1]);
                                 if (nplanes > 2) put_cstring(token, getAeteKey('B', gdata->standalone ? &gdata->parm : NULL), expr[2]);
         OSErr err = noErr; // assume no error
         PIDescriptorHandle h = NULL;
         if (procs->descriptor != NULL) // don't need descriptor passed to us
                 hProcs->disposeProc(procs->descriptor); // dispose.
+        // 3. Call CloseWriteDescriptorProc with writeToken, which will create a PIDescriptorHandle.
         procs->writeDescriptorProcs->closeWriteDescriptorProc(*token, &h);
+        // 4. Place the PIDescriptorHandle into the descriptor field. The host will dispose of it when finished.
         procs->descriptor = h;
-        // Set recordInfo to default.  Options are: plugInDialogOptional,
+        // 5. Set recordInfo.  Options are: plugInDialogOptional,
         // plugInDialogRequire, plugInDialogNone:
         procs->recordInfo = plugInDialogOptional;
         *token = NULL;

Subversion Repositories filter_foundry

filter_foundry/trunk/scripting.c – Rev 211 → 217