R/rk.XML.embed.R

In rkward-community/rkwarddev: A Collection of Tools for RKWard Plugin Development

# Copyright 2010-2014 Meik Michalke <meik.michalke@hhu.de>
#
# This file is part of the R package rkwarddev.
#
# rkwarddev is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# rkwarddev is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with rkwarddev.  If not, see <http://www.gnu.org/licenses/>.


#' Create XML node "embed" for RKWard plugins
#'
#' @param component Either a character string, registered name (\code{id} in pluginmap file) of the component to be embedded,
#'    or an object of class \code{\link[rkwarddev:rk.plug.comp-class]{rk.plug.comp}}, whose name will be used.
#' @param button Logical, whether the plugin should be embedded as a button and appear if it's pressed.
#' @param label A character string, text label for the button (only used if \code{button=TRUE}).
#' @param namespace An optional character string, XiMpLe node \code{<about>} or XiMpLe doc of doctype "rkpluginmap",
#'    to prefix the given \code{component} with the respective namespace (\code{"namespace::component"}).
#' @param id.name Character string, a unique ID for this plugin element.
#'    If \code{"auto"}, an ID will be generated automatically from the label and component strings.
#' @param i18n Either a character string or a named list with the optional elements \code{context}
#'    or \code{comment}, to give some \code{i18n_context} information for this node. If set to \code{FALSE},
#'    the attribute \code{label} will be renamed into \code{noi18n_label}.
#' @return An object of class \code{XiMpLe.node}.
#' @export
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @examples
#' test.embed <- rk.XML.embed("someComponent")
#' cat(pasteXML(test.embed))

rk.XML.embed <- function(component, button=FALSE, label="Options", namespace=NULL, id.name="auto", i18n=NULL){
  # namespace sources:
  # - <about>
  # - <pluginmap>
  if(!is.null(namespace)){
    throwError <- FALSE
    if(is.XiMpLe.node(namespace)){
      if(identical(XMLName(namespace), "about")){
        namespace <- XMLAttrs(namespace)[["name"]]
        # clean namespace
        namespace <- gsub("[^[:alnum:]_]*", "", namespace)
      } else {
        throwError <- TRUE
      }
    } else if(is.XiMpLe.doc(namespace)){
      if(identical(XMLDTD(namespace)[["doctype"]], "rkpluginmap")){
        namespace <- XMLAttrs(node(namespace, node="document"))[["namespace"]]
      } else {
        throwError <- TRUE
      }
    } else if(is.character(namespace)){
      # clean namespace
      namespace <- gsub("[^[:alnum:]_]*", "", namespace)
    } else {
      throwError <- TRUE
    }
    if(isTRUE(throwError)){
      stop(simpleError("\"namespace\" must be a character string, a XiMpLe.node <about>, or a XiMpLe.doc <pluginmap>!")) 
    } else {}
    namespace <- paste0(namespace, "::")
  } else {}

  # check the component
  if(inherits(component, "rk.plug.comp")){
    component <- slot(component, "name")
  } else if(is.character(component)){
    component <- gsub("[^[:alnum:]_]*", "", component)
  } else {
    stop(simpleError("\"component\" must be a character string or an object of class \"rk.plug.comp\"!"))
  }
  attr.list <- list(component=paste0(namespace, component))

  if(isTRUE(button)){
    attr.list[["as_button"]] <- "true"
  } else {}
  
  if(!identical(label, "Options") && isTRUE(button)){
    attr.list[["label"]] <- label
  } else {}

  if(identical(id.name, "auto")){
    attr.list[["id"]] <- auto.ids(paste0(label, component), prefix=ID.prefix("embed"))
  } else {
    attr.list[["id"]] <- id.name
  }

  # check for additional i18n info; if FALSE, "label" will be renamed to "noi18n_label"
  attr.list <- check.i18n(i18n=i18n, attrs=attr.list)
  
  node <- check.i18n(i18n=i18n, node=XMLNode("embed", attrs=attr.list), comment=TRUE)

  return(node)
}