1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
<?php
error_reporting(E_ALL & ~E_NOTICE);
require_once 'markdown/Markdown.inc.php';
use \Michelf\Markdown;
$dataset = 'default';
$dataset_qs = '';
if (isset($_GET['dataset'])) {
if (!preg_match('@[^a-z0-9-_ ]@i', $_GET['dataset'])) {
if (is_dir('data/' . $_GET['dataset'])) {
$dataset = $_GET['dataset'];
$dataset_qs = "?dataset=$dataset";
}
}
}
function get_html_docs($obj) {
global $config, $data, $dataset, $errors;
$name = str_replace('/', '_', $obj['name']);
$filename = "data/$dataset/$name.mkdn";
$name = str_replace('_', '\_', $obj['name']);
$type = $obj['type'];
if ($config['types'][$type]) {
$type = $config['types'][$type]['long'];
}
$markdown = "## $name *$type*\n\n";
if (file_exists($filename)) {
$markdown .= "### Documentation\n\n";
$markdown .= file_get_contents($filename);
} else {
$markdown .= "<div class=\"alert alert-warning\">No documentation for this object</div>";
}
if ($obj) {
$markdown .= "\n\n";
$markdown .= get_depends_markdown('Depends on', $obj['depends']);
$markdown .= get_depends_markdown('Depended on by', $obj['dependedOnBy']);
}
// Use {{object_id}} to link to an object
$arr = explode('{{', $markdown);
$markdown = $arr[0];
for ($i = 1; $i < count($arr); $i++) {
$pieces = explode('}}', $arr[$i], 2);
$name = $pieces[0];
$id_string = get_id_string($name);
$name_esc = str_replace('_', '\_', $name);
$class = 'select-object';
if (!isset($data[$name])) {
$class .= ' missing';
$errors[] = "Object '$obj[name]' links to unrecognized object '$name'";
}
$markdown .= "<a href=\"#$id_string\" class=\"$class\" data-name=\"$name\">$name_esc</a>";
$markdown .= $pieces[1];
}
$html = Markdown::defaultTransform($markdown);
// IE can't handle <pre><code> (it eats all the line breaks)
$html = str_replace('<pre><code>' , '<pre>' , $html);
$html = str_replace('</code></pre>', '</pre>', $html);
return $html;
}
function get_depends_markdown($header, $arr) {
$markdown = "### $header";
if (count($arr)) {
$markdown .= "\n\n";
foreach ($arr as $name) {
$markdown .= "* {{" . $name . "}}\n";
}
$markdown .= "\n";
} else {
$markdown .= " *(none)*\n\n";
}
return $markdown;
}
function get_id_string($name) {
return 'obj-' . preg_replace('@[^a-z0-9]+@i', '-', $name);
}
function read_config() {
global $config, $dataset, $dataset_qs;
$config = json_decode(file_get_contents("data/$dataset/config.json" ), true);
$config['jsonUrl'] = "json.php$dataset_qs";
}
function read_data() {
global $config, $data, $dataset, $errors;
if (!$config) read_config();
$json = json_decode(file_get_contents("data/$dataset/objects.json"), true);
$data = array();
$errors = array();
foreach ($json as $obj) {
$data[$obj['name']] = $obj;
}
foreach ($data as &$obj) {
$obj['dependedOnBy'] = array();
}
unset($obj);
foreach ($data as &$obj) {
foreach ($obj['depends'] as $name) {
if ($data[$name]) {
$data[$name]['dependedOnBy'][] = $obj['name'];
} else {
$errors[] = "Unrecognized dependency: '$obj[name]' depends on '$name'";
}
}
}
unset($obj);
foreach ($data as &$obj) {
$obj['docs'] = get_html_docs($obj);
}
unset($obj);
}
?>
|
