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 87, Sat May 1 12:21:27 2010 UTC revision 116, Fri Jun 18 15:33:07 2010 UTC
# Line 1  Line 1 
1    ### combine lists or character strings
2    combine <- function(x,y)UseMethod("combine")
3    
4    ### combine character strings by pasting them together
5    combine.character <- function(x,y)
6        paste(x,y,sep="\n")
7    
8    ### combine lists by adding elements or adding to existing elements
9    combine.list <- function(x,y){
10      toadd <- !names(y)%in%names(x)
11      toup <- names(y)[names(y)%in%names(x)]
12      x[names(y)[toadd]] <- y[toadd]
13      for(up in toup)x[[up]] <- combine(x[[up]],y[[up]])
14      return(x)
15    ### A list, same type as x, but with added elements from y.
16    }
17    
18    ### Prefix for code comments used with grep and gsub.
19    prefix <- "^[ \t]*###[ \t]"
20    
21    decomment <- function
22    ### Remove comment prefix and join lines of code to form a
23    ### documentation string.
24    (comments
25    ### Character vector of prefixed comment lines.
26     ){
27      paste(gsub(prefix,"",comments),collapse="\n")
28    ### String without prefixes or newlines.
29    }
30    
31  ### For each object in the package that satisfies the criterion  ### For each object in the package that satisfies the criterion
32  ### checked by subfun, parse source using FUN and return the resulting  ### checked by subfun, parse source using FUN and return the resulting
33  ### documentation list.  ### documentation list.
# Line 12  Line 42 
42    function(objs,docs,...){    function(objs,docs,...){
43      objs <- objs[sapply(objs,subfun)]      objs <- objs[sapply(objs,subfun)]
44      L <- list()      L <- list()
45      for(N in names(objs)){      for(N in names(docs)){
46        o <- objs[[N]]        o <- objs[[N]]
47        L[[N]] <- FUN(src=attr(o,"source"),name=N,objs=objs,o=o,docs=docs,doc=docs[[N]],...)        L[[N]] <- FUN(src=attr(o,"source"),
48                        name=N,objs=objs,o=o,docs=docs,doc=docs[[N]],...)
49      }      }
50      L      L
51    }    }
# Line 24  Line 55 
55  ### For each function in the package, do something.  ### For each function in the package, do something.
56  forfun <- function(FUN)forall(FUN,is.function)  forfun <- function(FUN)forall(FUN,is.function)
57    
58  ### Get last line (test)  ### Parsers for each object/function that are constructed
59  parsefuns <- forfun(function(src,name,...){  ### automatically. This is a named list, each element is a list of 2
60    ### elements: forfun/forall, then a parser function for an individual
61    ### object.
62    forall.parsers <-
63      list(## Extract lots of info from normal functions.
64           parsefun=list(forfun,function(src,name,...){
65    extract.docs.fun(src,name)    extract.docs.fun(src,name)
66  })         }),
67           ## Fill in author from DESCRIPTION and titles.
68  ### Fill in author from DESCRIPTION and titles.         author.from.description=list(forall,function(desc,...){
 author.from.description <- forall(function(desc,...){  
69    list(author=desc[,"Maintainer"])    list(author=desc[,"Maintainer"])
70  })         }),
71           ## The format section sometimes causes problems, so erase it.
72  ### The format section sometimes causes problems, so erase it.         erase.format=list(forall,function(...){
 erase.format <- forall(function(...){  
73    list(format="")    list(format="")
74  })         }),
75           ## Convert the function name to a title.
76  ### Convert the function name to a title.         title.from.name=list(forall,function(name,doc,...){
77  title.from.name <- forall(function(name,...){           if("title"%in%names(doc))list() else
78    list(title=gsub("[._]"," ",name))    list(title=gsub("[._]"," ",name))
79  })         }),
80           ## PhG: it is tests/FUN.R!!! I would like more flexibility here
81  ### Get examples for FUN from the file test/FUN.R         ## please, let me choose which dir to use for examples!
82  examples.from.testfile <- forfun(function(name,...){         ## Get examples for FUN from the file tests/FUN.R
83    tfile <- file.path("..","tests",paste(name,".R",sep=""))         examples.from.testfile=list(forfun,function(name,...){
84             tsubdir <- getOption("inlinedocs.exdir")
85             if (is.null(tsubdir)) tsubdir <- "tests"       # Default value
86             tfile <- file.path("..",tsubdir,paste(name,".R",sep=""))
87    if(file.exists(tfile))    if(file.exists(tfile))
88      list(examples=paste(readLines(tfile),collapse="\n"))      list(examples=paste(readLines(tfile),collapse="\n"))
89    else list()    else list()
90  })         }),
91           ## Get examples from inline definitions after return()
92  ### Get examples from inline definitions after return()         ## PhG: this does not work well! Think of these situations:
93  examples.after.return <- forfun(function(src,...){         ## 1) You have multiple return() in the code of your function,
94    rline <- grep("return([^)]*)",src)         ## 2) You have return() appearing is some example code, ...
95    if(length(rline)==0)return(list())         ## I can hardly propose a hack here. The whole code of the function
96    rline <- rline[length(rline)]         ## must be parsed, and one must determine which one is the last line
97    comment.line.nums <- grep(prefix,src)         ## of code that is actually executed.
98    if(!(comment.end <- rline+1)%in%comment.line.nums)return(list())         ##
99    while(comment.end%in%comment.line.nums)comment.end <- comment.end+1         ## I make two propositions here
100    excode <- src[comment.end:(length(src)-1)]         ## 1) to keep the same mechanism that has the advantage of simplicity
101    list(examples=paste(gsub("^\\W*","",excode),collapse="\n"))         ##    but to use a special tag
102  })         ##examples<< or #{{{examples to separate
103           ##    function code from examples explicitly, and
104           ## 2) to place the example in an "ex" attribute
105           ##    attached to the function
106           ##    (see next parser). That solution will be also interesting for
107           ##    documenting datasets, something not done yet by inlinedocs!
108           examples.after.return = list(forfun, function(name, src, ...) {
109             ## Look for the examples mark
110             m <- grep("##examples<<|#\\{\\{\\{examples", src)
111             if (!length(m)) return(list())
112             if (length(m) > 1)
113               warning("More than one examples tag for ", name,
114                       ". Taking the last one")
115             m <- m[length(m)]
116             ## Look for the lines containing return value comments just before
117             r <- grep("\\s*### ", src[1:(m-1)])
118               if (!length(r)) {
119                 value <- NULL
120               } else {
121                 ## Only take consecutive lines before the mark
122                 keep <- rev((m - rev(r)) == 1:length(r))
123                 if (!any(keep)) {
124                   value <- NULL
125                 } else {
126                   value <- decomment(src[r[keep]])
127                 }
128               }
129             ## Collect now the example code beneath the mark
130             ex <- src[(m + 1):(length(src) - 1)]
131             ## Possibly eliminate a #}}} tag
132             ex <- ex[!grepl("#}}}", ex)]
133             ## Eliminate leading tabulations or four spaces
134             prefixes <- gsub("(\\s*).*","\\1",ex,perl=TRUE)[grep("\\w",ex)]
135             FIND <- prefixes[which.min(nchar(prefixes))]
136             ex <- sub(FIND,"",ex)
137             ## Add an empty line before and after example
138             ex <- c("", ex, "")
139             ## Return examples and value
140             list(examples = paste(ex, collapse = "\n"), value = value)
141           }),
142           ## PhG: here is what I propose for examples code in the 'ex' attribute
143           examples.in.attr = list(forfun, function (name, o, ...) {
144             ex <- attr(o, "ex")
145             if (!is.null(ex)) {
146               ## Special case for code contained in a function
147               if (inherits(ex, "function")) {
148                 ## If source is available, start from there
149                 src <- attr(ex, "source")
150                 if (!is.null(src)) {
151                   ex <- src
152                 } else { ## Use the body of the function
153                   ex <- deparse(body(ex))
154                 }
155                 ## Eliminate leading and trailing code
156                 ex <- ex[-c(1, length(ex))]
157                 ## Eliminate leading tabulations or four spaces
158                 ex <- sub("^\t|    ", "", ex)
159                 ## Add an empty line before and after example
160                 ex <- c("", ex, "")
161               }
162               list(examples = paste(ex, collapse = "\n"))
163             } else list()
164           }))
165    
166    ### List of parser functions that operate on single objects. This list
167    ### is useful for testing these functions, ie
168    ### lonely$parsefun(attr(extract.docs.file,"source"),"extract.docs.file")
169    lonely <- sapply(forall.parsers,function(L)L[[2]])
170    
171  extract.docs.file <- function # Extract documentation from a file  extra.code.docs <- function # Extract documentation from code chunks
172  ### Parse R code to extract inline documentation from comments around  ### Parse R code to extract inline documentation from comments around
173  ### each function. These are not able to be retreived simply by  ### each function. These are not able to be retreived simply by
174  ### looking at the "source" attribute. This is a Parser Function that  ### looking at the "source" attribute. This is a Parser Function that
175  ### can be used in the parser list of package.skeleton.dx().  ### can be used in the parser list of package.skeleton.dx(). TODO:
176    ### Modularize this into separate Parsers Functions for S4 classes,
177    ### prefixes, ##<<blocks, etc. Right now it is not very clean!
178  (code,  (code,
179  ### Code lines in a character vector containing multiple R objects to  ### Code lines in a character vector containing multiple R objects to
180  ### parse for documentation.  ### parse for documentation.
# Line 91  Line 197 
197            doc$description <- parsed[[on]]@description            doc$description <- parsed[[on]]@description
198          }          }
199          if ( "setMethodS3" == parsed[[on]]@created ){          if ( "setMethodS3" == parsed[[on]]@created ){
200              # PhG: this may be wrong! It does not catch correctly how the method
201                      # must be splitted in case of methods containing dots. for instance,
202                      # as.data.frame.matrix must be split into: m1 = as.data.frame and
203                      # m2 = matrix... here you got m1 = as, and m2 = data.frame.matrix!!!
204            pattern <- "^([^\\.]+)\\.(.*)$"            pattern <- "^([^\\.]+)\\.(.*)$"
205            doc$s3method=c(m1 <- gsub(pattern,"\\1",on,perl=TRUE),            doc$s3method=c(m1 <- gsub(pattern,"\\1",on,perl=TRUE),
206                m2 <- gsub(pattern,"\\2",on,perl=TRUE))                m2 <- gsub(pattern,"\\2",on,perl=TRUE))
# Line 175  Line 285 
285  ### named list of lists, one for each object to document.  ### named list of lists, one for each object to document.
286  }  }
287    
288  ### Default parsers to use with package.skeleton.dx  ### List of parsers to use by default with package.skeleton.dx.
289  default.parsers <- list("parsefuns","extract.docs.file",  default.parsers <-
290                          "examples.after.return","examples.from.testfile",    c(extra.code.docs=extra.code.docs,
291                          "author.from.description","erase.format","title.from.name")      sapply(forall.parsers,function(L)L[[1]](L[[2]])),
292        edit.package.file=function(desc,...){
293          in.details <- setdiff(colnames(desc),"Description")
294          details <- paste(paste(in.details,": \\tab ",desc[,in.details],"\\cr",
295                                 sep=""),collapse="\n")
296          L <-
297            list(list(title=desc[,"Title"],
298                      description=desc[,"Description"],
299                      `tabular{ll}`=details,
300                      author=desc[,"Maintainer"]))
301          names(L) <- paste(desc[,"Package"],"-package",sep="")
302          L
303        })
304    
305  extract.docs.fun <- function # Extract documentation from a function  extract.docs.fun <- function # Extract documentation from a function
306  ### Given source code of a function, return a list describing inline  ### Given source code of a function, return a list describing inline
# Line 187  Line 309 
309  ### The function to examine.  ### The function to examine.
310   name.fun   name.fun
311  ### The name of the function/chunk to use in warning messages.  ### The name of the function/chunk to use in warning messages.
312   )   ){
 {  
313    res <- list()    res <- list()
314    clines <- grep(prefix,code)    clines <- grep(prefix,code)
315    if(length(grep("#",code[1]))){    if(length(grep("#",code[1]))){
# Line 407  Line 528 
528        arg <- gsub(arg.pat,"\\\\item\\{\\1\\}",line,perl=TRUE)        arg <- gsub(arg.pat,"\\\\item\\{\\1\\}",line,perl=TRUE)
529        in.chunk <- TRUE        in.chunk <- TRUE
530        if ( not.describe ){        if ( not.describe ){
531            ## TDH 2010-06-18 For item{}s in the documentation list names,
532            ## we don't need to have a backslash before, so delete it.
533            arg <- gsub("^[\\]+","",arg)
534          cur.field <- gsub("...","\\dots",arg,fix=TRUE) ##special case for dots          cur.field <- gsub("...","\\dots",arg,fix=TRUE) ##special case for dots
535          payload <- comment          payload <- comment
536        } else {        } else {
# Line 574  Line 698 
698  ### Using the same conventions as for functions, definitions of S4 classes  ### Using the same conventions as for functions, definitions of S4 classes
699  ### in the form \code{setClass("classname",\dots)} are also located and  ### in the form \code{setClass("classname",\dots)} are also located and
700  ### scanned for inline comments.  ### scanned for inline comments.
701  (doc.link)  (doc.link
702  ### DocLink object as created by \code{\link{extract.file.parse}}.  ### DocLink object as created by \code{\link{extract.file.parse}}.
703  ### Note that \code{source} statements are \emph{ignored} when scanning for  ### Note that \code{source} statements are \emph{ignored} when scanning for
704  ### class definitions.  ### class definitions.
705  {   ){
706    chunk.source <- doc.link@code    chunk.source <- doc.link@code
707    ##details<<    ##details<<
708    ## Extraction of S4 class documentation is currently limited to expressions    ## Extraction of S4 class documentation is currently limited to expressions
# Line 619  Line 743 
743    }    }
744    invisible(docs)    invisible(docs)
745  }  }
746    
747    apply.parsers <- function
748    ### Parse code to r objs, then run all the parsers and return the
749    ### documentation list.
750    (code,
751    ### Character vector of code lines.
752     parsers=default.parsers,
753    ### List of Parser Functions.
754     verbose=FALSE,
755    ### Echo names of Parser Functions?
756     ...
757    ### Additional arguments to pass to Parser Functions.
758     ){
759      e <- new.env()
760      old <- options(keep.source=TRUE)
761      on.exit(options(old))
762      exprs <- parse(text=code)
763      for (i in exprs) eval(i, e)
764      objs <- sapply(ls(e),get,e,simplify=FALSE)
765    
766      docs <- list()
767    
768      # PhG: Automatically determine who is S3 methods
769      for (name in names(objs)) {
770        parts <- strsplit(name, ".", fixed = TRUE)[[1]]
771            l <- length(parts)
772            if (l > 1) {
773            for (i in 1:(l - 1)) {
774                # Look for a generic function (known by the system or defined
775                # in the package) that matches that part of the function name
776                generic <- paste(parts[1:i], collapse = ".")
777                if (any(generic %in% utils:::getKnownS3generics()) ||
778                    utils:::findGeneric(generic, e) != "") {
779                    object <- paste(parts[(i + 1):l], collapse = ".")
780                    docs[[name]]$s3method <- c(generic, object)
781                    break
782                }
783            }
784        }
785      }
786      ## apply parsers in sequence to code and objs
787      for(i in seq_along(parsers)){
788        N <- names(parsers[i])
789        if(verbose){
790          if(is.character(N) && N!=""){
791            cat(N," ",sep="")
792          }else cat('. ')
793        }
794        p <- parsers[[i]]
795        ## This is the argument list that each parser receives:
796        L <- p(code=code,objs=objs,docs=docs,...)
797        docs <- combine(docs,L)
798      }
799      if(verbose)cat("\n")
800      docs
801    ### A list of extracted documentation from code.
802    }
803    
804    extract.docs.file <- function
805    ### Apply all parsers relevant to extract info from just 1 code file.
806    (f,
807    ### File name of R code to read and parse.
808     parsers=list(extra.code.docs,default.parsers$parsefun),
809    ### Parser Functions to use to parse the code and extract
810    ### documentation.
811     ...
812    ### Other arguments to pass to Parser Functions.
813     ){
814      apply.parsers(readLines(f),parsers,verbose=FALSE,...)
815    }

Legend:
Removed from v.87  
changed lines
  Added in v.116

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