This file documents the MELT plugin API. MELT is a plugin for GCC. This document is mostly generated from MELT source code (GPLv3+) so is under the same GPLv3+ license as the source code from which (and with which) it has been generated. This document was mostly generated by the MELT plugin (run in a specific makedoc mode) from its source code.

Copyright © 2011 Free Software Foundation, Inc. This document is generated from MELT source code (which is GPLv3+ licensed) so is under GPLv3+

This file is part of the MELT plugin for GCC (GCC MELT)

GCC MELT is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.

GCC MELT is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with GCC MELT; see the file COPYING3. If not see <http://www.gnu.org/licenses/>.

Introduction

This document (mostly generated from MELT source code) documents the MELT application programming interface. It is a reference manual generated from (GPLv3+ licensed) MELT source code, so is itself GPLv3+ licensed.

Additional tutorial information for GCC is linked to from http://gcc.gnu.org/readings.html and for MELT is linked to from http://gcc-melt.org/.

1. MELT Programming Reference

1.1 MELT macros

There are 57 documented macros.

1.1.1 AGAIN

Macro defined at file ‘warmelt-macro.melt’, line 6133.

macro description: The AGAIN syntax is for restarting a local FOREVER loop in the same function. Syntax is (AGAIN <loop-label>).

1.1.2 ASSERT_MSG

Macro defined at file ‘warmelt-macro.melt’, line 6260.

macro description: ASSERT_MSG macro with a message cstring and an optional condition. Generates an assertion -if checking is enabled- and also issues a compile warning if condition is missing so false.

1.1.3 CHEADER

Macro defined at file ‘warmelt-macro.melt’, line 5850.

macro description: The CHEADER syntax inserts C code in the header part of the generated code.

1.1.4 CODE_CHUNK

Macro defined at file ‘warmelt-macro.melt’, line 3950.

macro description: The CODE_CHUNK macro is for low-level C code chunks. The syntax is (CODE_CHUNK state-symbol chunk) where chunk is a macro-string. It generates a C block. Since it does not make any type verification, it should be usually avoided. See DEFPRIMITIVE etc.

1.1.5 COMMENT

Macro defined at file ‘warmelt-macro.melt’, line 5801.

macro description: The COMMENT syntax inserts comment in the generated code, or skips MELT code. Syntax is (COMMENT <string>) to insert a comment in the generated C code, or (COMMENT ...) to skip some syntax.

1.1.6 COMPILE_WARNING

Macro defined at file ‘warmelt-macro.melt’, line 6173.

macro description: The COMPILE_WARNING syntax issues a warning, inspired by GCC #warning. Syntax is (COMPILE_WARNING <string> [<expression>]).

1.1.7 COND

Macro defined at file ‘warmelt-macro.melt’, line 4536.

macro description: The usual lisp COND conditional. Syntax is (COND <conditions>...). Each condition is a list of the form (<test> <expr>...). The last catch-all condition can be (:else <epxr>...).

1.1.8 CONTENT

Macro defined at file ‘warmelt-macro.melt’, line 4931.

macro description: The CONTENT macro is obsolete. Use DEREF instead.

1.1.9 CPPIF

Macro defined at file ‘warmelt-macro.melt’, line 4359.

macro description: The CPPIF macro expands to C-code with an #if condition, so the condition is handled when compiling the generated C code into a MELT module. Syntax is (CPPIF <symbol> <then> [<else>]).

1.1.10 CURRENT_MODULE_ENVIRONMENT_CONTAINER

Macro defined at file ‘warmelt-macro.melt’, line 6702.

macro description: (CURRENT_MODULE_ENVIRONMENT_CONTAINER) returns a container, i.e. a reference thru CLASS_REFERENCE, for the current environment. See also PARENT_MODULE_ENVIRONMENT and CLASS_ENVIRONMENT. Will be renamed as CURRENT_MODULE_ENVIRONMENT_REFERENCE.

1.1.11 DEBUG

Macro defined at file ‘warmelt-macro.melt’, line 6452.

macro description: DEBUG is a variadic and polytypic macro for debugging prints. You can give it arbitrary arguments -either stuff or values-. Debugging prints should be enabled at compilation time of the generated C code with the quicklybuilt or debugnoline module flavors, and at run time with the -f[plugin-arg-]melt-debugging= option. Internally (DEBUG arg...) is macro expanded to the equivalent of (cppif MELT_HAVE_DEBUG (if (melt_need_dbg 0) (melt_debug_fun () count filename lineno ...)))

1.1.12 DEBUG_MSG

Macro defined at file ‘warmelt-macro.melt’, line 6333.

macro description: DEBUG_MSG is obsolete and should not be used. Use DEBUG instead.

1.1.13 DEFCITERATOR

Macro defined at file ‘warmelt-macro.melt’, line 2367.

macro description: The DEFCITERATOR macro defines a c-iterator which itself implements iterative for-like loops. Syntax is (DEFCITERATOR name start-formals state-symbol variable-formals [:doc documentation] before-expansion after-expansion). To be visible outside the module, the c-iterator should be exported using EXPORT_VALUES. See also CLASS_CITERATOR.

1.1.14 DEFCLASS

Macro defined at file ‘warmelt-macro.melt’, line 3188.

macro description: The DEFCLASS macro defines a class. Syntax is (DEFCLASS symbol [:doc documentation] :super super-class :fields fields-list). Conventionally, the class name (i.e. the symbol) should preferably start with CLASS_. The fields’ names should preferably be globally unique, and usually share a common prefix. See also CLASS_ROOT CLASS_CLASS CLASS_FIELD etc.

1.1.15 DEFCMATCHER

Macro defined at file ‘warmelt-macro.melt’, line 2568.

macro description: The DEFCMATCHER macro defines pattern-matching operator by their C expansion. Syntax is (DEFCMATCHER symbol match&ins-formals out-formals state-symbol [:doc documentation] test-expansion fill-expansion [operator-expansion]).

1.1.16 DEFINE

Macro defined at file ‘warmelt-macro.melt’, line 2920.

macro description: The DEFINE macro defines a named non-recursive value. Syntax (like in Scheme) is (DEFINE name [:doc documentation] expr ...) to define a value, and (DEFINE (funame formals...) [:doc documentation] expr ...) to define a function like DEFUN does. Use EXPORT_VALUES to make that name visible outside its module.

1.1.17 DEFINSTANCE

Macro defined at file ‘warmelt-macro.melt’, line 3399.

macro description: The DEFINSTANCE syntax defines a static instance bound by a symbol. Syntax is (DEFINSTANCE <symbol> <class> [:doc documentation] {:<field> <value>}*). The symbol is bound to the newly made instance.

1.1.18 DEFPRIMITIVE

Macro defined at file ‘warmelt-macro.melt’, line 2213.

macro description: The DEFPRIMITIVE macro defines new primitive operations by their C expansion. Syntax is (DEFPRIMITIVE name formals type [:doc documentation] expansion) which defines a primitive of given name with formal arguments formals, result c-type type, optional documentation, and given expansion. A macro is expanded into a C instruction if its c-type is :void, otherwise into a C expression. Primitives have to be exported with EXPORT_VALUES to be visible in other modules. See also the classes CLASS_PRIMITIVE, and CLASS_PRIMITIVE_BINDING and the CODE_CHUNK macro.

1.1.19 DEFSELECTOR

Macro defined at file ‘warmelt-macro.melt’, line 3548.

macro description: The DEFSELECTOR syntax defines a selector for sending messages. Syntax is (DEFSELECTOR <symbol> <selector-class> [:doc <documentation>] [:formals ( <formals>...)]).

1.1.20 DEFUN

Macro defined at file ‘warmelt-macro.melt’, line 2790.

