1/*  Part of SWI-Prolog
   2
   3    Author:        Jan Wielemaker
   4    E-mail:        J.Wielemaker@vu.nl
   5    WWW:           http://www.swi-prolog.org
   6    Copyright (c)  2012, VU University Amsterdam
   7    All rights reserved.
   8
   9    Redistribution and use in source and binary forms, with or without
  10    modification, are permitted provided that the following conditions
  11    are met:
  12
  13    1. Redistributions of source code must retain the above copyright
  14       notice, this list of conditions and the following disclaimer.
  15
  16    2. Redistributions in binary form must reproduce the above copyright
  17       notice, this list of conditions and the following disclaimer in
  18       the documentation and/or other materials provided with the
  19       distribution.
  20
  21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32    POSSIBILITY OF SUCH DAMAGE.
  33*/
  34
  35:- module(uuid,
  36          [ uuid/1,                     % -UUID
  37            uuid/2                      % -UUID, +Options
  38          ]).
  39
  40/** <module> Universally Unique Identifier (UUID) Library
  41
  42The library provides operations on UUIDs.   Please consult other sources
  43for understanding UUIDs and  the  implications   of  the  different UUID
  44versions.  Some typical calls are given below:
  45
  46  ==
  47  ?- uuid(X).
  48  X = 'ea6589fa-19dd-11e2-8a49-001d92e1879d'.
  49
  50  ?- uuid(X, [url('http://www.swi-prolog.org')]).
  51  X = '73a07870-6a90-3f2e-ae2b-ffa538dc7c2c'.
  52  ==
  53
  54@tbd Compare UUIDs, extract time and version from UUIDs
  55@see http://www.ossp.org/pkg/lib/uuid/
  56*/
  57
  58:- use_foreign_library(foreign(uuid)).
  59
  60%!  uuid(-UUID) is det.
  61%
  62%   UUID is an atom representing a  new   UUID.  This is the same as
  63%   calling uuid(UUID, []).  See uuid/2 for options.
  64
  65uuid(UUID) :-
  66    uuid(UUID, []).
  67
  68%!  uuid(-UUID, +Options) is det.
  69%
  70%   Create a new UUID according to   Options.  The following options
  71%   are defined:
  72%
  73%     * version(+Versions)
  74%     Integer in the range 1..5, which specifies the UUID version
  75%     that is created.  Default is 1.
  76%
  77%     * dns(DNS)
  78%     * url(URL)
  79%     * oid(OID)
  80%     * x500(X500)
  81%     Provide additional context information for UUIDs using version
  82%     3 or 5.  If there is no explicit version option, UUID version
  83%     3 is used.
  84%
  85%     * format(+Format)
  86%     Representation of the UUID.  Default is =atom=, yielding atoms
  87%     such as =|8304efdd-bd6e-5b7c-a27f-83f3f05c64e0|=. The
  88%     alternative is =integer=, returning a large integer that
  89%     represents the 128 bits of the UUID.