rename from q to queue

rename from q to queue

[rain1]

[-- Attachment #1: Type: text/plain, Size: 436 bytes --]

Hello!

The following library uses a pun writing 'q' instead of 'queue': 
<http://www.gnu.org/software/guile/manual/html_node/Queues.html>

I propose renaming the module from (ice-9 q) to (ice-9 queue) and 
spelling queue throughout in the usual scheme style of using full words.

Attached is a patch that does this. If there is a positive consensus on 
the rename I am happy to apply the change to all the documentation and 
tests too.

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Renamed-module-ice-9-q.scm-to-module-ice-9-queue.scm.patch --]
[-- Type: text/x-diff; name=0001-Renamed-module-ice-9-q.scm-to-module-ice-9-queue.scm.patch, Size: 9969 bytes --]

From 39cc9f240236850d1f2d6f83f1a2fb980d7a61e2 Mon Sep 17 00:00:00 2001
From: Raymond Nicholson <rain1@openmailbox.org>
Date: Mon, 11 Apr 2016 17:23:36 +0000
Subject: [PATCH] Renamed module/ice-9/q.scm to module/ice-9/queue.scm.

---
 module/ice-9/q.scm     | 153 -------------------------------------------------
 module/ice-9/queue.scm | 153 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 153 insertions(+), 153 deletions(-)
 delete mode 100644 module/ice-9/q.scm
 create mode 100644 module/ice-9/queue.scm

