jonls · qwepoizt · Jul 20, 2021 · Jul 20, 2021 · Jul 20, 2021 · Jul 20, 2021
diff --git a/.gitignore b/.gitignore
@@ -73,6 +73,7 @@ autom4te.cache
 /compile
 /config.guess
 /config.h.in
+/config.h
 /config.log
 /config.status
 /config.sub
@@ -86,6 +87,7 @@ autom4te.cache
 # https://www.gnu.org/software/libtool/
 
 /ltmain.sh
+/libtool
 
 # http://www.gnu.org/software/texinfo
 
@@ -110,9 +112,12 @@ m4/lt~obsolete.m4
 /data/applications/redshift-gtk.desktop
 /data/systemd/redshift.service
 /data/systemd/redshift-gtk.service
+/Makefile
 /m4
+/src/Makefile
 /src/redshift
 /src/redshift-gtk/defs.py
+/src/redshift-gtk/Makefile
 /src/redshift-gtk/redshift-gtk
 /src/redshift-gtk/__pycache__/
 
@@ -130,3 +135,10 @@ m4/lt~obsolete.m4
 /po/insert-header.sin
 /po/quot.sed
 /po/remove-potcdate.sin
+/po/Makefile
+/po/.intltool-merge-cache
+/src/.deps/*.Po
+/src/.deps/*.Plo
+
+# IntelliJ IDE folder
+.idea/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,37 +2,65 @@
 Building from git clone
 -----------------------
 
+### 1. Execute bootstrap script
 ``` shell
 $ ./bootstrap
-$ ./configure
 ```
-
 The bootstrap script will use autotools to set up the build environment
 and create the `configure` script.
 
-Use `./configure --help` for options. Use `--prefix` to make an install in
-your home directory. This is necessary to test python scripts. The systemd
-user unit directory should be set to avoid writing to the system location.
-
-Systemd will look for the unit files in `~/.config/systemd/user` so this
+### 2. Execute configure script
+
+#### Enabling adjustment methods and location providers
+* Which methods and providers your redshift build will support, is determined during execution of `./configure`.
+* If you install none of the suggested dependencies (see below), **redshift will only work in a very limited manner**! Especially, **adjusting screen temperature will not be possible**.
+* Therefore, make sure you have installed the required dependencies listed below, before `./configure`
+* The `configure` script actually tells you which adjustment methods/providers will be included in the build:
+  ```shell
+    (...)
+    Adjustment methods:
+    DRM:                no
+    RANDR:              yes
+    VidMode:            no
+    Quartz (macOS):     no
+    WinGDI (Windows):   no
+
+    Location providers:
+    Geoclue2:                   yes
+    CoreLocation (macOS):       no
+    (...)
+  ```
+* At least one of the adjustment methods should have "yes".
+* Use `./configure --help` to see all available options. 
+* Use `--prefix` to make an install in your home directory. This is necessary to test python scripts. The systemd user unit directory should be set to avoid writing to the system location.
+* Systemd will look for the unit files in `~/.config/systemd/user` so this
 directory can be used as a target if the unit files will be used. Otherwise
 the location can be set to `no` to disable the systemd files.
 
-Example:
+#### Example:
 
 ``` shell
-$ ./configure --prefix=$HOME/redshift/root \
+$ ./configure --enable-randr --prefix=$HOME/redshift/root \
    --with-systemduserunitdir=$HOME/.config/systemd/user
 ```
 
-Now, build the files:
+### 3. Build and mount  
+Now, build the files and mount the Elektra specification:  
+(Mounting the specification requires root privileges. `redshift-conf.mount.sh` uses `sudo` to achieve that).
 
 ``` shell
 $ make
+$ APP_PATH=`pwd`/src/redshift sh src/elektra/redshift-conf.mount.sh
+```
+
+### 4. Execute redshift
+The main redshift program can be run at this point:
+```shell
+$ src/redshift
 ```
 
-The main redshift program can be run at this point. To install to the
-prefix directory run:
+### 5. Optional: Install
+To install to the prefix directory run:
 
 ``` shell
 $ make install
@@ -44,21 +72,34 @@ You can now run the python script. Example:
 $ $HOME/redshift/root/bin/redshift-gtk
 ```
 
+### Updating the Elektra specification file
+When you update the Elektra specification file, make sure to regenerate the files `src/elektra/redshift-conf.*` and `src/elektra/windows/redshift-conf.*`:
+
+```sh
+cd src/elektra
+kdb gen -F ni=redshift.ni highlevel "/sw/jonls/redshift/#0/current" redshift-conf initFn=loadConfiguration helpFn=printHelpMessage specloadFn=exitForSpecload embeddedSpec=full;
+cd windows
+kdb gen -F dump=redshift-win.dump highlevel "/sw/jonls/redshift/#0/current" redshift-conf initFn=loadConfiguration helpFn=printHelpMessage specloadFn=exitForSpecload embeddedSpec=full;
+```
 
 Dependencies
 ------------
 
 * autotools, gettext
 * intltool, libtool
-* libdrm (Optional, for DRM support)
-* libxcb, libxcb-randr (Optional, for RandR support)
-* libX11, libXxf86vm (Optional, for VidMode support)
+* libelektra5
+* libdrm (Suggested but optional, for DRM support)
+* libxcb, libxcb-randr (Suggested but optional, for RandR support)
+* libX11, libXxf86vm (Suggested but optional, for VidMode support)
 * Glib 2 (Optional, for GeoClue2 support)
 
 * python3, pygobject, pyxdg (Optional, for GUI support)
 * appindicator (Optional, for Ubuntu-style GUI status icon)
 
-Ubuntu users will find all these dependencies in the packages listed in ``.travis.yml``.
+#### Notes
+* Install at least one adjustment method and location provider. Otherwise, redshift will only work in a very limited manner (see "2. Execute configure script" above).
+* Ubuntu users will find all these dependencies in the packages listed in ``.travis.yml``.
+* **Note that you also have to install the "-dev" packages for these libraries, if redshift should be able to use them**!
 
 
 Coding style for C code

diff --git a/Makefile.am b/Makefile.am
@@ -12,8 +12,7 @@ EXTRA_ROOTDOC_FILES = \
 	CONTRIBUTING.md \
 	DESIGN \
 	README \
-	README-colorramp \
-	redshift.conf.sample
+	README-colorramp 
 
 _HICOLOR_FILES = \
 	data/icons/hicolor/scalable/apps/redshift.svg \

diff --git a/README.md b/README.md
@@ -54,19 +54,31 @@ Use the packages provided by your distribution, e.g. for Ubuntu:
 `apt-get install redshift` or `apt-get install redshift-gtk`. For developers,
 please see _Building from source_ and _Latest builds from master branch_ below.
 
-### How do I setup a configuration file?
-
-A configuration file is not required but is useful for saving custom
-configurations and manually defining the location in case of issues with the
-automatic location provider. An example configuration can be found in
-[redshift.conf.sample](redshift.conf.sample).
-
-The configuration file should be saved in the following location depending on
-the platform:
-
-- Linux/macOS: `~/.config/redshift/redshift.conf` (if the environment variable `XDG_CONFIG_HOME` is undefined) or `${XDG_CONFIG_HOME}/redshift/redshift.conf` (if `XDG_CONFIG_HOME` is defined).
-- Windows: Put `redshift.conf` in `%USERPROFILE%\AppData\Local\`
-    (aka `%localappdata%`).
+### How do I configure Redshift?
+
+* For temporary configuration execute Redshift with command-line (CLI) options.  
+  `redshift --help` prints a list of supported options.
+* For permanent changes use [Elektra's](https://www.libelektra.org/home) `kdb set` command.
+
+#### Example: Change coordinates
+* To temporariliy set your location coordinates via CLI options execute:  
+`redshift --location-provider=manual --lat 52.0 --lon 14.0`
+
+* To set your location via `kdb` execute:
+
+```
+kdb set user:/sw/jonls/redshift/#0/current/provider/location manual
+kdb set user:/sw/jonls/redshift/#0/current/provider/location/manual/lat 52.0
+kdb set user:/sw/jonls/redshift/#0/current/provider/location/manual/lon 14.0
+```
+
+#### Supported configuration options
+* For a list of supported CLI options execute `redshift --help`.
+* For a list of supported options configureable via `kdb` execute:
+  * `kdb ls spec:/sw/jonls/redshift/#0/current`
+* For details on a configuration option execute:
+  * `kdb meta-get spec:/sw/jonls/redshift/#0/current/INSERT_OPTION_NAME description`
+  * e.g.: `kdb meta-get spec:/sw/jonls/redshift/#0/current/fade description`
 
 ### Where can I find my coordinates to put in the configuration file?
 

diff --git a/appveyor.yml b/appveyor.yml
@@ -13,40 +13,72 @@ build_script:
 - ps: |
     If ($env:arch -Match "x86_64") {
       $env:MSYSTEM = "MINGW64"
+      # TODO: switch to release channel after Elektra 0.9.8 is released
+      $env:ELEKTRA_DOWNLOAD_URL = "https://build.libelektra.org/job/libelektra/job/master/lastSuccessfulBuild/artifact/artifacts/debian-bullseye-mingw-w64-x86_64/elektra.zip"
+      $env:PATH_FOR_ELEKTRA_FILES = "C:\msys64\mingw64"
     } Else {
       $env:MSYSTEM = "MINGW32"
+      # TODO: switch to release channel after Elektra 0.9.8 is released
+      $env:ELEKTRA_DOWNLOAD_URL = "https://build.libelektra.org/job/libelektra/job/master/lastSuccessfulBuild/artifact/artifacts/debian-bullseye-mingw-w64-i686/elektra.zip"
+      $env:PATH_FOR_ELEKTRA_FILES = "C:\msys64\mingw32"
     }
 
     $env:CONFIGURE_FLAGS = "--disable-drm --disable-randr --disable-vidmode --enable-wingdi --disable-quartz --disable-geoclue2 --disable-corelocation --disable-gui --disable-ubuntu --disable-nls --host=$env:arch-w64-mingw32"
 
 - ps: md (Join-Path $env:APPVEYOR_BUILD_FOLDER root)
+
+# Download and extract Elektra.
+- ps: |
+    md (Join-Path $env:APPVEYOR_BUILD_FOLDER elektra-download)
+    cd $env:APPVEYOR_BUILD_FOLDER/elektra-download
+    Start-FileDownload $env:ELEKTRA_DOWNLOAD_URL
+    7z x elektra.zip
+
+    # Copied from https://stackoverflow.com/a/44931279
+    function CopyFilesToFolder ($fromFolder, $toFolder) {
+    $childItems = Get-ChildItem $fromFolder
+    $childItems | ForEach-Object {
+        Copy-Item -Path $_.FullName -Destination $toFolder -Recurse -Force
+    }
+        Write-Output "Copied all items of $fromFolder to $toFolder"
+    }
+    CopyFilesToFolder elektra\usr\local\lib $env:PATH_FOR_ELEKTRA_FILES\lib
+    CopyFilesToFolder elektra\usr\local\include $env:PATH_FOR_ELEKTRA_FILES\include
+    md $env:APPVEYOR_BUILD_FOLDER\root\bin
+    Copy-Item -Path elektra\usr\local\bin\kdb-static.exe $env:APPVEYOR_BUILD_FOLDER\root\bin
+    Copy-Item -Path elektra\usr\local\lib\libelektra-full.dll $env:APPVEYOR_BUILD_FOLDER\root\bin
+    cd $env:APPVEYOR_BUILD_FOLDER
+
 - C:\msys64\usr\bin\bash -lc "cd $APPVEYOR_BUILD_FOLDER && ./bootstrap"
 - C:\msys64\usr\bin\bash -lc "cd $APPVEYOR_BUILD_FOLDER && ./configure --prefix=\"$APPVEYOR_BUILD_FOLDER/root\" $CONFIGURE_FLAGS"
 - C:\msys64\usr\bin\bash -lc "cd $APPVEYOR_BUILD_FOLDER && make distcheck DISTCHECK_CONFIGURE_FLAGS=\"$CONFIGURE_FLAGS\""
 - C:\msys64\usr\bin\bash -lc "cd $APPVEYOR_BUILD_FOLDER && make install"
 
 test_script:
+
 - |
-  %APPVEYOR_BUILD_FOLDER%\root\bin\redshift.exe -l 12:-34 -pv
-- |
-  %APPVEYOR_BUILD_FOLDER%\root\bin\redshift.exe -l 12:-34 -m dummy -vo
-- ps: Set-Content -Value "[redshift]`ndawn-time=6:30`ndusk-time=18:00-19:30`n" -Path time.config
+  mkdir C:\ProgramData\usr\local\kdb\
+  %APPVEYOR_BUILD_FOLDER%\root\bin\kdb-static.exe mount ../../../../projects/redshift/src/elektra/windows/redshift-win.dump spec:/sw/jonls/redshift/#0/current dump
+  %APPVEYOR_BUILD_FOLDER%\root\bin\kdb-static.exe spec-mount /sw/jonls/redshift/#0/current
+
 - |
-  %APPVEYOR_BUILD_FOLDER%\root\bin\redshift.exe -c time.config -pv
+  %APPVEYOR_BUILD_FOLDER%\root\bin\redshift.exe --help
 - |
-  %APPVEYOR_BUILD_FOLDER%\root\bin\redshift.exe -c time.config -m dummy -vo
-
+  %APPVEYOR_BUILD_FOLDER%\root\bin\redshift.exe --mode=print --location-provider=manual --lat=12 --lon=-34 --method=dummy -v
+  
 after_build:
 - ps: |
     $ZIP_NAME = "redshift-windows-$env:arch"
     $ZIP_FILE = "redshift-windows-$env:arch.zip"
 
     md $ZIP_NAME
     Copy-Item -Path $env:APPVEYOR_BUILD_FOLDER\root\bin\redshift.exe -Destination $ZIP_NAME
+    Copy-Item -Path $env:APPVEYOR_BUILD_FOLDER\root\bin\kdb-static.exe -Destination $ZIP_NAME
+    Copy-Item -Path $env:APPVEYOR_BUILD_FOLDER\root\bin\libelektra-full.dll -Destination $ZIP_NAME
+    Copy-Item -Path $env:APPVEYOR_BUILD_FOLDER\src\elektra\windows\redshift-win.dump -Destination $ZIP_NAME
     Copy-Item -Path README.md -Destination $ZIP_NAME/README.txt
     Copy-Item -Path NEWS.md -Destination $ZIP_NAME/NEWS.txt
     Copy-Item -Path COPYING -Destination $ZIP_NAME/COPYING.txt
-    Copy-Item -Path redshift.conf.sample -Destination $ZIP_NAME
     7z a $ZIP_FILE $ZIP_NAME/
 
 - ps: Push-AppveyorArtifact $ZIP_FILE
diff --git a/configure.ac b/configure.ac
@@ -32,6 +32,7 @@ esac
 AC_CHECK_TOOL([WINDRES], [windres], [])
 AS_IF([test "x$build_windows" = "xyes" -a -n "x$WINDRES"], [
 	enable_windows_resource=yes
+	AC_DEFINE([WINDOWS_BUILD], [1], [Add a DEFINE that this is a Windows build])
 ], [
 	enable_windows_resource=no
 ])
@@ -71,6 +72,10 @@ PKG_CHECK_MODULES([XCB_RANDR], [xcb-randr],
 PKG_CHECK_MODULES([GLIB], [glib-2.0 gobject-2.0], [have_glib=yes], [have_glib=no])
 PKG_CHECK_MODULES([GEOCLUE2], [glib-2.0 gio-2.0 >= 2.26], [have_geoclue2=yes], [have_geoclue2=no])
 
+# No action-if-not-found is given, because we the build to fail, if elektra is missing.
+# The build will fail, because that is the default behavior if action-if-not-found is not set ("end the execution with an error for not having found the dependency.", https://autotools.io/pkgconfig/pkg_check_modules.html)
+PKG_CHECK_MODULES([ELEKTRA], [ elektra elektra-codegen elektra-highlevel >= 0.9.7])
+
 # macOS headers
 AC_CHECK_HEADER([ApplicationServices/ApplicationServices.h], [have_appserv_h=yes], [have_appserv_h=no])
 

diff --git a/po/POTFILES.in b/po/POTFILES.in
@@ -6,7 +6,6 @@ data/applications/redshift-gtk.desktop.in
 
 src/redshift.c
 src/options.c
-src/config-ini.c
 
 src/gamma-drm.c
 src/gamma-randr.c