;; -*- mode: scheme; coding: utf-8 -*-

;;;;
;;;; Copyright (C) 2016 - 2022
;;;; Free Software Foundation, Inc.

;;;; This file is part of GNU G-Golf

;;;; GNU G-Golf is free software; you can redistribute it and/or modify
;;;; it under the terms of the GNU Lesser General Public License as
;;;; published by the Free Software Foundation; either version 3 of the
;;;; License, or (at your option) any later version.

;;;; GNU G-Golf 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
;;;; Lesser General Public License for more details.

;;;; You should have received a copy of the GNU Lesser General Public
;;;; License along with GNU G-Golf.  If not, see
;;;; <https://www.gnu.org/licenses/lgpl.html>.
;;;;

;;; Commentary:

;; this file is partially a copy of (grip utils)
;; http://www.nongnu.org/grip/

;;; Code:


(define-module (g-golf support utils)
  #:use-module (ice-9 match)
  #:use-module (ice-9 receive)
  #:use-module (system foreign)
  #:use-module (g-golf hl-api n-decl)

  #:export (%stow
            stow-ref
            stow-set!
            stow-reset!
            stow-remove!
            stow->alist

	    displayln
            writeln
	    dimfi
	    warning
	    abort
	    and-l
	    identities
            flatten
            explode

            g-studly-caps-expand
	    g-name->name
	    g-name->class-name
            g-name->short-name
	    #;gi-class-name->method-name
            name->g-name

            class-name->name
            class-name->g-name
            syntax-name->method-name

            gi-type-tag->ffi
            gi-type-tag->init-val

            nil				;; [1]

            string-replace-all))

;; [1] we need a way to inform g-golf-callback-closure-marshal to not
;; set an ffi-arg-out to any value.

