Merge pull request #35 from gtk-rs/bilelmoussaoui/migrate

Merge repos

Author: bilelmoussaoui

.github/workflows/CI.yml

@@ -24,30 +24,25 @@ jobs:
         with:
           toolchain: ${{ matrix.rust }}
           override: true
-      - uses: actions-rs/cargo@v1
-        name: "Docs"
-        with:
-          command: doc
-          args: --features "dox,embed-lgpl-docs"
-      - uses: actions-rs/cargo@v1
-        name: "Test"
-        with:
-          command: test
-          args: --features "embed-lgpl-docs"
-      - uses: actions-rs/cargo@v1
-        name: "Build"
-        with:
-          command: build
-          args: --features "purge-lgpl-docs"
-      - run: git diff -R --exit-code
-      # - uses: actions/checkout@v2
-      #   with:
-      #     repository: gtk-rs/examples4
-      #     ref: master
-      #     path: examples4
-      # - name: Examples
-      #   working-directory: examples4
-      #   run: cargo check
+      - name: install dependencies
+        run: sudo dnf install -y xorg-x11-server-Xvfb
+      # gsk4
+      - name: "gsk4: tests"
+        run: xvfb-run --auto-servernum cargo test --manifest-path gsk4/Cargo.toml --all-features
+      - name: "gsk4: build"
+        run: cargo build --manifest-path gsk4/Cargo.toml --all-features
+      # gdk4
+      - name: "gdk4: tests"
+        run: xvfb-run --auto-servernum cargo test --manifest-path gdk4/Cargo.toml --all-features
+      - name: "gdk4: build"
+        run: cargo build --manifest-path gdk4/Cargo.toml --all-features
+      # gtk4
+      - name: "gtk4: tests"
+        run: xvfb-run --auto-servernum cargo test --manifest-path gtk4/Cargo.toml --all-features
+      - name: "gtk4: build"
+        run: cargo build --manifest-path gtk4/Cargo.toml --all-features
+
+      - uses: bcomnes/cleanup-xvfb@v1
 
   fmt:
     name: Rustfmt
@@ -64,13 +59,11 @@ jobs:
         with:
           command: fmt
           args: --all -- --check
-      - run: make regen_check
 
   checker:
     name: gtk-rs checker
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
       - uses: actions/checkout@v2
         with:
           repository: gtk-rs/checker

Cargo.toml

