syn_solidity/
lib.rs

1#![doc = include_str!("../README.md")]
2#![doc(
3    html_logo_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/alloy.jpg",
4    html_favicon_url = "https://raw.githubusercontent.com/alloy-rs/core/main/assets/favicon.ico"
5)]
6#![allow(missing_docs, missing_copy_implementations, clippy::missing_const_for_fn)]
7#![cfg_attr(not(test), warn(unused_crate_dependencies))]
8#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
9
10extern crate proc_macro;
11
12use syn::Result;
13
14#[macro_use]
15mod macros;
16
17mod attribute;
18pub use attribute::{
19    FunctionAttribute, FunctionAttributes, Modifier, Mutability, Override, Storage,
20    VariableAttribute, VariableAttributes, Visibility,
21};
22
23mod expr;
24pub use expr::{
25    ArgList, ArgListImpl, BinOp, Expr, ExprArray, ExprBinary, ExprCall, ExprCallOptions,
26    ExprDelete, ExprIndex, ExprMember, ExprNew, ExprPayable, ExprPostfix, ExprTernary, ExprTuple,
27    ExprTypeCall, ExprUnary, NamedArg, NamedArgList, PostUnOp, UnOp,
28};
29
30mod file;
31pub use file::File;
32
33mod ident;
34pub use ident::{SolIdent, SolPath};
35
36mod item;
37pub use item::{
38    ContractKind, EventParameter, FunctionBody, FunctionKind, ImportAlias, ImportAliases,
39    ImportDirective, ImportGlob, ImportPath, ImportPlain, Inheritance, Item, ItemContract,
40    ItemEnum, ItemError, ItemEvent, ItemFunction, ItemStruct, ItemUdt, PragmaDirective,
41    PragmaTokens, Returns, UserDefinableOperator, UsingDirective, UsingList, UsingListItem,
42    UsingType, Variant,
43};
44
45mod lit;
46pub use lit::{
47    HexStr, Lit, LitDenominated, LitHexStr, LitNumber, LitStr, LitUnicodeStr, SubDenomination,
48    UnicodeStr,
49};
50
51pub mod kw;
52
53pub mod spanned;
54pub use spanned::Spanned;
55
56mod stmt;
57pub use stmt::{
58    AssemblyFlags, Block, CatchClause, ForInitStmt, Stmt, StmtAssembly, StmtBreak, StmtContinue,
59    StmtDoWhile, StmtEmit, StmtExpr, StmtFor, StmtIf, StmtReturn, StmtRevert, StmtTry, StmtVarDecl,
60    StmtWhile, UncheckedBlock, VarDeclDecl, VarDeclTuple,
61};
62
63mod r#type;
64pub use r#type::{Type, TypeArray, TypeFunction, TypeMapping, TypeTuple};
65
66pub(crate) mod utils;
67
68mod variable;
69pub use variable::{FieldList, ParameterList, Parameters, VariableDeclaration, VariableDefinition};
70
71#[cfg(feature = "visit")]
72pub mod visit;
73#[cfg(feature = "visit")]
74pub use visit::Visit;
75
76#[cfg(feature = "visit-mut")]
77pub mod visit_mut;
78#[cfg(feature = "visit-mut")]
79pub use visit_mut::VisitMut;
80
81mod yul;
82pub use yul::{
83    WalrusToken, YulBlock, YulCaseBranch, YulEVMBuiltIn, YulExpr, YulFnCall, YulFnType, YulFor,
84    YulFunctionDef, YulIdent, YulIf, YulPath, YulReturns, YulStmt, YulSwitch, YulSwitchDefault,
85    YulVarAssign, YulVarDecl,
86};
87
88/// Parse a Solidity [`proc_macro::TokenStream`] into a [`File`].
89pub fn parse(input: proc_macro::TokenStream) -> Result<File> {
90    syn::parse(input)
91}
92
93/// Parse a Solidity [`proc_macro2::TokenStream`] into a [`File`].
94pub fn parse2(input: proc_macro2::TokenStream) -> Result<File> {
95    syn::parse2(input)
96}
97
98const DEBUG: bool = option_env!("SYN_SOLIDITY_DEBUG").is_some();
syn_solidity/lib.rs

syn_solidity/
lib.rs
