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

//! Defines generator related code for languages.

pub mod generator;

use crate::model;
use std::ffi::OsString;
use std::io;
use std::path::Path;
use num_bigint::BigUint;
use std::marker::PhantomData;

/// Error that could occur during generation.
#[derive(Debug)]
pub enum GeneratorError {
	IOError(io::Error),
	UnknownLanguage(String),
	InvalidOptions(String),
	UnmappedPackage(model::PackageName),
	CouldNotFind(model::QualifiedName),
	CouldNotFindVersion(model::QualifiedName, BigUint),
	CouldNotResolveTypeParameter(String),
	TypeCannotBeSequence(model::QualifiedName),
	TypeDoesNotHaveCase(model::QualifiedName, Option<BigUint>, String),
	IncorrectCaseArity(model::QualifiedName, String),
	RecordLiteralNotForStruct,
	ExternTypeDoesNotHaveRecordLiteral(model::QualifiedName),
	CouldNotFindRecordField(model::QualifiedName, Option<BigUint>, String),
	CouldNotGenerateType,
	InvalidTypeForConstant,
	InvalidTypeForCodec,
}

impl From<io::Error> for GeneratorError {
	fn from(err: io::Error) -> Self {
		GeneratorError::IOError(err)
	}
}

/// Outputs files produced by the generator.
/// 
/// Allows for capturing the output without writing directly to the file system.
pub trait OutputHandler<'state> {
	type FileHandle : io::Write;
	fn create_file<P: AsRef<Path>>(&'state mut self, path: P) -> Result<Self::FileHandle, GeneratorError>;
}

/// Defines a language supported by Verilization.
pub trait Language {

	/// An intermediate step for the language options.
	type OptionsBuilder;

	/// Finalized options.
	type Options;

	/// Gets the name of the language.
	fn name() -> &'static str;

	/// Gets an option builder with no options set.
	fn empty_options() -> Self::OptionsBuilder;

	/// Sets an option.
	fn add_option(builder: &mut Self::OptionsBuilder, name: &str, value: OsString) -> Result<(), GeneratorError>;

	/// Ensures that any required options have been set and finalizes the options.
	fn finalize_options(builder: Self::OptionsBuilder) -> Result<Self::Options, GeneratorError>;
	
	/// Generates serialization code for the language.
	fn generate<Output: for<'output> OutputHandler<'output>>(model: &model::Verilization, options: Self::Options, output: &mut Output) -> Result<(), GeneratorError>;

}

pub trait LanguageHandler {
	type Result;
	fn run<Lang: Language>(&mut self) -> Self::Result;
}

pub trait LanguageRegistry : Sized {
	fn has_language(&self, lang_name: &str) -> bool;
	fn handle_language<Handler: LanguageHandler>(&self, lang_name: &str, handler: &mut Handler) -> Option<Handler::Result>;
	fn each_language<Handler: LanguageHandler>(&self, handler: &mut Handler) -> Vec<Handler::Result>;

	fn add_language<Lang: Language>(self) -> LanguageRegistryCons<Lang, Self> {
		LanguageRegistryCons {
			prev: self,
			dummy_lang: PhantomData {},
		}
	}
}

pub struct EmptyLanguageRegistry {}
pub struct LanguageRegistryCons<Lang: Language, Prev: LanguageRegistry> {
	prev: Prev,
	dummy_lang: PhantomData<Lang>,
}

pub fn language_registry_new() -> EmptyLanguageRegistry {
	EmptyLanguageRegistry {}
}

impl LanguageRegistry for EmptyLanguageRegistry {
	fn has_language(&self, _lang_name: &str) -> bool {
		false
	}

	fn handle_language<Handler: LanguageHandler>(&self, _lang_name: &str, _handler: &mut Handler) -> Option<Handler::Result> {
		None
	}

	fn each_language<Handler: LanguageHandler>(&self, _handler: &mut Handler) -> Vec<Handler::Result> {
		Vec::new()
	}
}

impl <Lang: Language, Prev: LanguageRegistry> LanguageRegistry for LanguageRegistryCons<Lang, Prev> {
	fn has_language(&self, lang_name: &str) -> bool  {
		lang_name == Lang::name() || self.prev.has_language(lang_name)
	}

	fn handle_language<Handler: LanguageHandler>(&self, lang_name: &str, handler: &mut Handler) -> Option<Handler::Result> {
		if lang_name == Lang::name() {
			Some(handler.run::<Lang>())
		}
		else {
			self.prev.handle_language(lang_name, handler)
		}
	}

	fn each_language<Handler: LanguageHandler>(&self, handler: &mut Handler) -> Vec<Handler::Result> {
		let mut results = self.prev.each_language(handler);
		results.push(handler.run::<Lang>());
		results
	}
}