1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
parse_pairlist <- function(x){
is.missing.arg <- function(arg) typeof(arg) == "symbol" && deparse(arg) == ""
# x == NULL corresponds to functions with no arguments (also
# length(NULL) is 0) also, NULL is a pairlist with length 0.
# Is this function used with x other than pairlist?
if(is.null(x) || length(x) == 0) # If not, the test of length(x) is redundant.
return(list(argnames = character(0), defaults = character(0)))
nonmis <- x[ !sapply(x, is.missing.arg) ]
wrk <- character(length(nonmis))
names(wrk) <- names(nonmis)
for(s in names(nonmis)){
wrk[[s]] <- paste(deparse(nonmis[[s]], backtick = TRUE, width.cutoff = 500L)
, collapse = "\n")
}
list(argnames = names(x), defaults = wrk )
}
# 2012-10-03 new arg. infix
pairlist2f_usage1 <- function(x, name, S3class = "", S4sig = "", infix = FALSE, fu = TRUE){
structure(c(list(name=name, S3class=S3class, S4sig=S4sig, infix=infix, fu = fu),
parse_pairlist(x)), class="f_usage")
}
print.f_usage <- function(x, ...){
tab <- max(nchar(names(x)))
for(nam in names(x)){
if(is.null(nam))
next
if(nam != "defaults")
cat(nam, strrep(" ", tab - nchar(nam)), "=", x[[nam]], "\n")
else{
defnams <- names(x$defaults)
for(i in seq_along(defnams)){
if(i == 1)
cat(nam, strrep(" ", tab - nchar(nam[i])), ":", defnams[i], "=", x$defaults[i], "\n")
else
cat(strrep(" ", tab + 3), defnams[i] , "=", x$defaults[i], "\n")
}
}
}
cat("\n")
}
format_funusage <- function(x, name = "", width = 72, realname){
res <- paste(name, "(", paste(x, collapse = ", "), ")", sep="")
if(is.numeric(width) && nchar(res, type="width") > width){
delim <- c("(", rep(", ", length(x) - 1), ")")
wrk <- paste(c(name, x), delim, sep="")
lens <- nchar(wrk, type="width")
if(!missing(realname))
lens[1] <- nchar(realname, type="width") + 1
indent <- paste(rep(" ", lens[1]), collapse="")
res <- character(0)
curlen <- 0
for(i in seq_along(wrk)){
if(curlen + lens[i] > width){
res <- paste(res, "\n", indent, sep="")
curlen <- lens[1] # = number of chars in `indent'
}
res <- paste(res, wrk[i], sep="")
curlen <- curlen + lens[i]
}
}
res
}
deparse_usage1 <- function(x, width = 72){
if(!x$fu) # a variable, not function
return( structure( x$name, names = x$name ) )
# todo: maybe x$name tryabva da e character, as.character here should not be needed.
if(as.character(x$name) %in% c("[","[[", "$", "@", "[<-", "[[<-", "$<-", "@<-", "!"))
"dummy"
else if(x$infix){ # infix operator
if(grepl(".+<-$", x$name)){ # name end is "<-" but is not equal to it
name2 <- sub("^(.+)<-$", "\\1", x$name)
m <- length(x$argnames)
res <- paste(name2, "(", paste(x$argnames[-m], collapse=", "), ")",
"<-", x$argnames[m])
}else # todo: make sure that the name is not in quotes!
res <- paste(x$argnames, collapse = paste0(" ", x$name, " "))
return(res)
}
res <- x$argnames
names(res) <- x$argnames
nams <- names(x$defaults)
res[nams] <- paste(res[nams], "=", x$defaults)
assop <- grepl(".+<-$", x$name) # name end is "<-" but is not equal to it
name <- x$name
if(assop){
name <- sub("<-$", "", x$name)
value <- res[length(res)]
res <- res[-length(res)]
}
res <- if(!identical(x$S3class, ""))
format_funusage(res, paste("\\method{", name, "}{", x$S3class, "}", sep=""),
realname = name )
else if(!identical(x$S4sig, ""))
format_funusage(res, paste("\\S4method{", name, "}{",
paste0(x$S4sig, collapse = ", "),
"}", sep=""), realname = name )
else
switch(name,
"$" =, "@" = paste0(res[1], name, res[2]),
"[" =, "[[" = paste0(res[1], name, paste0(res[-1], collapse = ", "),
.closeOp[name]),
"!" = paste0("!", res[1]),
## default
format_funusage(res, name)
)
if(assop) # if assignment, add to the last line, usually the only one
res[length(res)] <- paste0(res[length(res)], " <- ", value)
# "[<-" = paste0(res[1], "[", paste0(res[c(-1,-length(res))],
# collapse = ", "), "]", " <- ", res[length(res)]),
# "[[<-" = paste0(res[1], "[[", paste0(res[c(-1,-length(res))],
# collapse = ", "), "]]", " <- ", res[length(res)]),
# "$<-" = paste0(res[1], "$", res[2], " <- ", res[3]),
# "@<-" = paste0(res[1], "@", res[2], " <- ", res[3]),
res <- gsub("...", "\\dots", res, fixed=TRUE)
structure( paste(res, collapse = ""), names=x$name )
}
as.character.f_usage <- function(x,...){
deparse_usage1(x)
}
deparse_usage <- function (x){
if(inherits(x, "f_usage"))
return(deparse_usage1(x))
nams <- names(x)
if(!is.null(nams)) # remove names since sapply merges them with the names of
names(x) <- NULL # the list obtained by lapply()
res <- sapply(x, deparse_usage1)
if(is.null(names(res))) # in most cases names(res) will be the same as nams
names(res) <- nams # but give preference to the ones returned by
# deparse_usage1 which takes names from the objects.
# This `if' will hardly ever kick in...
res
}
.closeOp <- list("[" = "]", "[[" = "]]", "(" = ")", "{" = "}")
|
