Skip to content

Commit 0c909f4

Browse files
RikkiGibsonRikkiGibson
committed
Add file-based programs source package
1 parent 99075fb commit 0c909f4

33 files changed

+1595
-93
lines changed

‎src/Cli/Microsoft.DotNet.FileBasedPrograms/.editorconfig‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[*.cs]
2+
3+
# IDE0240: Remove redundant nullable directive
4+
# The directive needs to be included since all sources in a source package are considered generated code
5+
# when referenced from a project via package reference.
6+
dotnet_diagnostic.IDE0240.severity = none

‎src/Cli/Microsoft.DotNet.FileBasedPrograms/ExternalHelpers.cs‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
// Licensed to the .NET Foundation under one or more agreements.
2+
// The .NET Foundation licenses this file to you under the MIT license.
3+
4+
#nullable enable
5+
using System;
6+
using System.IO;
7+
8+
namespace Microsoft.DotNet.FileBasedPrograms;
9+
10+
/// <summary>
11+
/// When targeting netstandard2.0, the user of the source package must "implement" certain methods by declaring members in this type.
12+
/// </summary>
13+
partial class ExternalHelpers
14+
{
15+
public static partial int CombineHashCodes(int value1, int value2);
16+
public static partial string GetRelativePath(string relativeTo, string path);
17+
18+
public static partial bool IsPathFullyQualified(string path);
19+
20+
#if NET
21+
public static partial int CombineHashCodes(int value1, int value2)
22+
=> HashCode.Combine(value1, value2);
23+
24+
public static partial string GetRelativePath(string relativeTo, string path)
25+
=> Path.GetRelativePath(relativeTo, path);
26+
27+
public static partial bool IsPathFullyQualified(string path)
28+
=> Path.IsPathFullyQualified(path);
29+
30+
#elif FILE_BASED_PROGRAMS_SOURCE_PACKAGE_BUILD
31+
// This path should only be used when we are verifying that the source package itself builds under netstandard2.0.
32+
public static partial int CombineHashCodes(int value1, int value2)
33+
=> throw new NotImplementedException();
34+
35+
public static partial string GetRelativePath(string relativeTo, string path)
36+
=> throw new NotImplementedException();
37+
38+
public static partial bool IsPathFullyQualified(string path)
39+
=> throw new NotImplementedException();
40+
41+
#endif
42+
}
43+
44+
#if FILE_BASED_PROGRAMS_SOURCE_PACKAGE_GRACEFUL_EXCEPTION
45+
internal class GracefulException : Exception
46+
{
47+
public GracefulException()
48+
{
49+
}
50+
51+
public GracefulException(string? message) : base(message)
52+
{
53+
}
54+
55+
public GracefulException(string format, string arg) : this(string.Format(format, arg))
56+
{
57+
}
58+
59+
public GracefulException(string? message, Exception? innerException) : base(message, innerException)
60+
{
61+
}
62+
}
63+
#endif

‎src/Cli/Microsoft.DotNet.FileBasedPrograms/FileBasedProgramsResources.resx‎

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="CouldNotFindAnyProjectInDirectory" xml:space="preserve">
121+
<value>Could not find any project in `{0}`.</value>
122+
</data>
123+
<data name="CouldNotFindProjectOrDirectory" xml:space="preserve">
124+
<value>Could not find project or directory `{0}`.</value>
125+
</data>
126+
<data name="MoreThanOneProjectInDirectory" xml:space="preserve">
127+
<value>Found more than one project in `{0}`. Specify which one to use.</value>
128+
</data>
129+
<data name="PropertyDirectiveInvalidName" xml:space="preserve">
130+
<value>Invalid property name: {0}</value>
131+
<comment>{0} is an inner exception message.</comment>
132+
</data>
133+
<data name="PropertyDirectiveMissingParts" xml:space="preserve">
134+
<value>The property directive needs to have two parts separated by '=' like '#:property PropertyName=PropertyValue'.</value>
135+
<comment>{Locked="#:property"}</comment>
136+
</data>
137+
<data name="StaticGraphRestoreNotSupported" xml:space="preserve">
138+
<value>Static graph restore is not supported for file-based apps. Remove the '#:property'.</value>
139+
<comment>{Locked="#:property"}</comment>
140+
</data>
141+
<data name="DirectiveError" xml:space="preserve">
142+
<value>error</value>
143+
<comment>Used when reporting directive errors like "file(location): error: message".</comment>
144+
</data>
145+
<data name="InvalidDirectiveName" xml:space="preserve">
146+
<value>The directive should contain a name without special characters and an optional value separated by '{1}' like '#:{0} Name{1}Value'.</value>
147+
<comment>{0} is the directive type like 'package' or 'sdk'. {1} is the expected separator like '@' or '='.</comment>
148+
</data>
149+
<data name="CannotConvertDirective" xml:space="preserve">
150+
<value>Some directives cannot be converted. Run the file to see all compilation errors. Specify '--force' to convert anyway.</value>
151+
<comment>{Locked="--force"}</comment>
152+
</data>
153+
<data name="DuplicateDirective" xml:space="preserve">
154+
<value>Duplicate directives are not supported: {0}</value>
155+
<comment>{0} is the directive type and name.</comment>
156+
</data>
157+
<data name="QuoteInDirective" xml:space="preserve">
158+
<value>Directives currently cannot contain double quotes (").</value>
159+
</data>
160+
<data name="InvalidProjectDirective" xml:space="preserve">
161+
<value>The '#:project' directive is invalid: {0}</value>
162+
<comment>{0} is the inner error message.</comment>
163+
</data>
164+
<data name="MissingDirectiveName" xml:space="preserve">
165+
<value>Missing name of '{0}'.</value>
166+
<comment>{0} is the directive name like 'package' or 'sdk'.</comment>
167+
</data>
168+
<data name="UnrecognizedDirective" xml:space="preserve">
169+
<value>Unrecognized directive '{0}'.</value>
170+
<comment>{0} is the directive name like 'package' or 'sdk'.</comment>
171+
</data>
172+
</root>

0 commit comments

Comments
 (0)