(define %stow #f)
(define stow-ref #f)
(define stow-set! #f)
(define stow-reset! #f)
(define stow-remove! #f)
(define stow->alist #f)


(eval-when (expand load eval)
  (let* ((stow-default-size 1013)
         (stow (make-hash-table stow-default-size)))

    (set! %stow stow)

    (set! stow-ref
	  (lambda (key)
            (hashq-ref stow key)))

    (set! stow-set!
	  (lambda (key value)
            (hashq-set! stow key value)))

    (set! stow-reset!
	  (lambda ()
            (hash-for-each (lambda (key value)
                             (hashq-remove! stow key))
                stow)))

    (set! stow-remove!
          (lambda (key)
            (hashq-remove! stow key)))

    (set! stow->alist
          (lambda ()
            (hash-map->list cons stow)))))


(define* (displayln msg #:optional (port #f))
  (if port
      (begin
	(display msg port)
	(newline port))
      (begin
	(display msg)
	(newline))))

(define* (writeln msg #:optional (port #f))
  (if port
      (begin
	(write msg port)
	(newline port))
      (begin
	(write msg)
	(newline))))

(define (dimfi . items)
  ;; if the first item is a port, we use it.
  (if (port? (car items))
      (let ((p (car items)))
	(display ";; " p)
	(for-each (lambda (item)
		    (display item p) (display " " p))
	    (cdr items))
	(display "\n" p))
      (begin
	(display ";; ")
	(for-each (lambda (item)
		    (display item) (display " " ))
	    items)
	(display "\n")))
  (car (last-pair items)))

(define* (warning what
                  #:optional msg
                  #:key (msg-2 #f)
                  (port (current-output-port)))
  (display "Warning: " port)
  (display what port)
  (when msg
    (display ": " port)
    (display msg port))
  (newline port)
  (when msg-2
    (display msg-2 port)
    (newline port)))

(define* (abort what msg
                #:key (msg-2 #f)
                (code -1)
                (port (current-output-port)))
  (display (string-append "ERROR: " what ": " msg) port)
  (newline port)
  (when msg-2
    (display msg-2 port)
    (newline port))
  (exit code))

(define (and-l ll)
  (if (null? ll)
      #t
      (if (car ll)
	  (and-l (cdr ll))
	  #f)))

(define (identities . args)
  args)

(define (flatten lst)
 (let loop ((item lst)
            (result '()))
   (match item
     (()
      result)
     ((elt . rests)
      (loop elt
            (loop rests
                  result)))
     (else
      (cons item
            result)))))

(define (explode lst)
  ;; Generate the (first level only [*]) combinatorial lists for LST.

  ;; For example:
  ;;   (explode '(a (b c) b))
  ;;     -| ((a b b) (a c b))
  ;;   (explode '(a (b c) (b c)))
  ;;     -|  ((a b b) (a b c) (a c b) (a c c))

  ;; But (expected, given the current definition):
  ;;  (explode '(a (b (c d)) (b c)))
  ;;    -| ((a b b) (a b c) (a (c d) b) (a (c d) c))

  ;; [*] In G-Golf, explode is used to determine the combinatorial lists
  ;; of specializers for a particular method, which we know requires
  ;; only one level of combinatorial generation. This is because, for
  ;; any method, the unexploded specializers (the argument passed to
  ;; explode) is a list of items, each of which is either a class or a
  ;; list of two classes (in which case, the first class is a <gobject>
  ;; sublass, the second is <boolean> - when the method accepts NULL
  ;; (the scheme representation of which is #f) for one or several of
  ;; its arguments.

  (map reverse (explode-1 lst '(()))))

(define (explode-1 lst results)
  (match lst
    (() results)
    ((x . rests)
     (match x
       (() '())
       ((a . bcd)
        (append (explode-1 rests
                           (map (lambda (result)
                                  (cons a result))
                             results))
                (explode-1 (cons bcd rests)
                           results)))
       (else
        (explode-1 rests
                   (map (lambda (result)
                          (cons x result))
                     results)))))))


;;;
;;; Name Transformation
;;;

;; Initially based on Guile-GNOME (gnome gobject utils), from which we keep
;; one algorithm - see caps-expand-token-2 - the original idea and procedures
;; have been enhanced to allow special treatment of any token that compose the
;; name to be transformed. A typical example of such a need is from the
;; WebKit2 namespace, where the "WebKit' studly caps expand (token) procedure
;; is expected to return "webkit", not "web-kit".

(define* (g-name->name g-name #:optional (as-string? #f))
  (let ((name (or (g-name-transform-exception? g-name)
                  (g-studly-caps-expand g-name))))
    (if as-string?
        name
        (string->symbol name))))

(define* (g-name->class-name g-name #:optional (as-string? #f))
  (let* ((name (g-name->name g-name 'as-string))
         (class-name (string-append "<" name ">")))
    (if as-string?
        class-name
        (string->symbol class-name))))

(define* (g-name->short-name g-name
                             g-parent-name
                             #:optional (as-string? #f))
  (let* ((name (g-name->name g-name 'as-string))
         (parent-name (or (g-short-name-transform-exception? g-parent-name)
                          (g-name->name g-parent-name 'as-string)))
         (short-name
          (if (string-contains name parent-name)
              (let* ((spl (string-length parent-name))
                     (delim (string-index name #\- spl)))
                (string-drop name (1+ delim)))
              (let* ((name (g-name->name g-name 'as-string))
                     (parent-name (g-name->name g-parent-name 'as-string))
                     (spl (string-prefix-length name parent-name)))
                (string-drop name spl)))))
    (if as-string?
        short-name
        (string->symbol short-name))))

;; Not sure this is used but let's keep it as well
#;(define (gi-class-name->method-name class-name name)
  (let ((class-string (symbol->string class-name)))
    (string->symbol
     (string-append (substring class-string 1 (1- (string-length class-string)))
                    ":" (symbol->string name)))))

(define* (name->g-name name #:optional (as-string? #f))
  ;; We only change - to _, other characters are not valid in a g-name.
  (let* ((str-name (or (and (string? name) name)
                       (symbol->string name)))
         (g-name (string-map (lambda (c)
                               (if (char=? c #\-) #\_ c))
                     str-name)))
    (if as-string?
        g-name
        (string->symbol g-name))))

#!

The class-name->g-name procedure is based on class-name->gtype-name, used by
Guile-GNOME.

!#

(define (class-name->name class-name)
  (let ((class-string (symbol->string class-name)))
    (string->symbol
     (substring class-string 1 (1- (string-length class-string))))))

(define (class-name->g-name class-name)
  (let loop ((cn-chars (string->list (symbol->string class-name)))
             (result '())
             (caps? #t))
    (match cn-chars
      (()
       (list->string (reverse! result)))
      ((x . rest)
       (cond ((char-alphabetic? x)
              (loop rest
                    (cons (if caps?
                              (char-upcase x)
                              x)
                          result)
                    #f))
             ((char-numeric? x)
              (loop rest
                    (cons x result)
                    #f))
             (else
              (loop rest
                    result
                    #t)))))))

#!

The g-studly-caps-expand procedure is based on the version that
is used by Guile-GNOME, where it is named GStudlyCapsExpand.

It itself is based on the slib's strcase.scm Written 1992 by Dirk
Lutzebaeck (lutzeb@cs.tu-berlin.de), and the code is in the public
domain.

It has then be modified by Aubrey Jaffer Nov 1992.
SYMBOL-APPEND and StudlyCapsExpand added by A. Jaffer 2001.
Authors of the original version were Ken Dickey and Aubrey Jaffer.

For G-Golf, in 2019, I - David Pirotte - modified the code, so that it
allows for exception treatment on inner token, such as "WebKit"
-> "webkit", not "web-kit".

!#

(define (g-studly-caps-expand name)
  (let loop ((tokens (string-split name #\_))
             (result '()))
    (match tokens
      (()
       (string-join (reverse! (flatten result)) "-"))
      ((token . rest)
       (loop rest
             (cons (caps-expand-token token)
                   result))))))

(define (caps-expand-token token)
  ;; that token might be an empty string may happen, if the name received
  ;; and split by the caller has a trailing character that is precisely
  ;; the character used to split.  In these cases, we wish a trailing
  ;; #\- to.
  (if (string-null? token)
      token
      (or (g-studly-caps-expand-token-exception? token)
          (caps-expand-token-1 token '()))))

(define (caps-expand-token-1 token subtokens)
  (if (string-null? token)
      subtokens
      (receive (idx exception)
          (any-caps-expand-token-exception token)
        (if exception
            (caps-expand-token-1 (substring token idx)
                                 (cons exception subtokens))
            (cons (caps-expand-token-2 token)
                  subtokens)))))

(define (caps-expand-token-2 token)
  (do ((idx (- (string-length token) 1)
	    (- idx 1)))
      ((> 1 idx)
       (string-downcase token))
    (cond ((and (> idx 2)
                (char-lower-case? (string-ref token (- idx 3)))
                (char-upper-case? (string-ref token (- idx 2)))
                (char-upper-case? (string-ref token (- idx 1)))
                (char-lower-case? (string-ref token idx)))
           (set! idx (- idx 1))
           (set! token
                 (string-append (substring token 0 (- idx 1))
                                "-"
                                (substring token (- idx 1)
                                           (string-length token)))))
          ((and (> idx 1)
                (char-upper-case? (string-ref token (- idx 1)))
                (char-lower-case? (string-ref token idx)))
           (set! token
                 (string-append (substring token 0 (- idx 1))
                                "-"
                                (substring token (- idx 1)
                                           (string-length token)))))
          ((and (char-lower-case? (string-ref token (- idx 1)))
                (char-upper-case? (string-ref token idx)))
           (set! token
                 (string-append (substring token 0 idx)
                                "-"
                                (substring token idx
                                           (string-length token))))))))

(define (any-caps-expand-token-exception token)
  (let loop ((exceptions (g-studly-caps-expand-token-exception)))
    (match exceptions
      (()
       (values 0 #f))
      ((exception . rest)
       (match exception
         ((key . val)
          (if (string-prefix? key token)
              (values (string-length key) val)
              (loop rest))))))))


;;;
;;; Syntax name -> method name
;;;

;; When G-Golf creates a method short name, it obtains it by dropping
;; the container name (and its trailing hyphen) from the GI method full
;; name, which is (the GNOME method name), by definition, always unique.

;; GI methods are added to their respective generic function, which is
;; created if it does not already exist. When a generic function is
;; created, G-Golf checks if the name is used, and when it is bound to a
;; procedure, the procedure is 'captured' into an unspecialized method,
;; which is added to the newly created generic function.

;; However, if/when the name is used but its variable value is a syntax,
;; the above can't be done and the name must be 'protected'. This is
;; what syntax-name->method-name does, by using a renamer (if any, it is
;; 'user provided'), or by adding a prefix, a postfix or both to its
;; argument (symbol) name.

(define (syntax-name->method-name name)
  (let ((snp-prefix (syntax-name-protect-prefix))
        (snp-postfix (syntax-name-protect-postfix))
        (snp-renamer (syntax-name-protect-renamer)))
    (cond (snp-renamer (snp-renamer name))
          ((and snp-prefix
                snp-postfix)
           (symbol-append snp-prefix name snp-postfix))
          (snp-prefix
           (symbol-append snp-prefix name))
        (snp-postfix (symbol-append name snp-postfix))
        (else
         (error "At least one of syntax name protect prefix, postfix or
renamer must be defined: " snp-prefix snp-postfix snp-renamer)))))


;;;
;;;
;;;

(define (gi-type-tag->ffi type-tag)
  (case type-tag
    ((void) void)
    ((boolean) int)
    ((int8
      uint8
      int16
      uint16
      int32
      uint32
      int64
      uint64
      float
      double)
     (eval type-tag (current-module)))
    ((gtype) size_t)
    ((utf8
      filename
      array
      interface
      glist
      gslist
      ghash
      error)
     '*) ;; pointer
    ((unichar) uint32)
    (else
     (error "No such GI type tag: " type-tag))))


(define (gi-type-tag->init-val type-tag)
  "Returns the default init value (to initialize C struct) for
TYPE-TAG."
  (case type-tag
    ((utf8
      filename
      pointer			;; <- forced type
      array
      interface
      glist
      gslist
      ghash
      error)
     %null-pointer)
    (else
     0)))

(define nil 'nil)


;;;
;;; string-replace-all
;;;

;; based on string-replace-substring, by A. Wingo in
;; https://lists.gnu.org/archive/html/guile-devel/2014-03/msg00058.html
;; also in string-replace-substring guix:guix/utils.scm.

(define (string-replace-all str all with)
  "Return a new string where every instance of @var{all} in string
   @var{str} has been replaced by @var{with}. For example:

   @lisp
   (string-replace-all \"a ring of strings\" \"ring\" \"rut\")
   @result{} \"a rut of struts\"
   @end lisp
   "
  (let ((sublen (string-length all)))
    (with-output-to-string
      (lambda ()
        (let lp ((start 0))
          (cond
           ((string-contains str all start)
            => (lambda (end)
                 (display (substring/shared str start end))
                 (display with)
                 (lp (+ end sublen))))
           (else
            (display (substring/shared str start)))))))))
