simplexidev/sdevlibs

[WIP] A collection of cross-platform .NET libraries that provide tools for creating robust desktop applications.

NOTICE: This project was just renamed from LibUISharp to sdfx.
NOTICE: This project is still a work-in-progress, and should not be used in a production environment.
NOTICE: The native dependency 'andlabs/libui' is early-alpha software, and as such is unstable.

SimplexiDev Framework

SimplexiDev Framework, or SDFx for short, is a collection of .NET libraries to create robust desktop applications on Windows, macOS, and Linux.

Contributing

Contributing is as easy as filing an issue, fixing a bug, starting a discussion, or suggesting a new feature. For more information about contributing to this project, see the CONTRIBUTING.md file.

Please hold off on submitting pull requests until #39 is merged. If you really want to prepare a pull request until then, please use the branch feature/internal/new-infrastructure.

Project Status

Build Status

We currently use Azure DevOps for our automated build process. While we only build for a few platforms, our packages should be able to be used on any platform supported by .NET 6.

Package	Status
SimplexiDev.Audio
SimplexiDev.Build.Annotations
SimplexiDev.Build.NativeCallGenerator
SimplexiDev.Core
SimplexiDev.IO.Compression
SimplexiDev.Native.Libui
SimplexiDev.Native.Miniaudio
SimplexiDev.Native.Zstd
SimplexiDev.UI
SimplexiDev.UI.Extras

Current Releases

Stable and preview packages are published on NuGet. Our CI builds are published to MyGet.

Using SDFx Packages

For examples, see the examples\ directory.

Utilizing Pre-Built Packages

While following these instructions:

• Replace {YourProject} with the the name of your project file.
• Replace {PackageName} with the package you want to use.
• Replace {PackageVersion} with the version of the package.

Install using .NET CLI

Run the following command in a command-line interface:

dotnet add {YourProject} package {PackageName} -v {PackageName}

Building From Source

You can build the packages by installing the .NET 6 SDK and using the following command in the root of the repository:

dotnet build sdfx.sln

sdevlibs's Issues

New Example Projects

Essentially, this will be the main list of example projects that need finished. The list is subject to change at any time:

LibUISharp.Core:

