sdcx 0.1.0

SDC (Synopsys Design Constraints) toolkit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

use anyhow::{bail, Context, Result};
use clap::{Parser, Subcommand};
use flate2::read::GzDecoder;
use flate2::write::GzEncoder;
use flate2::Compression;
use sdcx::errors::Report;
use sdcx::file_db::FileDb;
use std::fs::File;
use std::io::{BufReader, Read, Write};
use std::path::{Path, PathBuf};

// ---------------------------------------------------------------------------------------------------------------------
// Opt
// ---------------------------------------------------------------------------------------------------------------------

#[derive(Debug, Parser)]
struct Opt {
    #[clap(subcommand)]
    subcommand: SubCommands,
}

#[derive(Debug, Subcommand)]
enum SubCommands {
    /// Format input file
    Fmt {
        /// SDC file
        file: PathBuf,

        /// Output file
        #[arg(short, long)]
        output: Option<PathBuf>,
    },

    /// Check input file
    Check {
        /// SDC file
        file: PathBuf,

        /// Force SDC version
        #[arg(long)]
        force_version: Option<String>,
    },
}

// ---------------------------------------------------------------------------------------------------------------------
// Functions
// ---------------------------------------------------------------------------------------------------------------------

fn read_file(file: &Path) -> Result<String> {
    let file_name = file.display();
    let f = File::open(file).with_context(|| format!("could not open file: {file_name}"))?;
    let mut reader = BufReader::new(f);
    let mut s = String::new();

    if file.extension().map(|x| x.to_str()) == Some(Some("gz")) {
        let mut buf = vec![];
        reader
            .read_to_end(&mut buf)
            .with_context(|| format!("could not read file: {file_name}"))?;
        let mut gz = GzDecoder::new(&*buf);
        gz.read_to_string(&mut s)
            .with_context(|| format!("could not decode gzip file: {file_name}"))?;
    } else {
        reader
            .read_to_string(&mut s)
            .with_context(|| format!("could not read file: {file_name}"))?;
    }

    Ok(s)
}

fn write_file(file: &Path, text: &str) -> Result<()> {
    let file_name = file.display();
    let mut f = File::create(file).with_context(|| format!("could not open file: {file_name}"))?;

    if file.extension().map(|x| x.to_str()) == Some(Some("gz")) {
        let mut encoder = GzEncoder::new(&f, Compression::default());
        write!(encoder, "{}", text)
            .with_context(|| format!("could not write file: {file_name}"))?;
    } else {
        write!(f, "{}", text).with_context(|| format!("could not write file: {file_name}"))?;
    }

    f.flush()?;
    Ok(())
}

fn with_report<T, U: Report>(
    x: Result<T, U>,
    files: &FileDb<String, &str>,
    msg: &str,
) -> Result<T> {
    match x {
        Ok(x) => Ok(x),
        Err(x) => {
            x.report(files)?;
            bail!("{}", msg)
        }
    }
}

fn format(opt: &Opt) -> Result<()> {
    let SubCommands::Fmt {
        ref file,
        ref output,
    } = opt.subcommand
    else {
        return Ok(());
    };

    let s = read_file(file)?;

    let mut files = FileDb::new();
    files.add(file.display().to_string(), s.as_str());

    let mut sdc = with_report(
        sdcx::parser::Parser::parse(&s, &file),
        &files,
        &format!("could not parse file: {}", file.display()),
    )?;
    sdc.normalize();

    if let Some(output) = output {
        write_file(output, &format!("{}", sdc))?;
    } else {
        println!("{}", sdc);
    }
    Ok(())
}

fn check(opt: &Opt) -> Result<()> {
    let SubCommands::Check {
        ref file,
        ref force_version,
    } = opt.subcommand
    else {
        return Ok(());
    };

    let s = read_file(file)?;

    let mut files = FileDb::new();
    files.add(file.display().to_string(), s.as_str());

    let mut version = None;
    if let Some(force_version) = force_version {
        if let Ok(x) = force_version.as_str().try_into() {
            version = Some(x);
        } else {
            bail!("Unknown version: {force_version}")
        };
    }

    let sdc = with_report(
        sdcx::parser::Parser::parse(&s, &file),
        &files,
        &format!("could not parse file: {}", file.display()),
    )?;

    for err in sdc.validate(version) {
        err.report(&files)?;
    }

    Ok(())
}

// ---------------------------------------------------------------------------------------------------------------------
// Main
// ---------------------------------------------------------------------------------------------------------------------

fn main() -> Result<()> {
    let opt: Opt = Parser::parse();

    match opt.subcommand {
        SubCommands::Fmt { .. } => format(&opt)?,
        SubCommands::Check { .. } => check(&opt)?,
    }

    Ok(())
}