rom/dos/scanvars.c

   1 /*
   2     Copyright © 1995-2013, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: English
   7 */
   8
   9 #include <aros/debug.h>
  10
  11 #include "dos_intern.h"
  12 #include <proto/utility.h>
  13 #include <exec/lists.h>
  14 #include <dos/var.h>
  15
  16 /*****************************************************************************
  17
  18         NAME */
  19 #include <proto/dos.h>
  20
  21         AROS_LH3(LONG, ScanVars,
  22
  23 /*  SYNOPSIS */
  24         AROS_LHA(struct Hook *, hook, D1),
  25         AROS_LHA(ULONG,          flags, D2),
  26         AROS_LHA(APTR,           userdata, D3),
  27
  28 /*  LOCATION */
  29         struct DosLibrary *, DOSBase, 169, Dos)
  30
  31 /*  FUNCTION
  32         Scan local and/or global variables accordingly to specified flags. For
  33         each scanned variable hook function is called. Scanning process will
  34         continue as long as hook returns 0. If hook returns a non-zero value,
  35         scanning will be aborted and ScanVars will return this value.
  36
  37     INPUTS
  38         userdata - Any user-specific data passed to hook function.
  39         flags - Same as in GetVar().
  40         hook - Hook function that will be called for each scanned variable as:
  41                result = hook_function(hook,userdata,message) with ScanVarsMsg
  42                structure as message parameter containing information about given
  43                variable.
  44
  45     RESULT
  46         !=0 returned by hook function if scan process was aborted, 0 otherwise.
  47
  48     NOTES
  49         ScanVarsMsg structure content is valid only during hook call.
  50         See <dos/var.h> for description of ScanVarsMsg structure.
  51
  52         This function is compatible with AmigaOS v4.
  53
  54     EXAMPLE
  55
  56     BUGS
  57         Currently only local variables scanning is implemented.
  58
  59     SEE ALSO
  60         DeleteVar(), FindVar(), GetVar(), SetVar(), <dos/var.h>
  61
  62     INTERNALS
  63
  64 *****************************************************************************/
  65 {
  66         AROS_LIBFUNC_INIT
  67
  68         /* We scan through the process->pr_LocalVars list */
  69         struct Process  *pr;
  70         struct LocalVar *var;
  71         struct ScanVarsMsg msg;
  72         LONG res;
  73
  74         msg.sv_SVMSize = sizeof(struct ScanVarsMsg);
  75         msg.sv_Flags = flags;
  76         pr  = (struct Process *)FindTask(NULL);
  77
  78         ASSERT_VALID_PROCESS(pr);
  79
  80         /* not global only? */
  81         if(0 == (flags & GVF_GLOBAL_ONLY))
  82         {
  83                 var = (struct LocalVar *)pr->pr_LocalVars.mlh_Head;
  84
  85                 ForeachNode(&pr->pr_LocalVars, var)
  86                 {
  87                         if (var->lv_Node.ln_Type == LV_VAR)
  88                         {
  89                                 msg.sv_Name = var->lv_Node.ln_Name;
  90                                 msg.sv_Var = var->lv_Value;
  91                                 msg.sv_VarLen = var->lv_Len;
  92                                 msg.sv_GDir = "";
  93                                 res = CallHookPkt(hook, userdata, &msg);
  94                                 if(res != 0)
  95                                         return(res);
  96                         }
  97                 }
  98         }
  99         return 0;
 100
 101     AROS_LIBFUNC_EXIT
 102 }