macro description: The DEFUN macro defines a function. Syntax is (DEFUN funame formals [:doc documentation] body...). The first formal argument, if any, is required to be of ctype :value. The expressions in the body are evaluated in sequence. The value of the last is returned. See also RETURN and LAMBDA macros. A function defined by DEFUN has to be exported with EXPORT_VALUES to be visible outside its module.

1.1.21 DEFUNMATCHER

Macro defined at file ‘warmelt-macro.melt’, line 2717.

macro description: The DEFUNMATCHER syntax defines a matcher thru a MELT function. Syntax is (DEFUNMATCHER <symbol> <in-formals> <out-formals> [:doc docum] <match-function> [<apply-function> [<data>]])

1.1.22 DEREF

Macro defined at file ‘warmelt-macro.melt’, line 4917.

macro description: The DEREF macro is a short-hand to retrieve values inside instances of CLASS_REFERENCE. So (DEREF <value>) means (GET_FIELD :REFERENCED_VALUE <value>), hence test that <value> is indeed an instance of CLASS_REFERENCE, or else gives null. The special syntax !<expr> is a syntactic sugar for (DEREF <expr>).

1.1.23 EXCLAIM

Macro defined at file ‘warmelt-macro.melt’, line 4937.

macro description: EXCLAIM [usually given thru the ! syntactic sugar] is a synonym for DEREF, e.g. !(IF p c) means (DEREF (IF P C)) hence (GET_FIELD :REFERENCED_VALUE (IF P C))

1.1.24 EXIT

Macro defined at file ‘warmelt-macro.melt’, line 6090.

macro description: The EXIT syntax is for exiting a local FOREVER loop in the same function. Syntax is (EXIT <loop-name> <expression>...).

1.1.25 EXPORT_CLASS

Macro defined at file ‘warmelt-macro.melt’, line 6625.

macro description: (EXPORT_CLASS names...) is used to export class and their field names.

1.1.26 EXPORT_MACRO

Macro defined at file ‘warmelt-macro.melt’, line 6541.

macro description: (EXPORT_MACRO name macro-expander [:doc documentation]) is used to define an exported macro.

1.1.27 EXPORT_PATMACRO

Macro defined at file ‘warmelt-macro.melt’, line 6593.

macro description: (EXPORT_PATMACRO name pattern-expander [macro-expander] [:doc documentation]) is used to define patmacros.

1.1.28 EXPORT_SYNONYM

Macro defined at file ‘warmelt-macro.melt’, line 6674.

macro description: (EXPORT_SYNONYM new-name old-name [:doc documentation]) is used to define a synonym.

1.1.29 EXPORT_VALUES

Macro defined at file ‘warmelt-macro.melt’, line 6495.

macro description: EXPORT_VALUES is a macro to export values defined by names. Give it a sequence of names bound to values using DEFINE, DEFUN, DEFINSTANCE, DEFSELECTOR, DEFCITERATOR, DEFCMATCHER, DEFFUNMATCHER etc. Use EXPORT_CLASS for exporting classes and their fields.

1.1.30 FETCH_PREDEFINED

Macro defined at file ‘warmelt-macro.melt’, line 6797.

macro description: (FETCH_PREDEFINED predefined-name) is accessing a predefined value without using environments. You probably don’t need that.

1.1.31 FOREVER

Macro defined at file ‘warmelt-macro.melt’, line 6045.

macro description: The FOREVER syntax is for infinite loops exited thru EXIT. Syntax is (FOREVER <loop-name> <expr>...). Use EXIT to go out of the loop with a result.

1.1.32 GCCIF

Macro defined at file ‘warmelt-macro.melt’, line 4436.

macro description: The GCCIF macro expands the rest of the expression if the version string of the GCC translating this MELT expression matches the condition. Syntax is (GCCIF condition expr...), where the condition is a string such as "4.5." or a list of strings.

1.1.33 GET_FIELD

Macro defined at file ‘warmelt-macro.melt’, line 4125.

macro description: The GET_FIELD syntax safely access a field. Syntax is (GET_FIELD :<field> <expression>) which evaluates to nil if the expression is not of the class defining the field. See also UNSAFE_GET_FIELD.

1.1.34 IF

Macro defined at file ‘warmelt-macro.melt’, line 4230.

macro description: The IF syntax is for simple conditional expressions. See also WHEN and UNLESS and COND. Syntax is (IF <test-expression> <then-expression> [<else-expression>]).

1.1.35 INSTANCE

Macro defined at file ‘warmelt-macro.melt’, line 3618.

macro description: The INSTANCE syntax is for making new objects. Syntax is (INSTANCE <class> {:<field> <expression>}*).

1.1.36 LAMBDA

Macro defined at file ‘warmelt-macro.melt’, line 5537.

macro description: The LAMBDA syntax is for anonymous functions e.g. closures, with closed values (however closing things like :gimple or :long is not permitted, you have to box them explicitly as :value-s.). Syntax is (LAMBDA ( <formals> ... ) <body>...). The formal argument list should have its first formal be a :value. Other arguments can be c-typed with keywords like :value :gimple :long etc. which applies to all succeeding arguments up to the next ctype keyword. The body is a non-empty sequence of expressions. LAMBDA functions can RETURN a value with possible secondary results. See also MULTICALL. LAMBDA expressions are constructive so can appear in LETREC bindings.

1.1.37 LET

Macro defined at file ‘warmelt-macro.melt’, line 5321.

macro description: The LET syntax is for sequential local bindings of expressions. Syntax is (LET ( <binding>... ) <body>...). Each binding is an optional ctype such as :long or :gimple or :value (which is the default), followed by a local variable name, followed by a single expression. The body is a non-empty sequence of expressions, evaluated in an environment enriched with the local bindings. The MELT LET syntax is sequential, like LET* in Scheme so a variable bound in a previous binding can appear in the expression of a later binding.

1.1.38 LETREC

Macro defined at file ‘warmelt-macro.melt’, line 5494.

macro description: The LETREC syntax is for mutually recursive local bindings. Syntax is (LETREC ( <binding>... ) <body>...). Each binding is an optional ctype such as :long or :gimple or :value (which is the default), followed by a local variable name, followed by a single constructive expression, like LAMBDA INSTANCE TUPLE LIST. The body is a non-empty sequence of sub-expressions evaluated in an augmented environment. MELT LETREC is similar to Scheme’s LETREC.

1.1.39 LOAD

Macro defined at file ‘warmelt-macro.melt’, line 3660.

macro description: The LOAD macro is for reading expressions from another file. Syntax is (LOAD <file-name>).

1.1.40 MATCH

Macro defined at file ‘warmelt-macro.melt’, line 5176.

macro description: The MATCH syntax is for pattern-matching expressions. Syntax is (MATCH <matched-expression> <match-case>...). Each match-case starts with a pattern followed by expressions. The catch-all pattern ?_ should appear in the last match-case if any. Pattern variables like ?x are bound by the matching in their match-case.

1.1.41 MULTICALL

Macro defined at file ‘warmelt-macro.melt’, line 5727.

macro description: The MULTICALL syntax is for accumulating the primary and secondary results of a function application or a message sending. Syntax is (MULTICALL ( <formals> ) <application-or-sending> <body>...). The first formal is bound to the primary result and should be a :value. Other are for secondary results. The body is evaluated with these results of the given application or sending expression bound by the formals. Inspired by Scheme’s CALL-WITH-VALUES or CommonLisp’s MULTIPLE-VALUE-BIND.

1.1.42 PARENT_MODULE_ENVIRONMENT

Macro defined at file ‘warmelt-macro.melt’, line 6731.

