|
Enhanced C#
Language of your choice: library documentation
|
|
Enhanced C#
Language of your choice: library documentation
|
This interface provides services offered by the lexical macro processor (LeMP). More...
This interface provides services offered by the lexical macro processor (LeMP).
Macros receive this as their second argument (see LexicalMacro)
Properties | |
| IMessageSink | Sink [get] |
| Returns the message sink, used for writing warnings and errors. More... | |
| IDictionary< object, object > | ScopedProperties [get] |
| Returns a table of "properties" (arbitrary key-value pairs) that exist in the current scope. This dictionary is "persistent" in the computer science sense; any changes to these properties affect only the current scope and child scopes. When the current scope ends, the set of properties that existed in the parent scope are restored. More... | |
| IReadOnlyList< LNode > | Ancestors [get] |
| Returns a list of ancestors of the current node being processed. Normally Ancestors[0] is a #splice node that contains a list of all top-level statements in the file, and Ancestors.Last() is the current node. More... | |
| LNode | Parent [get] |
Gets the logical parent of the current node, which is Ancestors[Ancestors.Count - 2], or null if the current node is the root node. More... | |
| IListSource< LNode > | RemainingNodes [get] |
| Gets a list of the remaining nodes (arguments/statements or attributes) after this point in the code stream. More... | |
| bool | IsAttribute [get] |
| Returns true if the current node is in the attribute list of its immediate parent. More... | |
| bool | IsTarget [get] |
| Returns true if the current node is the target of its parent call node. More... | |
| bool | DropRemainingNodes [get, set] |
| Gets or sets a value that indicates whether to drop all remaining node after the current one when the current macro returns. This property has no effect if the macro rejects the input by returning null. More... | |
| IReadOnlyDictionary< Symbol, VList< MacroInfo > > | AllKnownMacros [get] |
Gets information about all macros registered with the macro processor, including macros whose namespace has not been opened with #importMacros. More... | |
Public Member Functions | |
| LNode | PreProcessChildren () |
| Applies all available macros to the current node's children and returns the result. More... | |
| VList< LNode > | PreProcess (VList< LNode > input, bool asRoot=false, bool resetOpenNamespaces=false, bool areAttributes=false) |
| Runs the macro processor on the specified node(s). More... | |
| LNode | PreProcess (LNode input, bool asRoot=false, bool resetOpenNamespaces=false, bool isTarget=false) |
 Public Member Functions inherited from Loyc.IMessageSink | |
| void | Write (Severity type, object context, string format) |
| Writes a message to the target that this object represents. More... | |
| void | Write (Severity type, object context, string format, object arg0, object arg1=null) |
| void | Write (Severity type, object context, string format, params object[] args) |
| bool | IsEnabled (Severity type) |
| Returns true if messages of the specified type will actually be printed, or false if Write(type, ...) is a no-op. More... | |
| VList<LNode> LeMP.IMacroContext.PreProcess | ( | VList< LNode > | input, |
| bool | asRoot = false, |
||
| bool | resetOpenNamespaces = false, |
||
| bool | areAttributes = false |
||
| ) |
Runs the macro processor on the specified node(s).
| input | The node or node list to process. |
| asRoot | If false, the nodes are treated as children of the current node (using the current list of ancestors as a basis), otherwise the nodes are processed alone as if they were a separate file. |
| resetOpenNamespaces | If false, the set of open namespaces stays the same; if true it is cleared to the set of pre-opened namespaces (MacroProcessor.PreOpenedNamespaces). |
The node(s)
| LNode LeMP.IMacroContext.PreProcessChildren | ( | ) |
Applies all available macros to the current node's children and returns the result.
This method only processes children once. If this method is called again for the same node, it returns a cached result.
If the currently-running macro fails, the result may be thrown away and the effort of processing the children will have been wasted. If the macro succeeds, and its LexicalMacro attribute uses the default MacroMode.Normal processing mode, the children will (normally) be processed again after the macro returns.
Gets information about all macros registered with the macro processor, including macros whose namespace has not been opened with #importMacros.
|
get |
Returns a list of ancestors of the current node being processed. Normally Ancestors[0] is a #splice node that contains a list of all top-level statements in the file, and Ancestors.Last() is the current node.
You would expect that Ancestors[N] would contain Ancestors[N+1] as part of the attributes, target or arguments, but this is not always true. The ancestor list contains original versions of each node; when a child node is changed by a macro, the parent is not updated in this list, but macro processing continues for the descendants of that child, so the ancestor list may occasionally seem incoherent.
|
getset |
Gets or sets a value that indicates whether to drop all remaining node after the current one when the current macro returns. This property has no effect if the macro rejects the input by returning null.
See remarks at MacroContext.GetArgsAndBody.
|
get |
Returns true if the current node is in the attribute list of its immediate parent.
|
get |
Returns true if the current node is the target of its parent call node.
|
get |
Gets the logical parent of the current node, which is Ancestors[Ancestors.Count - 2], or null if the current node is the root node.
Please note that the current node may not actually exist in the parent node due to changes made earlier to the current node by other macros (or even the same macro); the Parent property still returns the old version of the parent node.
|
get |
Gets a list of the remaining nodes (arguments/statements or attributes) after this point in the code stream.
The list is null when processing a target node.
For example, if your macro is called "macro" and it appears in the following context:
Then this list will contain two items, c() and d(). Similarly, if the context is [a, b, macro(c), d, e] then the list will contain the items d and e.
|
get |
Returns a table of "properties" (arbitrary key-value pairs) that exist in the current scope. This dictionary is "persistent" in the computer science sense; any changes to these properties affect only the current scope and child scopes. When the current scope ends, the set of properties that existed in the parent scope are restored.
Scopes are bounded by curly brace nodes (Call nodes named "{}").
|
get |
Returns the message sink, used for writing warnings and errors.
For backward compatibility, IMacroContext itself implements IMessageSink, but if we were starting from scratch you'd have to write output through this property.
1.8.7
