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 163, Tue Nov 16 12:06:29 2010 UTC revision 324, Wed Feb 1 17:16:32 2012 UTC
# Line 7  Line 7 
7    
8  ### combine lists by adding elements or adding to existing elements  ### combine lists by adding elements or adding to existing elements
9  combine.list <- function(x,y){  combine.list <- function(x,y){
10    toadd <- !names(y)%in%names(x)    toadd <- if(".overwrite"%in%names(y)){
11    toup <- names(y)[names(y)%in%names(x)]      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]    x[names(y)[toadd]] <- y[toadd]
18    for(up in toup)x[[up]] <- combine(x[[up]],y[[up]])    for(up in toup)x[[up]] <- combine(x[[up]],y[[up]])
19    return(x)    x
20  ### A list, same type as x, but with added elements from y.  ### A list, same type as x, but with added elements from y.
21  }  }
22    
23    
24    getSource <- function
25    ### Extract a function's source code.
26    (fun.obj
27    ### A function.
28     ) {
29          srcref <- attr(fun.obj, "srcref")
30          if (!is.null(srcref)) {
31            ##unlist(strsplit(as.character(srcref), "\n"))
32            as.character(srcref)
33          }
34          else attr(fun.obj, "source")
35    ### Source code lines as a character vector.
36    }
37    
38  ### Prefix for code comments used with grep and gsub.  ### Prefix for code comments used with grep and gsub.
39  prefix <- "^[ \t]*###[ \t]"  prefix <- "^[ \t]*###[ \t]*"
40    
41  decomment <- function  decomment <- function
42  ### Remove comment prefix and join lines of code to form a  ### Remove comment prefix and join lines of code to form a
# Line 24  Line 44 
44  (comments  (comments
45  ### Character vector of prefixed comment lines.  ### Character vector of prefixed comment lines.
46   ){   ){
47    paste(gsub(prefix,"",comments),collapse="\n")    gsub(prefix,"",comments)
48  ### String without prefixes or newlines.  ### String without prefixes or newlines.
49  }  }
50    
# Line 41  Line 61 
61   ){   ){
62    FUN <- FUN    FUN <- FUN
63    f <- function(objs,docs,...){    f <- function(objs,docs,...){
64        if(length(objs)==0)return(list())
65      objs <- objs[sapply(objs,subfun)]      objs <- objs[sapply(objs,subfun)]
66      L <- list()      L <- list()
67      on.exit(cat(sprintf("Parser Function failed on %s\n",N)))      on.exit(cat(sprintf("Parser Function failed on %s\n",N)))
68      for(N in names(docs)){      for(N in union(names(docs),names(objs))){
69        o <- objs[[N]]        o <- objs[[N]]
70        L[[N]] <- FUN(src=attr(o,"source"),        L[[N]] <- FUN(src=getSource(o),
71                      name=N,objs=objs,o=o,docs=docs,doc=docs[[N]],...)                      name=N,objs=objs,o=o,docs=docs,doc=docs[[N]],...)
72      }      }
73      on.exit()## remove warning message      on.exit()## remove warning message
# Line 84  Line 105 
105  ### Character vector of code lines with preceding whitespace removed.  ### Character vector of code lines with preceding whitespace removed.
106  }  }
107    
108  examples.after.return <- function  prefixed.lines <- structure(function(src,...){
 ### Get examples from inline definitions after return()  
 ### PhG: this does not work well! Think of these situations:  
 ### 1) You have multiple return() in the code of your function,  
 ### 2) You have return() appearing is some example code, ...  
 ### I can hardly propose a hack here. The whole code of the function  
 ### must be parsed, and one must determine which one is the last line  
 ### of code that is actually executed.  
 ###  
 ### I make two propositions here  
 ### 1) to keep the same mechanism that has the advantage of simplicity  
 ###    but to use a special tag  
 ###    ##examples<< or #{{{examples to separate  
 ###    function code from examples explicitly, and  
 ### 2) to place the example in an "ex" attribute  
 ###    attached to the function  
 ###    (see next parser). That solution will be also interesting for  
 ###    documenting datasets, something not done yet by inlinedocs!  
 (src,name="",...) {  
   ## Look for the examples mark  
   m <- grep("^\\s*(##examples<<|#\\{\\{\\{examples)", src)  
   if (!length(m)) return(list())  
   if (length(m) > 1)  
     warning("More than one examples tag for ", name,  
             ". Taking the last one")  
   m <- m[length(m)]  
   ## Look for the lines containing return value comments just before  
   r <- grep("\\s*### ", src[1:(m-1)])  
     if (!length(r)) {  
       value <- NULL  
     } else {  
       ## Only take consecutive lines before the mark  
       keep <- rev((m - rev(r)) == 1:length(r))  
       if (!any(keep)) {  
         value <- NULL  
       } else {  
         value <- decomment(src[r[keep]])  
       }  
     }  
   ## Collect now the example code beneath the mark  
   ex <- src[(m + 1):(length(src) - 1)]  
   ## Possibly eliminate a #}}} tag  
   ex <- ex[!grepl("#}}}", ex)]  
   ## Eliminate leading tabulations or four spaces  
   ex <- kill.prefix.whitespace(ex)  
   ## Add an empty line before and after example  
   ex <- c("", ex, "")  
   ## Return examples and value  
   list(examples = paste(ex, collapse = "\n"), value = value)  
 }  
   
 prefixed.lines <- function(src,...){  
109  ### The primary mechanism of inline documentation is via consecutive  ### The primary mechanism of inline documentation is via consecutive
110  ### groups of lines matching the specified prefix regular expression  ### groups of lines matching the specified prefix regular expression
111  ### "\code{^### }" (i.e. lines beginning with "\code{### }") are  ### "\code{^### }" (i.e. lines beginning with "\code{### }") are
# Line 155  Line 125 
125    f <- function(ch)cumsum(nchar(gsub(sprintf("[^%s]",ch),"",code)))    f <- function(ch)cumsum(nchar(gsub(sprintf("[^%s]",ch),"",code)))
126    parens <- f("(")-f(")")    parens <- f("(")-f(")")
127    body.begin <- which(diff(parens)<0 & parens[-1]==0)+2    body.begin <- which(diff(parens)<0 & parens[-1]==0)+2
128      if(length(body.begin)==0)body.begin <- 1 ## rare cases
129    is.arg <- function(){    is.arg <- function(){
130      gres <- grep("^\\s*#",src[start-1],perl=TRUE)      gres <- grep("^\\s*#",src[start-1],perl=TRUE)
131      0 == length(gres) && start<=body.begin      0 == length(gres) && start<=body.begin
# Line 163  Line 134 
134    for(i in seq_along(starts)){    for(i in seq_along(starts)){
135      start <- clines[starts[i]]      start <- clines[starts[i]]
136      end <- clines[ends[i]]      end <- clines[ends[i]]
137      lab <- if(end+1==length(src))"value"      processed <- gsub("#.*","",gsub("[ }]","",src[(end+1):length(src)]))
138        lab <- if(all(processed==""))"value"
139      else if(start==2)"description"      else if(start==2)"description"
140      else if(is.arg()){      else if(is.arg()){
141        ##twutz: strip leading white spaces and brackets and ,        ##twutz: strip leading white spaces and brackets and ,
# Line 179  Line 151 
151      res[[lab]] <- decomment(src[start:end])      res[[lab]] <- decomment(src[start:end])
152    }    }
153    res    res
154  }  },ex=function(){
155    test <- function
156    ### the description
157    (x,
158    ### the first argument
159     y ##<< another argument
160     ){
161      5
162    ### the return value
163    ##seealso<< foobar
164    }
165    src <- getSource(test)
166    prefixed.lines(src)
167    extract.xxx.chunks(src)
168    })
169    
170  extract.xxx.chunks <- function # Extract documentation from a function  extract.xxx.chunks <- function # Extract documentation from a function
171  ### Given source code of a function, return a list describing inline  ### Given source code of a function, return a list describing inline
# Line 265  Line 251 
251          chunk.sep <- "\n\n"          chunk.sep <- "\n\n"
252        }        }
253        chunk.res <- NULL        chunk.res <- NULL
254        if ( 0 == length(grep("^\\s*$",payload,perl=TRUE)) )        if ( !grepl("^\\s*$",payload,perl=TRUE) )
255          chunk.res <-          chunk.res <-
256            if ( is.null(res[[field]]) ) payload            if ( is.null(res[[field]]) ) payload
257            else paste(res[[field]], payload, sep=chunk.sep)            else paste(res[[field]], payload, sep=chunk.sep)
# Line 273  Line 259 
259      }      }
260    while ( k <= length(src) ){    while ( k <= length(src) ){
261      line <- src[k]      line <- src[k]
262      if ( 0 < length(grep(extra.regexp,line,perl=TRUE) ) ){      ##print(line)
263        ##if(grepl("^$",line))browser()
264        if ( grepl(extra.regexp,line,perl=TRUE) ){
265        ## 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
266        new.field <- gsub(extra.regexp,"\\1",line,perl=TRUE)        new.field <- gsub(extra.regexp,"\\1",line,perl=TRUE)
267        new.contents <- gsub(extra.regexp,"\\2",line,perl=TRUE)        new.contents <- gsub(extra.regexp,"\\2",line,perl=TRUE)
268          ##cat(new.field,"\n-----\n",new.contents,"\n\n")
269        ##details<< As a special case, the construct \code{##describe<<} causes        ##details<< As a special case, the construct \code{##describe<<} causes
270        ## similar processing to the main function arguments to be        ## similar processing to the main function arguments to be
271        ## applied in order to construct a describe block within the        ## applied in order to construct a describe block within the
# Line 286  Line 274 
274        ## block until terminated by a subsequent \code{##}\emph{xxx}\code{<<} line.        ## block until terminated by a subsequent \code{##}\emph{xxx}\code{<<} line.
275        if ( "describe" == new.field ){        if ( "describe" == new.field ){
276          ##details<< Such regions may be nested, but not in such a way          ##details<< Such regions may be nested, but not in such a way
277          ## that the first element in a \code{describe} is another \code{describe}.          ## that the first element in a \code{describe} is another
278          ## Thus there must be at least one \code{##<<} comment between each          ## \code{describe}.  Thus there must be at least one
279          ## pair of \code{##describe<<} comments.          ## \code{##<<} comment between each pair of
280            ## \code{##describe<<} comments.
281          if ( first.describe ){          if ( first.describe ){
282            stop("consecutive ##describe<< at line",k,"in",name.fun)            stop("consecutive ##describe<< at line",k,"in",name.fun)
283          } else {          } else {
# Line 348  Line 337 
337            first.describe <- TRUE;            first.describe <- TRUE;
338          }          }
339        }        }
340      } else if ( in.chunk && 0<length(grep(cont.re,line,perl=TRUE)) ){      } else if ( in.chunk && grepl(cont.re,line,perl=TRUE) ){
341        ## append this line to current chunk        ## append this line to current chunk
342        if ( 0 == length(grep(prefix,line,perl=TRUE)) ){        if ( !grepl(prefix,line,perl=TRUE) ){
343          ##describe<< Any lines with "\code{### }" at the left hand          ##describe<< Any lines with "\code{### }" at the left hand
344          ## margin within the included chunks are handled separately,          ## margin within the included chunks are handled separately,
345          ## so if they appear in the documentation they will appear          ## so if they appear in the documentation they will appear
# Line 363  Line 352 
352            payload <- stripped            payload <- stripped
353          }          }
354        }        }
355      } else if ( 0 < length(grep(arg.pat,line,perl=TRUE)) ){      } else if ( grepl(arg.pat,line,perl=TRUE) ){
356        not.describe <- (0==in.describe && !first.describe)        not.describe <- (0==in.describe && !first.describe)
357        if ( in.chunk && not.describe){        if ( in.chunk && not.describe){
358          res[[cur.field]] <- end.chunk(cur.field,payload)          res[[cur.field]] <- end.chunk(cur.field,payload)
# Line 425  Line 414 
414  ### with the string in this list (implemented in modify.Rd.file).  ### with the string in this list (implemented in modify.Rd.file).
415  }  }
416    
417    leadingS3generic <- function # check whether function name is an S3 generic
418    ### Determines whether a function name looks like an S3 generic function
419    (name,                     ##<< name of function
420     env,                      ##<< environment to search for additional generics
421     ...)                      ##<< ignored here
422    {
423      ##details<< This function is one of the default parsers, but exposed as
424      ## possibly of more general interest. Given a function name of the form
425      ## x.y.z it looks for the generic function x applying to objects of class
426      ## y.z and also for generic function x.y applying to objects of class z.
427      ##
428      parts <- strsplit(name, ".", fixed = TRUE)[[1]]
429      l <- length(parts)
430      if (l > 1) {
431        for (i in 1:(l - 1)) {
432          ## Look for a generic function (known by the system or defined
433          ## in the package) that matches that part of the function name
434          generic <- paste(parts[1:i], collapse = ".")
435          if (any(generic %in% utils:::getKnownS3generics()) ||
436              utils:::findGeneric(generic, env) != "") {
437            object <- paste(parts[(i + 1):l], collapse = ".")
438            ##details<< Assumes that the first name which matches any known
439            ## generics is the target generic function, so if both x and x.y
440            ## are generic functions, will assume generic x applying to objects
441            ## of class y.z
442            ##value<< If a matching generic found returns a list with a single component:
443            return(list(.s3method=c(generic, object))) ##<< a character vector containing generic name and object name.
444          }
445        }
446      }
447      ##value<< If no matching generic functions are found, returns an empty list.
448      list()
449    }
450    
451  ### Parsers for each function that are constructed automatically. This  ### Parsers for each function that are constructed automatically. This
452  ### is a named list, and each element is a parser function for an  ### is a named list, and each element is a parser function for an
453  ### individual object.  ### individual object.
454  forfun.parsers <-  forfun.parsers <-
455    list(prefixed.lines=prefixed.lines,    list(prefixed.lines=prefixed.lines,
        examples.after.return=examples.after.return,  
456         extract.xxx.chunks=extract.xxx.chunks,         extract.xxx.chunks=extract.xxx.chunks,
457         ## title from first line of function def         ## title from first line of function def
458         title.from.firstline=function(src,name,code,...){         title.from.firstline=function(src,...){
459           if(length(grep("#",src[1]))){           first <- src[1]
460             list(title=gsub("[^#]*#\\s*(.*)","\\1",src[1],perl=TRUE))           if(!is.character(first))return(list())
461           } else list()           if(!grepl("#",first))return(list())
462             list(title=gsub("[^#]*#\\s*(.*)","\\1",first,perl=TRUE))
463         },         },
464         ## PhG: it is tests/FUN.R!!! I would like more flexibility here         ## PhG: it is tests/FUN.R!!! I would like more flexibility here
465         ## please, let me choose which dir to use for examples!         ## please, let me choose which dir to use for examples!
# Line 446  Line 469 
469           if (is.null(tsubdir)) tsubdir <- "tests"       # Default value           if (is.null(tsubdir)) tsubdir <- "tests"       # Default value
470           tfile <- file.path("..",tsubdir,paste(name,".R",sep=""))           tfile <- file.path("..",tsubdir,paste(name,".R",sep=""))
471           if(file.exists(tfile))           if(file.exists(tfile))
472             list(examples=paste(readLines(tfile),collapse="\n"))             list(examples=readLines(tfile))
473           else list()           else list()
474         },         },
475         definition.from.source=function(doc,src,...){         definition.from.source=function(doc,src,...){
476           def <- doc$definition           def <- doc$definition
477           is.empty <- function(x)is.null(x)||x==""           is.empty <- function(x)is.null(x)||x==""
478           if(is.empty(def) && !is.empty(src))           if(is.empty(def) && !is.empty(src))
479             list(definition=paste(src,collapse="\n"))             list(definition=src)
480           else list()           else list()
481         })         })
482    
# Line 461  Line 484 
484  forall.parsers <-  forall.parsers <-
485    list(## Fill in author from DESCRIPTION and titles.    list(## Fill in author from DESCRIPTION and titles.
486         author.from.description=function(desc,...){         author.from.description=function(desc,...){
487           list(author=desc[,"Maintainer"])           list(author=desc[,"Author"])
488         },         },
489         ## The format section sometimes causes problems, so erase it.         ## The format section sometimes causes problems, so erase it.
490         erase.format=function(...){         erase.format=function(...){
# Line 479  Line 502 
502             ## Special case for code contained in a function             ## Special case for code contained in a function
503             if (inherits(ex, "function")) {             if (inherits(ex, "function")) {
504               ## If source is available, start from there               ## If source is available, start from there
505               src <- attr(ex, "source")               src <- getSource(ex)
506               if (!is.null(src)) {               if (!is.null(src)) {
507                 ex <- src                 ex <- src
508               } else { ## Use the body of the function               } else { ## Use the body of the function
# Line 487  Line 510 
510               }               }
511               ## Eliminate leading and trailing code               ## Eliminate leading and trailing code
512               ex <- ex[-c(1, length(ex))]               ex <- ex[-c(1, length(ex))]
513                 if(ex[1]=="{")ex <- ex[-1]
514               ## all the prefixes               ## all the prefixes
515               ex <- kill.prefix.whitespace(ex)               ex <- kill.prefix.whitespace(ex)
516               ## Add an empty line before and after example               ## Add an empty line before and after example
517               ex <- c("", ex, "")               ex <- c("", ex, "")
518             }             }
519             list(examples = paste(ex, collapse = "\n"))             list(examples = ex)
520           } else list()           } else list()
521         })         },collapse=function(doc,...){
522             L <- lapply(doc,paste,collapse="\n")
523             L$.overwrite <- TRUE
524             L
525           },tag.s3methods=leadingS3generic
526           )
527    
528  ### List of parser functions that operate on single objects. This list  ### List of parser functions that operate on single objects. This list
529  ### is useful for testing these functions.  ### is useful for testing these functions.
530  lonely <- c(forall.parsers,forfun.parsers)  lonely <- structure(c(forall.parsers,forfun.parsers),ex=function(){
 attr(lonely,"ex") <- function(){  
531    f <- function # title    f <- function # title
532  ### description  ### description
533    (x, ##<< arg x    (x, ##<< arg x
# Line 512  Line 540 
540           sum=x+y) ##<< their sum           sum=x+y) ##<< their sum
541      ##end<<      ##end<<
542    }    }
543    src <- attr(f,"source")    src <- getSource(f)
544    lonely$extract.xxx.chunks(src)    lonely$extract.xxx.chunks(src)
545    lonely$prefixed.lines(src)    lonely$prefixed.lines(src)
546  }  })
547    
548  extra.code.docs <- function # Extract documentation from code chunks  extra.code.docs <- function # Extract documentation from code chunks
549  ### Parse R code to extract inline documentation from comments around  ### Parse R code to extract inline documentation from comments around
# Line 540  Line 568 
568        doc <- list()        doc <- list()
569        if ( !is.null(parsed[[on]]) ){        if ( !is.null(parsed[[on]]) ){
570          if ( !is.na(parsed[[on]]@code[1]) ){ # no code given for generics          if ( !is.na(parsed[[on]]@code[1]) ){ # no code given for generics
571            doc$definition <- paste(parsed[[on]]@code,collapse="\n")            doc$definition <- paste(parsed[[on]]@code)
572          }          }
573          if(!"description"%in%names(doc) && !is.na(parsed[[on]]@description) ){          if(!"description"%in%names(doc) && !is.na(parsed[[on]]@description) ){
574            doc$description <- parsed[[on]]@description            doc$description <- parsed[[on]]@description
575          }          }
576          if ( "setMethodS3" == parsed[[on]]@created ){          ## if ( "setMethodS3" == parsed[[on]]@created ){
577            # PhG: this may be wrong! It does not catch correctly how the method          ##   gen <- leadingS3generic(on,topenv())
578            # must be splitted in case of methods containing dots. for instance,          ##   if ( 0 < length(gen) ){
579            # as.data.frame.matrix must be split into: m1 = as.data.frame and          ##     doc$.s3method <- gen$.s3method
580            # m2 = matrix... here you got m1 = as, and m2 = data.frame.matrix!!!          ##     cat("S3method(",gen$.s3method[1],",",gen$.s3method[2],")\n",sep="")
581                    pattern <- "^([^\\.]+)\\.(.*)$"          ##   }
582            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="")  
         }  