macro description: (PARENT_MODULE_ENVIRONMENT) gives the parent environnment of this module. See also CLASS_ENVIRONMENT and CURRENT_MODULE_ENVIRONMENT_CONTAINER.

1.1.43 PROGN

Macro defined at file ‘warmelt-macro.melt’, line 5982.

macro description: The PROGN syntax evaluate a sequence of expressions ignoring all but the last which is the result. Syntax is (PROGN <expression>...).

1.1.44 PUT_FIELDS

Macro defined at file ‘warmelt-macro.melt’, line 4043.

macro description: The PUT_FIELDS syntax is for safely setting fields in an object. Syntax is (PUT_FIELDS <instance-expression> {:<field> <field-expression>}*). If the instance is not an object of the class containing all the fields, no harm is done. See also UNSAFE_PUT_FIELDS which does not produces checks.

1.1.45 QUOTE

Macro defined at file ‘warmelt-macro.melt’, line 5770.

macro description: The QUOTE syntax (usually noted with a prefix quote-character) is for quotations. Only symbols or literals can be quoted. A quoted literal reifies a value, so ’2 is a value of DISCR_CONSTANT_INTEGER.

1.1.46 RETURN

Macro defined at file ‘warmelt-macro.melt’, line 6003.

macro description: The RETURN syntax is for returning a primary and possibly secondary results. Syntax is (RETURN <expression>...). If no expression is given, returns nil.

1.1.47 SETQ

Macro defined at file ‘warmelt-macro.melt’, line 4177.

macro description: The SETQ syntax is for assignment of local variables, usually bound by a LET in the same function. Syntax is (SETQ <symbol> <expr>).

1.1.48 SET_REF

Macro defined at file ‘warmelt-macro.melt’, line 4990.

macro description: The SET_REF macro is a short-hand to put a value inside instances of CLASS_REFERENCE. So (SET_REF <ref> <value>) means (PUT_FIELDS <ref> :REFERENCED_VALUE <value>), hence test that <ref> is indeed an instance of CLASS_REFERENCE before updating it.

1.1.49 STORE_PREDEFINED

Macro defined at file ‘warmelt-macro.melt’, line 6833.

macro description: (STORE_PREDEFINED predefined-name value) is storing a predefined value. You probably never need that.

1.1.50 UNLESS

Macro defined at file ‘warmelt-macro.melt’, line 4303.

macro description: The UNLESS syntax sugar is for negated conditional expressions with body. Syntax is (UNLESS <test> <body>...) syntactic sugar for (IF <test> () (PROGN <body>...)).

1.1.51 UNSAFE_GET_FIELD

Macro defined at file ‘warmelt-macro.melt’, line 4084.

macro description: The UNSAFE_GET_FIELD syntax retrieves dangerously a field from an instance and may crash when the instance is not an object of the appropriate class. Syntax is (UNSAFE_GET_FIELD :<field> <expression>). Using GET_FIELD is preferrable.

1.1.52 UNSAFE_PUT_FIELDS

Macro defined at file ‘warmelt-macro.melt’, line 3996.

macro description: The UNSAFE_PUT_FIELDS is for expert use only, since it can crash the running GCC MELT compilation. Syntax is (UNSAFE_PUT_FIELDS <instance> {:<field> <expression>}). It sets fields in an instance without any checks. Using PUT_FIELDS is prefered.

1.1.53 UPDATE_CURRENT_MODULE_ENVIRONMENT_CONTAINER

Macro defined at file ‘warmelt-macro.melt’, line 6760.

macro description: (UPDATE_CURRENT_MODULE_ENVIRONMENT_CONTAINER) is a guru macro to update the current module environment container. You probably should never use it, but it is necessary inside MELT. See CURRENT_MODULE_ENVIRONMENT_CONTAINER. Will be renamed as UPDATE_CURRENT_MODULE_ENVIRONMENT_BOX.

1.1.54 USE-PACKAGE-FROM-PKG-CONFIG

Macro defined at file ‘warmelt-macro.melt’, line 5936.

macro description: The USE-PACKAGE-FROM-PKG-CONFIG or USE_PACKAGE_FROM_PKG_CONFIG syntax enables usage of pkg-config-ured packages. Arguments are strings naming packages. This modifies the compilation and linking of generated C code. Probably using some CHEADER for some #include is useful.

1.1.55 USE_PACKAGE_FROM_PKG_CONFIG

Macro defined at file ‘warmelt-macro.melt’, line 5930.

macro description: The USE_PACKAGE_FROM_PKG_CONFIG or USE-PACKAGE-FROM-PKG-CONFIG syntax enables usage of pkg-config-ured packages. Arguments are strings naming packages. This modifies the compilation and linking of generated C code. Probably using some CHEADER for some #include is useful.

1.1.56 VARIADIC

Macro defined at file ‘warmelt-macro.melt’, line 5661.

macro description: The VARIADIC syntax is for getting variable arguments inside variadic functions -using :REST-. Syntax is (VARIADIC variadic-case ...) where each variadic-case is ( (formal ...) body ...) and the last variadic-case can also be (:ELSE body ...). When the actual variable arguments’s signature match the given formals in a variadic-case, they are bound, and the body of that case is evaluated. If no formals match in type and number and if the last variadic-case starts with :ELSE it is exacuted. As an expression, (VARIADIC ...) gives no result, so is :void. In a variadic-case, if no <formals are given, the body is executed when no more actual variable arguments remain.

1.1.57 WHEN

Macro defined at file ‘warmelt-macro.melt’, line 4266.

macro description: The WHEN syntax sugar is for conditional expressions with body. Syntax is (WHEN <test> <body>...) syntactic sugar for (IF <test> (PROGN <body>...)).

1.2 MELT pattern macros

There are 8 documented pattern-macros.

1.2.1 AND

Pattern macro defined at file ‘warmelt-macro.melt’, line 4697.

pattern macro description: The lispy AND conjunction syntax is a short-circuit "and then" conjunction. Expression syntax is (AND <conjunct-subexpression>...) and can evaluate to a :value or a thing such as a :long or a :gimple which is null/zero iff any conjunct is null or zero. Pattern syntax is ?(AND <conjunct-subpattern>...) and matches if all conjunct-subpattern-s match. See also COND OR and IF.

1.2.2 CONTAINER

Pattern macro defined at file ‘warmelt-macro.melt’, line 4873.

pattern macro description: The CONTAINER syntax for expressions or patterns is obsolete. Use REFERENCE instead

1.2.3 INSTANCE

Pattern macro defined at file ‘warmelt-macro.melt’, line 3789.

pattern macro description: The INSTANCE pattern macro matches an instance when used as a pattern, or creates an instance when used as an expression. Pattern syntax is ?(INSTANCE class-name :field1 pattern1 :field2 pattern2...) - there can be zero, one or more distinct fields. A value matches such a pattern if the value is an instance of class-name or a sub-class and if each specified field matches its [sub-]pattern. Expression syntax is (INSTANCE class-name :field1 value1 :field2 value2...). All the fields should be acceptable for the specified class-name. In expressions, missing fields are initialized to nil. In patterns missing fields are not matched. The given class-name is a fixed class (not a variable) possessing all the specified fields.

1.2.4 LIST

Pattern macro defined at file ‘warmelt-macro.melt’, line 5080.

pattern macro description: The LIST syntax is for making or matching lists made of pairs. Expression syntax is (LIST <component-subexpression>...) to make a list of DISCR_LIST with the given components going into the head of pairs of DISCR_PAIR. Pattern syntax is ?(LIST <component-subpattern>...) to match a list of given length with each component matching its corresponding <component-subpattern>. LIST expressions are constructive, so can appear in LETREC bindings.

1.2.5 OBJECT

Pattern macro defined at file ‘warmelt-macro.melt’, line 3894.

