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 356, Mon Apr 9 15:39:09 2012 UTC revision 400, Wed Apr 29 11:42:12 2015 UTC
# Line 1  Line 1 
1    #
2    ############################################################
3    sigString <- function(sig){paste(sig,collapse="_")}
4    ############################################################
5    methodDocName=function
6    ### creates the actual *.Rd filename for a method from its signature and the generic it implements
7    (genName,sig){
8      N=paste(genName,"_method__",sigString(sig),sep="")
9      N
10    }
11    # vim:set ff=unix expandtab ts=2 sw=2:
12    ############################################################
13    setMethod("[",
14        signature(x = "listOfMethods", i = "logical"),
15        function
16        ### overload the [] operator for objects of class "listOfMethods"
17        (x, i, j, ..., drop = TRUE)
18        {
19           fdef <- x@generic
20           object <- new("listOfMethods", arguments = fdef@signature)
21           object@generic <- fdef
22           object@signatures  <- x@signatures[i]
23           object@.Data       <-      x@.Data[i]
24           object@names       <-      x@names[i]
25           #pe(quote(class(object)),environment())
26           object
27    
28        }
29    )
30    ############################################################
31    mmPromptMethods <-  function (genName, filename = NULL, exportedMeths,where)
32      ## this is a copy of R s own promptMehtods functions but
33      ## with an additional argument of the methods to be exported (and documented)
34    {
35    
36        genExported  <- !is.null(exportedMeths)
37    
38        escape <- function(txt) gsub("%", "\\\\%", txt)
39        packageString <- ""
40        fdef <- getGeneric(genName,where=where)
41        if (!isGeneric(f=genName ,where=where,fdef = fdef))
42            stop(gettextf("no generic function found corresponding to %s",
43                sQuote(genName)), domain = NA)
44        methods <- findMethods(fdef,where=where)
45    
46        #where <- .genEnv(fdef, topenv(parent.frame()))
47        #if (!identical(where, .GlobalEnv))
48        #    packageString <- sprintf("in Package \\pkg{%s}",
49        #        getPackageName(where))
50        fullName <- utils:::topicName("methods", genName)
51    
52        n <- length(methods)
53        labels <- character(n)
54        aliases <- character(n)
55        signatures <- findMethodSignatures(methods = methods, target = TRUE)
56        args <- colnames(signatures)
57        for (i in seq_len(n)) {
58            sigi <- signatures[i, ]
59            labels[[i]] <- sprintf("\\code{signature(%s)}", paste(sprintf("%s = \"%s\"",
60                args, escape(sigi)), collapse = ", "))
61            aliases[[i]] <- paste0("\\alias{", utils:::topicName("method",
62                c(genName, signatures[i, ])), "}")
63        }
64        ####
65        if(genExported){
66          exportedSignatures <-findMethodSignatures(methods =exportedMeths, target = TRUE)
67         # #pp("exportedSignatures",environment())
68          n=nrow(exportedSignatures)
69          labels <- character(n)
70          items<- character(n)
71          args <- colnames(exportedSignatures)
72          for (i in seq_len(n)) {
73            sigi <- exportedSignatures[i, ]
74            N <- methodDocName(genName,sigi)
75            labels[[i]] <- sprintf("\\code{signature(%s)}", paste(sprintf("%s = \"%s\"",
76                args, escape(sigi)), collapse = ", "))
77            items[[i]]<- paste0("    \\item{", labels[[i]], "}{\n      \\code{\\link{",N,"}}  \n    }")
78    
79          }
80          des <- paste0(
81            "\\description{\n ~~ Methods for function",
82            " \\code{", genName, "}",
83            sub("^in Package", "in package", packageString),
84            " ~~\n}"
85          )
86    
87          text <- c("\\section{Methods}{\n  \\describe{", items, "\n  }\n}")
88    
89        }else{
90          des <- paste0(
91            "\\description{\n All methods for function",
92            " \\code{", genName, "} ",
93            "are intended for internal use inside the package only. \n}"
94          )
95          #item<-'
96          #All methods for this generic are privat. (not exported into the namespace).
97          #To discourage use outside the package the documentation is truncated.
98          #'
99          #text <- c("\\section{Methods}{\n\\describe{", item, "}\n}")
100          text <- "" #no method section at all
101        }
102        aliasText <- c(paste0("\\alias{", escape(fullName), "}"),
103            escape(aliases))
104        if (identical(filename, FALSE))
105            return(c(aliasText, text))
106        if (is.null(filename) || identical(filename, TRUE))
107            filename <- paste0(fullName, ".Rd")
108        Rdtxt <- list(name = paste0("\\name{", fullName, "}"), type = "\\docType{methods}",
109            aliases = aliasText, title = sprintf("\\title{ ~~ Methods for Function \\code{%s} %s ~~}",
110                genName, packageString), description = des
111            , `section{Methods}` = text,
112            keywords = c("\\keyword{methods}", "\\keyword{ ~~ other possible keyword(s) ~~ }"))
113        if (is.na(filename))
114            return(Rdtxt)
115        cat(unlist(Rdtxt), file = filename, sep = "\n")
116        print(paste("A shell of methods documentation has been written",filename))
117        invisible(filename)
118    }
119    
120    ############################################################
121    removeComma <- function(str){
122      if(grepl(",",str)){
123         str <- strsplit(str,",")[[1]][[1]]
124      }
125      return(str)
126    }
127    ############################################################
128    exported=function
129    ### a helper soon to read the NAMESPACE file, soon to be replaced by Rs own function
130    (pattern,tD){
131      ##pp("tD",environment())
132      #pe(quote(getwd()),environment())
133      # for simpler parsing we dont allow every possible
134      # export statement but assume the form
135      # export(
136      #  firstFunc,
137      #  secondFunc
138      # )
139      ns=readLines(file.path(tD,"NAMESPACE"))
140      if(any(grepl(pattern,ns))){
141        fl=grep(pattern,ns)[[1]]
142        # start search for closing ")" at the opening one and
143        # use only the next ")" if there are several
144        ll= grep("\\)",ns[fl:length(ns)])[[1]]+fl-1
145        if (ll==fl+1){
146          return(NULL)
147        }else{
148          trunks= unlist(lapply(ns[(fl+1):(ll-1)],removeComma))
149          return(trunks)
150        }
151      }else{
152        return(NULL)
153      }
154    }
155    ############################################################
156    exportedFunctions=function
157    ### get the exported functions from the NAMESPACE file
158    (tD){
159      funcNames=exported("export\\(",tD)
160      #pp("funcNames",environment())
161      return(funcNames)
162    }
163    ############################################################
164    exportedGenerics=function
165    ### get the exported generic functions from the NAMESPACE file
166    (tD){
167      # note that there is only a exportMethods statement available
168      funcNames=exported("exportMethods",tD)
169      return(funcNames)
170    }
171    ############################################################
172    exportedClasses=function
173    ### get the exported Classes from the NAMESPACE file
174    (tD){
175      classnames=exported("exportClasses",tD)
176      return(classnames)
177    }
178    ############################################################
179    methodTable <- function(exprs,e){
180      gens=list() ## a list of generic functions that are mentioned in setMethod statements within the code to be documented
181      for ( k in 1:length(exprs)){
182        lang <- exprs[[k]]
183        chars <- as.character(lang)
184        ##pp("chars",environment())
185        expr.type <- chars[[1]]
186        if (expr.type == "setMethod"){
187          NamedArgs=rewriteSetMethodArgs(lang)
188          nameOfGeneric<-NamedArgs[["f"]]
189          methSig <- eval(NamedArgs[["signature"]],e)
190          gens[[nameOfGeneric]] <- unique(c(gens[[nameOfGeneric]],list(methSig)))
191        }
192      }
193      gens
194    }
195    ############################################################
196    allClasses <- function(env){
197      getClasses(where=env)
198    }
199    ############################################################
200    hiddenClasses <- function(env,pkgDir){
201      setdiff(allClasses(env),exportedClasses(pkgDir))
202    }
203    ############################################################
204    # now find all Generics whose src can be found
205    GenHasSrc=function
206    ### This function tells us if we can find a src reference for this generic
207    (genName,e)
208    {!is.null(getSrcref(getGeneric(genName,where=e)))}
209    
210    
211    # we now want to find all Generics that have at least one Method where we can get at the source
212    ############################################################
213    methSrc=function
214    ### get at the src of a method given as  an MethodDefinition object
215    (MethodDefinition){getSrcref(unRematchDefinition(MethodDefinition))}
216    ############################################################
217    methSig=function
218    ### Extract the definition as text from an MethodDefinition object
219    (MethodDefinition){attr(MethodDefinition,"defined")}
220    ############################################################
221    MethodHasSrc=function(MethodDefinition)
222    ### This function tells if we can find a src reference for this method
223    {!is.null(methSrc(MethodDefinition))}
224    ############################################################
225    MethodSignatureHasOnlyExportedClasses=function(MethodDefinition,env,pkgDir)
226    ### check if all the classes in the signature are exported in the NAMESPACE file.
227    ### This information is needed to decide which Methods we want to document in cases
228    ### where the documentations is restricted to the exported NAMESPACE
229    {
230      sigStr=as.character(methSig(MethodDefinition))
231      hiddCls <- hiddenClasses(env,pkgDir)
232      intersection <- intersect(sigStr,hiddCls)
233      res <- (length(intersection)==0)
234      res
235    }
236    ############################################################
237    MethodsWithSrcRefForGen=function
238    ### Not all methods for a Generic are defined in the src we want to document.
239    ### This function helps to find the methods we want.
240    (genName,env){
241      l=findMethods(genName,where=env)[sapply(findMethods(genName,where=env),MethodHasSrc)]
242      #class(l)<-"methods"
243      l
244    }
245    ############################################################
246    GenHasAnyMethodWithSrc=function
247    ### function to check if we have a src reference for any of the methods of this generic
248    ### This helps to decide how the *-methods.Rd file should look like for this generic
249    (genName,env){
250      methDefs <- findMethods(genName,where=env)
251      ##pp("methDefs)
252      any(sapply(
253        methDefs,
254        MethodHasSrc))
255    }
256    ############################################################
257    GenHasAnyExposedMethod=function
258    ### function used to check if a GenericFunction has any method where the whole signature consist of classes exported in the namespace
259    (genName,env,pkgDir){
260      decide=function(MethodDescription){
261        MethodSignatureHasOnlyExportedClasses(MethodDescription,env,pkgDir)
262      }
263      hasExposedMethod <- any(
264          sapply(
265            findMethods(genName,where=env)
266            ,decide
267          )
268      )
269      #pp("genName",environment())
270      #pp("hasExposedMethod",environment())
271      hasExposedMethod
272    }
273    ############################################################
274    documentableMeths<- function(e){
275      # now find out which generics have any documentable methods
276      allGens=as.character(getGenerics(where=e))
277      ##pp("allGens",environment())
278      decide=function(genName){
279        GenHasAnyMethodWithSrc(genName,e)
280      }
281      GensWithDocMethods=allGens[unlist(sapply(allGens,decide))]
282      ##pp("GensWithDocMethods",environment())
283      # now we can make a list of list
284      # containing the Methods we want to documents ordered after the name of there Generics
285      documentableMeths=list()
286      for (genName in GensWithDocMethods){
287            documentableMeths[[genName]]<-MethodsWithSrcRefForGen(genName,e)
288      }
289      documentableMeths
290    }
291    ############################################################
292    exportedDocumentableMeths<- function(e,pkgDir){
293      decide1=function(genName){
294         GenHasAnyExposedMethod(genName,e,pkgDir)
295      }
296      dm <- documentableMeths(e)
297      indices=unlist(sapply(names(dm),decide1))
298      #pp("indices",environment())
299      newGens <- dm[indices]
300      decide2 <-  function(MethodDescription){
301        MethodSignatureHasOnlyExportedClasses(MethodDescription,e,pkgDir)
302      }
303      for (genName in names(newGens)){
304         allMeths=newGens[[genName]]
305         newGens[[genName]] <- allMeths[sapply(allMeths,decide2)]
306      }
307      newGens
308    
309    }
310    ############################################################
311    getMethodName <- function(doc.link,e){
312      method.name<- doc.link@name
313      method.name
314    }
315    ############################################################
316    getMethodSrc <- function(doc.link,e){
317      chunk.source <- doc.link@code
318      method.name<- doc.link@name
319      old.opt <- options(keep.source=TRUE)
320      parsed <- try(parse(text=chunk.source))
321      options(old.opt)
322      if ( inherits(parsed,"try-error") ){
323        stop("parse failed with error:\n",parsed)
324      }
325      lp <- length(parsed)
326      ##pp("lp",environment())
327      ##pp("parsed",environment())
328      if(lp!=1){
329        stop("extract.docs.setMethod:the expected code should be a lingle setMethod expression")
330      }
331    
332    
333      NamedArgs=rewriteSetMethodArgs(parsed[[1]])
334      #pp("NamedArgs",environment())
335      s <- NamedArgs[["signature"]]
336      #pp("s",environment())
337      methodDef=getMethod(
338          f=NamedArgs[["f"]],
339          signature=eval(NamedArgs[["signature"]]),
340          where=e
341        )
342      #pp("methodDef",environment())
343      src=as.character(getSrcref(unRematchDefinition(methodDef)))
344      src
345    }
346     rewriteSetMethodArgs=function(lang){
347       ### Since we do not know if the arguments in the call to setMethod are given with
348       ### keywords, partially matching keywords as an ordered list or any
349       ### combination of it, we use the same function as R  (match.arg )
350       ### to rewrite our argumentlist to a (pair)list from which
351       ### we can extract the information easily
352       KeyWords=c("f","signature","definition","where")
353       NamedArgs=list() # the new argument list
354       args=lang[2:length(lang)]
355       argNames=names(args)
356       if(is.null(argNames)){
357         # in the  special case keyword=value pairs are not given at all
358         # we determine them by position
359         for (i in seq_along(args)){
360            #pp("i",environment())
361            NamedArgs[[KeyWords[[i]] ]] <- args[[i]]
362         }
363       }else{
364         # at least some keyword=value pairs are given
365         # we determine them by match arg or by position
366         for (i in seq_along(args)){
367            argName=argNames[[i]]
368            if(argNames[[i]]==""){ # no keyword=value given for this arg
369              NamedArgs[[KeyWords[[i]]]] <- args[[i]] #determining the keyword  by position
370            }else{
371             newName=try(match.arg(argNames[[i]],KeyWords))
372             if (class(newName)=="try-error") {
373               stop(paste("could not match the argument with name : " ,argNames[[i]]," to a formal argument of setMethod",sep=""))
374             }else{
375              NamedArgs[[newName]] <- args[[i]]
376            }
377           }
378         }
379       }
380       #NN <- names(NamedArgs)
381       ##pp("lang",environment())
382       ##pp("args",environment())
383       ##pp("argNames",environment())
384       ##pp("NN",environment())
385       NamedArgs
386     }
387  do.not.generate <- structure(function  do.not.generate <- structure(function
388  ### Make a Parser Function used to indicate that certain Rd files  ### Make a Parser Function used to indicate that certain Rd files
389  ### should not be generated.  ### should not be generated.
# Line 57  Line 443 
443    setwd(owd)    setwd(owd)
444  })  })
445    
446    ### combine NULL objects.
447    combine.NULL<-function(x,y){
448        if ((class(x) == "NULL")& (class(y) == "NULL")){
449            # print(paste("mm x=",x))
450            # print(paste("mm class(x)=",class(x)))
451            return(NULL)
452        }
453        if (class(x) == "NULL"){
454            # print(paste("mm x=",x))
455            # print(paste("mm class(x)=",class(x)))
456            x=list("")
457        }
458        if (class(y) == "NULL"){
459            # print(paste("mm y=",y))
460            # print(paste("mm class(y)=",class(y)))
461            y=list("")
462        }
463        return(combine(x,y))
464    }
465    
466  ### combine lists or character strings  ### combine lists or character strings
467  combine <- function(x,y)UseMethod("combine")  combine <- function(x,y){
468        UseMethod("combine")
469    }
470    
471  ### combine character strings by pasting them together  ### combine character strings by pasting them together
472  combine.character <- function(x,y)  combine.character <- function(x,y)
# Line 147  Line 555 
555  }  }
556    
557  ### For each function in the package, do something.  ### For each function in the package, do something.
558  forfun <- function(FUN)forall(FUN,is.function)  forfun<- function
559    ### For each object in the package that satisfies the criterion
560    ### checked by subfun, parse source using FUN and return the resulting
561    ### documentation list.
562    (FUN
563    ### Function to apply to each function in the package.
564     ){
565      FUN <- FUN
566      f <- function(objs,docs,...){
567        if(length(objs)==0)return(list())
568        objs <- objs[sapply(objs,is.function)]
569        L <- list()
570        on.exit(cat(sprintf("Parser Function failed on %s\n",N)))
571        for(N in names(objs)){
572          o <- objs[[N]]
573          L[[N]] <- FUN(src=getSource(o),
574                        name=N,objs=objs,o=o,docs=docs,doc=docs[[N]],...)
575        }
576        on.exit()## remove warning message
577        L
578      }
579      class(f) <- c("allfun","function")
580      f
581    ### A Parser Function.
582    }
583    
584  kill.prefix.whitespace <- function  kill.prefix.whitespace <- function
585  ### Figure out what the whitespace preceding the example code is, and  ### Figure out what the whitespace preceding the example code is, and
# Line 486  Line 918 
918    ##    ##
919    parts <- strsplit(name, ".", fixed = TRUE)[[1]]    parts <- strsplit(name, ".", fixed = TRUE)[[1]]
920    l <- length(parts)    l <- length(parts)
921    if (l > 1) {    # twutz 29 April 2015: added nzchar to handle non-S3 functions such as .myPrivateMethod
922      if (nzchar(parts[1]) && l > 1) {
923      for (i in 1:(l - 1)) {      for (i in 1:(l - 1)) {
924        ## Look for a generic function (known by the system or defined        ## Look for a generic function (known by the system or defined
925        ## in the package) that matches that part of the function name        ## in the package) that matches that part of the function name
926        generic <- paste(parts[1:i], collapse = ".")        generic <- paste(parts[1:i], collapse = ".")
927        if (any(generic %in% utils:::getKnownS3generics()) ||        if (any(generic %in% getKnownS3generics()) ||
928            utils:::findGeneric(generic, env) != "") {            findGeneric(generic, env) != "") {
929          object <- paste(parts[(i + 1):l], collapse = ".")          object <- paste(parts[(i + 1):l], collapse = ".")
930          ##details<< Assumes that the first name which matches any known          ##details<< Assumes that the first name which matches any known
931          ## generics is the target generic function, so if both x and x.y          ## generics is the target generic function, so if both x and x.y
# Line 507  Line 940 
940    list()    list()
941  }  }
942    
943    definition.from.source=function(doc,src,...)
944    ### small helper to extract the definition of a doc entry from a bit of src code
945    {
946      def <- doc$definition
947      is.empty <- function(x)is.null(x)||x==""
948      if(is.empty(def) && !is.empty(src))
949        list(definition=src)
950      else list()
951    }
952    ## title from first line of function def
953    title.from.firstline=function
954    ### extract the title from the first line of a function definition
955    (src,...){
956      first <- src[1]
957      if(!is.character(first))return(list())
958      if(!grepl("#",first))return(list())
959      list(title=gsub("[^#]*#\\s*(.*)","\\1",first,perl=TRUE))
960    }
961    ############
962    mm.examples.from.testfile=function
963    ### extract examples from external files
964    (name,inlinedocs.exampleDir,inlinedocs.exampleTrunk,...){
965      tsubdir <-inlinedocs.exampleDir
966      trunk<- inlinedocs.exampleTrunk
967      if (is.null(tsubdir)) {
968        return(list())# do nothing
969      }
970      p <- paste(trunk,name,".R",sep="")
971      allfiles=dir(tsubdir)
972      L<- allfiles[grepl(pattern=p,allfiles,fixed=TRUE)]
973      path=function(l){file.path(tsubdir,l)}
974      paths=lapply(L,path)
975      print(lapply(paths,file.exists))
976    
977      res=list()
978      if(length(L)>0){
979        exampleTexts= lapply(paths,readLines)
980        combinedText <- unlist(exampleTexts)
981        res[["examples"]]=combinedText
982        ##pp("res",environment())
983    
984      }
985      res
986    }
987  ### Parsers for each function that are constructed automatically. This  ### Parsers for each function that are constructed automatically. This
988  ### 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
989  ### individual object.  ### individual object.
990  forfun.parsers <-  forfun.parsers <-
991    list(prefixed.lines=prefixed.lines,    list(prefixed.lines=prefixed.lines,
992         extract.xxx.chunks=extract.xxx.chunks,         extract.xxx.chunks=extract.xxx.chunks,
993         ## title from first line of function def         title.from.firstline=title.from.firstline,
        title.from.firstline=function(src,...){  
          first <- src[1]  
          if(!is.character(first))return(list())  
          if(!grepl("#",first))return(list())  
          list(title=gsub("[^#]*#\\s*(.*)","\\1",first,perl=TRUE))  
        },  
994         ## PhG: it is tests/FUN.R!!! I would like more flexibility here         ## PhG: it is tests/FUN.R!!! I would like more flexibility here
995         ## please, let me choose which dir to use for examples!         ## please, let me choose which dir to use for examples!
996         ## Get examples for FUN from the file tests/FUN.R         ## Get examples for FUN from the file tests/FUN.R
# Line 527  Line 998 
998           tsubdir <- getOption("inlinedocs.exdir")           tsubdir <- getOption("inlinedocs.exdir")
999           if (is.null(tsubdir)) tsubdir <- "tests"       # Default value           if (is.null(tsubdir)) tsubdir <- "tests"       # Default value
1000           tfile <- file.path("..",tsubdir,paste(name,".R",sep=""))           tfile <- file.path("..",tsubdir,paste(name,".R",sep=""))
1001           if(file.exists(tfile))           print(file.exists(tfile))
1002             if(file.exists(tfile)){
1003             list(examples=readLines(tfile))             list(examples=readLines(tfile))
1004             }
1005           else list()           else list()
1006         },         },
1007         definition.from.source=function(doc,src,...){         mm.examples.from.testfile=mm.examples.from.testfile,
1008           def <- doc$definition         definition.from.source=definition.from.source
          is.empty <- function(x)is.null(x)||x==""  
          if(is.empty(def) && !is.empty(src))  
            list(definition=src)  
          else list()  
        })  
   
 ### List of Parser Functions that can be applied to any object.  
 forall.parsers <-  
   list(## Fill in author from DESCRIPTION and titles.  
        author.from.description=function(desc,...){  
          list(author=desc[,"Author"])  
        },  
        ## The format section sometimes causes problems, so erase it.  
        erase.format=function(...){  
          list(format="")  
        },  
        ## Convert the function name to a title.  
        title.from.name=function(name,doc,...){  
          if("title"%in%names(doc))list() else  
          list(title=gsub("[._]"," ",name))  
        },  
        ## PhG: here is what I propose for examples code in the 'ex' attribute  
        examples.in.attr =  function (name, o, ...) {  
          ex <- attr(o, "ex")  
          if (!is.null(ex)) {  
            ## Special case for code contained in a function  
            if (inherits(ex, "function")) {  
              ## If source is available, start from there  
              src <- getSource(ex)  
              if (!is.null(src)) {  
                ex <- src  
              } else { ## Use the body of the function  
                ex <- deparse(body(ex))  
              }  
              ## Eliminate leading and trailing code  
              ex <- ex[-c(1, length(ex))]  
              if(ex[1]=="{")ex <- ex[-1]  
              ## all the prefixes  
              ex <- kill.prefix.whitespace(ex)  
              ## Add an empty line before and after example  
              ex <- c("", ex, "")  
            }  
            list(examples = ex)  
          } else list()  
        },collapse=function(doc,...){  
          L <- lapply(doc,paste,collapse="\n")  
          L$.overwrite <- TRUE  
          L  
        },tag.s3methods=leadingS3generic  
1009         )         )
1010    
1011  ### List of parser functions that operate on single objects. This list  extract.docs<-function
1012  ### is useful for testing these functions.  ### produce doc link instances
1013  lonely <- structure(c(forall.parsers,forfun.parsers),ex=function(){  (parsed,objs,on){
1014    f <- function # title    ##pp("on",environment())
 ### description  
   (x, ##<< arg x  
    y  
 ### arg y  
    ){  
     ##value<< a list with elements  
     list(x=x, ##<< original x value  
          y=y, ##<< original y value  
          sum=x+y) ##<< their sum  
     ##end<<  
   }  
   src <- getSource(f)  
   lonely$extract.xxx.chunks(src)  
   lonely$prefixed.lines(src)  
 })  
   
 extra.code.docs <- function # Extract documentation from code chunks  
 ### Parse R code to extract inline documentation from comments around  
 ### each function. These are not able to be retreived simply by  
 ### looking at the "source" attribute. This is a Parser Function that  
 ### can be used in the parser list of package.skeleton.dx(). TODO:  
 ### Modularize this into separate Parsers Functions for S4 classes,  
 ### prefixes, ##<<blocks, etc. Right now it is not very clean!  
 (code,  
 ### Code lines in a character vector containing multiple R objects to  
 ### parse for documentation.  
  objs,  
 ### The objects defined in the code.  
  ...  
 ### ignored  
  ){  
   parsed <- extract.file.parse(code)  
1015    extract.docs.try <- function(o,on)    extract.docs.try <- function(o,on)
1016      {      {
1017        ## Note: we could use parsed information here too, but that        ## Note: we could use parsed information here too, but that
1018        ## would produce different results for setMethodS3 etc.        ## would produce different results for R.methodsS3::setMethodS3 etc.
1019        doc <- list()        doc <- list()
1020        if ( !is.null(parsed[[on]]) ){        if ( !is.null(parsed[[on]]) ){
1021          if ( !is.na(parsed[[on]]@code[1]) ){ # no code given for generics          if ( !is.na(parsed[[on]]@code[1]) ){ # no code given for generics
# Line 632  Line 1024 
1024          if(!"description"%in%names(doc) && !is.na(parsed[[on]]@description) ){          if(!"description"%in%names(doc) && !is.na(parsed[[on]]@description) ){
1025            doc$description <- parsed[[on]]@description            doc$description <- parsed[[on]]@description
1026          }          }
1027          ## if ( "setMethodS3" == parsed[[on]]@created ){          ## if ( "R.methodsS3::setMethodS3" == parsed[[on]]@created ){
1028          ##   gen <- leadingS3generic(on,topenv())          ##   gen <- leadingS3generic(on,topenv())
1029          ##   if ( 0 < length(gen) ){          ##   if ( 0 < length(gen) ){
1030          ##     doc$.s3method <- gen$.s3method          ##     doc$.s3method <- gen$.s3method
# Line 648  Line 1040 
1040        }        }
1041        doc        doc
1042      }      }
   extract.docs <- function(on){  
1043      res <- try({o <- objs[[on]]      res <- try({o <- objs[[on]]
1044                  extract.docs.try(o, on)},FALSE)                  extract.docs.try(o, on)},FALSE)
1045      if(class(res)=="try-error"){      if(class(res)=="try-error"){
# Line 665  Line 1056 
1056        NULL        NULL
1057      } else res      } else res
1058    }    }
1059    doc.names <- names(objs)  
1060    res <- sapply(doc.names,extract.docs,simplify=FALSE)  inherit.docs <- function(
1061    ## Special processing for S4 classes as they do not appear in normal ls()  ### recursively add documentation inherited from doc.link parents
1062    for ( nn in names(parsed) ){    parsed, ##<< a list of doc.link objects
1063      if ( parsed[[nn]]@created == "setClass" ){    res,    ##<< the list of documentation to be extended
1064        S4class.docs <- extract.docs.setClass(parsed[[nn]])    childName      ##<< the name of the object who possibly inherits
1065        docname <- paste(nn,"class",sep="-")    ){
1066        if ( is.null(res[[docname]]) ){    in.res <- res[[childName]] #start with the present
1067          res[[docname]] <- S4class.docs    ##pp("in.res",environment())
1068          doc.names <- c(doc.names,docname)    childsDocLink <-parsed[[childName]]
1069        } else {    if ( !is.null(childsDocLink) ){
1070          stop(nn," appears as both S4 class and some other definition")      for ( parent in childsDocLink@parent ){
       }  
     }  
   }  
   inherit.docs <- function(on){  
     in.res <- res[[on]]  
     if ( !is.null(parsed[[on]]) ){  
       for ( parent in parsed[[on]]@parent ){  
1071          if ( !is.na(parent) ){          if ( !is.na(parent) ){
1072            ##pp("parent",environment())
1073            #pe(quote(names(res)),environment())
1074            #pe(quote(parent %in% names(res)),environment())
1075            if ( is.null(in.res) ){            if ( is.null(in.res) ){
1076              in.res <- res[[parent]]              in.res <- res[[parent]]
1077            } else if ( parent %in% names(res) ){            } else if ( parent %in% names(res) ){
# Line 699  Line 1086 
1086        }        }
1087      }      }
1088      invisible(in.res)      invisible(in.res)
1089      ### the possibly extended list of documentation
1090    }
1091    
1092    
1093    extra.method.docs <- function
1094    ### can be used in the parser list of package.skeleton.dx(). TODO:
1095    (code,
1096    ### Code lines in a character vector containing multiple R objects to
1097    ### parse for documentation.
1098    objs,
1099    ### The objects defined in the code.
1100    env,
1101    ### The environment they inhibit (needed to pass on)
1102    inlinedocs.exampleDir,
1103    ### A string pointing to the location where inlinedocs should search for external examples
1104    inlinedocs.exampleTrunk,
1105    ### A string used to identify the files containing external examples in the example directory. All file names of external examples have to start with this string
1106    ...
1107    ### ignored
1108     ){
1109      doc.names <- names(objs)
1110      parsed <- extract.file.parse(code,env)
1111      res=list()
1112      for ( nn in names(parsed) ){
1113        dL=parsed[[nn]]
1114        if ( dL@created == "setMethod" ){
1115          S4Method.docs <- extract.docs.setMethod(dL,env,inlinedocs.exampleDir,inlinedocs.exampleTrunk)
1116          docname <- dL@name
1117          if ( is.null(res[[docname]]) ){
1118            res[[docname]] <- S4Method.docs
1119            doc.names <- c(doc.names,docname)
1120          } else {
1121            stop(nn," appears as both S4 method and some other definition")
1122          }
1123        }
1124    }    }
1125    all.done <- FALSE    all.done <- FALSE
1126    while ( !all.done ){    while ( !all.done ){
1127      res1 <- sapply(doc.names,inherit.docs,simplify=FALSE)      res1 <- sapply(doc.names,inherit.docs,parsed=parsed,res=res,simplify=FALSE)
1128        all.done <- identical(res1,res)
1129        res <- res1
1130      }
1131      res
1132    ### named list of lists, one for each object to document.
1133    }
1134    
1135    
1136    
1137    extra.class.docs <- function # Extract documentation from code chunks
1138    ### Parse R code to extract inline documentation from comments around
1139    ### each class
1140    ### looking at the "source" attribute. This is a Parser Function that
1141    ### can be used in the parser list of package.skeleton.dx(). TODO:
1142    (code,
1143    ### Code lines in a character vector containing multiple R objects to
1144    ### parse for documentation.
1145    objs,
1146    ### The objects defined in the code.
1147    env,
1148    ### The environment they inhibit (needed to pass on)
1149    ...
1150    ### ignored
1151     ){
1152      doc.names <- names(objs)
1153      parsed <- extract.file.parse(code,env)
1154      res=list()
1155      for ( nn in names(parsed) ){
1156        if ( parsed[[nn]]@created == "setClass" ){
1157          S4class.docs <- extract.docs.setClass(parsed[[nn]])
1158          docname <- paste(nn,"class",sep="-")
1159          if ( is.null(res[[docname]]) ){
1160            res[[docname]] <- S4class.docs
1161            doc.names <- c(doc.names,docname)
1162          } else {
1163            stop(nn," appears as both S4 class and some other definition")
1164          }
1165        }
1166      }
1167      all.done <- FALSE
1168      while ( !all.done ){
1169        res1 <- sapply(doc.names,inherit.docs,parsed=parsed,res=res,simplify=FALSE)
1170        all.done <- identical(res1,res)
1171        res <- res1
1172      }
1173      res
1174    ### named list of lists, one for each object to document.
1175    }
1176    extra.code.docs <- function # Extract documentation from code chunks
1177    ### Parse R code to extract inline documentation from comments around
1178    ### each function. These are not able to be retreived simply by
1179    ### looking at the "source" attribute. This is a Parser Function that
1180    ### can be used in the parser list of package.skeleton.dx(). TODO:
1181    ### Modularize this into separate Parsers Functions for S4 classes,
1182    ### prefixes, ##<<blocks, etc. Right now it is not very clean!
1183    (code,
1184    ### Code lines in a character vector containing multiple R objects to
1185    ### parse for documentation.
1186     objs,
1187    ### The objects defined in the code.
1188    env, # the environment
1189     ...
1190    ### ignored
1191     ){
1192      parsed <- extract.file.parse(code,env)
1193      doc.names <- names(objs)
1194      res <- sapply(doc.names,extract.docs,parsed=parsed,objs=objs,simplify=FALSE)
1195      all.done <- FALSE
1196      while ( !all.done ){
1197        res1 <- sapply(doc.names,inherit.docs,parsed=parsed,res=res,simplify=FALSE)
1198      all.done <- identical(res1,res)      all.done <- identical(res1,res)
1199      res <- res1      res <- res1
1200    }    }
# Line 714  Line 1206 
1206    res    res
1207  ### named list of lists, one for each object to document.  ### named list of lists, one for each object to document.
1208  }  }
1209    ### List of Parser Functions that can be applied to any object.
1210    forall.parsers <-
1211      list(## Fill in author from DESCRIPTION and titles.
1212           author.from.description=function(desc,...){
1213             list(author=desc[,"Author"])
1214           },
1215           ## The format section sometimes causes problems, so erase it.
1216           erase.format=function(...){
1217             list(format="")
1218           },
1219           ## Convert the function name to a title.
1220           title.from.name=function(name,doc,...){
1221             if("title"%in%names(doc))list() else
1222             list(title=gsub("[._]"," ",name))
1223           },
1224           ## PhG: here is what I propose for examples code in the 'ex' attribute
1225           examples.in.attr =  function (name, o, ...) {
1226             ex <- attr(o, "ex",exact=TRUE)
1227             if (!is.null(ex)) {
1228               ## Special case for code contained in a function
1229               if (inherits(ex, "function")) {
1230                 ## If source is available, start from there
1231                 src <- getSource(ex)
1232                 if (!is.null(src)) {
1233                   ex <- src
1234                 } else { ## Use the body of the function
1235                   ex <- deparse(body(ex))
1236                 }
1237                 ## Eliminate leading and trailing code
1238                 ex <- ex[-c(1, length(ex))]
1239                 if( length(ex) ){  # avoid error on yet empty example
1240                     if(ex[1]=="{")ex <- ex[-1]
1241                     ## all the prefixes
1242                     ex <- kill.prefix.whitespace(ex)
1243                 }
1244                 ## Add an empty line before and after example
1245                 ex <- c("", ex, "")
1246               }
1247               list(examples = ex)
1248             } else list()
1249           },collapse=function(doc,...){
1250             L <- lapply(doc,paste,collapse="\n")
1251             L$.overwrite <- TRUE
1252             L
1253           },tag.s3methods=leadingS3generic
1254           )
1255    
1256    ### List of parser functions that operate on single objects. This list
1257    ### is useful for testing these functions.
1258    lonely <- structure(c(forall.parsers,forfun.parsers),ex=function(){
1259      f <- function # title
1260    ### description
1261      (x, ##<< arg x
1262       y
1263    ### arg y
1264       ){
1265        ##value<< a list with elements
1266        list(x=x, ##<< original x value
1267             y=y, ##<< original y value
1268             sum=x+y) ##<< their sum
1269        ##end<<
1270      }
1271      src <- getSource(f)
1272      lonely$extract.xxx.chunks(src)
1273      lonely$prefixed.lines(src)
1274    })
1275    
1276    
1277  ### List of parsers to use by default with package.skeleton.dx.  ### List of parsers to use by default with package.skeleton.dx.
1278  default.parsers <-  default.parsers <-
1279    c(extra.code.docs=extra.code.docs, ## TODO: cleanup!    c(
1280        extra.class.docs=extra.class.docs, ## TODO: cleanup!
1281        extra.method.docs=extra.method.docs, ## TODO: cleanup!
1282        extra.code.docs=extra.code.docs, ## TODO: cleanup!
1283      sapply(forfun.parsers,forfun),      sapply(forfun.parsers,forfun),
1284      edit.package.file=function(desc,...){      edit.package.file=function(desc,...){
1285        in.details <- setdiff(colnames(desc),"Description")        in.details <- setdiff(colnames(desc),"Description")
# Line 748  Line 1310 
1310  ### Using the base \code{parse} function, analyse the file to link  ### Using the base \code{parse} function, analyse the file to link
1311  ### preceding "prefix" comments to each active chunk. Those comments form  ### preceding "prefix" comments to each active chunk. Those comments form
1312  ### the default description for that chunk. The analysis also looks for  ### the default description for that chunk. The analysis also looks for
1313  ### S4 class "setClass" calls and R.oo setConstructorS3 and setMethodS3  ### S4 class "setClass" ,R.oo setConstructorS3  R.methodsS3::setMethodS3
1314  ### calls in order to link the documentation of those properly.  ### or S4 setMethod calls in order to link the documentation of those properly.
1315  (code  (code,
1316  ### Lines of R source code in a character vector - note that any  ### Lines of R source code in a character vector - note that any
1317  ### nested \code{source} statements are \emph{ignored} when scanning  ### nested \code{source} statements are \emph{ignored} when scanning
1318  ### for class definitions.  ### for class definitions.
1319     env
1320     ### the environment in which the code has been evaluated before.
1321     ### This is e.g. iportant to make sure that we can evaluate expressions
1322     ### like signature definitions for methods
1323   ){   ){
1324    res <- list()    res <- list()
1325    old.opt <- options(keep.source=TRUE)    old.opt <- options(keep.source=TRUE)
# Line 783  Line 1349 
1349      ## determined by expression type: \describe{      ## determined by expression type: \describe{
1350      ## \item{assignment (<-)}{Ordinary assignment of value/function;}      ## \item{assignment (<-)}{Ordinary assignment of value/function;}
1351      ## \item{setClass}{Definition of S4 class;}      ## \item{setClass}{Definition of S4 class;}
1352        ## \item{setMethod}{Definition of a method of a S4 generic;}
1353      ## \item{setConstructorS3}{Definition of S3 class using R.oo package;}      ## \item{setConstructorS3}{Definition of S3 class using R.oo package;}
1354      ## \item{setMethodS3}{Definition of method for S3 class using R.oo package.}}      ## \item{R.methodsS3::setMethodS3}{Definition of method for S3 class using R.oo package.}}
1355      ## Additionally, the value may be a name of a function defined elsewhere,      ## Additionally, the value may be a name of a function defined elsewhere,
1356      ## in which case the documentation should be copied from that other definition.      ## in which case the documentation should be copied from that other definition.
1357      ## This is handled using the concept of documentation links.      ## This is handled using the concept of documentation links.
# Line 793  Line 1360 
1360      expr.type <- chars[1]      expr.type <- chars[1]
1361      parent <- NA_character_      parent <- NA_character_
1362    
1363      if ( expr.type == "<-" || expr.type == "setConstructorS3" || expr.type == "setClass" ){      if ( expr.type == "<-" || expr.type == "setConstructorS3" ){
1364        object.name <- chars[2]        object.name <- chars[2]
1365        ## If the function definition is not embedded within the call, then        ## If the function definition is not embedded within the call, then
1366        ## the parent is that function. Test whether the the third value        ## the parent is that function. Test whether the the third value
# Line 806  Line 1373 
1373                                  parent=parent,                                  parent=parent,
1374                                  code=paste(chunks[[k]],sep=""),                                  code=paste(chunks[[k]],sep=""),
1375                                  description=default.description)                                  description=default.description)
1376      } else if ( expr.type == "setMethodS3" ){      } else if ( expr.type == "setClass" ){
1377        ##details<< The \code{setMethodS3} calls introduce additional        object.name <- chars[2]
1378          res[[object.name]] <- new("DocLink",name=object.name,
1379                                    created=expr.type,
1380                                    parent=parent,
1381                                    code=paste(chunks[[k]],sep=""),
1382                                    description=default.description)
1383    
1384        }
1385        else if ( expr.type == "R.methodsS3::setMethodS3" || expr.type ==  "R.methodsS3::R.methodsS3::setMethodS3"){
1386          ##details<< The \code{R.methodsS3::setMethodS3} calls introduce additional
1387        ## complexity: they will define an additional S3 generic (which        ## complexity: they will define an additional S3 generic (which
1388        ## needs documentation to avoid warnings at package build time)        ## needs documentation to avoid warnings at package build time)
1389        ## unless one already exists. This also is handled by "linking"        ## unless one already exists. This also is handled by "linking"
1390        ## documentation. A previously unseen generic is linked to the        ## documentation. A previously unseen S3generic is linked to the
1391        ## first defining instances, subsequent definitions of that generic        ## first defining instances, subsequent definitions of that S3generic
1392        ## also link back to the first defining instance.        ## also link back to the first defining instance.
1393        generic.name <- chars[2]        S3generic.name <- chars[2]
1394        object.name <- paste(generic.name,chars[3],sep=".")        object.name <- paste(S3generic.name,chars[3],sep=".")
1395        if ( is.null(res[[generic.name]]) ){        if ( is.null(res[[S3generic.name]]) ){
1396          ## TDH 9 April 2012 Do NOT add \\link in generic.desc below,          ## TDH 9 April 2012 Do NOT add \\link in S3generic.desc below,
1397          ## since it causes problems on R CMD check.          ## since it causes problems on R CMD check.
1398          ##* checking Rd cross-references ... WARNING          ##* checking Rd cross-references ... WARNING
1399          ##Error in find.package(package, lib.loc) :          ##Error in find.package(package, lib.loc) :
1400          ##  there is no package called ‘MASS’          ##  there is no package called ‘MASS’
1401          ##Calls: <Anonymous> -> lapply -> FUN -> find.package          ##Calls: <Anonymous> -> lapply -> FUN -> find.package
1402    
1403          generic.desc <-          S3generic.desc <-
1404            paste("Generic method behind \\code{",object.name,"}",sep="")            paste("Generic method behind \\code{",object.name,"}",sep="")
1405          res[[generic.name]] <- new("DocLink",          res[[S3generic.name]] <- new("DocLink",
1406                                     name=generic.name,                                     name=S3generic.name,
1407                                     created=expr.type,                                     created=expr.type,
1408                                     parent=object.name,                                     parent=object.name,
1409                                     code=NA_character_,                                     code=NA_character_,
1410                                     description=generic.desc)                                     description=S3generic.desc)
1411        } else {        } else {
1412          parent <- res[[generic.name]]@parent          parent <- res[[S3generic.name]]@parent
1413        }        }
1414        ## If the function definition is not embedded within the call, then        ## If the function definition is not embedded within the call, then
1415        ## the parent is that function. Test whether the the fourth value        ## the parent is that function. Test whether the the fourth value
# Line 846  Line 1422 
1422                                  parent=parent,                                  parent=parent,
1423                                  code=paste(chunks[[k]],sep=""),                                  code=paste(chunks[[k]],sep=""),
1424                                  description=default.description)                                  description=default.description)
1425        } else if (expr.type == "setMethod" ) {
1426    
1427          NamedArgs=rewriteSetMethodArgs(lang)
1428          genName=NamedArgs[["f"]]
1429          sigexp=NamedArgs[["signature"]]
1430          sig=eval(sigexp,env)
1431          N <- methodDocName(genName,sig)
1432          object.name <- N
1433    
1434          ## If the function definition is not embedded within the call, then
1435          ## the parent is that function. Test whether the value for "definition"
1436          ## looks like a funktion name and add it to parents if so.
1437          def=paste(as.character(NamedArgs[["definition"]]),collapse="\n")
1438          if ( grepl("^[\\._\\w]+$",def,perl=TRUE) ){
1439            parent <- def
1440          }
1441          res[[object.name]] <- new("DocLink",name=object.name,
1442                                    created=expr.type,
1443                                    parent=parent,
1444                                    code=paste(chunks[[k]],sep=""),
1445                                    description=default.description)
1446      } else {      } else {
1447        ## Not sure what to do with these yet. Need to deal with setMethod, setAs etc.        ## Not sure what to do with these yet. Need to deal with setAs etc.
1448      }      }
1449    }    }
1450    invisible(res)    invisible(res)
# Line 913  Line 1510 
1510    }    }
1511    invisible(docs)    invisible(docs)
1512  }  }
1513    extract.docs.setMethod<- function # S4 mehtod inline documentation
1514    ### Using the same conventions as for functions, definitions of S4 methods
1515    ### in the form \code{setMethod(\dots)} are also located and
1516    ### scanned for inline comments.
1517    
1518  apply.parsers <- function  (doc.link,
1519  ### Parse code to r objs, then run all the parsers and return the  ### DocLink object as created by \code{extract.file.parse}.
1520  ### documentation list.   env,
1521  (code,   ### environment to find method source
1522  ### Character vector of code lines.  inlinedocs.exampleDir,
1523   parsers=default.parsers,  ### A string pointing to the location where inlinedocs should search for external examples
1524  ### List of Parser Functions.  inlinedocs.exampleTrunk
1525   verbose=FALSE,  ### A regular expression used to identify the files containing external examples in the example directory
 ### Echo names of Parser Functions?  
  ...  
 ### Additional arguments to pass to Parser Functions.  
1526   ){   ){
1527      funcSource=getMethodSrc(doc.link,env)
1528      method.name=getMethodName(doc.link,env)
1529      ##pp("funcSource",environment())
1530      docs=list()
1531      docs<- combine(docs,prefixed.lines(funcSource))
1532      ##pp("docs",environment())
1533      docs <- combine(docs,extract.xxx.chunks(funcSource,method.name))
1534      ##pp("docs",environment())
1535      docs <- combine(docs,title.from.firstline(funcSource,method.name))
1536      ##pp("docs",environment())
1537      docs <- combine(docs,mm.examples.from.testfile(method.name,inlinedocs.exampleDir,inlinedocs.exampleTrunk))
1538      docs
1539    }
1540    createObjects <- function(code){
1541      ### the function creates the environment object lists and expression by parsing all the code files
1542      ### Is is factored out to make writing tests easier
1543      ### since we often need the objects and the environment
1544      ### they inhabit
1545    e <- new.env()    e <- new.env()
1546    ## KMP 2011-03-09 fix problem with DocLink when inlinedocs ran on itself    ## KMP 2011-03-09 fix problem with DocLink when inlinedocs ran on itself
1547    ## Error in assignClassDef(Class, classDef, where) :    ## Error in assignClassDef(Class, classDef, where) :
# Line 934  Line 1550 
1550    ## which in turn is inlinedocs when processing inlinedocs package, hence    ## which in turn is inlinedocs when processing inlinedocs package, hence
1551    ## the clash. The following works (under R 2.12.2), so that the topenv()    ## the clash. The following works (under R 2.12.2), so that the topenv()
1552    ## now finds e before finding the inlinedocs environment.    ## now finds e before finding the inlinedocs environment.
1553    old <- options(keep.source=TRUE,topLevelEnvironment=e)  
1554      #old <- options(keep.source=TRUE,topLevelEnvironment=e)
1555      old <- options(topLevelEnvironment=e)
1556    on.exit(options(old))    on.exit(options(old))
1557    exprs <- parse(text=code)    exprs <- parse(text=code,keep.source=TRUE)
1558    ## TDH 2011-04-07 set this so that no warnings about creating a fake    ## TDH 2011-04-07 set this so that no warnings about creating a fake
1559    ## package when we try to process S4 classes defined in code    ## package when we try to process S4 classes defined in code
1560    e$.packageName <- "inlinedocs.processor"    e$.packageName <- "inlinedocs.processor"
1561    for (i in exprs){    for (i in exprs){
1562        eval(i, e)        eval(i, e)
1563    }    }
1564    objs <- sapply(ls(e),get,e,simplify=FALSE)    objs <- sapply(ls(e),get,e,simplify=FALSE) # note that ls will not find S4 classes nor methods for generic functions
1565      list(objs=objs,env=e,exprs=exprs)
1566    }
1567    
1568    
1569    apply.parsers<- function
1570    ### Parse code to r objs, then run all the parsers and return the
1571    ### documentation list.
1572    (code,
1573    ### Character vector of code lines.
1574     parsers=default.parsers,
1575    ### List of Parser Functions.
1576     verbose=FALSE,
1577    ### Echo names of Parser Functions?
1578    inlinedocs.exampleDir,
1579    ### A string pointing to the location where inlinedocs should search for external examples
1580    inlinedocs.exampleTrunk,
1581    ### A string used to identify the files containing external examples in the example directory. All file names of external examples have to start with this string
1582     ...
1583    ### Additional arguments to pass to Parser Functions.
1584     ){
1585      l=createObjects(code)# note that ls will not find S4 classes nor methods for generic functions
1586      objs=l[["objs"]]
1587      e=l[["env"]]
1588      exprs=l[["exprs"]]
1589    docs <- list()    docs <- list()
1590    
1591    ## apply parsers in sequence to code and objs    ## apply parsers in sequence to code and objs
# Line 953  Line 1594 
1594      N <- names(parsers[i])      N <- names(parsers[i])
1595      if(verbose){      if(verbose){
1596        if(is.character(N) && N!=""){        if(is.character(N) && N!=""){
1597          cat(N,"\n",sep="")          cat(" this is parser:",N,"\n",sep="")
1598        }else cat('.\n')        }else cat('.\n')
1599      }      }
1600      p <- parsers[[i]]      p <- parsers[[i]]
1601      ## This is the argument list that each parser receives:      ## This is the argument list that each parser receives:
1602      L <- p(code=code,objs=objs,docs=docs,env=e,...)      L <- p(
1603      #print(paste(L,"\n"))          code=code,
1604      #if(N=="exclude")browser()          objs=objs,
1605            docs=docs,
1606            env=e,
1607            inlinedocs.exampleDir=inlinedocs.exampleDir,
1608            inlinedocs.exampleTrunk=inlinedocs.exampleTrunk,
1609            ...
1610            )
1611      docs <- combine(docs,L)      docs <- combine(docs,L)
1612    }    }
1613    ## post-process to collapse all character vectors    ## post-process to collapse all character vectors
# Line 971  Line 1618 
1618      }      }
1619   }   }
1620    if(verbose)cat("\n")    if(verbose)cat("\n")
1621    return(docs)  
1622      return(list(docs=docs,env=e,objs=objs,exprs=exprs))
1623  ### A list of extracted documentation from code.  ### A list of extracted documentation from code.
1624  }  }
1625    
# Line 993  Line 1641 
1641   parsers=NULL,   parsers=NULL,
1642  ### Parser Functions to use to parse the code and extract  ### Parser Functions to use to parse the code and extract
1643  ### documentation.  ### documentation.
1644    inlinedocs.exampleDir=file.path("..","..","inst","tests"),
1645    ### A string pointing to the location where inlinedocs should search for external examples
1646    inlinedocs.exampleTrunk="example.",
1647    ### A string used to identify the files containing external examples in the example directory. All file names of external examples have to start with this string
1648   ...   ...
1649  ### Other arguments to pass to Parser Functions.  ### Other arguments to pass to Parser Functions.
1650   ){   ){
1651    if(is.null(parsers))parsers <- nondesc.parsers    if(is.null(parsers))parsers <- nondesc.parsers
1652    apply.parsers(readLines(f),parsers,verbose=FALSE,...)    apply.parsers(
1653            readLines(f),
1654            parsers,
1655            verbose=FALSE,
1656            inlinedocs.exampleDir,
1657            inlinedocs.exampleTrunk,
1658            ...
1659            )[["docs"]]
1660  },ex=function(){  },ex=function(){
1661    f <- system.file("silly","R","silly.R",package="inlinedocs")    f <- system.file("silly","R","silly.R",package="inlinedocs")
1662    extract.docs.file(f)    extract.docs.file(f)

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

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