inform7/inbuild/supervisor-module/Chapter 5/Language Services.w

[Languages::] Language Services.

Behaviour specific to copies of the language genre.

@h Scanning metadata.
Metadata for natural languages is stored in the following structure.
Inform can read and write text in multiple natural languages, though it
needs help to do so: each natural language known to Inform comes from a
small resource folder called its "bundle". (This includes English.)

=
typedef struct inform_language {
	struct inbuild_copy *as_copy;
	struct wording instance_name; /* instance name, e.g., "German language" */
	struct instance *nl_instance; /* instance, e.g., "German language" */
	struct text_stream *iso_code; /* e.g., "fr" or "de" */
	struct text_stream *translated_name; /* e.g., "Français" or "Deutsch" */
	struct text_stream *native_cue; /* e.g., "en français" or "in deutscher Sprache" */
	int adaptive_person; /* which person text substitutions are written from */
	int Preform_loaded; /* has a Preform syntax definition been read for this? */
	CLASS_DEFINITION
} inform_language;

@ This is called as soon as a new copy |C| of the language genre is created.

=
void Languages::scan(inbuild_copy *C) {
	inform_language *L = CREATE(inform_language);
	L->as_copy = C;
	if (C == NULL) internal_error("no copy to scan");
	Copies::set_metadata(C, STORE_POINTER_inform_language(L));
	TEMPORARY_TEXT(sentence_format)
	WRITE_TO(sentence_format, "%S language", C->edition->work->title);
	L->instance_name = Feeds::feed_text(sentence_format);
	DISCARD_TEXT(sentence_format)
	L->nl_instance = NULL;
	L->Preform_loaded = FALSE;
	L->adaptive_person = -1; /* i.e., none yet specified */
	/* these defaults should always be overwritten */
	L->iso_code = I"en";
	L->translated_name = I"English";
	/* but not this one */
	L->native_cue = NULL;

	filename *about_file = Filenames::in(Languages::path_to_bundle(L), I"about.txt");
	if (TextFiles::exists(about_file)) {
		TEMPORARY_TEXT(err)
		WRITE_TO(err, "a language bundle should no longer use an 'about.txt' file");
		Copies::attach_error(C, CopyErrors::new_T(METADATA_MALFORMED_CE, -1, err));
		DISCARD_TEXT(err)	
	}
	
	filename *F = Filenames::in(C->location_if_path, I"language_metadata.json");
	if (TextFiles::exists(F)) {
		JSONMetadata::read_metadata_file(C, F);
		if (C->metadata_record) {
			JSON_value *language_details =
				JSON::look_up_object(C->metadata_record, I"language-details");
			if (language_details) @<Extract the language details@>
			else {
				TEMPORARY_TEXT(err)
				WRITE_TO(err, "'language_metadata.json' must contain a \"language-details\" field");
				Copies::attach_error(C, CopyErrors::new_T(METADATA_MALFORMED_CE, -1, err));
				DISCARD_TEXT(err)	
			}
			JSON_value *needs = JSON::look_up_object(C->metadata_record, I"needs");
			if (needs) {
				TEMPORARY_TEXT(expected)
				WRITE_TO(expected, "%SLanguageKit", C->edition->work->title);
				int found_expected = FALSE;
				JSON_value *E;
				LOOP_OVER_LINKED_LIST(E, JSON_value, needs->if_list)
					@<Extract this requirement@>;
				if (found_expected == FALSE) {
					TEMPORARY_TEXT(err)
					WRITE_TO(err, "language bundle must have dependency on '%S'", expected);
					Copies::attach_error(C, CopyErrors::new_T(METADATA_MALFORMED_CE, -1, err));
					DISCARD_TEXT(err)	
				}
				DISCARD_TEXT(expected)
			} else {
				TEMPORARY_TEXT(err)
				WRITE_TO(err, "'language_metadata.json' must contain a \"needs\" field");
				Copies::attach_error(C, CopyErrors::new_T(METADATA_MALFORMED_CE, -1, err));
				DISCARD_TEXT(err)	
			}
		}
	} else {
		TEMPORARY_TEXT(err)
		WRITE_TO(err, "a language bundle must now provide a 'language_metadata.json' file");
		Copies::attach_error(C, CopyErrors::new_T(METADATA_MALFORMED_CE, -1, err));
		DISCARD_TEXT(err)	
	}
}

@<Extract the language details@> =
	JSON_value *translated_name = JSON::look_up_object(language_details, I"translated-name");
	if (translated_name) L->translated_name = Str::duplicate(translated_name->if_string);
	
	JSON_value *iso_code = JSON::look_up_object(language_details, I"iso-639-1-code");
	if (iso_code) L->iso_code = Str::duplicate(iso_code->if_string);
	
	JSON_value *translated_syntax_cue = JSON::look_up_object(language_details, I"translated-syntax-cue");
	if (translated_syntax_cue) L->native_cue = Str::duplicate(translated_syntax_cue->if_string);

