Initial checkin of Pika from heckimp

This commit is contained in:
Cassowary 2023-09-25 15:35:21 -07:00
commit 891e999216
6761 changed files with 5240685 additions and 0 deletions

46
.clang-format Normal file
View File

@ -0,0 +1,46 @@
# For more information, see:
#
# https://clang.llvm.org/docs/ClangFormat.html
# https://clang.llvm.org/docs/ClangFormatStyleOptions.html
#
---
BasedOnStyle: GNU
AlignAfterOpenBracket: Align
AlignArrayOfStructures: Left
AlignConsecutiveAssignments: Consecutive
AlignConsecutiveDeclarations: Consecutive
AlignConsecutiveMacros: Consecutive
AlignEscapedNewlines: Left
AllowAllParametersOfDeclarationOnNextLine: false
AlwaysBreakAfterReturnType: AllDefinitions
BinPackParameters: false
BreakBeforeBraces: GNU
IndentWidth: 2
PointerAlignment: Right
UseTab: Never
SpaceBeforeParens: Always
SpaceAfterLogicalNot: true
SpaceAfterCStyleCast: true
# Our column limit is more around 80 characters but we want to avoid
# this rule to be over-agressive. So for clang-format, let's use a
# higher limit. Then let's put some biggish penalties on breaking on
# assignment, or parentheses, or other similar cases. Actually with such
# limits, if clang-format really ends up re-formatting, there might be
# something better to do code-wise (i.e. we might be in an akwardly
# over-nested block case).
ColumnLimit: 80
PenaltyBreakAssignment: 60
PenaltyBreakBeforeFirstCallParameter: 100
PenaltyBreakString: 60
# Uncomment this when we start using clang-format 14 in the CI.
# PenaltyBreakOpenParenthesis: 40
PenaltyExcessCharacter: 1
# Strings are more often longer by usage, so let's give these slightly
# more space to breath.
PenaltyBreakString: 60
PenaltyReturnTypeOnItsOwnLine: 50

4
.dir-locals.el Normal file
View File

@ -0,0 +1,4 @@
((c-mode . ((c-file-style . "GNU")
(c-basic-offset . 2)
(indent-tabs-mode . nil)
(show-trailing-whitespace . t))))

6
.gitignore vendored Normal file
View File

@ -0,0 +1,6 @@
# Meson
/_build
/compile_commands.json
# Atom editor
/.vscode

1096
.gitlab-ci.yml Normal file

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,32 @@
#!/usr/bin/python3
# Equivalent to:
# configure_file(input: src,
# output: name / src,
# copy: true,
# install_dir: pikaplugindir / 'plug-ins' / name,
# install_mode: 'rwxr-xr-x')
# Except that configure_file() does not accept output in a subdirectory. So we
# use this wrapper for now.
# See: https://github.com/mesonbuild/meson/issues/2320
import os
import shutil
import stat
import sys
src_file = sys.argv[1]
dir_name = sys.argv[2]
dummy_path = None
if len(sys.argv) > 3:
dummy_path = sys.argv[3]
os.makedirs(dir_name, exist_ok=True)
file_name = os.path.basename(src_file)
dst_file = os.path.join(dir_name, file_name)
shutil.copyfile(src_file, dst_file)
os.chmod(dst_file, stat.S_IRWXU | stat.S_IRGRP | stat.S_IXGRP | stat.S_IROTH | stat.S_IXOTH)
if dummy_path is not None:
# Just touch the dummy file.
open(dummy_path, mode='w').close()

View File

