-
Notifications
You must be signed in to change notification settings - Fork 31
/
docs_parser.cpp
843 lines (783 loc) · 21.5 KB
/
docs_parser.cpp
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
#include <cute.h>
using namespace Cute;
#include <algorithm>
#include <filesystem>
// Parses all the Cute headers and generates documentation pages in .md format.
const char* g_relative_path;
const char* get_relative_path()
{
if (!g_relative_path) {
CF_Path path = cf_fs_get_base_directory();
path.normalize();
CF_Path dir = path.my_directory();
if (siequ(dir.c_str(), "debug") || siequ(dir.c_str(), "release")) {
g_relative_path = "../../docs";
} else {
g_relative_path = "../docs";
}
}
return g_relative_path;
}
static bool s_is_space(int cp)
{
switch (cp) {
case ' ':
case '\n':
case '\t':
case '\v':
case '\f':
case '\r': return true;
default: return false;
}
}
static void panic(String msg)
{
printf("ERROR: %s\n", msg.c_str());
exit(-1);
}
enum DocType
{
DOC_EMPTY,
DOC_ENUM,
DOC_FUNCTION,
DOC_STRUCT,
};
struct Doc
{
DocType type;
CF_Path path;
String web_category;
String title;
String file;
String brief;
int this_index = -1;
String signature;
Array<String> param_names;
Array<String> param_briefs;
Array<String> enum_entries;
Array<String> enum_entry_briefs;
Array<String> member_briefs;
Array<int> member_functions;
Array<String> members;
String return_value;
String example_brief;
String example;
String remarks;
Array<String> related;
void emit_title(FILE* fp);
void emit_brief(FILE* fp);
void emit_signature(FILE* fp);
void emit_members(FILE* fp);
void emit_member_function_links(FILE* fp);
void emit_params(FILE* fp);
void emit_enum_entries(FILE* fp);
void emit_return(FILE* fp);
void emit_example(FILE* fp);
void emit_remarks(FILE* fp);
void emit_related(FILE* fp);
};
struct State
{
// Header parsing state.
const char* in;
const char* end;
String token;
String file;
Map<const char*, const char*> categories;
Map<const char*, Array<const char*>> category_index_lists;
// Stored strings for output docs file.
Doc doc;
Array<Doc> docs;
Map<const char*, int> page_to_doc_index;
void flush_doc()
{
CF_Path path = get_relative_path();
path.add(doc.web_category);
String title = doc.title;
title.to_lower().replace(" ", "_").append(".md");
path.add(title);
doc.path = path;
doc.file = file;
if (page_to_doc_index.has(sintern(title))) {
Doc& other_doc = docs[page_to_doc_index.get(sintern(title))];
panic(String::fmt("Tried to add a duplicate page for %s (found in file %s, previously seen in file %s).", title.c_str(), doc.file.c_str(), other_doc.file.c_str()));
}
page_to_doc_index.insert(sintern(title), docs.count());
docs.add(doc);
doc = Doc();
}
int get_doc_index(String title)
{
title.to_lower().replace(" ", "_").append(".md");
int* index = page_to_doc_index.try_find(sintern(title));
return index ? *index : -1;
}
bool doc_has_link(String title)
{
return get_doc_index(title) != -1;
}
String doc_get_link(String title)
{
int index = get_doc_index(title);
String link = docs[index].path.c_str();
link.replace(get_relative_path(), "");
return link;
}
bool has_doc(const char* file)
{
return page_to_doc_index.has(sintern(file));
}
void clear() { token.clear(); in = end = NULL; }
bool done() { return in >= end; }
void append(int ch) { token.append(ch); }
void ltrim() { while (!done()) { int cp = *in; if (s_is_space(cp)) ++in; else break; } }
int next() { int cp; in = cf_decode_UTF8(in, &cp); return cp; }
int peek() { int cp; cf_decode_UTF8(in, &cp); return cp; }
void skip() { int cp; in = cf_decode_UTF8(in, &cp); }
bool expect(int ch) { int cp = next(); if (cp != ch) { return false; } return true; }
bool try_next(int ch) { int cp; const char* next = cf_decode_UTF8(in, &cp); if (cp == ch) { in = next; return true; } return false; }
};
State state;
State* s = &state;
String linkify(String text, String scan, bool ticks = true)
{
if (s->doc_has_link(scan)) {
String link = s->doc_get_link(scan);
String coded_link = String::fmt("[%s](%s)", scan.c_str(), link.c_str());
scan = String::fmt(ticks ? "`%s`" : "%s", scan.c_str());
text.replace(scan, coded_link);
}
return text;
}
void Doc::emit_title(FILE* fp)
{
fprintf(fp, "[//]: # (This file is automatically generated by Cute Framework's docs parser.)\n");
fprintf(fp, "[//]: # (Do not edit this file by hand!)\n");
fprintf(fp, "[//]: # (See: https://github.com/RandyGaul/cute_framework/blob/master/samples/docs_parser.cpp)\n");
fprintf(fp, "[](../header.md ':include')\n\n");
fprintf(fp, "# %s\n\n", title.c_str());
String link = linkify(web_category, web_category, false);
fprintf(fp, "Category: [%s](/api_reference?id=%s) \n", web_category.c_str(), link.c_str());
fprintf(fp, "GitHub: [%s](https://github.com/RandyGaul/cute_framework/blob/master/include/%s) \n---\n\n", file.c_str(), file.c_str());
}
void Doc::emit_brief(FILE* fp)
{
fprintf(fp, "%s\n\n", brief.c_str());
}
void Doc::emit_signature(FILE* fp)
{
fprintf(fp, "```cpp\n%s\n```\n\n", signature.c_str());
}
void Doc::emit_members(FILE* fp)
{
if (members.count()) {
fprintf(fp, "Struct Members | Description\n--- | ---\n");
for (int i = 0; i < members.count(); ++i) {
fprintf(fp, "`%s` | %s\n", members[i].c_str(), member_briefs[i].c_str());
}
fprintf(fp, "\n");
}
}
void Doc::emit_member_function_links(FILE* fp)
{
// This function is not finished.
if (member_functions.count()) {
fprintf(fp, "Functions | Description\n--- | ---\n");
for (int i = 0; i < member_functions.count(); ++i) {
int index = member_functions[i];
Doc& doc = s->docs[index];
// TODO - Linkify title spot here.
fprintf(fp, "%s | %s\n", doc.title.c_str(), doc.brief.c_str());
}
fprintf(fp, "\n");
}
}
void Doc::emit_params(FILE* fp)
{
if (param_names.count()) {
fprintf(fp, "Parameters | Description\n--- | ---\n");
for (int i = 0; i < param_names.count(); ++i) {
fprintf(fp, "%s | %s\n", param_names[i].c_str(), param_briefs[i].c_str());
}
fprintf(fp, "\n");
}
}
void Doc::emit_enum_entries(FILE* fp)
{
fprintf(fp, "## Values\n\n");
fprintf(fp, "Enum | Description\n--- | ---\n");
for (int i = 0; i < enum_entries.count(); ++i) {
fprintf(fp, "%s | %s\n", enum_entries[i].c_str(), enum_entry_briefs[i].c_str());
}
fprintf(fp, "\n");
}
void Doc::emit_return(FILE* fp)
{
if (return_value.len()) {
fprintf(fp, "## Return Value\n\n%s\n\n", return_value.c_str());
}
}
void Doc::emit_example(FILE* fp)
{
if (example.len()) {
fprintf(fp, "## Code Example\n\n");
if (example_brief.len()) {
fprintf(fp, "%s\n\n", example_brief.c_str());
}
fprintf(fp, "```cpp%s```\n\n", example.c_str());
}
}
void Doc::emit_remarks(FILE* fp)
{
if (remarks.len()) {
fprintf(fp, "## Remarks\n\n");
fprintf(fp, "%s\n\n", remarks.c_str());
}
}
void Doc::emit_related(FILE* fp)
{
if (related.count()) {
fprintf(fp, "## Related Pages\n\n");
for (int i = 0; i < related.count(); ++i) {
fprintf(fp, "%s\n", related[i].c_str());
}
}
}
void parse_token()
{
s->token.clear();
while (!s->done()) {
int cp = s->next();
if (s_is_space(cp)) {
if (s->token.len()) {
return;
}
} else {
s->append(cp);
}
}
}
String parse_single_comment_line()
{
String line;
if (s->try_next(' ')) {
if (s->try_next('*')) {
if (s->try_next('/')) {
s->in--;
s->in--;
return line;
}
}
}
while (!s->done()) {
int cp = s->peek();
if (cp == '\n') {
break;
} else {
s->skip();
line.add(cp);
}
}
return line.trim();
}
String parse_paragraph(bool example = false)
{
String paragraph;
while (!s->done()) {
int cp = s->peek();
if (cp == '\n') {
paragraph.append(cp);
s->skip();
if (s->try_next(' ')) {
if (s->try_next('*')) {
if (s->try_next('/')) {
s->in--;
s->in--;
break;
} else {
s->try_next(' ');
}
}
}
} else if (cp == '@') {
break;
} else if (cp == '*') {
s->skip();
if (s->try_next('/')) {
s->in--;
s->in--;
break;
}
} else {
if (cp != '\r') {
paragraph.append(cp);
}
s->skip();
}
}
return !example ? paragraph.trim().replace("\n ", "\n") : paragraph;
}
void parse_command()
{
if (s->token == "@brief") {
s->doc.brief = parse_paragraph();
} else if (s->token == "@example") {
s->doc.example_brief = parse_single_comment_line();
s->doc.example = parse_paragraph(true).replace("\n ", "\n");
} else if (s->token == "@remarks") {
s->doc.remarks = parse_paragraph();
} else if (s->token == "@related") {
s->doc.related = parse_paragraph().split(' ');
} else if (s->token == "@param") {
parse_token();
s->doc.param_names.add(s->token);
s->doc.param_briefs.add(parse_paragraph());
} else if (s->token == "@return") {
s->doc.return_value = parse_paragraph();
} else if (s->token == "@category") {
s->doc.web_category = parse_paragraph();
const char* category = sintern(s->doc.web_category);
if (!s->categories.has(category)) {
s->categories.insert(category, category);
}
} else {
panic(String::fmt("Found unrecognized command %s.", s->token.c_str()));
}
}
void parse_enum()
{
s->doc.type = DOC_ENUM;
s->doc.title = parse_paragraph();
while (!s->done()) {
parse_token();
if (s->token.first() == '@') {
parse_command();
} else if (s->token == "*/") {
break;
}
}
while (!s->done()) {
parse_token();
if (s->token.first() == '@') {
if (s->token == "@entry") {
s->doc.enum_entry_briefs.add(parse_paragraph());
} else if (s->token == "@end") {
break;
} else {
panic(String::fmt("Expected to find @entry or @end, but instead found %s.", s->token.c_str()));
}
} else if (s->token.begins_with("CF_ENUM(")) {
s->token.replace("CF_ENUM(", "");
s->token.pop(); // Remove ','
s->doc.enum_entries.add(s->token);
}
}
if (s->doc.enum_entries.count() != s->doc.enum_entry_briefs.count()) {
int a = s->doc.enum_entries.count();
int b = s->doc.enum_entry_briefs.count();
panic(String::fmt("Enum entries count %d did not match entry description count %d.", a, b));
}
s->flush_doc();
}
String parse_line()
{
String line;
s->try_next('\n');
while (!s->done()) {
int cp = s->peek();
if (cp == '\n') {
break;
} else {
s->skip();
line.add(cp);
}
}
return line.trim();
}
void parse_comment_block()
{
s->doc.title = parse_paragraph();
while (!s->done()) {
parse_token();
if (s->token.first() == '@') {
parse_command();
} else if (s->token == "*/") {
break;
}
}
}
void parse_function()
{
s->doc.type = DOC_FUNCTION;
parse_comment_block();
s->doc.signature = parse_line().replace("CF_API ", "").replace("CF_CALL ", "").replace("CF_INLINE ", "");
int index = s->doc.signature.find(" {");
if (index != -1) {
s->doc.signature.set_len(index);
}
s->flush_doc();
}
void parse_struct()
{
s->doc.type = DOC_STRUCT;
parse_comment_block();
int doc_index = s->docs.count();
s->flush_doc();
Doc& doc = s->docs.last();
while (!s->done()) {
parse_token();
if (s->token.first() == '@') {
if (s->token == "@member") {
String brief = parse_paragraph();
parse_token(); // Skip "*/"
String member = parse_line().replace("CF_INLINE ", "").replace(";", "");
doc.member_briefs.add(brief);
doc.members.add(member);
} else if (s->token == "@function") {
doc.member_functions.add(s->docs.count());
parse_function();
s->docs.last().this_index = doc_index;
} else if (s->token == "@end") {
break;
} else {
panic(String::fmt("Found unexpected command %s while parsing a struct, @member, @end, or @function.", s->token.c_str()));
}
}
}
}
void parse(String header)
{
size_t sz = 0;
char* in = fs_read_entire_file_to_memory_and_nul_terminate(header, &sz);
s->clear();
s->in = in;
s->end = in + sz;
s->file = header;
while (!s->done()) {
parse_token();
if (s->token.first() == '@') {
if (s->token == "@enum") {
parse_enum();
} else if (s->token == "@function") {
parse_function();
} else if (s->token == "@struct") {
parse_struct();
} else {
panic(String::fmt("Found unexpected command %s, expected @enum, @function, or @struct.", s->token.c_str()));
}
}
}
}
// Scans text for `things in tick marks like this`. It will replace the tick mark text
// with a page link if an appropriate page link is found based on the title of the page.
String auto_generate_links(String text)
{
String scan;
bool found = false;
for (int i = 0; i < text.len(); ++i) {
char ch = text[i];
if (found) {
if (ch != '`') {
scan.add(ch);
} else {
text = linkify(text, scan);
found = false;
scan.clear();
}
} else {
if (ch == '`') {
found = true;
}
}
}
return text;
}
void save_api_reference_links(FILE* fp, const char* category, Array<const char*> pages, const char* type, const Map<const char*, Array<const char*>>& related)
{
if (pages.size()) {
fprintf(fp, "### %s\n", type);
for (int i = 0; i < pages.count(); ++i) {
String page = pages[i];
String page_lower = page;
page_lower.to_lower().replace(" ", "_");
fprintf(fp, "- [%s](/%s/%s.md)\n", page.c_str(), category, page_lower.c_str());
}
fprintf(fp, "\n\n");
}
const Array<const char*> related_links = related.find(category);
if (related_links.size()) {
fprintf(fp, "### Related Reading\n");
for (int i = 0; i < related_links.size(); ++i) {
fprintf(fp, "%s\n", related_links[i]);
}
fprintf(fp, "\n");
}
}
int main(int argc, char* argv[])
{
// Mount the headers folder as "/".
cf_fs_init(argv[0]);
CF_Path path = cf_fs_get_base_directory();
path = path.normalize();
path.popn(2);
path.add("/include");
cf_fs_mount(path.c_str(), "/", true);
// Mount docs folder as "/docs".
path = cf_fs_get_base_directory();
path = path.normalize();
path.popn(2);
path.add("/docs");
cf_fs_mount(path.c_str(), "/docs", true);
// Allow us to freely write in the project directory.
path = cf_fs_get_base_directory();
path = path.normalize();
path.popn(2);
cf_fs_set_write_directory(path.c_str());
// Parse each header into docs.
CF_Directory headers = CF_Directory::open("");
for (const char* file = headers.next(); file; file = headers.next()) {
if (spext_equ(file, ".h")) {
parse(file);
}
}
// Auto-generate links throughout the text.
for (int i = 0; i < s->docs.count(); ++i) {
Doc& doc = s->docs[i];
doc.brief = auto_generate_links(doc.brief);
for (int i = 0; i < doc.param_briefs.count(); ++i) {
doc.param_briefs[i] = auto_generate_links(doc.param_briefs[i]);
}
for (int i = 0; i < doc.enum_entry_briefs.count(); ++i) {
doc.enum_entry_briefs[i] = auto_generate_links(doc.enum_entry_briefs[i]);
}
for (int i = 0; i < doc.member_briefs.count(); ++i) {
doc.member_briefs[i] = auto_generate_links(doc.member_briefs[i]);
}
doc.return_value = auto_generate_links(doc.return_value);
doc.example_brief = auto_generate_links(doc.example_brief);
doc.example = auto_generate_links(doc.example);
doc.remarks = auto_generate_links(doc.remarks);
for (int i = 0; i < doc.related.count();) {
String related = doc.related[i];
if (related == doc.title) {
doc.related.unordered_remove(i);
continue;
}
doc.related[i] = linkify(related, related, false);
doc.related[i].append(" ");
++i;
}
}
// Save each doc file.
for (int i = 0; i < s->docs.count(); ++i) {
Doc& doc = s->docs[i];
{
CF_Path path = doc.path;
path.pop();
std::filesystem::create_directory(path.c_str());
}
FILE* fp = fopen(doc.path.c_str(), "wb");
CF_ASSERT(fp);
const char* category = sintern(doc.web_category.c_str());
if (!s->category_index_lists.has(category)) {
s->category_index_lists.insert(category);
}
Array<const char*>& categories = s->category_index_lists.find(category);
categories.add(sintern(doc.title));
if (doc.type == DOC_ENUM) {
doc.emit_title(fp);
doc.emit_brief(fp);
doc.emit_enum_entries(fp);
doc.emit_example(fp);
doc.emit_remarks(fp);
doc.emit_related(fp);
} else if (doc.type == DOC_FUNCTION) {
doc.emit_title(fp);
doc.emit_brief(fp);
doc.emit_signature(fp);
doc.emit_params(fp);
doc.emit_return(fp);
doc.emit_example(fp);
doc.emit_remarks(fp);
doc.emit_related(fp);
} else if (doc.type == DOC_STRUCT) {
doc.emit_title(fp);
doc.emit_brief(fp);
doc.emit_members(fp);
doc.emit_member_function_links(fp);
doc.emit_example(fp);
doc.emit_remarks(fp);
doc.emit_related(fp);
}
fclose(fp);
}
// Generate api_reference.md file.
{
CF_Path path = get_relative_path();
path += "api_reference.md";
FILE* fp = fopen(path, "wb");
fprintf(fp, "[//]: # (This file is automatically generated by Cute Framework's docs parser.)\n");
fprintf(fp, "[//]: # (Do not edit this file by hand!)\n");
fprintf(fp, "[//]: # (See: https://github.com/RandyGaul/cute_framework/blob/master/samples/docs_parser.cpp)\n");
fprintf(fp, "[](/header.md ':include')\n\n");
fprintf(fp, "# API Reference\n\n");
fprintf(fp, "This is a list of all functions in Cute Framework organized by categories. This is great for users that want to see all the available functionality laid out plainly.\n\n\n");
Map<const char*, Array<const char*>> related;
related.add("allocator", {
"- [Allocator](/topics/allocator.md)",
});
related.add("app", {
"- [Application Window](/topics/application_window.md)",
"- [Game Loop and Time](/topics/game_loop_and_time.md)",
});
related.add("array", {
"- [Data Structures](/topics/data_structures.md)",
});
related.add("atomics", {
"- [Atomics](/topics/atomics.md)",
});
related.add("base64", {
"- [Serialization](/topics/serialization.md)",
});
related.add("collision", {
"- [Collision](/topics/collision.md)",
});
related.add("coroutine", {
"- [Coroutines](/topics/coroutines.md)",
});
related.add("draw", {
"- [Drawing](/topics/drawing.md)",
});
related.add("ecs", {
"- [Entity Component System](/topics/entity_component_system.md)",
});
related.add("file", {
"- [Virtual File System](/topics/virtual_file_system.md)",
});
related.add("graphics", {
"- [Low Level Graphics](/topics/low_level_graphics.md)",
});
related.add("haptic", {
"- [Input](/topics/input.md)",
});
related.add("hash", {
"- [Data Structures](/topics/data_structures.md)",
});
related.add("input", {
"- [Input](/topics/input.md)",
});
related.add("list", {
"- [Data Structures](/topics/data_structures.md)",
});
related.add("math", {
"- [Collision](/topics/collision.md)",
});
related.add("multithreading", {
"- [Atomics](/topics/atomics.md)",
"- [Multithreading](/topics/multithreading.md)",
});
related.add("net", {
"- [Networking](/topics/Networking.md)",
});
related.add("path", {
"- [Virtual File System](/topics/virtual_file_system.md)",
});
related.add("pathfinding", {
"- [Path Finding](/topics/pathfinding.md)",
});
related.add("random", {
"- [Random Numbers](/topics/random_numbers.md)",
});
related.add("serialization", {
"- [Serialization](/topics/serialization.md)",
});
related.add("sprite", {
"- [Drawing](/topics/drawing.md)",
});
related.add("string", {
"- [Strings](/topics/strings.md)",
});
related.add("time", {
"- [Game Loop and Time](/topics/game_loop_and_time.md)",
});
related.add("text", {
"- [Drawing](/topics/drawing.md)",
"- [Input](/topics/input.md)",
});
related.add("web", {
"- [Networking](/topics/networking.md)",
});
s->categories.sort_by_items([](const char* a, const char* b) { return sicmp(a, b) < 0; });
for (int i = 0; i < s->categories.count(); ++i) {
const char* category = s->categories.items()[i];
Array<const char*> index_list = s->category_index_lists.find(category);
fprintf(fp, "## %s\n\n", category);
// Save functions.md.
bool has_functions = false;
{
Array<const char*> functions;
for (int i = 0; i < index_list.size(); ++i) {
const char* title = index_list[i];
if (s->docs[s->get_doc_index(title)].type == DOC_FUNCTION) {
functions.add(title);
}
}
has_functions = functions.count() > 0;
std::sort(functions.data(), functions.data() + functions.count(), [](const char* a, const char* b) { return sicmp(a, b) < 0; });
save_api_reference_links(fp, category, functions, "functions", related);
}
// Save structs.md.
bool has_structs = false;
{
Array<const char*> structs;
for (int i = 0; i < index_list.size(); ++i) {
const char* title = index_list[i];
if (s->docs[s->get_doc_index(title)].type == DOC_STRUCT) {
structs.add(title);
}
}
has_structs = structs.count() > 0;
std::sort(structs.data(), structs.data() + structs.count(), [](const char* a, const char* b) { return sicmp(a, b) < 0; });
save_api_reference_links(fp, category, structs, "structs", related);
}
// Save enums.md.
bool has_enums = false;
{
Array<const char*> enums;
for (int i = 0; i < index_list.size(); ++i) {
const char* title = index_list[i];
if (s->docs[s->get_doc_index(title)].type == DOC_ENUM) {
enums.add(title);
}
}
has_enums = enums.count() > 0;
std::sort(enums.data(), enums.data() + enums.count(), [](const char* a, const char* b) { return sicmp(a, b) < 0; });
save_api_reference_links(fp, category, enums, "enums", related);
}
}
fclose(fp);
}
#if 1
// Delete any old document files that are no longer used in the category folders.
{
for (int i = 0; i < s->categories.count(); ++i) {
const char* category = s->categories.keys()[i];
CF_Path path = "/docs";
path.add(category);
CF_Directory dir = CF_Directory::open(path);
const char* file;
while ((file = dir.next())) {
if (siequ(file, "enums.md") || siequ(file, "functions.md") || siequ(file, "structs.md")) {
continue;
}
if (!s->has_doc(file)) {
CF_Path filepath = path;
filepath += file;
fs_remove(filepath.c_str());
}
}
}
}
#endif
return 0;
}