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 162, Wed Nov 10 09:18:20 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    forall <- function
32  ### For each object in the package that satisfies the criterion  ### For each object in the package that satisfies the criterion
33  ### checked by subfun, parse source using FUN and return the resulting  ### checked by subfun, parse source using FUN and return the resulting
34  ### documentation list.  ### documentation list.
 forall <- function  
35  (FUN,  (FUN,
36  ### Function to apply to each element in the package.  ### Function to apply to each element in the package.
37   subfun=function(x)TRUE   subfun=function(x)TRUE
# Line 9  Line 39 
39  ### 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
40  ### the result will be returned.  ### the result will be returned.
41   ){   ){
42    function(objs,docs,...){    FUN <- FUN
43      f <- function(objs,docs,...){
44      objs <- objs[sapply(objs,subfun)]      objs <- objs[sapply(objs,subfun)]
45      L <- list()      L <- list()
46      for(N in names(objs)){      on.exit(cat(sprintf("Parser Function failed on %s\n",N)))
47        for(N in names(docs)){
48        o <- objs[[N]]        o <- objs[[N]]
49        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"),
50                        name=N,objs=objs,o=o,docs=docs,doc=docs[[N]],...)
51      }      }
52        on.exit()## remove warning message
53      L      L
54    }    }
55      class(f) <- c("allfun","function")
56      f
57  ### A Parser Function.  ### A Parser Function.
58  }  }
59    
60    ### Print method for functions constructed using forall.
61    print.allfun <- function(x,...){
62      e <- environment(x)
63      cat("Function to apply to every element.\nselector:")
64      print(e$subfun)
65      cat("processor:")
66      print(e$FUN)
67    }
68    
69  ### For each function in the package, do something.  ### For each function in the package, do something.
70  forfun <- function(FUN)forall(FUN,is.function)  forfun <- function(FUN)forall(FUN,is.function)
71    
72  ### Get last line (test)  examples.after.return <- function
 parsefuns <- forfun(function(src,name,...){  
   extract.docs.fun(src,name)  
 })  
   
 ### 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()  
 })  
   
