codama_attributes/codama_directives/
codama_directive.rs

1use crate::{
2    AccountDirective, ArgumentDirective, AttributeContext, DefaultValueDirective,
3    DiscriminatorDirective, DisplayDirective, EncodingDirective, EnumDiscriminatorDirective,
4    ErrorDirective, ExportDirective, FieldDirective, FixedSizeDirective, NameDirective,
5    OptionalAccountStrategyDirective, PdaDirective, ProgramDirective, SeedDirective,
6    SizePrefixDirective, SkipDirective, TypeDirective,
7};
8use codama_syn_helpers::{extensions::*, Meta};
9use derive_more::derive::From;
10
11#[derive(Debug, PartialEq, From)]
12pub enum CodamaDirective {
13    // Type directives.
14    Type(TypeDirective),
15    Encoding(EncodingDirective),
16    Field(FieldDirective),
17    FixedSize(FixedSizeDirective),
18    SizePrefix(SizePrefixDirective),
19
20    // Default value directive.
21    DefaultValue(DefaultValueDirective),
22
23    // Multi-purpose directives.
24    Discriminator(DiscriminatorDirective),
25    Display(DisplayDirective),
26    EnumDiscriminator(EnumDiscriminatorDirective),
27    Export(ExportDirective),
28    Name(NameDirective),
29    OptionalAccountStrategy(OptionalAccountStrategyDirective),
30    Program(ProgramDirective),
31    Seed(SeedDirective),
32    Skip(SkipDirective),
33
34    // Account directives.
35    Pda(PdaDirective),
36
37    // Instruction directives.
38    Account(AccountDirective),
39    Argument(ArgumentDirective),
40
41    // Error directives.
42    Error(ErrorDirective),
43}
44
45impl CodamaDirective {
46    pub fn parse(meta: &Meta, ctx: &AttributeContext) -> syn::Result<Self> {
47        let path = meta.path()?;
48        match path.to_string().as_str() {
49            // Type directives.
50            "type" => Ok(TypeDirective::parse(meta)?.into()),
51            "encoding" => Ok(EncodingDirective::parse(meta)?.into()),
52            "field" => Ok(FieldDirective::parse(meta)?.into()),
53            "fixed_size" => Ok(FixedSizeDirective::parse(meta)?.into()),
54            "size_prefix" => Ok(SizePrefixDirective::parse(meta)?.into()),
55
56            // Default value directive.
57            "default_value" => Ok(DefaultValueDirective::parse(meta)?.into()),
58            "value" => Ok(DefaultValueDirective::parse(meta)?.into()),
59
60            // Multi-purpose directives.
61            "discriminator" => Ok(DiscriminatorDirective::parse(meta)?.into()),
62            "display" => Ok(DisplayDirective::parse(meta)?.into()),
63            "enum_discriminator" => Ok(EnumDiscriminatorDirective::parse(meta)?.into()),
64            "export" => Ok(ExportDirective::parse(meta)?.into()),
65            "name" => Ok(NameDirective::parse(meta)?.into()),
66            "optional_account_strategy" => {
67                Ok(OptionalAccountStrategyDirective::parse(meta)?.into())
68            }
69            "program" => Ok(ProgramDirective::parse(meta, ctx)?.into()),
70            "seed" => Ok(SeedDirective::parse(meta, ctx)?.into()),
71            "skip" => Ok(SkipDirective::parse(meta)?.into()),
72
73            // Account directives.
74            "pda" => Ok(PdaDirective::parse(meta)?.into()),
75
76            // Instruction directives.
77            "account" => Ok(AccountDirective::parse(meta, ctx)?.into()),
78            "argument" => Ok(ArgumentDirective::parse(meta)?.into()),
79            "provide" => Err(path.error("provide directives are not supported yet")),
80
81            // Error directives.
82            "error" => Ok(ErrorDirective::parse(meta)?.into()),
83
84            _ => Err(path.error("unrecognized codama directive")),
85        }
86    }
87
88    pub fn name(&self) -> &'static str {
89        match self {
90            // Type directives.
91            Self::Type(_) => "type",
92            Self::Encoding(_) => "encoding",
93            Self::Field(_) => "field",
94            Self::FixedSize(_) => "fixed_size",
95            Self::SizePrefix(_) => "size_prefix",
96
97            // Default value directive.
98            Self::DefaultValue(_) => "default_value | value",
99
100            // Multi-purpose directives.
101            Self::Discriminator(_) => "discriminator",
102            Self::Display(_) => "display",
103            Self::EnumDiscriminator(_) => "enum_discriminator",
104            Self::Export(_) => "export",
105            Self::Name(_) => "name",
106            Self::OptionalAccountStrategy(_) => "optional_account_strategy",
107            Self::Program(_) => "program",
108            Self::Seed(_) => "seed",
109            Self::Skip(_) => "skip",
110
111            // Account directives.
112            Self::Pda(_) => "pda",
113
114            // Instruction directives.
115            Self::Account(_) => "account",
116            Self::Argument(_) => "argument",
117
118            // Error directives.
119            Self::Error(_) => "error",
120        }
121    }
122}
codama_attributes/codama_directives/codama_directive.rs

codama_attributes/codama_directives/
codama_directive.rs
