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 270, Mon May 23 15:53:47 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.
90          if ( !is.na(parsed[[on]]@code[1]) ){ # no code given for generics  }
91            doc$definition <- paste(parsed[[on]]@code,collapse="\n")  
92          }  prefixed.lines <- structure(function(src,...){
93          if(!"description"%in%names(doc) && !is.na(parsed[[on]]@description) ){  ### The primary mechanism of inline documentation is via consecutive
94            doc$description <- parsed[[on]]@description  ### groups of lines matching the specified prefix regular expression
95          }  ### "\code{^### }" (i.e. lines beginning with "\code{### }") are
96          if ( "setMethodS3" == parsed[[on]]@created ){  ### collected as follows into documentation sections:\describe{
97            pattern <- "^([^\\.]+)\\.(.*)$"  ### \item{description}{group starting at line 2 in the code}
98            doc$s3method=c(m1 <- gsub(pattern,"\\1",on,perl=TRUE),  ### \item{arguments}{group following each function argument}
99                m2 <- gsub(pattern,"\\2",on,perl=TRUE))  ### \item{value}{group ending at the penultimate line of the code}}
100            if ( 0 < length(grep("\\W",m1,perl=TRUE)) ){  ### These may be added to by use of the \code{##<<} constructs
101              m1 <- paste("`",m1,"`",sep="")  ### described below.
102            }    clines <- grep(prefix,src)
103            cat("S3method(",m1,",",m2,")\n",sep="")    if(length(clines)==0)return(list())
         }  
       }  
       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.  
 }  
   
 ### Default parsers to use with package.skeleton.dx  
 default.parsers <- list("parsefuns","extract.docs.file",  
                         "examples.after.return","examples.from.testfile",  
                         "author.from.description","erase.format","title.from.name")  
   
 extract.docs.fun <- function # Extract documentation from a function  
 ### Given source code of a function, return a list describing inline  
 ### documentation in that source code.  
 (code,  
 ### The function to examine.  
  name.fun  
 ### The name of the function/chunk to use in warning messages.  
  )  
 {  
   res <- list()  
   clines <- grep(prefix,code)  
   if(length(grep("#",code[1]))){  
     res$title <- gsub("[^#]*#\\s*(.*)","\\1",code[1],perl=TRUE)  
   }  
   if(length(clines) > 0){  
     ##details<<  
     ## The primary mechanism is that consecutive groups of lines matching  
     ## the specified prefix regular expression "\code{^### }" (i.e. lines  
     ## beginning with "\code{### }") are collected  
     ## as follows into documentation sections:\describe{  
     ## \item{description}{group starting at line 2 in the code}  
     ## \item{arguments}{group following each function argument}  
     ## \item{value}{group ending at the penultimate line of the code}}  
     ## These may be added to by use of the \code{##<<} constructs described  
     ## below.  
104      bounds <- which(diff(clines)!=1)      bounds <- which(diff(clines)!=1)
105      starts <- c(1,bounds+1)      starts <- c(1,bounds+1)
106      ends <- c(bounds,length(clines))      ends <- c(bounds,length(clines))
107      ## detect body of function using paren matching
108      code <- gsub("#.*","",src)
109      f <- function(ch)cumsum(nchar(gsub(sprintf("[^%s]",ch),"",code)))
110      parens <- f("(")-f(")")
111      body.begin <- which(diff(parens)<0 & parens[-1]==0)+2
112      if(length(body.begin)==0)body.begin <- 1 ## rare cases
113      is.arg <- function(){
114        gres <- grep("^\\s*#",src[start-1],perl=TRUE)
115        0 == length(gres) && start<=body.begin
116      }
117      res <- list()
118      for(i in seq_along(starts)){      for(i in seq_along(starts)){
119        start <- clines[starts[i]]        start <- clines[starts[i]]
120        end <- clines[ends[i]]        end <- clines[ends[i]]
121        lab <- if(end+1==length(code))"value"      lab <- if(all(grepl("^\\s*#",src[end:(length(src)-1)])))"value"
122        else if(start==2)"description"        else if(start==2)"description"
123        else if ( 0 == length(grep("^\\s*#",code[start-1],perl=TRUE)) ){      else if(is.arg()){
124           #arg <- gsub("^[ (]*","",code[start-1])        ##twutz: strip leading white spaces and brackets and ,
125           #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 ,  
126                   arg <- gsub("^([^=,]*)[=,].*", "\\1", arg)                   arg <- gsub("^([^=,]*)[=,].*", "\\1", arg)
127                   arg <- gsub("^([^ \t]*)([ \t]+)$","\\1",arg)   #twutz: remove trailing whitespaces        ##twutz: remove trailing whitespaces
128          arg <- gsub("^([^ \t]*)([ \t]+)$","\\1",arg)
129                   arg <- gsub("...", "\\dots", arg, fix = TRUE)                   arg <- gsub("...", "\\dots", arg, fix = TRUE)
130           paste("item{",arg,"}",sep="")           paste("item{",arg,"}",sep="")
131         } else {         } else {
132           next;           next;
133         }         }
134        res[[lab]] <- decomment(code[start:end])      res[[lab]] <- decomment(src[start:end])
     }  
135    }    }
136      res
137    },ex=function(){
138    test <- function
139    ### the description
140    (x,
141    ### the first argument
142     y ##<< another argument
143     ){
144      5
145    ### the return value
146    ##seealso<< foobar
147    }
148    src <- attr(test,"source")
149    prefixed.lines(src)
150    extract.xxx.chunks(src)
151    })
152    
153    extract.xxx.chunks <- function # Extract documentation from a function
154    ### Given source code of a function, return a list describing inline
155    ### documentation in that source code.
156    (src,
157    ### The source lines of the function to examine, as a character
158    ### vector.
159     name.fun="(unnamed function)",
160    ### The name of the function/chunk to use in warning messages.
161     ...
162    ### ignored.
163     ){
164      res <- list()
165    ##details<< For simple functions/arguments, the argument may also be    ##details<< For simple functions/arguments, the argument may also be
166    ## documented by appending \code{##<<} comments on the same line as the    ## documented by appending \code{##<<} comments on the same line as the
167    ## argument name. Mixing this mechanism with \code{###} comment lines for    ## argument name. Mixing this mechanism with \code{###} comment lines for
# Line 300  Line 234 
234          chunk.sep <- "\n\n"          chunk.sep <- "\n\n"
235        }        }
236        chunk.res <- NULL        chunk.res <- NULL
237        if ( 0 == length(grep("^\\s*$",payload,perl=TRUE)) )        if ( !grepl("^\\s*$",payload,perl=TRUE) )
238          chunk.res <-          chunk.res <-
239            if ( is.null(res[[field]]) ) payload            if ( is.null(res[[field]]) ) payload
240            else paste(res[[field]], payload, sep=chunk.sep)            else paste(res[[field]], payload, sep=chunk.sep)
241        invisible(chunk.res)        invisible(chunk.res)
242      }      }
243    while ( k <= length(code) ){    while ( k <= length(src) ){
244      line <- code[k]      line <- src[k]
245      if ( 0 < length(grep(extra.regexp,line,perl=TRUE) ) ){      if ( grepl(extra.regexp,line,perl=TRUE) ){
246        ## 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
247        new.field <- gsub(extra.regexp,"\\1",line,perl=TRUE)        new.field <- gsub(extra.regexp,"\\1",line,perl=TRUE)
248        new.contents <- gsub(extra.regexp,"\\2",line,perl=TRUE)        new.contents <- gsub(extra.regexp,"\\2",line,perl=TRUE)
# Line 383  Line 317 
317            first.describe <- TRUE;            first.describe <- TRUE;
318          }          }
319        }        }
320      } else if ( in.chunk && 0<length(grep(cont.re,line,perl=TRUE)) ){      } else if ( in.chunk && grepl(cont.re,line,perl=TRUE) ){
321        ## append this line to current chunk        ## append this line to current chunk
322        if ( 0 == length(grep(prefix,line,perl=TRUE)) ){        if ( !grepl(prefix,line,perl=TRUE) ){
323          ##describe<< Any lines with "\code{### }" at the left hand          ##describe<< Any lines with "\code{### }" at the left hand
324          ## margin within the included chunks are handled separately,          ## margin within the included chunks are handled separately,
325          ## so if they appear in the documentation they will appear          ## so if they appear in the documentation they will appear
# Line 398  Line 332 
332            payload <- stripped            payload <- stripped
333          }          }
334        }        }
335      } else if ( 0 < length(grep(arg.pat,line,perl=TRUE)) ){      } else if ( grepl(arg.pat,line,perl=TRUE) ){
336        not.describe <- (0==in.describe && !first.describe)        not.describe <- (0==in.describe && !first.describe)
337        if ( in.chunk && not.describe){        if ( in.chunk && not.describe){
338          res[[cur.field]] <- end.chunk(cur.field,payload)          res[[cur.field]] <- end.chunk(cur.field,payload)
# Line 407  Line 341 
341        arg <- gsub(arg.pat,"\\\\item\\{\\1\\}",line,perl=TRUE)        arg <- gsub(arg.pat,"\\\\item\\{\\1\\}",line,perl=TRUE)
342        in.chunk <- TRUE        in.chunk <- TRUE
343        if ( not.describe ){        if ( not.describe ){
344            ## TDH 2010-06-18 For item{}s in the documentation list names,
345            ## we don't need to have a backslash before, so delete it.
346            arg <- gsub("^[\\]+","",arg)
347          cur.field <- gsub("...","\\dots",arg,fix=TRUE) ##special case for dots          cur.field <- gsub("...","\\dots",arg,fix=TRUE) ##special case for dots
348          payload <- comment          payload <- comment
349        } else {        } else {
# Line 457  Line 394 
394  ### with the string in this list (implemented in modify.Rd.file).  ### with the string in this list (implemented in modify.Rd.file).
395  }  }
396    
397    leadingS3generic <- function # check whether function name is an S3 generic
398    ### Determines whether a function name looks like an S3 generic function
399    (name,                     ##<< name of function
400     env,                      ##<< environment to search for additional generics
401     ...)                      ##<< ignored here
402    {
403      ##details<< This function is one of the default parsers, but exposed as
404      ## possibly of more general interest. Given a function name of the form
405      ## x.y.z it looks for the generic function x applying to objects of class
406      ## y.z and also for generic function x.y applying to objects of class z.
407      ##
408      parts <- strsplit(name, ".", fixed = TRUE)[[1]]
409      l <- length(parts)
410      if (l > 1) {
411        for (i in 1:(l - 1)) {
412          ## Look for a generic function (known by the system or defined
413          ## in the package) that matches that part of the function name
414          generic <- paste(parts[1:i], collapse = ".")
415          if (any(generic %in% utils:::getKnownS3generics()) ||
416              utils:::findGeneric(generic, env) != "") {
417            object <- paste(parts[(i + 1):l], collapse = ".")
418            ##details<< Assumes that the first name which matches any known
419            ## generics is the target generic function, so if both x and x.y
420            ## are generic functions, will assume generic x applying to objects
421            ## of class y.z
422            ##value<< If a matching generic found returns a list with a single component:
423            return(list(.s3method=c(generic, object))) ##<< a character vector containing generic name and object name.
424          }
425        }
426      }
427      ##value<< If no matching generic functions are found, returns an empty list.
428      list()
429    }
430    
431    ### Parsers for each function that are constructed automatically. This
432    ### is a named list, and each element is a parser function for an
433    ### individual object.
434    forfun.parsers <-
435      list(prefixed.lines=prefixed.lines,
436           extract.xxx.chunks=extract.xxx.chunks,
437           ## title from first line of function def
438           title.from.firstline=function(src,...){
439             first <- src[1]
440             if(!is.character(first))return(list())
441             if(!grepl("#",first))return(list())
442             list(title=gsub("[^#]*#\\s*(.*)","\\1",first,perl=TRUE))
443           },
444           ## PhG: it is tests/FUN.R!!! I would like more flexibility here
445           ## please, let me choose which dir to use for examples!
446           ## Get examples for FUN from the file tests/FUN.R
447           examples.from.testfile=function(name,...){
448             tsubdir <- getOption("inlinedocs.exdir")
449             if (is.null(tsubdir)) tsubdir <- "tests"       # Default value
450             tfile <- file.path("..",tsubdir,paste(name,".R",sep=""))
451             if(file.exists(tfile))
452               list(examples=readLines(tfile))
453             else list()
454           },
455           definition.from.source=function(doc,src,...){
456             def <- doc$definition
457             is.empty <- function(x)is.null(x)||x==""
458             if(is.empty(def) && !is.empty(src))
459               list(definition=src)
460             else list()
461           })
462    
463    ### List of Parser Functions that can be applied to any object.
464    forall.parsers <-
465      list(## Fill in author from DESCRIPTION and titles.
466           author.from.description=function(desc,...){
467             list(author=desc[,"Maintainer"])
468           },
469           ## The format section sometimes causes problems, so erase it.
470           erase.format=function(...){
471             list(format="")
472           },
473           ## Convert the function name to a title.
474           title.from.name=function(name,doc,...){
475             if("title"%in%names(doc))list() else
476             list(title=gsub("[._]"," ",name))
477           },
478           ## PhG: here is what I propose for examples code in the 'ex' attribute
479           examples.in.attr =  function (name, o, ...) {
480             ex <- attr(o, "ex")
481             if (!is.null(ex)) {
482               ## Special case for code contained in a function
483               if (inherits(ex, "function")) {
484                 ## If source is available, start from there
485                 src <- attr(ex, "source")
486                 if (!is.null(src)) {
487                   ex <- src
488                 } else { ## Use the body of the function
489                   ex <- deparse(body(ex))
490                 }
491                 ## Eliminate leading and trailing code
492                 ex <- ex[-c(1, length(ex))]
493                 ## all the prefixes
494                 ex <- kill.prefix.whitespace(ex)
495                 ## Add an empty line before and after example
496                 ex <- c("", ex, "")
497               }
498               list(examples = ex)
499             } else list()
500           },collapse=function(doc,...){
501             L <- lapply(doc,paste,collapse="\n")
502             L$.overwrite <- TRUE
503             L
504           },tag.s3methods=leadingS3generic
505           )
506    
507    ### List of parser functions that operate on single objects. This list
508    ### is useful for testing these functions.
509    lonely <- structure(c(forall.parsers,forfun.parsers),ex=function(){
510      f <- function # title
511    ### description
512      (x, ##<< arg x
513       y
514    ### arg y
515       ){
516        ##value<< a list with elements
517        list(x=x, ##<< original x value
518             y=y, ##<< original y value
519             sum=x+y) ##<< their sum
520        ##end<<
521      }
522      src <- attr(f,"source")
523      lonely$extract.xxx.chunks(src)
524      lonely$prefixed.lines(src)
525    })
526    
527    extra.code.docs <- function # Extract documentation from code chunks
528    ### Parse R code to extract inline documentation from comments around
529    ### each function. These are not able to be retreived simply by
530    ### looking at the "source" attribute. This is a Parser Function that
531    ### can be used in the parser list of package.skeleton.dx(). TODO:
532    ### Modularize this into separate Parsers Functions for S4 classes,
533    ### prefixes, ##<<blocks, etc. Right now it is not very clean!
534    (code,
535    ### Code lines in a character vector containing multiple R objects to
536    ### parse for documentation.
537     objs,
538    ### The objects defined in the code.
539     ...
540    ### ignored
541     ){
542      parsed <- extract.file.parse(code)
543      extract.docs.try <- function(o,on)
544        {
545          ## Note: we could use parsed information here too, but that
546          ## would produce different results for setMethodS3 etc.
547          doc <- list()
548          if ( !is.null(parsed[[on]]) ){
549            if ( !is.na(parsed[[on]]@code[1]) ){ # no code given for generics
550              doc$definition <- paste(parsed[[on]]@code)
551            }
552            if(!"description"%in%names(doc) && !is.na(parsed[[on]]@description) ){
553              doc$description <- parsed[[on]]@description
554            }
555            ## if ( "setMethodS3" == parsed[[on]]@created ){
556            ##   gen <- leadingS3generic(on,topenv())
557            ##   if ( 0 < length(gen) ){
558            ##     doc$.s3method <- gen$.s3method
559            ##     cat("S3method(",gen$.s3method[1],",",gen$.s3method[2],")\n",sep="")
560            ##   }
561            ## }
562          }
563          if("title" %in% names(doc) && !"description" %in% names(doc) ){
564            ## For short functions having both would duplicate, but a
565            ## description is required. Therefore automatically copy title
566            ## across to avoid errors at package build time.
567            doc$description <- doc$title
568          }
569          doc
570        }
571      extract.docs <- function(on){
572        res <- try({o <- objs[[on]]
573                    extract.docs.try(o, on)},FALSE)
574        if(class(res)=="try-error"){
575          cat("Failed to extract docs for: ",on,"\n\n")
576          list()
577        } else if(0 == length(res) && inherits(objs[[on]],"standardGeneric")){
578          NULL
579        } else if(0 == length(res) && "function" %in% class(o)
580                  && 1 == length(osource <- attr(o,"source"))
581                  && grepl(paste("UseMethod(",on,")",sep="\""),osource)
582                  ){
583          ## phew - this should only pick up R.oo S3 generic definitions like:
584          ## attr(*, "source")= chr "function(...) UseMethod(\"select\")"
585          NULL
586        } else res
587      }
588      doc.names <- names(objs)
589      res <- sapply(doc.names,extract.docs,simplify=FALSE)
590      ## Special processing for S4 classes as they do not appear in normal ls()
591      for ( nn in names(parsed) ){
592        if ( parsed[[nn]]@created == "setClass" ){
593          S4class.docs <- extract.docs.setClass(parsed[[nn]])
594          docname <- paste(nn,"class",sep="-")
595          if ( is.null(res[[docname]]) ){
596            res[[docname]] <- S4class.docs
597            doc.names <- c(doc.names,docname)
598          } else {
599            stop(nn," appears as both S4 class and some other definition")
600          }
601        }
602      }
603      inherit.docs <- function(on){
604        in.res <- res[[on]]
605        if ( !is.null(parsed[[on]]) ){
606          for ( parent in parsed[[on]]@parent ){
607            if ( !is.na(parent) ){
608              if ( is.null(in.res) ){
609                in.res <- res[[parent]]
610              } else if ( parent %in% names(res) ){
611                parent.docs <- res[[parent]]
612                for ( nn in names(parent.docs) ){
613                  if ( !nn %in% names(in.res) ){
614                    in.res[[nn]] <- parent.docs[[nn]]
615                  }
616                }
617              }
618            }
619          }
620        }
621        invisible(in.res)
622      }
623      all.done <- FALSE
624      while ( !all.done ){
625        res1 <- sapply(doc.names,inherit.docs,simplify=FALSE)
626        all.done <- identical(res1,res)
627        res <- res1
628      }
629      ## now strip out any generics (which have value NULL in res):
630      res.not.null <- sapply(res,function(x){!is.null(x)})
631      if ( 0 < length(res.not.null) && length(res.not.null) < length(res) ){
632        res <- res[res.not.null]
633      }
634      res
635    ### named list of lists, one for each object to document.
636    }
637    
638    ### List of parsers to use by default with package.skeleton.dx.
639    default.parsers <-
640      c(extra.code.docs=extra.code.docs, ## TODO: cleanup!
641        sapply(forfun.parsers,forfun),
642        edit.package.file=function(desc,...){
643          in.details <- setdiff(colnames(desc),"Description")
644          details <- sprintf("%s: \\tab %s\\cr",in.details,desc[,in.details])
645          L <-
646            list(list(title=desc[,"Title"],
647                      description=desc[,"Description"],
648                      `tabular{ll}`=details))
649          names(L) <- paste(desc[,"Package"],"-package",sep="")
650          L
651        },
652        sapply(forall.parsers,forall)
653        )
654    
655  setClass("DocLink", # Link documentation among related functions  setClass("DocLink", # Link documentation among related functions
656  ### The \code{.DocLink} class provides the basis for hooking together  ### The \code{.DocLink} class provides the basis for hooking together
657  ### documentation of related classes/functions/objects. The aim is that  ### documentation of related classes/functions/objects. The aim is that
658  ### documentation sections missing from the child are  ### documentation sections missing from the child are inherited from
659    ### the parent class.
660           representation(name="character", ##<< name of object           representation(name="character", ##<< name of object
661                          created="character", ##<< how created                          created="character", ##<< how created
662                          parent="character", ##<< parent class or NA                          parent="character", ##<< parent class or NA
# Line 495  Line 691 
691      ## "prefix" lines will be used instead.      ## "prefix" lines will be used instead.
692      default.description <- NULL      default.description <- NULL
693      while ( start > last.end+1      while ( start > last.end+1
694             && 1 == length(grep(prefix,code[start-1],perl=TRUE)) ){             && grepl(prefix,code[start-1],perl=TRUE) ){
695        start <- start-1        start <- start-1
696      }      }
697      if ( start < chunks[[k]][1] ){      if ( start < chunks[[k]][1] ){
# Line 522  Line 718 
718        ## If the function definition is not embedded within the call, then        ## If the function definition is not embedded within the call, then
719        ## the parent is that function. Test whether the the third value        ## the parent is that function. Test whether the the third value
720        ## looks like a name and add it to parents if so.        ## looks like a name and add it to parents if so.
721        if ( 1 == length(grep("^[\\._\\w]+$",chars[3],perl=TRUE)) ){        if ( grepl("^[\\._\\w]+$",chars[3],perl=TRUE) ){
722          parent <- chars[3]          parent <- chars[3]
723        }        }
724        res[[object.name]] <- new("DocLink",name=object.name,        res[[object.name]] <- new("DocLink",name=object.name,
# Line 554  Line 750 
750        ## If the function definition is not embedded within the call, then        ## If the function definition is not embedded within the call, then
751        ## the parent is that function. Test whether the the fourth value        ## the parent is that function. Test whether the the fourth value
752        ## looks like a name and add it to parents if so.        ## looks like a name and add it to parents if so.
753        if ( 1 == length(grep("^[\\._\\w]+$",chars[4],perl=TRUE)) ){        if ( grepl("^[\\._\\w]+$",chars[4],perl=TRUE) ){
754          parent <- c(chars[4],parent)          parent <- c(chars[4],parent)
755        }        }
756        res[[object.name]] <- new("DocLink",name=object.name,        res[[object.name]] <- new("DocLink",name=object.name,
# Line 574  Line 770 
770  ### Using the same conventions as for functions, definitions of S4 classes  ### Using the same conventions as for functions, definitions of S4 classes
771  ### in the form \code{setClass("classname",\dots)} are also located and  ### in the form \code{setClass("classname",\dots)} are also located and
772  ### scanned for inline comments.  ### scanned for inline comments.
773  (doc.link)  (doc.link
774  ### DocLink object as created by \code{\link{extract.file.parse}}.  ### DocLink object as created by \code{\link{extract.file.parse}}.
775  ### Note that \code{source} statements are \emph{ignored} when scanning for  ### Note that \code{source} statements are \emph{ignored} when scanning for
776  ### class definitions.  ### class definitions.
777  {   ){
778    chunk.source <- doc.link@code    chunk.source <- doc.link@code
779    ##details<<    ##details<<
780    ## Extraction of S4 class documentation is currently limited to expressions    ## Extraction of S4 class documentation is currently limited to expressions
# Line 595  Line 791 
791    ## the same line or \code{### } comments at the beginning of the    ## the same line or \code{### } comments at the beginning of the
792    ## following line.    ## following line.
793    f.n <- paste(class.name,"class",sep="-")    f.n <- paste(class.name,"class",sep="-")
794    docs <- extract.docs.fun(chunk.source,f.n)    docs <- extract.xxx.chunks(chunk.source,f.n)
795      ## also apply source parsing functions that I separated out into
796      ## separate functions
797      docs <- combine(docs,lonely$prefixed.lines(chunk.source))
798      docs$title <- lonely$title.from.firstline(chunk.source)
799    ##details<<    ##details<<
800    ## The class definition skeleton includes an \code{Objects from the Class}    ## The class definition skeleton includes an \code{Objects from the Class}
801    ## section, to which any \code{##details<<} documentation chunks are    ## section, to which any \code{##details<<} documentation chunks are
# Line 619  Line 819 
819    }    }
820    invisible(docs)    invisible(docs)
821  }  }
822    
823    apply.parsers <- function
824    ### Parse code to r objs, then run all the parsers and return the
825    ### documentation list.
826    (code,
827    ### Character vector of code lines.
828     parsers=default.parsers,
829    ### List of Parser Functions.
830     verbose=FALSE,
831    ### Echo names of Parser Functions?
832     ...
833    ### Additional arguments to pass to Parser Functions.
834     ){
835      e <- new.env()
836      ## KMP 2011-03-09 fix problem with DocLink when inlinedocs ran on itself
837      ## Error in assignClassDef(Class, classDef, where) :
838      ##   Class "DocLink" has a locked definition in package "inlinedocs"
839      ## Traced to "where" argument in setClassDef which defaults to topenv()
840      ## which in turn is inlinedocs when processing inlinedocs package, hence
841      ## the clash. The following works (under R 2.12.2), so that the topenv()
842      ## now finds e before finding the inlinedocs environment.
843      old <- options(keep.source=TRUE,topLevelEnvironment=e)
844      on.exit(options(old))
845      exprs <- parse(text=code)
846      ## TDH 2011-04-07 set this so that no warnings about creating a fake
847      ## package when we try to process S4 classes defined in code
848      e$.packageName <- "inlinedocs.processor"
849      for (i in exprs){
850        ## TDH 2011-04-07 Disable this tryCatch since it makes it harder
851        ##to debug errors/warnings in the evaluated code
852    
853        ##tryCatch({
854          eval(i, e)
855        ##},error=function(e){
856          ##print(e)
857        ##})
858      }
859      objs <- sapply(ls(e),get,e,simplify=FALSE)
860    
861      docs <- list()
862    
863      ## apply parsers in sequence to code and objs
864      for(i in seq_along(parsers)){
865        N <- names(parsers[i])
866        if(verbose){
867          if(is.character(N) && N!=""){
868            cat(N," ",sep="")
869          }else cat('. ')
870        }
871        p <- parsers[[i]]
872        ## This is the argument list that each parser receives:
873        L <- p(code=code,objs=objs,docs=docs,env=e,...)
874        docs <- combine(docs,L)
875      }
876      ## post-process to collapse all character vectors
877      for(i in seq_along(docs)){
878        for(j in seq_along(docs[[i]])){
879          if(names(docs[[i]])[j]!=".s3method")
880          docs[[i]][[j]] <- paste(docs[[i]][[j]],collapse="\n")
881        }
882      }
883      if(verbose)cat("\n")
884      docs
885    ### A list of extracted documentation from code.
886    }
887    
888    ### Names of Parser Functions that operate on the desc arg.
889    descfile.names <- c("author.from.description","edit.package.file")
890    
891    ### Names of Parser Functions that do NOT use the desc arg.
892    non.descfile.names <-
893      names(default.parsers)[!names(default.parsers)%in%descfile.names]
894    
895    ### Parsers that operate only on R code, independently of the
896    ### description file.
897    nondesc.parsers <- default.parsers[non.descfile.names]
898    
899    extract.docs.file <- structure(function
900    ### Apply all parsers relevant to extract info from just 1 code file.
901    (f,
902    ### File name of R code to read and parse.
903     parsers=NULL,
904    ### Parser Functions to use to parse the code and extract
905    ### documentation.
906     ...
907    ### Other arguments to pass to Parser Functions.
908     ){
909      if(is.null(parsers))parsers <- nondesc.parsers
910      apply.parsers(readLines(f),parsers,verbose=FALSE,...)
911    },ex=function(){
912      f <- system.file("silly","R","silly.R",package="inlinedocs")
913      extract.docs.file(f)
914    })
915    

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

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