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 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
use std::path::PathBuf; use std::process::Output; use thiserror::Error; /// Define all the kinds of errors any part of this crate can return. #[derive(Debug, Error)] pub enum SubplotError { /// Subplot could not find a file named as a bindings file. #[error("binding file could not be found: {0}: {1}")] BindingsFileNotFound(PathBuf, std::io::Error), /// Subplot could not find a file named as a functions file. #[error("functions file could not be found: {0}: {1}")] FunctionsFileNotFound(PathBuf, std::io::Error), /// The simple pattern specifies a kind that is unknown. #[error("simple pattern kind {0} is unknown")] UnknownSimplePatternKind(String), /// The simple pattern and the type map disagree over the kind of a match #[error("simple pattern kind for {0} disagrees with the type map")] SimplePatternKindMismatch(String), /// The simple pattern contains a stray { or }. #[error("simple pattern contains a stray {{ or }}")] StrayBraceInSimplePattern(String), /// The simple pattern has regex metacharacters. /// /// Simple patterns are not permitted to have regex metacharacters in them /// unless the pattern is explicitly marked `regex: false` to indicate that /// the binding author understands what they're up to. #[error("simple pattern contains regex metacharacters: {0}")] SimplePatternHasMetaCharacters(String), /// Scenario step does not match a known binding /// /// This may be due to the binding missing entirely, or that the /// step or the binding has a typo, or that a pattern in the /// binding doesn't match what the author thinks it matches. #[error("do not understand binding: {0}")] BindingUnknown(String), /// Scenario step matches more than one binding /// /// THis may be due to bindings being too general, or having unusual /// overlaps in their matching #[error("more than one binding matches: {0}")] BindingNotUnique(String), /// A binding in the bindings file doesn't specify a known keyword. #[error("binding doesn't specify known keyword: {0}")] BindingWithoutKnownKeyword(String), /// A binding has more than one keyword (given/when/then). #[error("binding has more than one keyword (given/when/then)")] BindingHasManyKeywords(String), /// A binding lists an unknown type in its type map #[error("binding has unknown type/kind {0}")] UnknownTypeInBinding(String), /// Subplot tried to use a program, but couldn't feed it data /// /// Subplot uses some helper programs to implement some of its /// functionality, for example the GraphViz dot program. This /// error means that when tried to start a helper program and /// write to the helper's standard input stream, it failed to get /// the stream. /// /// This probably implies there's something wrong on your system. #[error("couldn't get stdin of child process to write to it")] ChildNoStdin, /// Subplot helper program failed /// /// Subplot uses some helper programs to implement some of its /// functionality, for example the GraphViz dot program. This /// error means that the helper program failed (exit code was not /// zero). /// /// This probably implies there's something wrong in Subplot. /// Please report this error to the Subplot project. #[error("child process failed: {0}")] ChildFailed(String), /// Binding doesn't define a function /// /// All binding must define the name of the function that /// implements the step. The bindings file has at least one /// binding that doesn't define one. To fix, add a `function:` /// field to the binding. #[error("binding does not name a function: {0}")] NoFunction(String), /// Document has no title /// /// The document YAML metadata does not define a document title. /// To fix, add a `title` field. #[error("document has no title")] NoTitle, /// Document has no template /// /// The document YAML metadata does not define the template to use /// during code generation. /// /// To fix, add a `template` field. #[error("document has no template")] MissingTemplate, /// Pandoc AST is not JSON /// /// Subplot acts as a Pandoc filter, and as part of that Pandoc /// constructs an _abstract syntax tree_ from the input document, /// and feeds it to the filter as JSON. However, when Subplot was /// parsing the AST, it wasn't JSON. /// /// This probably means there's something wrong with Pandoc, it's /// Rust bindings, or Subplot. #[error("Pandoc produce AST not in JSON")] NotJson, /// First scenario is before first heading /// /// Subplot scenarios are group by the input document's structure. /// Each scenario must be in a chapter, section, subsection, or /// other structural element with a heading. Subplot found a /// scenario block before the first heading in the document. /// /// To fix, add a heading or move the scenario after a heading. #[error("first scenario is before first heading")] ScenarioBeforeHeading, /// Step does not have a keyword. #[error("step has no keyword: {0}")] NoStepKeyword(String), /// Unknown scenario step keyword. /// /// Each scenario step must start with a known keyword (given, /// when, then, and, but), but Subplot didn't find one it /// recognized. /// /// This is usually due to a typing mistake or similar. #[error("unknown step keyword: {0}")] UnknownStepKind(String), /// Scenario step uses continuation keyword too early /// /// If a continuation keyword (`and` or `but`) is used too early /// in a scenario (i.e. before any other keyword was used) then /// it cannot be resolved to whichever keyword it should have been. #[error("continuation keyword used too early")] ContinuationTooEarly, /// Embedded file has the same name as another embedded file /// /// Names of embedded files must be unique in the input document, /// but Subplot found at least one with the same name as another. #[error("Duplicate embedded file name: {0}")] DuplicateEmbeddedFilename(String), /// Embedded file has more than one `add-newline` attribute /// /// The `add-newline` attribute can only be specified once for any given /// embedded file #[error("Embedded file {0} has more than one `add-newline` attribute")] RepeatedAddNewlineAttribute(String), /// Unrecognised `add-newline` attribute value on an embedded file /// /// The `add-newline` attribute can only take the values `auto`, `yes`, /// and `no`. #[error("Embedded file {0} has unrecognised `add-newline={}` - valid values are auto/yes/no")] UnrecognisedAddNewline(String, String), /// Couldn't determine base directory from input file name. /// /// Subplot needs to to determine the base directory for files /// referred to by the markdown input file (e.g., bindings and /// functions files). It failed to do that from the name of the /// input file. Something weird is happening. #[error("Could not determine base directory for included files from {0:?}")] BasedirError(PathBuf), /// Output goes into a directory that does not exist. /// /// Subplot needs to know in which directory it should write its /// output file, since it writes a temporary file first, then /// renames it to the final output file. The temporary file is /// created in the same directory as the final output file. /// However, Subplot could not find that directory. #[error("Output going to a directory that does not exist: {0}")] OutputDirectoryNotFound(String), /// The template.yaml is not in a directory. /// /// Template specifications reference files relative to the /// template.yaml file, but Subplot could not find the name of the /// directory containing the template.yaml file. Something is very /// weird. #[error("Couldn't find name of directory containing template spec: {0}")] NoTemplateSpecDirectory(PathBuf), /// A code template has an error. #[error("Couldn't load template {0}: {1}")] TemplateError(String, tera::Error), /// Unknown classes in use in document #[error("Unknown classes found in the document: {0}")] UnknownClasses(String), /// Template does not specify how to run generated program /// /// The template.yaml file used does not specify how to run the /// generated program, but user asked codegen to run it. #[error("template.yaml does not specify how to run generated program")] TemplateNoRun, /// An embedded file was not found. #[error("embedded file {0} was not found in the subplot document")] EmbeddedFileNotFound(String), /// When rendering a pikchr, something went wrong. #[error("failure rendering pikchr diagram: {0}")] PikchrRenderError(String), /// I/O error /// /// Subplot did some I/O, and it failed. This is a generic wrapper /// for any kind of I/O error. #[error(transparent)] IoError { /// The wrapped error. #[from] source: std::io::Error, }, /// Pandoc error /// /// Subplot got an error from Panoc. This is a generic wrapper for /// any kinds of Pandoc errors. #[error(transparent)] PandocError { /// The wrapped error. #[from] source: pandoc::PandocError, }, /// Regular expression error /// /// Subplot uses regular expressions. This is a generic wrapper for /// any kinds of errors related to that. #[error(transparent)] RegexError { /// The wrapped error. #[from] source: regex::Error, }, /// JSON error /// /// Subplot parses and generates JSON. This is a generic wrapper /// for any kinds of errors related to that. #[error(transparent)] JsonError { /// The wrapped error. #[from] source: serde_json::Error, }, /// YAML error /// /// Subplot parses YAML. This is a generic wrapper for any kinds /// of errors related to that. #[error(transparent)] YamlError { /// The wrapped error. #[from] source: serde_yaml::Error, }, } impl SubplotError { /// Construct a ChildFailed error. pub fn child_failed(msg: &str, output: &Output) -> SubplotError { let msg = format!( "{}: {}: {:?}", msg, output.status.code().unwrap_or(-1), String::from_utf8_lossy(&output.stderr) ); SubplotError::ChildFailed(msg) } } /// A result type for this crate. pub type Result<T> = std::result::Result<T, SubplotError>;