Skip to main content

Markup compiler for GTK user interface definitions

Project description

Blueprint

A markup language for GTK user interface files.

Motivation

GtkBuilder XML format is quite verbose, and many app developers don't like using WYSIWYG editors for creating UIs. Blueprint files are intended to be a concise, easy-to-read format that makes it easier to create and edit GTK UIs.

Internally, it compiles to GtkBuilder XML as part of an app's build system. It adds no new features, just makes the features that exist more accessible.

Another goal is to have excellent developer tooling--including a language server--so that less knowledge of the format is required. Hopefully this will increase adoption of cool advanced features like GtkExpression.

Example

Here is what the libshumate demo's UI definition looks like ported to this new format:

using Gtk 4.0;
using Shumate 1.0;

template ShumateDemoWindow : Gtk.ApplicationWindow {
  can-focus: yes;
  title: _("Shumate Demo");
  default-width: 800;
  default-height: 600;

  [titlebar]
  Gtk.HeaderBar {
    Gtk.DropDown layers_dropdown {
      notify::selected => on_layers_dropdown_notify_selected() swapped;
    }
  }

  Gtk.Overlay overlay {
    vexpand: true;
    Shumate.Map map {}

    [overlay]
    Shumate.Scale scale {
      halign: start;
      valign: end;
    }

    [overlay]
    Gtk.Box {
      orientation: vertical;
      halign: end;
      valign: end;

      Shumate.Compass compass {
        halign: end;
        map: map;
      }
      Shumate.License license {
        halign: end;
      }
    }
  }
}

Editors

Workbench, GNOME Builder and KDE's Kate have builtin support for Blueprint.

Vim

GNU Emacs

Visual Studio Code

Sublime Text

Zed

Getting in Touch

Matrix room: #blueprint-language:matrix.org

License

Copyright (C) 2021 James Westman james@jwestman.net

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

blueprint_compiler-0.20.4.post3.tar.gz (168.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

blueprint_compiler-0.20.4.post3-py3-none-any.whl (157.3 kB view details)

Uploaded Python 3

File details

Details for the file blueprint_compiler-0.20.4.post3.tar.gz.

File metadata

File hashes

Hashes for blueprint_compiler-0.20.4.post3.tar.gz
Algorithm Hash digest
SHA256 10c2fb94bfb953564e11e0138dbabe9259cb64a542c0ce4c99c9f7c2c0f88bf5
MD5 7a0b67c07d20c6d755698f4a6f2c9ba9
BLAKE2b-256 d87a2f05f39826a31a0af0c73170fc195b886d903cb062255a33787bc3e2ddb7

See more details on using hashes here.

File details

Details for the file blueprint_compiler-0.20.4.post3-py3-none-any.whl.

File metadata

File hashes

Hashes for blueprint_compiler-0.20.4.post3-py3-none-any.whl
Algorithm Hash digest
SHA256 b25c9c0a3b5ee68aad5893ed03453a4183e22a0989635701c4eadf32ba0e4e85
MD5 d0c97d8baee1ec265479e599c04f8399
BLAKE2b-256 496391547c05bb8542847b2dae9c1c5d5a43dd82288de08350474499afed3737

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page