@ -0,0 +1,41 @@
<!-- ⚠️ IMPORTANT: READ ME! ⚠️
This is the default template for bug reports.
For feature requests or performance issues, please switch instead to the appropriate template in the "Choose a template" list.
It is important that you fill all the fields of the template.
-->
### Environment/Versions
- PIKA version:
- Package: <!--[flatpak? Installer from https://heckin.technology/AlderconeStudio/PIKApp? If another installer, tell us where from] (write it after the > symbol)-->
- Operating System: <!--[Windows? macOS? Linux? All?] (write it after the > symbol) -->
<!--Note: bug reporters are expected to have verified the bug still exists
either in the last stable version of PIKA or on updated development code
(master branch).-->
### Description of the bug
<!--Please describe your issue with details.
Add screenshot or other files if needed.(write it after the > symbol)-->
### Reproduction
Is the bug reproducible? <!--[Always / Randomly / Happened only once ] (write it after the > symbol)-->
Reproduction steps:
1.
2.
3.
Expected result:
Actual result:
### Additional information
If you have a backtrace for a crash or a warning, paste it here.

View File

@ -0,0 +1,15 @@
**Operating System:** <!--[Windows? macOS? Linux? All?] (write it after the > symbol) -->
### Description of the feature
<!-- Please describe your feature with details.
Add screenshots, design images or other files which would help for
understanding the feature or for implementation.
Also add links when needed, for instance for implementation standards
or other relevant resources.-->
### Use cases
<!-- If not obvious, explain the use cases or problems to solve. -->

View File

@ -0,0 +1,34 @@
### Environment/Versions
- PIKA Version:
- Package: <!--[flatpak? Installer from https://heckin.technology/AlderconeStudio/PIKApp? If another installer, tell us where from] (write it after the > symbol)-->
- Operating System: <!--[Windows? macOS? Linux? All?] (write it after the > symbol) -->
<!-- Note: bug reporters are expected to have verified the bug still exists
either in the last stable version of PIKA or on updated development code
(master branch). -->
### Issue Description
<!-- Please provide a general description of the issue. -->
### Performance Log
<!-- Please record a performance log demonstrating the issue, and attach it to the report.
For more information, see
https://developer.pika.org/core/debug/performance-logs/
-->
### Performance Log Description
<!-- Please describe in detail the actions performed in the performance log.
If you added empty event markers to the log, please provide a description for them here.
If you recorded a screencast while recording the log, please attach it here. -->
### Additional Information
<!-- If there is any additional information, please provide it here. -->
/label ~"1. Performance"

View File

@ -0,0 +1,15 @@
Contribution guidelines:
- Follow our coding style, which is mostly the GNU coding style
with some specificities: see [Coding Style](https://developer.pika.org/core/coding_style/).
- Make sure no trailing spaces or tabs are left out.
- Check the following option when making your request:
"*Allow commits from members who can merge to the target branch.*"
- Enable the container registry for your repository by following this
documentation, but enabling the feature instead of disabling it
(unlike what the docs says, Container Registry is disabled by default
on our Gitlab instance):
https://docs.gitlab.com/ee/user/packages/container_registry/#disable-the-container-registry-for-a-project

View File

@ -0,0 +1,30 @@
#!/bin/bash
set -e
ancestor_horizon=28 # days (4 weeks)
echo ""
echo "This script may be wrong. You may disregard it if it conflicts with"
echo "https://gitlab.gnome.org/GNOME/pika/-/blob/master/CODING_STYLE.md"
clang-format --version
# Wrap everything in a subshell so we can propagate the exit status.
(
source .gitlab/search-common-ancestor.sh
git diff -U0 --no-color "${newest_common_ancestor_sha}" | clang-format-diff -p1 > format-diff.log
)
exit_status=$?
[ ${exit_status} == 0 ] || exit ${exit_status}
format_diff="$(<format-diff.log)"
if [ -n "${format_diff}" ]; then
cat format-diff.log
exit 1
fi

View File

@ -0,0 +1,39 @@
#!/bin/bash
set -e
ancestor_horizon=28 # days (4 weeks)
# We need to add a new remote for the upstream target branch, since this script
# could be running in a personal fork of the repository which has out of date
# branches.
#
# Limit the fetch to a certain date horizon to limit the amount of data we get.
# If the branch was forked from origin/main before this horizon, it should
# probably be rebased.
if ! git ls-remote --exit-code upstream >/dev/null 2>&1 ; then
git remote add upstream https://gitlab.gnome.org/GNOME/pika.git
fi
git fetch --shallow-since="$(date --date="${ancestor_horizon} days ago" +%Y-%m-%d)" upstream &> ./fetch_upstream.log
# Work out the newest common ancestor between the detached HEAD that this CI job
# has checked out, and the upstream target branch (which will typically be
# `upstream/main` or `upstream/glib-2-62`).
# `${CI_MERGE_REQUEST_TARGET_BRANCH_NAME}` or `${CI_MERGE_REQUEST_SOURCE_BRANCH_NAME}`
# are only defined if were running in a merge request pipeline,
# fall back to `${CI_DEFAULT_BRANCH}` or `${CI_COMMIT_BRANCH}` respectively
# otherwise.
# add mr-origin
git remote add mr-origin ${CI_MERGE_REQUEST_SOURCE_PROJECT_URL}
source_branch="${CI_MERGE_REQUEST_SOURCE_BRANCH_NAME:-${CI_COMMIT_BRANCH}}"
git fetch --shallow-since="$(date --date="${ancestor_horizon} days ago" +%Y-%m-%d)" mr-origin "${source_branch}" &> ./fetch_origin.log
newest_common_ancestor_sha=$(diff --old-line-format='' --new-line-format='' <(git rev-list --first-parent "upstream/${CI_MERGE_REQUEST_TARGET_BRANCH_NAME:-${CI_DEFAULT_BRANCH}}") <(git rev-list --first-parent "mr-origin/${source_branch}") | head -1)
if [ -z "${newest_common_ancestor_sha}" ]; then
echo "Couldnt find common ancestor with upstream main branch. This typically"
echo "happens if you branched from main a long time ago. Please update"
echo "your clone, rebase, and re-push your branch."
exit 1
fi

4
.kateconfig Normal file
View File

@ -0,0 +1,4 @@
kate: indent-mode cstyle;
kate: indent-width 2; tab-width 8;
kate: tab-indents off; replace-tabs on;
kate: remove-trailing-spaces modified;

397
AUTHORS Normal file
View File

@ -0,0 +1,397 @@
-- This file is generated from authors.xml, do not edit it directly. --
PIKA was originally written by:
Spencer Kimball
Peter Mattis
The current maintainers are:
Michael Natterer
Jehan
The following people have contributed code to PIKA:
Lauri Alanko
Fredrik Alströmer
Shawn Amundson
Sven Anders
Henrik Brix Andersen
Karl-Johan Andersson
Rob Antonishen
Nicola Archibald
Timm Bäder
Luis Barrancos
Jerry Baker
John Beale
Zach Beane
Tom Bech
Daniel P. Berrange
Marc Bless
Edward Blevins
Reagan Blundell
Jacob Boerema
Hendrik Boom
Xavier Bouchoux
Richard Bowers
Roberto Boyd
Stanislav Brabec
Hans Breuer
Simon Budig
João S. O. Bueno
Seth Burgess
Brent Burton
Francisco Bustamante
Albert Cahalan
George J. Carrette
Marco Ciampa
Sean Cier
Winston Chang
Stephane Chauveau
Zbigniew Chyla
Lars-Peter Clausen
Sven Claussner
Branko Collin
Ed Connel
Piers Cornwell
David Costanzo
Daniel Cotting
Jay Cox
Kevin Cozens
Jeremiah Darais
Michael Deal
Alexia Death
Brian Degenhardt
Karine Delvare
Andreas Dilger
Nicholas Doyle
Austin Donnelly
Scott Draves
Daniel Dunbar
Marek Dvoroznak
Misha Dynin
Daniel Eddeland
Daniel Egger
Ulf-D. Ehlert
Gil Eliyahu
Tobias Ellinghaus
Ell
Morton Eriksen
Larry Ewing
Dirk Farin
Pedro Alonso Ferrer
Nick Fetchak
Piotr Filiciak
Shlomi Fish
Sylvain Foret
David Forsyth
Raphael Francois
Gerald Friedland
Jochen Friedrich
Daniel Richard G
Jordi Gay
Jim Geuther
GG
Graeme Gill
Pedro Gimeno
Richard Gitschlag
Scott Goehring
Heiko Goller
Marcelo de Gomensoro Malheiros
Saul Goode
David Gowers
Niels De Graef
Cameron Gregory
Stanislav Grinkov
Eric Grivel
Stephen Griffiths
Pavel Grinfeld
Dov Grobgeld
Michael Hammel
Julien Hardelin
Tim Harder
Marcus Heese
Robert Helgesson
Michael Henning
James Henstridge
Eric Hernes
Lukasz Hladowski
David Hodson
Christoph Hoegl
Wolfgang Hofer
Éric Hoffman
Patrick Horgan
Alan Horkan
Daniel Hornung
Christopher Howard
Jan Hubička
Alexander Hämmerle
HJ Imbens
Barak Itkin
Ben Jackson
Tim Janik
Kristian Jantz
Javier Jardón
Tim Jedlicka
Róman Joost
Alexander Jones
Geert Jordaens
Aurimas Juška
Povilas Kanapickas
Malay Keshav
Andrew Kieschnick
Peter Kirchgessner
Philipp Klaus
David Koblas
Daniel Kobras
Øyvind Kolås
Lloyd Konneker
Robert L Krawitz
Kretynofil
Christian Krippendorf
Hartmut Kuhse
Tuomas Kuosmanen
Olof S Kylander
Philip Lafleur
Chris Lahey
Eric Lamarque
Nick Lamb
Marco Lamberto
Jens Lautenbacher
Laramie Leavitt
Roman Lebedev
Tom Lechner
Elliot Lee
Marc Lehmann
Simone Karin Lehmann
Ray Lehtiniemi
Tobias Lenz
Frederic Leroy
Raph Levien
Wing Tung Leung
Dave Lichterman
Adrian Likins
lillolollo
Tor Lillqvist
Ingo Lütkebohle
Nikc M.
Josh MacDonald
Ed Mackey
Vidar Madsen
Mikael Magnusson
Luidnel Maignan
Ian Main
Thomas Manni
Kjartan Maraas
John Marshall
Kelly Martin
Torsten Martinsen
Pascal Massimino
Johannes Matschke
Takeshi Matsuyama
Gordon Matzigkeit
Téo Mazars
Robert McHardy
Gregory McLean
Richard McLean
Jörn Meier
Mike Melancon
Federico Mena Quintero
Loren Merritt
Jim Meyer
James Mitchell
Hirotsuna Mizuno
Chris Mohler
Chris Moller
David Monniaux
Christopher Montgomery
Tim Mooney
Adam D Moss
Simon Müller
Tobias Mueller
Michael Muré
Lionel N.
Balazs Nagy
Yukihiro Nakai
Shuji Narazaki
Felix Natter
David Neary
David Necas
Sven Neumann
Andreas Neustifter
Tim Newsome
Jon Nordby
Martin Nordholts
Stephen Robert Norris
Daniel Novomeský
Erik Nygren
Miles O'Neal
Lukas Oberhuber
David Odin
Nelson A. de Oliveira
Victor Oliveira
Yoshio Ono
Thom van Os
Garry R. Osgood
Nathan Osman
Benjamin Otte
Petr Ovtchenkov
Alan Paeth
Jay Painter
Juan Palacios
Ville Pätsi
Akkana Peck
Asbjorn Pettersen
Félix Piédallu
Mike Phillips
Nils Philippsen
Ari Pollak
Mircea Purdea
Liam Quin
Raphaël Quinet
John Ralls
Dennis Ranke
Tom Rathborne
Debarshi Ray
Martin Renold
Jens Restemeier
Kristian Rietveld
Maurits Rijk
Daniel Risacher
Clarence Risher
Gilles Rochefort
James Robinson
Stefan Röllin
Guillermo S. Romero
Marco Rossini
Tim Rowley
Karthikeyan S
Daniel Sabo
Oleksii Samorukov
Mike Schaeffer
John Schlag
Norbert Schmitz
Thorsten Schnier
Enrico Schröder
Alexander Schulz
Michael Schumacher
Tracy Scott
Craig Setera
Elad Shahar
shark0r
Peter Sikking
RyōTa SimaMoto
Ted Shaneyfelt
Aaron Sherman
SHIRAKAWA Akira
Jernej Simončič
Manish Singh
Mukund Sivaraman
William Skaggs
Daniel Skarda
Ville Sokk
Kevin Sookocheff
Adam Spiers
Jakub Steiner
Omari Stephens
Tobias Stoeckmann
Elle Stone
Nathan Summers
Mike Sweet
Bogdan Szczurek
Eiichi Takamori
Tal Trachtman
Tristan Tarrant
Michael Taylor
Owen Taylor
Ian Tester
Andy Thomas
Mason Thomas
Benoit Touchette
Patrice Tremblay
Kevin Turner
Andreas Turtschan
Massimo Valentini
Brion Vibber
Helvetix Victorinox
Thorsten Vollmer
Clayton Walker
Rebecca Walter
Martin Weber
Rupert Weber
James Wang
Kris Wehner
Nigel Wetten
Alexis Wilhelm
Calvin Williamson
Matthew Wilson
woob
Karl Günter Wünsch
Andrew Wyatt
Yoshinori Yamakawa
Shirasaki Yasuhiro
Mihail Zenkov
Zhenfeng Zhao
Simon Zilliken
Przemyslaw Zych
Robert Ögren
The following people have contributed art to PIKA:
Lapo Calamandrei
Paul Davey
Patrick David
Alexia Death
Aurore Derriennic
Philipp Haegi
Aryeom Han
Tuomas Kuosmanen
Karl La Rocca
Andreas Nilsson
Ville Pätsi
Mike Schaeffer
Carol Spears
Klaus Staedtler
Jakub Steiner
William Szilveszter
The following people have helped to document PIKA:
Ignacio AntI
Žygimantas Beručka
Jacob Boerema
Carey Bunks
Marco Ciampa
Sven Claussner
Patrick David
Dust
Ulf-D. Ehlert
Alessandro Falappa
Jakub Friedl
Niels De Graef
Michael Hammel
Julien Hardelin
Simon Janes
Róman Joost
Hans de Jonge
Lloyd Konneker
Semka Kuloviæ-Debals
Karin Kylander
Olof S Kylander
Jean-Pierre Litzler
Vitaly Lomov
Ed Mackey
Ian Main
Akkana Peck
Pierre Perrier
Alexandre Prokoudine
Manuel Quiñones
James Robinson
Nickolay V. Shmyrev
Patrycja Stawiarska
Kolbjørn Stuestøl
Axel Wernicke

674
COPYING Normal file
View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
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.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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 <https://www.gnu.org/licenses/>.
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:
<program> Copyright (C) <year> <name of author>
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
<https://www.gnu.org/licenses/>.
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
<https://www.gnu.org/philosophy/why-not-lgpl.html>.

3329
ChangeLog.pre-1-0 Normal file

File diff suppressed because it is too large Load Diff

28795
ChangeLog.pre-1-2 Normal file

File diff suppressed because it is too large Load Diff

61186
ChangeLog.pre-2-0 Normal file

File diff suppressed because it is too large Load Diff

21166
ChangeLog.pre-2-2 Normal file

File diff suppressed because it is too large Load Diff

42277
ChangeLog.pre-2-4 Normal file

File diff suppressed because it is too large Load Diff

16113
ChangeLog.pre-2-6 Normal file

File diff suppressed because it is too large Load Diff

5959
ChangeLog.pre-git Normal file

File diff suppressed because it is too large Load Diff

488
INSTALL.in Normal file
View File

@ -0,0 +1,488 @@
---------------------------------------
Installation instructions for PIKA @PIKA_APP_VERSION@
---------------------------------------
There are some basic steps to building and installing PIKA.
PIKA @PIKA_APP_VERSION@ replaces earlier PIKA 2.99.x versions. It is advised to
uninstall them before installing PIKA @PIKA_APP_VERSION@. Since libpika* libraries
and data are all versionned anyway, it is possible to keep your older
PIKA 2.x installation in parallel to PIKA @PIKA_APP_VERSION@ on a same prefix.
PIKA @PIKA_APP_VERSION@ is not backward compatible with PIKA 2.10 and earlier
versions. Plug-ins and scripts written for PIKA 2.10, 2.8, 2.6 or
earlier PIKA 2.x versions will not work because the API changed.
The most important part is to make sure the requirements for a build
are fulfilled. We depend on a number of tools and libraries which are
listed below. For libraries this means you need to also have the
header files installed.
This file is generated (versions are filled by our build system) and
focuses on keeping an up-to-date list of dependencies intended to
packagers, contributors or whoever wants to compile PIKA from source.
Building and running self-built software often requires more setup, in
particular environment variables so that your system knows where to
find the various pieces of the software. The following document can
help in that regard:
https://developer.pika.org/core/setup/build/
******************************************************************
* Unless you are experienced with building software from source, *
* you should not attempt to build all these libraries yourself! *
* We suggest that you check if your distributor has development *
* packages of them and use these instead. *
******************************************************************
1. You need to have installed a recent version of pkg-config (>= @PIKA_PKGCONFIG_VERSION@) available
from https://www.freedesktop.org/software/pkgconfig/.
The compatible pkgconf utility would also work.
2. You need gettext version 0.19.8 or newer. Older versions did not have support yet
for certain file formats.
3. You need to have GEGL version @GEGL_REQUIRED_VERSION@ or newer and babl version
@BABL_REQUIRED_VERSION@ or newer. You can get them from https://gegl.org/ or clone
them from the GNOME git repository:
https://gitlab.gnome.org/GNOME/babl.git
https://gitlab.gnome.org/GNOME/gegl.git
GEGL must be built with Cairo support, i.e. -Dcairo=enabled option (required
for some mandatory operations such as "gegl:npd").
Introspection must be enabled for both babl and GEGL with -Denable-gir=true
and -Dintrospection=true respectively. The only case where we don't build
GIR data is when cross-compiling because of the difficulty to make cross-tools
for GObject Introspection.
Nevertheless if you have working GIR cross-tools, you can force the expected
behavior with PIKA's meson option -Dcan-crosscompile-gir=true
Optional:
- build GEGL with libumfpack (SuiteSparse) (`-Dumfpack=enabled`)
for alternative Matting engine "gegl:matting-levin" and OpenEXR
library (`-Dopenexr=enabled`) for OpenEXR format support.
- build GEGL with maxflow (https://github.com/gerddie/maxflow) and
the option -Dworkshop=true in order to be able to select the
experimental Paint Select tool in the Playground (operation
"gegl:paint-select" is needed).
- The "Show Image Graph" item in the "Debug" menu (hidden by
default on stable release) requires the GEGL operation
"gegl:introspect" which is always built but deactivated unless
the `dot` tool from graphviz is available (runtime dependency).
4. You need to have installed GTK version @GTK_REQUIRED_VERSION@ or newer.
PIKA also needs a recent version of GLib (>= @GLIB_REQUIRED_VERSION@), GDK-Pixbuf
(>= @GDK_PIXBUF_REQUIRED_VERSION@), and Pango (>= @PANGO_REQUIRED_VERSION@). Sources for these can be grabbed
from https://download.gnome.org/sources/.
5. We use cairo >= @CAIRO_REQUIRED_VERSION@, which is hosted at
https://www.cairographics.org/.
6. We require PangoCairo, a Pango backend using Cairo. Make sure you
have Cairo, FreeType2 and fontconfig installed before you compile
Pango. PIKA depends on freetype2 being newer than version @FREETYPE2_REQUIRED_VERSION@
and fontconfig @FONTCONFIG_REQUIRED_VERSION@ or newer. Older versions are known to have
bugs that seriously affect the stability of PIKA.
On Windows, we recommend fontconfig 2.13.95 (or over) where support
of fonts in user directory (Windows 1809 feature) appeared.
We also require HarfBuzz @HARFBUZZ_REQUIRED_VERSION@ or newer, an OpenType text shaping
tool. As this is a dependency for Pango, you will likely have it
installed, but you may have to install a development package for
the headers.
7. The file-compressor plug-in requires zlib, libbzip2, and liblzma to
be installed. All these libraries are required dependencies.
8. For metadata access PIKA requires the gexiv2 @GEXIV2_REQUIRED_VERSION@ or newer library.
It is hosted at: https://wiki.gnome.org/Projects/gexiv2
9. libpng, libjpeg, libtiff, librsvg and lcms are hard dependencies
that can not be disabled.
There might be some issues with librsvg, based on the fact newer
versions are in Rust which is not buildable on all platforms. Yet
SVG support was deemed too important to be considered "optional"
for a decent graphics activity. Nevertheless a packager really
intent to have PIKA running on an architecture with no Rust support
could still:
1) easily patch out the file-svg plug-in from build system;
2) build PIKA with -Dvector-icons=false. Ironically librsvg is
needed at build time for this option, in order to create PNG
variants of icons (making librsvg unneeded at runtime). So all it
takes is to have a build machine with librsvg to create the PNG
icons, package and deliver them for machines without librsvg.
This is the compromise we came with, i.e. officially making SVG a
first-class file format, yet explaining how you could ignore it if
you really wanted or needed to.
10. For MyPaint brushes, brushlib (libmypaint) @LIBMYPAINT_REQUIRED_VERSION@ is used.
The libmypaint repository is hosted at:
https://github.com/mypaint/libmypaint
If installing from repository, do not install the master branch!
Checkout the last tag "v1.y.z" from `libmypaint-v1` branch instead
(for instance "v1.6.1" tag at time of writing), or simply install
from a tarball or from your favorite package manager.
In particular, do NOT install tags or release tarballs versioned
"v2.y.z". PIKA depends on the version 1 of libmypaint and is
incompatible with the version 2 (which is still experimental anyway
and has no stable release at time of writing).
11. We also need the mypaint-brushes data package:
https://github.com/mypaint/mypaint-brushes
If installing from repository, install from branch "v1.3.x" or the
last tag "v1.y.z" (e.g. "v1.3.1" at time of writing).
In particular do NOT install from `master` branch which installs
brushes incompatible with PIKA (the `master` branch and v2 brushes
are targeted to software using recent libmypaint which PIKA wasn't
ported to yet).
Also this is a data packages and therefore it will install the
pkg-config file inside `$PREFIX/share/pkgconfig/`. If you install
mypaint-brushes from repository in a non-standard prefix, you will
have to make sure your $PKG_CONFIG_PATH environment variable also
lists `$PREFIX/share/pkgconfig/`.
12. PIKA uses GLib's GIO library to handle file URIs and any I/O in
general, transparently, regardless where the file is stored, i.e.
locally, remotely, with which scheme, and so on. GIO in turn
supports various backends through modules. We don't know all the
modules available but since HTTP and HTTPS are so pervasive
nowadays, we kind of consider a least GIO modules for these schemes
mandatory (it allows to open from a pasted URL or just drag'n drop
from e.g. a browser).
For HTTP support (and many other schemes), on Linux at least, you
should install `gvfs`:
https://wiki.gnome.org/Projects/gvfs
It is unclear whether `gvfs` can be built and installed on other
platforms such as Windows and macOS.
For HTTPS support, you should install `glib-networking`:
https://gitlab.gnome.org/GNOME/glib-networking
Of course there might be more modules providing support of more
storage backends. Ideally PIKA would have support to load from any
backend so packaging together with more GIO modules or recommending
them in a package manager would be ideal. In any case, installing
the ones for HTTP and HTTPS seems like the minimum nowadays.
13. You may want to install other third party libraries or programs
that are needed for some of the available plug-ins. We recommend
to check that the following libraries are installed: openjpeg,
libmng, libwmf, libaa and libgs (Ghostscript).
14. HEIF support depends on the libheif library. If you don't have
access to pre-built packages, the code is available at:
https://github.com/strukturag/libheif
Make sure you build libheif with libde265 and libx265 support (for
respectively decoding and encoding of HEVC, i.e. HEIC files), and
libaom decoder and encoder (for AV1, i.e. AVIF files), otherwise
the plug-in is mostly useless.
15. GObject Introspection requires the following dependencies to be
built and installed with introspection as well: babl, cairo,
GdkPixbuf, GEGL, GIO, GLib, GObject and GTK.
16. Windows builds can now generate backtrace logs upon a crash.
The logs will be available in: %APPDATA%\PIKA\@PIKA_APP_VERSION@\CrashLog\
The feature depends on Dr.MinGW's ExcHndl library:
https://github.com/jrfonseca/drmingw
17. Configure PIKA by running `meson _build`. You may want to pass some
options to it, see below.
18. Build PIKA by running `ninja -C _build'.
19. Install PIKA by running `ninja -C _build install'. In order to
avoid clashes with other versions of PIKA, we install a binary
called pika-@PIKA_APP_VERSION@. By default there's also a link created so that
you can type 'pika' to start pika-@PIKA_APP_VERSION@.
20. Summary of required packages and what version you need:
Package Name Version
appstream-glib @APPSTREAM_GLIB_REQUIRED_VERSION@
ATK @ATK_REQUIRED_VERSION@
babl @BABL_REQUIRED_VERSION@
cairo @CAIRO_REQUIRED_VERSION@
Fontconfig @FONTCONFIG_REQUIRED_VERSION@
freetype2 @FREETYPE2_REQUIRED_VERSION@
GDK-PixBuf @GDK_PIXBUF_REQUIRED_VERSION@
GEGL @GEGL_REQUIRED_VERSION@
gexiv2 @GEXIV2_REQUIRED_VERSION@
GIO
GLib @GLIB_REQUIRED_VERSION@
glib-networking
GTK @GTK_REQUIRED_VERSION@
gvfs (on Linux)
HarfBuzz @HARFBUZZ_REQUIRED_VERSION@
libbzip2
libjpeg
liblzma @LIBLZMA_REQUIRED_VERSION@
libmypaint @LIBMYPAINT_REQUIRED_VERSION@
libpng @LIBPNG_REQUIRED_VERSION@
libpoppler-glib @POPPLER_REQUIRED_VERSION@
librsvg @RSVG_REQUIRED_VERSION@
libtiff @LIBTIFF_REQUIRED_VERSION@
Little CMS @LCMS_REQUIRED_VERSION@
mypaint-brushes-1.0
pangocairo @PANGO_REQUIRED_VERSION@
poppler-data @POPPLER_DATA_REQUIRED_VERSION@
zlib
21. Summary of optional packages:
Package Name Version Feature
cairo-pdf @CAIRO_PDF_REQUIRED_VERSION@ PDF export
cfitsio - FITS
ExcHndl - Crash logs on Windows with Dr. MinGW
gs - ghostscript
libaa - ASCII art
libheif @LIBHEIF_REQUIRED_VERSION@ HEIF
libilbm - Amiga IFF/ILBM
libmng - MNG
libwebp @WEBP_REQUIRED_VERSION@ WebP (built with --enable-libwebpmux and --enable-libwebpdemux)
libwmf @WMF_REQUIRED_VERSION@ WMF
libXcursor - X11 Mouse Cursor
libxpm - XPM
openexr @OPENEXR_REQUIRED_VERSION@ OpenEXR
OpenJPEG @OPENJPEG_REQUIRED_VERSION@ JPEG 2000
qoi - QOI
webkit @WEBKITGTK_REQUIRED_VERSION@ Help browser & webpage
vala - Vala plug-ins
22. Summary of optional runtime dependencies:
darktable >= 1.7, with lua support enabled for raw loading
RawTherapee >= 5.2 for raw loading
xdg-email for sending emails
sendmail for sending emails if --with-sendmail enabled
gdb or lldb for our new bug-reporting dialog
"gegl:matting-levin" GEGL operation for alternative matting engine
Python @PYTHON3_REQUIRED_VERSION@ and PyGObject for Python 3 plug-ins
GJS for Javascript plug-ins
LuaJIT and LGI for Lua plug-ins
dot for "Show Image Graph" (unstable branches)
xdg-desktop-portal implemented for your desktop for various D-Bus API (screenshot, color-picking…)
Generic instructions for configuring and compiling auto-configured
packages are included below. Here is an illustration of commands that
might be used to build and install PIKA. The actual configuration,
compilation and installation output is not shown.
% tar xvf pika-@PIKA_VERSION@.tar.xz # unpack the sources
% cd pika-@PIKA_VERSION@ # change to the toplevel directory
% meson _build # `configure' step
% ninja -C _build # build PIKA
% ninja -C _build install # install PIKA
The `configure' step examines your system, and adapts PIKA to run on
it. The script has many options, some of which are described in the
generic instructions included at the end of this file. All of the
options can be listed using the command `meson configure' if you
successfully configured already, or by reading the file `meson_options.txt`.
There are several special options the PIKA configure script recognizes.
These are:
-Dvector-icons=false This option installs raster icons instead of
vector icons.
-Drelocatable-bundle=yes This option forces PIKA to search some
resources (e.g. MyPaint brushes or libwmf fonts) relatively to the
running prefix, rather than using build-time paths.
-Dansi=true This option causes stricter ANSI C checking to be
performed when compiling with GCC. The default is for strict
checking to be disabled. NOTE: This option is intended primarily as
a convenience for developers.
-Dpikadir=DIR. This option changes the default directory PIKA uses to
search for its configuration files from ~/.config/PIKA/@PIKA_APP_VERSION@ (the
directory .config/PIKA/@PIKA_APP_VERSION@ in the user's home directory) to
~/.config/DIR/@PIKA_APP_VERSION@.
If DIR is an absolute path, the directory will be changed to DIR.
-Dshmem-type=[none|sysv|posix|win32|auto]. This option allows you to
specify how image data is transported between the core and plug-ins.
Usually the best way to do this is detected automatically.
-Daa=disabled The AA plug-in needs libaa and configure checks for
its presence. Use -Daa=disabled if you run into problems.
-Dxpm=disabled The XPM plug-in needs libxpm and configure checks
for its presence. If for some reason you don't want to build the
XPM plug-in even though the library is installed, use
-Dxpm=disabled to disable it explicitly.
-Dmng=disabled The MNG plug-in needs libmng and configure checks
for its presence. If for some reason you don't want to build the
MNG plug-in even though the library is installed, use
-Dmng=disabled to disable it explicitly.
-Dwmf=disabled The WMF plug-in needs libwmf2 and configure checks for
its presence. Use -Dwmf=disabled if you run into problems.
-Dwebkit-unmaintained=true We do not recommend to install the Help
browser and Webpage plug-ins anymore. If for some reason you want
these anyway, you can force the build with this explicit option.
-Dprint=false If for some reason you don't want to build the Print
plug-in based on the GtkPrint API, you can build with -Dprint=false.