To manage named symbols in inter code.

• §1. Symbols themselves

§1. Symbols themselves.

typedef struct inter_symbol {
    inter_t symbol_ID;
    struct inter_symbols_table *owning_table;
    struct text_stream *symbol_name;
    struct inter_tree_node *definition;
    struct inter_symbol *equated_to;
    struct text_stream *equated_name;
    int symbol_status;
    struct inter_annotation_set ann_set;
    struct text_stream *translate_text;
    int link_time;
    struct inter_symbol *linked_to;
} inter_symbol;

• The structure inter_symbol is accessed in 2/st, 2/cnn, 2/trn, 3/iibf, 3/iitf, 3/vi, 3/idt, 4/tmc, 4/tpc, 4/tac, 4/tpc2, 4/tpc3, 4/tkc, 4/tdc, 4/tvc2, 4/tcc2, 4/trc, 4/tic, 4/tpc4, 4/tpc5, 4/tpc6, 4/tpc7, 5/tlc, 5/tlc2, 5/tic, 5/trc, 5/tvc, 5/tlc3, 5/tcc2 and here.

§2.

inter_symbol *Inter::Symbols::new?Usage of Inter::Symbols::new:
Symbols Tables - §3(text_stream *name, inter_symbols_table *T, inter_t ID) {
    if (Str::len(name) == 0) internal_error("symbol cannot have empty text as identifier");

    inter_symbol *symb = CREATE(inter_symbol);
    symb->owning_table = T;
    symb->symbol_ID = ID;
    symb->symbol_status = 0;
    Inter::Symbols::set_type(symb, MISC_ISYMT);
    Inter::Symbols::set_scope(symb, PUBLIC_ISYMS);
    symb->symbol_name = Str::duplicate(name);
    Inter::Symbols::undefine(symb);
    symb->ann_set = Inter::Annotations::new_set();
    symb->equated_to = NULL;
    symb->equated_name = NULL;
    symb->translate_text = NULL;
    symb->link_time = 0;
    symb->linked_to = NULL;
    LOGIF(INTER_SYMBOLS, "Created symbol $3 in $4\n", symb, T);

    return symb;
}

int Inter::Symbols::get_type?Usage of Inter::Symbols::get_type:
§4, §5
Inter in Binary Files - §1.1.3.2
The Local Construct - §2(inter_symbol *S) {
    return S->symbol_status & SYMBOL_TYPE_MASK_ISYMT;
}

int Inter::Symbols::get_scope?Usage of Inter::Symbols::get_scope:
§4, §5
Symbols Tables - §10
Connectors - §1
Transmigration - §1, §.1, §3
Inter in Binary Files - §1.4.2, §1.1.3.2
The Symbol Construct - §1
The Local Construct - §2(inter_symbol *S) {
    return S->symbol_status & SYMBOL_SCOPE_MASK_ISYMT;
}

void Inter::Symbols::set_type?Usage of Inter::Symbols::set_type:
§5
Symbols Tables - §10
Inter in Binary Files - §1.4.2
The Symbol Construct - §1(inter_symbol *S, int V) {
    S->symbol_status = S->symbol_status - (S->symbol_status & SYMBOL_TYPE_MASK_ISYMT) + V;
}

void Inter::Symbols::set_scope?Usage of Inter::Symbols::set_scope:
§5
Symbols Tables - §10
Inter in Binary Files - §1.4.2
The Symbol Construct - §1(inter_symbol *S, int V) {
    S->symbol_status = S->symbol_status - (S->symbol_status & SYMBOL_SCOPE_MASK_ISYMT) + V;
}

void Inter::Symbols::log?Usage of Inter::Symbols::log:
Bytecode Module - §3.6(OUTPUT_STREAM, void *vs) {
    inter_symbol *S = (inter_symbol *) vs;
    if (S == NULL) WRITE("<no-symbol>");
    else {
        Inter::SymbolsTables::symbol_to_url_name(DL, S);
        WRITE("{%d}", S->symbol_ID - SYMBOL_BASE_VAL);
        if (Str::len(S->translate_text) > 0) WRITE("'%S'", S->translate_text);
    }
}

int Inter::Symbols::sort_number(const inter_symbol *S) {
    if (S == NULL) return 0;
    return 100000 * (S->owning_table->allocation_id) + (int) (S->symbol_ID);
}

§3.