diff --git a/module/ice-9/q.scm b/module/ice-9/q.scm
deleted file mode 100644
index 4dc5d49..0000000
--- a/module/ice-9/q.scm
+++ /dev/null
@@ -1,153 +0,0 @@
-;;;; q.scm --- Queues
-;;;;
-;;;; 	Copyright (C) 1995, 2001, 2004, 2006 Free Software Foundation, Inc.
-;;;;
-;;;; This library 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.
-;;;; 
-;;;; This library 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 this library; if not, write to the Free Software
-;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-;;;;
-
-;;; Commentary:
-
-;;; Q: Based on the interface to
-;;;
-;;; "queue.scm"  Queues/Stacks for Scheme
-;;;  Written by Andrew Wilcox (awilcox@astro.psu.edu) on April 1, 1992.
-
-;;; {Q}
-;;;
-;;; A list is just a bunch of cons pairs that follows some constrains,
-;;; right?  Association lists are the same.  Hash tables are just
-;;; vectors and association lists.  You can print them, read them,
-;;; write them as constants, pun them off as other data structures
-;;; etc. This is good.  This is lisp.  These structures are fast and
-;;; compact and easy to manipulate arbitrarily because of their
-;;; simple, regular structure and non-disjointedness (associations
-;;; being lists and so forth).
-;;;
-;;; So I figured, queues should be the same -- just a "subtype" of cons-pair
-;;; structures in general.
-;;;
-;;; A queue is a cons pair:
-;;;		( <the-q> . <last-pair> )
-;;;
-;;; <the-q> is a list of things in the q.  New elements go at the end
-;;; of that list.
-;;;
-;;; <last-pair> is #f if the q is empty, and otherwise is the last
-;;; pair of <the-q>.
-;;;
-;;; q's print nicely, but alas, they do not read well because the
-;;; eq?-ness of <last-pair> and (last-pair <the-q>) is lost by read.
-;;;
-;;; All the functions that aren't explicitly defined to return
-;;; something else (a queue element; a boolean value) return the queue
-;;; object itself.
-
-;;; Code:
-
-(define-module (ice-9 q)
-  :export (sync-q! make-q q? q-empty? q-empty-check q-front q-rear
-	   q-remove! q-push! enq! q-pop! deq! q-length))
-
-;;; sync-q!
-;;;   The procedure
-;;;
-;;;		(sync-q! q)
-;;;
-;;;   recomputes and resets the <last-pair> component of a queue.
-;;;
-(define (sync-q! q)
-  (set-cdr! q (if (pair? (car q)) (last-pair (car q))
-		  #f))
-  q)
-
-;;; make-q
-;;;  return a new q.
-;;;
-(define (make-q) (cons '() #f))
-
-;;; q? obj
-;;;   Return true if obj is a Q.
-;;;   An object is a queue if it is equal? to '(() . #f)
-;;;   or it is a pair P with (list? (car P))
-;;;                      and (eq? (cdr P) (last-pair (car P))).
-;;;
-(define (q? obj)
-  (and (pair? obj)
-       (if (pair? (car obj))
-	   (eq? (cdr obj) (last-pair (car obj)))
-	   (and (null? (car obj))
-		(not (cdr obj))))))
-
-;;; q-empty? obj
-;;;
-(define (q-empty? obj) (null? (car obj)))
-
-;;; q-empty-check q
-;;;  Throw a q-empty exception if Q is empty.
-(define (q-empty-check q) (if (q-empty? q) (throw 'q-empty q)))
-
-;;; q-front q
-;;;  Return the first element of Q.
-(define (q-front q) (q-empty-check q) (caar q))
-
-;;; q-rear q
-;;;  Return the last element of Q.
-(define (q-rear q) (q-empty-check q) (cadr q))
-
-;;; q-remove! q obj
-;;;  Remove all occurences of obj from Q.
-(define (q-remove! q obj)
-  (set-car! q (delq! obj (car q)))
-  (sync-q! q))
-
-;;; q-push! q obj
-;;;  Add obj to the front of Q
-(define (q-push! q obj)
-  (let ((h (cons obj (car q))))
-    (set-car! q h)
-    (or (cdr q) (set-cdr! q h)))
-  q)
-
-;;; enq! q obj
-;;;  Add obj to the rear of Q
-(define (enq! q obj)
-  (let ((h (cons obj '())))
-    (if (null? (car q))
-	(set-car! q h)
-	(set-cdr! (cdr q) h))
-    (set-cdr! q h))
-  q)
-
-;;; q-pop! q
-;;;  Take the front of Q and return it.
-(define (q-pop! q)
-  (q-empty-check q)
-  (let ((it (caar q))
-	(next (cdar q)))
-    (if (null? next)
-	(set-cdr! q #f))
-    (set-car! q next)
-    it))
-
-;;; deq! q
-;;;  Take the front of Q and return it.
-(define deq! q-pop!)
-
-;;; q-length q
-;;;  Return the number of enqueued elements.
-;;;
-(define (q-length q) (length (car q)))
-
-;;; q.scm ends here
diff --git a/module/ice-9/queue.scm b/module/ice-9/queue.scm
new file mode 100644
index 0000000..a4d8a51
--- /dev/null
+++ b/module/ice-9/queue.scm
@@ -0,0 +1,153 @@
+;;;; queue.scm --- Queues
+;;;;
+;;;; 	Copyright (C) 1995, 2001, 2004, 2006 Free Software Foundation, Inc.
+;;;;
+;;;; This library 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.
+;;;; 
+;;;; This library 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 this library; if not, write to the Free Software
+;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+;;;;
+
+;;; Commentary:
+
+;;; Q: Based on the interface to
+;;;
+;;; "queue.scm"  Queues/Stacks for Scheme
+;;;  Written by Andrew Wilcox (awilcox@astro.psu.edu) on April 1, 1992.
+
+;;; {Q}
+;;;
+;;; A list is just a bunch of cons pairs that follows some constrains,
+;;; right?  Association lists are the same.  Hash tables are just
+;;; vectors and association lists.  You can print them, read them,
+;;; write them as constants, pun them off as other data structures
+;;; etc. This is good.  This is lisp.  These structures are fast and
+;;; compact and easy to manipulate arbitrarily because of their
+;;; simple, regular structure and non-disjointedness (associations
+;;; being lists and so forth).
+;;;
+;;; So I figured, queues should be the same -- just a "subtype" of cons-pair
+;;; structures in general.
+;;;
+;;; A queue is a cons pair:
+;;;		( <the-q> . <last-pair> )
+;;;
+;;; <the-q> is a list of things in the q.  New elements go at the end
+;;; of that list.
+;;;
+;;; <last-pair> is #f if the q is empty, and otherwise is the last
+;;; pair of <the-q>.
+;;;
+;;; q's print nicely, but alas, they do not read well because the
+;;; eq?-ness of <last-pair> and (last-pair <the-q>) is lost by read.
+;;;
+;;; All the functions that aren't explicitly defined to return
+;;; something else (a queue element; a boolean value) return the queue
+;;; object itself.
+
+;;; Code:
+
+(define-module (ice-9 queue)
+  :export (sync-queue! make-queue queue? queue-empty? queue-empty-check queue-front queue-rear
+	   queue-remove! queue-push! enqueue! queue-pop! dequeue! queue-length))
+
+;;; sync-queue!
+;;;   The procedure
+;;;
+;;;		(sync-queue! q)
+;;;
+;;;   recomputes and resets the <last-pair> component of a queue.
+;;;
+(define (sync-queue! q)
+  (set-cdr! q (if (pair? (car q)) (last-pair (car q))
+		  #f))
+  q)
+
+;;; make-queue
+;;;  return a new q.
+;;;
+(define (make-queue) (cons '() #f))
+
+;;; queue? obj
+;;;   Return true if obj is a Q.
+;;;   An object is a queue if it is equal? to '(() . #f)
+;;;   or it is a pair P with (list? (car P))
+;;;                      and (eq? (cdr P) (last-pair (car P))).
+;;;
+(define (queue? obj)
+  (and (pair? obj)
+       (if (pair? (car obj))
+	   (eq? (cdr obj) (last-pair (car obj)))
+	   (and (null? (car obj))
+		(not (cdr obj))))))
+
+;;; queue-empty? obj
+;;;
+(define (queue-empty? obj) (null? (car obj)))
+
+;;; queue-empty-check q
+;;;  Throw a queue-empty exception if Q is empty.
+(define (queue-empty-check q) (if (queue-empty? q) (throw 'queue-empty q)))
+
+;;; queue-front q
+;;;  Return the first element of Q.
+(define (queue-front q) (queue-empty-check q) (caar q))
+
+;;; queue-rear q
+;;;  Return the last element of Q.
+(define (queue-rear q) (queue-empty-check q) (cadr q))
+
+;;; queue-remove! q obj
+;;;  Remove all occurences of obj from Q.
+(define (queue-remove! q obj)
+  (set-car! q (delqueue! obj (car q)))
+  (sync-queue! q))
+
+;;; queue-push! q obj
+;;;  Add obj to the front of Q
+(define (queue-push! q obj)
+  (let ((h (cons obj (car q))))
+    (set-car! q h)
+    (or (cdr q) (set-cdr! q h)))
+  q)
+
+;;; enqueue! q obj
+;;;  Add obj to the rear of Q
+(define (enqueue! q obj)
+  (let ((h (cons obj '())))
+    (if (null? (car q))
+	(set-car! q h)
+	(set-cdr! (cdr q) h))
+    (set-cdr! q h))
+  q)
+
+;;; queue-pop! q
+;;;  Take the front of Q and return it.
+(define (queue-pop! q)
+  (queue-empty-check q)
+  (let ((it (caar q))
+	(next (cdar q)))
+    (if (null? next)
+	(set-cdr! q #f))
+    (set-car! q next)
+    it))
+
+;;; dequeue! q
+;;;  Take the front of Q and return it.
+(define dequeue! queue-pop!)
+
+;;; queue-length q
+;;;  Return the number of enqueued elements.
+;;;
+(define (queue-length q) (length (car q)))
+
+;;; q.scm ends here
-- 
2.8.1

Re: rename from q to queue

[Christopher Allan Webber]

rain1@openmailbox.org writes:

> Hello!
>
> The following library uses a pun writing 'q' instead of 'queue': 
> <http://www.gnu.org/software/guile/manual/html_node/Queues.html>
>
> I propose renaming the module from (ice-9 q) to (ice-9 queue) and 
> spelling queue throughout in the usual scheme style of using full words.
>
> Attached is a patch that does this. If there is a positive consensus on 
> the rename I am happy to apply the change to all the documentation and 
> tests too.

Seems like a pretty big api change without aliasing...

Re: rename from q to queue

[Nala Ginrut]

Agreed, such a force change may effect many folks

On Mon, 2016-04-11 at 22:55 -0500, Christopher Allan Webber wrote:
> rain1@openmailbox.org writes:
> 
> > 
> > Hello!
> > 
> > The following library uses a pun writing 'q' instead of 'queue': 
> > <http://www.gnu.org/software/guile/manual/html_node/Queues.html>
> > 
> > I propose renaming the module from (ice-9 q) to (ice-9 queue) and 
> > spelling queue throughout in the usual scheme style of using full
> > words.
> > 
> > Attached is a patch that does this. If there is a positive
> > consensus on 
> > the rename I am happy to apply the change to all the documentation
> > and 
> > tests too.
> Seems like a pretty big api change without aliasing...
> 

Re: rename from q to queue

[Mathieu Lirzin]

Hello,

rain1@openmailbox.org writes:

> The following library uses a pun writing 'q' instead of 'queue':
> <http://www.gnu.org/software/guile/manual/html_node/Queues.html>
>
> I propose renaming the module from (ice-9 q) to (ice-9 queue) and
> spelling queue throughout in the usual scheme style of using full
> words.
>
> Attached is a patch that does this. If there is a positive consensus
> on the rename I am happy to apply the change to all the documentation
> and tests too.

As stated on IRC I think it is an improvement to have a meaningful name
for this module.

However as pointed in other replies, It is not possible to implement it
this way because (ice-9 q) is a public API.

One way to not break backward compatibility, would be to move (ice-9 q)
code in (ice-9 queue) and make (ice-9 q) use it and re-export every
variable with its old name.

Finally we will need a way to give the information that (ice-9 q) module
is deprectated to the users.  I am not sure what is the best way to
achieve this.  Maybe with:

  (eval-when (expand load eval)
    (display "..." (current-warning-port)))

What do others think?

-- 
Mathieu Lirzin

Re: rename from q to queue

[Ludovic Courtès]

Mathieu Lirzin <mthl@gnu.org> skribis:

> One way to not break backward compatibility, would be to move (ice-9 q)
> code in (ice-9 queue) and make (ice-9 q) use it and re-export every
> variable with its old name.

Right.

> Finally we will need a way to give the information that (ice-9 q) module
> is deprectated to the users.  I am not sure what is the best way to
> achieve this.  Maybe with:
>
>   (eval-when (expand load eval)
>     (display "..." (current-warning-port)))
>
> What do others think?

We could do a quick hack to iterate over the exported bindings,
re-export them, and print a message.

However, I think it would be best to have a mechanism in the module
abstraction to /declare/ renames.  That would allow both the compiler
and the run-time support to emit an appropriate warning.

This would require something like adding a special field to ‘module’
records, such that one can write, say:

  (define-module (ice-9 q)
    #:superseded-by (ice-9 queue))

With that in place, it will become much easier to discuss about ice-9
renames, IMO.

Thoughts?

Thanks,
Ludo’.

Re: rename from q to queue

[Christopher Allan Webber]

Ludovic Courtès writes:

> Mathieu Lirzin <mthl@gnu.org> skribis:
>
>> One way to not break backward compatibility, would be to move (ice-9 q)
>> code in (ice-9 queue) and make (ice-9 q) use it and re-export every
>> variable with its old name.
>
> Right.
>
>> Finally we will need a way to give the information that (ice-9 q) module
>> is deprectated to the users.  I am not sure what is the best way to
>> achieve this.  Maybe with:
>>
>>   (eval-when (expand load eval)
>>     (display "..." (current-warning-port)))
>>
>> What do others think?
>
> We could do a quick hack to iterate over the exported bindings,
> re-export them, and print a message.
>
> However, I think it would be best to have a mechanism in the module
> abstraction to /declare/ renames.  That would allow both the compiler
> and the run-time support to emit an appropriate warning.
>
> This would require something like adding a special field to ‘module’
> records, such that one can write, say:
>
>   (define-module (ice-9 q)
>     #:superseded-by (ice-9 queue))
>
> With that in place, it will become much easier to discuss about ice-9
> renames, IMO.
>
> Thoughts?
>
> Thanks,
> Ludo’.

I think that would be useful.  There's been talk about renaminig things
from (ice-9) into a (guile) namespace.  Likewise aliasing things from
(srfi) to something more human-readable.  Are the rename and aliasing
thing the same step or two different things?

Re: rename from q to queue

[Ludovic Courtès]

Christopher Allan Webber <cwebber@dustycloud.org> skribis:

> Ludovic Courtès writes:

[...]

>> We could do a quick hack to iterate over the exported bindings,
>> re-export them, and print a message.
>>
>> However, I think it would be best to have a mechanism in the module
>> abstraction to /declare/ renames.  That would allow both the compiler
>> and the run-time support to emit an appropriate warning.
>>
>> This would require something like adding a special field to ‘module’
>> records, such that one can write, say:
>>
>>   (define-module (ice-9 q)
>>     #:superseded-by (ice-9 queue))
>>
>> With that in place, it will become much easier to discuss about ice-9
>> renames, IMO.
>>
>> Thoughts?
>>
>> Thanks,
>> Ludo’.
>
> I think that would be useful.  There's been talk about renaminig things
> from (ice-9) into a (guile) namespace.  Likewise aliasing things from
> (srfi) to something more human-readable.  Are the rename and aliasing
> thing the same step or two different things?

Module aliases and deprecation would probably be implemented similarly,
so there’s a connection between the two.

Ludo’.