@sasjs/utils 2.48.2 → 2.49.1

package/macros/mf_loc.sas

@@ -0,0 +1,29 @@
+/**
+  @file
+  @brief Returns physical location of various SAS items
+  @details Returns location of the PlatformObjectFramework tools
+    Usage:
+
+      %put %mf_loc(POF); %*location of PlatformObjectFramework tools;
+
+  @version 9.2
+  @author Allan Bowe
+**/
+
+%macro mf_loc(loc);
+%let loc=%upcase(&loc);
+%local root;
+
+%if &loc=POF or &loc=PLATFORMOBJECTFRAMEWORK %then %do;
+  %let root=%substr(%sysget(SASROOT),1,%index(%sysget(SASROOT),SASFoundation)-2);
+  %let root=&root/SASPlatformObjectFramework/&sysver;
+  %put Batch tools located at: &root;
+  &root
+%end;
+%else %if &loc=VIYACONFIG %then %do;
+  %let root=/opt/sas/viya/config;
+  %put Viya Config located at: &root;
+  &root
+%end;
+
+%mend mf_loc;

package/macros/mf_mkdir.sas

@@ -0,0 +1,67 @@
+/**
+  @file
+  @brief Creates a directory, including any intermediate directories
+  @details Works on windows and unix environments via dcreate function.
+Usage:
+
+    %mf_mkdir(/some/path/name)
+
+
+  @param dir relative or absolute pathname.  Unquoted.
+  @version 9.2
+
+**/
+
+%macro mf_mkdir(dir
+)/*/STORE SOURCE*/;
+
+  %local lastchar child parent;
+
+  %let lastchar = %substr(&dir, %length(&dir));
+  %if (%bquote(&lastchar) eq %str(:)) %then %do;
+    /* Cannot create drive mappings */
+    %return;
+  %end;
+
+  %if (%bquote(&lastchar)=%str(/)) or (%bquote(&lastchar)=%str(\)) %then %do;
+    /* last char is a slash */
+    %if (%length(&dir) eq 1) %then %do;
+      /* one single slash - root location is assumed to exist */
+      %return;
+    %end;
+    %else %do;
+      /* strip last slash */
+      %let dir = %substr(&dir, 1, %length(&dir)-1);
+    %end;
+  %end;
+
+  %if (%sysfunc(fileexist(%bquote(&dir))) = 0) %then %do;
+    /* directory does not exist so prepare to create */
+    /* first get the childmost directory */
+    %let child = %scan(&dir, -1, %str(/\:));
+
+    /*
+      If child name = path name then there are no parents to create. Else
+      they must be recursively scanned.
+    */
+
+    %if (%length(&dir) gt %length(&child)) %then %do;
+      %let parent = %substr(&dir, 1, %length(&dir)-%length(&child));
+      %mf_mkdir(&parent)
+    %end;
+
+    /*
+      Now create the directory.  Complain loudly of any errs.
+    */
+
+    %let dname = %sysfunc(dcreate(&child, &parent));
+    %if (%bquote(&dname) eq ) %then %do;
+      %put %str(ERR)OR: could not create &parent + &child;
+      %abort cancel;
+    %end;
+    %else %do;
+      %put Directory created:  &dir;
+    %end;
+  %end;
+  /* exit quietly if directory did exist.*/
+%mend mf_mkdir;

package/macros/mf_mval.sas

@@ -0,0 +1,19 @@
+/**
+  @file mf_mval.sas
+  @brief Returns a macro variable value if the variable exists
+  @details
+  Use this macro to avoid repetitive use of `%if %symexist(MACVAR) %then`
+  type logic.
+  Usage:
+
+      %if %mf_mval(maynotexist)=itdid %then %do;
+
+  @version 9.2
+  @author Allan Bowe
+**/
+
+%macro mf_mval(var);
+  %if %symexist(&var) %then %do;
+    %superq(&var)
+  %end;
+%mend mf_mval;