pattern macro description: The OBJECT pattern macro matches an instance when used as a pattern. Pattern syntax is ?(OBJECT class-name :field1 pattern1 :field2 pattern2...) - there can be zero, one or more distinct fields. A value matches such a pattern if the value is an instance of exactly class-name (not a sub-class) and if each specified field matches its [sub-]pattern. The OBJECT pattern macro should not be used in expression context. See also INSTANCE and DEFCLASS.

1.2.6 OR

Pattern macro defined at file ‘warmelt-macro.melt’, line 4763.

pattern macro description: The lispy OR disjunctive syntax is a short-circuit "or else" disjonction. Expression syntax is (OR <disjunct-subexpression>...) and can evaluate to a :value or a thing such as a :gimple or a :long etc. which is null/zero iff every disjunct is null/zero. Pattern-syntax is ?(OR <disjunct-subpattern>...) and matches if one of the disjunct-subpattern matches. See also COND AND and IF.

1.2.7 REFERENCE

Pattern macro defined at file ‘warmelt-macro.melt’, line 4845.

pattern macro description: The REFERENCE syntax is a short-hand for making or matching instances of CLASS_REFERENCE. Expression syntax (REFERENCE <subexpression>) is a short-hand for (INSTANCE CLASS_REFERENCE :REFERENCED_VALUE <subexpression>) to make an instance of CLASS_REFERENCE with the given value as REFERENCED_VALUE. Pattern syntax is ?(REFERENCE <subpattern>) to match an instance of CLASS_REFERENCE with its REFERENCED_VALUE matching <subpattern>. REFERENCE expressions are constructive, so can appear in LETREC bindings.

1.2.8 TUPLE

Pattern macro defined at file ‘warmelt-macro.melt’, line 5033.

pattern macro description: The TUPLE syntax is for making or matching tuples. Expression syntax is (TUPLE <component-subexpression>...) to make a tuple of DISCR_MULTIPLE with the given components. Pattern syntax is ?(TUPLE <component-subpattern>...) to match a tuple of given length with each component matching its corresponding <component-subpattern>. TUPLE expressions are constructive, so can appear in LETREC bindings.

1.3 MELT classes

Table of classes sorted by inheritance depth.

0:

CLASS_ROOT

1:

CLASS_ANY_BINDING, CLASS_C_GENERATION_CONTEXT, CLASS_DEBUG_INFORMATION, CLASS_ENVIRONMENT, CLASS_GENERATED_C_CODE, CLASS_MATCHING_CONTEXT, CLASS_MATCH_NORMALIZATION_CONTEXT, CLASS_MODULE_CONTEXT, CLASS_NORMALIZATION_CONTEXT, CLASS_NORMAL_OR_VARIABLE, CLASS_NREP, CLASS_OPTION_DESCRIPTOR, CLASS_PATTERN_CONTEXT, CLASS_PATTERN_EXPANSION_CONTEXT, CLASS_PROPED, CLASS_REFERENCE

2:

CLASS_ALARM_HANDLER, CLASS_ANALYSIS_STATE, CLASS_CHILD_PROCESS_HANDLER, CLASS_DESCRIBED_ENVIRONMENT, CLASS_EXPORTED_BINDING, CLASS_FIXED_BINDING, CLASS_FORMAL_BINDING, CLASS_INITIAL_GENERATION_CONTEXT, CLASS_INPUT_CHANNEL_HANDLER, CLASS_LABEL_BINDING, CLASS_LET_BINDING, CLASS_LITERAL_VALUE, CLASS_LOCATED, CLASS_MAKEDOC_INFO, CLASS_MATCHED_BINDING, CLASS_MATCHED_DATA, CLASS_MATCH_CASE, CLASS_MATCH_GRAPHIC, CLASS_NAMED, CLASS_NORMAL_CONSTRUCTOR_BINDING, CLASS_NREP_ANYPROC, CLASS_NREP_EXPRESSION, CLASS_NREP_QUASIDATA, CLASS_NREP_SIMPLE, CLASS_OPENGPU_INDUCTION_VARIABLE, CLASS_OPENGPU_LINEAR_COMPOSITION, CLASS_PROBED_FILE, CLASS_PROBED_INTERESTING_LOCATION, CLASS_PROBE_DATA, CLASS_RUNNING_EXTENSION_MODULE_CONTEXT

3:

CLASS_ANY_MATCHER, CLASS_CITERATOR, CLASS_CITERATOR_BINDING, CLASS_CLASS_BINDING, CLASS_CMATCHER_BINDING, CLASS_CTYPE, CLASS_DEFINED_VALUE_BINDING, CLASS_DELAYED_QUEUE, CLASS_DISCRIMINANT, CLASS_EXTENSION_GENERATION_CONTEXT, CLASS_FIELD, CLASS_FIELD_BINDING, CLASS_FUNCTION_BINDING, CLASS_FUNMATCHER_BINDING, CLASS_GCC_PASS, CLASS_GCC_PRAGMA, CLASS_INSTANCE_BINDING, CLASS_LETREC_BINDING, CLASS_MACRO_BINDING, CLASS_MATCHED_NORMAL_DATA, CLASS_MATCH_FLAG, CLASS_MATCH_STEP, CLASS_MELT_MODE, CLASS_NORMAL_CONSTRUCTED_INSTANCE_BINDING, CLASS_NORMAL_CONSTRUCTED_LAMBDA_BINDING, CLASS_NORMAL_CONSTRUCTED_LIST_BINDING, CLASS_NORMAL_CONSTRUCTED_PAIR_BINDING, CLASS_NORMAL_CONSTRUCTED_TUPLE_BINDING, CLASS_NORMAL_LET_BINDING, CLASS_NREP_BOUND_DATA, CLASS_NREP_CHECKSIGNAL, CLASS_NREP_COMMENT, CLASS_NREP_CONSUME_VARIADIC, CLASS_NREP_CPPIF, CLASS_NREP_INITPROC, CLASS_NREP_JUMP_WHEN_IS_A, CLASS_NREP_LET, CLASS_NREP_MATCHED_DATA, CLASS_NREP_MATCH_DATA_ACTION, CLASS_NREP_MATCH_FLAG, CLASS_NREP_MATCH_JUMP, CLASS_NREP_MATCH_LABEL, CLASS_NREP_NIL, CLASS_NREP_PREDEF, CLASS_NREP_PROGN, CLASS_NREP_RETURN, CLASS_NREP_ROUTPROC, CLASS_NREP_TYPED_EXPRESSION, CLASS_PRIMITIVE, CLASS_PRIMITIVE_BINDING, CLASS_SELECTOR, CLASS_SELECTOR_BINDING, CLASS_SEXPR, CLASS_SOURCE, CLASS_SYMBOL, CLASS_SYSTEM_DATA, CLASS_VALUE_BINDING, CLASS_VALUE_DESCRIPTOR

4:

