Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 0 additions & 124 deletions Build-Native.ps1

This file was deleted.

2 changes: 2 additions & 0 deletions Directory.Packages.props
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
<PackageVersion Include="Microsoft.CodeAnalysis.VisualBasic.Features" Version="4.14.0" />
<PackageVersion Include="Basic.Reference.Assemblies.Net80" Version="1.8.2" />
<PackageVersion Include="PolySharp" Version="1.15.0" />
<PackageVersion Include="System.Buffers" Version="4.6.1" />
<PackageVersion Include="System.Collections.Immutable" Version="9.0.8" />
<PackageVersion Include="System.CommandLine" Version="2.0.0-beta7.25380.108" />
<PackageVersion Include="System.IO.Hashing" Version="9.0.8" />
<!-- Workaround(2): https://github.com/dotnet/roslyn-sdk/issues/1191 -->
<PackageVersion Include="System.Formats.Asn1" Version="9.0.7" />
Expand Down
5 changes: 5 additions & 0 deletions IgnoredWords.dic
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ Enums
env
exe
facepalm
fallback
finalizer
finalizers
foo
Expand All @@ -74,6 +75,7 @@ inline
inlined
inlining
Interop
ints
jit
len
Lexer
Expand Down Expand Up @@ -105,6 +107,8 @@ pages
paren
perf
pointee
polyfills
pragma
pragmas
Pre
proj
Expand Down Expand Up @@ -149,6 +153,7 @@ userdefinedop
Users
usings
utils
validator
varargs
variadic
vcxproj
Expand Down
3 changes: 3 additions & 0 deletions docfx/CommandLine/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# About
Ubiquity.NET.CommandLines contains general extensions for .NET. to support command line
parsing using `System.CommandLine`
3 changes: 3 additions & 0 deletions docfx/CommandLine/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# About
Ubiquity.NET.CommandLines contains general extensions for .NET. to support command line
parsing using `System.CommandLine`
5 changes: 5 additions & 0 deletions docfx/CommandLine/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# TOC (Left nav) for the 'extensions' folder
- name: Overview
href: index.md
- name: Namespaces
href: api/toc.yml
74 changes: 52 additions & 22 deletions docfx/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,45 @@
// [Sigh] - docfx tooling will process and report warnings etc.. on projects found BEFORE it
// deals with the exclusion list so a simple glob for all csproj files doesn't work. It creates
// warnings and returns a non-success value which stops the build.
// Each project is listed in the order they appear in the VS solution explorer so they are easier
// to find and check etc...
{
// LLVM OO Wrappers library
// Interop helpers library
"memberLayout":"separatePages",
"namespaceLayout":"nested",
"src": [
{
"src": "../src/Ubiquity.NET.Llvm",
"src": "../src/Ubiquity.NET.InteropHelpers",
"files": ["**.csproj"]
}
],
"dest": "llvm/api"
"dest": "interop-helpers/api"
},
// NOTE: Ubiquity.NET.Llvm.Interop is intentionally NOT documented (It's considered an implementation detail)
// NOTE: Sample projects are not generating docs, they are... samples 8^)
{
// Runtime utilities library
// ANTLR Utilities library
"memberLayout":"separatePages",
"namespaceLayout":"nested",
"src": [
{
"src": "../src/Ubiquity.NET.Runtime.Utils",
"src": "../src/Ubiquity.NET.ANTLR.Utils",
"files": ["**.csproj"]
}
],
"dest": "runtime-utils/api"
"dest": "antlr-utils/api"
},
{
// ANTLR Utilities library
"memberLayout":"separatePages",
"namespaceLayout":"nested",
"src": [
{
"src": "../src/Ubiquity.NET.CommandLine",
"files": ["**.csproj"]
}
],
"dest": "CommandLine/api"
},
{
// Extensions library
Expand All @@ -41,28 +57,28 @@
"dest": "extensions/api"
},
{
// ANTLR Utilities library
// LLVM OO Wrappers library
"memberLayout":"separatePages",
"namespaceLayout":"nested",
"src": [
{
"src": "../src/Ubiquity.NET.ANTLR.Utils",
"src": "../src/Ubiquity.NET.Llvm",
"files": ["**.csproj"]
}
],
"dest": "antlr-utils/api"
"dest": "llvm/api"
},
{
// Interop helpers library
// Runtime utilities library
"memberLayout":"separatePages",
"namespaceLayout":"nested",
"src": [
{
"src": "../src/Ubiquity.NET.InteropHelpers",
"src": "../src/Ubiquity.NET.Runtime.Utils",
"files": ["**.csproj"]
}
],
"dest": "interop-helpers/api"
"dest": "runtime-utils/api"
},
{
// TextUX library
Expand All @@ -74,7 +90,10 @@
"files": ["**.csproj"]
}
],
"dest": "TextUX/api"
"dest": "TextUX/api",
"properties": {
"DefineConstants": "DOCFX_BUILD"
}
}
],
"build": {
Expand All @@ -93,9 +112,9 @@
]
},
{
// LLVM project additional content, Includes the generated metadata API folder
// InteropHelpers project additional content, Includes the generated metadata API folder
"files": [
"llvm/**.{md,yml}"
"interop-helpers/**.{md,yml}"
],
// Exclude the namespace overwrites and XREF maps as they are listed explicitly elsewhere
"exclude": [
Expand Down Expand Up @@ -123,10 +142,20 @@
]
},
{
// Runtime Utils project additional content, Includes the generated metadata API folder
// NOTE: File paths are relative to the location of this file
// ANTLR Utils project additional content, Includes the generated metadata API folder
"files": [
"runtime-utils/**.{md,yml}"
"antlr-utils/**.{md,yml}"
],
// Exclude the namespace overwrites and XREF maps as they are listed explicitly elsewhere
"exclude": [
"**/namespaces/**.md",
"**/*-xref.yml"
]
},
{
// CommandLine Utils project additional content, Includes the generated metadata API folder
"files": [
"CommandLine/**.{md,yml}"
],
// Exclude the namespace overwrites and XREF maps as they are listed explicitly elsewhere
"exclude": [
Expand All @@ -146,9 +175,9 @@
]
},
{
// ANTLR Utils project additional content, Includes the generated metadata API folder
// LLVM project additional content, Includes the generated metadata API folder
"files": [
"antlr-utils/**.{md,yml}"
"llvm/**.{md,yml}"
],
// Exclude the namespace overwrites and XREF maps as they are listed explicitly elsewhere
"exclude": [
Expand All @@ -157,9 +186,10 @@
]
},
{
// InteropHelpers project additional content, Includes the generated metadata API folder
// Runtime Utils project additional content, Includes the generated metadata API folder
// NOTE: File paths are relative to the location of this file
"files": [
"interop-helpers/**.{md,yml}"
"runtime-utils/**.{md,yml}"
],
// Exclude the namespace overwrites and XREF maps as they are listed explicitly elsewhere
"exclude": [
Expand Down
7 changes: 7 additions & 0 deletions docfx/documentation.msbuildproj
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,13 @@
<!-- Explicitly call out the non-generated files in the API folder-->
<None Include="TextUX/api/index.md" />
</ItemGroup>
<ItemGroup>
<!--Everything in the CommandLine sub-folders except the API folder as that contains generated files -->
<None Include="CommandLine/**" Exclude="CommandLine/api/**" />
<!-- Explicitly call out the non-generated files in the API folder-->
<None Include="CommandLine/api/index.md" />
</ItemGroup>

<Target Name="AlwaysRun" BeforeTargets="AfterBuild">
<Message Importance="High" Text="NOTE: Building $(MSBuildProjectFile) does NOTHING, docs are built using the docfx tool. This project is simply a convenient placeholder for organizing/editing files" />
</Target>
Expand Down
1 change: 1 addition & 0 deletions docfx/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ included.
| [Ubiquity.NET.Extensions](extensions/index.md) | This library contains general extensions and helpers for many scenarios using .NET |
| [Ubiquity.NET.Antlr.Utils](antlr-utils/index.md) | This library contains extensions and helpers for using ANTLR with .NET |
| [Ubiquity.NET.TextUX](TextUX/index.md) | This library contains extensions and helpers for Text User eXperience (UX) applications (console) |
| [Ubiquity.NET.CommandLine](CommandLine/index.md) | This library contains extensions and helpers for command line parsing via `System.CommandLine` |
| [Ubiquity.NET.InteropHelpers](interop-helpers/index.md) | This library contains extensions and helpers for implementing interop support for native libraries |
2 changes: 2 additions & 0 deletions docfx/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@
href: TextUX/index.md
- name: Interop Helpers
href: interop-helpers/index.md
- name: CommandLine Parsing
href: CommandLine/index.md
1 change: 1 addition & 0 deletions src/Samples/Kaleidoscope/Chapter8/Chapter8.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\..\..\Ubiquity.NET.CommandLine\Ubiquity.NET.CommandLine.csproj" />
<ProjectReference Include="..\Kaleidoscope.Grammar\Kaleidoscope.Grammar.csproj" />
<ProjectReference Include="..\Kaleidoscope.Runtime\Kaleidoscope.Runtime.csproj" />
</ItemGroup>
Expand Down
15 changes: 15 additions & 0 deletions src/Samples/Kaleidoscope/Chapter8/Options.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Copyright (c) Ubiquity.NET Contributors. All rights reserved.
// Licensed under the Apache-2.0 WITH LLVM-exception license. See the LICENSE.md file in the project root for full license information.

using System.IO;

namespace Kaleidoscope
{
/// <summary>Command line options for this application</summary>
internal partial class Options
{
/// <summary>Gets the source file to use as the reference for debug information</summary>
/// <remarks>The file is parsed as Kaleidoscope syntax to generate the output files for native code.</remarks>
public required FileInfo SourcePath { get; init; }
}
}
Loading
Loading