_scanheader.sas

Go to the documentation of this file.

%MACRO _scanHeader (MacroName   = 
                           ,FilePath    = 
                           ,LibOutDoc   = WORK
                           ,DataOutDoc  = _ProgramHeader 
                           ,LibOutPgm   = WORK
                           ,DataOutPgm  = _ProgramCode
                           ,LibOutToDo  = WORK
                           ,DataOutToDo = _ToDoDoc
                           ,LibOutTest  = WORK
                           ,DataOutTest = _TestDoc
                           ,LibOutBug   = WORK
                           ,DataOutBug  = _BugDoc
                           ,i_language  = EN
                            );

   %LOCAL l_sHeaderStartTag l_sHeaderEndTag;
   %LET l_sHeaderStartTag       = %str(/)%str(** );
   %LET l_sHeaderEndTag         = %str(*)%str(/);

   Data WORK.__programHeader (keep=macroname tag name description);
      Length macroname $80
             tag $20
             name $100
             description $1000
             headerStmtOpen tagStmtOpen 8;
      Retain headerStmtOpen tagStmtOpen 0 
             tag name;

      ***Compile Perl RegEx with PRXPARSE;
      patternAuthor     = PRXPARSE("/^\\author/");
      patternBrief      = PRXPARSE("/^\\brief/");
      patternCopyright  = PRXPARSE("/^\\copyright/");
      patternDate       = PRXPARSE("/^\\date/");
      patternDetails    = PRXPARSE("/^\\details/");
      patternFile       = PRXPARSE("/^\\file/");
      patternInGroup    = PRXPARSE("/^\\ingroup/");
      patternLink       = PRXPARSE("/^\\link/");
      patternParam      = PRXPARSE("/^\\param/");
      patternReturn     = PRXPARSE("/^\\return/");
      patternRet_Val    = PRXPARSE("/^\\ret_val/");
      patternSa         = PRXPARSE("/^\\sa/");
      patternTodo       = PRXPARSE("/^\\todo/");
      patternTest       = PRXPARSE("/^\\test/");
      patternBug        = PRXPARSE("/^\\bug/");
      patternRemark     = PRXPARSE("/^\\remark/");
      patternVersion    = PRXPARSE("/^\\version/");

      pattern           = "/^\\author|\\brief|\\copyright|\\date|\\details|\\file|\\ingroup|\\link|\\param|\\return|\\ret_val|\\sa|\\todo|\\test|\\bug|\\version|\\remark/";
      patternTag        = PRXPARSE(pattern);
      patternComment    = PRXPARSE("/\*\//");
              
      ***Input File;
      Infile "&FilePath.\&MacroName.";
      Input;

      *** MacroName for lists (todo, test, bug) ***;
      macroname = "&MacroName.";

      l_zeile     = compbl (left (_INFILE_));

      ***Leerzeile;
      if (compress(l_zeile) = "") then do;
         ***reset variables;
         tag         = "";
         name        = "";
         description = "";
         tagStmtOpen = 0;
      end;

      ***Stop scanning if sHeaderStartEnd is found;
      If (index(_INFILE_,  "&l_sHeaderEndTag")>0) Then DO;
         HeaderStmtOpen = 0;
      End; 

      ***Check for tag with more than one line;
      If((tagStmtOpen = 1 AND PRXMATCH(patternTag, l_zeile) = 1) OR PRXMATCH(patternComment, l_zeile) = 1) Then Do;
         tagStmtOpen = 0;
         if (PRXMATCH(patternComment, l_zeile) = 1) then do;
            ***reset variables;
            tag         = "";
            name        = "";
            description = "";
         end;
      End;

      ***Start Scanning if sHeaderStartTag is found;
      If (index(l_zeile, "&l_sHeaderStartTag")>0) Then Do;
         headerStmtOpen = 1;
         tagPos = Index(l_zeile, "&l_sHeaderStartTag");
         l_zeile = Strip(substr(l_zeile, tagPos + length("&l_sHeaderStartTag")));
      End;

      If (headerStmtOpen = 1) Then Do;
         ***Only Tag on single line: \file;
         If (PRXMATCH(patternFile, l_zeile) = 1) Then Do;
            ***reset variables;
            tag         = "";
            name        = "";
            description = "";
            blankPos    = Index(l_zeile, ' ');   
            tag         = Substr(l_zeile, 1, blankPos);
            name        = "";
            description = "";
         End;
         ***Complex tags with more than one line, 2 columns;
         Else If (PRXMATCH(patternBrief, l_zeile)     = 1 OR
                  PRXMATCH(patternCopyright, l_zeile) = 1 OR
                  PRXMATCH(patternDetails, l_zeile)   = 1 OR
                  PRXMATCH(patternSa, l_zeile)        = 1 OR
                  PRXMATCH(patternTodo, l_zeile)      = 1 OR
                  PRXMATCH(patternTest, l_zeile)      = 1 OR
                  PRXMATCH(patternBug, l_zeile)       = 1 OR
                  PRXMATCH(patternReturn, l_zeile)    = 1 OR
                  PRXMATCH(patternRemark, l_zeile)    = 1 OR
                  PRXMATCH(patternVersion, l_zeile)   = 1 OR
                  PRXMATCH(patternInGroup, l_zeile)   = 1 OR 
                  PRXMATCH(patternAuthor, l_zeile)    = 1 OR
                  PRXMATCH(patternDate, l_zeile)      = 1) Then Do;
            ***reset variables;
            tag         = "";
            name        = "";
            description = "";
            tagStmtOpen = 1;
            blankPos = Index(l_zeile, ' ');   
            tag = Substr(l_zeile, 1, blankPos);
            l_zeile = Substr(l_zeile, blankPos+1);
            description = Strip(l_zeile);
         End;
         ***Complex tags with name and more than one line, 3 columns;
         Else If (PRXMATCH(patternParam,   l_zeile)   = 1 OR
                  PRXMATCH(patternRet_val, l_zeile)   = 1
                 )  Then Do;
            ***reset variables;
            tag         = "";
            name        = "";
            description = "";
            tagStmtOpen = 1;
            blankPos = Index(l_zeile, ' ');   
            tag = Substr(l_zeile, 1, blankPos);
            l_zeile = Substr(l_zeile, blankPos+1);
            blankPos = Index(l_zeile, ' ');              
            name = Substr(l_zeile, 1, blankPos);
            l_zeile = Substr(l_zeile, blankPos+1);
            description = Strip(l_zeile);
         End;
         Else If (tagStmtOpen) then do;
            description = Strip(l_zeile);
         End;
      End;
   Run;

   data  WORK.__programHeader;
      length new_description $3200;
      set WORK.__programHeader (where=(not missing(tag)));
      obs_sort = _N_;
      tag_sort = put (tag, $TagSort.);
      tag_text = put (tag, $HeaderText_&i_language..);
      dummy = "   ";
      new_description = tranwrd (description, "<b>", "^{style [font_weight=bold]");
      new_description = tranwrd (new_description, "</b>", "}");
      new_description = tranwrd (new_description, "<em>", "^{style [font_style=italic]");
      new_description = tranwrd (new_description, "</em>", "}");
      new_description = tranwrd (new_description, "\n", "^n");
      new_description = tranwrd (new_description, "~ ", "- ");
      new_description = tranwrd (new_description, "~", "^_^_^_");
   run;

   proc sort data=WORK.__programHeader;
      by tag_sort obs_sort;
   run;

   proc append base=&LibOutTodo..&DataOutTodo. data=WORK.__programHeader (where=(tag="\todo"));
   run;

   proc append base=&LibOutTest..&DataOutTest. data=WORK.__programHeader (where=(tag="\test"));
   run;

   proc append base=&LibOutBug..&DataOutBug.   data=WORK.__programHeader (where=(tag="\bug"));
   run;

   data &LibOutDoc..&DataOutDoc.;
      set WORK.__programHeader;
      if (tag="\todo") then do;
         new_description ="^{style [background=Bisque] " !! trim (new_description) !! "}";
      end;
      if (tag="\test") then do;
         new_description ="^{style [background=LightBlue] " !! trim (new_description) !! "}";
      end;
      if (tag="\bug") then do;
         new_description ="^{style [background=LightCoral] " !! trim (new_description) !! "}";
      end;
      if (tag="\remark") then do;
         new_description ="^{style [background=LightGreen] " !! trim (new_description) !! "}";
      end;
   run;
%MEND _scanHeader;