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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
|
###########################################################################/**
# @RdocClass Settings
#
# @title "Class for applicational settings"
#
# \description{
# @classhierarchy
#
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{basename}{A @character string of the basename of the settings file.}
# \item{...}{Arguments passed to constructor of superclass \link{Options}.}
# }
#
# \section{Fields and Methods}{
# @allmethods
# }
#
# \section{Load settings with package and save on exit}{
# Here is a generic \code{.First.lib()} function for loading settings
# with package. It also (almost) assures that the package is detached
# when R finishes. See @see "onSessionExit" why it is not guaranteed!
#
# The almost generic \code{.Last.lib()} function, which will prompt
# user to save settings, is called when a package is detached.
#
# It is custom to put these functions in a file named \code{zzz.R}.
#
# \bold{.First.lib():}
# \preformatted{
# .First.lib <- function(libname, pkgname) {
# # Write a welcome message when package is loaded
# pkg <- Package(pkgname);
# assign(pkgname, pkg, pos=getPosition(pkg));
#
# # Read settings file ".<pkgname>Settings" and store it in package
# # variable '<pkgname>Settings'.
# varname <- paste(pkgname, "Settings");
# basename <- paste(".", varname, sep="");
# settings <- Settings$loadAnywhere(basename, verbose=TRUE);
# if (is.null(settings))
# settings <- Settings(basename);
# assign(varname, settings, pos=getPosition(pkg));
#
# # Detach package when R finishes, which will save package settings too.
# onSessionExit(function(...) detachPackage(pkgname));
#
# packageStartupMessage(getName(pkg), " v", getVersion(pkg),
# " (", getDate(pkg), ") successfully loaded. See ?", pkgname,
# " for help.\n", sep="");
# } # .First.lib()
# }
#
# \bold{.Last.lib():}
# \preformatted{
# .Last.lib <- function(libpath) {
# pkgname <- "<package name>";
#
# # Prompt and save package settings when package is detached.
# varname <- paste(pkgname, "Settings", sep="");
# if (exists(varname)) {
# settings <- get(varname);
# if (inherits(settings, "Settings"))
# promptAndSave(settings);
# }
# } # .Last.lib()
# }
# }
#
# @examples "../incl/Settings.Rex"
#
# @author
#
# @keyword programming
# @keyword IO
#*/###########################################################################
setConstructorS3("Settings", function(basename=NULL, ...) {
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Validate arguments
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Argument 'basename':
if (!is.null(basename)) {
basename <- as.character(basename);
}
extend(Options(...), "Settings",
.basename = basename,
.loadedPathname = NULL
)
})
###########################################################################/**
# @RdocMethod getLoadedPathname
#
# @title "Gets the pathname of the settings file loaded"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{...}{Not used.}
# }
#
# \value{
# Returns the absolute pathname (@character string) of the settings file
# loaded. If no file was read, @NULL is returned.
# }
#
# @author
#
# \seealso{
# @seeclass
# }
#
# @keyword programming
#*/###########################################################################
setMethodS3("getLoadedPathname", "Settings", function(this, ...) {
this$.loadedPathname;
})
###########################################################################/**
# @RdocMethod isModified
#
# @title "Checks if settings has been modified compared to whats on file"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{...}{Not used.}
# }
#
# \value{
# Returns @TRUE if settings have been modified since lasted loaded, or if
# they never have been loaded. Otherwise @FALSE is returned.
# }
#
# @author
#
# \seealso{
# @seeclass
# }
#
# @keyword programming
#*/###########################################################################
setMethodS3("isModified", "Settings", function(this, ...) {
file <- getLoadedPathname(this);
if (is.null(file))
return(FALSE);
settingsOnFile <- Settings$load(file);
!equals(this, settingsOnFile);
})
###########################################################################/**
# @RdocMethod findSettings
#
# @title "Searches for the settings file in one or several directories"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{basename}{A @character string of the basename of the settings file.}
# \item{paths}{A @vector of @character string specifying the directories to
# be searched.}
# \item{...}{Not used.}
# }
#
# \value{
# Returns the absolute pathname (@character string) of the first settings
# file found, otherwise @NULL.
# }
#
# @author
#
# \seealso{
# @seeclass
# }
#
# @keyword programming
#*/###########################################################################
setMethodS3("findSettings", "Settings", function(static, basename, paths=c(".", "~"), ...) {
# Search for the settings file
for (path in paths) {
pathname <- filePath(path, basename);
if (file.exists(pathname))
return(pathname);
}
return(NULL);
}, static=TRUE)
#########################################################################/**
# @RdocMethod saveAnywhere
#
# @title "Saves settings to file"
#
# \description{
# @get "title". If the settings was read from file, they are by default
# written back to the same file. If this was not the case, it defaults
# to the settings file in the home directory of the current user.
# }
#
# @synopsis
#
# \arguments{
# \item{file}{A @character string or a @connection where to write too.
# If @NULL, the file from which the settings were read is used. If
# this was not the case, argument \code{path} is used.}
# \item{path}{The default path, if no settings files are specified.
# This defaults to the current user's home directory.}
# \item{...}{Arguments passed to
# \code{\link[R.oo:save.Object]{save}()} in superclass Object.}
# }
#
# \value{
# Returns (invisibly) the pathname to the save settings file.
# }
#
# @author
#
# \seealso{
# @seemethod "loadAnywhere".
# @seeclass
# }
#
# @keyword programming
#*/#########################################################################
setMethodS3("saveAnywhere", "Settings", function(this, file=NULL, path="~", ...) {
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Validate arguments
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Argument 'path':
path <- as.character(path);
if (!isDirectory(path))
throw("Argument 'path' is not a directory: ", path);
# Get file location
if (is.null(file))
file <- this$.loadedPathname;
if (is.null(file))
file <- filePath(path, this$.basename);
# Save Object
save(this, file=file, ...);
invisible(file);
})
#########################################################################/**
# @RdocMethod loadAnywhere
#
# @title "Loads settings from file"
#
# \description{
# @get "title". If the settings was read from file, they are by default
# written back to the same file. If this was not the case, it defaults
# to the settings file in the home directory of the current user.
# }
#
# @synopsis
#
# \arguments{
# \item{file}{A @character string or a @connection from which settings
# should be read. If @NULL, the settings file is searched for by
# @seemethod "findSettings".}
# \item{...}{Arguments passed to @seemethod "findSettings".}
# \item{verbose}{If @TRUE, verbose information is written while reading,
# otherwise not.}
# }
#
# \value{Returns a \link{Settings} object if file was successfully read,
# otherwise @NULL.}
#
# @author
#
# \seealso{
# @seemethod "saveAnywhere".
# @seeclass
# }
#
# @keyword programming
#*/#########################################################################
setMethodS3("loadAnywhere", "Settings", function(static, file=NULL, ..., verbose=FALSE) {
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Validate arguments
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Argument 'file':
if (is.null(file)) {
file <- static$.basename;
}
if (inherits(file, "connection")) {
} else {
file <- as.character(file);
if (!file.exists(file)) {
file <- findSettings(static, basename=file, ...);
if (is.null(file))
return(NULL);
}
}
settings <- NULL;
tryCatch({
settings <- Settings$load(file=file);
settings$.loadedPathname <- getAbsolutePath(file);
if (verbose) {
message("Loaded settings: ", file, " (",
format(lastModified(file), "%Y-%m-%d %H:%M:%S"), ")");
}
}, error = function(ex) {
if (verbose)
message("Failed to load settings: ", file);
})
settings;
})
#########################################################################/**
# @RdocMethod promptAndSave
#
# @title "Prompt user to save modified settings"
#
# \description{
# @get "title".
# }
#
# @synopsis
#
# \arguments{
# \item{saveOption}{A @character string of the option used to set
# if user is prompted or not.}
# \item{...}{Arguments passed to @see "saveAnywhere".}
# }
#
# \value{
# Returns @TRUE if settings were successfully written to file,
# otherwise @FALSE is returned. An exception may also be thrown.
# }
#
# \details{
# If settings has been modified since loaded, the user is by default
# prompted to save the settings (if \R runs interactively).
# To save or not save without asking or when \R runs non-interactively,
# set option \code{"saveSettings"} to "yes" or "no", respectively.
# For prompting the user, use "prompt".
# }
#
# @author
#
# \seealso{
# @seemethod "isModified".
# @see "base::interactive".
# @seeclass
# }
#
# @keyword programming
#*/#########################################################################
setMethodS3("promptAndSave", "Settings", function(this, saveOption="saveSettings", settingsName=NULL, ...) {
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Validate arguments
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Argument 'saveOption':
saveOption <- as.character(saveOption);
if (length(saveOption) != 1) {
throw("Argument 'saveOption' should be a single character string: ",
paste(saveOption, collapse=", "));
}
# Check if settings have been updated since last read.
if (!isModified(this))
return(invisible(FALSE));
answer <- getOption(this, saveOption, "prompt");
if (answer == "prompt" && interactive()) {
# Prompt user...
msg <- "Do you wish to save modified";
if (!is.null(settingsName))
msg <- paste(msg, settingsName);
msg <- paste(msg, "settings?");
msg <- paste(msg, "[y/N]: ");
answer <- readline(msg);
answer <- tolower(answer);
neverAskAgain <- (regexpr("!$", answer) != -1);
if (neverAskAgain) {
answer <- gsub("!$", "", answer);
if (answer %in% c("y", "yes")) {
answer <- "yes";
} else {
answer <- "no";
}
setOption(this, saveOption, answer);
}
}
if (answer %in% c("y", "yes")) {
saveAnywhere(this, ...);
invisible(TRUE);
} else {
invisible(FALSE);
}
})
############################################################################
# HISTORY:
# 2013-04-18
# o Now the verbose output of loadAnywhere() for Settings is sent
# to standard error (was standard output).
# 2006-02-22
# o saveAnywhere() now returns the pathname where the settings were saved.
# o Rdoc: Fixed a missing link in saveAnywhere().
# 2005-10-20
# o Update loadAnywhere() so that it works on objects too for which the
# default basename is the static basename.
# 2005-06-11
# o Added last modified date in loading message.
# 2005-06-01
# o Added isModified().
# o Added Rdoc comments.
# 2005-05-31
# o Created.
############################################################################
|