Macro Package Definition and Import

In the Cangjie language, macro definitions must be placed within a package declared by macro package. A package scoped by macro package only allows macro definitions to be externally visible, while other declarations remain package-private.

> Note:
>
> Re-exported declarations are also permitted to be externally visible. For concepts related to package management and re-exporting, refer to the Package Import chapter.

It is important to note that within a macro package, declarations from other macro packages and non-macro packages can be re-exported. In non-macro packages, only declarations from non-macro packages are allowed to be re-exported.

Refer to the following examples:

- Define macro M1 in macro package A

The compilation command is as follows:

- Define a public function f1 in non-macro package B. Note that symbols from macro package cannot be re-exported in a non-macro package.

The compilation command is as follows. Here, the --output-type option is used to compile package B into a dynamic library. For details about cjc compilation options, refer to the "Appendix > cjc Compilation Options" chapter.

- Define macro M2 in macro package C, which depends on content from packages A and B. Observe that a macro package can re-export symbols from both macro package and non-macro package.

The compilation command is as follows. Note that explicit linking of package B's dynamic library is required:

- Use macro M2 in main.cj

The compilation command is as follows:

The expanded result of macro M2 in main.cj is as follows:

As seen in main.cj, the symbol f1 from package B appears. Macro authors can re-export symbols from package B within package C, allowing macro users to correctly compile macro-expanded code by simply importing the macro package. If main.cj only imports the macro symbol using import C.M2, an undeclared identifier 'f1' error will occur.

// file define.cj
macro package define         // Compiling define.cjo with macro attribute
import std.ast.*

public func A() {}          // Error: Macro packages disallow externally visible non-macro definitions. This will raise an error.

public macro M(input: Tokens): Tokens { // Macro M is externally visible
    return input
}