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 212, Wed Mar 9 16:37:25 2011 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 <- if(".overwrite"%in%names(y)){
11        y <- y[names(y)!=".overwrite"]
12        rep(TRUE,length(y))
13      }else{
14        !names(y)%in%names(x)
15      }
16      toup <- names(y)[!toadd]
17      x[names(y)[toadd]] <- y[toadd]
18      for(up in toup)x[[up]] <- combine(x[[up]],y[[up]])
19      x
20    ### A list, same type as x, but with added elements from y.
21    }
22    
23    ### Prefix for code comments used with grep and gsub.
24    prefix <- "^[ \t]*###[ \t]"
25    
26    decomment <- function
27    ### Remove comment prefix and join lines of code to form a
28    ### documentation string.
29    (comments
30    ### Character vector of prefixed comment lines.
31     ){
32      gsub(prefix,"",comments)
33    ### String without prefixes or newlines.
34    }
35    
36    forall <- function
37  ### For each object in the package that satisfies the criterion  ### For each object in the package that satisfies the criterion
38  ### checked by subfun, parse source using FUN and return the resulting  ### checked by subfun, parse source using FUN and return the resulting
39  ### documentation list.  ### documentation list.
 forall <- function  
40  (FUN,  (FUN,
41  ### Function to apply to each element in the package.  ### Function to apply to each element in the package.
42   subfun=function(x)TRUE   subfun=function(x)TRUE
# Line 9  Line 44 
44  ### is.function. subfun(x)==TRUE means FUN will be applied to x and  ### is.function. subfun(x)==TRUE means FUN will be applied to x and
45  ### the result will be returned.  ### the result will be returned.
46   ){   ){
47    function(objs,docs,...){    FUN <- FUN
48      f <- function(objs,docs,...){
49      objs <- objs[sapply(objs,subfun)]      objs <- objs[sapply(objs,subfun)]
50      L <- list()      L <- list()
51      for(N in names(objs)){      on.exit(cat(sprintf("Parser Function failed on %s\n",N)))
52        for(N in union(names(docs),names(objs))){
53        o <- objs[[N]]        o <- objs[[N]]
54        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"),
55                        name=N,objs=objs,o=o,docs=docs,doc=docs[[N]],...)
56      }      }
57        on.exit()## remove warning message
58      L      L
59    }    }
60      class(f) <- c("allfun","function")
61      f
62  ### A Parser Function.  ### A Parser Function.
63  }  }
64    
65    ### Print method for functions constructed using forall.
66    print.allfun <- function(x,...){
67      e <- environment(x)
68      cat("Function to apply to every element.\nselector:")
69      print(e$subfun)
70      cat("processor:")
71      print(e$FUN)
72    }
73    
74  ### For each function in the package, do something.  ### For each function in the package, do something.
75  forfun <- function(FUN)forall(FUN,is.function)  forfun <- function(FUN)forall(FUN,is.function)
76    
77  ### Get last line (test)  kill.prefix.whitespace <- function
78  parsefuns <- forfun(function(src,name,...){  ### Figure out what the whitespace preceding the example code is, and
79    extract.docs.fun(src,name)  ### then delete that from every line.
80  })  (ex
81    ### character vector of example code lines.
 ### Fill in author from DESCRIPTION and titles.  
 author.from.description <- forall(function(desc,...){  
   list(author=desc[,"Maintainer"])  
 })  
   
 ### The format section sometimes causes problems, so erase it.  
 erase.format <- forall(function(...){  
   list(format="")  
 })  
   
 ### Convert the function name to a title.  
 title.from.name <- forall(function(name,...){  
   list(title=gsub("[._]"," ",name))  
 })  
   
 ### Get examples for FUN from the file test/FUN.R  
 examples.from.testfile <- forfun(function(name,...){  
   tfile <- file.path("..","tests",paste(name,".R",sep=""))  
   if(file.exists(tfile))  
     list(examples=paste(readLines(tfile),collapse="\n"))  
   else list()  
 })  
   
 ### Get examples from inline definitions after return()  
 examples.after.return <- forfun(function(src,...){  
   rline <- grep("return([^)]*)",src)  
   if(length(rline)==0)return(list())  
   rline <- rline[length(rline)]  
   comment.line.nums <- grep(prefix,src)  
   if(!(comment.end <- rline+1)%in%comment.line.nums)return(list())  
   while(comment.end%in%comment.line.nums)comment.end <- comment.end+1  
   excode <- src[comment.end:(length(src)-1)]  
   list(examples=paste(gsub("^\\W*","",excode),collapse="\n"))  
 })  
   
 extract.docs.file <- function # Extract documentation from a file  
 ### Parse R code to extract inline documentation from comments around  
 ### each function. These are not able to be retreived simply by  
 ### looking at the "source" attribute. This is a Parser Function that  
 ### can be used in the parser list of package.skeleton.dx().  
 (code,  
 ### Code lines in a character vector containing multiple R objects to  
 ### parse for documentation.  
  objs,  
 ### The objects defined in the code.  
  ...  
 ### ignored  
82   ){   ){
83    parsed <- extract.file.parse(code)    tlines <- gsub("\\s*","",ex)
84    extract.docs.try <- function(o,on)    ##tlines <- gsub("#.*","",tlines)
85      {    prefixes <- unique(gsub("\\S.*","",ex[tlines!=""]))
86        ## Note: we could use parsed information here too, but that    FIND <- prefixes[which.min(nchar(prefixes))]
87        ## would produce different results for setMethodS3 etc.    ## Eliminate leading tabulations or 2/4 spaces
88        doc <- list()    sub(FIND, "", ex)
89        if ( !is.null(parsed[[on]]) ){  ### Character vector of code lines with preceding whitespace removed.
         if ( !is.na(parsed[[on]]@code[1]) ){ # no code given for generics  
           doc$definition <- paste(parsed[[on]]@code,collapse="\n")  
         }  
         if(!"description"%in%names(doc) && !is.na(parsed[[on]]@description) ){  
           doc$description <- parsed[[on]]@description  
         }  
         if ( "setMethodS3" == parsed[[on]]@created ){  
           pattern <- "^([^\\.]+)\\.(.*)$"  
           doc$s3method=c(m1 <- gsub(pattern,"\\1",on,perl=TRUE),  
               m2 <- gsub(pattern,"\\2",on,perl=TRUE))  
           if ( 0 < length(grep("\\W",m1,perl=TRUE)) ){  
             m1 <- paste("`",m1,"`",sep="")  
           }  
           cat("S3method(",m1,",",m2,")\n",sep="")  
         }  
       }  
       if("title" %in% names(doc) && !"description" %in% names(doc) ){  
         ## For short functions having both would duplicate, but a  
         ## description is required. Therefore automatically copy title  
         ## across to avoid errors at package build time.  
         doc$description <- doc$title  
       }  
       doc  
     }  
   extract.docs <- function(on){  
     res <- try({o <- objs[[on]]  
                 extract.docs.try(o, on)},FALSE)  
     if(class(res)=="try-error"){  
       cat("Failed to extract docs for: ",on,"\n\n")  
       list()  
     } else if(0 == length(res) && inherits(objs[[on]],"standardGeneric")){  
       NULL  
     } else if(0 == length(res) && "function" %in% class(o)  
               && 1 == length(osource <- attr(o,"source"))  
               && 1 == length(grep(paste("UseMethod(",on,")",sep="\""),osource))  
               ){  
       ## phew - this should only pick up R.oo S3 generic definitions like:  
       ## attr(*, "source")= chr "function(...) UseMethod(\"select\")"  
       NULL  
     } else res  
   }  
   doc.names <- names(objs)  
   res <- sapply(doc.names,extract.docs,simplify=FALSE)  
   ## Special processing for S4 classes as they do not appear in normal ls()  
   for ( nn in names(parsed) ){  
     if ( parsed[[nn]]@created == "setClass" ){  
       S4class.docs <- extract.docs.setClass(parsed[[nn]])  
       docname <- paste(nn,"class",sep="-")  
       if ( is.null(res[[docname]]) ){  
         res[[docname]] <- S4class.docs  
         doc.names <- c(doc.names,docname)  
       } else {  
         stop(nn," appears as both S4 class and some other definition")  
       }  
     }  
   }  
   inherit.docs <- function(on){  
     in.res <- res[[on]]  
     if ( !is.null(parsed[[on]]) ){  
       for ( parent in parsed[[on]]@parent ){  
         if ( !is.na(parent) ){  
           if ( is.null(in.res) ){  
             in.res <- res[[parent]]  
           } else if ( parent %in% names(res) ){  
             parent.docs <- res[[parent]]  
             for ( nn in names(parent.docs) ){  
               if ( !nn %in% names(in.res) ){  
                 in.res[[nn]] <- parent.docs[[nn]]  
               }  
             }  
           }  
         }  
       }  
     }  
     invisible(in.res)  
   }  
   all.done <- FALSE  
   while ( !all.done ){  
     res1 <- sapply(doc.names,inherit.docs,simplify=FALSE)  
     all.done <- identical(res1,res)  
     res <- res1  
   }  
   ## now strip out any generics (which have value NULL in res):  
   res.not.null <- sapply(res,function(x){!is.null(x)})  
   if ( 0 < length(res.not.null) && length(res.not.null) < length(res) ){  
     res <- res[res.not.null]  
   }  
   res  
 ### named list of lists, one for each object to document.  
90  }  }
91    
92  ### Default parsers to use with package.skeleton.dx  examples.after.return <- function
93  default.parsers <- list("parsefuns","extract.docs.file",  ### Get examples from inline definitions after return()
94                          "examples.after.return","examples.from.testfile",  ### PhG: this does not work well! Think of these situations:
95                          "author.from.description","erase.format","title.from.name")  ### 1) You have multiple return() in the code of your function,
96    ### 2) You have return() appearing is some example code, ...
97  extract.docs.fun <- function # Extract documentation from a function  ### I can hardly propose a hack here. The whole code of the function
98  ### Given source code of a function, return a list describing inline  ### must be parsed, and one must determine which one is the last line
99  ### documentation in that source code.  ### of code that is actually executed.
100  (code,  ###
101  ### The function to examine.  ### I make two propositions here
102   name.fun  ### 1) to keep the same mechanism that has the advantage of simplicity
103  ### The name of the function/chunk to use in warning messages.  ###    but to use a special tag
104   )  ###    ##examples<< or #{{{examples to separate
105  {  ###    function code from examples explicitly, and
106    res <- list()  ### 2) to place the example in an "ex" attribute
107    clines <- grep(prefix,code)  ###    attached to the function
108    if(length(grep("#",code[1]))){  ###    (see next parser). That solution will be also interesting for
109      res$title <- gsub("[^#]*#\\s*(.*)","\\1",code[1],perl=TRUE)  ###    documenting datasets, something not done yet by inlinedocs!
110    }  (src,name="",...) {
111    if(length(clines) > 0){    ## Look for the examples mark
112      ##details<<    m <- grep("^\\s*(##examples<<|#\\{\\{\\{examples)", src)
113      ## The primary mechanism is that consecutive groups of lines matching    if (!length(m)) return(list())
114      ## the specified prefix regular expression "\code{^### }" (i.e. lines    if (length(m) > 1)
115      ## beginning with "\code{### }") are collected      warning("More than one examples tag for ", name,
116      ## as follows into documentation sections:\describe{              ". Taking the last one")
117      ## \item{description}{group starting at line 2 in the code}    m <- m[length(m)]
118      ## \item{arguments}{group following each function argument}    ## Look for the lines containing return value comments just before
119      ## \item{value}{group ending at the penultimate line of the code}}    r <- grep("\\s*### ", src[1:(m-1)])
120      ## These may be added to by use of the \code{##<<} constructs described      if (!length(r)) {
121      ## below.        value <- NULL
122        } else {
123          ## Only take consecutive lines before the mark
124          keep <- rev((m - rev(r)) == 1:length(r))
125          if (!any(keep)) {
126            value <- NULL
127          } else {
128            value <- decomment(src[r[keep]])
129          }
130        }
131      ## Collect now the example code beneath the mark
132      ex <- src[(m + 1):(length(src) - 1)]
133      ## Possibly eliminate a #}}} tag
134      ex <- ex[!grepl("#}}}", ex)]
135      ## Eliminate leading tabulations or four spaces
136      ex <- kill.prefix.whitespace(ex)
137      ## Add an empty line before and after example
138      ex <- c("", ex, "")
139      ## Return examples and value
140      list(examples = ex, value = value)
141    }
142    
143    prefixed.lines <- structure(function(src,...){
144    ### The primary mechanism of inline documentation is via consecutive
145    ### groups of lines matching the specified prefix regular expression
146    ### "\code{^### }" (i.e. lines beginning with "\code{### }") are
147    ### collected as follows into documentation sections:\describe{
148    ### \item{description}{group starting at line 2 in the code}
149    ### \item{arguments}{group following each function argument}
150    ### \item{value}{group ending at the penultimate line of the code}}
151    ### These may be added to by use of the \code{##<<} constructs
152    ### described below.
153      clines <- grep(prefix,src)
154      if(length(clines)==0)return(list())
155      bounds <- which(diff(clines)!=1)      bounds <- which(diff(clines)!=1)
156      starts <- c(1,bounds+1)      starts <- c(1,bounds+1)
157      ends <- c(bounds,length(clines))      ends <- c(bounds,length(clines))
158      ## detect body of function using paren matching
159      code <- gsub("#.*","",src)
160      f <- function(ch)cumsum(nchar(gsub(sprintf("[^%s]",ch),"",code)))
161      parens <- f("(")-f(")")
162      body.begin <- which(diff(parens)<0 & parens[-1]==0)+2
163      if(length(body.begin)==0)body.begin <- 1 ## rare cases
164      is.arg <- function(){
165        gres <- grep("^\\s*#",src[start-1],perl=TRUE)
166        0 == length(gres) && start<=body.begin
167      }
168      res <- list()
169      for(i in seq_along(starts)){      for(i in seq_along(starts)){
170        start <- clines[starts[i]]        start <- clines[starts[i]]
171        end <- clines[ends[i]]        end <- clines[ends[i]]
172        lab <- if(end+1==length(code))"value"      lab <- if(all(grepl("^\\s*#",src[end:(length(src)-1)])))"value"
173        else if(start==2)"description"        else if(start==2)"description"
174        else if ( 0 == length(grep("^\\s*#",code[start-1],perl=TRUE)) ){      else if(is.arg()){
175           #arg <- gsub("^[ (]*","",code[start-1])        ##twutz: strip leading white spaces and brackets and ,
176           #arg <- gsub("^([^=,]*)[=,].*","\\1",arg)        arg <- gsub("^[ \t(,]*", "", src[start - 1])
          #arg <- gsub("...","\\dots",arg,fix=TRUE) ##special case for dots  
                  arg <- gsub("^[ \t(,]*", "", code[start - 1])  #twutz: strip leading white spaces and brackets and ,  
177                   arg <- gsub("^([^=,]*)[=,].*", "\\1", arg)                   arg <- gsub("^([^=,]*)[=,].*", "\\1", arg)
178                   arg <- gsub("^([^ \t]*)([ \t]+)$","\\1",arg)   #twutz: remove trailing whitespaces        ##twutz: remove trailing whitespaces
179          arg <- gsub("^([^ \t]*)([ \t]+)$","\\1",arg)
180                   arg <- gsub("...", "\\dots", arg, fix = TRUE)                   arg <- gsub("...", "\\dots", arg, fix = TRUE)
181           paste("item{",arg,"}",sep="")           paste("item{",arg,"}",sep="")
182         } else {         } else {
183           next;           next;
184         }         }
185        res[[lab]] <- decomment(code[start:end])      res[[lab]] <- decomment(src[start:end])
     }  
186    }    }
187      res
188    },ex=function(){
189    test <- function
190    ### the description
191    (x,
192    ### the first argument
193     y ##<< another argument
194     ){
195      5
196    ### the return value
197    ##seealso<< foobar
198    }
199    src <- attr(test,"source")
200    prefixed.lines(src)
201    extract.xxx.chunks(src)
202    })
203    
204    extract.xxx.chunks <- function # Extract documentation from a function
205    ### Given source code of a function, return a list describing inline
206    ### documentation in that source code.
207    (src,
208    ### The source lines of the function to examine, as a character
209    ### vector.
210     name.fun="(unnamed function)",
211    ### The name of the function/chunk to use in warning messages.
212     ...
213    ### ignored.
214     ){
215      res <- list()
216    ##details<< For simple functions/arguments, the argument may also be    ##details<< For simple functions/arguments, the argument may also be
217    ## documented by appending \code{##<<} comments on the same line as the    ## documented by appending \code{##<<} comments on the same line as the
218    ## argument name. Mixing this mechanism with \code{###} comment lines for    ## argument name. Mixing this mechanism with \code{###} comment lines for
# Line 300  Line 285 
285          chunk.sep <- "\n\n"          chunk.sep <- "\n\n"
286        }        }
287        chunk.res <- NULL        chunk.res <- NULL
288        if ( 0 == length(grep("^\\s*$",payload,perl=TRUE)) )        if ( !grepl("^\\s*$",payload,perl=TRUE) )
289          chunk.res <-          chunk.res <-
290            if ( is.null(res[[field]]) ) payload            if ( is.null(res[[field]]) ) payload
291            else paste(res[[field]], payload, sep=chunk.sep)            else paste(res[[field]], payload, sep=chunk.sep)
292        invisible(chunk.res)        invisible(chunk.res)
293      }      }
294    while ( k <= length(code) ){    while ( k <= length(src) ){
295      line <- code[k]      line <- src[k]
296      if ( 0 < length(grep(extra.regexp,line,perl=TRUE) ) ){      if ( grepl(extra.regexp,line,perl=TRUE) ){
297        ## we have a new extra chunk - first get field name and any payload        ## we have a new extra chunk - first get field name and any payload
298        new.field <- gsub(extra.regexp,"\\1",line,perl=TRUE)        new.field <- gsub(extra.regexp,"\\1",line,perl=TRUE)
299        new.contents <- gsub(extra.regexp,"\\2",line,perl=TRUE)        new.contents <- gsub(extra.regexp,"\\2",line,perl=TRUE)
# Line 383  Line 368 
368            first.describe <- TRUE;            first.describe <- TRUE;
369          }          }
370        }        }
371      } else if ( in.chunk && 0<length(grep(cont.re,line,perl=TRUE)) ){      } else if ( in.chunk && grepl(cont.re,line,perl=TRUE) ){
372        ## append this line to current chunk        ## append this line to current chunk
373        if ( 0 == length(grep(prefix,line,perl=TRUE)) ){        if ( !grepl(prefix,line,perl=TRUE) ){
374          ##describe<< Any lines with "\code{### }" at the left hand          ##describe<< Any lines with "\code{### }" at the left hand
375          ## margin within the included chunks are handled separately,          ## margin within the included chunks are handled separately,
376          ## so if they appear in the documentation they will appear          ## so if they appear in the documentation they will appear
# Line 398  Line 383 
383            payload <- stripped            payload <- stripped
384          }          }
385        }        }
386      } else if ( 0 < length(grep(arg.pat,line,perl=TRUE)) ){      } else if ( grepl(arg.pat,line,perl=TRUE) ){
387        not.describe <- (0==in.describe && !first.describe)        not.describe <- (0==in.describe && !first.describe)
388        if ( in.chunk && not.describe){        if ( in.chunk && not.describe){
389          res[[cur.field]] <- end.chunk(cur.field,payload)          res[[cur.field]] <- end.chunk(cur.field,payload)
# Line 407  Line 392 
392        arg <- gsub(arg.pat,"\\\\item\\{\\1\\}",line,perl=TRUE)        arg <- gsub(arg.pat,"\\\\item\\{\\1\\}",line,perl=TRUE)
393        in.chunk <- TRUE        in.chunk <- TRUE
394        if ( not.describe ){        if ( not.describe ){
395            ## TDH 2010-06-18 For item{}s in the documentation list names,
396            ## we don't need to have a backslash before, so delete it.
397            arg <- gsub("^[\\]+","",arg)
398          cur.field <- gsub("...","\\dots",arg,fix=TRUE) ##special case for dots          cur.field <- gsub("...","\\dots",arg,fix=TRUE) ##special case for dots
399          payload <- comment          payload <- comment
400        } else {        } else {
# Line 457  Line 445 
445  ### with the string in this list (implemented in modify.Rd.file).  ### with the string in this list (implemented in modify.Rd.file).
446  }  }
447    
448    leadingS3generic <- function # check whether function name is an S3 generic
449    ### Determines whether a function name looks like an S3 generic function
450    (name,                     ##<< name of function
451     env,                      ##<< environment to search for additional generics
452     ...)                      ##<< ignored here
453    {
454      ##details<< This function is one of the default parsers, but exposed as
455      ## possibly of more general interest. Given a function name of the form
456      ## x.y.z it looks for the generic function x applying to objects of class
457      ## y.z and also for generic function x.y applying to objects of class z.
458      ##
459      parts <- strsplit(name, ".", fixed = TRUE)[[1]]
460      l <- length(parts)
461      if (l > 1) {
462        for (i in 1:(l - 1)) {
463          ## Look for a generic function (known by the system or defined
464          ## in the package) that matches that part of the function name
465          generic <- paste(parts[1:i], collapse = ".")
466          if (any(generic %in% utils:::getKnownS3generics()) ||
467              utils:::findGeneric(generic, env) != "") {
468            object <- paste(parts[(i + 1):l], collapse = ".")
469            ##details<< Assumes that the first name which matches any known
470            ## generics is the target generic function, so if both x and x.y
471            ## are generic functions, will assume generic x applying to objects
472            ## of class y.z
473            ##value<< If a matching generic found returns a list with a single component:
474            return(list(.s3method=c(generic, object))) ##<< a character vector containing generic name and object name.
475          }
476        }
477      }
478      ##value<< If no matching generic functions are found, returns an empty list.
479      list()
480    }
481    
482    ### Parsers for each function that are constructed automatically. This
483    ### is a named list, and each element is a parser function for an
484    ### individual object.
485    forfun.parsers <-
486      list(prefixed.lines=prefixed.lines,
487           examples.after.return=examples.after.return,
488           extract.xxx.chunks=extract.xxx.chunks,
489           ## title from first line of function def
490           title.from.firstline=function(src,...){
491             first <- src[1]
492             if(!is.character(first))return(list())
493             if(!grepl("#",first))return(list())
494             list(title=gsub("[^#]*#\\s*(.*)","\\1",first,perl=TRUE))
495           },
496           ## PhG: it is tests/FUN.R!!! I would like more flexibility here
497           ## please, let me choose which dir to use for examples!
498           ## Get examples for FUN from the file tests/FUN.R
499           examples.from.testfile=function(name,...){
500             tsubdir <- getOption("inlinedocs.exdir")
501             if (is.null(tsubdir)) tsubdir <- "tests"       # Default value
502             tfile <- file.path("..",tsubdir,paste(name,".R",sep=""))
503             if(file.exists(tfile))
504               list(examples=readLines(tfile))
505             else list()
506           },
507           definition.from.source=function(doc,src,...){
508             def <- doc$definition
509             is.empty <- function(x)is.null(x)||x==""
510             if(is.empty(def) && !is.empty(src))
511               list(definition=src)
512             else list()
513           })
514    
515    ### List of Parser Functions that can be applied to any object.
516    forall.parsers <-
517      list(## Fill in author from DESCRIPTION and titles.
518           author.from.description=function(desc,...){
519             list(author=desc[,"Maintainer"])
520           },
521           ## The format section sometimes causes problems, so erase it.
522           erase.format=function(...){
523             list(format="")
524           },
525           ## Convert the function name to a title.
526           title.from.name=function(name,doc,...){
527             if("title"%in%names(doc))list() else
528             list(title=gsub("[._]"," ",name))
529           },
530           ## PhG: here is what I propose for examples code in the 'ex' attribute
531           examples.in.attr =  function (name, o, ...) {
532             ex <- attr(o, "ex")
533             if (!is.null(ex)) {
534               ## Special case for code contained in a function
535               if (inherits(ex, "function")) {
536                 ## If source is available, start from there
537                 src <- attr(ex, "source")
538                 if (!is.null(src)) {
539                   ex <- src
540                 } else { ## Use the body of the function
541                   ex <- deparse(body(ex))
542                 }
543                 ## Eliminate leading and trailing code
544                 ex <- ex[-c(1, length(ex))]
545                 ## all the prefixes
546                 ex <- kill.prefix.whitespace(ex)
547                 ## Add an empty line before and after example
548                 ex <- c("", ex, "")
549               }
550               list(examples = ex)
551             } else list()
552           },collapse=function(doc,...){
553             L <- lapply(doc,paste,collapse="\n")
554             L$.overwrite <- TRUE
555             L
556           },tag.s3methods=leadingS3generic
557           )
558    
559    ### List of parser functions that operate on single objects. This list
560    ### is useful for testing these functions.
561    lonely <- structure(c(forall.parsers,forfun.parsers),ex=function(){
562      f <- function # title
563    ### description
564      (x, ##<< arg x
565       y
566    ### arg y
567       ){
568        ##value<< a list with elements
569        list(x=x, ##<< original x value
570             y=y, ##<< original y value
571             sum=x+y) ##<< their sum
572        ##end<<
573      }
574      src <- attr(f,"source")
575      lonely$extract.xxx.chunks(src)
576      lonely$prefixed.lines(src)
577    })
578    
579    extra.code.docs <- function # Extract documentation from code chunks
580    ### Parse R code to extract inline documentation from comments around
581    ### each function. These are not able to be retreived simply by
582    ### looking at the "source" attribute. This is a Parser Function that
583    ### can be used in the parser list of package.skeleton.dx(). TODO:
584    ### Modularize this into separate Parsers Functions for S4 classes,
585    ### prefixes, ##<<blocks, etc. Right now it is not very clean!
586    (code,
587    ### Code lines in a character vector containing multiple R objects to
588    ### parse for documentation.
589     objs,
590    ### The objects defined in the code.
591     ...
592    ### ignored
593     ){
594      parsed <- extract.file.parse(code)
595      extract.docs.try <- function(o,on)
596        {
597          ## Note: we could use parsed information here too, but that
598          ## would produce different results for setMethodS3 etc.
599          doc <- list()
600          if ( !is.null(parsed[[on]]) ){
601            if ( !is.na(parsed[[on]]@code[1]) ){ # no code given for generics
602              doc$definition <- paste(parsed[[on]]@code)
603            }
604            if(!"description"%in%names(doc) && !is.na(parsed[[on]]@description) ){
605              doc$description <- parsed[[on]]@description
606            }
607            ## if ( "setMethodS3" == parsed[[on]]@created ){
608            ##   gen <- leadingS3generic(on,topenv())
609            ##   if ( 0 < length(gen) ){
610            ##     doc$.s3method <- gen$.s3method
611            ##     cat("S3method(",gen$.s3method[1],",",gen$.s3method[2],")\n",sep="")
612            ##   }
613            ## }
614          }
615          if("title" %in% names(doc) && !"description" %in% names(doc) ){
616            ## For short functions having both would duplicate, but a
617            ## description is required. Therefore automatically copy title
618            ## across to avoid errors at package build time.
619            doc$description <- doc$title
620          }
621          doc
622        }
623      extract.docs <- function(on){
624        res <- try({o <- objs[[on]]
625                    extract.docs.try(o, on)},FALSE)
626        if(class(res)=="try-error"){
627          cat("Failed to extract docs for: ",on,"\n\n")
628          list()
629        } else if(0 == length(res) && inherits(objs[[on]],"standardGeneric")){
630          NULL
631        } else if(0 == length(res) && "function" %in% class(o)
632                  && 1 == length(osource <- attr(o,"source"))
633                  && grepl(paste("UseMethod(",on,")",sep="\""),osource)
634                  ){
635          ## phew - this should only pick up R.oo S3 generic definitions like:
636          ## attr(*, "source")= chr "function(...) UseMethod(\"select\")"
637          NULL
638        } else res
639      }
640      doc.names <- names(objs)
641      res <- sapply(doc.names,extract.docs,simplify=FALSE)
642      ## Special processing for S4 classes as they do not appear in normal ls()
643      for ( nn in names(parsed) ){
644        if ( parsed[[nn]]@created == "setClass" ){
645          S4class.docs <- extract.docs.setClass(parsed[[nn]])
646          docname <- paste(nn,"class",sep="-")
647          if ( is.null(res[[docname]]) ){
648            res[[docname]] <- S4class.docs
649            doc.names <- c(doc.names,docname)
650          } else {
651            stop(nn," appears as both S4 class and some other definition")
652          }
653        }
654      }
655      inherit.docs <- function(on){
656        in.res <- res[[on]]
657        if ( !is.null(parsed[[on]]) ){
658          for ( parent in parsed[[on]]@parent ){
659            if ( !is.na(parent) ){
660              if ( is.null(in.res) ){
661                in.res <- res[[parent]]
662              } else if ( parent %in% names(res) ){
663                parent.docs <- res[[parent]]
664                for ( nn in names(parent.docs) ){
665                  if ( !nn %in% names(in.res) ){
666                    in.res[[nn]] <- parent.docs[[nn]]
667                  }
668                }
669              }
670            }
671          }
672        }
673        invisible(in.res)
674      }
675      all.done <- FALSE
676      while ( !all.done ){
677        res1 <- sapply(doc.names,inherit.docs,simplify=FALSE)
678        all.done <- identical(res1,res)
679        res <- res1
680      }
681      ## now strip out any generics (which have value NULL in res):
682      res.not.null <- sapply(res,function(x){!is.null(x)})
683      if ( 0 < length(res.not.null) && length(res.not.null) < length(res) ){
684        res <- res[res.not.null]
685      }
686      res
687    ### named list of lists, one for each object to document.
688    }
689    
690    ### List of parsers to use by default with package.skeleton.dx.
691    default.parsers <-
692      c(extra.code.docs=extra.code.docs, ## TODO: cleanup!
693        sapply(forfun.parsers,forfun),
694        edit.package.file=function(desc,...){
695          in.details <- setdiff(colnames(desc),"Description")
696          details <- sprintf("%s: \\tab %s\\cr",in.details,desc[,in.details])
697          L <-
698            list(list(title=desc[,"Title"],
699                      description=desc[,"Description"],
700                      `tabular{ll}`=details))
701          names(L) <- paste(desc[,"Package"],"-package",sep="")
702          L
703        },
704        sapply(forall.parsers,forall)
705        )
706    
707  setClass("DocLink", # Link documentation among related functions  setClass("DocLink", # Link documentation among related functions
708  ### The \code{.DocLink} class provides the basis for hooking together  ### The \code{.DocLink} class provides the basis for hooking together
709  ### documentation of related classes/functions/objects. The aim is that  ### documentation of related classes/functions/objects. The aim is that
710  ### documentation sections missing from the child are  ### documentation sections missing from the child are inherited from
711    ### the parent class.
712           representation(name="character", ##<< name of object           representation(name="character", ##<< name of object
713                          created="character", ##<< how created                          created="character", ##<< how created
714                          parent="character", ##<< parent class or NA                          parent="character", ##<< parent class or NA
# Line 495  Line 743 
743      ## "prefix" lines will be used instead.      ## "prefix" lines will be used instead.
744      default.description <- NULL      default.description <- NULL
745      while ( start > last.end+1      while ( start > last.end+1
746             && 1 == length(grep(prefix,code[start-1],perl=TRUE)) ){             && grepl(prefix,code[start-1],perl=TRUE) ){
747        start <- start-1        start <- start-1
748      }      }
749      if ( start < chunks[[k]][1] ){      if ( start < chunks[[k]][1] ){
# Line 522  Line 770 
770        ## If the function definition is not embedded within the call, then        ## If the function definition is not embedded within the call, then
771        ## the parent is that function. Test whether the the third value        ## the parent is that function. Test whether the the third value
772        ## looks like a name and add it to parents if so.        ## looks like a name and add it to parents if so.
773        if ( 1 == length(grep("^[\\._\\w]+$",chars[3],perl=TRUE)) ){        if ( grepl("^[\\._\\w]+$",chars[3],perl=TRUE) ){
774          parent <- chars[3]          parent <- chars[3]
775        }        }
776        res[[object.name]] <- new("DocLink",name=object.name,        res[[object.name]] <- new("DocLink",name=object.name,
# Line 554  Line 802 
802        ## If the function definition is not embedded within the call, then        ## If the function definition is not embedded within the call, then
803        ## the parent is that function. Test whether the the fourth value        ## the parent is that function. Test whether the the fourth value
804        ## looks like a name and add it to parents if so.        ## looks like a name and add it to parents if so.
805        if ( 1 == length(grep("^[\\._\\w]+$",chars[4],perl=TRUE)) ){        if ( grepl("^[\\._\\w]+$",chars[4],perl=TRUE) ){
806          parent <- c(chars[4],parent)          parent <- c(chars[4],parent)
807        }        }
808        res[[object.name]] <- new("DocLink",name=object.name,        res[[object.name]] <- new("DocLink",name=object.name,
# Line 574  Line 822 
822  ### Using the same conventions as for functions, definitions of S4 classes  ### Using the same conventions as for functions, definitions of S4 classes
823  ### in the form \code{setClass("classname",\dots)} are also located and  ### in the form \code{setClass("classname",\dots)} are also located and
824  ### scanned for inline comments.  ### scanned for inline comments.
825  (doc.link)  (doc.link
826  ### DocLink object as created by \code{\link{extract.file.parse}}.  ### DocLink object as created by \code{\link{extract.file.parse}}.
827  ### Note that \code{source} statements are \emph{ignored} when scanning for  ### Note that \code{source} statements are \emph{ignored} when scanning for
828  ### class definitions.  ### class definitions.
829  {   ){
830    chunk.source <- doc.link@code    chunk.source <- doc.link@code
831    ##details<<    ##details<<
832    ## Extraction of S4 class documentation is currently limited to expressions    ## Extraction of S4 class documentation is currently limited to expressions
# Line 595  Line 843 
843    ## the same line or \code{### } comments at the beginning of the    ## the same line or \code{### } comments at the beginning of the
844    ## following line.    ## following line.
845    f.n <- paste(class.name,"class",sep="-")    f.n <- paste(class.name,"class",sep="-")
846    docs <- extract.docs.fun(chunk.source,f.n)    docs <- extract.xxx.chunks(chunk.source,f.n)
847      ## also apply source parsing functions that I separated out into
848      ## separate functions
849      docs <- combine(docs,lonely$prefixed.lines(chunk.source))
850      docs$title <- lonely$title.from.firstline(chunk.source)
851    ##details<<    ##details<<
852    ## The class definition skeleton includes an \code{Objects from the Class}    ## The class definition skeleton includes an \code{Objects from the Class}
853    ## section, to which any \code{##details<<} documentation chunks are    ## section, to which any \code{##details<<} documentation chunks are
# Line 619  Line 871 
871    }    }
872    invisible(docs)    invisible(docs)
873  }  }
874    
875    apply.parsers <- function
876    ### Parse code to r objs, then run all the parsers and return the
877    ### documentation list.
878    (code,
879    ### Character vector of code lines.
880     parsers=default.parsers,
881    ### List of Parser Functions.
882     verbose=FALSE,
883    ### Echo names of Parser Functions?
884     ...
885    ### Additional arguments to pass to Parser Functions.
886     ){
887      e <- new.env()
888      ## KMP 2011-03-09 fix problem with DocLink when inlinedocs ran on itself
889      ## Error in assignClassDef(Class, classDef, where) :
890      ##   Class "DocLink" has a locked definition in package "inlinedocs"
891      ## Traced to "where" argument in setClassDef which defaults to topenv()
892      ## which in turn is inlinedocs when processing inlinedocs package, hence
893      ## the clash. The following works (under R 2.12.2), so that the topenv()
894      ## now finds e before finding the inlinedocs environment.
895      options(topLevelEnvironment=e)
896      old <- options(keep.source=TRUE)
897      on.exit(options(old))
898      exprs <- parse(text=code)
899      for (i in exprs){
900        tryCatch(eval(i, e),error=function(e){
901          ##print(e)
902        })
903      }
904      objs <- sapply(ls(e),get,e,simplify=FALSE)
905    
906      docs <- list()
907    
908      ## apply parsers in sequence to code and objs
909      for(i in seq_along(parsers)){
910        N <- names(parsers[i])
911        if(verbose){
912          if(is.character(N) && N!=""){
913            cat(N," ",sep="")
914          }else cat('. ')
915        }
916        p <- parsers[[i]]
917        ## This is the argument list that each parser receives:
918        L <- p(code=code,objs=objs,docs=docs,env=e,...)
919        docs <- combine(docs,L)
920      }
921      ## post-process to collapse all character vectors
922      for(i in seq_along(docs)){
923        for(j in seq_along(docs[[i]])){
924          if(names(docs[[i]])[j]!=".s3method")
925          docs[[i]][[j]] <- paste(docs[[i]][[j]],collapse="\n")
926        }
927      }
928      if(verbose)cat("\n")
929      docs
930    ### A list of extracted documentation from code.
931    }
932    
933    ### Names of Parser Functions that operate on the desc arg.
934    descfile.names <- c("author.from.description","edit.package.file")
935    
936    ### Names of Parser Functions that do NOT use the desc arg.
937    non.descfile.names <-
938      names(default.parsers)[!names(default.parsers)%in%descfile.names]
939    
940    ### Parsers that operate only on R code, independently of the
941    ### description file.
942    nondesc.parsers <- default.parsers[non.descfile.names]
943    
944    extract.docs.file <- structure(function
945    ### Apply all parsers relevant to extract info from just 1 code file.
946    (f,
947    ### File name of R code to read and parse.
948     parsers=NULL,
949    ### Parser Functions to use to parse the code and extract
950    ### documentation.
951     ...
952    ### Other arguments to pass to Parser Functions.
953     ){
954      if(is.null(parsers))parsers <- nondesc.parsers
955      apply.parsers(readLines(f),parsers,verbose=FALSE,...)
956    },ex=function(){
957      f <- system.file("silly","R","silly.R",package="inlinedocs")
958      extract.docs.file(f)
959    })

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

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