int Inter::Symbols::is_stored_in_data(inter_t val1, inter_t val2) {
    if (val1 == ALIAS_IVAL) return TRUE;
    return FALSE;
}

void Inter::Symbols::to_data?Usage of Inter::Symbols::to_data:
Inter Data Types - §3
The Constant Construct - §2
The Response Construct - §2
The Val Construct - §2(inter_tree *I, inter_package *pack, inter_symbol *S, inter_t *val1, inter_t *val2) {
    if (S == NULL) internal_error("no symbol");
    *val1 = ALIAS_IVAL; *val2 = Inter::SymbolsTables::id_from_symbol(I, pack, S);
}

§4.

void Inter::Symbols::write_declaration?Usage of Inter::Symbols::write_declaration:
Symbols Tables - §3(OUTPUT_STREAM, inter_symbol *mark, int N) {
    for (int L=0; L<N; L++) WRITE("\t");
    WRITE("symbol ");
    switch (Inter::Symbols::get_scope(mark)) {
        case PRIVATE_ISYMS: WRITE("private"); break;
        case PUBLIC_ISYMS: WRITE("public"); break;
        case EXTERNAL_ISYMS: WRITE("external"); break;
        case PLUG_ISYMS: WRITE("plug"); break;
        case SOCKET_ISYMS: WRITE("socket"); break;
        default: internal_error("unknown symbol type"); break;
    }
    WRITE(" ");
    switch (Inter::Symbols::get_type(mark)) {
        case LABEL_ISYMT: WRITE("label"); break;
        case MISC_ISYMT: WRITE("misc"); break;
        case PACKAGE_ISYMT: WRITE("package"); break;
        case PTYPE_ISYMT: WRITE("packagetype"); break;
        default: internal_error("unknown symbol type"); break;
    }
    WRITE(" %S", mark->symbol_name);
    if (Inter::Symbols::get_flag(mark, MAKE_NAME_UNIQUE)) WRITE("*");
    if (Str::len(mark->equated_name) > 0) {
        WRITE(" --? %S", mark->equated_name);
    }
    text_stream *trans_name = Inter::Symbols::get_translate(mark);
    if (Str::len(trans_name) > 0)
        WRITE(" `%S`", trans_name);
    inter_symbol *eq = mark->equated_to;
    if (eq) {
        WRITE(" --> ");
        Inter::SymbolsTables::symbol_to_url_name(OUT, eq);
    }
}

void Inter::Symbols::define?Usage of Inter::Symbols::define:
Verifying Inter - §1(inter_symbol *S, inter_tree_node *P) {
    if (S == NULL) internal_error("tried to define null symbol");
    S->definition = P;
}

inter_tree_node *Inter::Symbols::definition?Usage of Inter::Symbols::definition:
Packages - §3
Inter in Text Files - §1
Verifying Inter - §1
Inter Data Types - §2, §3
The Package Construct - §2
The Kind Construct - §2
The Variable Construct - §2
The Constant Construct - §2
The Instance Construct - §2
The Property Construct - §2
The Primitive Construct - §2
The Local Construct - §2
The Inv Construct - §2(inter_symbol *S) {
    if (S == NULL) internal_error("tried to find definition of null symbol");
    return S->definition;
}

int Inter::Symbols::is_defined?Usage of Inter::Symbols::is_defined:
§5
Packages - §3
Transmigration - §1
Inter in Text Files - §1
Verifying Inter - §1(inter_symbol *S) {
    if (S == NULL) return FALSE;
    if (Inter::Symbols::definition(S)) return TRUE;
    return FALSE;
}

int Inter::Symbols::evaluate_to_int(inter_symbol *S) {
    inter_tree_node *P = Inter::Symbols::definition(S);
    if ((P) &&
        (P->W.data[ID_IFLD] == CONSTANT_IST) &&
        (P->W.data[FORMAT_CONST_IFLD] == CONSTANT_DIRECT) &&
        (P->W.data[DATA_CONST_IFLD] == LITERAL_IVAL)) {
        return (int) P->W.data[DATA_CONST_IFLD + 1];
    }
    if ((P) &&
        (P->W.data[ID_IFLD] == CONSTANT_IST) &&
        (P->W.data[FORMAT_CONST_IFLD] == CONSTANT_DIRECT) &&
        (P->W.data[DATA_CONST_IFLD] == ALIAS_IVAL)) {
        inter_symbols_table *scope = S->owning_table;
        inter_symbol *alias_to = Inter::SymbolsTables::symbol_from_id(scope, P->W.data[DATA_CONST_IFLD + 1]);
        return Inter::Symbols::evaluate_to_int(alias_to);
    }
    return -1;
}

