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 332, Mon Mar 12 12:12:10 2012 UTC revision 352, Mon Apr 9 12:43:46 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      Sys.sleep(1/60) ## to make sure there is at least 1 second elapsed
41    
42      ## However, it will NOT generate Rd for files specified in
43      ## do.not.generate, if they DO exist already.
44      package.skeleton.dx("silly",parsers)
45      mtimes <- data.frame(old,new=file.info(Rd.paths)$mtime)
46      rownames(mtimes) <- Rd.files
47      mtimes$changed <- mtimes$old != mtimes$new
48      print(mtimes)
49      stopifnot(mtimes["silly-package.Rd","changed"]==FALSE)
50      stopifnot(mtimes["Silly-class.Rd","changed"]==FALSE)
51      stopifnot(mtimes["silly.example.Rd","changed"]==TRUE)
52    
53      unlink("silly",recursive=TRUE)
54      setwd(owd)
55    })
56    
57  ### combine lists or character strings  ### combine lists or character strings
58  combine <- function(x,y)UseMethod("combine")  combine <- function(x,y)UseMethod("combine")
59    
# Line 143  Line 199 
199        arg <- gsub("^([^=,]*)[=,].*", "\\1", arg)        arg <- gsub("^([^=,]*)[=,].*", "\\1", arg)
200        ##twutz: remove trailing whitespaces        ##twutz: remove trailing whitespaces
201        arg <- gsub("^([^ \t]*)([ \t]+)$","\\1",arg)        arg <- gsub("^([^ \t]*)([ \t]+)$","\\1",arg)
202        arg <- gsub("...", "\\dots", arg, fix = TRUE)        arg <- gsub("...", "\\dots", arg, fixed = TRUE)
203        paste("item{",arg,"}",sep="")        paste("item{",arg,"}",sep="")
204      } else {      } else {
205        next;        next;
# Line 364  Line 420 
420          ## TDH 2010-06-18 For item{}s in the documentation list names,          ## TDH 2010-06-18 For item{}s in the documentation list names,
421          ## we don't need to have a backslash before, so delete it.          ## we don't need to have a backslash before, so delete it.
422          arg <- gsub("^[\\]+","",arg)          arg <- gsub("^[\\]+","",arg)
423          cur.field <- gsub("...","\\dots",arg,fix=TRUE) ##special case for dots          cur.field <- gsub("...","\\dots",arg,fixed=TRUE) ##special case for dots
424          payload <- comment          payload <- comment
425        } else {        } else {
426          ## 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 893  Line 949 
949      ## This is the argument list that each parser receives:      ## This is the argument list that each parser receives:
950      L <- p(code=code,objs=objs,docs=docs,env=e,...)      L <- p(code=code,objs=objs,docs=docs,env=e,...)
951      #print(paste(L,"\n"))      #print(paste(L,"\n"))
952        #if(N=="exclude")browser()
953      docs <- combine(docs,L)      docs <- combine(docs,L)
954    }    }
955    ## post-process to collapse all character vectors    ## post-process to collapse all character vectors

Legend:
Removed from v.332  
changed lines
  Added in v.352

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