package/macros/mf_nobs.sas

@@ -0,0 +1,26 @@
+/**
+  @file
+  @brief Returns number of logical (undeleted) observations.
+  @details Beware - will not work on external database tables!
+  Is just a convenience macro for calling <code> %mf_getattrn()</code>.
+
+        %put Number of observations=%mf_nobs(sashelp.class);
+
+  <h4> SAS Macros </h4>
+  @li mf_getattrn.sas
+
+  @param libds library.dataset
+
+  @return output returns result of the attrn value supplied, or log message
+    if err.
+
+
+  @version 9.2
+  @author Allan Bowe
+
+**/
+
+%macro mf_nobs(libds
+)/*/STORE SOURCE*/;
+  %mf_getattrn(&libds,NLOBS)
+%mend mf_nobs;

package/macros/mf_trimstr.sas

@@ -0,0 +1,50 @@
+/**
+  @file mf_trimstr.sas
+  @brief Removes character(s) from the end, if they exist
+  @details If the designated characters exist at the end of the string, they
+  are removed
+
+        %put %mf_trimstr(/blah/,/); * /blah;
+        %put %mf_trimstr(/blah/,h); * /blah/;
+        %put %mf_trimstr(/blah/,h/);* /bla;
+
+  <h4> SAS Macros </h4>
+
+
+  @param basestr The string to be modified
+  @param trimstr The string to be removed from the end of `basestr`, if it
+    exists
+
+  @return output returns result with the value of `trimstr` removed from the end
+
+
+  @version 9.2
+  @author Allan Bowe
+
+**/
+
+%macro mf_trimstr(basestr,trimstr);
+%local baselen trimlen trimval;
+
+/* return if basestr is shorter than trimstr (or 0) */
+%let baselen=%length(%superq(basestr));
+%let trimlen=%length(%superq(trimstr));
+%if &baselen < &trimlen or &baselen=0 %then %return;
+
+/* obtain the characters from the end of basestr */
+%let trimval=%qsubstr(%superq(basestr)
+  ,%length(%superq(basestr))-&trimlen+1
+  ,&trimlen);
+
+/* compare and if matching, chop it off! */
+%if %superq(basestr)=%superq(trimstr) %then %do;
+  %return;
+%end;
+%else %if %superq(trimval)=%superq(trimstr) %then %do;
+  %qsubstr(%superq(basestr),1,%length(%superq(basestr))-&trimlen)
+%end;
+%else %do;
+  &basestr
+%end;
+
+%mend mf_trimstr;

package/macros/mf_uid.sas

@@ -0,0 +1,21 @@
+/**
+  @file
+  @brief Creates a unique ID based on system time in friendly format
+  @details format = YYYYMMDD_HHMMSSmmm_<sysjobid>_<3randomDigits>
+
+        %put %mf_uid();
+
+  @version 9.3
+  @author Allan Bowe
+
+**/
+
+%macro mf_uid(
+)/*/STORE SOURCE*/;
+  %local today now;
+  %let today=%sysfunc(today(),yymmddn8.);
+  %let now=%sysfunc(compress(%sysfunc(time(),tod12.3),:.));
+
+  &today._&now._&sysjobid._%sysevalf(%sysfunc(ranuni(0))*999,CEIL)
+
+%mend mf_uid;

package/macros/mf_verifymacvars.sas

