Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Single resx compilation using dotnet cli for compilation #96

Closed
wants to merge 2 commits into from
Closed

WIP: Single resx compilation using dotnet cli for compilation #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f56faf
Minimum usage of the resgen
Oct 15, 2019
d465a77
Outline of rule
Oct 15, 2019
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
31 changes: 31 additions & 0 deletions csharp/private/rules/resgen.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@

def _csharp_resx_impl(ctx):
print("todo")

csharp_resx = rule(
implementation = _csharp_resx_impl,
Copy link
Contributor Author

@jrbeverly jrbeverly Oct 15, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking we'll want to provide a custom struct as mentioned in #77, as the name of the output .resources file is determined by either the csproj file name or the RootNamespace property. We could add an out property for modifying the name of the csproj file (rather than relying solely on identifier) (more on PR #93)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The struct sounds good. I think the fact that we're generating a csproj behind the scenes is an implementation detail that we wouldn't want to expose via attrs though?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The struct containing a identifier property (or out for controlling output name) is not really related to the csproj, but to how the resources are consumed by C# compiler:

-resource:filename[,identifier[,accessibility-modifier]]

With parameters like that, I can pass in a resources file named hello.look.at.this.name.resources, but use the identifier hello.Strings.resources. This is what I was getting at in this discussion

attrs = {
"src": attr.label(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be more ergonomic for this to be srcs and to invoke dotnet multiple times in a loop behind the scenes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we went this route, the API for specifying the identifier would need to be a label_keyed_string_dict, which makes the specification of the identifier mandatory.

I would also have concerns with the resource being used incorrectly with localized resx files. For localized resx files, satellite assemblies are created in directories based on the culture code. Those will need some special handling, as the pathing of those assemblies matter.

doc = "The resx file."
mandatory = True,
allow_single_file = True
),
"identifier": attr.string(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've been looking into an out parameter to specify the name of the compiled resource. With EmbeddedResource's you can specify the property LogicalName that is used by GenerateResource to set the output name.

The GenerateResource task uses the metadata of an item to name the resource that is embedded in an assembly.

Assuming that the assembly is named myAssembly, the following code generates an embedded resource named someQualifier.someResource.resources:

Based on my testing so far I haven't been successful with getting the compiled resource named based on the LogicalName property. I'll try testing this from visual studio, to get a better idea of how this is happening in that environment.

doc = "The identifier of the resource."
mandatory = True,
),
"target_frameworks": attr.string_list(
doc = "A list of target framework monikers to build.",
allow_empty = False,
),
"_csproj_template": attr.label(
doc = "The csproj template used in compiling a resx file."
default = Label(_TEMPLATE),
allow_single_file = True,
),
"_dotnet_runner": attr.string(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should use toolchains instead. Check out how the csharp_library etc. rules get access to dotnet.exe

doc = "Allows customizing the dotnet instance. [PH]"
jrbeverly marked this conversation as resolved.
Show resolved Hide resolved
default = "dotnet",
),
},
)
21 changes: 21 additions & 0 deletions examples/resgen/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
load(
"@d2l_rules_csharp//csharp:defs.bzl",
"csharp_binary",
"csharp_resx"
)

# bazel run //examples:hello
csharp_binary(
name = "hello",
srcs = ["hello.cs", "Strings.Designer.cs"],
resources = [":hello.resources"],
target_frameworks = ["net472"],
deps = ["@net//:System.Linq"],
)

csharp_resx(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. If src -> srcs then it'd be idiomatic to name this rule csharp_resx_library.

name = "hello.resources",
src = "Strings.resx",
identifier = "Hello.Strings.resource",
target_frameworks = ["net472"],
)
31 changes: 31 additions & 0 deletions examples/resgen/Strings.Designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions examples/resgen/Strings.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="utf-8"?>
<root>
<resheader name="resmimetype">
<value>text/microsoft-resx</value>
</resheader>
<resheader name="version">
<value>2.0</value>
</resheader>
<data name="Hello" xml:space="preserve">
<value>Hello World!</value>
</data>
</root>
10 changes: 10 additions & 0 deletions examples/resgen/hello.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
using System;
using System.Threading;
using System.Globalization;
namespace Hello {
public static class Program {
public static void Main() {
Console.WriteLine("Message: {0}", Strings.Hello);
}
}
}