• DisposableExample
• EventHandlerExample
• PlatformExample (incl. in #39)
• NativeAssemblyExample
• NativeCallGeneratorExample

LibUISharp.UI

• SimpleWindowExample (incl. in #39)
• MenuedWindowExample
• ControlGalleryExample
• DrawingExample

Custom NativeLibraryLoader Implementation

This will allow for using the new C# unmanaged delegates as function pointers, rather than just IntPtr or void*. Hoping for a performane boost from it.

I also plan on adding FreeBSD/macOS support for it.

Support for uiTimer

This references PR andlabs/libui#223.

The Definition for NETStandard 2.0 is not found.

This issue is dependent on dotnet/standard#542.

The compiler and Intellisense complains with this error when using NativeLibrary.LoadFunction<T>() from NativeLibraryLoader:

Error CS0012: The type 'Object' is defined in an assembly that is not referenced. You must add a reference to assembly 'netstandard, Version=2.0.0.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51'.

This occurs in Kernel32Library.csL24, LibuiLibrary.csL30, and User32Library.csL24.

Various Exceptions Thrown in ControlGallery on Load.

Depending on how you go about debugging ControlGallery on Windows, you will encounter a EngineExecutionException or an AccessViolationException.

The EngineExecutionException is thrown while debugging the app in Visual Studio as DEBUG or RELEASE. If you build it with DEBUG, the error is thrown while initializing the Slider on the NumbersTab. If you build with RELEASE, it is thrown while initializing the ComboBox on the same tab.

If you build as either DEBUG or RELEASE, and you start the app without debugging, then attach to it once it crashes, you'll notice that an AccessViolationException is thrown on the ProgressBar initializer right after the ComboBox.

This references commit 4712a3c in api-changes

Support for uiTable

This references issue andlabs/libui#310.

Add SourceLink to the build

More Information: https://github.com/dotnet/sourcelink

Colors aren't displayed correctly

When the application opens, the color isn't the selected green, but it's purple.

When the color is changed to black (#FF000000), the resulting image turns gray (#FF7F7F7F).

Setup Azure Pipelines for Managed and Native Builds

This issue replaces #28
Depends on #46
This issue may be moved to another repository in the future

Essentially, this is what was left of the last major PR that needs finished, besides the API for libui.

Here is a list of tasks that need done to finish this:

• Setup Managed Builds
  • SDFx
• Setup Native Builds
  • libui-ng
  • miniaudio
  • zstd

For the native builds, each pipeline will be built on a weekly basis.

CI support for pipeline trigger on submodule update

It would be nice to run a specific pipeline based on if a submodule was updated. This would allow for native builds upon the update of a submodule.

Support for uiImage

This issue references commit andlabs/libui@e730534.

The second window is closed…

Hi,
I was in trouble.

Try the following code.

    class Program
    {
        static void Main(string[] args)
        {
            var app=new Application();
            var win=new Window1();
            app.Run(win);
        }
    }

    class Window1:Window
    {
        private readonly Button _btn=new Button("Show Window2");
        public Window1() : base("Window1") => InitializeComponent();

        protected sealed override void InitializeComponent()
        {
            base.InitializeComponent();
            Child = _btn;
            _btn.Click += (sender, args) =>
            {
                var window2 = new Window2();
                window2.Show();
            };
        }
    }

    class Window2:Window
    {
        public Window2():base("Window2"){}
    }

After I closed the window2,the application exited.Why?

Also,the application cannot show Chinese.

Thank in advance for any help.

InvalidOperationException thrown in Histogram Demo

When launching the LibUISharp.Demos.Histogram project, a mysterious `InvalidOperationException is thrown, and the application closes immediately. Odd thing is, that when the exception is thrown, it will only write a line to the Debug Output:

Exception thrown: 'System.InvalidOperationException' in LibUISharp.dll

In Visual Studio, debugging just stops when the exception is thrown, so there's no stack trace to see (that I know of).

I don't have a clue as to what is causing this, but it's affecting Windows and Linux (I assume macOS too, but I don't have access to a macOS installation).

Support for uiFixed

This is dependant on PR andlabs/libui#332.

How to use Menu?

Hi,
I found Menu in LibUISharp.However I dot not find any demo to use Menu.
When I ran the following code, a window did not appear and the dotnet process exited at once.

 public class MainWindow : Window
    {
        private readonly Menu _menu=new Menu("Demo");
	
        public MainWindow() : base("LibUISharp Control Gallery", new Size(640, 480), true) => InitializeComponent();
	
        protected sealed override void InitializeComponent()
        {
            IsMargined = true;
            Child = _menu;
            _menu.AddAboutItem(arg=>ShowMessageBox("Demo","Demo"));
            _menu.AddSeparator();
            _menu.AddQuitItem();
        }
    }

I hope you can help me.
Thanks.

Implementing xUnit Testing

Currently I do not have any test suites made up for this project, mostly because I don't know much about it. I'll have to look into it more.

Update:

Anyone is more than welcome to have at this, since I don't have the time to learn a test API, and write said tests. To be honest, I don't even know where to start when it comes to writing them.

That said, If anyone wants to work on this, create a new folder in the {ProjectRoot}/source/LibUISharp/tests/, with the project file {ProjectRoot}/source/LibUISharp/LibUISharp.Tests.csproj.

Nuget?

Is your feature request related to a problem? Please describe.
Kinda. can you upload this to nuget?

Describe the solution you'd like
Upload as .net 5 nuget package

Describe alternatives you've considered
I have considered Eto.Forms but its too complicated.

Additional Information
Please separate stable and unstable releases

Re-add PackageReference for NativeLibraryLoader instead of recompiling

Finish Demo Projects

I'm missing some demos that feature the functions of LibUISharp. Here's the current demos as well as missing ones:

• SimpleWindow
  Displays an empty Window with default properties. (Thanks to @ashelleyPurdue)
• ControlGallery
  Displays a gallery displaying all controls in the LibUISharp namespace.
• DrawText
  Displays a Window with decorated text using font and text functions from LibUISharp.Drawing.
• Histogram
  Displays a user-drawn histogram using drawing functions from LibUISharp.Drawing.

Support Improved uiDateTimePicker.

This PR is dependant on andlabs/libui#297.

Correctly include native libraries into LibUISharp.csproj

Any library that referenecs LibUISharp as-is, will recive a FileNotFoundException, complaining about not being able to find the libui assembly. I can't seem to find a way to add them to the project and avoid this issue right now, but this needs fixed before anything else.

Improvements to Continuous Integration

It would be ideal to have a submodule for libui, and then build libui using TravisCI and Appveyor. This would make releasing the binaries for libui (and keeping the libraries up-to-date) a whole lot easier.

The downside is I know nothing about CMake, nor TravisCI, so this is definitely out of my scope for now.

Possible MDI implimentation? I don't think libui supports it natively.

Is your feature request related to a problem? Please describe.
No its more of a sad reality of the modern world and of nostalgia.
But in reality it's about game editors and size limitation of small single monitors.

Describe the solution you'd like
MDI (M)ultiple (D)ocument (I)nterface.

Would it be possible to hack in multiple document interface if it isn't too hard?
I don't think libui supports it so if it's even possible it would be a hacky solution.

Describe alternatives you've considered
Many many other GUI libraries.

Additional Information
Mac uses a totally different ui layout.
It could probably just use separate windows and close them when the main window closes.

Finish Documentation

Mostly just drawing classes need documentation. I will work on that after merging #27. This will be finished (mostly) in api-changes (#27).

Support for uiLoadControlFont

This issue is dependant on PR andlabs/libui#388

Replace `libui` with `libui-ng`

As the libui community has decided, there is a new repository that will be updated and is currently maintained. I will eventually get to moving it over.

Hide the Console Window on startup

This seems to be a looming issue with .NET Core, since you can only compile as a library or console application. I would love to do it programatically, rather than try to use binedit.exe or whatever NSubsys is (which may be an option).

This is definitely a help wanted issue, as I'm not quite sure where to start with this. At least there's a simple way on Windows to accomplish this.

CLS Compliance

I need to see about how compliant the library is, and see what needs to be done to be compliant, if not already.

Add `LibuiBindingGenerator` tool

This tool would generate bindings based on the header file located int \ the root of the repository: ui.h.

SafeHandle Implementation

I'm working on this in the api-changes branch. Wanted an issue here to keep track of what I'm working on.

Histogram demo crashes immediately on MacOS

The culprit is the following line:
Matrix matrix = Matrix.SetIdentity();
on LibUISharp.Demos.Histogram.SurfaceHandler class (Line 54)

It throws the following system access violation:

Attempted to read or write protected memory. This is often an indication that other memory is corrupt.
libui.dylib [areaView drawRect:] + 537
com.apple.AppKit NSViewDrawRect + 83

When the following three lines are commented out, the histogram shows fine, albeit without the correct offset:

Matrix matrix = Matrix.SetIdentity();
matrix.Translate(xoffLeft, yoffTop);
e.Context.Transform(matrix);

The crash is observed even calling the SetIdentity method on its own without translating it or transforming the context with it, i.e.:

Matrix matrix = Matrix.SetIdentity();
// matrix.Translate(xoffLeft, yoffTop);
// e.Context.Transform(matrix);

This narrows down the issue to:
LibuiLibrary.uiDrawMatrixSetIdentity(matrix.ToLibuiDrawMatrix());
on LibUISharp.Drawing.Matrix.SetIdentity() static method (Line 31)

LibuiException thrown on Application Initialization

On initialization of a lLibUISharp application throws a LibuiException, which is caused by a COMException with the following error message:

LibuiException: error initializing libui: initializing COM; code -2147417850 (0x80010106) Cannot change thread mode after it is set.

@ashelleyPurdue I figured I'd mention you since you mentioned this exception earlier in #10.

The fix is to call Encoding.RegisterProvider(CodePagesEncodingProvider.Instance); in the initializer of LibUISharp.Application, and locking the rest of the method call. I'll be pushing a fix within an hour.

Can't compile on Linux and .net core 2.0 SDK

Hi,

I'm trying to compile your library on linux, but I always getting this error:

src/LibUISharp/FileDialog.cs(2,25): error CS0234: The type or namespace name 'Internal' does not exist in the namespace 'LibUISharp' ...

The same error for most files. I'll be grateful to get some hint how to overcome this.

Fix Continuous Integration and Automate the Release of a *.nupkg

The CI setup needs to be fixed, since I don't use it enough to know what I'm doing, and I'm not sure how to save artifacts in AppVeyor.

I will eventually get to this issue, but anyone is more than welcome to take it on!

0.4.0 Release

Version 0.4.0 of libui was released a few days ago, and that means it's time for a release, and a stable package on NuGet.

Issues/PRs that need that need to be resolved/finished:

[ ] Issue #3
[ ] Issue #21
[ ] Issue #24
[ ] Pull #27

For status of each listed, see the 0.4.0 project board