Utility functions for generating the code in the synoptic module.

• §1. Dealing with symbols
• §4. Making textual constants
• §5. Making functions
• §7. Making arrays

§1. Dealing with symbols. We are going to need to read and write these: for reading —

inter_symbol *Synoptic::get_symbol?Usage of Synoptic::get_symbol:
Kinds - §1.4
Tests - §1.1(inter_package *pack, text_stream *name) {
    inter_symbol *loc_s =
        InterSymbolsTable::symbol_from_name(InterPackage::scope(pack), name);
    if (loc_s == NULL) Metadata::err("package symbol not found", pack, name);
    return loc_s;
}

inter_tree_node *Synoptic::get_definition?Usage of Synoptic::get_definition:
Extensions - §1.1
Responses - §1.1
Rules - §1.1
Activities - §1.1
Actions - §1.1
Properties - §1.1
Relations - §1.1
Tables - §1, §1.1, §1.2, §1.6
Chronology - §1.1, §1.2
Use Options - §1.1(inter_package *pack, text_stream *name) {
    inter_symbol *def_s = InterSymbolsTable::symbol_from_name(InterPackage::scope(pack), name);
    if (def_s == NULL) {
        LOG("Unable to find symbol %S in $6\n", name, pack);
        internal_error("no symbol");
    }
    inter_tree_node *D = def_s->definition;
    if (D == NULL) {
        LOG("Undefined symbol %S in $6\n", name, pack);
        internal_error("undefined symbol");
    }
    return D;
}

§2. To clarify: here, the symbol is optional, that is, need not exist; but if it does exist, it must have a definition, and we return that.

inter_symbol *Synoptic::get_optional_symbol(inter_package *pack, text_stream *name) {
    return InterSymbolsTable::symbol_from_name(InterPackage::scope(pack), name);
}

inter_tree_node *Synoptic::get_optional_definition?Usage of Synoptic::get_optional_definition:
Activities - §1.1
Actions - §1.1
Tables - §1.6(inter_package *pack, text_stream *name) {
    inter_symbol *def_s = InterSymbolsTable::symbol_from_name(InterPackage::scope(pack), name);
    if (def_s == NULL) return NULL;
    inter_tree_node *D = def_s->definition;
    if (D == NULL) internal_error("undefined symbol");
    return D;
}

§3. And this creates a new symbol:

inter_symbol *Synoptic::new_symbol?Usage of Synoptic::new_symbol:
Literal Text - §1.1, §1.2(inter_package *pack, text_stream *name) {
    return InterSymbolsTable::create_with_unique_name(InterPackage::scope(pack), name);
}

§4. Making textual constants.

void Synoptic::textual_constant?Usage of Synoptic::textual_constant:
Literal Text - §1.1(inter_tree *I, pipeline_step *step,
    inter_symbol *con_s, text_stream *S, inter_bookmark *IBM) {
    Produce::guard(ConstantInstruction::new(IBM, con_s,
        LargeScale::text_literal_type(I), InterValuePairs::from_text(IBM, S),
        (inter_ti) InterBookmark::baseline(IBM) + 1, NULL));
}

§5. Making functions.

inter_package *synoptic_fn_package = NULL;
packaging_state synoptic_fn_ps;
void Synoptic::begin_function?Usage of Synoptic::begin_function:
Extensions - §1.2, §1.3, §1.4
Responses - §1.5
Rules - §1.6, §1.7, §1.8
Actions - §1.7
Instances - §1.1
Kinds - §1.4, §1.5, §1.6
Relations - §1.3, §1.4, §1.5
Tables - §1.4, §1.5
Chronology - §1.8
Scenes - §1.1, §1.2
Use Options - §1.3, §1.4
Tests - §1.1(inter_tree *I, inter_name *iname) {
    synoptic_fn_package = Produce::function_body(I, &synoptic_fn_ps, iname);
}
void Synoptic::end_function?Usage of Synoptic::end_function:
Extensions - §1.2, §1.3, §1.4
Responses - §1.5
Rules - §1.6, §1.7, §1.8
Actions - §1.7
Instances - §1.1
Kinds - §1.4, §1.5, §1.6
Relations - §1.3, §1.4, §1.5
Tables - §1.4, §1.5
Chronology - §1.8
Scenes - §1.1, §1.2
Use Options - §1.3, §1.4
Tests - §1.1(inter_tree *I, pipeline_step *step, inter_name *iname) {
    Produce::end_function_body(I);
    Packaging::exit(I, synoptic_fn_ps);
}

§6. To give such a function a local:

inter_symbol *Synoptic::local?Usage of Synoptic::local:
Extensions - §1.4
Responses - §1.5
Rules - §1.6, §1.7, §1.8
Actions - §1.7
Instances - §1.1
Kinds - §1.4, §1.5, §1.6
Relations - §1.4, §1.5
Tables - §1.4, §1.5
Chronology - §1.8
Scenes - §1.2
Use Options - §1.3, §1.4(inter_tree *I, text_stream *name, text_stream *comment) {
    return Produce::local(I, K_value, name, comment);
}

§7. Making arrays.

inter_tree_node *synoptic_array_node = NULL;
packaging_state synoptic_array_ps;

