inform7/inbuild/supervisor-module/Chapter 4/Extension Manager.w

[ExtensionManager::] Extension Manager.

Claiming and creating copies of the extension genre: used for Inform 7
extensions.

@h Genre definition.
The |extension_genre| can be summarised as follows. Copies consist of single
files. These are recognised by having the filename extension |.i7x|. They are
stored in nests, in |N/Extensions/Author/Title-vVersion.i7x|. Their build
graphs are a single vertex with no build edges, but with use edges to any
further extensions which they Include.

It may seem surprising that we do not provide a |GENRE_CONSTRUCT_GRAPH_MTID|
method. This is for efficiency reasons: we don't want to read and parse the
source text of every extension we ever see, and that's what would be needed
to make the graphs of every such extension. Instead we build out the graph
later on, as needed, just for extensions of interest: see below.

@ =
void ExtensionManager::start(void) {
	extension_genre = Genres::new(I"extension", I"extension", TRUE);
	Genres::place_in_class(extension_genre, 1);
	METHOD_ADD(extension_genre, GENRE_WRITE_WORK_MTID, ExtensionManager::write_work);
	METHOD_ADD(extension_genre, GENRE_CLAIM_AS_COPY_MTID, ExtensionManager::claim_as_copy);
	METHOD_ADD(extension_genre, GENRE_SEARCH_NEST_FOR_MTID, ExtensionManager::search_nest_for);
	METHOD_ADD(extension_genre, GENRE_COPY_TO_NEST_MTID, ExtensionManager::copy_to_nest);
	METHOD_ADD(extension_genre, GENRE_READ_SOURCE_TEXT_FOR_MTID, ExtensionManager::read_source_text_for);
	METHOD_ADD(extension_genre, GENRE_BUILDING_SOON_MTID, ExtensionManager::building_soon);
	METHOD_ADD(extension_genre, GENRE_DOCUMENT_MTID, ExtensionManager::document);
	METHOD_ADD(extension_genre, GENRE_MODERNISE_MTID, ExtensionManager::modernise);
}

void ExtensionManager::write_work(inbuild_genre *gen, OUTPUT_STREAM, inbuild_work *work) {
	WRITE("%X", work);
}

@ Extensions live in their namesake subdirectory of a nest:

=
pathname *ExtensionManager::path_within_nest(inbuild_nest *N) {
	if (N == NULL) internal_error("no nest");
	return Pathnames::down(N->location, I"Extensions");
}

@ Extension copies are annotated with a structure called an |inform_extension|,
which stores data about extensions used by the Inform compiler.

=
inform_extension *ExtensionManager::from_copy(inbuild_copy *C) {
	if ((C) && (C->edition->work->genre == extension_genre)) {
		return RETRIEVE_POINTER_inform_extension(C->metadata);
	}
	return NULL;
}

dictionary *ext_copy_cache = NULL;
inbuild_copy *ExtensionManager::new_copy(filename *F, inbuild_nest *N) {
	if (ext_copy_cache == NULL) ext_copy_cache = Dictionaries::new(16, FALSE);
	TEMPORARY_TEXT(key)
	WRITE_TO(key, "%f", F);
	inbuild_copy *C = NULL;
	if (Dictionaries::find(ext_copy_cache, key))
		C = Dictionaries::read_value(ext_copy_cache, key);
	if (C == NULL) {
		C = Copies::new_in_file(
				Editions::new(
					Works::new(extension_genre, I"Untitled", I"Anonymous"),
					VersionNumbers::null()),
				F, N);
		Extensions::scan(C);
		Dictionaries::create(ext_copy_cache, key);
		Dictionaries::write_value(ext_copy_cache, key, C);
	}
	DISCARD_TEXT(key)
	return C;
}

@h Claiming.
Here |arg| is a textual form of a filename or pathname, such as may have been
supplied at the command line; |ext| is a substring of it, and is its extension
(e.g., |jpg| if |arg| is |Geraniums.jpg|), or is empty if there isn't one;
|directory_status| is true if we know for some reason that this is a directory
not a file, false if we know the reverse, and otherwise not applicable.

