From 1770b12d5d95476310c27ccf39a91b5ba4a3f119 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Sun, 12 Jul 2026 17:20:15 +0300 Subject: bootstrap: meson build, test harness, CI, conventions, README/AGENTS (et0) Phase 0 (task et0): lays the build/test/CI/convention groundwork before any feature code. - meson.build: project ggaze C11 -Wall -Wextra; deps gtk4/glib/gio/libadwaita; feature options gegl/jxl/avif/heif (auto); generated ggaze-config.h with app id, version, GGAZE_HAVE_* feature flags. - tests: GLib g_test harness with separate unit/integration suites (--suite unit / --suite integration); test_bootstrap sanity test proves the harness compiles and the config header is reachable; -Db_coverage=true coverage target wired. - CI: .woodpecker/ci.yml three lanes (minimal, gegl, asan) with xvfb for the integration track and a coverage lane that warns until M10. - conventions: .clang-format (3-space, 80-col, K&R, *-on-var, return type on its own line) + .editorconfig matching docs/coding-conventions.md; CI clang-format --dry-run -Werror gate. - top-level README.md (humans) and AGENTS.md (agents) pointing into docs/. - LICENSE (GPL-3.0-or-later), .gitignore, dir placeholders. Acceptance: meson setup build && ninja -C build && meson test -C build green; clang-format --dry-run --Werror clean. --- .clang-format | 46 +++ .editorconfig | 27 ++ .gitignore | 19 ++ .woodpecker/ci.yml | 58 ++++ AGENTS.md | 126 ++++++++ LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++ README.md | 105 +++++++ data/.gitkeep | 0 ggaze-config.h.in | 15 + meson.build | 51 ++++ meson_options.txt | 21 ++ po/.gitkeep | 0 po/LINGUAS | 0 src/meson.build | 3 + tests/fixtures/.gitkeep | 0 tests/helpers/.gitkeep | 0 tests/integration/meson.build | 3 + tests/meson.build | 22 ++ tests/test_bootstrap.c | 49 +++ 19 files changed, 1219 insertions(+) create mode 100644 .clang-format create mode 100644 .editorconfig create mode 100644 .gitignore create mode 100644 .woodpecker/ci.yml create mode 100644 AGENTS.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 data/.gitkeep create mode 100644 ggaze-config.h.in create mode 100644 meson.build create mode 100644 meson_options.txt create mode 100644 po/.gitkeep create mode 100644 po/LINGUAS create mode 100644 src/meson.build create mode 100644 tests/fixtures/.gitkeep create mode 100644 tests/helpers/.gitkeep create mode 100644 tests/integration/meson.build create mode 100644 tests/meson.build create mode 100644 tests/test_bootstrap.c diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..05e8ba5 --- /dev/null +++ b/.clang-format @@ -0,0 +1,46 @@ +--- +# ggaze .clang-format — matches docs/coding-conventions.md and the +# c-best-practices skill. Enforced in CI with `clang-format --dry-run -Werror`. +Language: Cpp +BasedOnStyle: LLVM + +# 3-space indent, no tabs, 80-col limit. +# (UseTab singular is the canonical clang-format key across LLVM >=16; the +# older plural spelling is rejected by current toolchains.) +ColumnLimit: 80 +IndentWidth: 3 +UseTab: Never +TabWidth: 3 +ContinuationIndentWidth: 3 + +# K&R braces (opening brace on the same line). +BreakBeforeBraces: Attach + +# Return type on its own line above the function name (c-best-practices). +# AllDefinitions is accepted by both LLVM 18 (Fedora 40) and LLVM 22. +AlwaysBreakAfterReturnType: AllDefinitions + +# Pointer asterisk on the variable: `Token *p_token`, not `Token* p_token`. +PointerAlignment: Right + +# Keep the hand-written include order (own header, system, project). +SortIncludes: false +IncludeBlocks: Preserve + +# Spacing. +SpaceBeforeParens: ControlStatements +SpaceAfterCStyleCast: false +SpacesInParentheses: false +SpacesInSquareBrackets: false + +# No collapsing short control bodies onto one line. +AllowShortIfStatementsOnASingleLine: Never +AllowShortBlocksOnASingleLine: Empty +AllowShortFunctionsOnASingleLine: Empty +AllowShortLoopsOnASingleLine: false +AllowShortEnumsOnASingleLine: false + +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: Consecutive +AlignConsecutiveDeclarations: Consecutive +AlignTrailingComments: true \ No newline at end of file diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..41f7f1b --- /dev/null +++ b/.editorconfig @@ -0,0 +1,27 @@ +# ggaze editor config — mirrors docs/coding-conventions.md + .clang-format. +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = space +indent_size = 3 +max_line_length = 80 + +[*.{c,h}] +indent_size = 3 + +[meson.build] +indent_size = 3 + +[*.md] +max_line_length = off +trim_trailing_whitespace = false + +[*.{yml,yaml}] +indent_size = 2 + +[Makefile] +indent_style = tab \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0c66e9c --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +# ggaze build artifacts +/build/ +/build-*/ +*.o +*.obj +*.gcno +*.gcda +*.gcov +coverage-html/ + +# Meson +/subprojects/packagecache/ + +# Editors / OS +.DS_Store +*.swp +*~ +\#*\# +.\#* \ No newline at end of file diff --git a/.woodpecker/ci.yml b/.woodpecker/ci.yml new file mode 100644 index 0000000..6ec4680 --- /dev/null +++ b/.woodpecker/ci.yml @@ -0,0 +1,58 @@ +# ggaze CI — Woodpecker (codeberg-native). +# +# Three lanes (see docs/IMPLEMENTATION.md Phase 0): +# minimal all optional backends disabled; plain GdkPixbuf viewer. +# gegl gegl=enabled (+ jxl/avif/heif auto) — keeps the optional path +# from bit-rotting. +# asan minimal build under AddressSanitizer + UBSan (also drives the +# per-feature leak-check tasks). +# +# The coverage gate runs in the minimal lane and is "warn" until M10, after +# which it is flipped to fail (see docs/IMPLEMENTATION.md Cross-cutting). + +matrix: + include: + - LANE: minimal + MESON_OPTS: "-Dgegl=disabled -Djxl=disabled -Davif=disabled -Dheif=disabled" + RUN_COVERAGE: "yes" + ENV: "" + - LANE: gegl + MESON_OPTS: "-Dgegl=enabled" + RUN_COVERAGE: "no" + ENV: "" + - LANE: asan + MESON_OPTS: "-Dgegl=disabled -Djxl=disabled -Davif=disabled -Dheif=disabled -Db_sanitize=address,undefined" + RUN_COVERAGE: "no" + ENV: "G_DEBUG=gc-friendly ASAN_OPTIONS=detect_leaks=1:abort_on_error=1" + +when: + - event: [push, pull_request, manual] + +steps: + build-and-test: + image: fedora:40 + environment: ${ENV} + commands: + - dnf install -y --setopt=install_weak_deps=False + meson ninja-build gcc clang clang-format git + pkgconf-pkg-config xorg-x11-server-Xvfb + gtk4-devel glib2-devel libadwaita-devel + - | + if [ "$LANE" = "gegl" ]; then + dnf install -y --setopt=install_weak_deps=False gegl-devel babl-devel + fi + - meson setup build $MESON_OPTS + - ninja -C build + - clang-format --dry-run --Werror $(git ls-files '*.c' '*.h') + - | + if [ "$RUN_COVERAGE" = "yes" ]; then + # lcov/genhtml not installed in Phase 0 (gate warns until M10); + # add lcov + (perl-Dot-Graph or genhtml) here when M10 flips the + # coverage gate to fail. + meson setup -Db_coverage=true build-cov $MESON_OPTS + ninja -C build-cov + meson test -C build-cov + ninja -C build-cov coverage || echo "coverage: lcov/genhtml not installed (warn)" + fi + - meson test -C build --suite unit + - xvfb-run -a meson test -C build --suite integration \ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..f56a48a --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,126 @@ +# AGENTS.md — guide for coding agents working on ggaze + +ggaze is a small, fast, native GTK4 image viewer in C for Fedora/GNOME. This +file is the entry point for a fresh-context agent: read it first, then the +linked `docs/`. Humans should read `README.md`. + +## Load these skills as instructions (not as shell commands) + +- `agent-task-management` — task workflow (use `~/go/bin/ask` subcommands only) +- `c-best-practices` — C style, authoritative for all C here +- `solid-principles` — OO/design review +- `beyond-solid-principles` — architecture review +- `find-code-bugs` — defect hunting (at audit milestones) + +## Build / test / coverage + +```sh +meson setup build +ninja -C build +meson test -C build +meson test -C build --suite unit +meson test -C build --suite integration + +# coverage (>=80% on plain-C modules; gate warns until M10, then fails) +meson setup -Db_coverage=true build-cov && ninja -C build-cov +meson test -C build-cov && ninja -C build-cov coverage + +# leak check (run after every major feature — see "Memory" below) +meson setup build-asan -Db_sanitize=address,undefined +ASAN_OPTIONS=detect_leaks=1:abort_on_error=1 G_DEBUG=gc-friendly \ + meson test -C build-asan +``` + +## Two test tracks (both mandatory) + +| Track | Where | What | Gate | +|-------|------|------|------| +| unit | `tests/test_.c` | plain-C modules, no display | >=80% line coverage (gcov) | +| integration | `tests/integration/test_.c` | cross-module flows, real temp dirs, offscreen GTK | must be green, no coverage gate | + +Shared helpers go in `tests/helpers/`; fixtures in `tests/fixtures/` (grow per +milestone). Integration suites land with the milestone that first makes a flow +possible — see `docs/IMPLEMENTATION.md` "Planned integration suites". + +## Conventions (enforced) + +- `docs/coding-conventions.md` summarizes; the `c-best-practices` skill wins. +- 3-space indent, 80 cols, K&R braces, `*` on the variable (`Token *p_token`), + parenthesized returns (`return (x);`), return type on its own line. +- One module per `foo.h` + `foo.c`; every concrete type gets `type_new` / + `type_delete` (pair them); plain-C modules own no GtkWidget and are + unit-testable without a display. +- `clang-format --dry-run --Werror` must be clean on every `*.c`/`*.h` + (`.clang-format` matches the conventions). CI fails on a dirty tree. The + config targets LLVM clang-format >=16 (Fedora 40 ships 18); it uses the + cross-version key spellings (`UseTab`, `AlwaysBreakAfterReturnType`) so + both the Fedora-40 CI toolchain and newer local builds accept it. +- Header guards uppercase from filename (`NAVIGATOR_H`). `.c` includes: own + header first, blank line, system `<...>`, then project `"..."`. + +## Optional features are OFF in the minimal CI lane + +`gegl`, `jxl`, `avif`, `heif` are meson `feature`s (default `auto`). The +**minimal** CI lane forces all disabled and must stay green; the **gegl** lane +forces `gegl=enabled`. Never break the minimal build when adding an optional +backend — gate code with `GGAZE_HAVE_*` from `ggaze-config.h` and toast +"GEGL not built in" gracefully. + +## Architecture invariants (do not violate) + +- Only the main thread touches GTK widgets. Decode runs in `GTask` threads. +- **One active load per window.** Issuing a new load cancels the previous + `GCancellable` and drops its result. The viewer only ever shows a texture + whose path == `navigator.current` (**last-write-wins**). +- Bounded `GdkTexture` LRU (cap 4) to bound memory. +- Plain-C modules (`navigator`, `loader`, `detect`, `thumbnail`, `trash`, + `mover`, `opener`, `runner`, `enhancer`, `info`, `texturecache`, + `clipboard`) own no GtkWidget and are unit-tested standalone. + +## Memory (C has no GC) + +After **every major feature milestone**, run a `+leakcheck` pass before +starting the next feature: ASan build + `G_DEBUG=gc-friendly`, full test suite +(unit + integration), and a scripted elevator-pitch session; any leak blocks +the next milestone. See `docs/IMPLEMENTATION.md` "Memory-leak profiling". + +## Module map + +``` +src/main.c entry, CLI, GtkApplication +src/app.{c,h} GApplication, actions, single-instance +src/window.{c,h} GgazeWindow : GtkApplicationWindow (grid/large stack) +src/viewer.{c,h} GgazeViewer : GtkWidget (large canvas, zoom/pan) +src/gridview.{c,h} GgazeGrid (thumbnail overview) +src/shortcuts.{c,h} keybinding -> GAction map +src/navigator.{c,h} dir listing, sort/filter, marks, GFileMonitor +src/trash.{c,h} ./Trash bin + permanent delete + undo +src/mover.{c,h} configurable move destinations +src/opener.{c,h} configurable external programs +src/runner.{c,h} configurable shell scripts (async /bin/sh -c) +src/enhancer.{c,h} optional GEGL quick-enhance + export copy +src/clipboard.{c,h} copy image/URIs to GdkClipboard +src/thumbnail.{c,h} freedesktop TMS cache +src/settings.{c,h} GSettings wrapper (org.buetow.ggaze) +src/info.{c,h} EXIF/dimensions gather (libexif) +src/texturecache.{c,h} bounded LRU of decoded GdkTextures +src/loader/loader.{c,h} async load API +src/loader/detect.{c,h} content-sniff format detection +src/loader/backends/ pixbuf.c jxl.c avif.c heif.c (jpeg.c M6) +``` + +## Design docs (read before touching a milestone) + +`docs/PLAN.md` (tracker + decisions log), `docs/IMPLEMENTATION.md` (execution +plan + test-track tables + leak-check rules), `docs/architecture.md`, +`docs/ui-and-interactions.md`, `docs/tech-stack.md`, `docs/gegl.md`, +`docs/roadmap.md`, `docs/open-questions.md`. When docs disagree, the detail +docs are authoritative and `PLAN.md` gets updated. + +## Task workflow + +Tasks are scoped to this git project via `~/go/bin/ask`. Use only its +subcommands (`list`, `ready`, `add`, `info`, `start`, `done`, `annotate`, +`modify`, `dep`, ...). When a task passes tests + sub-agent review, commit and +push to `origin main`, then mark `ask done ` and progress to the next ready +task. \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..dbc0e12 --- /dev/null +++ b/README.md @@ -0,0 +1,105 @@ +# ggaze — GNOME Gaze + +A small, fast, native image viewer for Fedora Linux, written in C with GTK4. +Its job: **quickly preview a folder of pictures downloaded from a camera, +cull the rejects, move on.** Think `feh` / `nsxiv` / `qiv`, but GNOME-native +and KISS — no library, no database, no sidecars. The layout nods to gthumb +(header bar, thumbnail grid, full-window viewer) without the weight. + +> **Status:** planning → skeleton. The design is complete in `docs/`; the +> implementation is just starting. Not usable yet. + +## Quick start + +``` +ggaze ~/Downloads/Camera/IMG_0001.jpg +``` + +Opens the folder as a thumbnail grid, `Enter` drops into the large view, and +you flip through the shoot: + +| Key | Action | +|-----|--------| +| `h` / `l`, `←`/`→` | previous / next image | +| `Enter` / `Esc` | grid ↔ large view (`t` toggles) | +| `+` / `-` | zoom in / out (large) · grow / shrink thumbnails (grid) | +| `0` | zoom fit ↔ 100% (large) · reset thumbnail size (grid) | +| `i` | info overlay (EXIF) | +| `v` / `V` / `Ctrl+a` | mark / range-mark / mark all | +| `d` / `D` | trash to `./Trash` (undoable) / delete permanently | +| `u` | undo last `d` or `m` | +| `m` | move marks → destination popup (`1`, `2`, …) | +| `e` | open in external program popup | +| `!` | run a shell script popup | +| `a` | quick GEGL enhance popup (optional) | +| `c` / `R` / `[` / `]` | crop / straighten / rotate 90° (GEGL, optional) | +| `s` | save an enhanced/edited copy (original is never modified) | +| `Space` (hold) | compare original vs modified | +| `f` / `S` | fullscreen / slideshow | +| `o` | open file/folder dialog | +| `,` | preferences | +| `?` | shortcuts overlay | +| `q` | quit | + +Full keybindings and mouse/touch gestures: `docs/ui-and-interactions.md`. + +## Build + +```sh +meson setup build +ninja -C build +meson test -C build # all tests +meson test -C build --suite unit +meson test -C build --suite integration +``` + +A minimal build (GdkPixbuf-only, no GEGL) is valid and fast: + +```sh +meson setup build -Dgegl=disabled -Djxl=disabled -Davif=disabled -Dheif=disabled +``` + +Enable optional backends with the matching feature option (`auto` by default): + +```sh +meson setup build -Dgegl=enabled +``` + +Coverage (plain-C modules, ≥80% target): + +```sh +meson setup -Db_coverage=true build-cov +ninja -C build-cov +meson test -C build-cov +ninja -C build-cov coverage # needs lcov + genhtml +``` + +## Dependencies (Fedora) + +``` +meson ninja-build gcc pkgconf-pkg-config +gtk4-devel glib2-devel libadwaita-devel +# optional: +gegl-devel babl-devel libjxl-devel libavif-devel libheif-devel +``` + +## Documentation + +The full design lives in `docs/`: + +- [`docs/PLAN.md`](docs/PLAN.md) — living tracker + decisions log +- [`docs/IMPLEMENTATION.md`](docs/IMPLEMENTATION.md) — execution plan (this repo's roadmap in practice) +- [`docs/goals-and-scope.md`](docs/goals-and-scope.md) — what ggaze is and is not +- [`docs/architecture.md`](docs/architecture.md) — modules + data flow +- [`docs/ui-and-interactions.md`](docs/ui-and-interactions.md) — views, keybindings, gestures +- [`docs/tech-stack.md`](docs/tech-stack.md) — libraries, decode backends, settings keys +- [`docs/coding-conventions.md`](docs/coding-conventions.md) — C style +- [`docs/gegl.md`](docs/gegl.md) — optional GEGL enhance plan +- [`docs/roadmap.md`](docs/roadmap.md) — milestones +- [`docs/open-questions.md`](docs/open-questions.md) — undecided items + +Contributing and agent workflow: see `AGENTS.md`. + +## License + +GPL-3.0-or-later. See [`LICENSE`](LICENSE). \ No newline at end of file diff --git a/data/.gitkeep b/data/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/ggaze-config.h.in b/ggaze-config.h.in new file mode 100644 index 0000000..c72677a --- /dev/null +++ b/ggaze-config.h.in @@ -0,0 +1,15 @@ +#ifndef GGAZE_CONFIG_H +#define GGAZE_CONFIG_H + +/* Generated by meson from ggaze-config.h.in — do not edit the build copy. */ + +#define GGAZE_VERSION @GGAZE_VERSION@ +#define GGAZE_APP_ID @GGAZE_APP_ID@ + +/* Optional backends (1 = compiled in, 0 = absent). */ +#define GGAZE_HAVE_GEGL @GGAZE_HAVE_GEGL@ +#define GGAZE_HAVE_JXL @GGAZE_HAVE_JXL@ +#define GGAZE_HAVE_AVIF @GGAZE_HAVE_AVIF@ +#define GGAZE_HAVE_HEIF @GGAZE_HAVE_HEIF@ + +#endif /* GGAZE_CONFIG_H */ \ No newline at end of file diff --git a/meson.build b/meson.build new file mode 100644 index 0000000..4c67730 --- /dev/null +++ b/meson.build @@ -0,0 +1,51 @@ +# ggaze — GNOME Gaze +# +# A small, fast, native image viewer for Fedora Linux, written in C with +# GTK4. Full design lives in docs/; this file is the build root. Phase 0 +# establishes the build/test/CI/convention harness — no production sources +# yet (they arrive from M0; see docs/roadmap.md). + +project('ggaze', 'c', + version : '0.1.0', + license : 'GPL-3.0-or-later', + meson_version : '>= 1.1', + default_options : [ + 'warning_level=2', # -Wall -Wextra + 'c_std=c11', + 'b_pie=true', + ], +) + +# --- Always-required dependencies (the core viewer needs all of these) --- +gtk4_dep = dependency('gtk4') +glib_dep = dependency('glib-2.0') +gio_dep = dependency('gio-2.0') +adwaita_dep = dependency('libadwaita-1') + +# --- Optional backends (feature: auto/disabled/enabled). See meson_options.txt. +gegl_dep = dependency('gegl-0.4', required : get_option('gegl')) +jxl_dep = dependency('libjxl', required : get_option('jxl')) +avif_dep = dependency('libavif', required : get_option('avif')) +heif_dep = dependency('libheif', required : get_option('heif')) + +# --- Generated config header (app id, version, feature flags) --- +conf = configuration_data() +conf.set_quoted('GGAZE_VERSION', meson.project_version()) +conf.set_quoted('GGAZE_APP_ID', 'org.buetow.ggaze') +conf.set('GGAZE_HAVE_GEGL', gegl_dep.found() ? 1 : 0) +conf.set('GGAZE_HAVE_JXL', jxl_dep.found() ? 1 : 0) +conf.set('GGAZE_HAVE_AVIF', avif_dep.found() ? 1 : 0) +conf.set('GGAZE_HAVE_HEIF', heif_dep.found() ? 1 : 0) + +ggaze_conf_h = configure_file( + input : 'ggaze-config.h.in', + output : 'ggaze-config.h', + configuration : conf, +) + +# Include path: source root (generated header lands in the build root, which +# meson adds automatically for targets that list ggaze_conf_h as a source). +inc = include_directories('.') + +subdir('src') +subdir('tests') \ No newline at end of file diff --git a/meson_options.txt b/meson_options.txt new file mode 100644 index 0000000..153a3e3 --- /dev/null +++ b/meson_options.txt @@ -0,0 +1,21 @@ +# ggaze meson options. See docs/tech-stack.md and docs/IMPLEMENTATION.md. +# +# Optional loader / image-processing backends. Each is a meson `feature`: +# auto detect if installed, build if found (default; minimal CI lane +# forces disabled) +# disabled skip +# enabled require, fail if missing +# +# The core culling viewer never needs these; a GdkPixbuf-only build is valid. + +option('gegl', type : 'feature', value : 'auto', + description : 'GEGL quick-enhance, crop/straighten/rotate, ICC color mgmt') + +option('jxl', type : 'feature', value : 'auto', + description : 'JPEG XL loader backend (libjxl)') + +option('avif', type : 'feature', value : 'auto', + description : 'AVIF loader backend (libavif)') + +option('heif', type : 'feature', value : 'auto', + description : 'HEIF/HEIC loader backend (libheif)') \ No newline at end of file diff --git a/po/.gitkeep b/po/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/po/LINGUAS b/po/LINGUAS new file mode 100644 index 0000000..e69de29 diff --git a/src/meson.build b/src/meson.build new file mode 100644 index 0000000..a46993e --- /dev/null +++ b/src/meson.build @@ -0,0 +1,3 @@ +# ggaze production sources. Populated from M0 onward (see docs/roadmap.md and +# docs/architecture.md for the module map). Phase 0 ships no sources yet — +# only the build/test/CI/convention harness, so `ninja` has no C targets here. \ No newline at end of file diff --git a/tests/fixtures/.gitkeep b/tests/fixtures/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tests/helpers/.gitkeep b/tests/helpers/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tests/integration/meson.build b/tests/integration/meson.build new file mode 100644 index 0000000..5d540a0 --- /dev/null +++ b/tests/integration/meson.build @@ -0,0 +1,3 @@ +# Integration tests (cross-module flows, real temp dirs, offscreen GTK). +# Empty in Phase 0 — suites land with the milestones that first make each +# flow possible; see docs/IMPLEMENTATION.md "Planned integration suites". \ No newline at end of file diff --git a/tests/meson.build b/tests/meson.build new file mode 100644 index 0000000..c0ec9fb --- /dev/null +++ b/tests/meson.build @@ -0,0 +1,22 @@ +# ggaze tests — two tracks (see docs/IMPLEMENTATION.md "Two test tracks"). +# +# unit plain-C module tests, no display needed (>=80% coverage gate, +# warn until M10 then fail). +# integration cross-module flows with real temp dirs + offscreen GTK. +# +# Run one track: meson test -C build --suite unit +# meson test -C build --suite integration +# Coverage: meson setup -Db_coverage=true build +# meson test -C build +# ninja -C build coverage (needs lcov + genhtml) + +test_bootstrap = executable( + 'test_bootstrap', + ['test_bootstrap.c', ggaze_conf_h], + include_directories : inc, + dependencies : [glib_dep], + install : false, +) +test('bootstrap', test_bootstrap, suite : 'unit') + +subdir('integration') \ No newline at end of file diff --git a/tests/test_bootstrap.c b/tests/test_bootstrap.c new file mode 100644 index 0000000..fea0443 --- /dev/null +++ b/tests/test_bootstrap.c @@ -0,0 +1,49 @@ +/*:* + * ggaze — bootstrap sanity test + * + * Confirms the build/test harness is wired: g_test_init runs, and the + * generated ggaze-config.h exposes the app id and version. No display, + * no GTK — this is the smallest proof that the unit-test track compiles + * and executes under `meson test --suite unit`. + * + * Copyright (c) 2026 ggaze contributors + * SPDX-License-Identifier: GPL-3.0-or-later + *:*/ + +#include "ggaze-config.h" + +#include +#include + +static void +test_app_id(void) { + g_assert_cmpstr(GGAZE_APP_ID, ==, "org.buetow.ggaze"); +} + +static void +test_version(void) { + g_assert_cmpstr(GGAZE_VERSION, !=, NULL); + g_assert_cmpint((int)strlen(GGAZE_VERSION), >, 0); +} + +static void +test_feature_flags_are_binary(void) { + /* Feature flags must be 0 or 1, never undefined (compile-time guard). */ + g_assert_cmpint(GGAZE_HAVE_GEGL, >=, 0); + g_assert_cmpint(GGAZE_HAVE_GEGL, <=, 1); + g_assert_cmpint(GGAZE_HAVE_JXL, >=, 0); + g_assert_cmpint(GGAZE_HAVE_JXL, <=, 1); + g_assert_cmpint(GGAZE_HAVE_AVIF, >=, 0); + g_assert_cmpint(GGAZE_HAVE_AVIF, <=, 1); + g_assert_cmpint(GGAZE_HAVE_HEIF, >=, 0); + g_assert_cmpint(GGAZE_HAVE_HEIF, <=, 1); +} + +int +main(int i_argc, char **c_argv) { + g_test_init(&i_argc, &c_argv, NULL); + g_test_add_func("/bootstrap/app_id", test_app_id); + g_test_add_func("/bootstrap/version", test_version); + g_test_add_func("/bootstrap/feature_flags", test_feature_flags_are_binary); + return (g_test_run()); +} \ No newline at end of file -- cgit v1.2.3