CLASS_CLASS, CLASS_CLONED_SYMBOL, CLASS_CMATCHER, CLASS_CTYPE_GTY, CLASS_CTYPE_PLAIN, CLASS_FUNMATCHER, CLASS_GCC_ANY_IPA_PASS, CLASS_GCC_GIMPLE_PASS, CLASS_GCC_RTL_PASS, CLASS_KEYWORD, CLASS_MATCH_STEP_THEN, CLASS_NREP_ALTMATCH, CLASS_NREP_CHUNK, CLASS_NREP_DEFUNROUTPROC, CLASS_NREP_DISCRIMINATED_DATA, CLASS_NREP_IFCOMMON, CLASS_NREP_INITEXTENDPROC, CLASS_NREP_LAMBDAROUTPROC, CLASS_NREP_LETREC, CLASS_NREP_MATCH_DATA_CLEAR, CLASS_NREP_MATCH_DATA_FINALIZER, CLASS_NREP_MATCH_DATA_INITIALIZER, CLASS_NREP_MATCH_LABEL_END, CLASS_NREP_TYPED_EXPRESSION_WITH_ARGUMENTS, CLASS_PATMACRO_BINDING, CLASS_SEXPR_MACROSTRING, CLASS_SOURCE_ARGUMENTED_OPERATOR, CLASS_SOURCE_CHEADER, CLASS_SOURCE_COMMENT, CLASS_SOURCE_CPPIF, CLASS_SOURCE_DEFINITION, CLASS_SOURCE_EXPORTCOMMON, CLASS_SOURCE_EXPORT_MACRO, CLASS_SOURCE_EXPORT_SYNONYM, CLASS_SOURCE_FIELDASSIGN, CLASS_SOURCE_FIELD_PATTERN, CLASS_SOURCE_GENERATOR_DEVICE, CLASS_SOURCE_GET_FIELD, CLASS_SOURCE_IF, CLASS_SOURCE_IFVARIADIC, CLASS_SOURCE_INSTANCE, CLASS_SOURCE_LABELLED, CLASS_SOURCE_LAMBDA, CLASS_SOURCE_LAZY_MACRO_EXPANSION, CLASS_SOURCE_LET, CLASS_SOURCE_LET_BINDING, CLASS_SOURCE_MATCH, CLASS_SOURCE_MATCH_CASE, CLASS_SOURCE_MULTICALL, CLASS_SOURCE_OR, CLASS_SOURCE_PATTERN, CLASS_SOURCE_PROGN, CLASS_SOURCE_PUT_FIELDS, CLASS_SOURCE_QUOTE, CLASS_SOURCE_SETQ, CLASS_SOURCE_USE_PACKAGE_FROM_PKG_CONFIG, CLASS_VARISIZED_VALUE_DESCRIPTOR

5:

CLASS_GCC_SIMPLE_IPA_PASS, CLASS_GCC_TRANSFORM_IPA_PASS, CLASS_MATCH_STEP_CLEAR, CLASS_MATCH_STEP_WITH_DATA, CLASS_MATCH_STEP_WITH_FLAG, CLASS_NREP_APPLY, CLASS_NREP_IF, CLASS_NREP_IFSAME, CLASS_NREP_IFTESTVALUE, CLASS_NREP_IFVARIADIC, CLASS_NREP_MSEND, CLASS_SOURCE_AGAIN, CLASS_SOURCE_APPLY, CLASS_SOURCE_CITERATION, CLASS_SOURCE_CMATCHEXPR, CLASS_SOURCE_DEFINE, CLASS_SOURCE_DEFINITION_FORMAL, CLASS_SOURCE_DEFOBJCOMMON, CLASS_SOURCE_EXIT, CLASS_SOURCE_EXPORT_CLASS, CLASS_SOURCE_EXPORT_PATMACRO, CLASS_SOURCE_EXPORT_VALUES, CLASS_SOURCE_FOREVER, CLASS_SOURCE_FUNMATCHEXPR, CLASS_SOURCE_IFELSE, CLASS_SOURCE_LETREC, CLASS_SOURCE_LETREC_BINDING, CLASS_SOURCE_LIST, CLASS_SOURCE_MSEND, CLASS_SOURCE_PATTERN_AND, CLASS_SOURCE_PATTERN_CONSTANT, CLASS_SOURCE_PATTERN_CONSTRUCT, CLASS_SOURCE_PATTERN_OBJECT, CLASS_SOURCE_PATTERN_OR, CLASS_SOURCE_PATTERN_VARIABLE, CLASS_SOURCE_PATTERN_WHEN, CLASS_SOURCE_PRIMITIVE, CLASS_SOURCE_RETURN, CLASS_SOURCE_TUPLE, CLASS_SOURCE_UNSAFE_GET_FIELD, CLASS_SOURCE_UNSAFE_PUT_FIELDS

6:

CLASS_MATCH_STEP_FLAG_OPERATION, CLASS_MATCH_STEP_FLAG_SET, CLASS_MATCH_STEP_SUCCESS_WHEN_FLAG, CLASS_MATCH_STEP_TEST, CLASS_NREP_IFISA, CLASS_NREP_IFTUPLESIZED, CLASS_NREP_MULTIAPPLY, CLASS_NREP_MULTIMSEND, CLASS_SOURCE_DEFCITERATOR, CLASS_SOURCE_DEFCLASS, CLASS_SOURCE_DEFCMATCHER, CLASS_SOURCE_DEFINSTANCE, CLASS_SOURCE_DEFPRIMITIVE, CLASS_SOURCE_DEFUN, CLASS_SOURCE_DEFUNMATCHER, CLASS_SOURCE_PATTERN_COMPOSITE, CLASS_SOURCE_PATTERN_INSTANCE, CLASS_SOURCE_PATTERN_JOKER_VARIABLE, CLASS_SOURCE_PATTERN_LIST, CLASS_SOURCE_PATTERN_TUPLE

7:

CLASS_MATCH_STEP_FLAG_CONJUNCTION, CLASS_MATCH_STEP_FLAG_DISJUNCTION, CLASS_MATCH_STEP_TEST_CONSTANT, CLASS_MATCH_STEP_TEST_GROUP, CLASS_MATCH_STEP_TEST_INSTANCE, CLASS_MATCH_STEP_TEST_MATCHER, CLASS_MATCH_STEP_TEST_MULTIPLE, CLASS_MATCH_STEP_TEST_VARIABLE, CLASS_SOURCE_DEFSELECTOR, CLASS_SOURCE_PATTERN_MATCHER

8:

CLASS_SOURCE_PATTERN_C_MATCH, CLASS_SOURCE_PATTERN_FUN_MATCH

1.3.1 CLASS_ALARM_HANDLER

Class defined at file ‘warmelt-first.melt’, line 795.

2 ancestors: CLASS_ROOT CLASS_PROPED.

4 fields:

class description: Internal class for alarm handling. ALARMH_PERIOD is the boxed period in milliseconds, ALARMH_CLOS is the closure to be called, ALARMH_DATA is the client data. See REGISTER_ALARM_TIMER and

1.3.2 CLASS_ANALYSIS_STATE

Class defined at file ‘xtramelt-ana-base.melt’, line 36.

2 ancestors: CLASS_ROOT CLASS_PROPED.

1 fields:

class description: A class containing some analysis state, to be subclassed.

1.3.3 CLASS_ANY_BINDING

Class defined at file ‘warmelt-first.melt’, line 464.

1 ancestors: CLASS_ROOT.

1 fields:

27 sub-classes: CLASS_CITERATOR_BINDING, CLASS_CLASS_BINDING, CLASS_CMATCHER_BINDING, CLASS_DEFINED_VALUE_BINDING, CLASS_EXPORTED_BINDING, CLASS_FIELD_BINDING, CLASS_FIXED_BINDING, CLASS_FORMAL_BINDING, CLASS_FUNCTION_BINDING, CLASS_FUNMATCHER_BINDING, CLASS_INSTANCE_BINDING, CLASS_LABEL_BINDING, CLASS_LETREC_BINDING, CLASS_LET_BINDING, CLASS_MACRO_BINDING, CLASS_MATCHED_BINDING, CLASS_NORMAL_CONSTRUCTED_INSTANCE_BINDING, CLASS_NORMAL_CONSTRUCTED_LAMBDA_BINDING, CLASS_NORMAL_CONSTRUCTED_LIST_BINDING, CLASS_NORMAL_CONSTRUCTED_PAIR_BINDING, CLASS_NORMAL_CONSTRUCTED_TUPLE_BINDING, CLASS_NORMAL_CONSTRUCTOR_BINDING, CLASS_NORMAL_LET_BINDING, CLASS_PATMACRO_BINDING, CLASS_PRIMITIVE_BINDING, CLASS_SELECTOR_BINDING, CLASS_VALUE_BINDING.

