garando_syntax2 0.1.0

//! This module contains utilities for outputting metadata for diagnostic errors.
//!
//! Each set of errors is mapped to a metadata file by a name, which is
//! currently always a crate name.

use std::collections::BTreeMap;
use std::error::Error;
use std::fs::{create_dir_all, remove_file, File};
use std::path::PathBuf;

use crate::diagnostics::plugin::{ErrorInfo, ErrorMap};
use crate::ext::base::ExtCtxt;
use crate::syntax_pos::Span;

use serde::{Deserialize, Serialize};

// Default metadata directory to use for extended error JSON.
const ERROR_METADATA_PREFIX: &'static str = "tmp/extended-errors";

/// JSON encodable/decodable version of `ErrorInfo`.
#[derive(PartialEq, Deserialize, Serialize)]
pub struct ErrorMetadata {
    pub description: Option<String>,
    pub use_site: Option<ErrorLocation>,
}

/// Mapping from error codes to metadata that can be (de)serialized.
pub type ErrorMetadataMap = BTreeMap<String, ErrorMetadata>;

/// JSON encodable error location type with filename and line number.
#[derive(PartialEq, Deserialize, Serialize)]
pub struct ErrorLocation {
    pub filename: String,
    pub line: usize,
}

impl ErrorLocation {
    /// Create an error location from a span.
    pub fn from_span(ecx: &ExtCtxt, sp: Span) -> ErrorLocation {
        let loc = ecx.codemap().lookup_char_pos_adj(sp.lo);
        ErrorLocation {
            filename: loc.filename,
            line: loc.line,
        }
    }
}

/// Get the directory where metadata for a given `prefix` should be stored.
///
/// See `output_metadata`.
pub fn get_metadata_dir(prefix: &str) -> PathBuf {
    PathBuf::from(ERROR_METADATA_PREFIX).join(prefix)
}

/// Map `name` to a path in the given directory: <directory>/<name>.json
fn get_metadata_path(directory: PathBuf, name: &str) -> PathBuf {
    directory.join(format!("{}.json", name))
}

/// Write metadata for the errors in `err_map` to disk, to a file corresponding to `prefix/name`.
///
/// For our current purposes the prefix is the target architecture and the name is a crate name.
/// If an error occurs steps will be taken to ensure that no file is created.
pub fn output_metadata(
    ecx: &ExtCtxt,
    prefix: &str,
    name: &str,
    err_map: &ErrorMap,
) -> Result<(), Box<dyn Error>> {
    // Create the directory to place the file in.
    let metadata_dir = get_metadata_dir(prefix);
    create_dir_all(&metadata_dir)?;

    // Open the metadata file.
    let metadata_path = get_metadata_path(metadata_dir, name);
    let mut metadata_file = File::create(&metadata_path)?;

    // Construct a serializable map.
    let json_map = err_map
        .iter()
        .map(
            |(
                k,
                &ErrorInfo {
                    description,
                    use_site,
                },
            )| {
                let key = k.as_str().to_string();
                let value = ErrorMetadata {
                    description: description.map(|n| n.as_str().to_string()),
                    use_site: use_site.map(|sp| ErrorLocation::from_span(ecx, sp)),
                };
                (key, value)
            },
        )
        .collect::<ErrorMetadataMap>();

    // Write the data to the file, deleting it if the write fails.
    let result = serde_json::to_writer(&mut metadata_file, &json_map);
    if result.is_err() {
        remove_file(&metadata_path)?;
    }
    Ok(result?)
}