"normalize" messages, notably for translation, to use "character string"

git-svn-id: https://svn.r-project.org/R/trunk@87255 00db46b3-68df-0310-9c12-caf00c1e9a41

Author: maechler

doc/NEWS.Rd

@@ -110,6 +110,10 @@
       methods or class definitions are needed.  Consequently, previous
       workflows relying on the old behaviour will have to be amended by
       adding corresponding \code{library(p)} calls.
+
+      \item More R level messages use a common format containing
+      \code{"character string"} for more consistency and less translation
+      work.
     }
   }
 

src/library/base/R/RNG.R

@@ -1,7 +1,7 @@
 #  File src/library/base/R/RNG.R
 #  Part of the R package, https://www.R-project.org
 #
-#  Copyright (C) 1995-2019 The R Core Team
+#  Copyright (C) 1995-2022 The R Core Team
 #
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
@@ -33,7 +33,7 @@ RNGkind <- function(kind = NULL, normal.kind = NULL, sample.kind = NULL)
     do.set <- length(kind) > 0L
     if(do.set) {
 	if(!is.character(kind) || length(kind) > 1L)
-	    stop("'kind' must be a character string of length 1 (RNG to be used).")
+	    stop("'kind' must be a character string (RNG to be used).")
 	if(is.na(i.knd <- pmatch(kind, kinds) - 1L))
 	    stop(gettextf("'%s' is not a valid abbreviation of an RNG", kind),
                  domain = NA)
@@ -42,7 +42,8 @@ RNGkind <- function(kind = NULL, normal.kind = NULL, sample.kind = NULL)
 
     if(!is.null(normal.kind)) {
 	if(!is.character(normal.kind) || length(normal.kind) != 1L)
-	    stop("'normal.kind' must be a character string of length 1")
+	    stop(gettextf("'%s' must be a character string", "normal.kind"),
+		 domain = NA)
         normal.kind <- pmatch(normal.kind, n.kinds) - 1L
         if(is.na(normal.kind))
 	    stop(gettextf("'%s' is not a valid choice", normal.kind),
@@ -55,7 +56,8 @@ RNGkind <- function(kind = NULL, normal.kind = NULL, sample.kind = NULL)
 
     if(!is.null(sample.kind)) {
         if(!is.character(sample.kind) || length(sample.kind) != 1L)
-            stop("'sample.kind' must be a character string of length 1")
+	    stop(gettextf("'%s' must be a character string", "sample.kind"),
+		 domain = NA)
         sample.kind <- pmatch(sample.kind, s.kinds) - 1L
         if(is.na(sample.kind))
             stop(gettextf("'%s' is not a valid choice", sample.kind),
@@ -82,7 +84,7 @@ set.seed <- function(seed, kind = NULL, normal.kind = NULL, sample.kind = NULL)
     s.kinds <- c("Rounding", "Rejection", "default")
     if(length(kind) ) {
 	if(!is.character(kind) || length(kind) > 1L)
-	    stop("'kind' must be a character string of length 1 (RNG to be used).")
+	    stop("'kind' must be a character string (RNG to be used).")
 	if(is.na(i.knd <- pmatch(kind, kinds) - 1L))
 	    stop(gettextf("'%s' is not a valid abbreviation of an RNG", kind),
                  domain = NA)
@@ -91,7 +93,8 @@ set.seed <- function(seed, kind = NULL, normal.kind = NULL, sample.kind = NULL)
 
     if(!is.null(normal.kind)) {
 	if(!is.character(normal.kind) || length(normal.kind) != 1L)
-	    stop("'normal.kind' must be a character string of length 1")
+	    stop(gettextf("'%s' must be a character string", "normal.kind"),
+		 domain = NA)
         normal.kind <- pmatch(normal.kind, n.kinds) - 1L
         if(is.na(normal.kind))
 	    stop(gettextf("'%s' is not a valid choice", normal.kind),
@@ -103,7 +106,8 @@ set.seed <- function(seed, kind = NULL, normal.kind = NULL, sample.kind = NULL)
     }
     if(!is.null(sample.kind)) {
         if(!is.character(sample.kind) || length(sample.kind) != 1L)
-            stop("'sample.kind' must be a character string of length 1")
+	    stop(gettextf("'%s' must be a character string", "sample.kind"),
+		 domain = NA)
         sample.kind <- pmatch(sample.kind, s.kinds) - 1L
         if(is.na(sample.kind))
             stop(gettextf("'%s' is not a valid choice", sample.kind),

src/library/base/R/load.R

@@ -1,7 +1,7 @@
 #  File src/library/base/R/load.R
 #  Part of the R package, https://www.R-project.org
 #
-#  Copyright (C) 1995-2022 The R Core Team
+#  Copyright (C) 1995-2024 The R Core Team
 #
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
@@ -91,7 +91,7 @@ save <- function(..., list = character(),
         }
         if (is.character(file)) {
 	    if(!nzchar(file)) 
-                stop(gettextf("'%s' must be a non-empty string", "file"), domain = NA)
+                stop(gettextf("'%s' must be a non-empty character string", "file"), domain = NA)
 	    if(!is.character(compress)) {
 		if(!is.logical(compress))
 		    stop("'compress' must be logical or character")
@@ -130,7 +130,7 @@ save.image <- function (file = ".RData", version = NULL, ascii = FALSE,
                         compress = !ascii, safe = TRUE)
 {
     if (!is.character(file) || length(file) != 1 || file == "")
-        stop(gettextf("'%s' must be a non-empty string", "file"), domain = NA)
+        stop(gettextf("'%s' must be a non-empty character string", "file"), domain = NA)
     opts <- getOption("save.image.defaults")
     if(is.null(opts)) opts <- getOption("save.defaults")
 

src/library/base/R/serialize.R

@@ -1,7 +1,7 @@
 #  File src/library/base/R/serialize.R
 #  Part of the R package, https://www.R-project.org
 #
-#  Copyright (C) 1995-2023 The R Core Team
+#  Copyright (C) 1995-2024 The R Core Team
 #
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
@@ -22,7 +22,7 @@ saveRDS <-
 {
     if(is.character(file)) {
         if(length(file) != 1 || file == "")
-            stop(gettextf("'%s' must be a non-empty string", "file"), domain = NA)
+            stop(gettextf("'%s' must be a non-empty character string", "file"), domain = NA)
 	object <- object # do not create corrupt file if object does not exist
 	mode <- if(ascii %in% FALSE) "wb" else "w"
 	con <- if (is.logical(compress))

src/library/grDevices/R/postscript.R

@@ -1027,7 +1027,8 @@ embedFonts <- function(file, # The ps or pdf file to convert
 embedGlyphs <- function(file, glyphInfo, outfile = file,
                         options = character()) {
     if (!is.character(file) || length(file) != 1L || !nzchar(file))
-        stop("'file' must be a non-empty character string")
+        stop(gettextf("'%s' must be a non-empty character string", "file"),
+             domain = NA)
     infoList <- FALSE
     if (!inherits(glyphInfo, "RGlyphInfo")) {
         if (is.list(glyphInfo)) {

src/library/tools/R/utils.R

@@ -37,7 +37,7 @@ function(x)
     ## Turn a possibly relative file path absolute, performing tilde
     ## expansion if necessary.
     if(length(x) != 1L)
-        stop("'x' must be a single character string")
+        stop(gettextf("'%s' must be a character string", "x"), domain=NA)
     if(!file.exists(epath <- path.expand(x)))
         stop(gettextf("file '%s' does not exist", x),
              domain = NA)

src/library/utils/R/help.search.R

@@ -1,7 +1,7 @@
 #  File src/library/utils/R/help.search.R
 #  Part of the R package, https://www.R-project.org
 #
-#  Copyright (C) 1995-2022 The R Core Team
+#  Copyright (C) 1995-2024 The R Core Team
 #
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
@@ -121,36 +121,36 @@ function(pattern, fields = c("alias", "concept", "title"),
          types = getOption("help.search.types"))
 {
     ### Argument handling.
-    .wrong_args <- function(args)
-	gettextf("argument %s must be a character string", sQuote(args))
+    .wrong_arg <- function(arg)
+	gettextf("'%s' must be a character string", arg)
     if(is.logical(verbose)) verbose <- 2 * as.integer(verbose)
     fuzzy <- agrep
     if(!missing(pattern)) {
 	if(!is.character(pattern) || (length(pattern) > 1L))
-	    stop(.wrong_args("pattern"), domain = NA)
+	    stop(.wrong_arg("pattern"), domain = NA)
 	i <- pmatch(fields, hsearch_db_fields)
 	if(anyNA(i))
 	    stop("incorrect field specification")
 	else
 	    fields <- hsearch_db_fields[i]
     } else if(!missing(apropos)) {
 	if(!is.character(apropos) || (length(apropos) > 1L))
-	    stop(.wrong_args("apropos"), domain = NA)
+	    stop(.wrong_arg("apropos"), domain = NA)
 	else {
 	    pattern <- apropos
 	    fields <- c("alias", "title")
 	}
     } else if(!missing(keyword)) {
 	if(!is.character(keyword) || (length(keyword) > 1L))
-	    stop(.wrong_args("keyword"), domain = NA)
+	    stop(.wrong_arg("keyword"), domain = NA)
 	else {
 	    pattern <- keyword
 	    fields <- "keyword"
 	    if(is.null(fuzzy)) fuzzy <- FALSE
 	}
     } else if(!missing(whatis)) {
 	if(!is.character(whatis) || (length(whatis) > 1))
-	    stop(.wrong_args("whatis"), domain = NA)
+	    stop(.wrong_arg("whatis"), domain = NA)
 	else {
 	    pattern <- whatis
 	    fields <- "alias"

src/library/utils/R/packages.R

@@ -25,7 +25,7 @@ function(contriburl = contrib.url(repos, type), method,
          quiet = TRUE, ...)
 {
     if (!is.character(type))
-        stop("invalid 'type'; must be a character string")
+        stop(gettextf("'%s' must be a character string", "type"), domain = NA)
     requiredFields <-
         c(tools:::.get_standard_repository_db_fields(), "File")
     if (is.null(fields))
@@ -364,7 +364,7 @@ update.packages <- function(lib.loc = NULL, repos = getOption("repos"),
                             checkBuilt = FALSE, type = getOption("pkgType"))
 {
     if (!is.character(type))
-        stop("invalid 'type'; must be a character string")
+        stop(gettextf("'%s' must be a character string", "type"), domain = NA)
     force(ask)  # just a check that it is valid before we start work
     text.select <- function(old)
     {
@@ -473,7 +473,7 @@ old.packages <- function(lib.loc = NULL, repos = getOption("repos"),
                          ..., type = getOption("pkgType"))
 {
     if (!is.character(type))
-        stop("invalid 'type'; must be a character string")
+        stop(gettextf("'%s' must be a character string", "type"), domain = NA)
     if(is.null(lib.loc))
         lib.loc <- .libPaths()
     if(!missing(instPkgs)) {
@@ -525,7 +525,7 @@ new.packages <- function(lib.loc = NULL, repos = getOption("repos"),
                          ..., type = getOption("pkgType"))
 {
     if (!is.character(type))
-        stop("invalid 'type'; must be a character string")
+        stop(gettextf("'%s' must be a character string", "type"), domain = NA)
     ask  # just a check that it is valid before we start work
     if(type == "both" && (!missing(contriburl) || !is.null(available))) {
         stop("specifying 'contriburl' or 'available' requires a single type, not type = \"both\"")
@@ -738,7 +738,7 @@ download.packages <- function(pkgs, destdir, available = NULL,
                               method, type = getOption("pkgType"), ...)
 {
     if (!is.character(type))
-        stop("invalid 'type'; must be a character string")
+        stop(gettextf("'%s' must be a character string", "type"), domain = NA)
     nonlocalcran <- !all(startsWith(contriburl, "file:"))
     if(nonlocalcran && !dir.exists(destdir))
         stop("'destdir' is not a directory")
@@ -858,7 +858,7 @@ resolvePkgType <- function(type) {
 contrib.url <- function(repos, type = getOption("pkgType"))
 {
     if (!is.character(type))
-        stop("invalid 'type'; must be a character string")
+        stop(gettextf("'%s' must be a character string", "type"), domain = NA)
     type <- resolvePkgType(type)
     if(is.null(repos)) return(NULL)
     if(!length(repos)) return(character())