R/table-tools.R

In Abhi-1U/TexoR: Converting 'LaTeX' 'R Journal' Articles into 'RJ-web-articles'

#' @title patch table environment
#' @description
#' function to modify env and commands in TeX using GNU sed
#'
#'These are due to the pandoc's limitations and ease in conversion.
#'
#' @details
#' changes are made to :
#' 1. table* environment to table environment
#' 2. \\multicolumn to \\multicolumnx
#' \\multicolumnx is redefined in Metafix.sty as
#' \\renewcommand\{\\multicolumnx\}[3]\{\\multicolumn\{#1\}\{c\}\{#3\}\}
#' @param article_dir path to the directory which contains tex article
#'
#' @return patches table environments in LaTeX file and also backs up the old file before modification
#' @export
#'
#' @examples
#' article_dir <- system.file("examples/article",
#'                  package = "texor")
#' dir.create(your_article_folder <- file.path(tempdir(), "tempdir"))
#' x <- file.copy(from = article_dir, to = your_article_folder,recursive = TRUE,)
#' your_article_path <- paste(your_article_folder,"article",sep="/")
#' texor::patch_table_env(your_article_path)
#' unlink(your_article_folder,recursive = TRUE)
patch_table_env <- function(article_dir) {
    article_dir <- xfun::normalize_path(article_dir)
    file_name <- get_texfile_name(article_dir)
    if (check_sub_sec_files(article_dir)) {
        ## include sub files
        file_paths <- get_sub_sec_files(article_dir)
        ## include original file
        append(file_paths, texor::get_texfile_name(article_dir))
    }
    else {
        ## include only original file
        file_paths <- file_name
    }
    for (file_path in file_paths) {
        file_path <- paste(article_dir, file_path, sep = "/")
        if (file.exists(file_path)) {
            raw_lines <- readLines(file_path)
        }
        else {
            message("LaTeX file not found !")
            return(FALSE)
        }
        raw_lines <- stream_editor(raw_lines,
                               "\\s*\\\\begin\\{table\\*\\}", "table\\*", "table")
        message("Changed \\begin{table\\*} to \\begin{table}")
        raw_lines <- stream_editor(raw_lines,
                               "\\s*\\\\end\\{table\\*\\}", "table\\*", "table")
        message("Changed \\end{table*} to \\end{table}")
        raw_lines <- stream_editor(raw_lines,
                               "\\s*\\\\multicolumn\\{", "multicolumn", "multicolumnx")
        message("changed \\multicolumn to \\multicolumnx")
        raw_lines <- stream_editor(raw_lines,
                                   "\\s*\\\\begin\\{widetable\\}", "widetable", "table")
        message("Changed \\begin{widetable} to \\begin{table}")
        raw_lines <- stream_editor(raw_lines,
                                   "\\s*\\\\end\\{widetable\\}", "widetable", "table")
        message("Changed \\end{widetable} to \\end{table}")
        # backup old file
        if (file.exists(file_path)) {
        src_file_data <- readLines(file_path)
        }
        else {
            message("LaTeX file not found !")
            return(FALSE)
        }
        backup_file <- paste(file_path, ".bk", sep = "")
        write_external_file(backup_file, "w", src_file_data)
        #remove old tex file
        file.remove(file_path)
        # write same tex file with new data
        write_external_file(file_path, "w", raw_lines)
    }

    patch_table_label(article_dir)
}

patch_table_label <- function(article_dir) {
    # To better handle from latex_to_web and rnw_to_rmd, it offer two type of inputs
    file_paths <- c()
    article_dir <- xfun::normalize_path(article_dir)
    file_name <- get_texfile_name(article_dir)
    if (check_sub_sec_files(article_dir)) {
        ## include sub files
        file_paths <- get_sub_sec_files(article_dir)
        ## include original file
        append(file_paths, texor::get_texfile_name(article_dir))
    }
    else {
        ## include only original file
        file_paths <- file_name
    }

    for (file_path in file_paths) {
        file_path <- paste(article_dir, file_path, sep = "/")
        if (file.exists(file_path)) {
            raw_lines <- readLines(file_path)
        }
        else {
            message("LaTeX file not found !")
            return(FALSE)
        }

        modified_content <- list()
        label_found <- FALSE
        table_env <- FALSE
        table_count <- 0
        for (line in raw_lines) {
            if (grepl("^\\\\begin\\{(table|longtable|widetable)\\}", line)) {
                table_env <- TRUE
                label_found <- FALSE
                table_count <- table_count + 1
            }

            if (table_env) {
                if (!is_comment_line(line) && grepl("\\\\label\\{", line)) {
                    label_found <- TRUE
                }
            }

            if (grepl("^\\\\end\\{(table|longtable|widetable)\\}", line)) {
                if (!label_found) {
                    modified_content <- c(modified_content, paste0("\\label{tab:T", as.character(table_count), "}"))
                }
                table_env <- FALSE
                label_found <- FALSE
            }
            modified_content <- c(modified_content, line)
        }
        message("Auto add label for table env")
        modified_content <- unlist(modified_content, use.names = FALSE)
        xfun::write_utf8(modified_content, file_path)
    }
}

is_comment_line <- function(line) {
    if (grepl("^\\s*%", line)) {
        return(TRUE)
    }
    else {
        return(FALSE)
    }
}

patch_table_numbering <- function(article_dir) {
    # To better handle from latex_to_web and rnw_to_rmd, it offer two type of inputs
    article_dir <- xfun::normalize_path(article_dir)
    file_name <- get_md_file_name(article_dir)
    file_path <- paste(article_dir, file_name, sep = "/")
    if (file.exists(file_path)) {
        raw_lines <- readLines(file_path)
    }
    else {
        message("markdown file not found !")
        return(FALSE)
    }

    modified_content <- list()
    for (line in raw_lines) {
        if (grepl("\\(\\\\\\\\#tab:", line)) {
            line <- gsub("\\(\\\\\\\\#tab:","\\(\\\\#tab:",line)
            modified_content <- c(modified_content, line)
        }
        if (grepl("\\(\\\\\\\\\\\\\\\\#tab:", line)) {
            line <- gsub("\\(\\\\\\\\\\\\\\\\#tab:","\\(\\#tab:",line)
            modified_content <- c(modified_content, line)
        }
        else{
        modified_content <- c(modified_content, line)
        }
    }
        modified_content <- unlist(modified_content, use.names = FALSE)
        xfun::write_utf8(modified_content, file_path)
}