The FILE_HANDLER module type allows plugins to define handlers for custom file types. It defines how those files are processed and eventually generate Sail AST types.
The file handler may do some arbitrary processing of the parsed file contents prior to generating Sail AST types.
val parse : Parse_ast.l option -> string -> parsedval defines_functions : processed -> Ast_util.IdSet.tIf the file will define any functions, we must inform Sail.
If the file generates registers without any initialized default value, we must inform Sail, i.e this would be a register like
register X : bits(32)rather than
register X : bits(32) = 0x0000_0000which does have a default value.
val process :
default_sail_dir:string ->
target_name:string option ->
options:(Arg.key * Arg.spec * Arg.doc) list ->
Initial_check.ctx ->
parsed ->
processed * Initial_check.ctxval check :
Type_check.Env.t ->
processed ->
Type_check.typed_ast * Type_check.Env.t