R/prettifyCLANG.R

In stla/prettifyAddins: 'RStudio' Addins to Prettify 'JavaScript', 'C++', 'Python', and More

#' Prettify C, C++, Java
#' @description Prettify some C, C++ or Java code.
#'
#' @param contents the code to be prettified; there are three possibilities for
#'   this argument:
#'   \code{NA} (default), to use the file currently opened in RStudio;
#'   the path to a file;
#'   or the code given as a character vector
#' @param language the language of the code; when the contents is read from a
#'   file, this option is ignored, because the language is obtained from the
#'   extension of the file
#' @param tabSize number of spaces of the indentation (usually \code{2} or
#'   \code{4});
#'   if \code{NULL} (the default), there are two possibilities:
#'   if the contents is read from the current file in RStudio, then the
#'   number of spaces will be the one you use in RStudio;
#'   otherwise it is set to \code{2}
#'
#' @return The pretty code in a character string.
#'
#' @note This function requires the command line utility \code{clang-format}.
#'
#' @importFrom rstudioapi isAvailable
#' @importFrom tools file_ext
#' @export
prettifyCLANG <- function(contents = NA, language = NA, tabSize = NULL){

  if(Sys.which("clang-format") == ""){
    stop(
      "This function requires `clang-format`. ",
      "Either it is not installed, or it is not found. ",
      "To reindent C/C++/Java code, you can use the 'Shiny Indent' addin."
    )
  }

  language <- tolower(language)

  if(!isNA(contents) && !isFile(contents)){
    if(is.na(language)){
      stop("Please specify the language of this code.")
    }
    if(!is.element(language, c("c", "c++", "cpp", "java"))){
      stop('The language must be one of "c", "c++", or "java".')
    }
    ext <- language
  }
  if(isNA(contents) && isAvailable()){
    context <- RStudioContext()
    ext <- tolower(file_ext(context[["path"]]))
    if(!is.element(ext, c("c", "cpp", "c++", "h", "hpp", "java"))){
      stop("Looks like this file is not a C/C++/Java file.")
    }
    if(is.null(tabSize)){
      tabSize <- RStudioTabSize()
    }
    contents <- context[["contents"]]
  }else if(isNA(contents)){
    stop("You have to provide something for the `contents` argument.")
    return(invisible())
  }else{
    if(is.null(tabSize)){
      if(isAvailable()){
        tabSize <- RStudioTabSize()
      }else{
        tabSize <- 2
      }
    }
    if(isFile(contents)){
      ext <- tolower(file_ext(contents))
      if(!is.element(ext, c("c", "cpp", "c++", "h", "hpp", "java"))){
        stop("Looks like this file is not a C/C++/Java file.")
      }
      contents <- suppressWarnings(readLines(contents))
    }
  }
  tmpDir <- tempdir()
  writeLines(.clangFormat(tabSize), file.path(tmpDir, ".clang-format"))
  tmpFile <- tempfile(fileext = paste0(".", ext))
  writeLines(contents, tmpFile)
  prettyCode <- suppressWarnings(system2(
    "clang-format", tmpFile,
    stdout = TRUE, stderr = TRUE
  ))
  if(!is.null(attr(prettyCode, "status"))){
    stop(
      "Something went wrong. ",
      "Probably the code is not valid."
    )
  }
  paste0(prettyCode, collapse = "\n")
}