73  ### Get examples from inline definitions after return()  ### Get examples from inline definitions after return()
74  examples.after.return <- forfun(function(src,...){  ### PhG: this does not work well! Think of these situations:
75    rline <- grep("return([^)]*)",src)  ### 1) You have multiple return() in the code of your function,
76    if(length(rline)==0)return(list())  ### 2) You have return() appearing is some example code, ...
77    rline <- rline[length(rline)]  ### I can hardly propose a hack here. The whole code of the function
78    comment.line.nums <- grep(prefix,src)  ### must be parsed, and one must determine which one is the last line
79    if(!(comment.end <- rline+1)%in%comment.line.nums)return(list())  ### of code that is actually executed.
80    while(comment.end%in%comment.line.nums)comment.end <- comment.end+1  ###
81    excode <- src[comment.end:(length(src)-1)]  ### I make two propositions here
82    list(examples=paste(gsub("^\\W*","",excode),collapse="\n"))  ### 1) to keep the same mechanism that has the advantage of simplicity
83  })  ###    but to use a special tag
84    ###    ##examples<< or #{{{examples to separate
85  extract.docs.file <- function # Extract documentation from a file  ###    function code from examples explicitly, and
86  ### Parse R code to extract inline documentation from comments around  ### 2) to place the example in an "ex" attribute
87  ### each function. These are not able to be retreived simply by  ###    attached to the function
88  ### looking at the "source" attribute. This is a Parser Function that  ###    (see next parser). That solution will be also interesting for
89  ### can be used in the parser list of package.skeleton.dx().  ###    documenting datasets, something not done yet by inlinedocs!
90  (code,  (src,name="",...) {
91  ### Code lines in a character vector containing multiple R objects to    ## Look for the examples mark
92  ### parse for documentation.    m <- grep("^\\s*(##examples<<|#\\{\\{\\{examples)", src)
93   objs,    if (!length(m)) return(list())
94  ### The objects defined in the code.    if (length(m) > 1)
95   ...      warning("More than one examples tag for ", name,
96  ### ignored              ". Taking the last one")
97   ){    m <- m[length(m)]
98    parsed <- extract.file.parse(code)    ## Look for the lines containing return value comments just before
99    extract.docs.try <- function(o,on)    r <- grep("\\s*### ", src[1:(m-1)])
100      {      if (!length(r)) {
101        ## Note: we could use parsed information here too, but that        value <- NULL
102        ## would produce different results for setMethodS3 etc.      } else {
103        doc <- list()        ## Only take consecutive lines before the mark
104        if ( !is.null(parsed[[on]]) ){        keep <- rev((m - rev(r)) == 1:length(r))
105          if ( !is.na(parsed[[on]]@code[1]) ){ # no code given for generics        if (!any(keep)) {
106            doc$definition <- paste(parsed[[on]]@code,collapse="\n")          value <- NULL
107          }        } else {
108          if(!"description"%in%names(doc) && !is.na(parsed[[on]]@description) ){          value <- decomment(src[r[keep]])
109            doc$description <- parsed[[on]]@description        }
110          }      }
111          if ( "setMethodS3" == parsed[[on]]@created ){    ## Collect now the example code beneath the mark
112            pattern <- "^([^\\.]+)\\.(.*)$"    ex <- src[(m + 1):(length(src) - 1)]
113            doc$s3method=c(m1 <- gsub(pattern,"\\1",on,perl=TRUE),    ## Possibly eliminate a #}}} tag
114                m2 <- gsub(pattern,"\\2",on,perl=TRUE))    ex <- ex[!grepl("#}}}", ex)]
115            if ( 0 < length(grep("\\W",m1,perl=TRUE)) ){    ## Eliminate leading tabulations or four spaces
116              m1 <- paste("`",m1,"`",sep="")    prefixes <- gsub("(\\s*).*","\\1",ex,perl=TRUE)[grep("\\w",ex)]
117            }    FIND <- prefixes[which.min(nchar(prefixes))]
118            cat("S3method(",m1,",",m2,")\n",sep="")    ex <- sub(FIND,"",ex)
119          }    ## Add an empty line before and after example
120        }    ex <- c("", ex, "")
121        if("title" %in% names(doc) && !"description" %in% names(doc) ){    ## Return examples and value
122          ## For short functions having both would duplicate, but a    list(examples = paste(ex, collapse = "\n"), value = value)
123          ## description is required. Therefore automatically copy title  }
124          ## across to avoid errors at package build time.  
125          doc$description <- doc$title  prefixed.lines <- function(src,...){
126        }  ### The primary mechanism of inline documentation is via consecutive
127        doc  ### groups of lines matching the specified prefix regular expression
128      }  ### "\code{^### }" (i.e. lines beginning with "\code{### }") are
129    extract.docs <- function(on){  ### collected as follows into documentation sections:\describe{
130      res <- try({o <- objs[[on]]  ### \item{description}{group starting at line 2 in the code}
131                  extract.docs.try(o, on)},FALSE)  ### \item{arguments}{group following each function argument}
132      if(class(res)=="try-error"){  ### \item{value}{group ending at the penultimate line of the code}}
133        cat("Failed to extract docs for: ",on,"\n\n")  ### These may be added to by use of the \code{##<<} constructs
134        list()  ### described below.
135      } else if(0 == length(res) && inherits(objs[[on]],"standardGeneric")){    clines <- grep(prefix,src)
136        NULL    if(length(clines)==0)return(list())
     } 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.  
137      bounds <- which(diff(clines)!=1)      bounds <- which(diff(clines)!=1)
138      starts <- c(1,bounds+1)      starts <- c(1,bounds+1)
139      ends <- c(bounds,length(clines))      ends <- c(bounds,length(clines))
140      ## detect body of function using paren matching
141      code <- gsub("#.*","",src)
142      f <- function(ch)cumsum(nchar(gsub(sprintf("[^%s]",ch),"",code)))
143      parens <- f("(")-f(")")
144      body.begin <- which(diff(parens)<0 & parens[-1]==0)+2
145      is.arg <- function(){
146        gres <- grep("^\\s*#",src[start-1],perl=TRUE)
147        0 == length(gres) && start<=body.begin
148      }
149      res <- list()
150      for(i in seq_along(starts)){      for(i in seq_along(starts)){
151        start <- clines[starts[i]]        start <- clines[starts[i]]
152        end <- clines[ends[i]]        end <- clines[ends[i]]
153        lab <- if(end+1==length(code))"value"      lab <- if(end+1==length(src))"value"
154        else if(start==2)"description"        else if(start==2)"description"
155        else if ( 0 == length(grep("^\\s*#",code[start-1],perl=TRUE)) ){      else if(is.arg()){
156           #arg <- gsub("^[ (]*","",code[start-1])        ##twutz: strip leading white spaces and brackets and ,
157           #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 ,  
158                   arg <- gsub("^([^=,]*)[=,].*", "\\1", arg)                   arg <- gsub("^([^=,]*)[=,].*", "\\1", arg)
159                   arg <- gsub("^([^ \t]*)([ \t]+)$","\\1",arg)   #twutz: remove trailing whitespaces        ##twutz: remove trailing whitespaces
160          arg <- gsub("^([^ \t]*)([ \t]+)$","\\1",arg)
161                   arg <- gsub("...", "\\dots", arg, fix = TRUE)                   arg <- gsub("...", "\\dots", arg, fix = TRUE)
162           paste("item{",arg,"}",sep="")           paste("item{",arg,"}",sep="")
163         } else {         } else {
164           next;           next;
165         }         }
166        res[[lab]] <- decomment(code[start:end])      res[[lab]] <- decomment(src[start:end])
167      }      }
168      res
169    }    }
170    
171    extract.xxx.chunks <- function # Extract documentation from a function
172    ### Given source code of a function, return a list describing inline
173    ### documentation in that source code.
174    (src,
175    ### The source lines of the function to examine, as a character
176    ### vector.
177     name.fun="(unnamed function)",
178    ### The name of the function/chunk to use in warning messages.
179     ...
180    ### ignored.
181     ){
182      res <- list()
183    ##details<< For simple functions/arguments, the argument may also be    ##details<< For simple functions/arguments, the argument may also be
184    ## documented by appending \code{##<<} comments on the same line as the    ## documented by appending \code{##<<} comments on the same line as the
185    ## argument name. Mixing this mechanism with \code{###} comment lines for    ## argument name. Mixing this mechanism with \code{###} comment lines for
# Line 306  Line 258 
258            else paste(res[[field]], payload, sep=chunk.sep)            else paste(res[[field]], payload, sep=chunk.sep)
259        invisible(chunk.res)        invisible(chunk.res)
260      }      }
261    while ( k <= length(code) ){    while ( k <= length(src) ){
262      line <- code[k]      line <- src[k]
263      if ( 0 < length(grep(extra.regexp,line,perl=TRUE) ) ){      if ( 0 < length(grep(extra.regexp,line,perl=TRUE) ) ){
264        ## 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
265        new.field <- gsub(extra.regexp,"\\1",line,perl=TRUE)        new.field <- gsub(extra.regexp,"\\1",line,perl=TRUE)
# Line 407  Line 359 
359        arg <- gsub(arg.pat,"\\\\item\\{\\1\\}",line,perl=TRUE)        arg <- gsub(arg.pat,"\\\\item\\{\\1\\}",line,perl=TRUE)
360        in.chunk <- TRUE        in.chunk <- TRUE
361        if ( not.describe ){        if ( not.describe ){
362            ## TDH 2010-06-18 For item{}s in the documentation list names,
363            ## we don't need to have a backslash before, so delete it.
364            arg <- gsub("^[\\]+","",arg)
365          cur.field <- gsub("...","\\dots",arg,fix=TRUE) ##special case for dots          cur.field <- gsub("...","\\dots",arg,fix=TRUE) ##special case for dots
366          payload <- comment          payload <- comment
367        } else {        } else {
# Line 457  Line 412 
412  ### with the string in this list (implemented in modify.Rd.file).  ### with the string in this list (implemented in modify.Rd.file).
413  }  }
414    
415    ### Parsers for each function that are constructed automatically. This
416    ### is a named list, and each element is a parser function for an
417    ### individual object.
418    forfun.parsers <-
419      list(prefixed.lines=prefixed.lines,
420           examples.after.return=examples.after.return,
421           extract.xxx.chunks=extract.xxx.chunks,
422           ## title from first line of function def
423           title.from.firstline=function(src,name,code,...){
424             if(length(grep("#",src[1]))){
425               list(title=gsub("[^#]*#\\s*(.*)","\\1",src[1],perl=TRUE))
426             } else list()
427           },
428           ## PhG: it is tests/FUN.R!!! I would like more flexibility here
429           ## please, let me choose which dir to use for examples!
430           ## Get examples for FUN from the file tests/FUN.R
431           examples.from.testfile=function(name,...){
432             tsubdir <- getOption("inlinedocs.exdir")
433             if (is.null(tsubdir)) tsubdir <- "tests"       # Default value
434             tfile <- file.path("..",tsubdir,paste(name,".R",sep=""))
435             if(file.exists(tfile))
436               list(examples=paste(readLines(tfile),collapse="\n"))
437             else list()
438           },
439           definition.from.source=function(doc,src,...){
440             def <- doc$definition
441             is.empty <- function(x)is.null(x)||x==""
442             if(is.empty(def) && !is.empty(src))
443               list(definition=paste(src,collapse="\n"))
444             else list()
445           })
446    
447    ### List of Parser Functions that can be applied to any object.
448    forall.parsers <-
449      list(## Fill in author from DESCRIPTION and titles.
450           author.from.description=function(desc,...){
451             list(author=desc[,"Maintainer"])
452           },
453           ## The format section sometimes causes problems, so erase it.
454           erase.format=function(...){
455             list(format="")
456           },
457           ## Convert the function name to a title.
458           title.from.name=function(name,doc,...){
459             if("title"%in%names(doc))list() else
460             list(title=gsub("[._]"," ",name))
461           },
462           ## PhG: here is what I propose for examples code in the 'ex' attribute
463           examples.in.attr =  function (name, o, ...) {
464             ex <- attr(o, "ex")
465             if (!is.null(ex)) {
466               ## Special case for code contained in a function
467               if (inherits(ex, "function")) {
468                 ## If source is available, start from there
469                 src <- attr(ex, "source")
470                 if (!is.null(src)) {
471                   ex <- src
472                 } else { ## Use the body of the function
473                   ex <- deparse(body(ex))
474                 }
475                 ## Eliminate leading and trailing code
476                 ex <- ex[-c(1, length(ex))]
477                 ## Eliminate leading tabulations or 2/4 spaces
478                 ex <- sub("^\t|    |  ", "", ex)
479                 ## Add an empty line before and after example
480                 ex <- c("", ex, "")
481               }
482               list(examples = paste(ex, collapse = "\n"))
483             } else list()
484           })
485    
486    ### List of parser functions that operate on single objects. This list
487    ### is useful for testing these functions.
488    lonely <- c(forall.parsers,forfun.parsers)
489    attr(lonely,"ex") <- function(){
490      f <- function # title
491    ### description
492      (x, ##<< arg x
493       y
494    ### arg y
495       ){
496        ##value<< a list with elements
497        list(x=x, ##<< original x value
498             y=y, ##<< original y value
499             sum=x+y) ##<< their sum
500        ##end<<
501      }
502      src <- attr(f,"source")
503      lonely$extract.xxx.chunks(src)
504      lonely$prefixed.lines(src)
505    }
506    
507    extra.code.docs <- function # Extract documentation from code chunks
508    ### Parse R code to extract inline documentation from comments around
509    ### each function. These are not able to be retreived simply by
510    ### looking at the "source" attribute. This is a Parser Function that
511    ### can be used in the parser list of package.skeleton.dx(). TODO:
512    ### Modularize this into separate Parsers Functions for S4 classes,
513    ### prefixes, ##<<blocks, etc. Right now it is not very clean!
514    (code,
515    ### Code lines in a character vector containing multiple R objects to
516    ### parse for documentation.
517     objs,
518    ### The objects defined in the code.
519     ...
520    ### ignored
521     ){
522      parsed <- extract.file.parse(code)
523      extract.docs.try <- function(o,on)
524        {
525          ## Note: we could use parsed information here too, but that
526          ## would produce different results for setMethodS3 etc.
527          doc <- list()
528          if ( !is.null(parsed[[on]]) ){
529            if ( !is.na(parsed[[on]]@code[1]) ){ # no code given for generics
530              doc$definition <- paste(parsed[[on]]@code,collapse="\n")
531            }
532            if(!"description"%in%names(doc) && !is.na(parsed[[on]]@description) ){
533              doc$description <- parsed[[on]]@description
534            }
535            if ( "setMethodS3" == parsed[[on]]@created ){
536              # PhG: this may be wrong! It does not catch correctly how the method
537              # must be splitted in case of methods containing dots. for instance,
538              # as.data.frame.matrix must be split into: m1 = as.data.frame and
539              # m2 = matrix... here you got m1 = as, and m2 = data.frame.matrix!!!
540                      pattern <- "^([^\\.]+)\\.(.*)$"
541              doc$s3method=c(m1 <- gsub(pattern,"\\1",on,perl=TRUE),
542                  m2 <- gsub(pattern,"\\2",on,perl=TRUE))
543              if ( 0 < length(grep("\\W",m1,perl=TRUE)) ){
544                              m1 <- paste("`",m1,"`",sep="")
545              }
546              cat("S3method(",m1,",",m2,")\n",sep="")
547            }
548          }
549          if("title" %in% names(doc) && !"description" %in% names(doc) ){
550            ## For short functions having both would duplicate, but a
551            ## description is required. Therefore automatically copy title
552            ## across to avoid errors at package build time.
553            doc$description <- doc$title
554          }
555          doc
556        }
557      extract.docs <- function(on){
558        res <- try({o <- objs[[on]]
559                    extract.docs.try(o, on)},FALSE)
560        if(class(res)=="try-error"){
561          cat("Failed to extract docs for: ",on,"\n\n")
562          list()
563        } else if(0 == length(res) && inherits(objs[[on]],"standardGeneric")){
564          NULL
565        } else if(0 == length(res) && "function" %in% class(o)
566                  && 1 == length(osource <- attr(o,"source"))
567                  && 1 == length(grep(paste("UseMethod(",on,")",sep="\""),osource))
568                  ){
569          ## phew - this should only pick up R.oo S3 generic definitions like:
570          ## attr(*, "source")= chr "function(...) UseMethod(\"select\")"
571          NULL
572        } else res
573      }
574      doc.names <- names(objs)
575      res <- sapply(doc.names,extract.docs,simplify=FALSE)
576      ## Special processing for S4 classes as they do not appear in normal ls()
577      for ( nn in names(parsed) ){
578        if ( parsed[[nn]]@created == "setClass" ){
579          S4class.docs <- extract.docs.setClass(parsed[[nn]])
580          docname <- paste(nn,"class",sep="-")
581          if ( is.null(res[[docname]]) ){
582            res[[docname]] <- S4class.docs
583            doc.names <- c(doc.names,docname)
584          } else {
585            stop(nn," appears as both S4 class and some other definition")
586          }
587        }
588      }
589      inherit.docs <- function(on){
590        in.res <- res[[on]]
591        if ( !is.null(parsed[[on]]) ){
592          for ( parent in parsed[[on]]@parent ){
593            if ( !is.na(parent) ){
594              if ( is.null(in.res) ){
595                in.res <- res[[parent]]
596              } else if ( parent %in% names(res) ){
597                parent.docs <- res[[parent]]
598                for ( nn in names(parent.docs) ){
599                  if ( !nn %in% names(in.res) ){
600                    in.res[[nn]] <- parent.docs[[nn]]
601                  }
602                }
603              }
604            }
605          }
606        }
607        invisible(in.res)
608      }
609      all.done <- FALSE
610      while ( !all.done ){
611        res1 <- sapply(doc.names,inherit.docs,simplify=FALSE)
612        all.done <- identical(res1,res)
613        res <- res1
614      }
615      ## now strip out any generics (which have value NULL in res):
616      res.not.null <- sapply(res,function(x){!is.null(x)})
617      if ( 0 < length(res.not.null) && length(res.not.null) < length(res) ){
618        res <- res[res.not.null]
619      }
620      res
621    ### named list of lists, one for each object to document.
622    }
623    
624    ### List of parsers to use by default with package.skeleton.dx.
625    default.parsers <-
626      c(extra.code.docs=extra.code.docs, ## TODO: cleanup!
627        sapply(forfun.parsers,forfun),
628        sapply(forall.parsers,forall),
629        edit.package.file=function(desc,...){
630          in.details <- setdiff(colnames(desc),"Description")
631          details <- paste(paste(in.details,": \\tab ",desc[,in.details],"\\cr",
632                                 sep=""),collapse="\n")
633          L <-
634            list(list(title=desc[,"Title"],
635                      description=desc[,"Description"],
636                      `tabular{ll}`=details,
637                      author=desc[,"Maintainer"]))
638          names(L) <- paste(desc[,"Package"],"-package",sep="")
639          L
640        })
641    
642  setClass("DocLink", # Link documentation among related functions  setClass("DocLink", # Link documentation among related functions
643  ### The \code{.DocLink} class provides the basis for hooking together  ### The \code{.DocLink} class provides the basis for hooking together
644  ### documentation of related classes/functions/objects. The aim is that  ### documentation of related classes/functions/objects. The aim is that
# Line 574  Line 756 
756  ### Using the same conventions as for functions, definitions of S4 classes  ### Using the same conventions as for functions, definitions of S4 classes
757  ### in the form \code{setClass("classname",\dots)} are also located and  ### in the form \code{setClass("classname",\dots)} are also located and
758  ### scanned for inline comments.  ### scanned for inline comments.
759  (doc.link)  (doc.link
760  ### DocLink object as created by \code{\link{extract.file.parse}}.  ### DocLink object as created by \code{\link{extract.file.parse}}.
761  ### Note that \code{source} statements are \emph{ignored} when scanning for  ### Note that \code{source} statements are \emph{ignored} when scanning for
762  ### class definitions.  ### class definitions.
763  {   ){
764    chunk.source <- doc.link@code    chunk.source <- doc.link@code
765    ##details<<    ##details<<
766    ## Extraction of S4 class documentation is currently limited to expressions    ## Extraction of S4 class documentation is currently limited to expressions
# Line 595  Line 777 
777    ## the same line or \code{### } comments at the beginning of the    ## the same line or \code{### } comments at the beginning of the
778    ## following line.    ## following line.
779    f.n <- paste(class.name,"class",sep="-")    f.n <- paste(class.name,"class",sep="-")
780    docs <- extract.docs.fun(chunk.source,f.n)    docs <- extract.xxx.chunks(chunk.source,f.n)
781      ## also apply source parsing functions that I separated out into
782      ## separate functions
783      docs <- combine(docs,lonely$prefixed.lines(chunk.source))
784      docs$title <- lonely$title.from.firstline(chunk.source)
785    ##details<<    ##details<<
786    ## The class definition skeleton includes an \code{Objects from the Class}    ## The class definition skeleton includes an \code{Objects from the Class}
787    ## section, to which any \code{##details<<} documentation chunks are    ## section, to which any \code{##details<<} documentation chunks are
# Line 619  Line 805 
805    }    }
806    invisible(docs)    invisible(docs)
807  }  }
808    
809    apply.parsers <- function
810    ### Parse code to r objs, then run all the parsers and return the
811    ### documentation list.
812    (code,
813    ### Character vector of code lines.
814     parsers=default.parsers,
815    ### List of Parser Functions.
816     verbose=FALSE,
817    ### Echo names of Parser Functions?
818     ...
819    ### Additional arguments to pass to Parser Functions.
820     ){
821      e <- new.env()
822      old <- options(keep.source=TRUE)
823      on.exit(options(old))
824      exprs <- parse(text=code)
825      for (i in exprs){
826        tryCatch(eval(i, e),error=function(e){
827          ##print(e)
828        })
829      }
830      objs <- sapply(ls(e),get,e,simplify=FALSE)
831    
832      docs <- list()
833    
834      # PhG: Automatically determine who is S3 methods
835      for (name in names(objs)) {
836        parts <- strsplit(name, ".", fixed = TRUE)[[1]]
837            l <- length(parts)
838            if (l > 1) {
839            for (i in 1:(l - 1)) {
840                # Look for a generic function (known by the system or defined
841                # in the package) that matches that part of the function name
842                generic <- paste(parts[1:i], collapse = ".")
843                if (any(generic %in% utils:::getKnownS3generics()) ||
844                    utils:::findGeneric(generic, e) != "") {
845                    object <- paste(parts[(i + 1):l], collapse = ".")
846                    docs[[name]]$s3method <- c(generic, object)
847                    break
848                }
849            }
850        }
851      }
852      ## apply parsers in sequence to code and objs
853      for(i in seq_along(parsers)){
854        N <- names(parsers[i])
855        if(verbose){
856          if(is.character(N) && N!=""){
857            cat(N," ",sep="")
858          }else cat('. ')
859        }
860        p <- parsers[[i]]
861        ## This is the argument list that each parser receives:
862        L <- p(code=code,objs=objs,docs=docs,...)
863        docs <- combine(docs,L)
864      }
865      if(verbose)cat("\n")
866      docs
867    ### A list of extracted documentation from code.
868    }
869    
870    ### Names of Parser Functions that operate on the desc arg.
871    descfile.names <- c("author.from.description","edit.package.file")
872    
873    ### Names of Parser Functions that do NOT use the desc arg.
874    non.descfile.names <-
875      names(default.parsers)[!names(default.parsers)%in%descfile.names]
876    
877    ### Parsers that operate only on R code, independently of the
878    ### description file.
879    nondesc.parsers <- default.parsers[non.descfile.names]
880    
881    extract.docs.file <- function
882    ### Apply all parsers relevant to extract info from just 1 code file.
883    (f,
884    ### File name of R code to read and parse.
885     parsers=nondesc.parsers,
886    ### Parser Functions to use to parse the code and extract
887    ### documentation.
888     ...
889    ### Other arguments to pass to Parser Functions.
890     ){
891      apply.parsers(readLines(f),parsers,verbose=FALSE,...)
892    }

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

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