class description: The CLASS_ANY_BINDING is the super-class of every binding. The BINDER field is the bound name. Bindings are added by module initializers. Don’t create bindings by instanciating this class in user code, they are created within the Melt translator.

1.3.4 CLASS_ANY_MATCHER

Class defined at file ‘warmelt-first.melt’, line 158.

3 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED.

5 fields:

2 sub-classes: CLASS_CMATCHER, CLASS_FUNMATCHER.

class description: The CLASS_ANY_MATCHER is the common super-class for matcher descriptors. The AMATCH_IN gives the formal input arguments, the AMATCH_MATCHBIND is the formal binding of the matched stuff, and AMATCH_OUT is the formal output arguments. Instances of sub-classes of CLASS_ANY_MATCHER are automagically created by macros like DEFCMATCHER and DEFUNMATCHER.

1.3.5 CLASS_CHILD_PROCESS_HANDLER

Class defined at file ‘warmelt-first.melt’, line 807.

2 ancestors: CLASS_ROOT CLASS_PROPED.

4 fields:

class description: Internal class for child process handling. CHILPROH_PID is the boxed pid, CHILPROH_CLOS is the boxed closure, CHILPROH_DATA is the client data.

1.3.6 CLASS_CITERATOR

Class defined at file ‘warmelt-first.melt’, line 141.

3 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED.

7 fields:

class description: The CLASS_CITERATOR is the class describing c-iterators. The formal start arguments are in the CITER_START_FORMALS field, the CITER_STATE field gives the state symbol, the CITER_BODY_FORMALS gives the formal body arguments, and the before and after expansions are CITER_EXPBEFORE and CITER_EXPAFTER. Instances of CLASS_CITERATOR are automagically created by the DEFCITERATOR macro.

1.3.7 CLASS_CITERATOR_BINDING

Class defined at file ‘warmelt-first.melt’, line 545.

3 ancestors: CLASS_ROOT CLASS_ANY_BINDING CLASS_FIXED_BINDING.

4 fields:

class description: The internal CLASS_CITERATOR_BINDING is for c-iterator bindings. See the DEFCITERATOR macro. The CBIND_CITERDEF gives the definition, and the CBIND_CITERATOR provides the c-iterator itself.

1.3.8 CLASS_CLASS

Class defined at file ‘warmelt-first.melt’, line 105.

4 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED CLASS_DISCRIMINANT.

8 fields:

class description: The CLASS_CLASS is the class of all classes - which are therefore discriminants. The CLASS_ANCESTORS field holds the sequence of ancestors. The CLASS_FIELDS gives the sequence of inherited and own fields. The CLASS_DATA is for class variables. Instances of CLASS_CLASS are automagically created by the DEFCLASS macro.

1.3.9 CLASS_CLASS_BINDING

Class defined at file ‘warmelt-first.melt’, line 577.

3 ancestors: CLASS_ROOT CLASS_ANY_BINDING CLASS_FIXED_BINDING.

4 fields:

class description: The internal CLASS_CLASS_BINDING is for class bindings. See the DEFCLASS macro. The definition is provided by CBIND_DEFCLASS, and the class itself is given by CBIND_CLASS. A class definition also define fields.

1.3.10 CLASS_CLONED_SYMBOL

Class defined at file ‘warmelt-first.melt’, line 264.

4 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED CLASS_SYMBOL.

4 fields:

class description: The CLASS_CLONED_SYMBOL is the sub-class of cloned symbols, e.g. like GENSYM-ed symbols is many Lisps. Cloned symbols are internally generated inside the MELT translator by the CLONE_SYMBOL function. Their CSYM_URANK field gives their unique rank as a boxed integer. Cloned symbols are not interned.

1.3.11 CLASS_CMATCHER

Class defined at file ‘warmelt-first.melt’, line 172.

4 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED CLASS_ANY_MATCHER.

9 fields:

class description: The CLASS_CMATCHER is the class for c-matcher descriptors. CMATCH_STATE is the state symbol, CMATCH_EXPTEST gives the expansion for testing in patterns, CMATCH_EXPFILL is the expansion for filling a matched pattern. CMATCH_EXPOPER is the expansion for operator uses. Instances of CLASS_CMATCHER are automagically created by the DEFCMATCHER macro.

1.3.12 CLASS_CMATCHER_BINDING

Class defined at file ‘warmelt-first.melt’, line 607.

3 ancestors: CLASS_ROOT CLASS_ANY_BINDING CLASS_FIXED_BINDING.

3 fields:

class description: The internal CLASS_CMATCHER_BINDING is for c-matcher bindings. See the DEFCMATCHER macro. The c-matcher is in CMBIND_MATCHER.

1.3.13 CLASS_CTYPE

Class defined at file ‘warmelt-first.melt’, line 288.

3 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED.

11 fields:

2 sub-classes: CLASS_CTYPE_GTY, CLASS_CTYPE_PLAIN.

class description: The CLASS_CTYPE is for predefined descriptors of C types (like long or tree). CTYPE_KEYWORD gives the associated keywords (for formal argument lists, etc...), CTYPE_CNAME gives the C identifier of the type. Parameter passing is described by CTYPE_PARCHAR (for the character) and CTYPE_PARSTRING (for the corresponding C string). Argument member in union is given by CTYPE_ARGFIELD, and by CTYPE_RESFIELD for results. The marking routine is CTYPE_MARKER and CTYPE_DESCR is some descriptive string or data. A possible alternate keyword is given by CTYPE_ALTKEYWORD. Adding new c-types requires an update of MELT runtime!

1.3.14 CLASS_CTYPE_GTY

Class defined at file ‘warmelt-first.melt’, line 328.

4 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED CLASS_CTYPE.

33 fields:

class description: The CLASS_CTYPE_GTY is a subclass of CLASS_CTYPE and describes C types which are GTY-ed, that is handled by the Ggc [the existing Gcc Garbage Collector].

1.3.15 CLASS_CTYPE_PLAIN

Class defined at file ‘warmelt-first.melt’, line 314.

4 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED CLASS_CTYPE.

13 fields:

class description: The CLASS_CTYPE_PLAIN is for predefined descriptors of plain c-types which are not GTY-ed so need a boxing and unboxing chunk. The CTYPP_BOXING is the name of a C function or macro getting the discriminant and the stuff and boxing them. The CTYPP_UNBOXING is the name of a C function or macro unboxing its value.

1.3.16 CLASS_C_GENERATION_CONTEXT

Class defined at file ‘warmelt-first.melt’, line 917.

1 ancestors: CLASS_ROOT.

10 fields:

2 sub-classes: CLASS_EXTENSION_GENERATION_CONTEXT, CLASS_INITIAL_GENERATION_CONTEXT.

class description: The internal CLASS_C_GENERATION_CONTEXT (for gurus) is the class of contexts for C code generation, while generating a single C routine. The containing object routine is GNCX_OBJROUT. The object map from normal bindings to local is given in GNCX_LOCMAP. The list of freed local value pointers is in GNCX_FREEPTRLIST. The list of free longs is in GNCX_FREELONGLIST. For other c-types, each c-type has its list, associated to it in GNCX_FREEOTHERMAPS. The return location is in GNCX_RETLOC. The cached map of procedures to compiled routines is in GNCX_COMPICACHE. The module compilation context is in GNCX_MODULCONTEXT. A map keyed by normal matchers to give a unique label prefix is in GNCX_MATCHMAP.