@@ -0,0 +1,72 @@
+/**
+  @file
+  @brief Checks if a set of macro variables exist AND contain values.
+  @details Writes ERROR to log if abortType is SOFT, else will call %mf_abort.
+  Usage:
+
+      %let var1=x;
+      %let var2=y;
+      %put %mf_verifymacvars(var1 var2);
+
+  Returns:
+  > 1
+
+  <h4> SAS Macros </h4>
+  @li mf_abort.sas
+
+  @param [in] verifyvars Space separated list of macro variable names
+  @param [in] makeupcase= (NO) Set to YES to convert all variable VALUES to
+    uppercase.
+  @param [in] mAbort= (SOFT) Abort Type.  When SOFT, simply writes an err
+    message to the log.
+    Set to any other value to call mf_abort (which can be configured to abort in
+    various fashions according to context).
+
+  @warning will not be able to verify the following variables due to
+    naming clash!
+      - verifyVars
+      - verifyVar
+      - verifyIterator
+      - makeUpcase
+
+  @version 9.2
+  @author Allan Bowe
+
+**/
+
+
+%macro mf_verifymacvars(
+    verifyVars  /* list of macro variable NAMES */
+    ,makeUpcase=NO  /* set to YES to make all the variable VALUES uppercase */
+    ,mAbort=SOFT
+)/*/STORE SOURCE*/;
+
+  %local verifyIterator verifyVar abortmsg;
+  %do verifyIterator=1 %to %sysfunc(countw(&verifyVars,%str( )));
+    %let verifyVar=%qscan(&verifyVars,&verifyIterator,%str( ));
+    %if not %symexist(&verifyvar) %then %do;
+      %let abortmsg= Variable &verifyVar is MISSING;
+      %goto exit_err;
+    %end;
+    %if %length(%trim(&&&verifyVar))=0 %then %do;
+      %let abortmsg= Variable &verifyVar is EMPTY;
+      %goto exit_err;
+    %end;
+    %if &makeupcase=YES %then %do;
+      %let &verifyVar=%upcase(&&&verifyvar);
+    %end;
+  %end;
+
+  %goto exit_success;
+  %exit_err:
+    %put &abortmsg;
+    %mf_abort(iftrue=(&mabort ne SOFT),
+      mac=mf_verifymacvars,
+      msg=%str(&abortmsg)
+    )
+    0
+    %return;
+  %exit_success:
+  1
+
+%mend mf_verifymacvars;

package/macros/mf_wordsinstr1andstr2.sas

@@ -0,0 +1,53 @@
+/**
+  @file
+  @brief Returns words that are in both string 1 and string 2
+  @details  Compares two space separated strings and returns the words that are
+  in both.
+  Usage:
+
+      %put %mf_wordsInStr1andStr2(
+        Str1=blah sss blaaah brah bram boo
+        ,Str2=   blah blaaah brah ssss
+      );
+
+  returns:
+  > blah blaaah brah
+
+  @param str1= string containing words to extract
+  @param str2= used to compare with the extract string
+
+  @warning CASE SENSITIVE!
+
+  @version 9.2
+  @author Allan Bowe
+
+**/
+
+%macro mf_wordsInStr1andStr2(
+  Str1= /* string containing words to extract */
+  ,Str2= /* used to compare with the extract string */
+)/*/STORE SOURCE*/;
+
+%local count_base count_extr i i2 extr_word base_word match outvar;
+%if %length(&str1)=0 or %length(&str2)=0 %then %do;
+  %put base string (str1)= &str1;
+  %put compare string (str2) = &str2;
+  %return;
+%end;
+%let count_base=%sysfunc(countw(&Str2));
+%let count_extr=%sysfunc(countw(&Str1));
+
+%do i=1 %to &count_extr;
+  %let extr_word=%scan(&Str1,&i,%str( ));
+  %let match=0;
+  %do i2=1 %to &count_base;
+    %let base_word=%scan(&Str2,&i2,%str( ));
+    %if &extr_word=&base_word %then %let match=1;
+  %end;
+  %if &match=1 %then %let outvar=&outvar &extr_word;
+%end;
+
+  &outvar
+
+%mend mf_wordsInStr1andStr2;
+

package/macros/mf_wordsinstr1butnotstr2.sas

