libadalang2xml 1.0.2 (#1001)

This release updates the year-old documentation in 1.0.0 to better address macOS issues, mainly by suggesting how to deal with the standard langkit_support & libadalang crates, and offering a mcOS-specific alternative.
2024-02-19 12:34:08 +00:00
parent d62dc1e888
commit 1300ee3e34
1 changed files with 94 additions and 0 deletions
@@ -0,0 +1,94 @@
+name = "libadalang2xml"
+description = "Generates XML for Ada source, using libadalang."
+long-description = """
+Libadalang2XML is a tool to extract syntatic aspects of Ada source code into XML.
+
+The Ada source is initially read using [Libadalang](https://github.com/AdaCore/libadalang). The resulting tree is then traversed, and its structure output in an XML form.
+
+The [document type definition](https://en.wikipedia.org/wiki/Document_type_definition) isn't explicit; it's simply derived from the tree elements created by Libadalang. Note that Libadalang includes much more semantic information than the surface structure generated by this tool, but nevertheless there's enough there to --- for example --- create a scriptable body for a package spec.
+
+## Building on macOS ##
+
+Using the standard `langkit_support`, `libadalang` crates, you **must** build with `LIBRARY_TYPE` set to `relocatable`.
+
+You can obtain versions of those crates adjusted to not require those features, which can therefore build the (default) static libraries, by visiting https://github.com/simonjwright/alire-index.mac.
+
+## Example ##
+
+As an example of the output, this code
+``` ada
+package Demo is
+   procedure Square (X : in out Integer);
+end Demo;
+```
+generates
+``` xml
+<CompilationUnit>
+  <AdaNodeList/>
+  <LibraryItem>
+    <PrivateAbsent/>
+    <PackageDecl>
+      <DefiningName>
+        <Id>Demo</Id>
+      </DefiningName>
+      <PublicPart>
+        <AdaNodeList>
+          <SubpDecl>
+            <OverridingUnspecified/>
+            <SubpSpec>
+              <SubpKindProcedure>procedure</SubpKindProcedure>
+              <DefiningName>
+                <Id>Square</Id>
+              </DefiningName>
+              <Params>
+                <ParamSpecList>
+                  <ParamSpec>
+                    <DefiningNameList>
+                      <DefiningName>
+                        <Id>X</Id>
+                      </DefiningName>
+                    </DefiningNameList>
+                    <AliasedAbsent/>
+                    <ModeInOut>in out</ModeInOut>
+                    <SubtypeIndication>
+                      <NotNullAbsent/>
+                      <Id>Integer</Id>
+                    </SubtypeIndication>
+                  </ParamSpec>
+                </ParamSpecList>
+              </Params>
+            </SubpSpec>
+          </SubpDecl>
+        </AdaNodeList>
+      </PublicPart>
+      <EndName>
+        <Id>Demo</Id>
+      </EndName>
+    </PackageDecl>
+  </LibraryItem>
+  <PragmaNodeList/>
+</CompilationUnit>
+```
+"""
+version = "1.0.2"
+
+authors = ["Simon Wright"]
+maintainers = ["Simon Wright <simon@pushface.org>"]
+maintainers-logins = ["simonjwright"]
+licenses = "GPL-3.0-or-later"
+website = "https://github.com/simonjwright/libadalang2xml"
+tags = ["ada", "xml"]
+
+executables = ["libadalang2xml"]
+
+[build-switches]
+development.contracts = "yes"
+"*".ada_version = "ada2022"
+
+[[depends-on]]
+libadalang = "*"
+
+[origin]
+commit = "99ee1dd171cd66736f38e770a751a15ad7ffc334"
+url = "git+https://github.com/simonjwright/libadalang2xml.git"
+