@<Extract this requirement@> =
	JSON_value *if_clause = JSON::look_up_object(E, I"if");
	JSON_value *unless_clause = JSON::look_up_object(E, I"unless");
	if ((if_clause) || (unless_clause)) {
		TEMPORARY_TEXT(err)
		WRITE_TO(err, "a language bundle's needs must be unconditional");
		Copies::attach_error(C, CopyErrors::new_T(METADATA_MALFORMED_CE, -1, err));
		DISCARD_TEXT(err)	
	}
	JSON_value *need_clause = JSON::look_up_object(E, I"need");
	if (need_clause) {
		JSON_value *need_type = JSON::look_up_object(need_clause, I"type");
		JSON_value *need_title = JSON::look_up_object(need_clause, I"title");
		JSON_value *need_version_range = JSON::look_up_object(need_clause, I"version-range");
		if (Str::eq(need_type->if_string, I"kit")) {
			if (Str::eq(expected, need_title->if_string)) found_expected = TRUE;
			if (need_version_range) {
				TEMPORARY_TEXT(err)
				WRITE_TO(err, "version ranges on kit dependencies are not yet implemented");
				Copies::attach_error(C, CopyErrors::new_T(METADATA_MALFORMED_CE, -1, err));
				DISCARD_TEXT(err)
			}
		} else {
			TEMPORARY_TEXT(err)
			WRITE_TO(err, "a language can only have kits as dependencies");
			Copies::attach_error(C, CopyErrors::new_T(METADATA_MALFORMED_CE, -1, err));
			DISCARD_TEXT(err)
		}
	}

@ =
pathname *Languages::path_to_bundle(inform_language *L) {
	return L->as_copy->location_if_path;
}
	
@h Logging.

=
void Languages::log(OUTPUT_STREAM, char *opts, void *vL) {
	inform_language *L = (inform_language *) vL;
	if (L == NULL) { LOG("<null-language>"); }
	else { LOG("%S", L->as_copy->edition->work->title); }
}

@h Language code.
This is used when we write the bibliographic data for the work of IF we're
making; this enables online databases like IFDB, and smart interpreters, to
detect the language of play for a story file without actually running it.

=
void Languages::write_ISO_code(OUTPUT_STREAM, inform_language *L) {
	#ifdef CORE_MODULE
	if (L == NULL) L = DefaultLanguage::get(NULL);
	#endif
	WRITE("%S", L->iso_code);
}

@h Kit.
Each language needs its own kit(s) of Inter code, given in the dependencies:

=
void Languages::add_kit_dependencies_to_project(inform_language *L, inform_project *project) {
	if (L == NULL) internal_error("no language");
	JSON_value *md = L->as_copy->metadata_record;
	if (md == NULL) return; /* should never happen, but fail safe */
	JSON_value *needs = JSON::look_up_object(md, I"needs");
	if (needs == NULL) return; /* should never happen, but fail safe */
	JSON_value *E;
	LOOP_OVER_LINKED_LIST(E, JSON_value, needs->if_list) {
		JSON_value *need_clause = JSON::look_up_object(E, I"need");
		if (need_clause) {
			JSON_value *need_type = JSON::look_up_object(need_clause, I"type");
			JSON_value *need_title = JSON::look_up_object(need_clause, I"title");
			JSON_value *need_version = JSON::look_up_object(need_clause, I"version");
			if (Str::eq(need_type->if_string, I"kit")) {
				inbuild_work *work = Works::new_raw(kit_genre, need_title->if_string, I"");
				inbuild_requirement *req;
				if (need_version) req = Requirements::new(work,
					VersionNumberRanges::compatibility_range(VersionNumbers::from_text(need_version->if_string)));
				else req = Requirements::any_version_of(work);
				Projects::add_kit_dependency(project, need_title->if_string, L, NULL, req);
			}
		}
	}
}

@h Finding by name.
Given the name of a natural language (e.g., "German") we find the
corresponding definition. That will mean searching for a copy, and that
raises the question of where to look -- in particular, it's important to
include the Materials folder for any relevant project.

=
linked_list *search_list_for_Preform_callback = NULL;
int Languages::read_Preform_definition(inform_language *L, linked_list *S) {
	if (L == NULL) internal_error("no language");
	if (L->Preform_loaded == FALSE) {
		L->Preform_loaded = TRUE;
		search_list_for_Preform_callback = S;
		int n = (*shared_preform_callback)(L);
		if (n == 0) return FALSE;
	}
	return TRUE;
}

@ This function is called only from Preform...

@d PREFORM_LANGUAGE_FROM_NAME_WORDS_CALLBACK Languages::Preform_find

=
inform_language *Languages::Preform_find(text_stream *name) {
	return Languages::find_for(name, search_list_for_Preform_callback);
}

@ ...but this one is more generally available.

=
inform_language *Languages::find_for(text_stream *name, linked_list *search) {
	inbuild_requirement *req =
		Requirements::any_version_of(Works::new(language_genre, name, I""));
	inbuild_search_result *R = Nests::search_for_best(req, search);
	if (R) return LanguageManager::from_copy(R->copy);
	return NULL;
}

@ Or we can convert the native cue, |en français|, to the name, |French|:

=
text_stream *Languages::find_by_native_cue(text_stream *cue, linked_list *search) {
	linked_list *results = NEW_LINKED_LIST(inbuild_search_result);
	Nests::search_for(Requirements::anything_of_genre(language_genre), search, results);
	inbuild_search_result *search_result;
	LOOP_OVER_LINKED_LIST(search_result, inbuild_search_result, results) {
		inform_language *L = LanguageManager::from_copy(search_result->copy);
		if (Str::eq_insensitive(cue, L->native_cue))
			return L->as_copy->edition->work->title;
	}
	return NULL;
}

@ Finally, the following Preform nonterminal matches the English-language
name of a language: for example, "French". Unlike the above functions, it
looks only at languages already loaded, and doesn't scan nests for more.

=
<natural-language> internal {
	inform_language *L;
	LOOP_OVER(L, inform_language)
		if (Wordings::match(W, Wordings::first_word(L->instance_name))) {
			==> { -, L };
			return TRUE;
		}
	==> { fail };
}