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 303, Tue Jul 19 15:35:23 2011 UTC revision 332, Mon Mar 12 12:12:10 2012 UTC
# Line 27  Line 27 
27  ### A function.  ### A function.
28   ) {   ) {
29        srcref <- attr(fun.obj, "srcref")        srcref <- attr(fun.obj, "srcref")
30        if (!is.null(srcref)) unlist(strsplit(as.character(srcref), "\n"))        if (!is.null(srcref)) {
31            ##unlist(strsplit(as.character(srcref), "\n"))
32            as.character(srcref)
33          }
34        else attr(fun.obj, "source")        else attr(fun.obj, "source")
35  ### Source code lines as a character vector.  ### Source code lines as a character vector.
36  }  }
# Line 131  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(gsub("[ }]","",src[(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 255  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 268  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 477  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 811  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 861  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 895  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.303  
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