1.3.17 CLASS_DEBUG_INFORMATION

Class defined at file ‘warmelt-debug.melt’, line 39.

1 ancestors: CLASS_ROOT.

3 fields:

class description: The CLASS_DEBUG_INFORMATION is for debug information output, e.g. DEBUG_MSG macro. The produced output or buffer is DBGI_OUT, the occurrence map is DBGI_OCCMAP, used to avoid outputting twice the same object. The boxed maximal depth is DBGI_MAXDEPTH.

1.3.18 CLASS_DEFINED_VALUE_BINDING

Class defined at file ‘warmelt-first.melt’, line 568.

3 ancestors: CLASS_ROOT CLASS_ANY_BINDING CLASS_FIXED_BINDING.

3 fields:

class description: The internal CLASS_DEFINED_VALUE_BINDING is for defined values thru the DEFINE macro. DEFVALBIND_DEFINE provides the definition. FIXBIND_DATA gives a symbol occurrence in that case.

1.3.19 CLASS_DELAYED_QUEUE

Class defined at file ‘warmelt-first.melt’, line 3045.

3 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED.

5 fields:

class description: A class for named queues of delayed tasks. DELQU_FIRST is the list of actions to do first, DELQU_LAST those to do last.

1.3.20 CLASS_DESCRIBED_ENVIRONMENT

Class defined at file ‘warmelt-first.melt’, line 456.

2 ancestors: CLASS_ROOT CLASS_ENVIRONMENT.

4 fields:

class description: The CLASS_DESCRIBED_ENVIRONMENT provides an extra descriptor DENV_DESCR which can for example be a descriptive string.

1.3.21 CLASS_DISCRIMINANT

Class defined at file ‘warmelt-first.melt’, line 92.

3 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED.

5 fields:

1 sub-classes: CLASS_CLASS.

class description: The CLASS_DISCRIMINANT is the class of every discriminant. It has the method dictionnary DISC_METHODICT and the super-discriminant DISC_SUPER. The DISC_SENDER can hold a closure doing the send if the selector is not found. Otherwise, the default is to send thru the super-discriminant.

1.3.22 CLASS_ENVIRONMENT

Class defined at file ‘warmelt-first.melt’, line 442.

1 ancestors: CLASS_ROOT.

3 fields:

1 sub-classes: CLASS_DESCRIBED_ENVIRONMENT.

class description: The CLASS_ENVIRONMENT reifies environments. The binding map is ENV_BIND, the previous environment is ENV_PREV, and the procedure if any of this environment is ENV_PROC. It is heavily used within the MELT translator. Module initialization produces fresh instances of it. See the CURRENT_MODULE_ENVIRONMENT_CONTAINER and PARENT_MODULE_ENVIRONMENT macros.

1.3.23 CLASS_EXPORTED_BINDING

Class defined at file ‘warmelt-first.melt’, line 473.

2 ancestors: CLASS_ROOT CLASS_ANY_BINDING.

1 fields:

3 sub-classes: CLASS_MACRO_BINDING, CLASS_PATMACRO_BINDING, CLASS_VALUE_BINDING.

class description: The CLASS_EXPORTED_BINDING is the super-class of exported bindings.

1.3.24 CLASS_EXTENSION_GENERATION_CONTEXT

Class defined at file ‘warmelt-first.melt’, line 964.

3 ancestors: CLASS_ROOT CLASS_C_GENERATION_CONTEXT CLASS_INITIAL_GENERATION_CONTEXT.

16 fields:

class description: The internal CLASS_EXTENSION_GENERATION_CONTEXT (for gurus) is used when generating the initial routine of an extension, i.e. for runtime evaluation of expressions. EGNCX_VALOCLIST is the list of literal values stack locations, and EGNCX_LITVALTUPLOC is the stack location for the literal values tuple.

1.3.25 CLASS_FIELD

Class defined at file ‘warmelt-first.melt’, line 118.

3 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED.

4 fields:

class description: The CLASS_FIELD is the class of every field. Its objnum is its offset. Its FLD_OWNCLASS is the class owning that field. The FLD_DATA is for additional data. Instances of CLASS_FIELD are automagically created by the DEFCLASS macro.

1.3.26 CLASS_FIELD_BINDING

Class defined at file ‘warmelt-first.melt’, line 588.

3 ancestors: CLASS_ROOT CLASS_ANY_BINDING CLASS_FIXED_BINDING.

4 fields:

class description: The internal CLASS_FIELD_BINDING is for field bindings. See the DEFCLASS macro. The class binding is FLBIND_CLABIND, and the defined field is FLBIND_FIELD.

1.3.27 CLASS_FIXED_BINDING

Class defined at file ‘warmelt-first.melt’, line 515.

2 ancestors: CLASS_ROOT CLASS_ANY_BINDING.

2 fields:

10 sub-classes: CLASS_CITERATOR_BINDING, CLASS_CLASS_BINDING, CLASS_CMATCHER_BINDING, CLASS_DEFINED_VALUE_BINDING, CLASS_FIELD_BINDING, CLASS_FUNCTION_BINDING, CLASS_FUNMATCHER_BINDING, CLASS_INSTANCE_BINDING, CLASS_PRIMITIVE_BINDING, CLASS_SELECTOR_BINDING.

class description: The internal CLASS_FIXED_BINDING is a super-class of bindings inside a compilation unit. The data description is inside FIXBIND_DATA. Fixed bindings are internal to the translator.

1.3.28 CLASS_FORMAL_BINDING

Class defined at file ‘warmelt-first.melt’, line 502.

2 ancestors: CLASS_ROOT CLASS_ANY_BINDING.

2 fields:

class description: The CLASS_FORMAL_BINDING is the class of formal argument bindings [like in defun lambda defprimitive defciterator etc..]. The FBIND_TYPE gives the formal’s c-type. The object’s number is the argument rank.

1.3.29 CLASS_FUNCTION_BINDING

Class defined at file ‘warmelt-first.melt’, line 557.

3 ancestors: CLASS_ROOT CLASS_ANY_BINDING CLASS_FIXED_BINDING.

3 fields:

class description: The internal CLASS_FUNCTION_BINDING is for function bindings. See the DEFUN macro. The FUBIND_DEFUN provides the definition.

1.3.30 CLASS_FUNMATCHER

Class defined at file ‘warmelt-first.melt’, line 191.

4 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED CLASS_ANY_MATCHER.

8 fields:

class description: The CLASS_FUNMATCHER describes fun-matchers. FMATCH_MATCHF is the matching function -for patterns. FMATCH_APPLYF is the applying function -for expressions. FMATCH_DATA is some additional client data. Instances of CLASS_FUNMATCHER are automagically created by the DEFUNMATCHER macro.

1.3.31 CLASS_FUNMATCHER_BINDING

Class defined at file ‘warmelt-first.melt’, line 617.

3 ancestors: CLASS_ROOT CLASS_ANY_BINDING CLASS_FIXED_BINDING.

4 fields:

class description: The internal CLASS_FUNMATCHER_BINDING is for funmatcher bindings. See the DEFUNMATCHER macro. The funmatcher is in FMBIND_FUNMATCHER and its definition in FMBIND_DEFUNMATCHER.

1.3.32 CLASS_GCC_ANY_IPA_PASS

Class defined at file ‘warmelt-first.melt’, line 737.

4 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED CLASS_GCC_PASS.

10 fields:

2 sub-classes: CLASS_GCC_SIMPLE_IPA_PASS, CLASS_GCC_TRANSFORM_IPA_PASS.

class description: The CLASS_GCC_ANY_IPA_PASS is the common class for every GCC inter procedural analysis [IPA] pass descriptors.

1.3.33 CLASS_GCC_GIMPLE_PASS

