markam/src/paths.scm
Tom Willemsen e3d4594eb7 Add/improve some documentation comments
Since CHICKEN scheme doesn't do docstrings I'm just using comments.
2012-12-28 22:03:55 +01:00

46 lines
1.8 KiB
Scheme

;;; linkwave -- Store/retrieve/manage bookmarks
;; Copyright (C) 2012 Tom Willemsen <tom at ryuslash dot org>
;; 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 <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Path-related functions.
;;; Code:
(declare (unit paths))
(define (stored-file xdg-env file)
;; Get FILE either from `XDG-ENV/linkwave/' or from
;; `$HOME/.linkwave/'. Prefer any existing file over any other, but
;; prefer files using XDG-ENV over `$HOME'.
(let ((xdg (get-environment-variable xdg-env))
(stored-file (string-append (get-environment-variable "HOME") "/.linkwave/" file)))
(unless (or (file-exists? stored-file) (not xdg))
(set! stored-file (string-append xdg "/linkwave/" file)))
stored-file))
(: config-file (string -> string))
(define (config-file file)
;; Use `stored-file' to get configuration file FILE. Configuration
;; files are stored under `$XDG_CONFIG_HOME' if the XDG standard is
;; used.
(stored-file "XDG_CONFIG_HOME" file))
(: data-file (string -> string))
(define (data-file file)
;; Use `stored-file' to get data file FILE. Data files are stored
;; under `$XDG_DATA_HOME' if the XDG standard is used.
(stored-file "XDG_DATA_HOME" file))