void Inter::Symbols::strike_definition(inter_symbol *S) {
    if (S) {
        inter_tree_node *D = Inter::Symbols::definition(S);
        if (D) Inter::Tree::remove_node(D);
        Inter::Symbols::undefine(S);
    }
}

void Inter::Symbols::remove_from_table(inter_symbol *S) {
    int index = (int) S->symbol_ID - (int) SYMBOL_BASE_VAL;
    S->owning_table->symbol_array[index] = NULL;
}

void Inter::Symbols::undefine?Usage of Inter::Symbols::undefine:
§2
Inter in Text Files - §1(inter_symbol *S) {
    if (S == NULL) internal_error("tried to undefine null symbol");
    S->definition = NULL;
}

void Inter::Symbols::clear_transient_flags(inter_symbol *symb) {
    symb->symbol_status = (symb->symbol_status) & NONTRANSIENT_SYMBOL_BITS;
}

int Inter::Symbols::get_flag?Usage of Inter::Symbols::get_flag:
Inter in Binary Files - §1.1.3.2(inter_symbol *symb, int f) {
    if (symb == NULL) internal_error("no symbol");
    return (symb->symbol_status & f)?TRUE:FALSE;
}

void Inter::Symbols::set_flag?Usage of Inter::Symbols::set_flag:
Inter in Binary Files - §1.4.2
The Symbol Construct - §1(inter_symbol *symb, int f) {
    if (symb == NULL) internal_error("no symbol");
    symb->symbol_status = symb->symbol_status | f;
}

void Inter::Symbols::clear_flag(inter_symbol *symb, int f) {
    if (symb == NULL) internal_error("no symbol");
    if (symb->symbol_status & f) symb->symbol_status = symb->symbol_status - f;
}

void Inter::Symbols::set_translate?Usage of Inter::Symbols::set_translate:
Inter in Binary Files - §1.4.2
The Symbol Construct - §1(inter_symbol *symb, text_stream *S) {
    if (symb == NULL) internal_error("no symbol");
    symb->translate_text = Str::duplicate(S);
}

text_stream *Inter::Symbols::get_translate(inter_symbol *symb) {
    if (symb == NULL) internal_error("no symbol");
    return symb->translate_text;
}

void Inter::Symbols::annotate?Usage of Inter::Symbols::annotate:
Annotations - §2
Inter in Binary Files - §1.4.2(inter_symbol *symb, inter_annotation IA) {
    if (symb == NULL) internal_error("annotated null symbol");
    Inter::Annotations::add_to_set(&(symb->ann_set), IA);
}

void Inter::Symbols::annotate_i(inter_symbol *symb, inter_t annot_ID, inter_t n) {
    inter_annotation IA = Inter::Annotations::from_bytecode(annot_ID, n);
    Inter::Symbols::annotate(symb, IA);
}

int Inter::Symbols::read_annotation?Usage of Inter::Symbols::read_annotation:
Transmigration - §3(const inter_symbol *symb, inter_t ID) {
    inter_annotation *IA = Inter::Annotations::find(&(symb->ann_set), ID);
    if (IA) return (int) IA->annot_value;
    return -1;
}

text_stream *Inter::Symbols::read_annotation_t(inter_symbol *symb, inter_tree *I, inter_t ID) {
    inter_annotation *IA = Inter::Annotations::find(&(symb->ann_set), ID);
    if (IA) return Inter::Warehouse::get_text(Inter::Tree::warehouse(I), IA->annot_value);
    return NULL;
}

void Inter::Symbols::annotate_t?Usage of Inter::Symbols::annotate_t:
The Append Construct - §2(inter_tree *I, inter_package *owner, inter_symbol *symb, inter_t annot_ID, text_stream *S) {
    inter_t n = Inter::Warehouse::create_text(Inter::Tree::warehouse(I), owner);
    Str::copy(Inter::Warehouse::get_text(Inter::Tree::warehouse(I), n), S);
    inter_annotation IA = Inter::Annotations::from_bytecode(annot_ID, n);
    Inter::Symbols::annotate(symb, IA);
}