void Synoptic::begin_array?Usage of Synoptic::begin_array:
Responses - §1.3, §1.4
Rules - §1.3, §1.4, §1.5
Activities - §1.2, §1.3, §1.4, §1.5
Actions - §1.4, §1.5
Dialogue - §1.1, §1.2, §1.3
Kinds - §1.3, §1.8
Tables - §1.3
Chronology - §1.7
Multimedia - §1.1, §1.2, §1.4, §1.6
Use Options - §1.5
Verbs - §1.2(inter_tree *I, pipeline_step *step, inter_name *iname) {
    Synoptic::begin_array_inner(I, step, iname, CONST_LIST_FORMAT_WORDS);
}

void Synoptic::begin_bounded_array?Usage of Synoptic::begin_bounded_array:
Actions - §1.6
Chronology - §1.5, §1.6(inter_tree *I, pipeline_step *step, inter_name *iname) {
    Synoptic::begin_array_inner(I, step, iname, CONST_LIST_FORMAT_B_WORDS);
}

void Synoptic::begin_byte_array?Usage of Synoptic::begin_byte_array:
Activities - §1.6
Tables - §1.6(inter_tree *I, pipeline_step *step, inter_name *iname) {
    Synoptic::begin_array_inner(I, step, iname, CONST_LIST_FORMAT_BYTES);
}

void Synoptic::begin_array_inner(inter_tree *I, pipeline_step *step, inter_name *iname,
    inter_ti format) {
    synoptic_array_ps = Packaging::enter_home_of(iname);
    inter_symbol *con_s = InterNames::to_symbol(iname);
    inter_ti TID = InterTypes::to_TID(InterBookmark::scope(Packaging::at(I)),
        InterTypes::from_constructor_code(LIST_ITCONC));
    synoptic_array_node = Inode::new_with_3_data_fields(Packaging::at(I), CONSTANT_IST,
         InterSymbolsTable::id_at_bookmark(Packaging::at(I), con_s),
         TID, format, NULL,
         (inter_ti) InterBookmark::baseline(Packaging::at(I)) + 1);
}

void Synoptic::end_array?Usage of Synoptic::end_array:
Responses - §1.3, §1.4
Rules - §1.3, §1.4, §1.5
Activities - §1.2, §1.3, §1.4, §1.5, §1.6
Actions - §1.4, §1.5, §1.6
Dialogue - §1.1, §1.2, §1.3
Kinds - §1.3, §1.8
Tables - §1.3, §1.6
Chronology - §1.5, §1.6, §1.7
Multimedia - §1.1, §1.2, §1.4, §1.6
Use Options - §1.5
Verbs - §1.2(inter_tree *I) {
    inter_error_message *E = VerifyingInter::instruction(
        InterBookmark::package(Packaging::at(I)), synoptic_array_node);
    if (E) {
        InterErrors::issue(E);
        internal_error("synoptic array failed verification");
    }
    NodePlacement::move_to_moving_bookmark(synoptic_array_node, Packaging::at(I));
    Packaging::exit(I, synoptic_array_ps);
}

§8. Three ways to define an entry:

void Synoptic::numeric_entry?Usage of Synoptic::numeric_entry:
Responses - §1.3, §1.4
Rules - §1.3, §1.4, §1.5
Activities - §1.5, §1.6
Actions - §1.4, §1.5, §1.6
Dialogue - §1.1, §1.2, §1.3
Kinds - §1.3, §1.3.2, §1.3.3, §1.3.4, §1.3.5, §1.3.6, §1.3.7, §1.3.8, §1.3.9, §1.3.10, §1.3.11, §1.3.12, §1.3.13, §1.3.14, §1.3.15, §1.3.16, §1.3.17, §1.3.18, §1.3.19, §1.8
Tables - §1.3, §1.6
Chronology - §1.5, §1.6, §1.7
Multimedia - §1.1, §1.2, §1.4, §1.6
Use Options - §1.5
Verbs - §1.2(inter_ti N) {
    Inode::extend_instruction_by(synoptic_array_node, 2);
    InterValuePairs::set(synoptic_array_node, synoptic_array_node->W.extent-2,
        InterValuePairs::number(N));
}
void Synoptic::symbol_entry?Usage of Synoptic::symbol_entry:
Responses - §1.3
Rules - §1.4, §1.5
Activities - §1.2, §1.3, §1.4, §1.5
Actions - §1.5, §1.6
Dialogue - §1.1, §1.2, §1.3
Kinds - §1.3.1, §1.3.2, §1.3.3, §1.3.4, §1.3.5, §1.3.8, §1.3.9, §1.3.10, §1.3.11, §1.3.12, §1.3.13, §1.3.14, §1.3.15, §1.3.17, §1.3.18, §1.3.19, §1.8
Tables - §1.3
Chronology - §1.5, §1.7
Multimedia - §1.4, §1.6
Verbs - §1.2(inter_symbol *S) {
    Inode::extend_instruction_by(synoptic_array_node, 2);
    inter_package *pack = InterPackage::container(synoptic_array_node);
    inter_symbol *local_S = InterSymbolsTable::create_with_unique_name(
        InterPackage::scope(pack), InterSymbol::identifier(S));
    Wiring::wire_to(local_S, S);
    InterValuePairs::set(synoptic_array_node, synoptic_array_node->W.extent-2,
        InterValuePairs::symbolic_in(pack, local_S));
}
void Synoptic::textual_entry?Usage of Synoptic::textual_entry:
Responses - §1.4
Rules - §1.3(text_stream *text) {
    inter_tree *I = Inode::tree(synoptic_array_node);
    Inode::extend_instruction_by(synoptic_array_node, 2);
    InterValuePairs::set(synoptic_array_node, synoptic_array_node->W.extent-2,
        InterValuePairs::from_text(Packaging::at(I), text));
}