@@ -578,8 +578,30 @@ protected:
}
};
+/**
+ * All builtin macros possible
+ */
+enum class BuiltinMacro
+{
+ Assert,
+ File,
+ Line,
+ Column,
+ IncludeBytes,
+ IncludeStr,
+ CompileError,
+ Concat,
+ Env,
+ Cfg,
+ Include
+};
+
/* AST node of a macro invocation, which is replaced by the macro result at
- * compile time */
+ * compile time. This is technically a sum-type/tagged-union, which represents
+ * both classic macro invocations and builtin macro invocations. Regular macro
+ * invocations are expanded lazily, but builtin macro invocations need to be
+ * expanded eagerly, hence the differentiation.
+ */
class MacroInvocation : public TypeNoBounds,
public Pattern,
public Item,
@@ -589,26 +611,47 @@ class MacroInvocation : public TypeNoBounds,
public ExternalItem,
public ExprWithoutBlock
{
- std::vector<Attribute> outer_attrs;
- MacroInvocData invoc_data;
- Location locus;
-
- // Important for when we actually expand the macro
- bool is_semi_coloned;
-
- NodeId node_id;
-
public:
+ enum class InvocKind
+ {
+ Regular,
+ Builtin,
+ };
+
std::string as_string () const override;
- MacroInvocation (MacroInvocData invoc_data,
- std::vector<Attribute> outer_attrs, Location locus,
- bool is_semi_coloned = false)
- : outer_attrs (std::move (outer_attrs)),
- invoc_data (std::move (invoc_data)), locus (locus),
- is_semi_coloned (is_semi_coloned),
- node_id (Analysis::Mappings::get ()->get_next_node_id ())
- {}
+ /**
+ * The default constructor you should use. Whenever we parse a macro call, we
+ * cannot possibly know whether or not this call refers to a builtin macro or
+ * a regular macro. With name resolution and scopes and nested macro calls,
+ * this is literally impossible. Hence, always start by creating a `Regular`
+ * MacroInvocation which will then (maybe!) become a `Builtin` macro
+ * invocation in the expander.
+ */
+ static std::unique_ptr<MacroInvocation>
+ Regular (MacroInvocData invoc_data, std::vector<Attribute> outer_attrs,
+ Location locus, bool is_semi_coloned = false)
+ {
+ return std::unique_ptr<MacroInvocation> (
+ new MacroInvocation (InvocKind::Regular, Optional<BuiltinMacro>::none (),
+ invoc_data, outer_attrs, locus, is_semi_coloned));
+ }
+
+ /**
+ * Create a builtin macro invocation. This can only be done after macro
+ * name-resolution and within the macro expander, so unless you're modifying
+ * these visitors, you probably do not want to use this function.
+ */
+ static std::unique_ptr<MacroInvocation>
+ Builtin (BuiltinMacro kind, MacroInvocData invoc_data,
+ std::vector<Attribute> outer_attrs, Location locus,
+ bool is_semi_coloned = false)
+ {
+ return std::unique_ptr<MacroInvocation> (
+ new MacroInvocation (InvocKind::Builtin,
+ Optional<BuiltinMacro>::some (kind), invoc_data,
+ outer_attrs, locus, is_semi_coloned));
+ }
Location get_locus () const override final { return locus; }
@@ -642,6 +685,37 @@ public:
bool has_semicolon () const { return is_semi_coloned; }
+ InvocKind get_kind () const { return kind; }
+ Optional<BuiltinMacro> get_builtin_kind () const { return builtin_kind; }
+
+private:
+ /* Full constructor */
+ MacroInvocation (InvocKind kind, Optional<BuiltinMacro> builtin_kind,
+ MacroInvocData invoc_data,
+ std::vector<Attribute> outer_attrs, Location locus,
+ bool is_semi_coloned)
+ : outer_attrs (std::move (outer_attrs)), locus (locus),
+ node_id (Analysis::Mappings::get ()->get_next_node_id ()),
+ invoc_data (std::move (invoc_data)), is_semi_coloned (is_semi_coloned),
+ kind (kind), builtin_kind (builtin_kind)
+ {}
+
+ std::vector<Attribute> outer_attrs;
+ Location locus;
+ NodeId node_id;
+
+ /* The data given to the macro invocation */
+ MacroInvocData invoc_data;
+
+ /* Important for when we actually expand the macro */
+ bool is_semi_coloned;
+
+ /* Is this a builtin macro or a regular macro */
+ InvocKind kind;
+
+ /* If it is a builtin macro, which one */
+ Optional<BuiltinMacro> builtin_kind = Optional<BuiltinMacro>::none ();
+
protected:
/* Use covariance to implement clone function as returning this object rather
* than base */
@@ -389,6 +389,8 @@ AttrVisitor::visit (AST::ConstGenericParam &)
void
AttrVisitor::visit (AST::MacroInvocation ¯o_invoc)
{
+ // FIXME: Probably need to check macro_invoc.kind
+
// initial strip test based on outer attrs
expander.expand_cfg_attrs (macro_invoc.get_outer_attrs ());
if (expander.fails_cfg_with_expand (macro_invoc.get_outer_attrs ()))
@@ -1752,10 +1752,9 @@ Parser<ManagedTokenSource>::parse_macro_invocation_semi (
{
// as this is the end, allow recovery (probably) - may change
- return std::unique_ptr<AST::MacroInvocation> (
- new AST::MacroInvocation (std::move (invoc_data),
- std::move (outer_attrs), macro_locus,
- true));
+ return AST::MacroInvocation::Regular (std::move (invoc_data),
+ std::move (outer_attrs),
+ macro_locus, true);
}
}
@@ -1764,9 +1763,9 @@ Parser<ManagedTokenSource>::parse_macro_invocation_semi (
t->get_token_description (),
lexer.peek_token ()->get_token_description ());
- return std::unique_ptr<AST::MacroInvocation> (
- new AST::MacroInvocation (std::move (invoc_data),
- std::move (outer_attrs), macro_locus, true));
+ return AST::MacroInvocation::Regular (std::move (invoc_data),
+ std::move (outer_attrs),
+ macro_locus, true);
}
else
{
@@ -1814,10 +1813,9 @@ Parser<ManagedTokenSource>::parse_macro_invocation (AST::AttrVec outer_attrs)
Location macro_locus = macro_path.get_locus ();
- return std::unique_ptr<AST::MacroInvocation> (
- new AST::MacroInvocation (AST::MacroInvocData (std::move (macro_path),
- std::move (delim_tok_tree)),
- std::move (outer_attrs), macro_locus));
+ return AST::MacroInvocation::Regular (
+ AST::MacroInvocData (std::move (macro_path), std::move (delim_tok_tree)),
+ std::move (outer_attrs), macro_locus);
}
// Parses a macro rule definition - does not parse semicolons.
@@ -9308,11 +9306,10 @@ Parser<ManagedTokenSource>::parse_type (bool save_errors)
AST::DelimTokenTree tok_tree = parse_delim_token_tree ();
- return std::unique_ptr<AST::MacroInvocation> (
- new AST::MacroInvocation (
- AST::MacroInvocData (std::move (macro_path),
- std::move (tok_tree)),
- {}, locus));
+ return AST::MacroInvocation::Regular (
+ AST::MacroInvocData (std::move (macro_path),
+ std::move (tok_tree)),
+ {}, locus);
}
case PLUS: {
// type param bounds
@@ -10146,11 +10143,10 @@ Parser<ManagedTokenSource>::parse_type_no_bounds ()
AST::DelimTokenTree tok_tree = parse_delim_token_tree ();
- return std::unique_ptr<AST::MacroInvocation> (
- new AST::MacroInvocation (
- AST::MacroInvocData (std::move (macro_path),
- std::move (tok_tree)),
- {}, locus));
+ return AST::MacroInvocation::Regular (
+ AST::MacroInvocData (std::move (macro_path),
+ std::move (tok_tree)),
+ {}, locus);
}
default:
// assume that this is a type path and not an error
@@ -12010,18 +12006,17 @@ Parser<ManagedTokenSource>::parse_path_based_stmt_or_expr (
{
lexer.skip_token ();
- std::unique_ptr<AST::MacroInvocation> stmt (
- new AST::MacroInvocation (std::move (invoc_data),
- std::move (outer_attrs),
- stmt_or_expr_loc, true));
+ auto stmt
+ = AST::MacroInvocation::Regular (std::move (invoc_data),
+ std::move (outer_attrs),
+ stmt_or_expr_loc, true);
return ExprOrStmt (std::move (stmt));
}
// otherwise, create macro invocation
- std::unique_ptr<AST::MacroInvocation> expr (
- new AST::MacroInvocation (std::move (invoc_data),
- std::move (outer_attrs),
- stmt_or_expr_loc, false));
+ auto expr = AST::MacroInvocation::Regular (std::move (invoc_data),
+ std::move (outer_attrs),
+ stmt_or_expr_loc, false);
return ExprOrStmt (std::move (expr));
}
else
@@ -12330,17 +12325,16 @@ Parser<ManagedTokenSource>::parse_macro_invocation_maybe_semi (
{
lexer.skip_token ();
- std::unique_ptr<AST::MacroInvocation> stmt (
- new AST::MacroInvocation (std::move (invoc_data),
- std::move (outer_attrs), macro_locus,
- true));
+ auto stmt = AST::MacroInvocation::Regular (std::move (invoc_data),
+ std::move (outer_attrs),
+ macro_locus, true);
return ExprOrStmt (std::move (stmt));
}
// otherwise, create macro invocation
- std::unique_ptr<AST::MacroInvocation> expr (
- new AST::MacroInvocation (std::move (invoc_data),
- std::move (outer_attrs), macro_locus));
+ auto expr
+ = AST::MacroInvocation::Regular (std::move (invoc_data),
+ std::move (outer_attrs), macro_locus);
return ExprOrStmt (std::move (expr));
}
else
@@ -14552,9 +14546,9 @@ Parser<ManagedTokenSource>::parse_macro_invocation_partial (
Location macro_locus = converted_path.get_locus ();
- return std::unique_ptr<AST::MacroInvocation> (new AST::MacroInvocation (
+ return AST::MacroInvocation::Regular (
AST::MacroInvocData (std::move (converted_path), std::move (tok_tree)),
- std::move (outer_attrs), macro_locus, restrictions.expr_can_be_stmt));
+ std::move (outer_attrs), macro_locus, restrictions.expr_can_be_stmt);
}
/* Parses a struct expr struct with a path in expression already parsed (but