Class defined at file ‘warmelt-first.melt’, line 722.

4 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED CLASS_GCC_PASS.

10 fields:

class description: The CLASS_GCC_GIMPLE_PASS is for GCC gimple pass descriptors.

1.3.34 CLASS_GCC_PASS

Class defined at file ‘warmelt-first.melt’, line 691.

3 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED.

10 fields:

5 sub-classes: CLASS_GCC_ANY_IPA_PASS, CLASS_GCC_GIMPLE_PASS, CLASS_GCC_RTL_PASS, CLASS_GCC_SIMPLE_IPA_PASS, CLASS_GCC_TRANSFORM_IPA_PASS.

class description: The CLASS_GCC_PASS is the super-class of GCC compiler passes descriptors, as provided in MELT. Once correctly instanciated, such a pass descriptor should be registered thru the INSTALL_MELT_GCC_PASS primitive. Pass descriptors are named (be careful to give a unique unused name!). The GCCPASS_GATE is the pass gate function. The GCCPASS_EXEC is the pass execution function. The field GCCPASS_DATA can be used for client data. The fields GCCPASS_PROPERTIES_REQUIRED GCCPASS_PROPERTIES_PROVIDED GCCPASS_PROPERTIES_DESTROYED GCCPASS_TODO_FLAGS_START GCCPASS_TODO_FLAGS_FINISH are like their counterparts in C, and can be a boxed integer, a string or named [i.e. symbol], or a tuple or list of them.

1.3.35 CLASS_GCC_PRAGMA

Class defined at file ‘warmelt-first.melt’, line 674.

3 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED.

4 fields:

class description: The CLASS_GCC_PRAGMA is for objects describing GCC pragmas, as provided by MELT code. Once correctly instanciated, such a pragma descriptor should be registered thru the INSTALL_MELT_GCC_PRAGMA primitive. MELT pragmas are named, and all belong to the same MELT pragma namespace. C code using them will use: #pragma MELT name ... and the name there is the string given by the NAMED_NAME field of the pragma descriptor.

1.3.36 CLASS_GCC_RTL_PASS

Class defined at file ‘warmelt-first.melt’, line 729.

4 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED CLASS_GCC_PASS.

10 fields:

class description: The CLASS_GCC_RTL_PASS is for GCC RTL pass descriptors.

1.3.37 CLASS_GCC_SIMPLE_IPA_PASS

Class defined at file ‘warmelt-first.melt’, line 743.

5 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED CLASS_GCC_PASS CLASS_GCC_ANY_IPA_PASS.

10 fields:

class description: The CLASS_GCC_SIMPLE_IPA_PASS is for GCC simple IPA pass descriptors.

1.3.38 CLASS_GCC_TRANSFORM_IPA_PASS

Class defined at file ‘warmelt-first.melt’, line 750.

5 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED CLASS_GCC_PASS CLASS_GCC_ANY_IPA_PASS.

13 fields:

class description: The CLASS_GCC_TRANSFORM_IPA_PASS is for GCC full IPA pass descriptors which don’t read or write any LTO information but are plain transforming IPA passes.

1.3.39 CLASS_GENERATED_C_CODE

Class defined at file ‘warmelt-first.melt’, line 977.

1 ancestors: CLASS_ROOT.

class description: The super-class CLASS_GENERATED_C_CODE is a common super-class for representing generated C abstract syntax trees inside the MELT translator. Within MELT, it has nothing in common with GCC compiled C abstract syntax trees (that is :tree and :gimple).

1.3.40 CLASS_INITIAL_GENERATION_CONTEXT

Class defined at file ‘warmelt-first.melt’, line 947.

2 ancestors: CLASS_ROOT CLASS_C_GENERATION_CONTEXT.

14 fields:

1 sub-classes: CLASS_EXTENSION_GENERATION_CONTEXT.

class description: The internal CLASS_INITIAL_GENERATION_CONTEXT (for gurus) is used when generating the initial routine of a module, which builds the current environment and evaluates the module toplevel expressions. The IGNCX_PREVENVLOC is the local stack slot for the parent environment. The IGNCX_CONTENVLOC is the local for the container of the current module’s environment. The list of routines using it is in IGNCX_PROCURMODENVLIST. The mapping of imported symbolts to locals is IGNCX_IMPORTMAP.

1.3.41 CLASS_INPUT_CHANNEL_HANDLER

Class defined at file ‘warmelt-first.melt’, line 780.

2 ancestors: CLASS_ROOT CLASS_PROPED.

4 fields:

class description: Internal class for input channel handling. Its magic number is the file descriptor. INCH_SBUF is the read-only string-buffer for the input, INCH_CLOS is a closure, and INCH_DATA is some client data. See also REGISTER_INPUT_CHANNEL_HANDLER. Use carefully, and don’t mutate it. All fields should be considered read-only from application code, which is only permitted to use INCH_DATA and mutate it.

1.3.42 CLASS_INSTANCE_BINDING

Class defined at file ‘warmelt-first.melt’, line 598.

3 ancestors: CLASS_ROOT CLASS_ANY_BINDING CLASS_FIXED_BINDING.

3 fields:

class description: The internal CLASS_INSTANCE_BINDING is for instance bindings. See the DEFINSTANCE macro. The instance’s class is in IBIND_ICLASS.

1.3.43 CLASS_KEYWORD

Class defined at file ‘warmelt-first.melt’, line 275.

4 ancestors: CLASS_ROOT CLASS_PROPED CLASS_NAMED CLASS_SYMBOL.

3 fields:

class description: The CLASS_KEYWORD is the sub-class of keywords, that is symbols starting with a colon, which are handled specially and implicitly quoted. Most ctypes are denoted by such keywords like :long :value etc. The reader parses as keyword any symbol starting with a colon. Keywords are interned inside the INITIAL_SYSTEM_DATA.

1.3.44 CLASS_LABEL_BINDING

Class defined at file ‘warmelt-first.melt’, line 658.

2 ancestors: CLASS_ROOT CLASS_ANY_BINDING.

4 fields:

class description: The internal CLASS_LABEL_BINDING is for labels. See The FOREVER and EXIT macros. The label source location is LABIND_LOC, the cloned symbol unique to the label is LABIND_CLONSY. The local variables for the result is LABIND_RES.

1.3.45 CLASS_LETREC_BINDING

Class defined at file ‘warmelt-first.melt’, line 640.

3 ancestors: CLASS_ROOT CLASS_ANY_BINDING CLASS_LET_BINDING.

4 fields:

class description: The internal CLASS_LETREC_BINDING is for internal letrec bindings. See the LETREC macro. The bound expression should be recursively constructible (like LAMBDA TUPLE LIST INSTANCE ...)

1.3.46 CLASS_LET_BINDING

Class defined at file ‘warmelt-first.melt’, line 627.

2 ancestors: CLASS_ROOT CLASS_ANY_BINDING.

4 fields:

2 sub-classes: CLASS_LETREC_BINDING, CLASS_NORMAL_LET_BINDING.

class description: The internal CLASS_LET_BINDING is for internal let bindings. See The LET macro and also the CLASS_NORMAL_LET_BINDING. The c-type of the bound valus is LETBIND_TYPE, the expression is LETBIND_EXPR, the source location if any is LEBIND_LOC.

1.3.47 CLASS_LITERAL_VALUE

Class defined at file ‘warmelt-normal.melt’, line 858.

2 ancestors: CLASS_ROOT CLASS_PROPED.

4 fields:

class description: CLASS_LITERAL_VALUE is the class managing literal values in runtime extension modules. LITV_VALUE is the literal value itself LITV_RANK is its unique rank in the extension module LITV_LOC may contain its stack location