@@ -1,64 +1,11 @@
-[package]
-documentation = "https://gtk-rs.org/docs/gtk4/"
-categories = ["api-bindings", "gui"]
-license = "MIT"
-description = "Rust bindings for the GTK 4 library"
-name = "gtk4"
-homepage = "https://gtk-rs.org/"
-authors = ["The Gtk-rs Project Developers"]
-readme = "README.md"
-version = "0.1.0"
-keywords = ["gtk", "gtk4", "gtk-rs", "gnome", "GUI"]
-repository = "https://github.com/gtk-rs/gtk4"
-build = "build.rs"
-exclude = [
-    "gir-files/*",
+[workspace]
+members = [
+  "gdk4",
+  "gdk4/sys",
+  "gsk4",
+  "gsk4/sys",
+  "gtk4",
+  "gtk4/sys",
 ]
 
-[badges]
-appveyor = { repository = "GuillaumeGomez/gtk4", service = "github" }
-travis-ci = { repository = "gtk-rs/gtk4" }
-
-[lib]
-name = "gtk4"
-
-[features]
-purge-lgpl-docs = ["gtk-rs-lgpl-docs", "gdk4/purge-lgpl-docs", "gsk4/purge-lgpl-docs"]
-embed-lgpl-docs = ["gtk-rs-lgpl-docs", "gdk4/embed-lgpl-docs", "gsk4/embed-lgpl-docs"]
-dox = ["gdk4/dox", "gsk4/dox", "gtk4-sys/dox"]
-
-[package.metadata.docs.rs]
-features = ["dox", "embed-lgpl-docs"]
-
-[build-dependencies.gtk-rs-lgpl-docs]
-version = "0.1.3"
-optional = true
-git = "https://github.com/gtk-rs/lgpl-docs"
-
-[dependencies]
-libc = "0.2"
-bitflags = "1.0"
-once_cell = "1.0"
-atk = { git = "https://github.com/gtk-rs/atk" }
-atk-sys = { git = "https://github.com/gtk-rs/sys" }
-cairo-sys-rs = { git = "https://github.com/gtk-rs/cairo" }
-gdk-pixbuf-sys = { git = "https://github.com/gtk-rs/sys" }
-gdk4-sys = { git = "https://github.com/gtk-rs/sys" }
-gio-sys = { git = "https://github.com/gtk-rs/sys" }
-glib-sys = { git = "https://github.com/gtk-rs/sys" }
-gobject-sys = { git = "https://github.com/gtk-rs/sys" }
-graphene-sys = { git = "https://github.com/gtk-rs/graphene" }
-gsk4-sys = { git = "https://github.com/gtk-rs/sys" }
-gtk4-sys = { git = "https://github.com/gtk-rs/sys" }
-pango-sys = { git = "https://github.com/gtk-rs/sys" }
-cairo-rs = { git = "https://github.com/gtk-rs/cairo" }
-gio = { git = "https://github.com/gtk-rs/gio", features = ["v2_46"] }
-glib = { git = "https://github.com/gtk-rs/glib" }
-gdk4 = { git = "https://github.com/gtk-rs/gdk4" }
-graphene = { package = "graphene-rs", git = "https://github.com/gtk-rs/graphene" }
-gsk4 = { git = "https://github.com/gtk-rs/gsk4" }
-gdk-pixbuf = { git = "https://github.com/gtk-rs/gdk-pixbuf" }
-pango = { git = "https://github.com/gtk-rs/pango", features = ["v1_46"] }
-
-[dev-dependencies]
-gir-format-check = "^0.1"
+exclude = ["checker", "gir"]

Makefile

@@ -1,79 +1,41 @@
-# gtk4 ![CI](https://github.com/gtk-rs/gtk4/workflows/CI/badge.svg)
+# gtk4-rs
 
-[Project site](https://gtk-rs.org/) | [Online documentation](https://gtk-rs.org/docs-src/)
+The `gtk4-rs` are a group of crates that aims to provide gtk4 bindings.
 
-__Rust__ bindings and wrappers for __GTK 4__.
+This repository contains all the "core" crates of gtk 4. For more
+information about each crate, please refer to their `README.md` file in their directory.
 
-## Building
+## Regenerating
 
-__gtk4__ expects __GTK 4__, __GLib__ and __Cairo__ development files to be installed on your system.
-See the [requirements page](https://gtk-rs.org/docs/requirements.html).
+To regenerate crates using [gir], please use the `generator.py`
+file as follows:
 
-## Using
-
-We recommend using [crates from crates.io](https://crates.io/keywords/gtk-rs),
-as [demonstrated here](https://gtk-rs.org/#using).
-
-If you want to track the bleeding edge, use the git dependency instead:
-
-```toml
-[dependencies]
-gtk = { git = "https://github.com/gtk-rs/gtk4.git" }
-```
-
-Avoid mixing versioned and git crates like this:
-
-```toml
-# This will not compile
-[dependencies]
-gdk = "0.2"
-gtk = { git = "https://github.com/gtk-rs/gtk4.git" }
-```
-
-## Documentation
-
-The majority of the documentation is kept [in a separate repo][gtk-md] due to
-licensing issues. You can pull it in with cargo:
-
-```shell
-> cargo build --features embed-lgpl-docs
+```bash
+$ python3 generator.py
 ```
 
-Changes to those doc-comments should be submitted to the `lgpl-docs` repo. Avoid
-including those embedded doc-comments in PRs to this repo.
-
-The opposite feature removes all of those docs regardless of edits:
-
-```shell
-> cargo build --features purge-lgpl-docs
-```
-
-These features **rewrite the crate sources** so it's sufficient to enable them
-once. **Omitting them in the following `cargo` invocations will not undo their
-effects!**
-
-Generate the docs:
-
-```shell
-> cargo doc
-```
-
-[gtk-md]: https://github.com/gtk-rs/lgpl-docs/blob/master/README.md
-
-## Contribute
-
-Contributor you're welcome!
+## Development
 
-See the general [bindings documentation](https://gtk-rs.org/docs/glib/).
 
-Most of the bindings ([`src/auto`](src/auto)) are generated by [gir](https://github.com/gtk-rs/gir) using [this configuration file](Gir.toml). After editing `Gir.toml` the sources can be regenerated with
+This repository is structured as follows:
 
-```shell
-> make gir
+```text
+- crate/
+   |
+   |-- README.md
+   |-- Gir.toml
+   |-- Cargo.toml
+   |-- src/
+   |-- sys/
 ```
 
-When opening a PR please put the changes to the `src/auto` directory in a separate commit.
+The `crate` is a "top" directory (so "gdk4" or "gtk4" in here for example). I listed some
+import files, let's quickly explain them:
 
-## License
+ * `README.md`: Explanations about the crate itself and eventually some details.
+ * `Gir.toml`: Used by [gir] to generate most of the crates' code.
+ * `Cargo.toml`: File describing the crate, used by `cargo` and `Rust`.
+ * `src`: Contains the source code of the crate.
+ * `sys`: Contains the 1:1 bindings of the C API.
 
-__gtk4__ is available under the MIT License, please refer to it.
+[gir]: https://github.com/gtk-rs/gir

README.md

@@ -0,0 +1,48 @@
+[package]
+name = "gdk4"
+license = "MIT"
+homepage = "https://gtk-rs.org/"
+authors = ["The Gtk-rs Project Developers"]
+keywords = ["gdk", "gdk4", "gtk", "gtk-rs", "gnome", "GUI"]
+readme = "README.md"
+documentation = "https://gtk-rs.org/docs/gdk4/"
+version = "0.1.0"
+description = "Rust bindings for the GDK 4 library"
+repository = "https://github.com/gtk-rs/gdk4"
+build = "build.rs"
+exclude = [
+    "gir-files/*",
+]
+
+[lib]
+name = "gdk4"
+
+[features]
+dox = ["gdk4-sys/dox", "glib/dox", "gio/dox", "gdk-pixbuf/dox", "cairo-rs/dox", "pango/dox"]
+purge-lgpl-docs = ["gtk-rs-lgpl-docs", "cairo-rs/purge-lgpl-docs", "gdk-pixbuf/purge-lgpl-docs", "gio/purge-lgpl-docs"]
+embed-lgpl-docs = ["gtk-rs-lgpl-docs", "cairo-rs/embed-lgpl-docs", "gdk-pixbuf/embed-lgpl-docs", "gio/embed-lgpl-docs"]
+
+[package.metadata.docs.rs]
+features = ["dox", "embed-lgpl-docs"]
+
+[build-dependencies.gtk-rs-lgpl-docs]
+version = "0.1.3"
+optional = true
+git = "https://github.com/gtk-rs/lgpl-docs"
+
+[dependencies]
+libc = "0.2"
+bitflags = "1.0"
+glib-sys = { git = "https://github.com/gtk-rs/gtk-rs" }
+gdk4-sys = { path = "./sys" }
+gio-sys = { git = "https://github.com/gtk-rs/gtk-rs" }
+gobject-sys = { git = "https://github.com/gtk-rs/gtk-rs" }
+cairo-sys-rs = { git = "https://github.com/gtk-rs/gtk-rs" }
+cairo-rs = { git = "https://github.com/gtk-rs/gtk-rs" }
+gdk-pixbuf = { git = "https://github.com/gtk-rs/gtk-rs" }
+gio = { git = "https://github.com/gtk-rs/gtk-rs" }
+glib = { git = "https://github.com/gtk-rs/gtk-rs" }
+pango = { git = "https://github.com/gtk-rs/gtk-rs" }
+
+[dev-dependencies]
+gir-format-check = "^0.1"