SCM

SCM Repository

[inlinedocs] Diff of /pkg/inlinedocs/R/parsers.R
ViewVC logotype

Diff of /pkg/inlinedocs/R/parsers.R

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 246, Thu Apr 7 13:21:39 2011 UTC revision 302, Tue Jul 12 12:06:42 2011 UTC
# Line 20  Line 20 
20  ### A list, same type as x, but with added elements from y.  ### A list, same type as x, but with added elements from y.
21  }  }
22    
23    
24    getSource <- function
25    ### Extract a function's source code.
26    (fun.obj
27    ### A function.
28     ) {
29          srcref <- attr(fun.obj, "srcref")
30          if (!is.null(srcref)) unlist(strsplit(as.character(srcref), "\n"))
31          else attr(fun.obj, "source")
32    ### Source code lines as a character vector.
33    }
34    
35  ### Prefix for code comments used with grep and gsub.  ### Prefix for code comments used with grep and gsub.
36  prefix <- "^[ \t]*###[ \t]"  prefix <- "^[ \t]*###[ \t]*"
37    
38  decomment <- function  decomment <- function
39  ### Remove comment prefix and join lines of code to form a  ### Remove comment prefix and join lines of code to form a
# Line 46  Line 58 
58   ){   ){
59    FUN <- FUN    FUN <- FUN
60    f <- function(objs,docs,...){    f <- function(objs,docs,...){
61        if(length(objs)==0)return(list())
62      objs <- objs[sapply(objs,subfun)]      objs <- objs[sapply(objs,subfun)]
63      L <- list()      L <- list()
64      on.exit(cat(sprintf("Parser Function failed on %s\n",N)))      on.exit(cat(sprintf("Parser Function failed on %s\n",N)))
65      for(N in union(names(docs),names(objs))){      for(N in union(names(docs),names(objs))){
66        o <- objs[[N]]        o <- objs[[N]]
67        L[[N]] <- FUN(src=attr(o,"source"),        L[[N]] <- FUN(src=getSource(o),
68                      name=N,objs=objs,o=o,docs=docs,doc=docs[[N]],...)                      name=N,objs=objs,o=o,docs=docs,doc=docs[[N]],...)
69      }      }
70      on.exit()## remove warning message      on.exit()## remove warning message
# Line 89  Line 102 
102  ### Character vector of code lines with preceding whitespace removed.  ### Character vector of code lines with preceding whitespace removed.
103  }  }
104    
 examples.after.return <- function  
 ### Get examples from inline definitions after return()  
 ### PhG: this does not work well! Think of these situations:  
 ### 1) You have multiple return() in the code of your function,  
 ### 2) You have return() appearing is some example code, ...  
 ### I can hardly propose a hack here. The whole code of the function  
 ### must be parsed, and one must determine which one is the last line  
 ### of code that is actually executed.  
 ###  
 ### I make two propositions here  
 ### 1) to keep the same mechanism that has the advantage of simplicity  
 ###    but to use a special tag  
 ###    ##examples<< or #{{{examples to separate  
 ###    function code from examples explicitly, and  
 ### 2) to place the example in an "ex" attribute  
 ###    attached to the function  
 ###    (see next parser). That solution will be also interesting for  
 ###    documenting datasets, something not done yet by inlinedocs!  
 (src,name="",...) {  
   ## Look for the examples mark  
   m <- grep("^\\s*(##examples<<|#\\{\\{\\{examples)", src)  
   if (!length(m)) return(list())  
   if (length(m) > 1)  
     warning("More than one examples tag for ", name,  
             ". Taking the last one")  
   m <- m[length(m)]  
   ## Look for the lines containing return value comments just before  
   r <- grep("\\s*### ", src[1:(m-1)])  
     if (!length(r)) {  
       value <- NULL  
     } else {  
       ## Only take consecutive lines before the mark  
       keep <- rev((m - rev(r)) == 1:length(r))  
       if (!any(keep)) {  
         value <- NULL  
       } else {  
         value <- decomment(src[r[keep]])  
       }  
     }  
   ## Collect now the example code beneath the mark  
   ex <- src[(m + 1):(length(src) - 1)]  
   ## Possibly eliminate a #}}} tag  
   ex <- ex[!grepl("#}}}", ex)]  
   ## Eliminate leading tabulations or four spaces  
   ex <- kill.prefix.whitespace(ex)  
   ## Add an empty line before and after example  
   ex <- c("", ex, "")  
   ## Return examples and value  
   list(examples = ex, value = value)  
 }  
   
105  prefixed.lines <- structure(function(src,...){  prefixed.lines <- structure(function(src,...){
106  ### The primary mechanism of inline documentation is via consecutive  ### The primary mechanism of inline documentation is via consecutive
107  ### groups of lines matching the specified prefix regular expression  ### groups of lines matching the specified prefix regular expression
# Line 196  Line 158 
158  ### the return value  ### the return value
159  ##seealso<< foobar  ##seealso<< foobar
160  }  }
161  src <- attr(test,"source")  src <- getSource(test)
162  prefixed.lines(src)  prefixed.lines(src)
163  extract.xxx.chunks(src)  extract.xxx.chunks(src)
164  })  })
# Line 484  Line 446 
446  ### individual object.  ### individual object.
447  forfun.parsers <-  forfun.parsers <-
448    list(prefixed.lines=prefixed.lines,    list(prefixed.lines=prefixed.lines,
        examples.after.return=examples.after.return,  
449         extract.xxx.chunks=extract.xxx.chunks,         extract.xxx.chunks=extract.xxx.chunks,
450         ## title from first line of function def         ## title from first line of function def
451         title.from.firstline=function(src,...){         title.from.firstline=function(src,...){
# Line 534  Line 495 
495             ## Special case for code contained in a function             ## Special case for code contained in a function
496             if (inherits(ex, "function")) {             if (inherits(ex, "function")) {
497               ## If source is available, start from there               ## If source is available, start from there
498               src <- attr(ex, "source")               src <- getSource(ex)
499               if (!is.null(src)) {               if (!is.null(src)) {
500                 ex <- src                 ex <- src
501               } else { ## Use the body of the function               } else { ## Use the body of the function
# Line 571  Line 532 
532           sum=x+y) ##<< their sum           sum=x+y) ##<< their sum
533      ##end<<      ##end<<
534    }    }
535    src <- attr(f,"source")    src <- getSource(f)
536    lonely$extract.xxx.chunks(src)    lonely$extract.xxx.chunks(src)
537    lonely$prefixed.lines(src)    lonely$prefixed.lines(src)
538  })  })
# Line 629  Line 590 
590      } else if(0 == length(res) && inherits(objs[[on]],"standardGeneric")){      } else if(0 == length(res) && inherits(objs[[on]],"standardGeneric")){
591        NULL        NULL
592      } else if(0 == length(res) && "function" %in% class(o)      } else if(0 == length(res) && "function" %in% class(o)
593                && 1 == length(osource <- attr(o,"source"))                && 1 == length(osource <- getSource(o))
594                && grepl(paste("UseMethod(",on,")",sep="\""),osource)                && grepl(paste("UseMethod(",on,")",sep="\""),osource)
595                ){                ){
596        ## phew - this should only pick up R.oo S3 generic definitions like:        ## phew - this should only pick up R.oo S3 generic definitions like:
# Line 895  Line 856 
856    old <- options(keep.source=TRUE,topLevelEnvironment=e)    old <- options(keep.source=TRUE,topLevelEnvironment=e)
857    on.exit(options(old))    on.exit(options(old))
858    exprs <- parse(text=code)    exprs <- parse(text=code)
859      ## TDH 2011-04-07 set this so that no warnings about creating a fake
860      ## package when we try to process S4 classes defined in code
861      e$.packageName <- "inlinedocs.processor"
862    for (i in exprs){    for (i in exprs){
863      tryCatch(eval(i, e),error=function(e){      ## TDH 2011-04-07 Disable this tryCatch since it makes it harder
864        ##to debug errors/warnings in the evaluated code
865    
866        ##tryCatch({
867          eval(i, e)
868        ##},error=function(e){
869        ##print(e)        ##print(e)
870      })      ##})
871    }    }
872    objs <- sapply(ls(e),get,e,simplify=FALSE)    objs <- sapply(ls(e),get,e,simplify=FALSE)
873    
# Line 954  Line 923 
923    apply.parsers(readLines(f),parsers,verbose=FALSE,...)    apply.parsers(readLines(f),parsers,verbose=FALSE,...)
924  },ex=function(){  },ex=function(){
925    f <- system.file("silly","R","silly.R",package="inlinedocs")    f <- system.file("silly","R","silly.R",package="inlinedocs")
926    extract.docs.file(f) ##FIXME: warning    extract.docs.file(f)
927  })  })
928    

Legend:
Removed from v.246  
changed lines
  Added in v.302

root@r-forge.r-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business Powered By FusionForge