apex-ruby 1.0.18 → 1.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +17 -3
- data/ext/apex_ext/apex_ext.c +260 -91
- data/ext/apex_ext/apex_src/CHANGELOG.md +440 -0
- data/ext/apex_ext/apex_src/CMakeLists.txt +15 -1
- data/ext/apex_ext/apex_src/Formula/apex.rb +7 -2
- data/ext/apex_ext/apex_src/Package.swift +15 -4
- data/ext/apex_ext/apex_src/README.md +94 -35
- data/ext/apex_ext/apex_src/VERSION +1 -1
- data/ext/apex_ext/apex_src/apex-debug.log +4 -0
- data/ext/apex_ext/apex_src/apex.code-workspace +38 -0
- data/ext/apex_ext/apex_src/apex.taskpaper +12 -0
- data/ext/apex_ext/apex_src/apex_deflist_debug.log +25 -0
- data/ext/apex_ext/apex_src/buildnotes.md +1435 -0
- data/ext/apex_ext/apex_src/cli/main.c +262 -33
- data/ext/apex_ext/apex_src/debug.log +7 -0
- data/ext/apex_ext/apex_src/docs/CITATIONS_EXAMPLES.md +274 -0
- data/ext/apex_ext/apex_src/docs/CITATIONS_IMPLEMENTATION_PLAN.md +749 -0
- data/ext/apex_ext/apex_src/docs/CITATIONS_PLAN.md +744 -0
- data/ext/apex_ext/apex_src/docs/INDEX_IMPLEMENTATION_ANALYSIS.md +382 -0
- data/ext/apex_ext/apex_src/docs/plans/2025-02-27-man-page-output-implementation.md +351 -0
- data/ext/apex_ext/apex_src/docs/superpowers/plans/2026-07-12-toc-output-format.md +745 -0
- data/ext/apex_ext/apex_src/docs/superpowers/plans/2026-07-18-bear-image-attributes.md +829 -0
- data/ext/apex_ext/apex_src/docs/superpowers/plans/2026-07-19-apex-node-npm.md +1148 -0
- data/ext/apex_ext/apex_src/docs/superpowers/specs/2026-07-12-toc-output-format-design.md +161 -0
- data/ext/apex_ext/apex_src/docs/superpowers/specs/2026-07-18-bear-image-attributes-design.md +184 -0
- data/ext/apex_ext/apex_src/docs/superpowers/specs/2026-07-19-apex-node-npm-design.md +211 -0
- data/ext/apex_ext/apex_src/documentation/app-settings-table.md +67 -0
- data/ext/apex_ext/apex_src/documentation/app-transformed/Citations.md +340 -0
- data/ext/apex_ext/apex_src/documentation/app-transformed/Credits.md +11 -0
- data/ext/apex_ext/apex_src/documentation/app-transformed/Header-IDs.md +234 -0
- data/ext/apex_ext/apex_src/documentation/app-transformed/Inline-Attribute-Lists.md +516 -0
- data/ext/apex_ext/apex_src/documentation/app-transformed/Metadata-Transforms.md +461 -0
- data/ext/apex_ext/apex_src/documentation/app-transformed/Modes.md +193 -0
- data/ext/apex_ext/apex_src/documentation/app-transformed/Multi-File-Documents.md +201 -0
- data/ext/apex_ext/apex_src/documentation/app-transformed/Plugins.md +678 -0
- data/ext/apex_ext/apex_src/documentation/app-transformed/Syntax.md +1367 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex Command Line Options.cheatsheet.txt +6 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/C-API.html +774 -300
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Callouts.html +1194 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Citations.html +416 -216
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Command-Line-Options.html +3544 -1094
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Configuration.html +371 -97
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Credits.html +153 -23
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Examples.html +358 -124
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Filters.html +1656 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Generating-Man-Pages.html +1226 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Getting-Started.html +201 -56
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Header-IDs.html +279 -109
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Home.html +200 -53
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Indices.html +2327 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Inline-Attribute-Lists.html +690 -271
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Installation.html +201 -55
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Limitations-and-Roadmap.html +238 -68
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Metadata-Transforms.html +421 -221
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Modes.html +340 -78
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Multi-File-Documents.html +251 -86
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Multi-Format-Images.html +1362 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Pandoc-Integration.html +277 -90
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Plugins.html +673 -346
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Quarto-Mode.html +1405 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Rendering-Markdown-In-Terminal.html +1902 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Syntax.html +1939 -1698
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Tables.html +1781 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Troubleshooting.html +315 -140
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Usage.html +307 -113
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Using-Apex-with-Jekyll.html +1132 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Writing-Tests.html +1754 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/Documents/Xcode-Integration.html +872 -376
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/docSet.dsidx +0 -0
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/optimizedIndex.dsidx +0 -0
- data/ext/apex_ext/apex_src/documentation/html/apex-app-docs.html +8746 -0
- data/ext/apex_ext/apex_src/documentation/shared_styles.css +20 -15
- data/ext/apex_ext/apex_src/documentation/transform_for_app.md +55 -0
- data/ext/apex_ext/apex_src/escaping-repro.md +103 -0
- data/ext/apex_ext/apex_src/examples/quick-actions/Markdown to RTF.workflow/Contents/Info.plist +8 -0
- data/ext/apex_ext/apex_src/examples/quick-actions/Markdown to RTF.workflow/Contents/QuickLook/Preview.png +0 -0
- data/ext/apex_ext/apex_src/examples/quick-actions/Markdown to RTF.workflow/Contents/document.wflow +547 -0
- data/ext/apex_ext/apex_src/examples/quick-actions/Markdown-to-RTF.workflow.zip +0 -0
- data/ext/apex_ext/apex_src/examples/quick-actions/README.md +33 -0
- data/ext/apex_ext/apex_src/include/apex/apex.h +92 -6
- data/ext/apex_ext/apex_src/include/apex/ast_rtf.h +23 -0
- data/ext/apex_ext/apex_src/include/apex/ast_terminal.h +6 -0
- data/ext/apex_ext/apex_src/include/apex/module.modulemap +5 -0
- data/ext/apex_ext/apex_src/include/apex/plugins.h +105 -0
- data/ext/apex_ext/apex_src/include/apexc.h +1 -0
- data/ext/apex_ext/apex_src/man/apex.1 +82 -78
- data/ext/apex_ext/apex_src/man/apex.1.md +81 -4
- data/ext/apex_ext/apex_src/objc/Apex.swift +73 -0
- data/ext/apex_ext/apex_src/objc/ApexPlugins.swift +79 -0
- data/ext/apex_ext/apex_src/objc/NSString+Apex.h +83 -5
- data/ext/apex_ext/apex_src/objc/NSString+Apex.m +244 -1
- data/ext/apex_ext/apex_src/objc/NSString+ApexPlugins.h +76 -0
- data/ext/apex_ext/apex_src/objc/NSString+ApexPlugins.m +169 -0
- data/ext/apex_ext/apex_src/output.html +87 -0
- data/ext/apex_ext/apex_src/plans/quarto-mode.md +442 -0
- data/ext/apex_ext/apex_src/src/_README.md +85 -32
- data/ext/apex_ext/apex_src/src/apex.c +770 -200
- data/ext/apex_ext/apex_src/src/ast_rtf.c +848 -0
- data/ext/apex_ext/apex_src/src/ast_terminal.c +184 -7
- data/ext/apex_ext/apex_src/src/extensions/abbreviations.c +10 -3
- data/ext/apex_ext/apex_src/src/extensions/advanced_tables.c +7 -11
- data/ext/apex_ext/apex_src/src/extensions/bear_image_attrs.c +467 -0
- data/ext/apex_ext/apex_src/src/extensions/bear_image_attrs.h +27 -0
- data/ext/apex_ext/apex_src/src/extensions/callouts.c +400 -4
- data/ext/apex_ext/apex_src/src/extensions/callouts.h +15 -5
- data/ext/apex_ext/apex_src/src/extensions/citations.c +26 -5
- data/ext/apex_ext/apex_src/src/extensions/code_fence_attrs.c +632 -0
- data/ext/apex_ext/apex_src/src/extensions/code_fence_attrs.h +22 -0
- data/ext/apex_ext/apex_src/src/extensions/concordance.c +632 -0
- data/ext/apex_ext/apex_src/src/extensions/definition_list.c +129 -15
- data/ext/apex_ext/apex_src/src/extensions/grid_tables.c +1050 -121
- data/ext/apex_ext/apex_src/src/extensions/html_markdown.c +569 -16
- data/ext/apex_ext/apex_src/src/extensions/ial.c +502 -52
- data/ext/apex_ext/apex_src/src/extensions/ial.h +2 -1
- data/ext/apex_ext/apex_src/src/extensions/includes.c +532 -33
- data/ext/apex_ext/apex_src/src/extensions/includes.h +7 -1
- data/ext/apex_ext/apex_src/src/extensions/index.c +1427 -140
- data/ext/apex_ext/apex_src/src/extensions/index.h +28 -0
- data/ext/apex_ext/apex_src/src/extensions/metadata.c +200 -161
- data/ext/apex_ext/apex_src/src/extensions/quarto_diagrams.c +251 -0
- data/ext/apex_ext/apex_src/src/extensions/quarto_diagrams.h +22 -0
- data/ext/apex_ext/apex_src/src/extensions/quarto_lists.c +624 -0
- data/ext/apex_ext/apex_src/src/extensions/quarto_lists.h +35 -0
- data/ext/apex_ext/apex_src/src/extensions/quarto_polish.c +264 -0
- data/ext/apex_ext/apex_src/src/extensions/quarto_polish.h +23 -0
- data/ext/apex_ext/apex_src/src/extensions/quarto_shortcodes.c +307 -0
- data/ext/apex_ext/apex_src/src/extensions/quarto_shortcodes.h +21 -0
- data/ext/apex_ext/apex_src/src/extensions/raw_content.c +351 -0
- data/ext/apex_ext/apex_src/src/extensions/raw_content.h +20 -0
- data/ext/apex_ext/apex_src/src/extensions/relaxed_tables.c +117 -3
- data/ext/apex_ext/apex_src/src/extensions/special_markers.c +53 -0
- data/ext/apex_ext/apex_src/src/extensions/syntax_highlight.c +23 -1
- data/ext/apex_ext/apex_src/src/extensions/table_html_postprocess.c +83 -92
- data/ext/apex_ext/apex_src/src/extensions/toc.c +446 -25
- data/ext/apex_ext/apex_src/src/extensions/toc.h +26 -1
- data/ext/apex_ext/apex_src/src/extensions/wiki_links.c +28 -0
- data/ext/apex_ext/apex_src/src/html_renderer.c +387 -17
- data/ext/apex_ext/apex_src/src/plugin_catalog.c +517 -0
- data/ext/apex_ext/apex_src/src/plugins_remote.c +88 -14
- data/ext/apex_ext/apex_src/src/plugins_remote.h +34 -0
- data/ext/apex_ext/apex_src/src/pretty_html.c +6 -1
- data/ext/apex_ext/apex_src/tests/fixtures/comprehensive_test.md +21 -0
- data/ext/apex_ext/apex_src/tests/fixtures/images/bear_image_attributes.md +10 -0
- data/ext/apex_ext/apex_src/tests/fixtures/includes/sections.md +19 -0
- data/ext/apex_ext/apex_src/tests/fixtures/includes/sections.txt +11 -0
- data/ext/apex_ext/apex_src/tests/fixtures/minimal_pb.md +2 -0
- data/ext/apex_ext/apex_src/tests/fixtures/obsidian-callouts.md +46 -0
- data/ext/apex_ext/apex_src/tests/fixtures/pagebreak_html_repro.md +5 -0
- data/ext/apex_ext/apex_src/tests/fixtures/python-callouts.md +47 -0
- data/ext/apex_ext/apex_src/tests/fixtures/quarto/callouts.md +3 -0
- data/ext/apex_ext/apex_src/tests/fixtures/quarto/code-attrs.md +3 -0
- data/ext/apex_ext/apex_src/tests/fixtures/quarto/diagrams.md +8 -0
- data/ext/apex_ext/apex_src/tests/fixtures/quarto/lists.md +19 -0
- data/ext/apex_ext/apex_src/tests/fixtures/quarto/raw-content.md +5 -0
- data/ext/apex_ext/apex_src/tests/fixtures/quarto/shortcodes.md +7 -0
- data/ext/apex_ext/apex_src/tests/fixtures/quarto/smoke.md +81 -0
- data/ext/apex_ext/apex_src/tests/fixtures/quarto/spans.md +5 -0
- data/ext/apex_ext/apex_src/tests/fixtures/quarto-callouts.md +47 -0
- data/ext/apex_ext/apex_src/tests/fixtures/speed.md +192 -0
- data/ext/apex_ext/apex_src/tests/fixtures/tables/grid-tables.md +37 -0
- data/ext/apex_ext/apex_src/tests/paginate_cli_test.sh +16 -0
- data/ext/apex_ext/apex_src/tests/test_bear_image_attrs.c +301 -0
- data/ext/apex_ext/apex_src/tests/test_concordance.tsv +4 -0
- data/ext/apex_ext/apex_src/tests/test_escaping_repro.c +82 -0
- data/ext/apex_ext/apex_src/tests/test_extensions.c +821 -1
- data/ext/apex_ext/apex_src/tests/test_ial.c +7 -0
- data/ext/apex_ext/apex_src/tests/test_marked_integration.c +25 -0
- data/ext/apex_ext/apex_src/tests/test_metadata.c +129 -0
- data/ext/apex_ext/apex_src/tests/test_output.c +568 -2
- data/ext/apex_ext/apex_src/tests/test_runner.c +11 -0
- data/ext/apex_ext/apex_src/tests/test_tables.c +420 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/CMakeLists.txt +1 -1
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/autolink.c +77 -1
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/extensions/table.c +135 -5
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/blocks.c +56 -1
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/config.h +38 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/src/main.c +1 -1
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/__pycache__/cmark.cpython-314.pyc +0 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/__pycache__/normalize.cpython-314.pyc +0 -0
- data/ext/apex_ext/apex_src/vendor/cmark-gfm/test/extensions.txt +69 -0
- data/ext/apex_ext/apex_src/xcode_build/CMakeScripts/ReRunCMake.make +74 -0
- data/ext/apex_ext/apex_src/xcode_build/CTestTestfile.cmake +22 -0
- data/ext/apex_ext/apex_src/xcode_build/Debug/Apex.framework/Versions/A/Apex +0 -0
- data/ext/apex_ext/apex_src/xcode_build/Debug/Apex.framework/Versions/A/Resources/Info.plist +44 -0
- data/ext/apex_ext/apex_src/xcode_build/Debug/Apex.framework/Versions/A/_CodeSignature/CodeResources +128 -0
- data/ext/apex_ext/apex_src/xcode_build/apex.xcodeproj/project.pbxproj +5118 -0
- data/ext/apex_ext/apex_src/xcode_build/apex.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings +8 -0
- data/ext/apex_ext/apex_src/xcode_build/apex.xcodeproj/project.xcworkspace/xcuserdata/ttscoff.xcuserdatad/UserInterfaceState.xcuserstate +0 -0
- data/ext/apex_ext/apex_src/xcode_build/apex.xcodeproj/project.xcworkspace/xcuserdata/ttscoff.xcuserdatad/WorkspaceSettings.xcsettings +8 -0
- data/ext/apex_ext/apex_src/xcode_build/apex.xcodeproj/xcuserdata/ttscoff.xcuserdatad/xcschemes/xcschememanagement.plist +99 -0
- data/ext/apex_ext/apex_src/xcode_build/cmake_install.cmake +452 -0
- data/ext/apex_ext/apex_src/xcode_build/vendor/cmark-gfm/CMakeScripts/ReRunCMake.make +52 -0
- data/ext/apex_ext/apex_src/xcode_build/vendor/cmark-gfm/cmake_install.cmake +55 -0
- data/ext/apex_ext/apex_src/xcode_build/vendor/cmark-gfm/cmark-gfm.xcodeproj/project.pbxproj +2455 -0
- data/ext/apex_ext/apex_src/xcode_build/vendor/cmark-gfm/cmark-gfm.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings +8 -0
- data/ext/apex_ext/apex_src/xcode_build/vendor/cmark-gfm/extensions/cmake_install.cmake +171 -0
- data/ext/apex_ext/apex_src/xcode_build/vendor/cmark-gfm/man/cmake_install.cmake +55 -0
- data/ext/apex_ext/apex_src/xcode_build/vendor/cmark-gfm/src/cmake_install.cmake +220 -0
- data/ext/apex_ext/apex_src/xcode_build/vendor/cmark-gfm/src/cmark-gfm_export.h +43 -0
- data/ext/apex_ext/apex_src/xcode_build/vendor/cmark-gfm/src/cmark-gfm_version.h +7 -0
- data/ext/apex_ext/apex_src/xcode_build/vendor/cmark-gfm/src/config.h +76 -0
- data/ext/apex_ext/apex_src/xcode_build/vendor/cmark-gfm/src/libcmark-gfm.pc +10 -0
- data/ext/apex_ext/extconf.rb +35 -0
- data/lib/apex/version.rb +2 -2
- metadata +117 -2
- data/ext/apex_ext/apex_src/documentation/docsets/Apex.docset/Contents/Resources/tempOptimizedIndex.dsidx +0 -0
|
@@ -0,0 +1,1754 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
|
|
4
|
+
<head>
|
|
5
|
+
|
|
6
|
+
<meta charset="UTF-8">
|
|
7
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
8
|
+
<meta name="generator" content="Apex 1.1.12">
|
|
9
|
+
<title>Document</title>
|
|
10
|
+
<style>
|
|
11
|
+
/* GitHub-style syntax highlighting for Pygments and Skylighting */
|
|
12
|
+
/* Don't apply background to wrapper when code highlighting is enabled - let default styles handle it */
|
|
13
|
+
.code-highlighted .highlight, .code-highlighted .sourceCode { background: inherit; border-radius: 6px; padding: 16px; overflow-x: auto; }
|
|
14
|
+
.highlight pre, .sourceCode pre { margin: 0; padding: 0; background: transparent; }
|
|
15
|
+
.highlight code, .sourceCode code { font-family: 'SFMono-Regular', Consolas, 'Liberation Mono', Menlo, monospace; font-size: 12px; line-height: 1.45; }
|
|
16
|
+
/* Pygments classes */
|
|
17
|
+
.highlight .k { color: #d73a49; font-weight: 600; } /* Keyword */
|
|
18
|
+
.highlight .kt { color: #d73a49; } /* Keyword.Type */
|
|
19
|
+
.highlight .kd { color: #d73a49; font-weight: 600; } /* Keyword.Declaration */
|
|
20
|
+
.highlight .kn { color: #d73a49; } /* Keyword.Namespace */
|
|
21
|
+
.highlight .kp { color: #d73a49; } /* Keyword.Pseudo */
|
|
22
|
+
.highlight .kr { color: #d73a49; font-weight: 600; } /* Keyword.Reserved */
|
|
23
|
+
.highlight .n { color: #6f42c1; } /* Name */
|
|
24
|
+
.highlight .na { color: #6f42c1; } /* Name.Attribute */
|
|
25
|
+
.highlight .nc { color: #6f42c1; font-weight: 600; } /* Name.Class */
|
|
26
|
+
.highlight .no { color: #005cc5; } /* Name.Constant */
|
|
27
|
+
.highlight .nd { color: #6f42c1; font-weight: 600; } /* Name.Decorator */
|
|
28
|
+
.highlight .ni { color: #800080; } /* Name.Entity */
|
|
29
|
+
.highlight .ne { color: #990000; font-weight: 600; } /* Name.Exception */
|
|
30
|
+
.highlight .nf { color: #6f42c1; font-weight: 600; } /* Name.Function */
|
|
31
|
+
.highlight .nl { color: #6f42c1; } /* Name.Label */
|
|
32
|
+
.highlight .nn { color: #555; } /* Name.Namespace */
|
|
33
|
+
.highlight .nt { color: #22863a; } /* Name.Tag */
|
|
34
|
+
.highlight .nv { color: #e36209; } /* Name.Variable */
|
|
35
|
+
.highlight .s { color: #032f62; } /* String */
|
|
36
|
+
.highlight .sb { color: #032f62; } /* String.Backtick */
|
|
37
|
+
.highlight .sc { color: #032f62; } /* String.Char */
|
|
38
|
+
.highlight .sd { color: #032f62; } /* String.Doc */
|
|
39
|
+
.highlight .s2 { color: #032f62; } /* String.Double */
|
|
40
|
+
.highlight .se { color: #032f62; } /* String.Escape */
|
|
41
|
+
.highlight .sh { color: #032f62; } /* String.Heredoc */
|
|
42
|
+
.highlight .si { color: #032f62; } /* String.Interpol */
|
|
43
|
+
.highlight .sx { color: #032f62; } /* String.Other */
|
|
44
|
+
.highlight .sr { color: #032f62; } /* String.Regex */
|
|
45
|
+
.highlight .s1 { color: #032f62; } /* String.Single */
|
|
46
|
+
.highlight .ss { color: #032f62; } /* String.Symbol */
|
|
47
|
+
.highlight .c { color: #6a737d; font-style: italic; } /* Comment */
|
|
48
|
+
.highlight .c1 { color: #6a737d; font-style: italic; } /* Comment.Single */
|
|
49
|
+
.highlight .cm { color: #6a737d; font-style: italic; } /* Comment.Multiline */
|
|
50
|
+
.highlight .cp { color: #6a737d; font-weight: 600; } /* Comment.Preproc */
|
|
51
|
+
.highlight .cs { color: #6a737d; font-weight: 600; font-style: italic; } /* Comment.Special */
|
|
52
|
+
.highlight .m { color: #005cc5; } /* Literal.Number */
|
|
53
|
+
.highlight .mb { color: #005cc5; } /* Literal.Number.Bin */
|
|
54
|
+
.highlight .mf { color: #005cc5; } /* Literal.Number.Float */
|
|
55
|
+
.highlight .mh { color: #005cc5; } /* Literal.Number.Hex */
|
|
56
|
+
.highlight .mi { color: #005cc5; } /* Literal.Number.Integer */
|
|
57
|
+
.highlight .il { color: #005cc5; } /* Literal.Number.Integer.Long */
|
|
58
|
+
.highlight .mo { color: #005cc5; } /* Literal.Number.Oct */
|
|
59
|
+
.highlight .o { color: #d73a49; } /* Operator */
|
|
60
|
+
.highlight .ow { color: #d73a49; } /* Operator.Word */
|
|
61
|
+
.highlight .p { color: #24292e; } /* Punctuation */
|
|
62
|
+
.highlight .w { color: #e1e4e8; } /* Text.Whitespace */
|
|
63
|
+
/* Skylighting classes */
|
|
64
|
+
.sourceCode .kw { color: #d73a49; font-weight: 600; } /* Keyword */
|
|
65
|
+
.sourceCode .dt { color: #6f42c1; } /* DataType */
|
|
66
|
+
.sourceCode .dv { color: #005cc5; } /* DecVal */
|
|
67
|
+
.sourceCode .bn { color: #005cc5; } /* BaseN */
|
|
68
|
+
.sourceCode .fl { color: #005cc5; } /* Float */
|
|
69
|
+
.sourceCode .ch { color: #032f62; } /* Char */
|
|
70
|
+
.sourceCode .st { color: #032f62; } /* String */
|
|
71
|
+
.sourceCode .co { color: #6a737d; font-style: italic; } /* Comment */
|
|
72
|
+
.sourceCode .ot { color: #22863a; } /* Other */
|
|
73
|
+
.sourceCode .al { color: #e36209; font-weight: 600; } /* Alert */
|
|
74
|
+
.sourceCode .fu { color: #6f42c1; font-weight: 600; } /* Function */
|
|
75
|
+
.sourceCode .re { color: #032f62; } /* RegionMarker */
|
|
76
|
+
.sourceCode .er { color: #d73a49; font-weight: 600; } /* Error */
|
|
77
|
+
.sourceCode .cf { color: #d73a49; font-weight: 600; } /* ControlFlow */
|
|
78
|
+
.sourceCode .op { color: #d73a49; } /* Operator */
|
|
79
|
+
.sourceCode .pp { color: #6a737d; } /* Preprocessor */
|
|
80
|
+
.sourceCode .at { color: #005cc5; } /* Attribute */
|
|
81
|
+
.sourceCode .do { color: #6a737d; font-style: italic; } /* Documentation */
|
|
82
|
+
.sourceCode .an { color: #6a737d; font-weight: 600; } /* Annotation */
|
|
83
|
+
.sourceCode .cv { color: #6a737d; font-weight: 600; font-style: italic; } /* CommentVar */
|
|
84
|
+
.sourceCode .in { color: #6a737d; } /* Information */
|
|
85
|
+
.sourceCode .wa { color: #e36209; font-weight: 600; } /* Warning */
|
|
86
|
+
.sourceCode .im { color: #d73a49; } /* Import */
|
|
87
|
+
.sourceCode .bu { color: #005cc5; } /* BuiltIn */
|
|
88
|
+
.sourceCode .ex { color: #6f42c1; } /* Extension */
|
|
89
|
+
.sourceCode .va { color: #e36209; } /* Variable */
|
|
90
|
+
.sourceCode .ss { color: #032f62; } /* SpecialString */
|
|
91
|
+
.sourceCode .sc { color: #032f62; } /* SpecialChar */
|
|
92
|
+
.sourceCode .vs { color: #032f62; } /* VerbatimString */
|
|
93
|
+
.sourceCode .il { color: #005cc5; } /* Special */
|
|
94
|
+
/* Line numbers (Skylighting) */
|
|
95
|
+
.sourceCode.numberSource .sourceCode { counter-reset: line; }
|
|
96
|
+
.sourceCode.numberSource .sourceCode > span { position: relative; left: -4em; counter-increment: line; }
|
|
97
|
+
.sourceCode.numberSource .sourceCode > span > a:first-child::before { content: counter(line); position: relative; left: -1em; text-align: right; vertical-align: baseline; border: none; display: inline-block; min-width: 1em; padding-right: 0.5em; color: #aaa; }
|
|
98
|
+
</style>
|
|
99
|
+
<style>
|
|
100
|
+
body {
|
|
101
|
+
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Helvetica, Arial, sans-serif;
|
|
102
|
+
line-height: 1.6;
|
|
103
|
+
max-width: 800px;
|
|
104
|
+
margin: 2rem auto;
|
|
105
|
+
padding: 0 1rem;
|
|
106
|
+
color: #333;
|
|
107
|
+
}
|
|
108
|
+
pre { background: #f5f5f5; padding: 1rem; overflow-x: auto; }
|
|
109
|
+
code { background: #f0f0f0; padding: 0.2em 0.4em; border-radius: 3px; }
|
|
110
|
+
blockquote { border-left: 4px solid #ddd; margin: 0; padding-left: 1rem; color: #666; }
|
|
111
|
+
table { border-collapse: collapse; width: 100%%; }
|
|
112
|
+
th, td { border: 1px solid #ddd; padding: 0.5rem; }
|
|
113
|
+
th { background: #f5f5f5; }
|
|
114
|
+
tfoot td { background: #e8e8e8; }
|
|
115
|
+
figure.table-figure { width: fit-content; margin: 1em 0; }
|
|
116
|
+
figure.table-figure table { width: auto; }
|
|
117
|
+
figcaption { text-align: center; font-weight: bold; font-size: 0.8em; }
|
|
118
|
+
.page-break { page-break-after: always; }
|
|
119
|
+
.callout { padding: 1rem; margin: 1rem 0; border-left: 4px solid; }
|
|
120
|
+
.callout-note { border-color: #3b82f6; background: #eff6ff; }
|
|
121
|
+
.callout-warning { border-color: #f59e0b; background: #fffbeb; }
|
|
122
|
+
.callout-tip { border-color: #10b981; background: #f0fdf4; }
|
|
123
|
+
.callout-danger { border-color: #ef4444; background: #fef2f2; }
|
|
124
|
+
ins { background: #d4fcbc; text-decoration: none; }
|
|
125
|
+
del { background: #fbb6c2; text-decoration: line-through; }
|
|
126
|
+
mark { background: #fff3cd; }
|
|
127
|
+
.smallcaps { font-variant: small-caps; }
|
|
128
|
+
.underline { text-decoration: underline; }
|
|
129
|
+
span.mark { background: #fff3cd; }
|
|
130
|
+
.hidden { display: none; }
|
|
131
|
+
.quarto-xref { font-variant: normal; }
|
|
132
|
+
.critic.comment { background: #e7e7e7; color: #666; font-style: italic; }
|
|
133
|
+
.mkhashtag { color: #666; }
|
|
134
|
+
.mkstyledtag {
|
|
135
|
+
display: inline-block;
|
|
136
|
+
background: #e0e0e0;
|
|
137
|
+
padding: 3px 9px;
|
|
138
|
+
border-radius: 20px;
|
|
139
|
+
font-size: 0.9em;
|
|
140
|
+
line-height: 1.4;
|
|
141
|
+
color: #333;
|
|
142
|
+
margin: 0 2px;
|
|
143
|
+
}
|
|
144
|
+
</style>
|
|
145
|
+
<meta name="paginate" content="symbols"/>
|
|
146
|
+
<meta name="highlight-language-only" content="true"/>
|
|
147
|
+
<meta name="code-line-numbers" content="false"/>
|
|
148
|
+
<meta name="code-highlight" content="pygments"/>
|
|
149
|
+
<meta name="sup-sub" content="true"/>
|
|
150
|
+
<meta name="relaxed-tables" content="true"/>
|
|
151
|
+
<meta name="includes" content="true"/>
|
|
152
|
+
<meta name="autolink" content="true"/>
|
|
153
|
+
<meta name="pretty" content="false"/>
|
|
154
|
+
<meta name="standalone" content="false"/>
|
|
155
|
+
<meta name="mode" content="unified"/>
|
|
156
|
+
<meta name="markdown-in-html" content="true"/>
|
|
157
|
+
<meta name="image-captions" content="true"/>
|
|
158
|
+
<meta name="wikilink-extension" content="html"/>
|
|
159
|
+
<meta name="wikilink-space" content="hyphen"/>
|
|
160
|
+
<meta name="wikilinks" content="true"/>
|
|
161
|
+
<meta name="widont" content="true"/>
|
|
162
|
+
<meta name="plugins" content="true"/>
|
|
163
|
+
<meta name="id-format" content="gfm"/>
|
|
164
|
+
|
|
165
|
+
<style>
|
|
166
|
+
:root {
|
|
167
|
+
/* border-box width of the fixed sidebar; body offset includes a small gap */
|
|
168
|
+
--sidebar-width: 250px;
|
|
169
|
+
--sidebar-offset: 270px;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
/* Base styles — override Apex standalone centering (max-width + margin: auto) */
|
|
173
|
+
body {
|
|
174
|
+
-webkit-font-smoothing: antialiased;
|
|
175
|
+
-moz-osx-font-smoothing: grayscale;
|
|
176
|
+
font-size: 17px;
|
|
177
|
+
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
|
|
178
|
+
"Helvetica Neue", Arial, sans-serif;
|
|
179
|
+
line-height: 1.65;
|
|
180
|
+
color: #1e293b;
|
|
181
|
+
background-color: #fff;
|
|
182
|
+
max-width: none;
|
|
183
|
+
width: auto;
|
|
184
|
+
margin: 2rem 2rem 2rem var(--sidebar-offset);
|
|
185
|
+
padding: 0 1rem;
|
|
186
|
+
box-sizing: border-box;
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
/* Sidebar / Main TOC - wider on larger screens */
|
|
190
|
+
.main-toc,
|
|
191
|
+
.sidebar {
|
|
192
|
+
position: fixed;
|
|
193
|
+
left: 0;
|
|
194
|
+
top: 0;
|
|
195
|
+
box-sizing: border-box;
|
|
196
|
+
width: var(--sidebar-width);
|
|
197
|
+
min-width: var(--sidebar-width);
|
|
198
|
+
max-width: var(--sidebar-width);
|
|
199
|
+
height: 100vh;
|
|
200
|
+
overflow-y: auto;
|
|
201
|
+
background: #1e293b;
|
|
202
|
+
color: rgba(255, 255, 255, 0.9);
|
|
203
|
+
border-right: 2px solid rgba(255, 255, 255, 0.1);
|
|
204
|
+
padding: 24px 20px 130px;
|
|
205
|
+
font-size: 14px;
|
|
206
|
+
z-index: 100;
|
|
207
|
+
box-shadow: 4px 0 24px rgba(0, 0, 0, 0.08);
|
|
208
|
+
transition: transform 0.3s ease;
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
.main-toc ul,
|
|
212
|
+
.sidebar ul {
|
|
213
|
+
list-style: none;
|
|
214
|
+
padding-left: 0;
|
|
215
|
+
margin: 0;
|
|
216
|
+
padding-bottom: 80px;
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
.main-toc ul::after,
|
|
220
|
+
.sidebar ul::after {
|
|
221
|
+
content: "";
|
|
222
|
+
display: block;
|
|
223
|
+
height: 80px;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
.main-toc li,
|
|
227
|
+
.sidebar li {
|
|
228
|
+
margin: 0.25em 0;
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
.main-toc a,
|
|
232
|
+
.sidebar a {
|
|
233
|
+
color: rgba(255, 255, 255, 0.85);
|
|
234
|
+
text-decoration: none;
|
|
235
|
+
display: block;
|
|
236
|
+
padding: 6px 12px;
|
|
237
|
+
border-radius: 4px;
|
|
238
|
+
transition: all 0.15s ease;
|
|
239
|
+
white-space: nowrap;
|
|
240
|
+
overflow: hidden;
|
|
241
|
+
text-overflow: ellipsis;
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
.main-toc a:hover,
|
|
245
|
+
.sidebar a:hover {
|
|
246
|
+
background: #334155;
|
|
247
|
+
color: #fff;
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
.sidebar a.active {
|
|
251
|
+
color: #0ea5e9;
|
|
252
|
+
font-weight: 500;
|
|
253
|
+
}
|
|
254
|
+
|
|
255
|
+
/* Hamburger menu button */
|
|
256
|
+
.hamburger-menu {
|
|
257
|
+
display: none;
|
|
258
|
+
position: fixed;
|
|
259
|
+
top: 12px;
|
|
260
|
+
left: 12px;
|
|
261
|
+
z-index: 200;
|
|
262
|
+
background: #1e293b;
|
|
263
|
+
border: 2px solid rgba(255, 255, 255, 0.1);
|
|
264
|
+
border-radius: 6px;
|
|
265
|
+
padding: 10px;
|
|
266
|
+
cursor: pointer;
|
|
267
|
+
color: rgba(255, 255, 255, 0.9);
|
|
268
|
+
font-size: 20px;
|
|
269
|
+
line-height: 1;
|
|
270
|
+
box-sizing: border-box;
|
|
271
|
+
width: 44px;
|
|
272
|
+
height: 44px;
|
|
273
|
+
align-items: center;
|
|
274
|
+
justify-content: center;
|
|
275
|
+
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.2);
|
|
276
|
+
transition: all 0.2s ease;
|
|
277
|
+
opacity: 0.2;
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
.hamburger-menu:hover {
|
|
281
|
+
background: #334155;
|
|
282
|
+
color: #fff;
|
|
283
|
+
opacity: 1;
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
/* Move hamburger to the right of the sidebar when menu is open */
|
|
287
|
+
.hamburger-menu.active {
|
|
288
|
+
left: calc(var(--sidebar-width) + 12px);
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
.hamburger-menu.active {
|
|
292
|
+
background: #0ea5e9;
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
.hamburger-menu::before {
|
|
296
|
+
content: "☰";
|
|
297
|
+
}
|
|
298
|
+
|
|
299
|
+
.hamburger-menu.active::before {
|
|
300
|
+
content: "✕";
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
/* Mobile menu overlay */
|
|
304
|
+
.mobile-menu-overlay {
|
|
305
|
+
display: none;
|
|
306
|
+
position: fixed;
|
|
307
|
+
top: 0;
|
|
308
|
+
left: 0;
|
|
309
|
+
right: 0;
|
|
310
|
+
bottom: 0;
|
|
311
|
+
background: rgba(0, 0, 0, 0.5);
|
|
312
|
+
z-index: 150;
|
|
313
|
+
opacity: 0;
|
|
314
|
+
visibility: hidden;
|
|
315
|
+
transition: opacity 0.3s ease, visibility 0.3s ease;
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
.mobile-menu-overlay.active {
|
|
319
|
+
opacity: 1;
|
|
320
|
+
visibility: visible;
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
/* Page TOC */
|
|
324
|
+
.page-toc {
|
|
325
|
+
background: #f9f9f9;
|
|
326
|
+
border: 1px solid #ddd;
|
|
327
|
+
border-radius: 4px;
|
|
328
|
+
padding: 1rem;
|
|
329
|
+
margin: 1.5rem 0;
|
|
330
|
+
}
|
|
331
|
+
|
|
332
|
+
.page-toc ul {
|
|
333
|
+
list-style: none;
|
|
334
|
+
padding-left: 0;
|
|
335
|
+
margin: 0;
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
.page-toc > ul {
|
|
339
|
+
padding-left: 0;
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
.page-toc li {
|
|
343
|
+
margin: 0.25em 0;
|
|
344
|
+
}
|
|
345
|
+
|
|
346
|
+
.page-toc a {
|
|
347
|
+
color: #0066cc;
|
|
348
|
+
text-decoration: none;
|
|
349
|
+
display: block;
|
|
350
|
+
padding: 0.25em 0.5em;
|
|
351
|
+
border-radius: 3px;
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
.page-toc a:hover {
|
|
355
|
+
background: #e0e0e0;
|
|
356
|
+
color: #004499;
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
.page-toc ul ul {
|
|
360
|
+
list-style: none;
|
|
361
|
+
padding-left: 1.5em;
|
|
362
|
+
margin-top: 0.25em;
|
|
363
|
+
margin-left: 0;
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
.page-toc ul ul ul {
|
|
367
|
+
padding-left: 1.5em;
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
.page-toc ul ul a {
|
|
371
|
+
font-size: 0.9em;
|
|
372
|
+
color: #555;
|
|
373
|
+
}
|
|
374
|
+
|
|
375
|
+
.page-toc ul ul ul a {
|
|
376
|
+
font-size: 0.85em;
|
|
377
|
+
color: #666;
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
/* Floating TOC */
|
|
381
|
+
.floating-toc {
|
|
382
|
+
position: fixed;
|
|
383
|
+
top: 0;
|
|
384
|
+
left: var(--sidebar-offset);
|
|
385
|
+
right: 0;
|
|
386
|
+
z-index: 50;
|
|
387
|
+
opacity: 0;
|
|
388
|
+
visibility: hidden;
|
|
389
|
+
transition: opacity 0.2s ease, visibility 0.2s ease;
|
|
390
|
+
pointer-events: none;
|
|
391
|
+
display: flex;
|
|
392
|
+
justify-content: flex-end;
|
|
393
|
+
padding-right: 2rem;
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
.floating-toc.visible {
|
|
397
|
+
opacity: 1;
|
|
398
|
+
visibility: visible;
|
|
399
|
+
pointer-events: auto;
|
|
400
|
+
}
|
|
401
|
+
|
|
402
|
+
.floating-toc-container {
|
|
403
|
+
background: rgba(255, 255, 255, 0.95);
|
|
404
|
+
backdrop-filter: blur(10px);
|
|
405
|
+
border-bottom: 1px solid #ddd;
|
|
406
|
+
border-radius: 0 0 12px 12px;
|
|
407
|
+
box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1);
|
|
408
|
+
width: fit-content;
|
|
409
|
+
max-width: 400px;
|
|
410
|
+
min-width: 200px;
|
|
411
|
+
overflow: hidden;
|
|
412
|
+
transition: max-height 0.3s ease;
|
|
413
|
+
}
|
|
414
|
+
|
|
415
|
+
.floating-toc-header {
|
|
416
|
+
padding: 8px 16px;
|
|
417
|
+
cursor: pointer;
|
|
418
|
+
user-select: none;
|
|
419
|
+
font-size: 14px;
|
|
420
|
+
font-weight: 500;
|
|
421
|
+
color: #1e293b;
|
|
422
|
+
display: flex;
|
|
423
|
+
align-items: center;
|
|
424
|
+
justify-content: space-between;
|
|
425
|
+
}
|
|
426
|
+
|
|
427
|
+
.floating-toc-header:hover {
|
|
428
|
+
background: rgba(0, 0, 0, 0.02);
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
.floating-toc-content {
|
|
432
|
+
max-height: 0;
|
|
433
|
+
overflow: hidden;
|
|
434
|
+
transition: max-height 0.3s ease;
|
|
435
|
+
}
|
|
436
|
+
|
|
437
|
+
.floating-toc-container:hover .floating-toc-content {
|
|
438
|
+
max-height: 70vh;
|
|
439
|
+
overflow-y: auto;
|
|
440
|
+
}
|
|
441
|
+
|
|
442
|
+
.floating-toc-content ul {
|
|
443
|
+
list-style: none;
|
|
444
|
+
padding: 8px 16px 16px;
|
|
445
|
+
margin: 0;
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
.floating-toc-content li {
|
|
449
|
+
margin: 0.1em 0;
|
|
450
|
+
}
|
|
451
|
+
|
|
452
|
+
.floating-toc-content a {
|
|
453
|
+
color: #0066cc;
|
|
454
|
+
text-decoration: none;
|
|
455
|
+
display: block;
|
|
456
|
+
padding: 0.2em 0.5em;
|
|
457
|
+
border-radius: 4px;
|
|
458
|
+
font-size: 13px;
|
|
459
|
+
transition: background 0.15s ease;
|
|
460
|
+
}
|
|
461
|
+
|
|
462
|
+
.floating-toc-content a:hover {
|
|
463
|
+
background: #e0e0e0;
|
|
464
|
+
color: #004499;
|
|
465
|
+
}
|
|
466
|
+
|
|
467
|
+
.floating-toc-content ul ul {
|
|
468
|
+
padding-left: 1.2em;
|
|
469
|
+
margin-top: 0;
|
|
470
|
+
margin-bottom: 0;
|
|
471
|
+
}
|
|
472
|
+
|
|
473
|
+
.floating-toc-content ul ul ul {
|
|
474
|
+
margin-top: 0;
|
|
475
|
+
margin-bottom: 0;
|
|
476
|
+
}
|
|
477
|
+
|
|
478
|
+
.floating-toc-content ul ul a {
|
|
479
|
+
font-size: 12px;
|
|
480
|
+
color: #555;
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
.floating-toc-content ul ul ul a {
|
|
484
|
+
font-size: 11px;
|
|
485
|
+
color: #666;
|
|
486
|
+
}
|
|
487
|
+
|
|
488
|
+
/* Smooth scrolling */
|
|
489
|
+
html {
|
|
490
|
+
scroll-behavior: smooth;
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
/* Code blocks */
|
|
494
|
+
code {
|
|
495
|
+
background: #f0f0f0;
|
|
496
|
+
padding: 0.2em 0.4em;
|
|
497
|
+
border-radius: 3px;
|
|
498
|
+
font-family: "Monaco", "Menlo", "Ubuntu Mono", monospace;
|
|
499
|
+
font-size: 0.9em;
|
|
500
|
+
margin: 0 0.1em;
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
pre {
|
|
504
|
+
background: #f5f5f5;
|
|
505
|
+
padding: 1rem;
|
|
506
|
+
overflow-x: auto;
|
|
507
|
+
border-radius: 4px;
|
|
508
|
+
margin: 1em 0;
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
pre code {
|
|
512
|
+
background: none;
|
|
513
|
+
padding: 0;
|
|
514
|
+
margin: 0;
|
|
515
|
+
}
|
|
516
|
+
|
|
517
|
+
/* Rouge syntax highlighting - GitHub theme, scoped to .highlight containers */
|
|
518
|
+
.highlight {
|
|
519
|
+
color: #24292e;
|
|
520
|
+
}
|
|
521
|
+
|
|
522
|
+
.highlight .c {
|
|
523
|
+
color: #6a737d;
|
|
524
|
+
font-style: italic;
|
|
525
|
+
} /* Comment */
|
|
526
|
+
.highlight .err {
|
|
527
|
+
color: #a61717;
|
|
528
|
+
background-color: #e3d2d2;
|
|
529
|
+
} /* Error */
|
|
530
|
+
.highlight .k {
|
|
531
|
+
color: #d73a49;
|
|
532
|
+
font-weight: bold;
|
|
533
|
+
} /* Keyword */
|
|
534
|
+
.highlight .l {
|
|
535
|
+
color: #032f62;
|
|
536
|
+
} /* Literal */
|
|
537
|
+
.highlight .n {
|
|
538
|
+
color: #24292e;
|
|
539
|
+
} /* Name */
|
|
540
|
+
.highlight .o {
|
|
541
|
+
color: #d73a49;
|
|
542
|
+
} /* Operator */
|
|
543
|
+
.highlight .p {
|
|
544
|
+
color: #24292e;
|
|
545
|
+
} /* Punctuation */
|
|
546
|
+
.highlight .cm {
|
|
547
|
+
color: #6a737d;
|
|
548
|
+
font-style: italic;
|
|
549
|
+
} /* Comment.Multiline */
|
|
550
|
+
.highlight .cp {
|
|
551
|
+
color: #6a737d;
|
|
552
|
+
font-weight: bold;
|
|
553
|
+
} /* Comment.Preproc */
|
|
554
|
+
.highlight .c1 {
|
|
555
|
+
color: #6a737d;
|
|
556
|
+
font-style: italic;
|
|
557
|
+
} /* Comment.Single */
|
|
558
|
+
.highlight .cs {
|
|
559
|
+
color: #6a737d;
|
|
560
|
+
font-weight: bold;
|
|
561
|
+
font-style: italic;
|
|
562
|
+
} /* Comment.Special */
|
|
563
|
+
.highlight .gd {
|
|
564
|
+
color: #24292e;
|
|
565
|
+
background-color: #ffeef0;
|
|
566
|
+
} /* Generic.Deleted */
|
|
567
|
+
.highlight .ge {
|
|
568
|
+
color: #24292e;
|
|
569
|
+
font-style: italic;
|
|
570
|
+
} /* Generic.Emph */
|
|
571
|
+
.highlight .gr {
|
|
572
|
+
color: #aa0000;
|
|
573
|
+
} /* Generic.Error */
|
|
574
|
+
.highlight .gh {
|
|
575
|
+
color: #999999;
|
|
576
|
+
font-weight: bold;
|
|
577
|
+
} /* Generic.Heading */
|
|
578
|
+
.highlight .gi {
|
|
579
|
+
color: #24292e;
|
|
580
|
+
background-color: #f0fff4;
|
|
581
|
+
} /* Generic.Inserted */
|
|
582
|
+
.highlight .go {
|
|
583
|
+
color: #888888;
|
|
584
|
+
} /* Generic.Output */
|
|
585
|
+
.highlight .gp {
|
|
586
|
+
color: #555555;
|
|
587
|
+
} /* Generic.Prompt */
|
|
588
|
+
.highlight .gs {
|
|
589
|
+
font-weight: bold;
|
|
590
|
+
} /* Generic.Strong */
|
|
591
|
+
.highlight .gu {
|
|
592
|
+
color: #aaaaaa;
|
|
593
|
+
} /* Generic.Subheading */
|
|
594
|
+
.highlight .gt {
|
|
595
|
+
color: #aa0000;
|
|
596
|
+
} /* Generic.Traceback */
|
|
597
|
+
.highlight .kc {
|
|
598
|
+
color: #d73a49;
|
|
599
|
+
font-weight: bold;
|
|
600
|
+
} /* Keyword.Constant */
|
|
601
|
+
.highlight .kd {
|
|
602
|
+
color: #d73a49;
|
|
603
|
+
font-weight: bold;
|
|
604
|
+
} /* Keyword.Declaration */
|
|
605
|
+
.highlight .kn {
|
|
606
|
+
color: #d73a49;
|
|
607
|
+
font-weight: bold;
|
|
608
|
+
} /* Keyword.Namespace */
|
|
609
|
+
.highlight .kp {
|
|
610
|
+
color: #d73a49;
|
|
611
|
+
font-weight: bold;
|
|
612
|
+
} /* Keyword.Pseudo */
|
|
613
|
+
.highlight .kr {
|
|
614
|
+
color: #d73a49;
|
|
615
|
+
font-weight: bold;
|
|
616
|
+
} /* Keyword.Reserved */
|
|
617
|
+
.highlight .kt {
|
|
618
|
+
color: #d73a49;
|
|
619
|
+
font-weight: bold;
|
|
620
|
+
} /* Keyword.Type */
|
|
621
|
+
.highlight .ld {
|
|
622
|
+
color: #032f62;
|
|
623
|
+
} /* Literal.Date */
|
|
624
|
+
.highlight .m {
|
|
625
|
+
color: #005cc5;
|
|
626
|
+
} /* Literal.Number */
|
|
627
|
+
.highlight .s {
|
|
628
|
+
color: #032f62;
|
|
629
|
+
} /* Literal.String */
|
|
630
|
+
.highlight .na {
|
|
631
|
+
color: #6f42c1;
|
|
632
|
+
} /* Name.Attribute */
|
|
633
|
+
.highlight .nb {
|
|
634
|
+
color: #005cc5;
|
|
635
|
+
} /* Name.Builtin */
|
|
636
|
+
.highlight .nc {
|
|
637
|
+
color: #6f42c1;
|
|
638
|
+
font-weight: bold;
|
|
639
|
+
} /* Name.Class */
|
|
640
|
+
.highlight .no {
|
|
641
|
+
color: #005cc5;
|
|
642
|
+
} /* Name.Constant */
|
|
643
|
+
.highlight .nd {
|
|
644
|
+
color: #6f42c1;
|
|
645
|
+
font-weight: bold;
|
|
646
|
+
} /* Name.Decorator */
|
|
647
|
+
.highlight .ni {
|
|
648
|
+
color: #800080;
|
|
649
|
+
} /* Name.Entity */
|
|
650
|
+
.highlight .ne {
|
|
651
|
+
color: #990000;
|
|
652
|
+
font-weight: bold;
|
|
653
|
+
} /* Name.Exception */
|
|
654
|
+
.highlight .nf {
|
|
655
|
+
color: #6f42c1;
|
|
656
|
+
} /* Name.Function */
|
|
657
|
+
.highlight .nl {
|
|
658
|
+
color: #990000;
|
|
659
|
+
} /* Name.Label */
|
|
660
|
+
.highlight .nn {
|
|
661
|
+
color: #555555;
|
|
662
|
+
} /* Name.Namespace */
|
|
663
|
+
.highlight .nx {
|
|
664
|
+
color: #6f42c1;
|
|
665
|
+
} /* Name.Other */
|
|
666
|
+
.highlight .py {
|
|
667
|
+
color: #990000;
|
|
668
|
+
} /* Name.Property */
|
|
669
|
+
.highlight .nt {
|
|
670
|
+
color: #22863a;
|
|
671
|
+
} /* Name.Tag */
|
|
672
|
+
.highlight .nv {
|
|
673
|
+
color: #e36209;
|
|
674
|
+
} /* Name.Variable */
|
|
675
|
+
.highlight .ow {
|
|
676
|
+
color: #d73a49;
|
|
677
|
+
font-weight: bold;
|
|
678
|
+
} /* Operator.Word */
|
|
679
|
+
.highlight .w {
|
|
680
|
+
color: #bbbbbb;
|
|
681
|
+
} /* Text.Whitespace */
|
|
682
|
+
.highlight .mf {
|
|
683
|
+
color: #005cc5;
|
|
684
|
+
} /* Literal.Number.Float */
|
|
685
|
+
.highlight .mh {
|
|
686
|
+
color: #005cc5;
|
|
687
|
+
} /* Literal.Number.Hex */
|
|
688
|
+
.highlight .mi {
|
|
689
|
+
color: #005cc5;
|
|
690
|
+
} /* Literal.Number.Integer */
|
|
691
|
+
.highlight .mo {
|
|
692
|
+
color: #005cc5;
|
|
693
|
+
} /* Literal.Number.Oct */
|
|
694
|
+
.highlight .sb {
|
|
695
|
+
color: #032f62;
|
|
696
|
+
} /* Literal.String.Backtick */
|
|
697
|
+
.highlight .sc {
|
|
698
|
+
color: #032f62;
|
|
699
|
+
} /* Literal.String.Char */
|
|
700
|
+
.highlight .sd {
|
|
701
|
+
color: #032f62;
|
|
702
|
+
} /* Literal.String.Doc */
|
|
703
|
+
.highlight .s2 {
|
|
704
|
+
color: #032f62;
|
|
705
|
+
} /* Literal.String.Double */
|
|
706
|
+
.highlight .se {
|
|
707
|
+
color: #032f62;
|
|
708
|
+
} /* Literal.String.Escape */
|
|
709
|
+
.highlight .sh {
|
|
710
|
+
color: #032f62;
|
|
711
|
+
} /* Literal.String.Heredoc */
|
|
712
|
+
.highlight .si {
|
|
713
|
+
color: #032f62;
|
|
714
|
+
} /* Literal.String.Interpol */
|
|
715
|
+
.highlight .sx {
|
|
716
|
+
color: #032f62;
|
|
717
|
+
} /* Literal.String.Other */
|
|
718
|
+
.highlight .sr {
|
|
719
|
+
color: #22863a;
|
|
720
|
+
} /* Literal.String.Regex */
|
|
721
|
+
.highlight .s1 {
|
|
722
|
+
color: #032f62;
|
|
723
|
+
} /* Literal.String.Single */
|
|
724
|
+
.highlight .ss {
|
|
725
|
+
color: #032f62;
|
|
726
|
+
} /* Literal.String.Symbol */
|
|
727
|
+
.highlight .bp {
|
|
728
|
+
color: #005cc5;
|
|
729
|
+
} /* Name.Builtin.Pseudo */
|
|
730
|
+
.highlight .vc {
|
|
731
|
+
color: #e36209;
|
|
732
|
+
} /* Name.Variable.Class */
|
|
733
|
+
.highlight .vg {
|
|
734
|
+
color: #e36209;
|
|
735
|
+
} /* Name.Variable.Global */
|
|
736
|
+
.highlight .vi {
|
|
737
|
+
color: #e36209;
|
|
738
|
+
} /* Name.Variable.Instance */
|
|
739
|
+
.highlight .il {
|
|
740
|
+
color: #005cc5;
|
|
741
|
+
} /* Literal.Number.Integer.Long */
|
|
742
|
+
|
|
743
|
+
/* Additional Rouge token classes that may be used */
|
|
744
|
+
.highlight .token {
|
|
745
|
+
color: #5670a0;
|
|
746
|
+
}
|
|
747
|
+
.highlight .token.list {
|
|
748
|
+
color: #546e9f;
|
|
749
|
+
}
|
|
750
|
+
.highlight .token.punctuation {
|
|
751
|
+
color: #3e8dad;
|
|
752
|
+
}
|
|
753
|
+
.highlight .token.list.punctuation {
|
|
754
|
+
color: #e05b78;
|
|
755
|
+
}
|
|
756
|
+
.highlight .token.content {
|
|
757
|
+
padding: 0;
|
|
758
|
+
}
|
|
759
|
+
|
|
760
|
+
/* Nested lists in page content */
|
|
761
|
+
ul ul,
|
|
762
|
+
ol ol,
|
|
763
|
+
ul ol,
|
|
764
|
+
ol ul {
|
|
765
|
+
padding-left: 1.5em;
|
|
766
|
+
margin-top: 0.25em;
|
|
767
|
+
}
|
|
768
|
+
|
|
769
|
+
/* Page footer */
|
|
770
|
+
.page-footer {
|
|
771
|
+
background: #f5f5f5;
|
|
772
|
+
border-top: 1px solid #ddd;
|
|
773
|
+
padding: 1.5rem;
|
|
774
|
+
margin-top: 3rem;
|
|
775
|
+
color: #666;
|
|
776
|
+
font-size: 0.9em;
|
|
777
|
+
}
|
|
778
|
+
|
|
779
|
+
.page-footer p {
|
|
780
|
+
margin: 0.5em 0;
|
|
781
|
+
}
|
|
782
|
+
|
|
783
|
+
.page-footer a {
|
|
784
|
+
color: #0066cc;
|
|
785
|
+
text-decoration: none;
|
|
786
|
+
}
|
|
787
|
+
|
|
788
|
+
.page-footer a:hover {
|
|
789
|
+
text-decoration: underline;
|
|
790
|
+
}
|
|
791
|
+
|
|
792
|
+
/* Mobile responsive */
|
|
793
|
+
@media (max-width: 768px) {
|
|
794
|
+
.hamburger-menu {
|
|
795
|
+
display: flex;
|
|
796
|
+
}
|
|
797
|
+
|
|
798
|
+
.main-toc,
|
|
799
|
+
.sidebar {
|
|
800
|
+
transform: translateX(-100%);
|
|
801
|
+
z-index: 175;
|
|
802
|
+
}
|
|
803
|
+
|
|
804
|
+
.main-toc.mobile-open,
|
|
805
|
+
.sidebar.mobile-open {
|
|
806
|
+
transform: translateX(0);
|
|
807
|
+
}
|
|
808
|
+
|
|
809
|
+
body {
|
|
810
|
+
margin: 2rem 1rem;
|
|
811
|
+
}
|
|
812
|
+
|
|
813
|
+
.floating-toc {
|
|
814
|
+
left: 0;
|
|
815
|
+
}
|
|
816
|
+
}
|
|
817
|
+
|
|
818
|
+
</style></head>
|
|
819
|
+
|
|
820
|
+
<body class="code-highlighted">
|
|
821
|
+
<div class="floating-toc" id="floating-toc">
|
|
822
|
+
<div class="floating-toc-container">
|
|
823
|
+
<div class="floating-toc-header">
|
|
824
|
+
<span>Table of Contents 🔻</span>
|
|
825
|
+
</div>
|
|
826
|
+
<div class="floating-toc-content" id="floating-toc-content">
|
|
827
|
+
<!-- Content will be populated by JavaScript -->
|
|
828
|
+
</div>
|
|
829
|
+
</div>
|
|
830
|
+
</div>
|
|
831
|
+
|
|
832
|
+
<button class="hamburger-menu" id="hamburger-menu" aria-label="Toggle navigation"></button>
|
|
833
|
+
<div class="mobile-menu-overlay" id="mobile-menu-overlay"></div>
|
|
834
|
+
|
|
835
|
+
<nav class="main-toc"><ul><li><a href="Home.html">Home</a></li><li><a href="Getting-Started.html">Getting Started</a></li><li><a href="Installation.html">Installation</a></li><li><a href="Usage.html">Usage</a></li><li><a href="Syntax.html">Syntax</a></li><li><a href="Callouts.html">Callouts</a></li><li><a href="Tables.html">Tables</a></li><li><a href="Inline-Attribute-Lists.html">Inline Attribute Lists</a></li><li><a href="Modes.html">Modes</a></li><li><a href="Quarto-Mode.html">Quarto Mode</a></li><li><a href="Command-Line-Options.html">Command Line Options</a></li><li><a href="Rendering-Markdown-In-Terminal.html">Rendering Markdown in the Terminal</a></li><li><a href="Generating-Man-Pages.html">Generating Man Pages</a></li><li><a href="Multi-File-Documents.html">Multi-file Documents</a></li><li><a href="Citations.html">Citations</a></li><li><a href="Indices.html">Indices</a></li><li><a href="Metadata-Transforms.html">Metadata Transforms</a></li><li><a href="Pandoc-Integration.html">Integrating with Pandoc</a></li><li><a href="Using-Apex-with-Jekyll.html">Using Apex with Jekyll</a></li><li><a href="Header-IDs.html">Header IDs</a></li><li><a href="C-API.html">C API</a></li><li><a href="Writing-Tests.html">Writing Tests</a></li><li><a href="Xcode-Integration.html">Xcode Integration</a></li><li><a href="Examples.html">Examples</a></li><li><a href="Plugins.html">Plugins</a></li><li><a href="Filters.html">Filters</a></li><li><a href="Troubleshooting.html">Troubleshooting</a></li><li><a href="Credits.html">Credits</a></li></ul></nav>
|
|
836
|
+
|
|
837
|
+
<h1 id="writing-tests">
|
|
838
|
+
Writing Tests
|
|
839
|
+
</h1>
|
|
840
|
+
<nav class="page-toc" id="page-toc-top"><ul><li><a href="#writing-tests">Writing Tests</a><ul><li><a href="#test-infrastructure-overview">Test Infrastructure Overview</a></li><li><a href="#running-tests">Running Tests</a></li><li><a href="#when-to-create-a-new-test-suite">When to Create a New Test Suite</a></li><li><a href="#test-file-structure">Test File Structure</a><ul><li><a href="#creating-a-new-test-suite">Creating a New Test Suite</a></li><li><a href="#basic-test-file-template">Basic Test File Template</a></li></ul></li><li><a href="#helper-functions-reference">Helper Functions Reference</a><ul><li><a href="#suite-management">Suite Management</a><ul><li><a href="#suitestart">suite_start()</a></li><li><a href="#suiteendint-suitestartfailures">suite_end(int suite_start_failures)</a></li><li><a href="#printsuitetitleconst-char-title-bool-suitehadfailures-bool-atstart">print_suite_title(const char *title, bool suite_had_failures, bool at_start)</a></li></ul></li><li><a href="#assertion-functions">Assertion Functions</a><ul><li><a href="#assertcontainsconst-char-haystack-const-char-needle-const-char-testname">assert_contains(const char *haystack, const char *needle, const char *test_name)</a></li><li><a href="#assertnotcontainsconst-char-haystack-const-char-needle-const-char-testname">assert_not_contains(const char *haystack, const char *needle, const char *test_name)</a></li><li><a href="#assertoptionboolbool-actual-bool-expected-const-char-testname">assert_option_bool(bool actual, bool expected, const char *test_name)</a></li><li><a href="#assertoptionstringconst-char-actual-const-char-expected-const-char-testname">assert_option_string(const char *actual, const char *expected, const char *test_name)</a></li></ul></li><li><a href="#manual-test-results">Manual Test Results</a><ul><li><a href="#testresultbool-passed-const-char-testname">test_result(bool passed, const char *test_name)</a></li><li><a href="#testresultfbool-passed-const-char-format">test_resultf(bool passed, const char *format, ...)</a></li></ul></li></ul></li><li><a href="#apex-api-functions">Apex API Functions</a><ul><li><a href="#core-conversion">Core Conversion</a><ul><li><a href="#apexmarkdowntohtmlconst-char-markdown-sizet-length-apexoptions-opts">apex_markdown_to_html(const char *markdown, size_t length, apex_options *opts)</a></li><li><a href="#apexfreestringchar-str">apex_free_string(char *str)</a></li></ul></li><li><a href="#options">Options</a><ul><li><a href="#apexoptionsdefault">apex_options_default()</a></li><li><a href="#apexoptionsformodeapexmode-mode">apex_options_for_mode(apex_mode mode)</a></li><li><a href="#apexapplymetadatatooptionsapexmetadataitem-metadata-apexoptions-opts">apex_apply_metadata_to_options(apex_metadata_item *metadata, apex_options *opts)</a></li></ul></li><li><a href="#metadata">Metadata</a><ul><li><a href="#apexfreemetadataapexmetadataitem-metadata">apex_free_metadata(apex_metadata_item *metadata)</a></li><li><a href="#apexloadmetadatafromfileconst-char-path">apex_load_metadata_from_file(const char *path)</a></li></ul></li><li><a href="#file-includes">File Includes</a><ul><li><a href="#apexprocessincludesconst-char-source-const-char-basedir-const-char-searchpaths-int-searchpathcount">apex_process_includes(const char *source, const char *base_dir, const char **search_paths, int search_path_count)</a></li></ul></li></ul></li><li><a href="#common-options-for-testing">Common Options for Testing</a></li><li><a href="#complete-test-example">Complete Test Example</a></li><li><a href="#using-test-fixtures">Using Test Fixtures</a></li><li><a href="#best-practices">Best Practices</a></li><li><a href="#global-variables">Global Variables</a></li></ul></li></ul></nav>
|
|
841
|
+
|
|
842
|
+
<p>
|
|
843
|
+
This guide explains how to add tests to the Apex test suite. Tests should be added for all new features. <strong>Pull Requests must include appropriate tests before they will be merged.</strong>
|
|
844
|
+
</p>
|
|
845
|
+
|
|
846
|
+
<h2 id="test-infrastructure-overview">
|
|
847
|
+
Test Infrastructure Overview
|
|
848
|
+
</h2>
|
|
849
|
+
|
|
850
|
+
<p>
|
|
851
|
+
The Apex test suite is built in C and uses a simple, custom test framework. The main components are:
|
|
852
|
+
</p>
|
|
853
|
+
|
|
854
|
+
<ul>
|
|
855
|
+
|
|
856
|
+
<li>
|
|
857
|
+
<strong><code>tests/test_runner.c</code></strong> - The main test runner that executes all test suites
|
|
858
|
+
</li>
|
|
859
|
+
|
|
860
|
+
<li>
|
|
861
|
+
<strong><code>tests/test_helpers.h</code></strong> and <strong><code>tests/test_helpers.c</code></strong> - Shared helper functions and macros
|
|
862
|
+
</li>
|
|
863
|
+
|
|
864
|
+
<li>
|
|
865
|
+
<strong>Individual test files</strong> - Each test file contains one or more test suites (e.g., <code>test_basic.c</code>, <code>test_metadata.c</code>)
|
|
866
|
+
</li>
|
|
867
|
+
|
|
868
|
+
</ul>
|
|
869
|
+
|
|
870
|
+
<h2 id="running-tests">
|
|
871
|
+
Running Tests
|
|
872
|
+
</h2>
|
|
873
|
+
|
|
874
|
+
<p>
|
|
875
|
+
Build and run the test suite:
|
|
876
|
+
</p>
|
|
877
|
+
|
|
878
|
+
<div class="highlight">
|
|
879
|
+
<pre><span></span><span class="c1"># Build with CMake</span>
|
|
880
|
+
mkdir<span class="w"> </span>-p<span class="w"> </span>build<span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="nb">cd</span><span class="w"> </span>build
|
|
881
|
+
cmake<span class="w"> </span>..
|
|
882
|
+
make<span class="w"> </span>apex_test_runner
|
|
883
|
+
|
|
884
|
+
<span class="c1"># Run all tests</span>
|
|
885
|
+
./apex_test_runner
|
|
886
|
+
|
|
887
|
+
<span class="c1"># Run a specific test suite</span>
|
|
888
|
+
./apex_test_runner<span class="w"> </span>metadata
|
|
889
|
+
|
|
890
|
+
<span class="c1"># Run with errors-only output (suppress passing tests)</span>
|
|
891
|
+
./apex_test_runner<span class="w"> </span>--errors-only
|
|
892
|
+
./apex_test_runner<span class="w"> </span>-e
|
|
893
|
+
|
|
894
|
+
<span class="c1"># Output badge format (passed/total count)</span>
|
|
895
|
+
./apex_test_runner<span class="w"> </span>--badge
|
|
896
|
+
|
|
897
|
+
<span class="c1"># List available test suites</span>
|
|
898
|
+
./apex_test_runner<span class="w"> </span>list
|
|
899
|
+
</pre>
|
|
900
|
+
</div>
|
|
901
|
+
|
|
902
|
+
<h2 id="when-to-create-a-new-test-suite">
|
|
903
|
+
When to Create a New Test Suite
|
|
904
|
+
</h2>
|
|
905
|
+
|
|
906
|
+
<p>
|
|
907
|
+
Create a <strong>new test suite</strong> when:
|
|
908
|
+
</p>
|
|
909
|
+
|
|
910
|
+
<ul>
|
|
911
|
+
|
|
912
|
+
<li>
|
|
913
|
+
Adding a <strong>new feature</strong> (e.g., citations, indices, a new extension)
|
|
914
|
+
</li>
|
|
915
|
+
|
|
916
|
+
<li>
|
|
917
|
+
The feature has <strong>multiple test cases</strong> that logically group together
|
|
918
|
+
</li>
|
|
919
|
+
|
|
920
|
+
<li>
|
|
921
|
+
The tests would clutter an existing suite
|
|
922
|
+
</li>
|
|
923
|
+
|
|
924
|
+
</ul>
|
|
925
|
+
|
|
926
|
+
<p>
|
|
927
|
+
Add tests to an <strong>existing suite</strong> when:
|
|
928
|
+
</p>
|
|
929
|
+
|
|
930
|
+
<ul>
|
|
931
|
+
|
|
932
|
+
<li>
|
|
933
|
+
Fixing a <strong>bug</strong> in existing functionality
|
|
934
|
+
</li>
|
|
935
|
+
|
|
936
|
+
<li>
|
|
937
|
+
Adding <strong>edge cases</strong> to existing features
|
|
938
|
+
</li>
|
|
939
|
+
|
|
940
|
+
<li>
|
|
941
|
+
The tests naturally fit with related functionality
|
|
942
|
+
</li>
|
|
943
|
+
|
|
944
|
+
</ul>
|
|
945
|
+
|
|
946
|
+
<h2 id="test-file-structure">
|
|
947
|
+
Test File Structure
|
|
948
|
+
</h2>
|
|
949
|
+
|
|
950
|
+
<h3 id="creating-a-new-test-suite">
|
|
951
|
+
Creating a New Test Suite
|
|
952
|
+
</h3>
|
|
953
|
+
|
|
954
|
+
<ol>
|
|
955
|
+
|
|
956
|
+
<li>
|
|
957
|
+
|
|
958
|
+
<p>
|
|
959
|
+
<strong>Create a new test file</strong> in <code>tests/</code> (e.g., <code>tests/test_myfeature.c</code>)
|
|
960
|
+
</p>
|
|
961
|
+
|
|
962
|
+
</li>
|
|
963
|
+
|
|
964
|
+
<li>
|
|
965
|
+
|
|
966
|
+
<p>
|
|
967
|
+
<strong>Add the file to CMakeLists.txt</strong>:
|
|
968
|
+
</p>
|
|
969
|
+
|
|
970
|
+
</li>
|
|
971
|
+
|
|
972
|
+
</ol>
|
|
973
|
+
|
|
974
|
+
<div class="highlight">
|
|
975
|
+
<pre><span></span><span class="nb">add_executable</span><span class="p">(</span><span class="s">apex_test_runner</span>
|
|
976
|
+
<span class="w"> </span><span class="s">tests/test_helpers.c</span>
|
|
977
|
+
<span class="w"> </span><span class="s">tests/test_runner.c</span>
|
|
978
|
+
<span class="w"> </span><span class="s">tests/test_basic.c</span>
|
|
979
|
+
<span class="w"> </span><span class="c"># ... other test files ...</span>
|
|
980
|
+
<span class="w"> </span><span class="s">tests/test_myfeature.c</span><span class="w"> </span><span class="c"># Add your new file</span>
|
|
981
|
+
<span class="p">)</span>
|
|
982
|
+
</pre>
|
|
983
|
+
</div>
|
|
984
|
+
|
|
985
|
+
<ol start="3">
|
|
986
|
+
|
|
987
|
+
<li>
|
|
988
|
+
<strong>Add a forward declaration in <code>test_runner.c</code></strong>:
|
|
989
|
+
</li>
|
|
990
|
+
|
|
991
|
+
</ol>
|
|
992
|
+
|
|
993
|
+
<div class="highlight">
|
|
994
|
+
<pre><span></span><span class="cm">/* Forward declarations for individual test suites */</span>
|
|
995
|
+
<span class="kt">void</span><span class="w"> </span><span class="nf">test_basic_markdown</span><span class="p">(</span><span class="kt">void</span><span class="p">);</span>
|
|
996
|
+
<span class="kt">void</span><span class="w"> </span><span class="nf">test_gfm_features</span><span class="p">(</span><span class="kt">void</span><span class="p">);</span>
|
|
997
|
+
<span class="c1">// ... other declarations ...</span>
|
|
998
|
+
<span class="kt">void</span><span class="w"> </span><span class="nf">test_myfeature</span><span class="p">(</span><span class="kt">void</span><span class="p">);</span><span class="w"> </span><span class="c1">// Add your declaration</span>
|
|
999
|
+
</pre>
|
|
1000
|
+
</div>
|
|
1001
|
+
|
|
1002
|
+
<ol start="4">
|
|
1003
|
+
|
|
1004
|
+
<li>
|
|
1005
|
+
<strong>Register in the suites array in <code>test_runner.c</code></strong>:
|
|
1006
|
+
</li>
|
|
1007
|
+
|
|
1008
|
+
</ol>
|
|
1009
|
+
|
|
1010
|
+
<div class="highlight">
|
|
1011
|
+
<pre><span></span><span class="k">static</span><span class="w"> </span><span class="n">test_suite</span><span class="w"> </span><span class="n">suites</span><span class="p">[]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
1012
|
+
<span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s">"basic"</span><span class="p">,</span><span class="w"> </span><span class="n">test_basic_markdown</span><span class="w"> </span><span class="p">},</span>
|
|
1013
|
+
<span class="w"> </span><span class="c1">// ... other suites ...</span>
|
|
1014
|
+
<span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s">"myfeature"</span><span class="p">,</span><span class="w"> </span><span class="n">test_myfeature</span><span class="w"> </span><span class="p">},</span><span class="w"> </span><span class="c1">// Add your suite</span>
|
|
1015
|
+
<span class="p">};</span>
|
|
1016
|
+
</pre>
|
|
1017
|
+
</div>
|
|
1018
|
+
|
|
1019
|
+
<h3 id="basic-test-file-template">
|
|
1020
|
+
Basic Test File Template
|
|
1021
|
+
</h3>
|
|
1022
|
+
|
|
1023
|
+
<div class="highlight">
|
|
1024
|
+
<pre><span></span><span class="cm">/**</span>
|
|
1025
|
+
<span class="cm"> * My Feature Tests</span>
|
|
1026
|
+
<span class="cm"> */</span>
|
|
1027
|
+
|
|
1028
|
+
<span class="cp">#include</span><span class="w"> </span><span class="cpf">"test_helpers.h"</span>
|
|
1029
|
+
<span class="cp">#include</span><span class="w"> </span><span class="cpf">"apex/apex.h"</span>
|
|
1030
|
+
<span class="cp">#include</span><span class="w"> </span><span class="cpf"><string.h></span>
|
|
1031
|
+
|
|
1032
|
+
<span class="kt">void</span><span class="w"> </span><span class="nf">test_myfeature</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
1033
|
+
<span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">suite_failures</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">suite_start</span><span class="p">();</span>
|
|
1034
|
+
<span class="w"> </span><span class="n">print_suite_title</span><span class="p">(</span><span class="s">"My Feature Tests"</span><span class="p">,</span><span class="w"> </span><span class="nb">false</span><span class="p">,</span><span class="w"> </span><span class="nb">true</span><span class="p">);</span>
|
|
1035
|
+
|
|
1036
|
+
<span class="w"> </span><span class="n">apex_options</span><span class="w"> </span><span class="n">opts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_options_default</span><span class="p">();</span>
|
|
1037
|
+
<span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">html</span><span class="p">;</span>
|
|
1038
|
+
|
|
1039
|
+
<span class="w"> </span><span class="cm">/* Test case 1: Basic functionality */</span>
|
|
1040
|
+
<span class="w"> </span><span class="n">html</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_markdown_to_html</span><span class="p">(</span><span class="s">"# Test"</span><span class="p">,</span><span class="w"> </span><span class="mi">6</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">opts</span><span class="p">);</span>
|
|
1041
|
+
<span class="w"> </span><span class="n">assert_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"<h1"</span><span class="p">,</span><span class="w"> </span><span class="s">"Header tag generated"</span><span class="p">);</span>
|
|
1042
|
+
<span class="w"> </span><span class="n">apex_free_string</span><span class="p">(</span><span class="n">html</span><span class="p">);</span>
|
|
1043
|
+
|
|
1044
|
+
<span class="w"> </span><span class="cm">/* Test case 2: Another test */</span>
|
|
1045
|
+
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">doc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Some **markdown** content"</span><span class="p">;</span>
|
|
1046
|
+
<span class="w"> </span><span class="n">html</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_markdown_to_html</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span><span class="w"> </span><span class="n">strlen</span><span class="p">(</span><span class="n">doc</span><span class="p">),</span><span class="w"> </span><span class="o">&</span><span class="n">opts</span><span class="p">);</span>
|
|
1047
|
+
<span class="w"> </span><span class="n">assert_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"<strong>"</span><span class="p">,</span><span class="w"> </span><span class="s">"Bold text converted"</span><span class="p">);</span>
|
|
1048
|
+
<span class="w"> </span><span class="n">apex_free_string</span><span class="p">(</span><span class="n">html</span><span class="p">);</span>
|
|
1049
|
+
|
|
1050
|
+
<span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">had_failures</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">suite_end</span><span class="p">(</span><span class="n">suite_failures</span><span class="p">);</span>
|
|
1051
|
+
<span class="w"> </span><span class="n">print_suite_title</span><span class="p">(</span><span class="s">"My Feature Tests"</span><span class="p">,</span><span class="w"> </span><span class="n">had_failures</span><span class="p">,</span><span class="w"> </span><span class="nb">false</span><span class="p">);</span>
|
|
1052
|
+
<span class="p">}</span>
|
|
1053
|
+
</pre>
|
|
1054
|
+
</div>
|
|
1055
|
+
|
|
1056
|
+
<h2 id="helper-functions-reference">
|
|
1057
|
+
Helper Functions Reference
|
|
1058
|
+
</h2>
|
|
1059
|
+
|
|
1060
|
+
<h3 id="suite-management">
|
|
1061
|
+
Suite Management
|
|
1062
|
+
</h3>
|
|
1063
|
+
|
|
1064
|
+
<h4 id="suitestart">
|
|
1065
|
+
<code>suite_start()</code>
|
|
1066
|
+
</h4>
|
|
1067
|
+
|
|
1068
|
+
<p>
|
|
1069
|
+
Call at the beginning of each test suite to track failures.
|
|
1070
|
+
</p>
|
|
1071
|
+
|
|
1072
|
+
<div class="highlight">
|
|
1073
|
+
<pre><span></span><span class="kt">int</span><span class="w"> </span><span class="n">suite_failures</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">suite_start</span><span class="p">();</span>
|
|
1074
|
+
</pre>
|
|
1075
|
+
</div>
|
|
1076
|
+
|
|
1077
|
+
<h4 id="suiteendint-suitestartfailures">
|
|
1078
|
+
<code>suite_end(int suite_start_failures)</code>
|
|
1079
|
+
</h4>
|
|
1080
|
+
|
|
1081
|
+
<p>
|
|
1082
|
+
Call at the end of each test suite. Returns <code>true</code> if any tests failed.
|
|
1083
|
+
</p>
|
|
1084
|
+
|
|
1085
|
+
<div class="highlight">
|
|
1086
|
+
<pre><span></span><span class="kt">bool</span><span class="w"> </span><span class="n">had_failures</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">suite_end</span><span class="p">(</span><span class="n">suite_failures</span><span class="p">);</span>
|
|
1087
|
+
</pre>
|
|
1088
|
+
</div>
|
|
1089
|
+
|
|
1090
|
+
<h4 id="printsuitetitleconst-char-title-bool-suitehadfailures-bool-atstart">
|
|
1091
|
+
<code>print_suite_title(const char *title, bool suite_had_failures, bool at_start)</code>
|
|
1092
|
+
</h4>
|
|
1093
|
+
|
|
1094
|
+
<p>
|
|
1095
|
+
Prints the suite title. Call twice: once at the start (<code>at_start = true</code>) and once at the end (<code>at_start = false</code>).
|
|
1096
|
+
</p>
|
|
1097
|
+
|
|
1098
|
+
<ul>
|
|
1099
|
+
|
|
1100
|
+
<li>
|
|
1101
|
+
In normal mode: prints at start
|
|
1102
|
+
</li>
|
|
1103
|
+
|
|
1104
|
+
<li>
|
|
1105
|
+
In errors-only mode: prints at end only if there were failures
|
|
1106
|
+
</li>
|
|
1107
|
+
|
|
1108
|
+
<li>
|
|
1109
|
+
In badge mode: never prints
|
|
1110
|
+
</li>
|
|
1111
|
+
|
|
1112
|
+
</ul>
|
|
1113
|
+
|
|
1114
|
+
<div class="highlight">
|
|
1115
|
+
<pre><span></span><span class="c1">// At start of suite</span>
|
|
1116
|
+
<span class="n">print_suite_title</span><span class="p">(</span><span class="s">"My Feature Tests"</span><span class="p">,</span><span class="w"> </span><span class="nb">false</span><span class="p">,</span><span class="w"> </span><span class="nb">true</span><span class="p">);</span>
|
|
1117
|
+
|
|
1118
|
+
<span class="c1">// At end of suite</span>
|
|
1119
|
+
<span class="n">print_suite_title</span><span class="p">(</span><span class="s">"My Feature Tests"</span><span class="p">,</span><span class="w"> </span><span class="n">had_failures</span><span class="p">,</span><span class="w"> </span><span class="nb">false</span><span class="p">);</span>
|
|
1120
|
+
</pre>
|
|
1121
|
+
</div>
|
|
1122
|
+
|
|
1123
|
+
<h3 id="assertion-functions">
|
|
1124
|
+
Assertion Functions
|
|
1125
|
+
</h3>
|
|
1126
|
+
|
|
1127
|
+
<h4 id="assertcontainsconst-char-haystack-const-char-needle-const-char-testname">
|
|
1128
|
+
<code>assert_contains(const char *haystack, const char *needle, const char *test_name)</code>
|
|
1129
|
+
</h4>
|
|
1130
|
+
|
|
1131
|
+
<p>
|
|
1132
|
+
Assert that <code>haystack</code> contains <code>needle</code>. Returns <code>true</code> if found.
|
|
1133
|
+
</p>
|
|
1134
|
+
|
|
1135
|
+
<div class="highlight">
|
|
1136
|
+
<pre><span></span><span class="n">assert_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"<h1"</span><span class="p">,</span><span class="w"> </span><span class="s">"Header tag present"</span><span class="p">);</span>
|
|
1137
|
+
<span class="n">assert_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"id=</span><span class="se">\"</span><span class="s">my-id</span><span class="se">\"</span><span class="s">"</span><span class="p">,</span><span class="w"> </span><span class="s">"Custom ID applied"</span><span class="p">);</span>
|
|
1138
|
+
</pre>
|
|
1139
|
+
</div>
|
|
1140
|
+
|
|
1141
|
+
<h4 id="assertnotcontainsconst-char-haystack-const-char-needle-const-char-testname">
|
|
1142
|
+
<code>assert_not_contains(const char *haystack, const char *needle, const char *test_name)</code>
|
|
1143
|
+
</h4>
|
|
1144
|
+
|
|
1145
|
+
<p>
|
|
1146
|
+
Assert that <code>haystack</code> does NOT contain <code>needle</code>. Returns <code>true</code> if not found.
|
|
1147
|
+
</p>
|
|
1148
|
+
|
|
1149
|
+
<div class="highlight">
|
|
1150
|
+
<pre><span></span><span class="n">assert_not_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"<!--TOC-->"</span><span class="p">,</span><span class="w"> </span><span class="s">"TOC marker replaced"</span><span class="p">);</span>
|
|
1151
|
+
<span class="n">assert_not_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"{:.class}"</span><span class="p">,</span><span class="w"> </span><span class="s">"IAL syntax removed"</span><span class="p">);</span>
|
|
1152
|
+
</pre>
|
|
1153
|
+
</div>
|
|
1154
|
+
|
|
1155
|
+
<h4 id="assertoptionboolbool-actual-bool-expected-const-char-testname">
|
|
1156
|
+
<code>assert_option_bool(bool actual, bool expected, const char *test_name)</code>
|
|
1157
|
+
</h4>
|
|
1158
|
+
|
|
1159
|
+
<p>
|
|
1160
|
+
Assert that a boolean value matches expected.
|
|
1161
|
+
</p>
|
|
1162
|
+
|
|
1163
|
+
<div class="highlight">
|
|
1164
|
+
<pre><span></span><span class="n">assert_option_bool</span><span class="p">(</span><span class="n">opts</span><span class="p">.</span><span class="n">enable_wiki_links</span><span class="p">,</span><span class="w"> </span><span class="nb">true</span><span class="p">,</span><span class="w"> </span><span class="s">"Wiki links enabled"</span><span class="p">);</span>
|
|
1165
|
+
<span class="n">assert_option_bool</span><span class="p">(</span><span class="n">opts</span><span class="p">.</span><span class="n">pretty</span><span class="p">,</span><span class="w"> </span><span class="nb">false</span><span class="p">,</span><span class="w"> </span><span class="s">"Pretty mode disabled"</span><span class="p">);</span>
|
|
1166
|
+
</pre>
|
|
1167
|
+
</div>
|
|
1168
|
+
|
|
1169
|
+
<h4 id="assertoptionstringconst-char-actual-const-char-expected-const-char-testname">
|
|
1170
|
+
<code>assert_option_string(const char *actual, const char *expected, const char *test_name)</code>
|
|
1171
|
+
</h4>
|
|
1172
|
+
|
|
1173
|
+
<p>
|
|
1174
|
+
Assert that a string value matches expected.
|
|
1175
|
+
</p>
|
|
1176
|
+
|
|
1177
|
+
<div class="highlight">
|
|
1178
|
+
<pre><span></span><span class="n">assert_option_string</span><span class="p">(</span><span class="n">opts</span><span class="p">.</span><span class="n">document_title</span><span class="p">,</span><span class="w"> </span><span class="s">"Test Doc"</span><span class="p">,</span><span class="w"> </span><span class="s">"Title set correctly"</span><span class="p">);</span>
|
|
1179
|
+
</pre>
|
|
1180
|
+
</div>
|
|
1181
|
+
|
|
1182
|
+
<h3 id="manual-test-results">
|
|
1183
|
+
Manual Test Results
|
|
1184
|
+
</h3>
|
|
1185
|
+
|
|
1186
|
+
<h4 id="testresultbool-passed-const-char-testname">
|
|
1187
|
+
<code>test_result(bool passed, const char *test_name)</code>
|
|
1188
|
+
</h4>
|
|
1189
|
+
|
|
1190
|
+
<p>
|
|
1191
|
+
Report a test result manually when you need custom logic.
|
|
1192
|
+
</p>
|
|
1193
|
+
|
|
1194
|
+
<div class="highlight">
|
|
1195
|
+
<pre><span></span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">strstr</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"expected"</span><span class="p">)</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="nb">NULL</span><span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="n">strstr</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"alternative"</span><span class="p">)</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="nb">NULL</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
1196
|
+
<span class="w"> </span><span class="n">test_result</span><span class="p">(</span><span class="nb">true</span><span class="p">,</span><span class="w"> </span><span class="s">"Expected output found"</span><span class="p">);</span>
|
|
1197
|
+
<span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">{</span>
|
|
1198
|
+
<span class="w"> </span><span class="n">test_result</span><span class="p">(</span><span class="nb">false</span><span class="p">,</span><span class="w"> </span><span class="s">"Expected output not found"</span><span class="p">);</span>
|
|
1199
|
+
<span class="p">}</span>
|
|
1200
|
+
</pre>
|
|
1201
|
+
</div>
|
|
1202
|
+
|
|
1203
|
+
<h4 id="testresultfbool-passed-const-char-format">
|
|
1204
|
+
<code>test_resultf(bool passed, const char *format, ...)</code>
|
|
1205
|
+
</h4>
|
|
1206
|
+
|
|
1207
|
+
<p>
|
|
1208
|
+
Report a test result with a formatted message.
|
|
1209
|
+
</p>
|
|
1210
|
+
|
|
1211
|
+
<div class="highlight">
|
|
1212
|
+
<pre><span></span><span class="n">test_resultf</span><span class="p">(</span><span class="n">result</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="s">"Function returned %d (expected 0)"</span><span class="p">,</span><span class="w"> </span><span class="n">result</span><span class="p">);</span>
|
|
1213
|
+
</pre>
|
|
1214
|
+
</div>
|
|
1215
|
+
|
|
1216
|
+
<h2 id="apex-api-functions">
|
|
1217
|
+
Apex API Functions
|
|
1218
|
+
</h2>
|
|
1219
|
+
|
|
1220
|
+
<h3 id="core-conversion">
|
|
1221
|
+
Core Conversion
|
|
1222
|
+
</h3>
|
|
1223
|
+
|
|
1224
|
+
<h4 id="apexmarkdowntohtmlconst-char-markdown-sizet-length-apexoptions-opts">
|
|
1225
|
+
<code>apex_markdown_to_html(const char *markdown, size_t length, apex_options *opts)</code>
|
|
1226
|
+
</h4>
|
|
1227
|
+
|
|
1228
|
+
<p>
|
|
1229
|
+
Convert Markdown to HTML. Returns a dynamically allocated string that must be freed with <code>apex_free_string()</code>.
|
|
1230
|
+
</p>
|
|
1231
|
+
|
|
1232
|
+
<div class="highlight">
|
|
1233
|
+
<pre><span></span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">html</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_markdown_to_html</span><span class="p">(</span><span class="s">"# Hello"</span><span class="p">,</span><span class="w"> </span><span class="mi">7</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">opts</span><span class="p">);</span>
|
|
1234
|
+
<span class="c1">// ... use html ...</span>
|
|
1235
|
+
<span class="n">apex_free_string</span><span class="p">(</span><span class="n">html</span><span class="p">);</span>
|
|
1236
|
+
</pre>
|
|
1237
|
+
</div>
|
|
1238
|
+
|
|
1239
|
+
<h4 id="apexfreestringchar-str">
|
|
1240
|
+
<code>apex_free_string(char *str)</code>
|
|
1241
|
+
</h4>
|
|
1242
|
+
|
|
1243
|
+
<p>
|
|
1244
|
+
Free a string returned by Apex functions.
|
|
1245
|
+
</p>
|
|
1246
|
+
|
|
1247
|
+
<h3 id="options">
|
|
1248
|
+
Options
|
|
1249
|
+
</h3>
|
|
1250
|
+
|
|
1251
|
+
<h4 id="apexoptionsdefault">
|
|
1252
|
+
<code>apex_options_default()</code>
|
|
1253
|
+
</h4>
|
|
1254
|
+
|
|
1255
|
+
<p>
|
|
1256
|
+
Get default options (Unified mode with common features enabled).
|
|
1257
|
+
</p>
|
|
1258
|
+
|
|
1259
|
+
<div class="highlight">
|
|
1260
|
+
<pre><span></span><span class="n">apex_options</span><span class="w"> </span><span class="n">opts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_options_default</span><span class="p">();</span>
|
|
1261
|
+
</pre>
|
|
1262
|
+
</div>
|
|
1263
|
+
|
|
1264
|
+
<h4 id="apexoptionsformodeapexmode-mode">
|
|
1265
|
+
<code>apex_options_for_mode(apex_mode mode)</code>
|
|
1266
|
+
</h4>
|
|
1267
|
+
|
|
1268
|
+
<p>
|
|
1269
|
+
Get options pre-configured for a specific mode.
|
|
1270
|
+
</p>
|
|
1271
|
+
|
|
1272
|
+
<div class="highlight">
|
|
1273
|
+
<pre><span></span><span class="n">apex_options</span><span class="w"> </span><span class="n">opts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_options_for_mode</span><span class="p">(</span><span class="n">APEX_MODE_GFM</span><span class="p">);</span>
|
|
1274
|
+
<span class="n">apex_options</span><span class="w"> </span><span class="n">opts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_options_for_mode</span><span class="p">(</span><span class="n">APEX_MODE_KRAMDOWN</span><span class="p">);</span>
|
|
1275
|
+
<span class="n">apex_options</span><span class="w"> </span><span class="n">opts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_options_for_mode</span><span class="p">(</span><span class="n">APEX_MODE_MULTIMARKDOWN</span><span class="p">);</span>
|
|
1276
|
+
<span class="n">apex_options</span><span class="w"> </span><span class="n">opts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_options_for_mode</span><span class="p">(</span><span class="n">APEX_MODE_PANDOC</span><span class="p">);</span>
|
|
1277
|
+
</pre>
|
|
1278
|
+
</div>
|
|
1279
|
+
|
|
1280
|
+
<h4 id="apexapplymetadatatooptionsapexmetadataitem-metadata-apexoptions-opts">
|
|
1281
|
+
<code>apex_apply_metadata_to_options(apex_metadata_item *metadata, apex_options *opts)</code>
|
|
1282
|
+
</h4>
|
|
1283
|
+
|
|
1284
|
+
<p>
|
|
1285
|
+
Apply metadata key-value pairs to options. Used for testing metadata-driven configuration.
|
|
1286
|
+
</p>
|
|
1287
|
+
|
|
1288
|
+
<div class="highlight">
|
|
1289
|
+
<pre><span></span><span class="n">apex_metadata_item</span><span class="w"> </span><span class="o">*</span><span class="n">metadata</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">NULL</span><span class="p">;</span>
|
|
1290
|
+
<span class="n">apex_metadata_item</span><span class="w"> </span><span class="o">*</span><span class="n">item</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">malloc</span><span class="p">(</span><span class="k">sizeof</span><span class="p">(</span><span class="n">apex_metadata_item</span><span class="p">));</span>
|
|
1291
|
+
<span class="n">item</span><span class="o">-></span><span class="n">key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">strdup</span><span class="p">(</span><span class="s">"wikilinks"</span><span class="p">);</span>
|
|
1292
|
+
<span class="n">item</span><span class="o">-></span><span class="n">value</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">strdup</span><span class="p">(</span><span class="s">"true"</span><span class="p">);</span>
|
|
1293
|
+
<span class="n">item</span><span class="o">-></span><span class="n">next</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">metadata</span><span class="p">;</span>
|
|
1294
|
+
<span class="n">metadata</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">item</span><span class="p">;</span>
|
|
1295
|
+
|
|
1296
|
+
<span class="n">apex_apply_metadata_to_options</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">opts</span><span class="p">);</span>
|
|
1297
|
+
<span class="n">assert_option_bool</span><span class="p">(</span><span class="n">opts</span><span class="p">.</span><span class="n">enable_wiki_links</span><span class="p">,</span><span class="w"> </span><span class="nb">true</span><span class="p">,</span><span class="w"> </span><span class="s">"wikilinks metadata applied"</span><span class="p">);</span>
|
|
1298
|
+
|
|
1299
|
+
<span class="n">apex_free_metadata</span><span class="p">(</span><span class="n">metadata</span><span class="p">);</span>
|
|
1300
|
+
</pre>
|
|
1301
|
+
</div>
|
|
1302
|
+
|
|
1303
|
+
<h3 id="metadata">
|
|
1304
|
+
Metadata
|
|
1305
|
+
</h3>
|
|
1306
|
+
|
|
1307
|
+
<h4 id="apexfreemetadataapexmetadataitem-metadata">
|
|
1308
|
+
<code>apex_free_metadata(apex_metadata_item *metadata)</code>
|
|
1309
|
+
</h4>
|
|
1310
|
+
|
|
1311
|
+
<p>
|
|
1312
|
+
Free a metadata linked list.
|
|
1313
|
+
</p>
|
|
1314
|
+
|
|
1315
|
+
<h4 id="apexloadmetadatafromfileconst-char-path">
|
|
1316
|
+
<code>apex_load_metadata_from_file(const char *path)</code>
|
|
1317
|
+
</h4>
|
|
1318
|
+
|
|
1319
|
+
<p>
|
|
1320
|
+
Load metadata from a YAML file. Returns <code>NULL</code> on failure.
|
|
1321
|
+
</p>
|
|
1322
|
+
|
|
1323
|
+
<div class="highlight">
|
|
1324
|
+
<pre><span></span><span class="cp">#ifdef TEST_FIXTURES_DIR</span>
|
|
1325
|
+
<span class="kt">char</span><span class="w"> </span><span class="n">path</span><span class="p">[</span><span class="mi">512</span><span class="p">];</span>
|
|
1326
|
+
<span class="n">snprintf</span><span class="p">(</span><span class="n">path</span><span class="p">,</span><span class="w"> </span><span class="k">sizeof</span><span class="p">(</span><span class="n">path</span><span class="p">),</span><span class="w"> </span><span class="s">"%s/metadata.yml"</span><span class="p">,</span><span class="w"> </span><span class="n">TEST_FIXTURES_DIR</span><span class="p">);</span>
|
|
1327
|
+
<span class="n">apex_metadata_item</span><span class="w"> </span><span class="o">*</span><span class="n">meta</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_load_metadata_from_file</span><span class="p">(</span><span class="n">path</span><span class="p">);</span>
|
|
1328
|
+
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">meta</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
1329
|
+
<span class="w"> </span><span class="c1">// ... use metadata ...</span>
|
|
1330
|
+
<span class="w"> </span><span class="n">apex_free_metadata</span><span class="p">(</span><span class="n">meta</span><span class="p">);</span>
|
|
1331
|
+
<span class="p">}</span>
|
|
1332
|
+
<span class="cp">#endif</span>
|
|
1333
|
+
</pre>
|
|
1334
|
+
</div>
|
|
1335
|
+
|
|
1336
|
+
<h3 id="file-includes">
|
|
1337
|
+
File Includes
|
|
1338
|
+
</h3>
|
|
1339
|
+
|
|
1340
|
+
<h4 id="apexprocessincludesconst-char-source-const-char-basedir-const-char-searchpaths-int-searchpathcount">
|
|
1341
|
+
<code>apex_process_includes(const char *source, const char *base_dir, const char **search_paths, int search_path_count)</code>
|
|
1342
|
+
</h4>
|
|
1343
|
+
|
|
1344
|
+
<p>
|
|
1345
|
+
Process file include directives (<code>{{filename}}</code>, <code><<filename>></code>, etc.). Returns a new string with includes expanded.
|
|
1346
|
+
</p>
|
|
1347
|
+
|
|
1348
|
+
<div class="highlight">
|
|
1349
|
+
<pre><span></span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">processed</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_process_includes</span><span class="p">(</span><span class="n">source</span><span class="p">,</span><span class="w"> </span><span class="s">"tests/fixtures"</span><span class="p">,</span><span class="w"> </span><span class="nb">NULL</span><span class="p">,</span><span class="w"> </span><span class="mi">0</span><span class="p">);</span>
|
|
1350
|
+
<span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">html</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_markdown_to_html</span><span class="p">(</span><span class="n">processed</span><span class="p">,</span><span class="w"> </span><span class="n">strlen</span><span class="p">(</span><span class="n">processed</span><span class="p">),</span><span class="w"> </span><span class="o">&</span><span class="n">opts</span><span class="p">);</span>
|
|
1351
|
+
<span class="n">free</span><span class="p">(</span><span class="n">processed</span><span class="p">);</span>
|
|
1352
|
+
<span class="n">apex_free_string</span><span class="p">(</span><span class="n">html</span><span class="p">);</span>
|
|
1353
|
+
</pre>
|
|
1354
|
+
</div>
|
|
1355
|
+
|
|
1356
|
+
<h2 id="common-options-for-testing">
|
|
1357
|
+
Common Options for Testing
|
|
1358
|
+
</h2>
|
|
1359
|
+
|
|
1360
|
+
<div class="highlight">
|
|
1361
|
+
<pre><span></span><span class="n">apex_options</span><span class="w"> </span><span class="n">opts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_options_default</span><span class="p">();</span>
|
|
1362
|
+
|
|
1363
|
+
<span class="c1">// Output options</span>
|
|
1364
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">standalone</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Generate complete HTML document</span>
|
|
1365
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">pretty</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Pretty-print HTML output</span>
|
|
1366
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">document_title</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Test"</span><span class="p">;</span><span class="w"> </span><span class="c1">// Set document title</span>
|
|
1367
|
+
|
|
1368
|
+
<span class="c1">// Feature toggles</span>
|
|
1369
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">enable_wiki_links</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Enable [[wiki links]]</span>
|
|
1370
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">enable_spans</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Enable [text]{.class} spans</span>
|
|
1371
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">enable_indices</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Enable index generation</span>
|
|
1372
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">enable_citations</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Enable citation processing</span>
|
|
1373
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">enable_marked_extensions</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Enable TOC, emoji, etc.</span>
|
|
1374
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">enable_smart_typography</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Enable smart quotes</span>
|
|
1375
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">enable_file_includes</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Enable file includes</span>
|
|
1376
|
+
|
|
1377
|
+
<span class="c1">// Table options</span>
|
|
1378
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">enable_tables</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Enable table processing</span>
|
|
1379
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">relaxed_tables</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Allow relaxed table syntax</span>
|
|
1380
|
+
|
|
1381
|
+
<span class="c1">// Header options</span>
|
|
1382
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">generate_header_ids</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Generate IDs for headers</span>
|
|
1383
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">header_anchors</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Add anchor links to headers</span>
|
|
1384
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">id_format</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span><span class="w"> </span><span class="c1">// 0=GFM, 1=MMD, 2=Kramdown</span>
|
|
1385
|
+
|
|
1386
|
+
<span class="c1">// Citation options</span>
|
|
1387
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">bibliography_files</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="kt">char</span><span class="w"> </span><span class="o">**</span><span class="p">)</span><span class="n">files</span><span class="p">;</span><span class="w"> </span><span class="c1">// Set bibliography files</span>
|
|
1388
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">link_citations</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Link citations to bibliography</span>
|
|
1389
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">suppress_bibliography</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Don't generate bibliography</span>
|
|
1390
|
+
|
|
1391
|
+
<span class="c1">// Other</span>
|
|
1392
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">base_directory</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"tests"</span><span class="p">;</span><span class="w"> </span><span class="c1">// Base directory for file resolution</span>
|
|
1393
|
+
<span class="n">opts</span><span class="p">.</span><span class="n">enable_aria</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"> </span><span class="c1">// Add ARIA accessibility attributes</span>
|
|
1394
|
+
</pre>
|
|
1395
|
+
</div>
|
|
1396
|
+
|
|
1397
|
+
<h2 id="complete-test-example">
|
|
1398
|
+
Complete Test Example
|
|
1399
|
+
</h2>
|
|
1400
|
+
|
|
1401
|
+
<p>
|
|
1402
|
+
Here’s a complete example testing a hypothetical “highlight” feature:
|
|
1403
|
+
</p>
|
|
1404
|
+
|
|
1405
|
+
<div class="highlight">
|
|
1406
|
+
<pre><span></span><span class="cm">/**</span>
|
|
1407
|
+
<span class="cm"> * Highlight Extension Tests</span>
|
|
1408
|
+
<span class="cm"> */</span>
|
|
1409
|
+
|
|
1410
|
+
<span class="cp">#include</span><span class="w"> </span><span class="cpf">"test_helpers.h"</span>
|
|
1411
|
+
<span class="cp">#include</span><span class="w"> </span><span class="cpf">"apex/apex.h"</span>
|
|
1412
|
+
<span class="cp">#include</span><span class="w"> </span><span class="cpf"><string.h></span>
|
|
1413
|
+
|
|
1414
|
+
<span class="kt">void</span><span class="w"> </span><span class="nf">test_highlight</span><span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
1415
|
+
<span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">suite_failures</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">suite_start</span><span class="p">();</span>
|
|
1416
|
+
<span class="w"> </span><span class="n">print_suite_title</span><span class="p">(</span><span class="s">"Highlight Extension Tests"</span><span class="p">,</span><span class="w"> </span><span class="nb">false</span><span class="p">,</span><span class="w"> </span><span class="nb">true</span><span class="p">);</span>
|
|
1417
|
+
|
|
1418
|
+
<span class="w"> </span><span class="n">apex_options</span><span class="w"> </span><span class="n">opts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_options_default</span><span class="p">();</span>
|
|
1419
|
+
<span class="w"> </span><span class="n">opts</span><span class="p">.</span><span class="n">enable_highlight</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span>
|
|
1420
|
+
<span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">html</span><span class="p">;</span>
|
|
1421
|
+
|
|
1422
|
+
<span class="w"> </span><span class="cm">/* Test basic highlight syntax */</span>
|
|
1423
|
+
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">basic</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"This is ==highlighted== text."</span><span class="p">;</span>
|
|
1424
|
+
<span class="w"> </span><span class="n">html</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_markdown_to_html</span><span class="p">(</span><span class="n">basic</span><span class="p">,</span><span class="w"> </span><span class="n">strlen</span><span class="p">(</span><span class="n">basic</span><span class="p">),</span><span class="w"> </span><span class="o">&</span><span class="n">opts</span><span class="p">);</span>
|
|
1425
|
+
<span class="w"> </span><span class="n">assert_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"<mark>"</span><span class="p">,</span><span class="w"> </span><span class="s">"Highlight uses mark tag"</span><span class="p">);</span>
|
|
1426
|
+
<span class="w"> </span><span class="n">assert_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"highlighted"</span><span class="p">,</span><span class="w"> </span><span class="s">"Highlight content preserved"</span><span class="p">);</span>
|
|
1427
|
+
<span class="w"> </span><span class="n">assert_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"</mark>"</span><span class="p">,</span><span class="w"> </span><span class="s">"Highlight tag closed"</span><span class="p">);</span>
|
|
1428
|
+
<span class="w"> </span><span class="n">assert_not_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"=="</span><span class="p">,</span><span class="w"> </span><span class="s">"Highlight syntax removed"</span><span class="p">);</span>
|
|
1429
|
+
<span class="w"> </span><span class="n">apex_free_string</span><span class="p">(</span><span class="n">html</span><span class="p">);</span>
|
|
1430
|
+
|
|
1431
|
+
<span class="w"> </span><span class="cm">/* Test highlight with other inline formatting */</span>
|
|
1432
|
+
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">mixed</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"This is ==**bold highlight**== here."</span><span class="p">;</span>
|
|
1433
|
+
<span class="w"> </span><span class="n">html</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_markdown_to_html</span><span class="p">(</span><span class="n">mixed</span><span class="p">,</span><span class="w"> </span><span class="n">strlen</span><span class="p">(</span><span class="n">mixed</span><span class="p">),</span><span class="w"> </span><span class="o">&</span><span class="n">opts</span><span class="p">);</span>
|
|
1434
|
+
<span class="w"> </span><span class="n">assert_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"<mark>"</span><span class="p">,</span><span class="w"> </span><span class="s">"Highlight with nested bold"</span><span class="p">);</span>
|
|
1435
|
+
<span class="w"> </span><span class="n">assert_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"<strong>"</span><span class="p">,</span><span class="w"> </span><span class="s">"Bold inside highlight"</span><span class="p">);</span>
|
|
1436
|
+
<span class="w"> </span><span class="n">apex_free_string</span><span class="p">(</span><span class="n">html</span><span class="p">);</span>
|
|
1437
|
+
|
|
1438
|
+
<span class="w"> </span><span class="cm">/* Test multiple highlights */</span>
|
|
1439
|
+
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">multi</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"First ==one== and ==two== highlights."</span><span class="p">;</span>
|
|
1440
|
+
<span class="w"> </span><span class="n">html</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_markdown_to_html</span><span class="p">(</span><span class="n">multi</span><span class="p">,</span><span class="w"> </span><span class="n">strlen</span><span class="p">(</span><span class="n">multi</span><span class="p">),</span><span class="w"> </span><span class="o">&</span><span class="n">opts</span><span class="p">);</span>
|
|
1441
|
+
<span class="w"> </span><span class="cm">/* Count occurrences */</span>
|
|
1442
|
+
<span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">count</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>
|
|
1443
|
+
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">p</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">html</span><span class="p">;</span>
|
|
1444
|
+
<span class="w"> </span><span class="k">while</span><span class="w"> </span><span class="p">((</span><span class="n">p</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">strstr</span><span class="p">(</span><span class="n">p</span><span class="p">,</span><span class="w"> </span><span class="s">"<mark>"</span><span class="p">))</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="nb">NULL</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
1445
|
+
<span class="w"> </span><span class="n">count</span><span class="o">++</span><span class="p">;</span>
|
|
1446
|
+
<span class="w"> </span><span class="n">p</span><span class="o">++</span><span class="p">;</span>
|
|
1447
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1448
|
+
<span class="w"> </span><span class="n">test_resultf</span><span class="p">(</span><span class="n">count</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="s">"Multiple highlights: found %d (expected 2)"</span><span class="p">,</span><span class="w"> </span><span class="n">count</span><span class="p">);</span>
|
|
1449
|
+
<span class="w"> </span><span class="n">apex_free_string</span><span class="p">(</span><span class="n">html</span><span class="p">);</span>
|
|
1450
|
+
|
|
1451
|
+
<span class="w"> </span><span class="cm">/* Test highlight disabled */</span>
|
|
1452
|
+
<span class="w"> </span><span class="n">apex_options</span><span class="w"> </span><span class="n">no_hl</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_options_default</span><span class="p">();</span>
|
|
1453
|
+
<span class="w"> </span><span class="n">no_hl</span><span class="p">.</span><span class="n">enable_highlight</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">false</span><span class="p">;</span>
|
|
1454
|
+
<span class="w"> </span><span class="n">html</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_markdown_to_html</span><span class="p">(</span><span class="n">basic</span><span class="p">,</span><span class="w"> </span><span class="n">strlen</span><span class="p">(</span><span class="n">basic</span><span class="p">),</span><span class="w"> </span><span class="o">&</span><span class="n">no_hl</span><span class="p">);</span>
|
|
1455
|
+
<span class="w"> </span><span class="n">assert_not_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"<mark>"</span><span class="p">,</span><span class="w"> </span><span class="s">"Highlight disabled produces no mark tags"</span><span class="p">);</span>
|
|
1456
|
+
<span class="w"> </span><span class="n">assert_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"==highlighted=="</span><span class="p">,</span><span class="w"> </span><span class="s">"Highlight syntax preserved when disabled"</span><span class="p">);</span>
|
|
1457
|
+
<span class="w"> </span><span class="n">apex_free_string</span><span class="p">(</span><span class="n">html</span><span class="p">);</span>
|
|
1458
|
+
|
|
1459
|
+
<span class="w"> </span><span class="cm">/* Test edge case: empty highlight */</span>
|
|
1460
|
+
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">empty</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"This is ==== empty."</span><span class="p">;</span>
|
|
1461
|
+
<span class="w"> </span><span class="n">html</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_markdown_to_html</span><span class="p">(</span><span class="n">empty</span><span class="p">,</span><span class="w"> </span><span class="n">strlen</span><span class="p">(</span><span class="n">empty</span><span class="p">),</span><span class="w"> </span><span class="o">&</span><span class="n">opts</span><span class="p">);</span>
|
|
1462
|
+
<span class="w"> </span><span class="cm">/* Empty highlight should not create mark tag */</span>
|
|
1463
|
+
<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">strstr</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"<mark></mark>"</span><span class="p">)</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="nb">NULL</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
1464
|
+
<span class="w"> </span><span class="n">test_result</span><span class="p">(</span><span class="nb">true</span><span class="p">,</span><span class="w"> </span><span class="s">"Empty highlight handled gracefully"</span><span class="p">);</span>
|
|
1465
|
+
<span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">{</span>
|
|
1466
|
+
<span class="w"> </span><span class="n">test_result</span><span class="p">(</span><span class="nb">false</span><span class="p">,</span><span class="w"> </span><span class="s">"Empty highlight creates empty mark tag"</span><span class="p">);</span>
|
|
1467
|
+
<span class="w"> </span><span class="p">}</span>
|
|
1468
|
+
<span class="w"> </span><span class="n">apex_free_string</span><span class="p">(</span><span class="n">html</span><span class="p">);</span>
|
|
1469
|
+
|
|
1470
|
+
<span class="w"> </span><span class="cm">/* Test highlight across lines (should not work) */</span>
|
|
1471
|
+
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">multiline</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"This is ==high</span><span class="se">\n</span><span class="s">lighted== text."</span><span class="p">;</span>
|
|
1472
|
+
<span class="w"> </span><span class="n">html</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_markdown_to_html</span><span class="p">(</span><span class="n">multiline</span><span class="p">,</span><span class="w"> </span><span class="n">strlen</span><span class="p">(</span><span class="n">multiline</span><span class="p">),</span><span class="w"> </span><span class="o">&</span><span class="n">opts</span><span class="p">);</span>
|
|
1473
|
+
<span class="w"> </span><span class="n">assert_not_contains</span><span class="p">(</span><span class="n">html</span><span class="p">,</span><span class="w"> </span><span class="s">"<mark>"</span><span class="p">,</span><span class="w"> </span><span class="s">"Highlight does not span lines"</span><span class="p">);</span>
|
|
1474
|
+
<span class="w"> </span><span class="n">apex_free_string</span><span class="p">(</span><span class="n">html</span><span class="p">);</span>
|
|
1475
|
+
|
|
1476
|
+
<span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">had_failures</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">suite_end</span><span class="p">(</span><span class="n">suite_failures</span><span class="p">);</span>
|
|
1477
|
+
<span class="w"> </span><span class="n">print_suite_title</span><span class="p">(</span><span class="s">"Highlight Extension Tests"</span><span class="p">,</span><span class="w"> </span><span class="n">had_failures</span><span class="p">,</span><span class="w"> </span><span class="nb">false</span><span class="p">);</span>
|
|
1478
|
+
<span class="p">}</span>
|
|
1479
|
+
</pre>
|
|
1480
|
+
</div>
|
|
1481
|
+
|
|
1482
|
+
<h2 id="using-test-fixtures">
|
|
1483
|
+
Using Test Fixtures
|
|
1484
|
+
</h2>
|
|
1485
|
+
|
|
1486
|
+
<p>
|
|
1487
|
+
For tests that need external files, use the <code>TEST_FIXTURES_DIR</code> macro:
|
|
1488
|
+
</p>
|
|
1489
|
+
|
|
1490
|
+
<div class="highlight">
|
|
1491
|
+
<pre><span></span><span class="cp">#ifdef TEST_FIXTURES_DIR</span>
|
|
1492
|
+
<span class="kt">char</span><span class="w"> </span><span class="n">fixture_path</span><span class="p">[</span><span class="mi">512</span><span class="p">];</span>
|
|
1493
|
+
<span class="n">snprintf</span><span class="p">(</span><span class="n">fixture_path</span><span class="p">,</span><span class="w"> </span><span class="k">sizeof</span><span class="p">(</span><span class="n">fixture_path</span><span class="p">),</span><span class="w"> </span><span class="s">"%s/mytest.md"</span><span class="p">,</span><span class="w"> </span><span class="n">TEST_FIXTURES_DIR</span><span class="p">);</span>
|
|
1494
|
+
|
|
1495
|
+
<span class="kt">FILE</span><span class="w"> </span><span class="o">*</span><span class="n">fp</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">fopen</span><span class="p">(</span><span class="n">fixture_path</span><span class="p">,</span><span class="w"> </span><span class="s">"rb"</span><span class="p">);</span>
|
|
1496
|
+
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">fp</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
1497
|
+
<span class="w"> </span><span class="c1">// Read and process file</span>
|
|
1498
|
+
<span class="w"> </span><span class="n">fclose</span><span class="p">(</span><span class="n">fp</span><span class="p">);</span>
|
|
1499
|
+
<span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">{</span>
|
|
1500
|
+
<span class="w"> </span><span class="n">test_result</span><span class="p">(</span><span class="nb">false</span><span class="p">,</span><span class="w"> </span><span class="s">"Failed to load test fixture"</span><span class="p">);</span>
|
|
1501
|
+
<span class="p">}</span>
|
|
1502
|
+
<span class="cp">#endif</span>
|
|
1503
|
+
</pre>
|
|
1504
|
+
</div>
|
|
1505
|
+
|
|
1506
|
+
<p>
|
|
1507
|
+
Test fixture files should be placed in <code>tests/fixtures/</code> in an appropriate subdirectory.
|
|
1508
|
+
</p>
|
|
1509
|
+
|
|
1510
|
+
<h2 id="best-practices">
|
|
1511
|
+
Best Practices
|
|
1512
|
+
</h2>
|
|
1513
|
+
|
|
1514
|
+
<ol>
|
|
1515
|
+
|
|
1516
|
+
<li>
|
|
1517
|
+
<strong>Always free allocated memory</strong> - Use <code>apex_free_string()</code> for Apex-allocated strings
|
|
1518
|
+
</li>
|
|
1519
|
+
|
|
1520
|
+
<li>
|
|
1521
|
+
<strong>Test both positive and negative cases</strong> - Verify features work AND don’t appear when disabled
|
|
1522
|
+
</li>
|
|
1523
|
+
|
|
1524
|
+
<li>
|
|
1525
|
+
<strong>Use descriptive test names</strong> - The test name appears in output on failure
|
|
1526
|
+
</li>
|
|
1527
|
+
|
|
1528
|
+
<li>
|
|
1529
|
+
<strong>Test edge cases</strong> - Empty input, special characters, boundary conditions
|
|
1530
|
+
</li>
|
|
1531
|
+
|
|
1532
|
+
<li>
|
|
1533
|
+
<strong>Test mode-specific behavior</strong> - If a feature behaves differently in different modes, test each mode
|
|
1534
|
+
</li>
|
|
1535
|
+
|
|
1536
|
+
<li>
|
|
1537
|
+
<strong>Keep tests focused</strong> - Each test should verify one specific behavior
|
|
1538
|
+
</li>
|
|
1539
|
+
|
|
1540
|
+
<li>
|
|
1541
|
+
<strong>Use <code>strlen()</code> for variable-length input</strong> - Pass correct length to <code>apex_markdown_to_html()</code>
|
|
1542
|
+
</li>
|
|
1543
|
+
|
|
1544
|
+
</ol>
|
|
1545
|
+
|
|
1546
|
+
<div class="highlight">
|
|
1547
|
+
<pre><span></span><span class="c1">// For string literals, you can count manually or use strlen</span>
|
|
1548
|
+
<span class="n">html</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_markdown_to_html</span><span class="p">(</span><span class="s">"# Test"</span><span class="p">,</span><span class="w"> </span><span class="mi">6</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">opts</span><span class="p">);</span>
|
|
1549
|
+
|
|
1550
|
+
<span class="c1">// For variable content, always use strlen</span>
|
|
1551
|
+
<span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">doc</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">some_variable_content</span><span class="p">;</span>
|
|
1552
|
+
<span class="n">html</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">apex_markdown_to_html</span><span class="p">(</span><span class="n">doc</span><span class="p">,</span><span class="w"> </span><span class="n">strlen</span><span class="p">(</span><span class="n">doc</span><span class="p">),</span><span class="w"> </span><span class="o">&</span><span class="n">opts</span><span class="p">);</span>
|
|
1553
|
+
</pre>
|
|
1554
|
+
</div>
|
|
1555
|
+
|
|
1556
|
+
<h2 id="global-variables">
|
|
1557
|
+
Global Variables
|
|
1558
|
+
</h2>
|
|
1559
|
+
|
|
1560
|
+
<p>
|
|
1561
|
+
The test framework uses these global variables (defined in <code>test_helpers.c</code>):
|
|
1562
|
+
</p>
|
|
1563
|
+
|
|
1564
|
+
<ul>
|
|
1565
|
+
|
|
1566
|
+
<li>
|
|
1567
|
+
<code>tests_run</code> - Total number of tests executed
|
|
1568
|
+
</li>
|
|
1569
|
+
|
|
1570
|
+
<li>
|
|
1571
|
+
<code>tests_passed</code> - Number of passing tests
|
|
1572
|
+
</li>
|
|
1573
|
+
|
|
1574
|
+
<li>
|
|
1575
|
+
<code>tests_failed</code> - Number of failing tests
|
|
1576
|
+
</li>
|
|
1577
|
+
|
|
1578
|
+
<li>
|
|
1579
|
+
<code>errors_only_output</code> - When non-zero, only print failing tests
|
|
1580
|
+
</li>
|
|
1581
|
+
|
|
1582
|
+
<li>
|
|
1583
|
+
<code>badge_mode</code> - When non-zero, suppress output except final count
|
|
1584
|
+
</li>
|
|
1585
|
+
|
|
1586
|
+
</ul>
|
|
1587
|
+
|
|
1588
|
+
<script>
|
|
1589
|
+
// Hamburger menu functionality
|
|
1590
|
+
(function() {
|
|
1591
|
+
function initHamburgerMenu() {
|
|
1592
|
+
var hamburger = document.getElementById('hamburger-menu');
|
|
1593
|
+
var sidebar = document.querySelector('.main-toc, .sidebar');
|
|
1594
|
+
var overlay = document.getElementById('mobile-menu-overlay');
|
|
1595
|
+
|
|
1596
|
+
if (!hamburger || !sidebar) return;
|
|
1597
|
+
|
|
1598
|
+
function toggleMenu() {
|
|
1599
|
+
var isOpen = sidebar.classList.contains('mobile-open');
|
|
1600
|
+
if (isOpen) {
|
|
1601
|
+
sidebar.classList.remove('mobile-open');
|
|
1602
|
+
hamburger.classList.remove('active');
|
|
1603
|
+
if (overlay) overlay.classList.remove('active');
|
|
1604
|
+
} else {
|
|
1605
|
+
sidebar.classList.add('mobile-open');
|
|
1606
|
+
hamburger.classList.add('active');
|
|
1607
|
+
if (overlay) overlay.classList.add('active');
|
|
1608
|
+
}
|
|
1609
|
+
}
|
|
1610
|
+
|
|
1611
|
+
hamburger.addEventListener('click', function(e) {
|
|
1612
|
+
e.stopPropagation();
|
|
1613
|
+
toggleMenu();
|
|
1614
|
+
});
|
|
1615
|
+
|
|
1616
|
+
if (overlay) {
|
|
1617
|
+
overlay.addEventListener('click', function() {
|
|
1618
|
+
toggleMenu();
|
|
1619
|
+
});
|
|
1620
|
+
}
|
|
1621
|
+
|
|
1622
|
+
// Close menu when clicking on a sidebar link (mobile only)
|
|
1623
|
+
if (window.innerWidth <= 768) {
|
|
1624
|
+
var sidebarLinks = sidebar.querySelectorAll('a');
|
|
1625
|
+
sidebarLinks.forEach(function(link) {
|
|
1626
|
+
link.addEventListener('click', function() {
|
|
1627
|
+
setTimeout(function() {
|
|
1628
|
+
sidebar.classList.remove('mobile-open');
|
|
1629
|
+
hamburger.classList.remove('active');
|
|
1630
|
+
if (overlay) overlay.classList.remove('active');
|
|
1631
|
+
}, 100);
|
|
1632
|
+
});
|
|
1633
|
+
});
|
|
1634
|
+
}
|
|
1635
|
+
|
|
1636
|
+
// Close menu on window resize if going to desktop
|
|
1637
|
+
window.addEventListener('resize', function() {
|
|
1638
|
+
if (window.innerWidth > 768) {
|
|
1639
|
+
sidebar.classList.remove('mobile-open');
|
|
1640
|
+
hamburger.classList.remove('active');
|
|
1641
|
+
if (overlay) overlay.classList.remove('active');
|
|
1642
|
+
}
|
|
1643
|
+
});
|
|
1644
|
+
}
|
|
1645
|
+
|
|
1646
|
+
// Initialize when DOM is ready
|
|
1647
|
+
if (document.readyState === 'loading') {
|
|
1648
|
+
document.addEventListener('DOMContentLoaded', initHamburgerMenu);
|
|
1649
|
+
} else {
|
|
1650
|
+
initHamburgerMenu();
|
|
1651
|
+
}
|
|
1652
|
+
})();
|
|
1653
|
+
|
|
1654
|
+
</script>
|
|
1655
|
+
<script>
|
|
1656
|
+
(function() {
|
|
1657
|
+
// Clone the page TOC for floating TOC
|
|
1658
|
+
function initFloatingTOC() {
|
|
1659
|
+
var pageTOC = document.getElementById('page-toc-top');
|
|
1660
|
+
var floatingTOCContent = document.getElementById('floating-toc-content');
|
|
1661
|
+
var floatingTOC = document.getElementById('floating-toc');
|
|
1662
|
+
|
|
1663
|
+
if (!pageTOC || !floatingTOCContent || !floatingTOC) return;
|
|
1664
|
+
|
|
1665
|
+
// Clone the TOC structure
|
|
1666
|
+
var tocClone = pageTOC.cloneNode(true);
|
|
1667
|
+
tocClone.id = 'floating-toc-clone';
|
|
1668
|
+
floatingTOCContent.appendChild(tocClone);
|
|
1669
|
+
|
|
1670
|
+
// Update all links to use smooth scrolling
|
|
1671
|
+
var allTOCLinks = document.querySelectorAll('.page-toc a, .floating-toc-content a');
|
|
1672
|
+
allTOCLinks.forEach(function(link) {
|
|
1673
|
+
link.addEventListener('click', function(e) {
|
|
1674
|
+
var href = this.getAttribute('href');
|
|
1675
|
+
if (href && href.startsWith('#')) {
|
|
1676
|
+
e.preventDefault();
|
|
1677
|
+
var targetId = href.substring(1);
|
|
1678
|
+
var targetElement = document.getElementById(targetId);
|
|
1679
|
+
if (targetElement) {
|
|
1680
|
+
var offset = 20; // Offset from top
|
|
1681
|
+
|
|
1682
|
+
// Function to calculate absolute position from document top
|
|
1683
|
+
function getAbsoluteTop(element) {
|
|
1684
|
+
var top = 0;
|
|
1685
|
+
while (element) {
|
|
1686
|
+
top += element.offsetTop;
|
|
1687
|
+
element = element.offsetParent;
|
|
1688
|
+
}
|
|
1689
|
+
return top;
|
|
1690
|
+
}
|
|
1691
|
+
|
|
1692
|
+
var absoluteTop = getAbsoluteTop(targetElement);
|
|
1693
|
+
var scrollTop = window.pageYOffset || document.documentElement.scrollTop;
|
|
1694
|
+
var offsetPosition = absoluteTop - offset;
|
|
1695
|
+
|
|
1696
|
+
// Only scroll if we're not already at the target position
|
|
1697
|
+
if (Math.abs(scrollTop - offsetPosition) > 10) {
|
|
1698
|
+
window.scrollTo({
|
|
1699
|
+
top: Math.max(0, offsetPosition),
|
|
1700
|
+
behavior: 'smooth'
|
|
1701
|
+
});
|
|
1702
|
+
}
|
|
1703
|
+
|
|
1704
|
+
// Update URL hash without triggering scroll
|
|
1705
|
+
if (history.pushState) {
|
|
1706
|
+
history.pushState(null, null, href);
|
|
1707
|
+
}
|
|
1708
|
+
}
|
|
1709
|
+
}
|
|
1710
|
+
});
|
|
1711
|
+
});
|
|
1712
|
+
|
|
1713
|
+
// Handle scroll to show/hide floating TOC
|
|
1714
|
+
var tocTop = pageTOC.getBoundingClientRect().top + window.pageYOffset;
|
|
1715
|
+
var tocBottom = tocTop + pageTOC.offsetHeight;
|
|
1716
|
+
|
|
1717
|
+
function updateFloatingTOC() {
|
|
1718
|
+
var scrollY = window.pageYOffset || document.documentElement.scrollTop;
|
|
1719
|
+
|
|
1720
|
+
if (scrollY > tocBottom) {
|
|
1721
|
+
floatingTOC.classList.add('visible');
|
|
1722
|
+
} else {
|
|
1723
|
+
floatingTOC.classList.remove('visible');
|
|
1724
|
+
}
|
|
1725
|
+
}
|
|
1726
|
+
|
|
1727
|
+
// Throttle scroll events
|
|
1728
|
+
var ticking = false;
|
|
1729
|
+
window.addEventListener('scroll', function() {
|
|
1730
|
+
if (!ticking) {
|
|
1731
|
+
window.requestAnimationFrame(function() {
|
|
1732
|
+
updateFloatingTOC();
|
|
1733
|
+
ticking = false;
|
|
1734
|
+
});
|
|
1735
|
+
ticking = true;
|
|
1736
|
+
}
|
|
1737
|
+
});
|
|
1738
|
+
|
|
1739
|
+
// Initial check
|
|
1740
|
+
updateFloatingTOC();
|
|
1741
|
+
}
|
|
1742
|
+
|
|
1743
|
+
// Initialize when DOM is ready
|
|
1744
|
+
if (document.readyState === 'loading') {
|
|
1745
|
+
document.addEventListener('DOMContentLoaded', initFloatingTOC);
|
|
1746
|
+
} else {
|
|
1747
|
+
initFloatingTOC();
|
|
1748
|
+
}
|
|
1749
|
+
})();
|
|
1750
|
+
</script>
|
|
1751
|
+
<footer class="page-footer"><p>Copyright 2025 Brett Terpstra, All Rights Reserved | MIT License</p></footer></body>
|
|
1752
|
+
|
|
1753
|
+
</html>
|
|
1754
|
+
|