An extension, for us, needs to be a file with extension |i7x|, but it needs
also to scan properly -- which means the top line of the file has to be right.
So we'll open it and look.

=
void ExtensionManager::claim_as_copy(inbuild_genre *gen, inbuild_copy **C,
	text_stream *arg, text_stream *ext, int directory_status) {
	if (directory_status == TRUE) return;
	if (Str::eq_insensitive(ext, I"i7x")) {
		filename *F = Filenames::from_text(arg);
		*C = ExtensionManager::claim_file_as_copy(F, NULL);
	}
}

inbuild_copy *ExtensionManager::claim_file_as_copy(filename *F, inbuild_nest *N) {
	if (TextFiles::exists(F) == FALSE) return NULL;
	return ExtensionManager::new_copy(F, N);
}

@h Searching.
Here we look through a nest to find all extensions matching the supplied
requirements.

For efficiency's sake, since the nest could contain many hundreds of
extensions, we narrow down to the author's subfolder if a specific
author is required. We cannot safely assume that the author's name specified
in |req| has the same casing as in the subfolder name, so we go about this
cautiously for the sake of case-sensitive file systems.

Nobody should any longer be storing extension files without the file
extension |.i7x|. This was allowed in the early days of Inform 7, and early
drafts of inblorb allowed it too, but this caused problems with emacs backup
files (with filenames ending |~|) being picked up instead of the extension
files they were backing up. So inblorb now recognises only |.i7x| files as
extensions. Similarly, another bad emacs habit is to write hidden symlinks,
with leafnames beginning |.|, so we reject those too.

=
void ExtensionManager::search_nest_for(inbuild_genre *gen, inbuild_nest *N,
	inbuild_requirement *req, linked_list *search_results) {
	if ((req->work->genre) && (Genres::equivalent(req->work->genre, extension_genre) == FALSE))
		return;
	pathname *P = ExtensionManager::path_within_nest(N);
	if (Str::len(req->work->author_name) > 0) {
		linked_list *L = Directories::listing(P);
		text_stream *entry;
		LOOP_OVER_LINKED_LIST(entry, text_stream, L) {
			if (Platform::is_folder_separator(Str::get_last_char(entry))) {
				Str::delete_last_character(entry);
				if ((Str::ne(entry, I"Reserved")) &&
					(Str::eq_insensitive(entry, req->work->author_name))) {
					pathname *Q = Pathnames::down(P, entry);
					ExtensionManager::search_nest_for_r(Q, N, req, search_results, FALSE);
				}
			}
		}
	} else {
		ExtensionManager::search_nest_for_r(P, N, req, search_results, TRUE);
	}
}

void ExtensionManager::search_nest_for_r(pathname *P, inbuild_nest *N,
	inbuild_requirement *req, linked_list *search_results, int recurse) {
	linked_list *L = Directories::listing(P);
	text_stream *entry;
	LOOP_OVER_LINKED_LIST(entry, text_stream, L) {
		if (Platform::is_folder_separator(Str::get_last_char(entry))) {
			Str::delete_last_character(entry);
			if ((recurse) && (Str::ne(entry, I"Reserved")) && (Str::ne(entry, I"Source"))) {
				pathname *Q = Pathnames::down(P, entry);
				ExtensionManager::search_nest_for_r(Q, N, req, search_results, TRUE);
			}
		} else {
			filename *F = Filenames::in(P, entry);
			ExtensionManager::search_nest_for_single_file(F, N, req, search_results);
		}
	}
}

void ExtensionManager::search_nest_for_single_file(filename *F, inbuild_nest *N,
	inbuild_requirement *req, linked_list *search_results) {
	TEMPORARY_TEXT(fext)
	Filenames::write_extension(fext, F);
	if ((Str::eq_insensitive(fext, I".i7x")) &&
		(Str::get_first_char(Filenames::get_leafname(F)) != '.')) {
		inbuild_copy *C = ExtensionManager::claim_file_as_copy(F, N);
		if ((C) && (Requirements::meets(C->edition, req))) {
			Nests::add_search_result(search_results, N, C, req);
		}
	}
	DISCARD_TEXT(fext)
}

