SCM

SCM Repository

[inlinedocs] Annotation of /pkg/inlinedocs/R/parsers.R
ViewVC logotype

Annotation of /pkg/inlinedocs/R/parsers.R

Parent Directory Parent Directory | Revision Log Revision Log


Revision 303 - (view) (download)

1 : tdhock 110 ### combine lists or character strings
2 :     combine <- function(x,y)UseMethod("combine")
3 :    
4 :     ### combine character strings by pasting them together
5 :     combine.character <- function(x,y)
6 :     paste(x,y,sep="\n")
7 :    
8 :     ### combine lists by adding elements or adding to existing elements
9 :     combine.list <- function(x,y){
10 : tdhock 200 toadd <- if(".overwrite"%in%names(y)){
11 :     y <- y[names(y)!=".overwrite"]
12 :     rep(TRUE,length(y))
13 :     }else{
14 :     !names(y)%in%names(x)
15 :     }
16 : tdhock 185 toup <- names(y)[!toadd]
17 : tdhock 110 x[names(y)[toadd]] <- y[toadd]
18 :     for(up in toup)x[[up]] <- combine(x[[up]],y[[up]])
19 : tdhock 200 x
20 : tdhock 110 ### A list, same type as x, but with added elements from y.
21 :     }
22 :    
23 : tdhock 302
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)) unlist(strsplit(as.character(srcref), "\n"))
31 :     else attr(fun.obj, "source")
32 :     ### Source code lines as a character vector.
33 :     }
34 :    
35 : tdhock 110 ### Prefix for code comments used with grep and gsub.
36 : tdhock 257 prefix <- "^[ \t]*###[ \t]*"
37 : tdhock 110
38 :     decomment <- function
39 :     ### Remove comment prefix and join lines of code to form a
40 :     ### documentation string.
41 :     (comments
42 :     ### Character vector of prefixed comment lines.
43 :     ){
44 : tdhock 185 gsub(prefix,"",comments)
45 : tdhock 110 ### String without prefixes or newlines.
46 :     }
47 :    
48 : tdhock 162 forall <- function
49 : tdhock 158 ### For each object in the package that satisfies the criterion
50 :     ### checked by subfun, parse source using FUN and return the resulting
51 : tdhock 87 ### documentation list.
52 :     (FUN,
53 :     ### Function to apply to each element in the package.
54 :     subfun=function(x)TRUE
55 :     ### Function to select subsets of elements of the package, such as
56 :     ### is.function. subfun(x)==TRUE means FUN will be applied to x and
57 :     ### the result will be returned.
58 :     ){
59 : tdhock 138 FUN <- FUN
60 :     f <- function(objs,docs,...){
61 : tdhock 300 if(length(objs)==0)return(list())
62 : tdhock 87 objs <- objs[sapply(objs,subfun)]
63 :     L <- list()
64 : tdhock 162 on.exit(cat(sprintf("Parser Function failed on %s\n",N)))
65 : tdhock 204 for(N in union(names(docs),names(objs))){
66 : tdhock 87 o <- objs[[N]]
67 : tdhock 302 L[[N]] <- FUN(src=getSource(o),
68 : tdhock 89 name=N,objs=objs,o=o,docs=docs,doc=docs[[N]],...)
69 : tdhock 87 }
70 : tdhock 162 on.exit()## remove warning message
71 : tdhock 87 L
72 :     }
73 : tdhock 138 class(f) <- c("allfun","function")
74 :     f
75 : tdhock 87 ### A Parser Function.
76 :     }
77 :    
78 : tdhock 138 ### Print method for functions constructed using forall.
79 :     print.allfun <- function(x,...){
80 :     e <- environment(x)
81 :     cat("Function to apply to every element.\nselector:")
82 :     print(e$subfun)
83 :     cat("processor:")
84 :     print(e$FUN)
85 :     }
86 :    
87 : tdhock 87 ### For each function in the package, do something.
88 :     forfun <- function(FUN)forall(FUN,is.function)
89 :    
90 : tdhock 163 kill.prefix.whitespace <- function
91 :     ### Figure out what the whitespace preceding the example code is, and
92 :     ### then delete that from every line.
93 :     (ex
94 :     ### character vector of example code lines.
95 :     ){
96 :     tlines <- gsub("\\s*","",ex)
97 :     ##tlines <- gsub("#.*","",tlines)
98 :     prefixes <- unique(gsub("\\S.*","",ex[tlines!=""]))
99 :     FIND <- prefixes[which.min(nchar(prefixes))]
100 :     ## Eliminate leading tabulations or 2/4 spaces
101 :     sub(FIND, "", ex)
102 :     ### Character vector of code lines with preceding whitespace removed.
103 :     }
104 :    
105 : tdhock 175 prefixed.lines <- structure(function(src,...){
106 : tdhock 138 ### The primary mechanism of inline documentation is via consecutive
107 :     ### groups of lines matching the specified prefix regular expression
108 :     ### "\code{^### }" (i.e. lines beginning with "\code{### }") are
109 :     ### collected as follows into documentation sections:\describe{
110 :     ### \item{description}{group starting at line 2 in the code}
111 :     ### \item{arguments}{group following each function argument}
112 :     ### \item{value}{group ending at the penultimate line of the code}}
113 :     ### These may be added to by use of the \code{##<<} constructs
114 :     ### described below.
115 :     clines <- grep(prefix,src)
116 :     if(length(clines)==0)return(list())
117 :     bounds <- which(diff(clines)!=1)
118 :     starts <- c(1,bounds+1)
119 :     ends <- c(bounds,length(clines))
120 :     ## detect body of function using paren matching
121 : tdhock 159 code <- gsub("#.*","",src)
122 :     f <- function(ch)cumsum(nchar(gsub(sprintf("[^%s]",ch),"",code)))
123 : tdhock 138 parens <- f("(")-f(")")
124 :     body.begin <- which(diff(parens)<0 & parens[-1]==0)+2
125 : tdhock 175 if(length(body.begin)==0)body.begin <- 1 ## rare cases
126 : tdhock 138 is.arg <- function(){
127 : tdhock 159 gres <- grep("^\\s*#",src[start-1],perl=TRUE)
128 :     0 == length(gres) && start<=body.begin
129 :     }
130 : tdhock 138 res <- list()
131 :     for(i in seq_along(starts)){
132 :     start <- clines[starts[i]]
133 :     end <- clines[ends[i]]
134 : tdhock 303 lab <- if(all(gsub("[ }]","",src[(end+1):length(src)])==""))"value"
135 : tdhock 138 else if(start==2)"description"
136 :     else if(is.arg()){
137 :     ##twutz: strip leading white spaces and brackets and ,
138 :     arg <- gsub("^[ \t(,]*", "", src[start - 1])
139 :     arg <- gsub("^([^=,]*)[=,].*", "\\1", arg)
140 :     ##twutz: remove trailing whitespaces
141 :     arg <- gsub("^([^ \t]*)([ \t]+)$","\\1",arg)
142 :     arg <- gsub("...", "\\dots", arg, fix = TRUE)
143 :     paste("item{",arg,"}",sep="")
144 :     } else {
145 :     next;
146 :     }
147 :     res[[lab]] <- decomment(src[start:end])
148 :     }
149 :     res
150 : tdhock 175 },ex=function(){
151 :     test <- function
152 : tdhock 191 ### the description
153 : tdhock 175 (x,
154 :     ### the first argument
155 :     y ##<< another argument
156 :     ){
157 :     5
158 :     ### the return value
159 :     ##seealso<< foobar
160 : tdhock 138 }
161 : tdhock 302 src <- getSource(test)
162 : tdhock 175 prefixed.lines(src)
163 :     extract.xxx.chunks(src)
164 :     })
165 : tdhock 138
166 : tdhock 154 extract.xxx.chunks <- function # Extract documentation from a function
167 : tdhock 87 ### Given source code of a function, return a list describing inline
168 :     ### documentation in that source code.
169 : tdhock 154 (src,
170 :     ### The source lines of the function to examine, as a character
171 :     ### vector.
172 :     name.fun="(unnamed function)",
173 : tdhock 87 ### The name of the function/chunk to use in warning messages.
174 : tdhock 154 ...
175 :     ### ignored.
176 : tdhock 95 ){
177 : tdhock 87 res <- list()
178 :     ##details<< For simple functions/arguments, the argument may also be
179 :     ## documented by appending \code{##<<} comments on the same line as the
180 :     ## argument name. Mixing this mechanism with \code{###} comment lines for
181 :     ## the same argument is likely to lead to confusion, as the \code{###}
182 :     ## lines are processed first.
183 :     #arg.pat <- paste("^[^=,#]*?([\\w\\.]+)\\s*([=,].*|\\)\\s*)?",
184 :     # "<<\\s*(\\S.*?)\\s*$",
185 :     # sep="##") # paste avoids embedded trigger fooling the system
186 :     #tw: removed first comma
187 :     arg.pat <- paste("^[^=#]*?([\\w\\.]+)\\s*([=,].*|\\)\\s*)?",
188 :     "<<\\s*(\\S.*?)\\s*$",
189 :     sep="##") # paste avoids embedded trigger fooling the system
190 :    
191 :     skeleton.fields <- c("alias","details","keyword","references","author",
192 :     "note","seealso","value","title","description",
193 :     "describe","end")
194 :     ##details<< Additionally, consecutive sections of \code{##} comment
195 :     ## lines beginning with \code{##}\emph{xxx}\code{<<} (where
196 :     ## \emph{xxx} is one of the fields: \code{alias}, \code{details},
197 :     ## \code{keyword}, \code{references}, \code{author}, \code{note},
198 :     ## \code{seealso}, \code{value}, \code{title} or \code{description})
199 :     ## are accumulated and inserted in the relevant part of the .Rd
200 :     ## file.
201 :     ##
202 :     ## For \code{value}, \code{title}, \code{description} and function
203 :     ## arguments, these \emph{append} to any text from "prefix"
204 :     ## (\code{^### }) comment lines, irrespective of the order in the
205 :     ## source.
206 :     ##
207 :     ## When documenting S4 classes, documentation from \code{details}
208 :     ## sections will appear under a section \code{Objects from the Class}. That
209 :     ## section typically includes information about construction methods
210 :     ## as well as other description of class objects (but note that the
211 :     ## class Slots are documented in a separate section).
212 :    
213 :     ## but this should not appear, because separated by a blank line
214 :     extra.regexp <- paste("^\\s*##(",paste(skeleton.fields,collapse="|"),
215 :     ")<<\\s*(.*)$",sep="")
216 :     cont.re <- "^\\s*##\\s*"
217 :     in.describe <- 0
218 :     first.describe <- FALSE
219 :     k <- 1
220 :     in.chunk <- FALSE
221 :     end.chunk <- function(field,payload)
222 :     {
223 :     if ( "alias" == field ){
224 :     ##note<< \code{alias} extras are automatically split at new lines.
225 :     payload <- gsub("\\n+","\\}\n\\\\alias\\{",payload,perl=TRUE)
226 :     chunk.sep <- "}\n\\alias{"
227 :     } else if ( "keyword" == field ){
228 :     ##keyword<< documentation utilities
229 :     ##note<< \code{keyword} extras are automatically split at white space,
230 :     ## as all the valid keywords are single words.
231 :     payload <- gsub("\\s+","\\}\n\\\\keyword\\{",payload,perl=TRUE)
232 :     chunk.sep <- "}\n\\keyword{"
233 :     } else if ( "title" == field ){
234 :     chunk.sep <- " "
235 :     } else if ( "description" == field ){
236 :     chunk.sep <- "\n"
237 :     } else {
238 :     ##details<< Each separate extra section appears as a new
239 :     ## paragraph except that: \itemize{\item empty sections (no
240 :     ## matter how many lines) are ignored;\item \code{alias} and
241 :     ## \code{keyword} sections have special rules;\item
242 :     ## \code{description} should be brief, so all such sections
243 :     ## are concatenated as one paragraph;\item \code{title} should
244 :     ## be one line, so any extra \code{title} sections are
245 :     ## concatenated as a single line with spaces separating the
246 :     ## sections.}
247 :     chunk.sep <- "\n\n"
248 :     }
249 :     chunk.res <- NULL
250 : tdhock 191 if ( !grepl("^\\s*$",payload,perl=TRUE) )
251 : tdhock 87 chunk.res <-
252 :     if ( is.null(res[[field]]) ) payload
253 :     else paste(res[[field]], payload, sep=chunk.sep)
254 :     invisible(chunk.res)
255 :     }
256 : tdhock 154 while ( k <= length(src) ){
257 :     line <- src[k]
258 : tdhock 191 if ( grepl(extra.regexp,line,perl=TRUE) ){
259 : tdhock 87 ## we have a new extra chunk - first get field name and any payload
260 :     new.field <- gsub(extra.regexp,"\\1",line,perl=TRUE)
261 :     new.contents <- gsub(extra.regexp,"\\2",line,perl=TRUE)
262 :    
263 :     ##details<< As a special case, the construct \code{##describe<<} causes
264 :     ## similar processing to the main function arguments to be
265 :     ## applied in order to construct a describe block within the
266 :     ## documentation, for example to describe the members of a
267 :     ## list. All subsequent "same line" \code{##<<} comments go into that
268 :     ## block until terminated by a subsequent \code{##}\emph{xxx}\code{<<} line.
269 :     if ( "describe" == new.field ){
270 :     ##details<< Such regions may be nested, but not in such a way
271 :     ## that the first element in a \code{describe} is another \code{describe}.
272 :     ## Thus there must be at least one \code{##<<} comment between each
273 :     ## pair of \code{##describe<<} comments.
274 :     if ( first.describe ){
275 :     stop("consecutive ##describe<< at line",k,"in",name.fun)
276 :     } else {
277 :     if ( nzchar(new.contents) ){
278 :     if ( is.null(payload) || 0 == nzchar(payload) ){
279 :     payload <- new.contents
280 :     } else {
281 :     payload <- paste(payload,new.contents,sep="\n\n")
282 :     }
283 :     }
284 :     first.describe <- TRUE
285 :     }
286 :     } else if ( "end" == new.field ){
287 :     ##details<< When nested \code{describe} blocks are used, a comment-only
288 :     ## line with \code{##end<<} terminates the current level only; any
289 :     ## other valid \code{##}\emph{xxx}\code{<<} line terminates
290 :     ## all open describe blocks.
291 :     if ( in.describe>0 ){
292 :     ## terminate current \item and \describe block only
293 :     if ( "value" == cur.field && 1 == in.describe ){
294 :     payload <- paste(payload,"}",sep="")
295 :     } else {
296 :     payload <- paste(payload,"}\n}",sep="")
297 :     }
298 :     in.describe <- in.describe-1;
299 :     } else {
300 :     warning("mismatched ##end<< at line ",k," in ",name.fun)
301 :     }
302 :     if ( nzchar(new.contents) ){
303 :     if ( nzchar(payload) ){
304 :     payload <- paste(payload,new.contents,sep="\n")
305 :     } else {
306 :     payload <- new.contents
307 :     }
308 :     }
309 :     } else {
310 :     ## terminate all open \describe blocks (+1 because of open item)
311 :     if ( 0 < in.describe ){
312 :     if ( "value" != cur.field ){ # value is implicit describe block
313 :     payload <- paste(payload,"}",sep="")
314 :     }
315 :     while ( in.describe>0 ){
316 :     payload <- paste(payload,"}",sep="\n")
317 :     in.describe <- in.describe-1;
318 :     }
319 :     }
320 :     ## finishing any existing payload
321 :     if ( in.chunk ) res[[cur.field]] <- end.chunk(cur.field,payload)
322 :     in.chunk <- TRUE
323 :     cur.field <- new.field
324 :     payload <- new.contents
325 :     ##note<< The "value" section of a .Rd file is implicitly a describe
326 :     ## block and \code{##}\code{value}\code{<<} acts accordingly. Therefore
327 :     ## it automatically enables the describe block itemization (##<< after
328 :     ## list entries).
329 :     if ( "value" == new.field ){
330 :     first.describe <- TRUE;
331 :     }
332 :     }
333 : tdhock 191 } else if ( in.chunk && grepl(cont.re,line,perl=TRUE) ){
334 : tdhock 87 ## append this line to current chunk
335 : tdhock 191 if ( !grepl(prefix,line,perl=TRUE) ){
336 : tdhock 87 ##describe<< Any lines with "\code{### }" at the left hand
337 :     ## margin within the included chunks are handled separately,
338 :     ## so if they appear in the documentation they will appear
339 :     ## before the \code{##}\emph{xxx}\code{<}\code{<} chunks.
340 :     ### This one should not appear.
341 :     stripped <- gsub(cont.re,"",line,perl=TRUE)
342 :     if ( nzchar(payload) ){
343 :     payload <- paste(payload,stripped,sep="\n")
344 :     } else {
345 :     payload <- stripped
346 :     }
347 :     }
348 : tdhock 191 } else if ( grepl(arg.pat,line,perl=TRUE) ){
349 : tdhock 87 not.describe <- (0==in.describe && !first.describe)
350 :     if ( in.chunk && not.describe){
351 :     res[[cur.field]] <- end.chunk(cur.field,payload)
352 :     }
353 :     comment <- gsub(arg.pat,"\\3",line,perl=TRUE);
354 :     arg <- gsub(arg.pat,"\\\\item\\{\\1\\}",line,perl=TRUE)
355 :     in.chunk <- TRUE
356 :     if ( not.describe ){
357 : tdhock 115 ## TDH 2010-06-18 For item{}s in the documentation list names,
358 :     ## we don't need to have a backslash before, so delete it.
359 :     arg <- gsub("^[\\]+","",arg)
360 : tdhock 87 cur.field <- gsub("...","\\dots",arg,fix=TRUE) ##special case for dots
361 :     payload <- comment
362 :     } else {
363 :     ## this is a describe block, so we need to paste with existing
364 :     ## payload as a new \item.
365 :     if ( first.describe ){
366 :     ## for first item, need to add describe block starter
367 :     if ( "value" == cur.field ){
368 :     payload <- paste(payload,"\n",arg,"{",sep="")
369 :     } else {
370 :     payload <- paste(payload,"\\describe{\n",arg,"{",sep="")
371 :     }
372 :     first.describe <- FALSE
373 :     in.describe <- in.describe+1
374 :     } else {
375 :     ## subsequent item - terminate existing and start new
376 :     payload <- paste(payload,"}\n",arg,"{",sep="")
377 :     }
378 :     if ( nzchar(comment) ){
379 :     payload <- paste(payload,comment,sep="")
380 :     }
381 :     }
382 :     } else if ( in.chunk ){
383 :     if ( 0 == in.describe && !first.describe ){
384 :     ## reached an end to current field, but need to wait if in.describe
385 :     res[[cur.field]] <- end.chunk(cur.field,payload)
386 :     in.chunk <- FALSE
387 :     cur.field <- NULL
388 :     payload <- NULL
389 :     }
390 :     }
391 :     k <- k+1
392 :     }
393 :     ## finishing any existing payload
394 :     if ( 0 < in.describe ){
395 :     if ( "value" != cur.field ){ # value is implicit describe block
396 :     payload <- paste(payload,"}",sep="")
397 :     }
398 :     while ( in.describe>0 ){
399 :     payload <- paste(payload,"}",sep="\n")
400 :     in.describe <- in.describe-1;
401 :     }
402 :     }
403 :     if ( in.chunk ) res[[cur.field]] <- end.chunk(cur.field,payload)
404 :     res
405 :     ### Named list of character strings extracted from comments. For each
406 :     ### name N we will look for N\{...\} in the Rd file and replace it
407 :     ### with the string in this list (implemented in modify.Rd.file).
408 :     }
409 :    
410 : kmpont 212 leadingS3generic <- function # check whether function name is an S3 generic
411 :     ### Determines whether a function name looks like an S3 generic function
412 :     (name, ##<< name of function
413 :     env, ##<< environment to search for additional generics
414 :     ...) ##<< ignored here
415 :     {
416 :     ##details<< This function is one of the default parsers, but exposed as
417 :     ## possibly of more general interest. Given a function name of the form
418 :     ## x.y.z it looks for the generic function x applying to objects of class
419 :     ## y.z and also for generic function x.y applying to objects of class z.
420 :     ##
421 :     parts <- strsplit(name, ".", fixed = TRUE)[[1]]
422 :     l <- length(parts)
423 :     if (l > 1) {
424 :     for (i in 1:(l - 1)) {
425 :     ## Look for a generic function (known by the system or defined
426 :     ## in the package) that matches that part of the function name
427 :     generic <- paste(parts[1:i], collapse = ".")
428 :     if (any(generic %in% utils:::getKnownS3generics()) ||
429 :     utils:::findGeneric(generic, env) != "") {
430 :     object <- paste(parts[(i + 1):l], collapse = ".")
431 :     ##details<< Assumes that the first name which matches any known
432 :     ## generics is the target generic function, so if both x and x.y
433 :     ## are generic functions, will assume generic x applying to objects
434 :     ## of class y.z
435 :     ##value<< If a matching generic found returns a list with a single component:
436 :     return(list(.s3method=c(generic, object))) ##<< a character vector containing generic name and object name.
437 :     }
438 :     }
439 :     }
440 :     ##value<< If no matching generic functions are found, returns an empty list.
441 :     list()
442 :     }
443 :    
444 : tdhock 154 ### Parsers for each function that are constructed automatically. This
445 :     ### is a named list, and each element is a parser function for an
446 :     ### individual object.
447 :     forfun.parsers <-
448 :     list(prefixed.lines=prefixed.lines,
449 :     extract.xxx.chunks=extract.xxx.chunks,
450 :     ## title from first line of function def
451 : tdhock 191 title.from.firstline=function(src,...){
452 : tdhock 195 first <- src[1]
453 :     if(!is.character(first))return(list())
454 :     if(!grepl("#",first))return(list())
455 :     list(title=gsub("[^#]*#\\s*(.*)","\\1",first,perl=TRUE))
456 : tdhock 154 },
457 :     ## PhG: it is tests/FUN.R!!! I would like more flexibility here
458 :     ## please, let me choose which dir to use for examples!
459 :     ## Get examples for FUN from the file tests/FUN.R
460 :     examples.from.testfile=function(name,...){
461 :     tsubdir <- getOption("inlinedocs.exdir")
462 :     if (is.null(tsubdir)) tsubdir <- "tests" # Default value
463 :     tfile <- file.path("..",tsubdir,paste(name,".R",sep=""))
464 :     if(file.exists(tfile))
465 : tdhock 185 list(examples=readLines(tfile))
466 : tdhock 154 else list()
467 :     },
468 :     definition.from.source=function(doc,src,...){
469 :     def <- doc$definition
470 :     is.empty <- function(x)is.null(x)||x==""
471 :     if(is.empty(def) && !is.empty(src))
472 : tdhock 185 list(definition=src)
473 : tdhock 154 else list()
474 :     })
475 :    
476 :     ### List of Parser Functions that can be applied to any object.
477 :     forall.parsers <-
478 :     list(## Fill in author from DESCRIPTION and titles.
479 :     author.from.description=function(desc,...){
480 :     list(author=desc[,"Maintainer"])
481 :     },
482 :     ## The format section sometimes causes problems, so erase it.
483 :     erase.format=function(...){
484 :     list(format="")
485 :     },
486 :     ## Convert the function name to a title.
487 :     title.from.name=function(name,doc,...){
488 :     if("title"%in%names(doc))list() else
489 :     list(title=gsub("[._]"," ",name))
490 :     },
491 :     ## PhG: here is what I propose for examples code in the 'ex' attribute
492 :     examples.in.attr = function (name, o, ...) {
493 :     ex <- attr(o, "ex")
494 :     if (!is.null(ex)) {
495 :     ## Special case for code contained in a function
496 :     if (inherits(ex, "function")) {
497 :     ## If source is available, start from there
498 : tdhock 302 src <- getSource(ex)
499 : tdhock 154 if (!is.null(src)) {
500 :     ex <- src
501 :     } else { ## Use the body of the function
502 :     ex <- deparse(body(ex))
503 :     }
504 :     ## Eliminate leading and trailing code
505 :     ex <- ex[-c(1, length(ex))]
506 : tdhock 303 if(ex[1]=="{")ex <- ex[-1]
507 : tdhock 163 ## all the prefixes
508 :     ex <- kill.prefix.whitespace(ex)
509 : tdhock 154 ## Add an empty line before and after example
510 :     ex <- c("", ex, "")
511 :     }
512 : tdhock 185 list(examples = ex)
513 : tdhock 154 } else list()
514 : tdhock 200 },collapse=function(doc,...){
515 :     L <- lapply(doc,paste,collapse="\n")
516 :     L$.overwrite <- TRUE
517 :     L
518 : kmpont 212 },tag.s3methods=leadingS3generic
519 : tdhock 196 )
520 : tdhock 154
521 :     ### List of parser functions that operate on single objects. This list
522 :     ### is useful for testing these functions.
523 : tdhock 196 lonely <- structure(c(forall.parsers,forfun.parsers),ex=function(){
524 : tdhock 154 f <- function # title
525 :     ### description
526 :     (x, ##<< arg x
527 :     y
528 :     ### arg y
529 :     ){
530 :     ##value<< a list with elements
531 :     list(x=x, ##<< original x value
532 :     y=y, ##<< original y value
533 :     sum=x+y) ##<< their sum
534 :     ##end<<
535 :     }
536 : tdhock 302 src <- getSource(f)
537 : tdhock 154 lonely$extract.xxx.chunks(src)
538 :     lonely$prefixed.lines(src)
539 : tdhock 196 })
540 : tdhock 154
541 :     extra.code.docs <- function # Extract documentation from code chunks
542 :     ### Parse R code to extract inline documentation from comments around
543 :     ### each function. These are not able to be retreived simply by
544 :     ### looking at the "source" attribute. This is a Parser Function that
545 :     ### can be used in the parser list of package.skeleton.dx(). TODO:
546 :     ### Modularize this into separate Parsers Functions for S4 classes,
547 :     ### prefixes, ##<<blocks, etc. Right now it is not very clean!
548 :     (code,
549 :     ### Code lines in a character vector containing multiple R objects to
550 :     ### parse for documentation.
551 :     objs,
552 :     ### The objects defined in the code.
553 :     ...
554 :     ### ignored
555 :     ){
556 :     parsed <- extract.file.parse(code)
557 :     extract.docs.try <- function(o,on)
558 :     {
559 :     ## Note: we could use parsed information here too, but that
560 :     ## would produce different results for setMethodS3 etc.
561 :     doc <- list()
562 :     if ( !is.null(parsed[[on]]) ){
563 :     if ( !is.na(parsed[[on]]@code[1]) ){ # no code given for generics
564 : tdhock 185 doc$definition <- paste(parsed[[on]]@code)
565 : tdhock 154 }
566 :     if(!"description"%in%names(doc) && !is.na(parsed[[on]]@description) ){
567 :     doc$description <- parsed[[on]]@description
568 :     }
569 : kmpont 212 ## if ( "setMethodS3" == parsed[[on]]@created ){
570 :     ## gen <- leadingS3generic(on,topenv())
571 :     ## if ( 0 < length(gen) ){
572 :     ## doc$.s3method <- gen$.s3method
573 :     ## cat("S3method(",gen$.s3method[1],",",gen$.s3method[2],")\n",sep="")
574 :     ## }
575 :     ## }
576 : tdhock 154 }
577 :     if("title" %in% names(doc) && !"description" %in% names(doc) ){
578 :     ## For short functions having both would duplicate, but a
579 :     ## description is required. Therefore automatically copy title
580 :     ## across to avoid errors at package build time.
581 :     doc$description <- doc$title
582 :     }
583 :     doc
584 :     }
585 :     extract.docs <- function(on){
586 :     res <- try({o <- objs[[on]]
587 :     extract.docs.try(o, on)},FALSE)
588 :     if(class(res)=="try-error"){
589 :     cat("Failed to extract docs for: ",on,"\n\n")
590 :     list()
591 :     } else if(0 == length(res) && inherits(objs[[on]],"standardGeneric")){
592 :     NULL
593 :     } else if(0 == length(res) && "function" %in% class(o)
594 : tdhock 302 && 1 == length(osource <- getSource(o))
595 : tdhock 191 && grepl(paste("UseMethod(",on,")",sep="\""),osource)
596 : tdhock 154 ){
597 :     ## phew - this should only pick up R.oo S3 generic definitions like:
598 :     ## attr(*, "source")= chr "function(...) UseMethod(\"select\")"
599 :     NULL
600 :     } else res
601 :     }
602 :     doc.names <- names(objs)
603 :     res <- sapply(doc.names,extract.docs,simplify=FALSE)
604 :     ## Special processing for S4 classes as they do not appear in normal ls()
605 :     for ( nn in names(parsed) ){
606 :     if ( parsed[[nn]]@created == "setClass" ){
607 :     S4class.docs <- extract.docs.setClass(parsed[[nn]])
608 :     docname <- paste(nn,"class",sep="-")
609 :     if ( is.null(res[[docname]]) ){
610 :     res[[docname]] <- S4class.docs
611 :     doc.names <- c(doc.names,docname)
612 :     } else {
613 :     stop(nn," appears as both S4 class and some other definition")
614 :     }
615 :     }
616 :     }
617 :     inherit.docs <- function(on){
618 :     in.res <- res[[on]]
619 :     if ( !is.null(parsed[[on]]) ){
620 :     for ( parent in parsed[[on]]@parent ){
621 :     if ( !is.na(parent) ){
622 :     if ( is.null(in.res) ){
623 :     in.res <- res[[parent]]
624 :     } else if ( parent %in% names(res) ){
625 :     parent.docs <- res[[parent]]
626 :     for ( nn in names(parent.docs) ){
627 :     if ( !nn %in% names(in.res) ){
628 :     in.res[[nn]] <- parent.docs[[nn]]
629 :     }
630 :     }
631 :     }
632 :     }
633 :     }
634 :     }
635 :     invisible(in.res)
636 :     }
637 :     all.done <- FALSE
638 :     while ( !all.done ){
639 :     res1 <- sapply(doc.names,inherit.docs,simplify=FALSE)
640 :     all.done <- identical(res1,res)
641 :     res <- res1
642 :     }
643 :     ## now strip out any generics (which have value NULL in res):
644 :     res.not.null <- sapply(res,function(x){!is.null(x)})
645 :     if ( 0 < length(res.not.null) && length(res.not.null) < length(res) ){
646 :     res <- res[res.not.null]
647 :     }
648 :     res
649 :     ### named list of lists, one for each object to document.
650 :     }
651 :    
652 :     ### List of parsers to use by default with package.skeleton.dx.
653 :     default.parsers <-
654 :     c(extra.code.docs=extra.code.docs, ## TODO: cleanup!
655 :     sapply(forfun.parsers,forfun),
656 :     edit.package.file=function(desc,...){
657 :     in.details <- setdiff(colnames(desc),"Description")
658 : tdhock 185 details <- sprintf("%s: \\tab %s\\cr",in.details,desc[,in.details])
659 : tdhock 154 L <-
660 :     list(list(title=desc[,"Title"],
661 :     description=desc[,"Description"],
662 : tdhock 195 `tabular{ll}`=details))
663 : tdhock 154 names(L) <- paste(desc[,"Package"],"-package",sep="")
664 :     L
665 : tdhock 197 },
666 :     sapply(forall.parsers,forall)
667 : tdhock 186 )
668 : tdhock 154
669 : tdhock 87 setClass("DocLink", # Link documentation among related functions
670 :     ### The \code{.DocLink} class provides the basis for hooking together
671 :     ### documentation of related classes/functions/objects. The aim is that
672 : kmpont 212 ### documentation sections missing from the child are inherited from
673 :     ### the parent class.
674 : tdhock 87 representation(name="character", ##<< name of object
675 :     created="character", ##<< how created
676 :     parent="character", ##<< parent class or NA
677 :     code="character", ##<< actual source lines
678 :     description="character") ##<< preceding description block
679 :     )
680 :    
681 :     extract.file.parse <- function # File content analysis
682 :     ### Using the base \code{\link{parse}} function, analyse the file to link
683 :     ### preceding "prefix" comments to each active chunk. Those comments form
684 :     ### the default description for that chunk. The analysis also looks for
685 :     ### S4 class "setClass" calls and R.oo setConstructorS3 and setMethodS3
686 :     ### calls in order to link the documentation of those properly.
687 :     (code
688 :     ### Lines of R source code in a character vector - note that any
689 :     ### nested \code{source} statements are \emph{ignored} when scanning
690 :     ### for class definitions.
691 :     ){
692 :     res <- list()
693 :     old.opt <- options(keep.source=TRUE)
694 :     parsed <- try(parse(text=code))
695 :     options(old.opt)
696 :     if ( inherits(parsed,"try-error") ){
697 :     stop("parse failed with error:\n",parsed)
698 :     }
699 :     chunks <- attr(parsed,"srcref")
700 :     last.end <- 0
701 :     for ( k in 1:length(parsed) ){
702 :     start <- chunks[[k]][1]
703 :     ##details<< If the definition chunk does not contain a
704 :     ## description, any immediately preceding sequence consecutive
705 :     ## "prefix" lines will be used instead.
706 :     default.description <- NULL
707 :     while ( start > last.end+1
708 : tdhock 191 && grepl(prefix,code[start-1],perl=TRUE) ){
709 : tdhock 87 start <- start-1
710 :     }
711 :     if ( start < chunks[[k]][1] ){
712 :     default.description <- decomment(code[start:(chunks[[k]][1]-1)])
713 :     } else {
714 :     default.description <- NA_character_;
715 :     }
716 :     ##details<< Class and method definitions can take several forms,
717 :     ## determined by expression type: \describe{
718 :     ## \item{assignment (<-)}{Ordinary assignment of value/function;}
719 :     ## \item{setClass}{Definition of S4 class;}
720 :     ## \item{setConstructorS3}{Definition of S3 class using R.oo package;}
721 :     ## \item{setMethodS3}{Definition of method for S3 class using R.oo package.}}
722 :     ## Additionally, the value may be a name of a function defined elsewhere,
723 :     ## in which case the documentation should be copied from that other definition.
724 :     ## This is handled using the concept of documentation links.
725 :     lang <- parsed[[k]]
726 :     chars <- as.character(lang)
727 :     expr.type <- chars[1]
728 :     parent <- NA_character_
729 :    
730 :     if ( expr.type == "<-" || expr.type == "setConstructorS3" || expr.type == "setClass" ){
731 :     object.name <- chars[2]
732 :     ## If the function definition is not embedded within the call, then
733 :     ## the parent is that function. Test whether the the third value
734 :     ## looks like a name and add it to parents if so.
735 : tdhock 191 if ( grepl("^[\\._\\w]+$",chars[3],perl=TRUE) ){
736 : tdhock 87 parent <- chars[3]
737 :     }
738 :     res[[object.name]] <- new("DocLink",name=object.name,
739 :     created=expr.type,
740 :     parent=parent,
741 :     code=paste(chunks[[k]],sep=""),
742 :     description=default.description)
743 :     } else if ( expr.type == "setMethodS3" ){
744 :     ##details<< The \code{setMethodS3} calls introduce additional
745 :     ## complexity: they will define an additional S3 generic (which
746 :     ## needs documentation to avoid warnings at package build time)
747 :     ## unless one already exists. This also is handled by "linking"
748 :     ## documentation. A previously unseen generic is linked to the
749 :     ## first defining instances, subsequent definitions of that generic
750 :     ## also link back to the first defining instance.
751 :     generic.name <- chars[2]
752 :     object.name <- paste(generic.name,chars[3],sep=".")
753 :     if ( is.null(res[[generic.name]]) ){
754 :     generic.desc <- paste("Generic method behind \\code{\\link{",object.name,"}}",sep="")
755 :     res[[generic.name]] <- new("DocLink",
756 :     name=generic.name,
757 :     created=expr.type,
758 :     parent=object.name,
759 :     code=NA_character_,
760 :     description=generic.desc)
761 :     } else {
762 :     parent <- res[[generic.name]]@parent
763 :     }
764 :     ## If the function definition is not embedded within the call, then
765 :     ## the parent is that function. Test whether the the fourth value
766 :     ## looks like a name and add it to parents if so.
767 : tdhock 191 if ( grepl("^[\\._\\w]+$",chars[4],perl=TRUE) ){
768 : tdhock 87 parent <- c(chars[4],parent)
769 :     }
770 :     res[[object.name]] <- new("DocLink",name=object.name,
771 :     created=expr.type,
772 :     parent=parent,
773 :     code=paste(chunks[[k]],sep=""),
774 :     description=default.description)
775 :     } else {
776 :     ## Not sure what to do with these yet. Need to deal with setMethod, setAs etc.
777 :     }
778 :     }
779 :     invisible(res)
780 :     ### Returns an invisible list of .DocLink objects.
781 :     }
782 :    
783 :     extract.docs.setClass <- function # S4 class inline documentation
784 :     ### Using the same conventions as for functions, definitions of S4 classes
785 :     ### in the form \code{setClass("classname",\dots)} are also located and
786 :     ### scanned for inline comments.
787 : tdhock 93 (doc.link
788 : tdhock 87 ### DocLink object as created by \code{\link{extract.file.parse}}.
789 :     ### Note that \code{source} statements are \emph{ignored} when scanning for
790 :     ### class definitions.
791 : tdhock 93 ){
792 : tdhock 87 chunk.source <- doc.link@code
793 :     ##details<<
794 :     ## Extraction of S4 class documentation is currently limited to expressions
795 :     ## within the source code which have first line starting with
796 :     ## \code{setClass("classname"}. These are located from the source file
797 :     ## (allowing also for white space around the \code{setClass} and \code{(}).
798 :     ## Note that \code{"classname"} must be a quoted character string;
799 :     ## expressions returning such a string are not matched.
800 :     class.name <- doc.link@name
801 :    
802 :     ##details<< For class definitions, the slots (elements of the
803 :     ## \code{representation} list) fill the role of function
804 :     ## arguments, so may be documented by \code{##<<} comments on
805 :     ## the same line or \code{### } comments at the beginning of the
806 :     ## following line.
807 :     f.n <- paste(class.name,"class",sep="-")
808 : tdhock 154 docs <- extract.xxx.chunks(chunk.source,f.n)
809 : tdhock 138 ## also apply source parsing functions that I separated out into
810 :     ## separate functions
811 :     docs <- combine(docs,lonely$prefixed.lines(chunk.source))
812 :     docs$title <- lonely$title.from.firstline(chunk.source)
813 : tdhock 87 ##details<<
814 :     ## The class definition skeleton includes an \code{Objects from the Class}
815 :     ## section, to which any \code{##details<<} documentation chunks are
816 :     ## written. It is given a vanilla content if there are no specific
817 :     ## \code{##details<<} documentation chunks.
818 :     if ( is.null(docs[["details"]]) ){
819 :     docs[["details"]] <-
820 :     paste("Objects can be created by calls of the form \\code{new(",
821 :     class.name," ...)}",sep="")
822 :     }
823 :     docs[["section{Objects from the Class}"]] <- docs[["details"]]
824 :     ## seealso has a skeleton line not marked by ~ .. ~, so have to suppress
825 :     if ( is.null(docs[["seealso"]]) ){
826 :     docs[["seealso"]] <- ""
827 :     }
828 :     if ( is.null(docs[["alias"]]) ){
829 :     docs[["alias"]] <- class.name
830 :     }
831 :     if ( is.null(docs[["description"]]) ){
832 :     docs[["description"]] <- doc.link@description
833 :     }
834 :     invisible(docs)
835 :     }
836 : tdhock 105
837 : tdhock 109 apply.parsers <- function
838 :     ### Parse code to r objs, then run all the parsers and return the
839 :     ### documentation list.
840 : tdhock 105 (code,
841 :     ### Character vector of code lines.
842 : tdhock 109 parsers=default.parsers,
843 : tdhock 105 ### List of Parser Functions.
844 : tdhock 109 verbose=FALSE,
845 : tdhock 105 ### Echo names of Parser Functions?
846 :     ...
847 :     ### Additional arguments to pass to Parser Functions.
848 :     ){
849 :     e <- new.env()
850 : kmpont 212 ## KMP 2011-03-09 fix problem with DocLink when inlinedocs ran on itself
851 :     ## Error in assignClassDef(Class, classDef, where) :
852 :     ## Class "DocLink" has a locked definition in package "inlinedocs"
853 :     ## Traced to "where" argument in setClassDef which defaults to topenv()
854 :     ## which in turn is inlinedocs when processing inlinedocs package, hence
855 :     ## the clash. The following works (under R 2.12.2), so that the topenv()
856 :     ## now finds e before finding the inlinedocs environment.
857 : kmpont 213 old <- options(keep.source=TRUE,topLevelEnvironment=e)
858 : tdhock 109 on.exit(options(old))
859 : tdhock 110 exprs <- parse(text=code)
860 : tdhock 248 ## TDH 2011-04-07 set this so that no warnings about creating a fake
861 :     ## package when we try to process S4 classes defined in code
862 :     e$.packageName <- "inlinedocs.processor"
863 : tdhock 152 for (i in exprs){
864 : tdhock 248 ## TDH 2011-04-07 Disable this tryCatch since it makes it harder
865 :     ##to debug errors/warnings in the evaluated code
866 :    
867 :     ##tryCatch({
868 :     eval(i, e)
869 :     ##},error=function(e){
870 : tdhock 152 ##print(e)
871 : tdhock 248 ##})
872 : tdhock 152 }
873 : tdhock 105 objs <- sapply(ls(e),get,e,simplify=FALSE)
874 :    
875 :     docs <- list()
876 : phgrosjean 108
877 : tdhock 109 ## apply parsers in sequence to code and objs
878 : tdhock 105 for(i in seq_along(parsers)){
879 :     N <- names(parsers[i])
880 :     if(verbose){
881 :     if(is.character(N) && N!=""){
882 :     cat(N," ",sep="")
883 :     }else cat('. ')
884 :     }
885 :     p <- parsers[[i]]
886 :     ## This is the argument list that each parser receives:
887 : tdhock 200 L <- p(code=code,objs=objs,docs=docs,env=e,...)
888 : tdhock 105 docs <- combine(docs,L)
889 :     }
890 : tdhock 196 ## post-process to collapse all character vectors
891 :     for(i in seq_along(docs)){
892 :     for(j in seq_along(docs[[i]])){
893 : tdhock 198 if(names(docs[[i]])[j]!=".s3method")
894 : tdhock 196 docs[[i]][[j]] <- paste(docs[[i]][[j]],collapse="\n")
895 :     }
896 :     }
897 : tdhock 105 if(verbose)cat("\n")
898 :     docs
899 :     ### A list of extracted documentation from code.
900 :     }
901 : tdhock 109
902 : tdhock 138 ### Names of Parser Functions that operate on the desc arg.
903 :     descfile.names <- c("author.from.description","edit.package.file")
904 :    
905 :     ### Names of Parser Functions that do NOT use the desc arg.
906 :     non.descfile.names <-
907 :     names(default.parsers)[!names(default.parsers)%in%descfile.names]
908 :    
909 : tdhock 118 ### Parsers that operate only on R code, independently of the
910 :     ### description file.
911 : tdhock 138 nondesc.parsers <- default.parsers[non.descfile.names]
912 : tdhock 118
913 : tdhock 209 extract.docs.file <- structure(function
914 : tdhock 109 ### Apply all parsers relevant to extract info from just 1 code file.
915 :     (f,
916 :     ### File name of R code to read and parse.
917 : tdhock 203 parsers=NULL,
918 : tdhock 109 ### Parser Functions to use to parse the code and extract
919 :     ### documentation.
920 :     ...
921 :     ### Other arguments to pass to Parser Functions.
922 :     ){
923 : tdhock 203 if(is.null(parsers))parsers <- nondesc.parsers
924 : tdhock 109 apply.parsers(readLines(f),parsers,verbose=FALSE,...)
925 : tdhock 209 },ex=function(){
926 :     f <- system.file("silly","R","silly.R",package="inlinedocs")
927 : tdhock 248 extract.docs.file(f)
928 : tdhock 209 })
929 : tdhock 248

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