Merge pull request #61 from cgay/dev

Change default package install directory

Author: cgay

Makefile

@@ -73,6 +73,7 @@ remove-dylan-tool-artifacts:
 
 clean: remove-dylan-tool-artifacts
 	rm -rf _build
+	rm -rf _test
 
 distclean: clean
 	rm -rf $(install_dir)

documentation/source/index.rst

@@ -33,14 +33,15 @@ workspace
   means a workspace is where the :file:`_build` and :file:`registry`
   directories are generated. In most cases, a workspace is the directory
   containing the :file:`dylan-package.json` file, but the ultimate arbiter is
-  the workspace.json file, if it exists. See `workspaces`_ for details.
+  the :file:`workspace.json` file, if it exists. See `workspaces`_ for details.
 
 active package
   A package checked out into the top-level of a workspace. In most cases a
   workspace is the same as a package directory so there is only one active
-  package. See `Workspaces`_ for discussion of multi-package
-  workspaces. Example: the `dylan update`_ subcommand scans active packages
-  when creating the registry.
+  package. See `Workspaces`_ for discussion of multi-package workspaces.
+
+  The `dylan update`_ subcommand scans active packages when creating the
+  registry.
 
 release
   A specific version of a package. A release has a `Semantic Version`_ associated
@@ -50,24 +51,28 @@ release
 Requirements
 ============
 
-To find and install packages on the local file system many of the
-:program:`dylan` subcommands use the :envvar:`DYLAN` environment variable. If
-:envvar:`DYLAN` is not set, ``$HOME/dylan`` is used instead. (Much of this
-documentation is written to assume that :envvar:`DYLAN` is set, but it is not
-required.)
-
 Make sure :program:`git` is on your :envvar:`PATH` so it can be found by the
 package manager, which currently exec's ``git clone`` to install
 packages. (This dependency will be removed in a future release.)
 
-The :program:`dylan` tool installs packages, including the `pacman-catalog`_
-package (which describes where to find other packages), under ``$DYLAN/pkg/``.
 
-.. warning::
+Where are Packages Installed?
+=============================
+
+The :program:`dylan` tool installs package dependencies locally in the
+workspace directory by default.  However, you may choose to install them
+globally with :command:`dylan update --global`. Also, the package manager
+caches `its catalog <https://github.com/dylan-lang/pacman-catalog>`_ into a
+global location per user. This location is chosen based on environment
+variables, in this order:
+
+1. ``${DYLAN}/_packages`` if :envvar:`DYLAN` is set.
+
+2. ``${XDG_STATE_HOME}/dylan/_packages`` (Unix) if :envvar:`XDG_STATE_HOME` is
+   set, or ``${CSIDL_LOCAL_APPDATA}/dylan/_packages`` (Windows) if
+   :envvar:`CSIDL_LOCAL_APPDATA` is set.
 
-   Don't put files you want to keep in the ``$DYLAN/pkg/`` directory. The
-   expectation should be that anything in this directory may be deleted at any
-   time by the package manager.
+3. ``${HOME}/.local/state/dylan/_packages`` otherwise.
 
 
 Building From Source
@@ -85,8 +90,8 @@ version, follow these steps to build and install.
 
 #.  Read the `Requirements`_ section, above.
 
-#.  Make sure you have :program:`git`, :program:`make`, and Open Dylan
-    installed.
+#.  Make sure you have :program:`git`, :program:`make`, and
+    :program:`dylan-compiler` installed.
 
 #.  Clone and build the "dylan-tool" project::
 
@@ -97,7 +102,8 @@ version, follow these steps to build and install.
         $ make install
 
 #.  Make sure that ``$DYLAN/bin`` is on your ``$PATH``. If you prefer not to
-    set ``$DYLAN``, make sure that ``$HOME/dylan/bin`` is on your ``$PATH``.
+    set ``$DYLAN``, make sure that ``$HOME/dylan/bin`` is on your ``$PATH``, as
+    that is where the Makefile installs the executable.
 
 You should now be able to run `dylan help`_ and go through the Hello World
 example below.
@@ -462,13 +468,14 @@ Options:
 dylan install
 -------------
 
-Install a package into the package cache, ``${DYLAN}/pkg``.
+Install packages.
 
 Synopsis: ``dylan install <package> [<package> ...]``
 
 This command is primarily useful if you want to browse the source code in a