void Inter::Symbols::write_annotations?Usage of Inter::Symbols::write_annotations:
The Kind Construct - §2
The Variable Construct - §2
The Constant Construct - §2
The Instance Construct - §2
The Property Construct - §2
The Local Construct - §2(OUTPUT_STREAM, inter_tree_node *F, inter_symbol *symb) {
    if (symb) Inter::Annotations::write_set(OUT, &(symb->ann_set), F);
}

void Inter::Symbols::transpose_annotations(inter_symbol *symb, inter_t *grid, inter_t grid_extent, inter_error_message **E) {
    if (symb) Inter::Annotations::transpose_set(&(symb->ann_set), grid, grid_extent, E);
}

§5.

int Inter::Symbols::is_predeclared?Usage of Inter::Symbols::is_predeclared:
Inter in Text Files - §1
Verifying Inter - §1
Inter Data Types - §2, §3
The Inv Construct - §2(inter_symbol *S) {
    if (S == NULL) return FALSE;
    if (Inter::Symbols::get_scope(S) != PUBLIC_ISYMS) return FALSE;
    if (Inter::Symbols::get_type(S) != MISC_ISYMT) return FALSE;
    if (Inter::Symbols::is_defined(S)) return FALSE;
    return TRUE;
}

int Inter::Symbols::is_predeclared_local?Usage of Inter::Symbols::is_predeclared_local:
Inter in Text Files - §1
Verifying Inter - §1(inter_symbol *S) {
    if (S == NULL) return FALSE;
    if (Inter::Symbols::get_scope(S) != PRIVATE_ISYMS) return FALSE;
    if (Inter::Symbols::get_type(S) != MISC_ISYMT) return FALSE;
    if (Inter::Symbols::is_defined(S)) return FALSE;
    return TRUE;
}

int Inter::Symbols::is_undefined_private(inter_symbol *S) {
    if (S == NULL) return FALSE;
    if (Inter::Symbols::get_scope(S) != PRIVATE_ISYMS) return FALSE;
    if (Inter::Symbols::is_defined(S)) return FALSE;
    return TRUE;
}

int Inter::Symbols::is_extern?Usage of Inter::Symbols::is_extern:
Inter in Text Files - §1
Verifying Inter - §1
Inter Data Types - §2, §3
The Inv Construct - §2(inter_symbol *S) {
    if (S == NULL) return FALSE;
    if (Inter::Symbols::get_scope(S) == EXTERNAL_ISYMS) return TRUE;
    if (Inter::Symbols::get_scope(S) == PLUG_ISYMS) return TRUE;
    return FALSE;
}

void Inter::Symbols::extern(inter_symbol *S) {
    Inter::Symbols::set_scope(S, EXTERNAL_ISYMS);
    Inter::Symbols::set_type(S, MISC_ISYMT);
    S->definition = NULL;
}

int Inter::Symbols::is_label?Usage of Inter::Symbols::is_label:
The Label Construct - §2
The Lab Construct - §2(inter_symbol *S) {
    if (S == NULL) return FALSE;
    if (Inter::Symbols::get_scope(S) != PRIVATE_ISYMS) return FALSE;
    if (Inter::Symbols::get_type(S) != LABEL_ISYMT) return FALSE;
    return TRUE;
}

void Inter::Symbols::label(inter_symbol *S) {
    if (Str::get_first_char(S->symbol_name) != '.') {
        LOG("Name is %S\n", S->symbol_name);
        internal_error("not a label name");
    }
    Inter::Symbols::set_scope(S, PRIVATE_ISYMS);
    Inter::Symbols::set_type(S, LABEL_ISYMT);
    S->definition = NULL;
}

void Inter::Symbols::local(inter_symbol *S) {
    Inter::Symbols::set_scope(S, PRIVATE_ISYMS);
    Inter::Symbols::set_type(S, MISC_ISYMT);
    S->definition = NULL;
}

int Inter::Symbols::is_local(inter_symbol *S) {
    if (S == NULL) return FALSE;
    if (Inter::Symbols::get_scope(S) != PRIVATE_ISYMS) return FALSE;
    if (Inter::Symbols::get_type(S) != MISC_ISYMT) return FALSE;
    return TRUE;
}

int Inter::Symbols::is_connector?Usage of Inter::Symbols::is_connector:
The Symbol Construct - §1(inter_symbol *S) {
    if ((S) && ((Inter::Symbols::get_scope(S) == PLUG_ISYMS) ||
        (Inter::Symbols::get_scope(S) == SOCKET_ISYMS)))
        return TRUE;
    return FALSE;
}