583        }        }
584        if("title" %in% names(doc) && !"description" %in% names(doc) ){        if("title" %in% names(doc) && !"description" %in% names(doc) ){
585          ## For short functions having both would duplicate, but a          ## For short functions having both would duplicate, but a
# Line 576  Line 598 
598      } else if(0 == length(res) && inherits(objs[[on]],"standardGeneric")){      } else if(0 == length(res) && inherits(objs[[on]],"standardGeneric")){
599        NULL        NULL
600      } else if(0 == length(res) && "function" %in% class(o)      } else if(0 == length(res) && "function" %in% class(o)
601                && 1 == length(osource <- attr(o,"source"))                && 1 == length(osource <- getSource(o))
602                && 1 == length(grep(paste("UseMethod(",on,")",sep="\""),osource))                && grepl(paste("UseMethod(",on,")",sep="\""),osource)
603                ){                ){
604        ## phew - this should only pick up R.oo S3 generic definitions like:        ## phew - this should only pick up R.oo S3 generic definitions like:
605        ## attr(*, "source")= chr "function(...) UseMethod(\"select\")"        ## attr(*, "source")= chr "function(...) UseMethod(\"select\")"
# Line 638  Line 660 
660  default.parsers <-  default.parsers <-
661    c(extra.code.docs=extra.code.docs, ## TODO: cleanup!    c(extra.code.docs=extra.code.docs, ## TODO: cleanup!
662      sapply(forfun.parsers,forfun),      sapply(forfun.parsers,forfun),
     sapply(forall.parsers,forall),  
663      edit.package.file=function(desc,...){      edit.package.file=function(desc,...){
664        in.details <- setdiff(colnames(desc),"Description")        in.details <- setdiff(colnames(desc),"Description")
665        details <- paste(paste(in.details,": \\tab ",desc[,in.details],"\\cr",        details <- sprintf("%s: \\tab %s\\cr",in.details,desc[,in.details])
                              sep=""),collapse="\n")  
666        L <-        L <-
667          list(list(title=desc[,"Title"],          list(list(title=desc[,"Title"],
668                    description=desc[,"Description"],                    description=desc[,"Description"],
669                    `tabular{ll}`=details,                    `tabular{ll}`=details))
                   author=desc[,"Maintainer"]))  
670        names(L) <- paste(desc[,"Package"],"-package",sep="")        names(L) <- paste(desc[,"Package"],"-package",sep="")
671        L        L
672      })      },
673        sapply(forall.parsers,forall)
674        )
675    
676  setClass("DocLink", # Link documentation among related functions  setClass("DocLink", # Link documentation among related functions
677  ### The \code{.DocLink} class provides the basis for hooking together  ### The \code{.DocLink} class provides the basis for hooking together
678  ### documentation of related classes/functions/objects. The aim is that  ### documentation of related classes/functions/objects. The aim is that
679  ### documentation sections missing from the child are  ### documentation sections missing from the child are inherited from
680    ### the parent class.
681           representation(name="character", ##<< name of object           representation(name="character", ##<< name of object
682                          created="character", ##<< how created                          created="character", ##<< how created
683                          parent="character", ##<< parent class or NA                          parent="character", ##<< parent class or NA
# Line 690  Line 712 
712      ## "prefix" lines will be used instead.      ## "prefix" lines will be used instead.
713      default.description <- NULL      default.description <- NULL
714      while ( start > last.end+1      while ( start > last.end+1
715             && 1 == length(grep(prefix,code[start-1],perl=TRUE)) ){             && grepl(prefix,code[start-1],perl=TRUE) ){
716        start <- start-1        start <- start-1
717      }      }
718      if ( start < chunks[[k]][1] ){      if ( start < chunks[[k]][1] ){
# Line 717  Line 739 
739        ## If the function definition is not embedded within the call, then        ## If the function definition is not embedded within the call, then
740        ## the parent is that function. Test whether the the third value        ## the parent is that function. Test whether the the third value
741        ## looks like a name and add it to parents if so.        ## looks like a name and add it to parents if so.
742        if ( 1 == length(grep("^[\\._\\w]+$",chars[3],perl=TRUE)) ){        if ( grepl("^[\\._\\w]+$",chars[3],perl=TRUE) ){
743          parent <- chars[3]          parent <- chars[3]
744        }        }
745        res[[object.name]] <- new("DocLink",name=object.name,        res[[object.name]] <- new("DocLink",name=object.name,
# Line 749  Line 771 
771        ## If the function definition is not embedded within the call, then        ## If the function definition is not embedded within the call, then
772        ## the parent is that function. Test whether the the fourth value        ## the parent is that function. Test whether the the fourth value
773        ## looks like a name and add it to parents if so.        ## looks like a name and add it to parents if so.
774        if ( 1 == length(grep("^[\\._\\w]+$",chars[4],perl=TRUE)) ){        if ( grepl("^[\\._\\w]+$",chars[4],perl=TRUE) ){
775          parent <- c(chars[4],parent)          parent <- c(chars[4],parent)
776        }        }
777        res[[object.name]] <- new("DocLink",name=object.name,        res[[object.name]] <- new("DocLink",name=object.name,
# Line 796  Line 818 
818    docs <- combine(docs,lonely$prefixed.lines(chunk.source))    docs <- combine(docs,lonely$prefixed.lines(chunk.source))
819    docs$title <- lonely$title.from.firstline(chunk.source)    docs$title <- lonely$title.from.firstline(chunk.source)
820    ##details<<    ##details<<
821      ## If there is no explicit title on the first line of setClass, then
822      ## one is made up from the class name.
823      if ( 0 == length(docs$title) ){
824        docs$title <- list(title=paste(class.name,"S4 class"))
825      }
826      ##details<<
827    ## The class definition skeleton includes an \code{Objects from the Class}    ## The class definition skeleton includes an \code{Objects from the Class}
828    ## section, to which any \code{##details<<} documentation chunks are    ## section, to which any \code{##details<<} documentation chunks are
829    ## written. It is given a vanilla content if there are no specific    ## written. It is given a vanilla content if there are no specific
# Line 819  Line 847 
847    invisible(docs)    invisible(docs)
848  }  }
849    
850    pr=function(string,env)
851    {
852        cat(string,"=",eval(as.symbol(string),envir=env),"\n")
853    }
854  apply.parsers <- function  apply.parsers <- function
855  ### Parse code to r objs, then run all the parsers and return the  ### Parse code to r objs, then run all the parsers and return the
856  ### documentation list.  ### documentation list.
# Line 832  Line 864 
864  ### Additional arguments to pass to Parser Functions.  ### Additional arguments to pass to Parser Functions.
865   ){   ){
866    e <- new.env()    e <- new.env()
867    old <- options(keep.source=TRUE)    ## KMP 2011-03-09 fix problem with DocLink when inlinedocs ran on itself
868      ## Error in assignClassDef(Class, classDef, where) :
869      ##   Class "DocLink" has a locked definition in package "inlinedocs"
870      ## Traced to "where" argument in setClassDef which defaults to topenv()
871      ## which in turn is inlinedocs when processing inlinedocs package, hence
872      ## the clash. The following works (under R 2.12.2), so that the topenv()
873      ## now finds e before finding the inlinedocs environment.
874      old <- options(keep.source=TRUE,topLevelEnvironment=e)
875    on.exit(options(old))    on.exit(options(old))
876    exprs <- parse(text=code)    exprs <- parse(text=code)
877      ## TDH 2011-04-07 set this so that no warnings about creating a fake
878      ## package when we try to process S4 classes defined in code
879      e$.packageName <- "inlinedocs.processor"
880    for (i in exprs){    for (i in exprs){
881      tryCatch(eval(i, e),error=function(e){        eval(i, e)
       ##print(e)  
     })  
882    }    }
883    objs <- sapply(ls(e),get,e,simplify=FALSE)    objs <- sapply(ls(e),get,e,simplify=FALSE)
884    
885    docs <- list()    docs <- list()
886    
   # PhG: Automatically determine who is S3 methods  
   for (name in names(objs)) {  
     parts <- strsplit(name, ".", fixed = TRUE)[[1]]  
         l <- length(parts)  
         if (l > 1) {  
         for (i in 1:(l - 1)) {  
             # Look for a generic function (known by the system or defined  
             # in the package) that matches that part of the function name  
             generic <- paste(parts[1:i], collapse = ".")  
             if (any(generic %in% utils:::getKnownS3generics()) ||  
                 utils:::findGeneric(generic, e) != "") {  
                 object <- paste(parts[(i + 1):l], collapse = ".")  
                 docs[[name]]$s3method <- c(generic, object)  
                 break  
             }  
         }  
     }  
   }  
887    ## apply parsers in sequence to code and objs    ## apply parsers in sequence to code and objs
888      if(verbose)cat("Applying parsers:\n")
889    for(i in seq_along(parsers)){    for(i in seq_along(parsers)){
890      N <- names(parsers[i])      N <- names(parsers[i])
891      if(verbose){      if(verbose){
892        if(is.character(N) && N!=""){        if(is.character(N) && N!=""){
893          cat(N," ",sep="")          cat(N,"\n",sep="")
894        }else cat('. ')        }else cat('.\n')
895      }      }
896      p <- parsers[[i]]      p <- parsers[[i]]
897      ## This is the argument list that each parser receives:      ## This is the argument list that each parser receives:
898      L <- p(code=code,objs=objs,docs=docs,...)      L <- p(code=code,objs=objs,docs=docs,env=e,...)
899        #print(paste(L,"\n"))
900      docs <- combine(docs,L)      docs <- combine(docs,L)
901    }    }
902      ## post-process to collapse all character vectors
903      for(i in seq_along(docs)){
904        for(j in seq_along(docs[[i]])){
905          if(names(docs[[i]])[j]!=".s3method")
906          docs[[i]][[j]] <- paste(docs[[i]][[j]],collapse="\n")
907        }
908     }
909    if(verbose)cat("\n")    if(verbose)cat("\n")
910    docs    return(docs)
911  ### A list of extracted documentation from code.  ### A list of extracted documentation from code.
912  }  }
913    
# Line 891  Line 922 
922  ### description file.  ### description file.
923  nondesc.parsers <- default.parsers[non.descfile.names]  nondesc.parsers <- default.parsers[non.descfile.names]
924    
925  extract.docs.file <- function  extract.docs.file <- structure(function
926  ### Apply all parsers relevant to extract info from just 1 code file.  ### Apply all parsers relevant to extract info from just 1 code file.
927  (f,  (f,
928  ### File name of R code to read and parse.  ### File name of R code to read and parse.
929   parsers=nondesc.parsers,   parsers=NULL,
930  ### Parser Functions to use to parse the code and extract  ### Parser Functions to use to parse the code and extract
931  ### documentation.  ### documentation.
932   ...   ...
933  ### Other arguments to pass to Parser Functions.  ### Other arguments to pass to Parser Functions.
934   ){   ){
935      if(is.null(parsers))parsers <- nondesc.parsers
936    apply.parsers(readLines(f),parsers,verbose=FALSE,...)    apply.parsers(readLines(f),parsers,verbose=FALSE,...)
937  }  },ex=function(){
938      f <- system.file("silly","R","silly.R",package="inlinedocs")
939      extract.docs.file(f)
940    })
941    

Legend:
Removed from v.163  
changed lines
  Added in v.324

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