standardpaths 0.5.0

Getting standard system locations


To use this package, run the following command in your project's root directory:

Manual usage
Put the following dependency into your project's dependences section:


This package provides sub packages which can be used individually:

standardpaths:printdirs - A minimal D application.

standardpaths:getpath - A minimal D application.

Standard paths

D library for getting standard paths (e.g. Pictures, Music, Documents). Inspired by QStandardPaths from Qt.

Build Status

Online documentation

Note: recently this library had functions for finding executables in directories defined by PATH environment variable. This functionality was moved to the separate library. See findexecutable.

Platform support

Currently works on Windows, Linux and FreeBSD. Mac OS X support is experimental.

Running examples

Prints some standard paths to stdout.

dub run :printdirs --build=release

Get path

Get path of given type, verify it exists or create if it does not.

dub run :getpath -- --verify --create templates

Use cases

Some code snippets showing how standardpaths library is supposed to be used.

Building file dialogs

Let's say you have some fancy FileDialog class and you want to provide shortcuts to standard user directories to improve experience. Your code may look like this:

import standardpaths;
import std.file;
import std.stdio;

void showFileDialog()
{
    auto fileDialog = new FileDialog;
    auto folderFlag = FolderFlag.verify;
    
    string[] paths = [
        homeDir(),
        writablePath(StandardPath.desktop, folderFlag),
        writablePath(StandardPath.downloads, folderFlag),
        writablePath(StandardPath.documents, folderFlag),
        writablePath(StandardPath.pictures, folderFlag),
        writablePath(StandardPath.music, folderFlag),
        writablePath(StandardPath.videos, folderFlag),
        writablePath(StandardPath.templates, folderFlag),
        writablePath(StandardPath.publicShare, folderFlag)
    ];
    foreach(path; paths) {
        if (path.exists) {
            string label = path.baseName();
            fileDialog.addPath(label, path);
        }
    }
    fileDialog.show();
}

Writing configuration files

Usually your application will have some configuration file (or files) to store user's preferences and settings. That's where you could use StandardPath.Config path. While the library returns generic paths for configuration, data and cache, you want to have separate folders specially for your application, so you will not accidentally read or modify files used by other programs. Usually these paths are built by concatenating of generic path, organization name and application name.

//You may have these as constants somewhere in your code
enum organizationName = "MyLittleCompany";
enum applicationName = "MyLittleApplication";

import standardpaths;
import std.stdio;
import std.path;

void saveSettings(const Config config)
{
    string configDir = buildPath(writablePath(StandardPath.config), organizationName, applicationName);
    if (!configDir.exists) {
        mkdirRecurse(configDir);
    }
    string configFile = buildPath(configDir, "config.conf");
    
    auto f = File(configFile, "w"); 
    // write settings
    writeln("Settings saved!");
}

Reading configuration files

Since one can save settings it also should be able to read them. Before the first start application does not have any user-specific settings, though it may provide some global default settings upon installing. It's up to developer to decide how to read configs, e.g. whether to read the first found file only or to merge settings from all found config consequentially.

Config readSettings()
{
    string[] configDirs = standardPaths(StandardPath.config).map!(s => buildPath(s, organizationName, applicationName).array;

    foreach(configDir; configDirs) {
        string configFile = buildPath(configDir, "config.conf");
        if (configFile.exists) {
            auto f = File(configFile, "r");
            Config config;
            //read settings...
            return config;//consider using of the first found file
        }
    }
}

Implementation details

Freedesktop

On freedesktop systems (GNU/Linux, FreeBSD, etc.) library uses XDG Base Directory Specification and also provides behavior similiar to xdg-user-dirs.

Windows

On Windows it utilizes SHGetSpecialFolderPath.

Mac OS X

Uses FSFindFolder from Carbon framework. It's deprecated now and should be replaced with Cocoa where possible. See here.

Authors:
  • Roman Chistokhodov
Sub packages:
standardpaths:printdirs, standardpaths:getpath
Dependencies:
xdgpaths
Versions:
0.8.2 2021-Jun-12
0.8.1 2018-May-05
0.8.0 2017-Oct-11
0.7.1 2016-Sep-26
0.7.0 2016-Jun-27
Show all 23 versions
Download Stats:
  • 8 downloads today

  • 65 downloads this week

  • 296 downloads this month

  • 19782 downloads total

Score:
2.7
Short URL:
standardpaths.dub.pm