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 270, Mon May 23 15:53:47 2011 UTC revision 332, Mon Mar 12 12:12:10 2012 UTC
# Line 20  Line 20 
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    
# Line 46  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 union(names(docs),names(objs))){      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 118  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(all(grepl("^\\s*#",src[end:(length(src)-1)])))"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 145  Line 162 
162  ### the return value  ### the return value
163  ##seealso<< foobar  ##seealso<< foobar
164  }  }
165  src <- attr(test,"source")  src <- getSource(test)
166  prefixed.lines(src)  prefixed.lines(src)
167  extract.xxx.chunks(src)  extract.xxx.chunks(src)
168  })  })
# Line 242  Line 259 
259      }      }
260    while ( k <= length(src) ){    while ( k <= length(src) ){
261      line <- src[k]      line <- src[k]
262        ##print(line)
263        ##if(grepl("^$",line))browser()
264      if ( grepl(extra.regexp,line,perl=TRUE) ){      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 255  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 464  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 482  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 490  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
# Line 519  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  })  })
# Line 577  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                && grepl(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:
# Line 797  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 847  Line 874 
874    ## package when we try to process S4 classes defined in code    ## package when we try to process S4 classes defined in code
875    e$.packageName <- "inlinedocs.processor"    e$.packageName <- "inlinedocs.processor"
876    for (i in exprs){    for (i in exprs){
     ## TDH 2011-04-07 Disable this tryCatch since it makes it harder  
     ##to debug errors/warnings in the evaluated code  
   
     ##tryCatch({  
877        eval(i, e)        eval(i, e)
     ##},error=function(e){  
       ##print(e)  
     ##})  
878    }    }
879    objs <- sapply(ls(e),get,e,simplify=FALSE)    objs <- sapply(ls(e),get,e,simplify=FALSE)
880    
881    docs <- list()    docs <- list()
882    
883    ## apply parsers in sequence to code and objs    ## apply parsers in sequence to code and objs
884      if(verbose)cat("Applying parsers:\n")
885    for(i in seq_along(parsers)){    for(i in seq_along(parsers)){
886      N <- names(parsers[i])      N <- names(parsers[i])
887      if(verbose){      if(verbose){
888        if(is.character(N) && N!=""){        if(is.character(N) && N!=""){
889          cat(N," ",sep="")          cat(N,"\n",sep="")
890        }else cat('. ')        }else cat('.\n')
891      }      }
892      p <- parsers[[i]]      p <- parsers[[i]]
893      ## This is the argument list that each parser receives:      ## This is the argument list that each parser receives:
894      L <- p(code=code,objs=objs,docs=docs,env=e,...)      L <- p(code=code,objs=objs,docs=docs,env=e,...)
895        #print(paste(L,"\n"))
896      docs <- combine(docs,L)      docs <- combine(docs,L)
897    }    }
898    ## post-process to collapse all character vectors    ## post-process to collapse all character vectors
# Line 881  Line 903 
903      }      }
904    }    }
905    if(verbose)cat("\n")    if(verbose)cat("\n")
906    docs    return(docs)
907  ### A list of extracted documentation from code.  ### A list of extracted documentation from code.
908  }  }
909    

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

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