-package locally without having to worry about where to clone it from. The
-packages are installed into ``${DYLAN}/pkg/<package-name>/<version>/src/``.
+package locally without having to worry about where to clone it from. If you
+are in a workspace directory the packages are installed in the workspace's
+"_packages" subdirectory. Otherwise, see `Where are Packages Installed?`_.
 
 
 .. index::

ext/pacman-catalog

@@ -153,8 +153,8 @@ define constant $update-subcommand
   = make(<update-subcommand>,
          options: list(make(<flag-option>,
                             names: #("global"),
-                            help: "Install packages in ${DYLAN}/pkg instead of in the"
-                              " workspace.")));
+                            help: "Install packages globally instead of in the"
+                              " workspace. [%default%]")));
 
 define method execute-subcommand
     (parser :: <command-line-parser>, subcmd :: <update-subcommand>)

ext/testworks

@@ -48,9 +48,10 @@ define module pacman
   export
     <catalog-error>,
     catalog,
-    dylan-directory,            // $DYLAN or $HOME/dylan or /opt/dylan
+    dylan-directory,
     package-manager-directory,
     *package-manager-directory*,
+    $package-directory-name,
 
     <catalog>,
     catalog-directory,

sources/commands/simple-commands.dylan

@@ -19,7 +19,9 @@ define test test-install ()
     assert-false(installed?(release));
     install(release);
     assert-true(installed?(release));
-    let file = as(<file-locator>, "pkg/json/1.0.0/src/json.lid");
+    let file = as(<file-locator>,
+                  format-to-string("%s/json/1.0.0/src/json.lid",
+                                   $package-directory-name));
     let lid-path = merge-locators(file, dir);
     assert-true(file-exists?(lid-path));
     let versions = installed-versions(release.package-name);

sources/library.dylan

@@ -4,7 +4,7 @@ Module: %pacman
 define function string-parser (s :: <string>) => (s :: <string>) s end;
 
 // Name of the subdirectory in which packages are to be installed.
-define constant $package-directory-name = "pkg";
+define constant $package-directory-name = "_packages";
 
 // This provides a way for dylan-tool commands to override the default package
 // installation directory without threading it through the entire call chain,
@@ -20,29 +20,28 @@ define function package-manager-directory
     | subdirectory-locator(dylan-directory(), $package-directory-name)
 end function;
 
-// TODO: Windows
-define constant $default-dylan-directory = "/opt/dylan";
-define constant $dylan-dir-name = "dylan";
 define constant $dylan-env-var = "DYLAN";
 
-// The base directory for all things Dylan for a given user.
-//   1. ${DYLAN}
-//   2. ${HOME}/dylan or %APPDATA%\dylan
-//   3. /opt/dylan or ??? on Windows
-// TODO: Dylan implementations should export this.
 define function dylan-directory
     () => (dir :: <directory-locator>)
+  let basevar = select (os/$os-name)
+                  #"win32" => "CSIDL_LOCAL_APPDATA";
+                  otherwise => "XDG_STATE_HOME";
+                end;
+  let base = os/environment-variable(basevar);
+  let home = os/environment-variable("HOME");
   let dylan = os/environment-variable($dylan-env-var);
-  if (dylan)
-    as(<directory-locator>, dylan)
-  else
-    // TODO: use %APPDATA% on Windows
-    let home = os/environment-variable("HOME");
-    if (home)
-      subdirectory-locator(as(<directory-locator>, home), $dylan-dir-name)
-    else
-      as(<directory-locator>, $default-dylan-directory)
-    end
+  case
+    dylan =>
+      as(<directory-locator>, dylan);
+    base =>
+      subdirectory-locator(as(<directory-locator>, base), "dylan");
+    home =>
+      subdirectory-locator(as(<directory-locator>, home), ".local", "state", "dylan");
+    otherwise =>
+      package-error("Couldn't determine Dylan global package directory."
+                      " Set the %s, %s, or HOME environment variable.",
+                    $dylan-env-var, basevar);
   end
 end function;
 

sources/pacman/install-test.dylan

@@ -77,7 +77,8 @@ define function update
                   = if (global?)
                       *package-manager-directory*
                     else
-                      subdirectory-locator(workspace-directory(ws), "_packages")
+                      subdirectory-locator(workspace-directory(ws),
+                                           pm/$package-directory-name)
                     end)
     let (releases, actives) = update-deps(ws, cat);
     let registry = update-registry(ws, cat, releases, actives);