website/site-tools/create-module-metadata.php

<?php

require_once(__DIR__ . '/../common/code/boost_libraries.php');
require_once(__DIR__ . '/boost_super_project.php');

function main() {
    $args = $_SERVER['argv'];
    $boost_root = null;

    switch (count($args)) {
        case 2: $boost_root = $args[1]; break;
        default:
            echo "Usage: update-doc-list.php boost_root\n";
            exit(1);
    }

    $library_details =
        boost_libraries::from_xml_file(__DIR__ . '/../doc/libraries.xml')
            ->get_for_version(BoostVersion::develop());
    $git_submodules = (new BoostSuperProject($boost_root))->get_modules();


    // Get the library data, so that it can be updated with maintainers.
    // In case you're wondering why the result from get_for_version doesn't
    // use 'key' as its key, it's for historical reasons I think, might be
    // fixable.

    $libs_index = array();
    foreach ($library_details as $index => $details) {
        $libs_index[$details['key']] = $index;
    }

    foreach (file("$boost_root/libs/maintainers.txt") as $line)
    {
        $line = trim($line);
        if (!$line || $line[0] == '#') {
            continue;
        }

        $matches = null;
        if (!preg_match('@^([^\s]+)\s*(.*)$@', $line, $matches)) {
            echo "Unable to parse line: {$line}\n";
            exit(1);
        }
        
        $key = trim($matches[1]);
        $values = trim($matches[2]);
        
        if (!$values) { continue; }

        if ($key === 'logic') { $key = 'logic/tribool'; }
        if ($key === 'operators') { $key = 'utility/operators'; }

        if (isset($libs_index[$key])) {
            $index = $libs_index[$key];
            $library_details[$index]['maintainers'] = array_map('trim',
                    explode(',', $values));
        }
        else {
            echo "Unable to find library: {$key}\n";
        }
    }

    // Split the libraries up into modules.

    $libraries_by_module = array();

    foreach ($library_details as $library) {
        $module = $library['module'];

        if (!isset($git_submodules[$module])) {
            echo "Unknown module: {$module}\n";
            continue;
        }

        if (isset($library['documentation'])) {
            $doc_url = $library['documentation'];
            $module_base = $git_submodules[$module]['path'];

            if ($doc_url == $module_base) {
                $doc_url = '';
            }
            else if (strpos($doc_url, "$module_base/") === 0) {
                $doc_url = substr($doc_url, strlen("$module_base/"));
            }
            else {
                $doc_url = "/$doc_url";
            }

            if (!$doc_url) {
                unset($library['documentation']);
            }
            else {
                $library['documentation'] = $doc_url;
            }
        }

        $libraries_by_module[$module][] = $library;
    }

    // Write the module metadata

    foreach ($libraries_by_module as $module => $libraries) {
        $module_libraries = boost_libraries::from_array($libraries);
        $module_dir = "{$boost_root}/{$git_submodules[$module]['path']}";
        $meta_dir = "$module_dir/meta";
        $meta_file = "$module_dir/meta/libraries.json";

        if (!is_dir($module_dir)) {
            echo "Module '$module' doesn't exist at '$module_dir'\n";
            continue;
        }

        if (!is_dir($meta_dir)) {
            mkdir($meta_dir);
        }

        file_put_contents($meta_file, $module_libraries->to_json(
                array('boost-version', 'update-version', 'module')));
    }
}


main();