inform7/inter/bytecode-module/Chapter 4/The Plug Construct.w

[Inter::Plug::] The Plug Construct.

Defining the symbol construct.

@

@e PLUG_IST

=
void Inter::Plug::define(void) {
	inter_construct *IC = InterConstruct::create_construct(PLUG_IST, I"plug");
	InterConstruct::specify_syntax(IC, I"plug IDENTIFIER TOKENS");
	METHOD_ADD(IC, CONSTRUCT_READ_MTID, Inter::Plug::read);
	METHOD_ADD(IC, CONSTRUCT_VERIFY_MTID, Inter::Plug::verify);
	METHOD_ADD(IC, CONSTRUCT_WRITE_MTID, Inter::Plug::write);
	InterConstruct::allow_in_depth_range(IC, 0, 1);
	InterConstruct::permit(IC, INSIDE_PLAIN_PACKAGE_ICUP);
}

void Inter::Plug::read(inter_construct *IC, inter_bookmark *IBM, inter_line_parse *ilp, inter_error_location *eloc, inter_error_message **E) {
	*E = InterConstruct::check_level_in_package(IBM, PLUG_IST, ilp->indent_level, eloc);
	if (*E) return;
	if (SymbolAnnotation::nonempty(&(ilp->set))) { *E = Inter::Errors::plain(I"__annotations are not allowed", eloc); return; }

	inter_package *routine = TextualInter::get_latest_block_package();

	text_stream *symbol_name = ilp->mr.exp[0];
	text_stream *equate_name = NULL;
	int to_name = FALSE;
	match_results mr2 = Regexp::create_mr();
	if (Regexp::match(&mr2, ilp->mr.exp[1], L"~~> \"(%C+)\"")) {
		equate_name = mr2.exp[0];
		to_name = TRUE;
	} else if (Regexp::match(&mr2, ilp->mr.exp[1], L"~~> (%C+)")) {
		equate_name = mr2.exp[0];
	} else {
		*E = Inter::Errors::plain(I"bad plug syntax", eloc); return;
	}

	inter_symbol *name_name = NULL;
	inter_ti level = 0;
	if (routine) {
		inter_symbols_table *locals = InterPackage::scope(routine);
		if (locals == NULL) { *E = Inter::Errors::plain(I"function has no symbols table", eloc); return; }
		name_name = TextualInter::new_symbol(eloc, locals, symbol_name, E);
		if (*E) return;
		InterSymbol::make_plug(name_name);
		if (to_name) Wiring::make_plug_wanting_identifier(name_name, equate_name);
		else {
			inter_symbol *eq = InterSymbolsTable::URL_to_symbol(InterBookmark::tree(IBM), equate_name);
			if (eq == NULL) eq = InterSymbolsTable::symbol_from_name(InterBookmark::scope(IBM), equate_name);
			if (eq == NULL) {
				Wiring::wire_to_name(name_name, equate_name);
			} else {
				Wiring::make_socket_to(name_name, eq);
			}
		}
		level = (inter_ti) ilp->indent_level;
	} else {
		*E = Inter::Errors::plain(I"plugs can exist only in the connectors package", eloc); return;
	}
}

void Inter::Plug::verify(inter_construct *IC, inter_tree_node *P, inter_package *owner, inter_error_message **E) {
	internal_error("PLUG_IST structures cannot exist");
}

void Inter::Plug::write(inter_construct *IC, OUTPUT_STREAM, inter_tree_node *P, inter_error_message **E) {
	internal_error("PLUG_IST structures cannot exist");
}

@ The following writes a valid line of textual Inter to declare a plug or socket,
appearing at level |N| in the hierarchy.

=
void Inter::Plug::write_declaration(OUTPUT_STREAM, inter_symbol *S, int N) {
	for (int L=0; L<N; L++) WRITE("\t");
	switch (InterSymbol::get_type(S)) {
		case PLUG_ISYMT:   WRITE("plug"); break;
		case SOCKET_ISYMT: WRITE("socket"); break;
		default: internal_error("not a connector"); break;
	}
	WRITE(" %S", S->symbol_name);
	if (Wiring::is_wired_to_name(S)) {
		WRITE(" ~~> \"%S\"", Wiring::wired_to_name(S));
	} else if (Wiring::is_wired(S)) {
		WRITE(" ~~> ");
		InterSymbolsTable::write_symbol_URL(OUT, Wiring::wired_to(S));
	} else {
		WRITE(" ?");
	}
}