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 324, Wed Feb 1 17:16:32 2012 UTC revision 356, Mon Apr 9 15:39:09 2012 UTC
# Line 1  Line 1 
1    do.not.generate <- structure(function
2    ### Make a Parser Function used to indicate that certain Rd files
3    ### should not be generated.
4    (...
5    ### Character strings indicating Rd files without the .Rd suffix.
6     ){
7      filenames <- c(...)
8      function(docs,...){
9        for(fn in filenames){
10          docs[[fn]] <- list()
11        }
12        docs$.overwrite <- TRUE
13        docs
14      }
15    ### A Parser Function that will delete items from the outer
16    ### Documentation List.
17    },ex=function(){
18      silly.pkg <- system.file("silly",package="inlinedocs")
19      owd <- setwd(tempdir())
20      file.copy(silly.pkg,".",recursive=TRUE)
21    
22      ## define a custom Parser Function that will not generate some Rd
23      ## files
24      custom <- do.not.generate("silly-package","Silly-class")
25      parsers <- c(default.parsers,list(exclude=custom))
26    
27      ## At first, no Rd files in the man subdirectory.
28      man.dir <- file.path("silly","man")
29      dir(man.dir)
30    
31      ## Running package.skeleton.dx will generate bare-bones files for
32      ## those specified in do.not.generate, if they do not exist.
33      package.skeleton.dx("silly",parsers)
34      Rd.files <- c("silly-package.Rd","Silly-class.Rd","silly.example.Rd")
35      Rd.paths <- file.path(man.dir,Rd.files)
36      stopifnot(all(file.exists(Rd.paths)))
37    
38      ## Save the modification times of the Rd files
39      old <- file.info(Rd.paths)$mtime
40    
41      ## make sure there is at least 2 seconds elapsed, which is the
42      ## resolution for recording times on windows file systems.
43      Sys.sleep(4)
44    
45      ## However, it will NOT generate Rd for files specified in
46      ## do.not.generate, if they DO exist already.
47      package.skeleton.dx("silly",parsers)
48      mtimes <- data.frame(old,new=file.info(Rd.paths)$mtime)
49      rownames(mtimes) <- Rd.files
50      mtimes$changed <- mtimes$old != mtimes$new
51      print(mtimes)
52      stopifnot(mtimes["silly-package.Rd","changed"]==FALSE)
53      stopifnot(mtimes["Silly-class.Rd","changed"]==FALSE)
54      stopifnot(mtimes["silly.example.Rd","changed"]==TRUE)
55    
56      unlink("silly",recursive=TRUE)
57      setwd(owd)
58    })
59    
60  ### combine lists or character strings  ### combine lists or character strings
61  combine <- function(x,y)UseMethod("combine")  combine <- function(x,y)UseMethod("combine")
62    
# Line 143  Line 202 
202        arg <- gsub("^([^=,]*)[=,].*", "\\1", arg)        arg <- gsub("^([^=,]*)[=,].*", "\\1", arg)
203        ##twutz: remove trailing whitespaces        ##twutz: remove trailing whitespaces
204        arg <- gsub("^([^ \t]*)([ \t]+)$","\\1",arg)        arg <- gsub("^([^ \t]*)([ \t]+)$","\\1",arg)
205        arg <- gsub("...", "\\dots", arg, fix = TRUE)        arg <- gsub("...", "\\dots", arg, fixed = TRUE)
206        paste("item{",arg,"}",sep="")        paste("item{",arg,"}",sep="")
207      } else {      } else {
208        next;        next;
# Line 364  Line 423 
423          ## TDH 2010-06-18 For item{}s in the documentation list names,          ## TDH 2010-06-18 For item{}s in the documentation list names,
424          ## we don't need to have a backslash before, so delete it.          ## we don't need to have a backslash before, so delete it.
425          arg <- gsub("^[\\]+","",arg)          arg <- gsub("^[\\]+","",arg)
426          cur.field <- gsub("...","\\dots",arg,fix=TRUE) ##special case for dots          cur.field <- gsub("...","\\dots",arg,fixed=TRUE) ##special case for dots
427          payload <- comment          payload <- comment
428        } else {        } else {
429          ## this is a describe block, so we need to paste with existing          ## this is a describe block, so we need to paste with existing
# Line 686  Line 745 
745           )           )
746    
747  extract.file.parse <- function # File content analysis  extract.file.parse <- function # File content analysis
748  ### Using the base \code{\link{parse}} function, analyse the file to link  ### Using the base \code{parse} function, analyse the file to link
749  ### preceding "prefix" comments to each active chunk. Those comments form  ### preceding "prefix" comments to each active chunk. Those comments form
750  ### the default description for that chunk. The analysis also looks for  ### the default description for that chunk. The analysis also looks for
751  ### S4 class "setClass" calls and R.oo setConstructorS3 and setMethodS3  ### S4 class "setClass" calls and R.oo setConstructorS3 and setMethodS3
# Line 758  Line 817 
817        generic.name <- chars[2]        generic.name <- chars[2]
818        object.name <- paste(generic.name,chars[3],sep=".")        object.name <- paste(generic.name,chars[3],sep=".")
819        if ( is.null(res[[generic.name]]) ){        if ( is.null(res[[generic.name]]) ){
820          generic.desc <- paste("Generic method behind \\code{\\link{",object.name,"}}",sep="")          ## TDH 9 April 2012 Do NOT add \\link in generic.desc below,
821            ## since it causes problems on R CMD check.
822            ##* checking Rd cross-references ... WARNING
823            ##Error in find.package(package, lib.loc) :
824            ##  there is no package called ‘MASS’
825            ##Calls: <Anonymous> -> lapply -> FUN -> find.package
826    
827            generic.desc <-
828              paste("Generic method behind \\code{",object.name,"}",sep="")
829          res[[generic.name]] <- new("DocLink",          res[[generic.name]] <- new("DocLink",
830                                     name=generic.name,                                     name=generic.name,
831                                     created=expr.type,                                     created=expr.type,
# Line 792  Line 859 
859  ### in the form \code{setClass("classname",\dots)} are also located and  ### in the form \code{setClass("classname",\dots)} are also located and
860  ### scanned for inline comments.  ### scanned for inline comments.
861  (doc.link  (doc.link
862  ### DocLink object as created by \code{\link{extract.file.parse}}.  ### DocLink object as created by \code{extract.file.parse}.
863  ### Note that \code{source} statements are \emph{ignored} when scanning for  ### Note that \code{source} statements are \emph{ignored} when scanning for
864  ### class definitions.  ### class definitions.
865   ){   ){
# Line 847  Line 914 
914    invisible(docs)    invisible(docs)
915  }  }
916    
 pr=function(string,env)  
 {  
     cat(string,"=",eval(as.symbol(string),envir=env),"\n")  
 }  
917  apply.parsers <- function  apply.parsers <- function
918  ### 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
919  ### documentation list.  ### documentation list.
# Line 897  Line 960 
960      ## This is the argument list that each parser receives:      ## This is the argument list that each parser receives:
961      L <- p(code=code,objs=objs,docs=docs,env=e,...)      L <- p(code=code,objs=objs,docs=docs,env=e,...)
962      #print(paste(L,"\n"))      #print(paste(L,"\n"))
963        #if(N=="exclude")browser()
964      docs <- combine(docs,L)      docs <- combine(docs,L)
965    }    }
966    ## post-process to collapse all character vectors    ## post-process to collapse all character vectors

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

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