@@ -0,0 +1,54 @@
+/**
+  @file
+  @brief Returns words that are in string 1 but not in string 2
+  @details  Compares two space separated strings and returns the words that are
+  in the first but not in the second.
+
+  Note - case sensitive!
+
+  Usage:
+
+      %let x= %mf_wordsInStr1ButNotStr2(
+        Str1=blah sss blaaah brah bram boo
+        ,Str2=   blah blaaah brah ssss
+      );
+
+  returns:
+  > sss bram boo
+
+  @param [in] str1= string containing words to extract
+  @param [in] str2= used to compare with the extract string
+
+  @version 9.2
+  @author Allan Bowe
+
+**/
+
+%macro mf_wordsInStr1ButNotStr2(
+  Str1= /* string containing words to extract */
+  ,Str2= /* used to compare with the extract string */
+)/*/STORE SOURCE*/;
+
+%local count_base count_extr i i2 extr_word base_word match outvar;
+%if %length(&str1)=0 or %length(&str2)=0 %then %do;
+  %put base string (str1)= &str1;
+  %put compare string (str2) = &str2;
+  %return;
+%end;
+%let count_base=%sysfunc(countw(&Str2));
+%let count_extr=%sysfunc(countw(&Str1));
+
+%do i=1 %to &count_extr;
+  %let extr_word=%scan(&Str1,&i,%str( ));
+  %let match=0;
+  %do i2=1 %to &count_base;
+    %let base_word=%scan(&Str2,&i2,%str( ));
+    %if &extr_word=&base_word %then %let match=1;
+  %end;
+  %if &match=0 %then %let outvar=&outvar &extr_word;
+%end;
+
+  &outvar
+
+%mend mf_wordsInStr1ButNotStr2;
+

package/macros/mf_writefile.sas

@@ -0,0 +1,67 @@
+/**
+  @file
+  @brief Creates a text file using pure macro
+  @details Creates a text file of up to 10 lines.  If further lines are
+    desired, feel free to [create an issue](
+    https://github.com/sasjs/core/issues/new), or make a pull request!
+
+    The use of PARMBUFF was considered for this macro, but it would have made
+    things problematic for writing lines containing commas.
+
+    Usage:
+
+        %mf_writefile(&sasjswork/myfile.txt,l1=some content,l2=more content)
+        data _null_;
+          infile "&sasjswork/myfile.txt";
+          input;
+          list;
+        run;
+
+  @param [in] fpath Full path to file to be created or appended to
+  @param [in] mode= (O) Available options are A or O as follows:
+    @li A APPEND mode, writes new records after the current end of the file.
+    @li O OUTPUT mode, writes new records from the beginning of the file.
+  @param [in] l1= First line
+  @param [in] l2= Second line (etc through to l10)
+
+  <h4> Related Macros </h4>
+  @li mf_writefile.test.sas
+
+  @version 9.2
+  @author Allan Bowe
+**/
+/** @cond */
+
+%macro mf_writefile(fpath,mode=O,l1=,l2=,l3=,l4=,l5=,l6=,l7=,l8=,l9=,l10=
+)/*/STORE SOURCE*/;
+%local fref rc fid i total_lines;
+
+/* find number of lines by reference to first non-blank param */
+%do i=10 %to 1 %by -1;
+  %if %str(&&l&i) ne %str() %then %goto continue;
+%end;
+%continue:
+%let total_lines=&i;
+
+%if %sysfunc(filename(fref,&fpath)) ne 0 %then %do;
+  %put &=fref &=fpath;
+  %put %str(ERR)OR: %sysfunc(sysmsg());
+  %return;
+%end;
+
+%let fid=%sysfunc(fopen(&fref,&mode));
+
+%if &fid=0 %then %do;
+  %put %str(ERR)OR: %sysfunc(sysmsg());
+  %return;
+%end;
+
+%do i=1 %to &total_lines;
+  %let rc=%sysfunc(fput(&fid, &&l&i));
+  %let rc=%sysfunc(fwrite(&fid));
+%end;
+%let rc=%sysfunc(fclose(&fid));
+%let rc=%sysfunc(filename(&fref));
+
+%mend mf_writefile;
+/** @endcond */