@h Copying.
Now the task is to copy an extension into place in a nest. This is easy,
since an extension is a single file; to sync, we just overwrite.

=
filename *ExtensionManager::filename_in_nest(inbuild_nest *N, inbuild_edition *E) {
	pathname *EX = ExtensionManager::path_within_nest(N);
	TEMPORARY_TEXT(leaf)
	Editions::write_canonical_leaf(leaf, E);
	WRITE_TO(leaf, ".i7x");
	filename *F = Filenames::in(
		Pathnames::down(EX, E->work->author_name), leaf);
	DISCARD_TEXT(leaf)
	return F;
}

int ExtensionManager::copy_to_nest(inbuild_genre *gen, inbuild_copy *C, inbuild_nest *N,
	int syncing, build_methodology *meth) {
	filename *F = ExtensionManager::filename_in_nest(N, C->edition);

	if (TextFiles::exists(F)) {
		if (syncing == FALSE) { Copies::overwrite_error(C, N); return 1; }
	} else {
		if (meth->methodology == DRY_RUN_METHODOLOGY) {
			TEMPORARY_TEXT(command)
			WRITE_TO(command, "mkdir -p ");
			Shell::quote_path(command, Filenames::up(F));
			WRITE_TO(STDOUT, "%S\n", command);
			DISCARD_TEXT(command)
		} else {
			Pathnames::create_in_file_system(N->location);
			Pathnames::create_in_file_system(Pathnames::down(N->location, I"Extensions"));
			Pathnames::create_in_file_system(Filenames::up(F));
		}
	}

	int rv = 0;
	if (meth->methodology == DRY_RUN_METHODOLOGY) {
		TEMPORARY_TEXT(command)
		WRITE_TO(command, "cp -f ");
		Shell::quote_file(command, C->location_if_file);
		Shell::quote_file(command, F);
		WRITE_TO(STDOUT, "%S\n", command);
		DISCARD_TEXT(command)
	} else {
		Filenames::copy_file(C->location_if_file, F);
	}
	return rv;
}

@h Build graph.
As far as building goes, the build graph for an extension is just a single vertex: 
you don't need to build an extension at all. But it may well have use edges,
thanks to including other extensions, and because of that we have to read the
source text before we can do anything with the graph.

We don't do this at the going operational stage because that would be
inefficient and might cause VM-related problems -- it would mean that many
extraneous extensions, discovered only when scanning some directory, would
be read in as source text; and some of those might not be compatible with
the current VM settings.

We therefore generate the build graph only on demand.

=
void ExtensionManager::building_soon(inbuild_genre *gen, inbuild_copy *C, build_vertex **V) {
	ExtensionManager::ensure_graphed(C);
	*V = C->vertex;
}

void ExtensionManager::ensure_graphed(inbuild_copy *C) {
	Extensions::construct_graph(ExtensionManager::from_copy(C));
	build_vertex *V;
	LOOP_OVER_LINKED_LIST(V, build_vertex, C->vertex->use_edges)
		if (ExtensionManager::from_copy(V->as_copy))
			ExtensionManager::ensure_graphed(V->as_copy);
}

@h Source text.

=
void ExtensionManager::read_source_text_for(inbuild_genre *G, inbuild_copy *C) {
	Extensions::read_source_text_for(ExtensionManager::from_copy(C));
}

@h Documentation.

=
void ExtensionManager::document(inbuild_genre *gen, inbuild_copy *C, pathname *dest,
	filename *sitemap) {
	Extensions::document(Extensions::from_copy(C), dest, sitemap);
}

@h Modernisation.

=
int ExtensionManager::modernise(inbuild_genre *gen, inbuild_copy *C, text_stream *OUT) {
	return Extensions::modernise(Extensions::from_copy(C), OUT);
}