IUP for Zig

A Zig language idiomatic and type-checked bindings for IUP Portable User Interface Toolkit

Examples

First look

A simple hello world example looks like this:

const iup = @import("iup.zig");

pub fn main() !void {
    try iup.MainLoop.open();
    defer iup.MainLoop.close();

    var main_dialog = try (iup.Dialog.init()
        .setTitle("Hello World")
        .setChildren(
        .{
            iup.VBox.init()
                .setMargin(10, 10)
                .setGap(10)
                .setAlignment(.ACenter)
                .setChildren(
                .{
                    iup.Label.init()
                        .setTitle("Hello World from IUPforZig"),
                    iup.Button.init()
                        .setTitle("OK")
                        .setActionCallback(exit),
                },
            ),
        },
    ).unwrap());
    defer main_dialog.deinit();

    try main_dialog.showXY(.Center, .Center);
    try iup.MainLoop.beginLoop();
}

fn exit(button: *iup.Button) !void {
    iup.MainLoop.exitLoop();
}

Resulting in this:

IUP Metadata

This project contains source-code automatically generated by The IUP Metadata Project.

Most of the hard/repetitive work was done by code-gen tool, however, the API guidelines and all the interop code belongs here on this project.

API

Zig does not require any special treatment to use C libraries, so to use IUP in Zig, it is as simple as adding @cInclude("iup.h") in your source code, no need for special bindings!

This project attempts to create Zig bindings for IUP Toolkit with idiomatic and type-checked API, where none of the original IUP's declarations are exposed in the public interface, only names and concepts are kept as close as possible.

Comparison:

IUP simple example in C:

#include <stdlib.h>
#include <iup.h>

int main(int argc, char **argv)
{
  Ihandle *dlg, *multitext, *vbox;

  IupOpen(&argc, &argv);

  multitext = IupText(NULL);
  vbox = IupVbox(
    multitext,
    NULL);
  IupSetAttribute(multitext, "MULTILINE", "YES");
  IupSetAttribute(multitext, "EXPAND", "YES");

  dlg = IupDialog(vbox);
  IupSetAttribute(dlg, "TITLE", "Simple Notepad");
  IupSetAttribute(dlg, "SIZE", "QUARTERxQUARTER");

  IupShowXY(dlg, IUP_CENTER, IUP_CENTER);
  IupSetAttribute(dlg, "USERSIZE", NULL);

  IupMainLoop();

  IupClose();
  return EXIT_SUCCESS;
}

Equivalent example in Zig:

const iup = @import("iup.zig");

pub fn main() !void {
    try iup.MainLoop.open();
    defer iup.MainLoop.close();

    var main_dialog = try (iup.Dialog.init()
        .setTitle("Simple Notepad")
        .setSize(.Quarter, .Quarter)
        .setChildren(
        .{
            iup.VBox.init()
                .setChildren(
                .{
                    iup.Text.init()
                        .setMultiline(true)
                        .setExpand(.Yes),
                },
            ),
        },
    ).unwrap());
    defer main_dialog.deinit();

    try main_dialog.showXY(.Center, .Center);
    try iup.MainLoop.beginLoop();
}

How to build

Download Zig;
Install IUP shared libraries and run:

NOTE: curl is needed to download IUP binaries.

Linux

./install_iup.sh
zig build run

Windows

.\install_iup.bat
zig build run

For more information, please visit IUP's download page for your platform: https://sourceforge.net/projects/iup/files/3.30/

Dependencies for libim and libcd may be required: https://sourceforge.net/projects/imtoolkit/files/3.15/ https://sourceforge.net/projects/canvasdraw/files/5.14/

Pending work

Support for collections and indexed attributes (list items for example)
Complete the Simple Notepad example.
Support Linux and Windows (using shared libs)
Investigate how to build IUP from C sources in Zig.
More tests, and sanitize failing tests.
Additional controls (image library, matrix, GLCanvas, scintilla, plot, etc)

Feel free to place any comments/issues/PRs, it will be very nice to receive any feedback 🚀.

Prior Art

Some great projects that served as inspiration.

License

This project is a free and unencumbered software released into the public domain. Plese visit unlicense.org for more details.
IUP is a Tecgraf/PUC-Rio project licensed under the terms of the MIT license. Please visit https://www.tecgraf.puc-rio.br/iup/ for more details.

Complex metadata representation

Figure out the better way to represent those metadata complexities:

1. IUP elements that have attributes that are applied on children;

Example:

MDI attributes for Canvas for example

Proposals:

Render these functions in all possible elements, allowing to set them even when they are not children of the expected element.
Render these functions on parent element with a special signature .setXYZ(child, value); Maybe not ergonomics to declare in fluent API.

2. Complex union values

Examples:

Colors can be an RGB triplet or a well-known alias, like "BGCOLOR", "FGCOLOR", etc.
Tree.setValue expects an i32 representing the index, or a well-known alias, like "NEXT", "PREVIOUS", "ROOT", etc

Proposals

Status-quo: Declare an union with each possible value, for example

pub const Color = union(enum) {
    BgColor,
    FgColor,
    Rgb: Rgb,
};

pub const Selection = union(enum) {
    Next,
    Previous,
    Root,
    Index: i32
};

Use anytype in set; Each case may have a get behavior.
Declare two functions, one for each type, for example setColorRgb and setColorStr`

3. Handle or HandleName attributes

Example:

setImage and many others attribute should accept an Image or a string with the HandleName

Proposals

Status-quo: use aways string, for example setImage(image.getHandleName())
Use anytype in set; Each case may have a get behavior.
Declare two functions, one for each type, for example setImage and setImageHandleName`

batiati / iupforzig Goto Github PK

iupforzig's Introduction

IUP for Zig

Examples

First look

IUP Metadata

API

Comparison:

How to build

Pending work

Prior Art

License

iupforzig's People

Contributors

Stargazers

Watchers

Forkers

iupforzig's Issues

1. IUP elements that have attributes that are applied on children;

2. Complex union values

3. Handle or HandleName attributes

Recommend Projects

Recommend Topics

Recommend Org