Instructions of indoc to different output types.

• §1. Known instruction files
• §2. Command line switches

§1. Known instruction files. Most configuration is done not from the command line, but by instructions files, and we store a list of those here:

linked_list *instructions_files = NULL;  of filename

void Configuration::add_instructions_file?Usage of Configuration::add_instructions_file:
§2, §3(filename *F) {
    if (instructions_files == NULL) instructions_files = NEW_LINKED_LIST(filename);
    ADD_TO_LINKED_LIST(F, filename, instructions_files);
}

void Configuration::read_instructions?Usage of Configuration::read_instructions:
§2(text_stream *target, settings_block *settings) {
    Instructions::read_instructions(target, instructions_files, settings);
}

§2. Command line switches.

typedef struct cl_state {
    struct text_stream *target_chosen;
    struct settings_block *settings;
} cl_state;

void Configuration::read_command_line?Usage of Configuration::read_command_line:
Main - §1.1(int argc, char **argv, settings_block *settings) {
    cl_state state;
    state.target_chosen = Str::new();
    state.settings = settings;
    Read the command line2.2;
    path_to_indoc = Pathnames::installation_path("INDOC_PATH", I"indoc");
    if (settings->verbose_mode) PRINT("Installation path is %p\n", path_to_indoc);
    path_to_indoc_materials = Pathnames::down(path_to_indoc, I"Materials");
    Configuration::add_instructions_file(
        Filenames::in(path_to_indoc_materials, I"basic-instructions.txt"));
    Configuration::add_instructions_file(
        Filenames::in(settings->book_folder, I"indoc-instructions.txt"));
    Configuration::read_instructions(state.target_chosen, settings);
}

• The structure cl_state is accessed in 1/ins and here.

§2.1.

enum VERBOSE_CLSW
enum TEST_INDEX_CLSW
enum XREFS_CLSW
enum FROM_CLSW
enum TO_CLSW
enum INSERTION_CLSW
enum INSTRUCTIONS_CLSW

§2.2. Read the command line2.2 =

    CommandLine::declare_heading(
        U"indoc: a tool for rendering Inform documentation\n\n"
        U"Usage: indoc [OPTIONS] TARGET\n"
        U"where TARGET must be one of those set up in the instructions.\n");

    CommandLine::declare_boolean_switch(VERBOSE_CLSW, U"verbose", 1,
        U"explain what indoc is doing", FALSE);
    CommandLine::declare_boolean_switch(TEST_INDEX_CLSW, U"test-index", 1,
        U"test indexing", FALSE);
    CommandLine::declare_switch(XREFS_CLSW, U"xrefs", 2,
        U"write a file of documentation cross-references to filename X");
    CommandLine::declare_switch(FROM_CLSW, U"from", 2,
        U"use documentation in directory X (instead of 'Documentation' in cwd)");
    CommandLine::declare_switch(TO_CLSW, U"to", 2,
        U"redirect output to folder X (which must already exist)");
    CommandLine::declare_switch(INSERTION_CLSW, U"insertion", 2,
        U"insert HTML in file X at the top of each page head");
    CommandLine::declare_switch(INSTRUCTIONS_CLSW, U"instructions", 2,
        U"read further instructions from file X");

    if (CommandLine::read(argc, argv, &state, &Configuration::switch, &Configuration::bareword)
        == FALSE) exit(0);

• This code is used in §2.

§3.

void Configuration::switch?Usage of Configuration::switch:
§2.2(int id, int val, text_stream *arg, void *v_cl_state) {
    settings_block *settings = ((cl_state *) v_cl_state)->settings;
    switch (id) {
        case VERBOSE_CLSW: settings->verbose_mode = val; break;
        case TEST_INDEX_CLSW: settings->test_index_mode = val; break;
        case XREFS_CLSW: settings->xrefs_filename = Filenames::from_text(arg); break;
        case FROM_CLSW: settings->book_folder = Pathnames::from_text(arg); break;
        case TO_CLSW: settings->destination = Pathnames::from_text(arg);
            settings->destination_modifiable = FALSE; break;
        case INSERTION_CLSW: settings->insertion_filename = Filenames::from_text(arg); break;
        case INSTRUCTIONS_CLSW: Configuration::add_instructions_file(Filenames::from_text(arg)); break;
        default: internal_error("unimplemented switch");
    }
}

void Configuration::bareword?Usage of Configuration::bareword:
§2.2(int id, text_stream *opt, void *v_cl_state) {
    cl_state *state = (cl_state *) v_cl_state;
    Str::copy(state->target_chosen, opt);
}