harn-stdlib 0.8.163

Embedded Harn standard library source catalog
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

// std/path — Path manipulation utilities
//
// Import with: import "std/path"
/**
 * Get the file extension without the dot.
 * File extension of `path` (without the leading dot).
 *
 * @effects: []
 * @errors: []
 */
pub fn ext(path) {
  let e = extname(path)
  if len(e) > 0 {
    return e.substring(1)
  }
  return ""
}

/**
 * Get the filename without extension.
 * File name of `path` without its extension.
 *
 * @effects: []
 * @errors: []
 */
pub fn stem(path) {
  let base = basename(path)
  let dot = base.last_index_of(".")
  if dot <= 0 {
    return base
  }
  return base.substring(0, dot)
}

/**
 * Normalize path separators (replace backslash with forward slash).
 * Normalize `path`, collapsing `.`/`..` segments and redundant separators.
 *
 * @effects: []
 * @errors: []
 */
pub fn normalize(path) {
  return path.replace("\\", "/")
}

/**
 * Check if a path is absolute.
 * Whether `path` is absolute.
 *
 * @effects: []
 * @errors: []
 */
pub fn is_absolute(path) {
  let normalized = normalize(path)
  let windows_drive_root = len(normalized) >= 3 && normalized.substring(1, 2) == ":" && normalized.substring(2, 3) == "/"
  return normalized.starts_with("/") || windows_drive_root
}

/**
 * Classify a path at the workspace boundary.
 * Resolve `path` against the workspace root into workspace metadata.
 *
 * @effects: []
 * @errors: []
 */
pub fn workspace_info(path, workspace_root = nil) {
  return path_workspace_info(path, workspace_root)
}

/**
 * Normalize a path into workspace-relative form when possible.
 * Normalize `path` relative to the workspace root.
 *
 * @effects: []
 * @errors: []
 */
pub fn workspace_normalize(path, workspace_root = nil) {
  return path_workspace_normalize(path, workspace_root)
}

/**
 * List files in a directory recursively (one level).
 * List the file paths directly under directory `dir`.
 *
 * @effects: []
 * @errors: []
 */
pub fn list_files(dir) {
  let entries = harness.fs.list_dir(dir)
  return entries
    .filter(
    { name ->
      let full = path_join(dir, name)
      let info = harness.fs.stat(full)
      return info.is_file
    },
  )
}

/**
 * List subdirectories.
 * List the subdirectory paths directly under directory `dir`.
 *
 * @effects: []
 * @errors: []
 */
pub fn list_dirs(dir) {
  let entries = harness.fs.list_dir(dir)
  return entries
    .filter(
    { name ->
      let full = path_join(dir, name)
      let info = harness.fs.stat(full)
      return info.is_dir
    },
  )
}